diff --git a/fern/docs.yml b/fern/docs.yml index f18bcbd0da..6351c58c32 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -80,6 +80,12 @@ products: availability: deprecated slug: v2 + - display-name: SDK Reference + slug: sdk-reference + path: products/sdk-reference/sdk-reference.yml + icon: fa-regular fa-books + subtitle: Auto-generated reference for every SignalWire SDK + # Column 3 (APIs) - display-name: APIs slug: apis diff --git a/fern/products/sdk-reference/cpp/_meta.json b/fern/products/sdk-reference/cpp/_meta.json new file mode 100644 index 0000000000..ffd6311149 --- /dev/null +++ b/fern/products/sdk-reference/cpp/_meta.json @@ -0,0 +1,10 @@ +{ + "language": "cpp", + "sdk_name": "cpp-sdk", + "version": null, + "source_repo": "https://github.com/signalwire/signalwire-cpp", + "format": "mdx", + "platform": "fern", + "base_slug": "/reference/cpp", + "item_count": 1633 +} \ No newline at end of file diff --git a/fern/products/sdk-reference/cpp/c-tool-context/index.mdx b/fern/products/sdk-reference/cpp/c-tool-context/index.mdx new file mode 100644 index 0000000000..6fdedff726 --- /dev/null +++ b/fern/products/sdk-reference/cpp/c-tool-context/index.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/c-tool-context" +title: "CToolContext" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "CToolContext" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/c_api/signalwire_c.cpp" + visibility: "public" +--- +# `CToolContext` + +## Signature + +```cpp +struct CToolContext +``` + +## Properties + + + + + +## Source + +[`src/c_api/signalwire_c.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/c_api/signalwire_c.cpp) + +Line 83. diff --git a/fern/products/sdk-reference/cpp/httplib/index.mdx b/fern/products/sdk-reference/cpp/httplib/index.mdx new file mode 100644 index 0000000000..afe1689ad0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/httplib/index.mdx @@ -0,0 +1,25 @@ +--- +slug: "/reference/cpp/httplib" +title: "httplib" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "httplib" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" +--- +# `httplib` + +## Signature + +```cpp +namespace httplib +``` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 26. diff --git a/fern/products/sdk-reference/cpp/index.mdx b/fern/products/sdk-reference/cpp/index.mdx new file mode 100644 index 0000000000..ae8bf837bf --- /dev/null +++ b/fern/products/sdk-reference/cpp/index.mdx @@ -0,0 +1,16 @@ +--- +title: "C++ SDK" +slug: "/reference/cpp" +lustri: + auto_generated: true + language: "cpp" + kind: "sdk" +--- +# C++ SDK Reference + +## Modules + +- [`httplib`](/reference/cpp/httplib) +- [`signalwire`](/reference/cpp/signalwire) +- [`std`](/reference/cpp/std) + diff --git a/fern/products/sdk-reference/cpp/signalwire/add-skill-directory.mdx b/fern/products/sdk-reference/cpp/signalwire/add-skill-directory.mdx new file mode 100644 index 0000000000..4146f462f4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/add-skill-directory.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/add-skill-directory" +title: "add_skill_directory" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::add_skill_directory" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/signalwire.cpp" + visibility: "public" +--- +# `add_skill_directory` + +Add a directory to search for skills. +Mirrors Python's signalwire.add\_skill\_directory(path) — delegates to the singleton skills::SkillRegistry instance so third-party skill collections can be registered by path. + +std::invalid\_argument + +when the path doesn't exist or isn't a directory. + +## Signature + +```cpp +void add_skill_directory(const std::string & path) +``` + +## Parameters + + + +## Throws + +- `std::invalid_argument` — when the path doesn't exist or isn't a directory. + +## Source + +[`src/signalwire.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/signalwire.cpp) + +Line 94. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-answer-verb.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-answer-verb.mdx new file mode 100644 index 0000000000..01b3d20f18 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-answer-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-answer-verb" +title: "add_answer_verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_answer_verb" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_answer_verb` + +## Signature + +```cpp +AgentBase & add_answer_verb(const std::string & verb_name, const json & params) +``` + +## Parameters + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 379. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-context.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-context.mdx new file mode 100644 index 0000000000..67f072a57f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-context.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-context" +title: "add_context" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_context" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_context` + +## Signature + +```cpp +contexts::Context & add_context(const std::string & name) +``` + +## Parameters + + + +## Returns + +`contexts::Context &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 391. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-function-include.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-function-include.mdx new file mode 100644 index 0000000000..770efa8883 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-function-include.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-function-include" +title: "add_function_include" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_function_include" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_function_include` + +## Signature + +```cpp +AgentBase & add_function_include(const json & include) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 369. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-hint.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-hint.mdx new file mode 100644 index 0000000000..98bcc1d114 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-hint.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-hint" +title: "add_hint" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_hint" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_hint` + +## Signature + +```cpp +AgentBase & add_hint(const std::string & hint) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 290. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-hints.mdx new file mode 100644 index 0000000000..79c824b457 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-hints" +title: "add_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_hints" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_hints` + +## Signature + +```cpp +AgentBase & add_hints(const std::vector< std::string > & hints) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 291. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-internal-filler.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-internal-filler.mdx new file mode 100644 index 0000000000..0d220820ea --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-internal-filler.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-internal-filler" +title: "add_internal_filler" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_internal_filler" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_internal_filler` + +Add internal fillers for a single language (legacy overload; stored under the given language key at the top level). + +## Signature + + + + ```cpp + AgentBase & add_internal_filler( + const std::string & lang, + const std::vector< std::string > & fillers + ) + ``` + + + + ```cpp + AgentBase & add_internal_filler( + const std::string & function_name, + const std::string & language_code, + const std::vector< std::string > & fillers + ) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + + + + + +## Returns (Overload 1) + +`AgentBase &` + +## Returns (Overload 2) + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 358. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-language.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-language.mdx new file mode 100644 index 0000000000..75fe6021f3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-language.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-language" +title: "add_language" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_language" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_language` + +## Signature + +```cpp +AgentBase & add_language(const LanguageConfig & lang) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 293. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-mcp-server.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-mcp-server.mdx new file mode 100644 index 0000000000..2fce4d4fb5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-mcp-server.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-mcp-server" +title: "add_mcp_server" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_mcp_server" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_mcp_server` + +## Signature + +```cpp +AgentBase & add_mcp_server( + const std::string & url, + const std::map< std::string, std::string > & headers = {}, + bool resources = false, + const std::map< std::string, std::string > & resource_vars = {} +) +``` + +## Parameters + + + + + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 411. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-pattern-hint.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-pattern-hint.mdx new file mode 100644 index 0000000000..180e041a65 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-pattern-hint.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-pattern-hint" +title: "add_pattern_hint" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_pattern_hint" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_pattern_hint` + +## Signature + +```cpp +AgentBase & add_pattern_hint(const std::string & pattern) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 292. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-post-ai-verb.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-post-ai-verb.mdx new file mode 100644 index 0000000000..90052027bc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-post-ai-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-post-ai-verb" +title: "add_post_ai_verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_post_ai_verb" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_post_ai_verb` + +## Signature + +```cpp +AgentBase & add_post_ai_verb(const std::string & verb_name, const json & params) +``` + +## Parameters + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 381. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-post-answer-verb.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-post-answer-verb.mdx new file mode 100644 index 0000000000..e4cb8e4bbe --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-post-answer-verb.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-post-answer-verb" +title: "add_post_answer_verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_post_answer_verb" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_post_answer_verb` + +## Signature + +```cpp +AgentBase & add_post_answer_verb( + const std::string & verb_name, + const json & params +) +``` + +## Parameters + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 380. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-pre-answer-verb.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..115aacf505 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-pre-answer-verb.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-pre-answer-verb" +title: "add_pre_answer_verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_pre_answer_verb" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_pre_answer_verb` + +## Signature + +```cpp +AgentBase & add_pre_answer_verb( + const std::string & verb_name, + const json & params +) +``` + +## Parameters + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 378. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-pronunciation.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-pronunciation.mdx new file mode 100644 index 0000000000..efd492ab49 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-pronunciation.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-pronunciation" +title: "add_pronunciation" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_pronunciation" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_pronunciation` + +## Signature + +```cpp +AgentBase & add_pronunciation( + const std::string & replace_val, + const std::string & with_val, + bool ignore_case = false +) +``` + +## Parameters + + + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 313. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-security-headers.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-security-headers.mdx new file mode 100644 index 0000000000..b93d08a8f7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-security-headers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-security-headers" +title: "add_security_headers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_security_headers" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `add_security_headers` + +**Modifiers:** `static` + +## Signature + +```cpp +void add_security_headers(httplib::Response & res) +``` + +## Parameters + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 543. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-skill.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-skill.mdx new file mode 100644 index 0000000000..2c624f7ba5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-skill.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-skill" +title: "add_skill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_skill" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_skill` + +## Signature + +```cpp +AgentBase & add_skill( + const std::string & skill_name, + const json & params = json::object() +) +``` + +## Parameters + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 402. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-swaig-query-param.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-swaig-query-param.mdx new file mode 100644 index 0000000000..a64874a329 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/add-swaig-query-param.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/add-swaig-query-param" +title: "add_swaig_query_param" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::add_swaig_query_param" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `add_swaig_query_param` + +## Signature + +```cpp +AgentBase & add_swaig_query_param( + const std::string & key, + const std::string & value +) +``` + +## Parameters + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 429. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/agent-base.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/agent-base.mdx new file mode 100644 index 0000000000..650f1ff145 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/agent-base.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/agent-base" +title: "AgentBase" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::AgentBase" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `AgentBase` + +**Modifiers:** `explicit` + +## Signature + + + + ```cpp + void AgentBase( + const std::string & name = "agent", + const std::string & route = "/", + const std::string & host = "0.0.0.0", + int port = 3000 + ) + ``` + + + + ```cpp + void AgentBase(const AgentBase & other) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + +## Parameters (Overload 2) + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 115. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/agent-base__2.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/agent-base__2.mdx new file mode 100644 index 0000000000..a42373db1d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/agent-base__2.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/agent-base__2" +title: "~AgentBase" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::~AgentBase" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `~AgentBase` + +**Modifiers:** `virtual` + +## Signature + +```cpp +void ~AgentBase() +``` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 119. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/auth-password.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/auth-password.mdx new file mode 100644 index 0000000000..58101da7cf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/auth-password.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/auth-password" +title: "auth_password" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::auth_password" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `auth_password` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & auth_password() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 447. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/auth-username.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/auth-username.mdx new file mode 100644 index 0000000000..ecc880da65 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/auth-username.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/auth-username" +title: "auth_username" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::auth_username" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `auth_username` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & auth_username() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 446. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/auto-map-sip-usernames.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/auto-map-sip-usernames.mdx new file mode 100644 index 0000000000..ef4e85357b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/auto-map-sip-usernames.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/auto-map-sip-usernames" +title: "auto_map_sip_usernames" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::auto_map_sip_usernames" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `auto_map_sip_usernames` + +## Signature + +```cpp +AgentBase & auto_map_sip_usernames(bool enable = true) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 439. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-ai-verb.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-ai-verb.mdx new file mode 100644 index 0000000000..9c79846e6f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-ai-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/build-ai-verb" +title: "build_ai_verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::build_ai_verb" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `build_ai_verb` + +**Modifiers:** `const` + +## Signature + +```cpp +json build_ai_verb(const std::string & webhook_url) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 516. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-mcp-tool-list.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-mcp-tool-list.mdx new file mode 100644 index 0000000000..beb3e24edf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-mcp-tool-list.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/build-mcp-tool-list" +title: "build_mcp_tool_list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::build_mcp_tool_list" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `build_mcp_tool_list` + +**Modifiers:** `const` + +## Signature + +```cpp +std::vector< json > build_mcp_tool_list() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 418. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-prompt.mdx new file mode 100644 index 0000000000..d4f23c6555 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-prompt.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/build-prompt" +title: "build_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::build_prompt" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `build_prompt` + +**Modifiers:** `const` + +## Signature + +```cpp +json build_prompt() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 522. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-swaig-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-swaig-functions.mdx new file mode 100644 index 0000000000..4c2d6c1270 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-swaig-functions.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/build-swaig-functions" +title: "build_swaig_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::build_swaig_functions" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `build_swaig_functions` + +**Modifiers:** `const` + +## Signature + +```cpp +json build_swaig_functions(const std::string & webhook_url) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 519. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-webhook-url.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-webhook-url.mdx new file mode 100644 index 0000000000..dde29c9f2c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/build-webhook-url.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/build-webhook-url" +title: "build_webhook_url" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::build_webhook_url" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `build_webhook_url` + +**Modifiers:** `const` + +## Signature + +```cpp +std::string build_webhook_url(const std::string & base_url) const +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 510. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..8162239374 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-post-ai-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/clear-post-ai-verbs" +title: "clear_post_ai_verbs" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::clear_post_ai_verbs" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `clear_post_ai_verbs` + +## Signature + +```cpp +AgentBase & clear_post_ai_verbs() +``` + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 384. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..d57dda77da --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-post-answer-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/clear-post-answer-verbs" +title: "clear_post_answer_verbs" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::clear_post_answer_verbs" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `clear_post_answer_verbs` + +## Signature + +```cpp +AgentBase & clear_post_answer_verbs() +``` + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 383. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..06751d72ef --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-pre-answer-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/clear-pre-answer-verbs" +title: "clear_pre_answer_verbs" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::clear_pre_answer_verbs" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `clear_pre_answer_verbs` + +## Signature + +```cpp +AgentBase & clear_pre_answer_verbs() +``` + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 382. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-swaig-query-params.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..75ab1d55f4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clear-swaig-query-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/clear-swaig-query-params" +title: "clear_swaig_query_params" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::clear_swaig_query_params" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `clear_swaig_query_params` + +## Signature + +```cpp +AgentBase & clear_swaig_query_params() +``` + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 430. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clone.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clone.mdx new file mode 100644 index 0000000000..bccc987351 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/clone.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/clone" +title: "clone" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::clone" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `clone` + +**Modifiers:** `const` + +## Signature + +```cpp +std::unique_ptr< AgentBase > clone() const +``` + +## Returns + +`std::unique_ptr< AgentBase >` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 507. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/create-tool-token.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/create-tool-token.mdx new file mode 100644 index 0000000000..c8e83a946d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/create-tool-token.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/create-tool-token" +title: "create_tool_token" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::create_tool_token" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `create_tool_token` + +Mint a per-call SWAIG-function token via the agent's SessionManager. +Python parity: state\_mixin.StateMixin.\_create\_tool\_token — delegates to SessionManager::create\_token and returns an empty string on any thrown exception (Python catches all exceptions and returns "" on error). + +**Modifiers:** `const` + +## Signature + +```cpp +std::string create_tool_token( + const std::string & tool_name, + const std::string & call_id +) const +``` + +## Parameters + + + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 273. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/define-contexts.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/define-contexts.mdx new file mode 100644 index 0000000000..ca0898dd2c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/define-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/define-contexts" +title: "define_contexts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::define_contexts" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `define_contexts` + +## Signature + +```cpp +contexts::ContextBuilder & define_contexts() +``` + +## Returns + +`contexts::ContextBuilder &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 390. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/define-tool.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/define-tool.mdx new file mode 100644 index 0000000000..3bc6e1d2c0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/define-tool.mdx @@ -0,0 +1,84 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/define-tool" +title: "define_tool" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::define_tool" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `define_tool` + +Register a SWAIG tool (function) that the AI can invoke during a call. + +How this becomes a tool the model seesA SWAIG function is exactly the same concept as a "tool" in native OpenAI / Anthropic tool calling. On every LLM turn, the SDK renders each registered SWAIG function into the OpenAI tool schema: +\{ "type": "function", "function": \{ "name": "your\_name\_here", "description": "your description text", "parameters": \{ ... your JSON schema ... \} \} \} +That schema is sent to the model as part of the same API call that produces the next assistant message. The model reads: +the function description to decide WHEN to call this tool +each parameter description (inside parameters) to decide HOW to fill in that argument from the user's utterance + +This means descriptions are prompt engineering, not developer comments. A vague description is the #1 cause of "the model has +the right tool but doesn't call it" failures. + +Bad vs good descriptionsBAD : description: "Lookup function" GOOD: description: "Look up a customer's account details by " "account number. Use this BEFORE quoting " "any account-specific info (balance, plan, " "status). Do not use for general product " "questions." +BAD : parameters: \{"id": \{"type": "string", "description": "the id"\}\} GOOD: parameters: \{"account\_number": \{"type": "string", "description": "The customer's 8-digit account " "number, no dashes or spaces. Ask the user if they " "don't provide it."\}\} + +Tool count mattersLLM tool selection accuracy degrades past ~7-8 simultaneously-active tools per call. Use contexts::Step::set\_functions to partition tools across steps so only the relevant subset is active at any moment. + +## Signature + + + + ```cpp + AgentBase & define_tool(const swaig::ToolDefinition & tool) + ``` + + + + ```cpp + AgentBase & define_tool( + const std::string & name, + const std::string & description, + const json & parameters, + swaig::ToolHandler handler, + bool secure = false + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + + + + + + + +## Returns (Overload 1) + +`AgentBase &` + +## Returns (Overload 2) + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 257. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/detect-proxy-url.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/detect-proxy-url.mdx new file mode 100644 index 0000000000..9cd989282e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/detect-proxy-url.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/detect-proxy-url" +title: "detect_proxy_url" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::detect_proxy_url" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `detect_proxy_url` + +**Modifiers:** `const` + +## Signature + +```cpp +std::string detect_proxy_url( + const std::map< std::string, std::string > & headers +) const +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 513. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-debug-events.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-debug-events.mdx new file mode 100644 index 0000000000..5ca30fbde9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-debug-events.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/enable-debug-events" +title: "enable_debug_events" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::enable_debug_events" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `enable_debug_events` + +## Signature + +```cpp +AgentBase & enable_debug_events(bool enable = true) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 368. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-debug-routes.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-debug-routes.mdx new file mode 100644 index 0000000000..f52a568f10 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-debug-routes.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/enable-debug-routes" +title: "enable_debug_routes" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::enable_debug_routes" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `enable_debug_routes` + +## Signature + +```cpp +AgentBase & enable_debug_routes(bool enable = true) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 431. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-mcp-server.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-mcp-server.mdx new file mode 100644 index 0000000000..dc26ed7ddf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-mcp-server.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/enable-mcp-server" +title: "enable_mcp_server" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::enable_mcp_server" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `enable_mcp_server` + +## Signature + +```cpp +AgentBase & enable_mcp_server(bool enable = true) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 415. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-sip-routing.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-sip-routing.mdx new file mode 100644 index 0000000000..ece39d897e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/enable-sip-routing.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/enable-sip-routing" +title: "enable_sip_routing" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::enable_sip_routing" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `enable_sip_routing` + +## Signature + +```cpp +AgentBase & enable_sip_routing(bool enable = true) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 437. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-contexts.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-contexts.mdx new file mode 100644 index 0000000000..40e18c07f4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/get-contexts" +title: "get_contexts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::get_contexts" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `get_contexts` + +Returns the contexts dictionary as a serialised JSON object, or std::nullopt when no contexts have been defined yet. +Mirrors Python's PromptManager.get\_contexts which returns the contexts dict or None. + +**Modifiers:** `const` + +## Signature + +```cpp +std::optional< json > get_contexts() const +``` + +## Returns + +`std::optional< json >` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 195. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-language-params.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-language-params.mdx new file mode 100644 index 0000000000..557b213071 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-language-params.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/get-language-params" +title: "get_language_params" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::get_language_params" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `get_language_params` + +Read the per-language params dict for a previously-added language. Returns std::nullopt when the code is unknown or when params were never set on that language — no exception path, mirroring Python's None return. +Python parity: AIConfigMixin.get\_language\_params (029ca6f). + +**Modifiers:** `const` + +## Signature + +```cpp +std::optional< json > get_language_params(const std::string & code) const +``` + +## Parameters + + + +## Returns + +`std::optional< json >` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 312. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-post-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-post-prompt.mdx new file mode 100644 index 0000000000..9aa197ff1f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-post-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/get-post-prompt" +title: "get_post_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::get_post_prompt" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `get_post_prompt` + +Returns the post-prompt text whatever set\_post\_prompt stored, or std::nullopt when no post-prompt has been set. +Mirrors Python's PromptManager.get\_post\_prompt / PromptMixin.get\_post\_prompt — used by SWML rendering when a post-prompt is configured. + +**Modifiers:** `const` + +## Signature + +```cpp +std::optional< std::string > get_post_prompt() const +``` + +## Returns + +`std::optional< std::string >` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 172. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-prompt.mdx new file mode 100644 index 0000000000..1c04758eef --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-prompt.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/get-prompt" +title: "get_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::get_prompt" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `get_prompt` + +**Modifiers:** `const` + +## Signature + +```cpp +std::string get_prompt() const +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 153. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-raw-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-raw-prompt.mdx new file mode 100644 index 0000000000..de3fb49a06 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/get-raw-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/get-raw-prompt" +title: "get_raw_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::get_raw_prompt" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `get_raw_prompt` + +Returns the raw prompt text whatever set\_prompt\_text stored, or std::nullopt when no raw prompt has been set. Distinct from get\_prompt which renders the POM array when use\_pom is true. +Mirrors Python's PromptManager.get\_raw\_prompt. + +**Modifiers:** `const` + +## Signature + +```cpp +std::optional< std::string > get_raw_prompt() const +``` + +## Returns + +`std::optional< std::string >` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 180. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-mcp-request.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-mcp-request.mdx new file mode 100644 index 0000000000..7162b9129b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-mcp-request.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/handle-mcp-request" +title: "handle_mcp_request" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::handle_mcp_request" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `handle_mcp_request` + +## Signature + +```cpp +json handle_mcp_request(const json & body) +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 419. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-post-prompt-request.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-post-prompt-request.mdx new file mode 100644 index 0000000000..89c4303147 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-post-prompt-request.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/handle-post-prompt-request" +title: "handle_post_prompt_request" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::handle_post_prompt_request" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `handle_post_prompt_request` + +## Signature + +```cpp +void handle_post_prompt_request( + const httplib::Request & req, + httplib::Response & res +) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 537. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-swaig-request.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-swaig-request.mdx new file mode 100644 index 0000000000..741ad0724b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-swaig-request.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/handle-swaig-request" +title: "handle_swaig_request" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::handle_swaig_request" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `handle_swaig_request` + +## Signature + +```cpp +void handle_swaig_request(const httplib::Request & req, httplib::Response & res) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 534. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-swml-request.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-swml-request.mdx new file mode 100644 index 0000000000..deb0bfe8df --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/handle-swml-request.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/handle-swml-request" +title: "handle_swml_request" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::handle_swml_request" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `handle_swml_request` + +## Signature + +```cpp +void handle_swml_request(const httplib::Request & req, httplib::Response & res) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 531. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/has-contexts.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/has-contexts.mdx new file mode 100644 index 0000000000..7f82a467b2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/has-contexts.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/has-contexts" +title: "has_contexts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::has_contexts" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `has_contexts` + +**Modifiers:** `const` + +## Signature + +```cpp +bool has_contexts() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 392. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/has-skill.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/has-skill.mdx new file mode 100644 index 0000000000..9f1651ae2e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/has-skill.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/has-skill" +title: "has_skill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::has_skill" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `has_skill` + +**Modifiers:** `const` + +## Signature + +```cpp +bool has_skill(const std::string & skill_name) const +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 404. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/index.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/index.mdx new file mode 100644 index 0000000000..2885595caf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/index.mdx @@ -0,0 +1,282 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base" +title: "AgentBase" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase" + parent: "signalwire::agent" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `AgentBase` + +## Signature + +```cpp +class signalwire::agent::AgentBase : signalwire::swml::Service +``` + +## Inheritance + +**Extends:** [signalwire::swml::Service](/reference/cpp/signalwire/swml/service) + +## Methods + + + + + + + + + + + + + + + + Add internal fillers for a single language (legacy overload; stored under the given language key at the top level). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Mint a per-call SWAIG-function token via the agent's SessionManager. Python parity: state\_mixin.StateMixin.\_create\_tool\_token — delegates to SessionManager::create\_token and returns an empty string on any thrown exception (Python catches all exceptions and returns "" on error). + + + + + + Register a SWAIG tool (function) that the AI can invoke during a call. + + + + + + + + + + + + + + Returns the contexts dictionary as a serialised JSON object, or std::nullopt when no contexts have been defined yet. Mirrors Python's PromptManager.get\_contexts which returns the contexts dict or None. + + + + Read the per-language params dict for a previously-added language. Returns std::nullopt when the code is unknown or when params were never set on that language — no exception path, mirroring Python's None return. Python parity: AIConfigMixin.get\_language\_params (029ca6f). + + + + Returns the post-prompt text whatever set\_post\_prompt stored, or std::nullopt when no post-prompt has been set. Mirrors Python's PromptManager.get\_post\_prompt / PromptMixin.get\_post\_prompt — used by SWML rendering when a post-prompt is configured. + + + + + + Returns the raw prompt text whatever set\_prompt\_text stored, or std::nullopt when no raw prompt has been set. Distinct from get\_prompt which renders the POM array when use\_pom is true. Mirrors Python's PromptManager.get\_raw\_prompt. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Dispatch a function call to the registered handler. Returns a FunctionResult; if the function isn't registered, returns a FunctionResult with a "Function not found" response. + + + + + + + + Read-only snapshot of the agent's POM as a PromptObjectModel. Python parity: agent.pom instance attribute (agent\_base.py line 209). Returns std::nullopt when use\_pom is false (mirroring Python's self.pom = None); otherwise returns a freshly built signalwire::pom::PromptObjectModel whose sections are deep-copied from the agent's internal section/ subsection structures so callers cannot mutate them in-place. + + + + + + + + + + + + + + + + + + + + + + + + Remove all contexts, returning the agent to a no-contexts state. Convenience wrapper around define\_contexts().reset(). + + + + + + + + + + + + + + + + + + Set internal fillers for native SWAIG functions. Internal fillers are short phrases the AI agent speaks (via TTS) while an internal/native function is running, so the caller doesn't hear dead air during transitions or background work. Supported function names (match the SWAIGInternalFiller schema): hangup, check\_time, wait\_for\_user, wait\_seconds, adjust\_response\_latency, next\_step, change\_context, get\_visual\_input, get\_ideal\_strategy. See supported\_internal\_filler\_names(). Notably NOT supported: change\_step, gather\_submit, or arbitrary user-defined SWAIG function names. The runtime only honors fillers for the names listed above; everything else is silently ignored at the SWML level. This method warns at registration time if you pass an unknown name so you catch the typo early. Expected JSON shape: \{"function\_name": \{"language\_code": \["phrase1", ...]\}, ...\} + + + + Set (or replace) the per-language params dict on an already-added language. Useful when language entries are built via add\_language() first and engine-specific tuning is added later (e.g. from a config loader). Passing an empty object removes the params key (treated as unset). No-op if code isn't found among previously-added languages. Python parity: AIConfigMixin.set\_language\_params (029ca6f). + + + + + + + + + + + + + + + + + + + + + + + + Sets the prompt as a list of POM section JSON objects. Each section supports keys "title", "body", "bullets", "numbered", "numbered\_bullets", and "subsections". Switches the agent to POM mode. Mirrors Python's PromptManager.set\_prompt\_pom. + + + + + + + + Set the SignalWire Signing Key (Dashboard → API Credentials). Pass the empty string to clear and revert to env-fallback behavior. + + + + + + + + + + Read the resolved signing key (constructor / set\_signing\_key / SIGNALWIRE\_SIGNING\_KEY env), or std::nullopt when unset. The returned value is the secret — never log it. + + + + + + The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — set\_internal\_fillers and add\_internal\_filler warn if you pass an unknown name. Notable absences: change\_step, gather\_submit, and arbitrary user-defined SWAIG function names are NOT supported. + + + + If true, X-Forwarded-Proto / X-Forwarded-Host are honored by the webhook middleware when reconstructing the URL. Default false — proxy headers are spoofable so opt in only when the reverse-proxy is trusted. + + + + + + + + Validate a per-call SWAIG-function token. Returns false when the function is not registered, when the SessionManager rejects the token, or on any underlying exception. Python parity: state\_mixin.StateMixin.validate\_tool\_token — rejects unknown function names up-front and swallows exceptions. + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 112. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/init-auth.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/init-auth.mdx new file mode 100644 index 0000000000..2e198508ce --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/init-auth.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/init-auth" +title: "init_auth" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::init_auth" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `init_auth` + +## Signature + +```cpp +void init_auth() +``` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 525. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/is-mcp-server-enabled.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/is-mcp-server-enabled.mdx new file mode 100644 index 0000000000..5f90efa5f2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/is-mcp-server-enabled.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/is-mcp-server-enabled" +title: "is_mcp_server_enabled" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::is_mcp_server_enabled" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `is_mcp_server_enabled` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool is_mcp_server_enabled() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 416. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/list-skills.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/list-skills.mdx new file mode 100644 index 0000000000..98edc4534c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/list-skills.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/list-skills" +title: "list_skills" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::list_skills" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `list_skills` + +**Modifiers:** `const` + +## Signature + +```cpp +std::vector< std::string > list_skills() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 405. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/list-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/list-tools.mdx new file mode 100644 index 0000000000..90274bc75b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/list-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/list-tools" +title: "list_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::list_tools" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `list_tools` + +**Modifiers:** `const` + +## Signature + +```cpp +std::vector< std::string > list_tools() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 265. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/manual-set-proxy-url.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..a6de26a0a5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/manual-set-proxy-url.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/manual-set-proxy-url" +title: "manual_set_proxy_url" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::manual_set_proxy_url" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `manual_set_proxy_url` + +## Signature + +```cpp +AgentBase & manual_set_proxy_url(const std::string & url) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 426. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/mcp-servers.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/mcp-servers.mdx new file mode 100644 index 0000000000..9603e868ec --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/mcp-servers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/mcp-servers" +title: "mcp_servers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::mcp_servers" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `mcp_servers` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::vector< json > & mcp_servers() const +``` + +## Returns + +`const std::vector< json > &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 417. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/on-debug-event.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/on-debug-event.mdx new file mode 100644 index 0000000000..491d86bd07 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/on-debug-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/on-debug-event" +title: "on_debug_event" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::on_debug_event" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `on_debug_event` + +## Signature + +```cpp +AgentBase & on_debug_event(DebugEventCallback cb) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 483. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/on-function-call.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/on-function-call.mdx new file mode 100644 index 0000000000..0619c59ee0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/on-function-call.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/on-function-call" +title: "on_function_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::on_function_call" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `on_function_call` + +Dispatch a function call to the registered handler. Returns a FunctionResult; if the function isn't registered, returns a FunctionResult with a "Function not found" response. + +**Modifiers:** `virtual` + +## Signature + +```cpp +swaig::FunctionResult on_function_call( + const std::string & name, + const json & args, + const json & raw_data +) +``` + +## Parameters + + + + + + + +## Returns + +`swaig::FunctionResult` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 262. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/on-summary.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/on-summary.mdx new file mode 100644 index 0000000000..216c397654 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/on-summary.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/on-summary" +title: "on_summary" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::on_summary" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `on_summary` + +## Signature + +```cpp +AgentBase & on_summary(SummaryCallback cb) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 482. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/operator.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/operator.mdx new file mode 100644 index 0000000000..eda3d4b1bc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/operator.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/operator" +title: "operator=" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::operator=" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `operator=` + +## Signature + +```cpp +AgentBase & operator=(const AgentBase &) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 123. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/pom.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/pom.mdx new file mode 100644 index 0000000000..65b3e580b6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/pom.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/pom" +title: "pom" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::pom" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `pom` + +Read-only snapshot of the agent's POM as a PromptObjectModel. +Python parity: agent.pom instance attribute (agent\_base.py line 209). Returns std::nullopt when use\_pom is false (mirroring Python's self.pom = None); otherwise returns a freshly built signalwire::pom::PromptObjectModel whose sections are deep-copied from the agent's internal section/ subsection structures so callers cannot mutate them in-place. + +**Modifiers:** `const` + +## Signature + +```cpp +std::optional< signalwire::pom::PromptObjectModel > pom() const +``` + +## Returns + +`std::optional< signalwire::pom::PromptObjectModel >` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 164. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-add-section.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-add-section.mdx new file mode 100644 index 0000000000..c33601e9d2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-add-section.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/prompt-add-section" +title: "prompt_add_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::prompt_add_section" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `prompt_add_section` + +## Signature + +```cpp +AgentBase & prompt_add_section( + const std::string & title, + const std::string & body = "", + const std::vector< std::string > & bullets = {} +) +``` + +## Parameters + + + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 142. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-add-subsection.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-add-subsection.mdx new file mode 100644 index 0000000000..e9b87b9468 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-add-subsection.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/prompt-add-subsection" +title: "prompt_add_subsection" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::prompt_add_subsection" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `prompt_add_subsection` + +## Signature + +```cpp +AgentBase & prompt_add_subsection( + const std::string & parent_title, + const std::string & title, + const std::string & body = "", + const std::vector< std::string > & bullets = {} +) +``` + +## Parameters + + + + + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 145. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-add-to-section.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-add-to-section.mdx new file mode 100644 index 0000000000..6a45004857 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-add-to-section.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/prompt-add-to-section" +title: "prompt_add_to_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::prompt_add_to_section" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `prompt_add_to_section` + +## Signature + +```cpp +AgentBase & prompt_add_to_section( + const std::string & title, + const std::string & body = "", + const std::vector< std::string > & bullets = {} +) +``` + +## Parameters + + + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 149. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-has-section.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-has-section.mdx new file mode 100644 index 0000000000..b05b815a3f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/prompt-has-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/prompt-has-section" +title: "prompt_has_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::prompt_has_section" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `prompt_has_section` + +**Modifiers:** `const` + +## Signature + +```cpp +bool prompt_has_section(const std::string & title) const +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 152. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/register-sip-username.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/register-sip-username.mdx new file mode 100644 index 0000000000..9648d7ead6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/register-sip-username.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/register-sip-username" +title: "register_sip_username" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::register_sip_username" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `register_sip_username` + +## Signature + +```cpp +AgentBase & register_sip_username(const std::string & username) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 438. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/register-swaig-function.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/register-swaig-function.mdx new file mode 100644 index 0000000000..d38eff51bd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/register-swaig-function.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/register-swaig-function" +title: "register_swaig_function" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::register_swaig_function" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `register_swaig_function` + +## Signature + +```cpp +AgentBase & register_swaig_function(const json & func_def) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 261. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/remove-skill.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/remove-skill.mdx new file mode 100644 index 0000000000..169f6c21bb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/remove-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/remove-skill" +title: "remove_skill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::remove_skill" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `remove_skill` + +## Signature + +```cpp +AgentBase & remove_skill(const std::string & skill_name) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 403. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/render-swml-for-request.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/render-swml-for-request.mdx new file mode 100644 index 0000000000..416c30edb5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/render-swml-for-request.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/render-swml-for-request" +title: "render_swml_for_request" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::render_swml_for_request" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `render_swml_for_request` + +**Modifiers:** `const` + +## Signature + +```cpp +json render_swml_for_request( + const std::map< std::string, std::string > & query_params, + const json & body_params, + const std::map< std::string, std::string > & headers +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 490. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/render-swml-internal.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/render-swml-internal.mdx new file mode 100644 index 0000000000..c74bd12977 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/render-swml-internal.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/render-swml-internal" +title: "render_swml_internal" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::render_swml_internal" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `render_swml_internal` + +**Modifiers:** `const` + +## Signature + +```cpp +json render_swml_internal( + const std::map< std::string, std::string > & headers +) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 546. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/render-swml.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/render-swml.mdx new file mode 100644 index 0000000000..45e4a743ef --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/render-swml.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/render-swml" +title: "render_swml" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::render_swml" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `render_swml` + +**Modifiers:** `const` + +## Signature + +```cpp +json render_swml() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 489. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/reset-contexts.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/reset-contexts.mdx new file mode 100644 index 0000000000..d81d9ec111 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/reset-contexts.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/reset-contexts" +title: "reset_contexts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::reset_contexts" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `reset_contexts` + +Remove all contexts, returning the agent to a no-contexts state. Convenience wrapper around define\_contexts().reset(). + +## Signature + +```cpp +AgentBase & reset_contexts() +``` + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 396. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/run.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/run.mdx new file mode 100644 index 0000000000..ae9457febe --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/run.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/run" +title: "run" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::run" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `run` + +## Signature + +```cpp +void run() +``` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 498. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/serve.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/serve.mdx new file mode 100644 index 0000000000..da3320cfae --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/serve.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/serve" +title: "serve" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::serve" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `serve` + +## Signature + +```cpp +void serve() +``` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 499. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/session-manager.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/session-manager.mdx new file mode 100644 index 0000000000..bf9689c151 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/session-manager.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/session-manager" +title: "session_manager" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::session_manager" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `session_manager` + +**Modifiers:** `inline` + +## Signature + +```cpp +security::SessionManager & session_manager() +``` + +## Returns + +`security::SessionManager &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 503. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-auth.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-auth.mdx new file mode 100644 index 0000000000..5f67f35c10 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-auth.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-auth" +title: "set_auth" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_auth" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_auth` + +## Signature + +```cpp +AgentBase & set_auth(const std::string & username, const std::string & password) +``` + +## Parameters + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 445. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..83b9f9375e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-dynamic-config-callback.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-dynamic-config-callback" +title: "set_dynamic_config_callback" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_dynamic_config_callback" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_dynamic_config_callback` + +## Signature + +```cpp +AgentBase & set_dynamic_config_callback(DynamicConfigCallback cb) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 425. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-function-includes.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-function-includes.mdx new file mode 100644 index 0000000000..0479d9821b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-function-includes.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-function-includes" +title: "set_function_includes" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_function_includes" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_function_includes` + +## Signature + +```cpp +AgentBase & set_function_includes(const std::vector< json > & includes) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 370. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-global-data.mdx new file mode 100644 index 0000000000..35834a8514 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-global-data" +title: "set_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_global_data" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_global_data` + +## Signature + +```cpp +AgentBase & set_global_data(const json & data) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 319. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-internal-fillers.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-internal-fillers.mdx new file mode 100644 index 0000000000..b34c359f45 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-internal-fillers.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-internal-fillers" +title: "set_internal_fillers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_internal_fillers" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_internal_fillers` + +Set internal fillers for native SWAIG functions. +Internal fillers are short phrases the AI agent speaks (via TTS) while an internal/native function is running, so the caller doesn't hear dead air during transitions or background work. +Supported function names (match the SWAIGInternalFiller schema): hangup, check\_time, wait\_for\_user, wait\_seconds, adjust\_response\_latency, next\_step, change\_context, get\_visual\_input, get\_ideal\_strategy. See supported\_internal\_filler\_names(). +Notably NOT supported: change\_step, gather\_submit, or arbitrary user-defined SWAIG function names. The runtime only honors fillers for the names listed above; everything else is silently ignored at the SWML level. This method warns at registration time if you pass an unknown name so you catch the typo early. +Expected JSON shape: \{"function\_name": \{"language\_code": \["phrase1", ...]\}, ...\} + +## Signature + +```cpp +AgentBase & set_internal_fillers(const json & fillers) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 354. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-language-params.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-language-params.mdx new file mode 100644 index 0000000000..2d998a3e4f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-language-params.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-language-params" +title: "set_language_params" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_language_params" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_language_params` + +Set (or replace) the per-language params dict on an already-added language. Useful when language entries are built via add\_language() first and engine-specific tuning is added later (e.g. from a config loader). Passing an empty object removes the params key (treated as unset). No-op if code isn't found among previously-added languages. +Python parity: AIConfigMixin.set\_language\_params (029ca6f). + +## Signature + +```cpp +AgentBase & set_language_params(const std::string & code, const json & params) +``` + +## Parameters + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 304. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-languages.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-languages.mdx new file mode 100644 index 0000000000..45bc2527cc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-languages.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-languages" +title: "set_languages" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_languages" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_languages` + +## Signature + +```cpp +AgentBase & set_languages(const std::vector< LanguageConfig > & langs) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 294. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-name.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-name.mdx new file mode 100644 index 0000000000..b1e5be2685 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-name.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-name" +title: "set_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_name" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_name` + +**Modifiers:** `inline` + +## Signature + +```cpp +AgentBase & set_name(const std::string & n) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 130. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-native-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-native-functions.mdx new file mode 100644 index 0000000000..c0cf7e36b3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-native-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-native-functions" +title: "set_native_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_native_functions" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_native_functions` + +## Signature + +```cpp +AgentBase & set_native_functions(const std::vector< std::string > & funcs) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 321. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-param.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-param.mdx new file mode 100644 index 0000000000..45c654e2d6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-param.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-param" +title: "set_param" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_param" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_param` + +## Signature + +```cpp +AgentBase & set_param(const std::string & key, const json & value) +``` + +## Parameters + + + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 317. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-params.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-params.mdx new file mode 100644 index 0000000000..fedf7e8082 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-params" +title: "set_params" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_params" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_params` + +## Signature + +```cpp +AgentBase & set_params(const json & params) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 318. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..983e075061 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt-llm-params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-post-prompt-llm-params" +title: "set_post_prompt_llm_params" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_post_prompt_llm_params" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_post_prompt_llm_params` + +## Signature + +```cpp +AgentBase & set_post_prompt_llm_params(const json & params) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 372. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt-url-direct.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt-url-direct.mdx new file mode 100644 index 0000000000..d5c1d7df38 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt-url-direct.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-post-prompt-url-direct" +title: "set_post_prompt_url_direct" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_post_prompt_url_direct" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_post_prompt_url_direct` + +## Signature + +```cpp +AgentBase & set_post_prompt_url_direct(const std::string & url) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 428. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt-url.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt-url.mdx new file mode 100644 index 0000000000..14a2c4c41d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt-url.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-post-prompt-url" +title: "set_post_prompt_url" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_post_prompt_url" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_post_prompt_url` + +## Signature + +```cpp +AgentBase & set_post_prompt_url(const std::string & url) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 141. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt.mdx new file mode 100644 index 0000000000..e882735fa4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-post-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-post-prompt" +title: "set_post_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_post_prompt" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_post_prompt` + +## Signature + +```cpp +AgentBase & set_post_prompt(const std::string & text) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 140. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-prompt-llm-params.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..27111bc808 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-prompt-llm-params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-prompt-llm-params" +title: "set_prompt_llm_params" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_prompt_llm_params" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_prompt_llm_params` + +## Signature + +```cpp +AgentBase & set_prompt_llm_params(const json & params) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 371. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-prompt-pom.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-prompt-pom.mdx new file mode 100644 index 0000000000..a417eef7f7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-prompt-pom.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-prompt-pom" +title: "set_prompt_pom" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_prompt_pom" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_prompt_pom` + +Sets the prompt as a list of POM section JSON objects. Each section supports keys "title", "body", "bullets", "numbered", "numbered\_bullets", and "subsections". Switches the agent to POM mode. +Mirrors Python's PromptManager.set\_prompt\_pom. + +## Signature + +```cpp +AgentBase & set_prompt_pom(const std::vector< json > & pom) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 188. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-prompt-text.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-prompt-text.mdx new file mode 100644 index 0000000000..34fb50884f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-prompt-text.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-prompt-text" +title: "set_prompt_text" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_prompt_text" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_prompt_text` + +## Signature + +```cpp +AgentBase & set_prompt_text(const std::string & text) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 139. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-pronunciations.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-pronunciations.mdx new file mode 100644 index 0000000000..05a2bafba3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-pronunciations.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-pronunciations" +title: "set_pronunciations" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_pronunciations" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_pronunciations` + +## Signature + +```cpp +AgentBase & set_pronunciations(const std::vector< Pronunciation > & pronuns) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 316. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-signing-key.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-signing-key.mdx new file mode 100644 index 0000000000..d2204ff786 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-signing-key.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-signing-key" +title: "set_signing_key" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_signing_key" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_signing_key` + +Set the SignalWire Signing Key (Dashboard → API Credentials). Pass the empty string to clear and revert to env-fallback behavior. + +## Signature + +```cpp +AgentBase & set_signing_key(const std::string & key) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 465. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-use-pom.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-use-pom.mdx new file mode 100644 index 0000000000..93ef23528d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-use-pom.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-use-pom" +title: "set_use_pom" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_use_pom" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_use_pom` + +## Signature + +```cpp +AgentBase & set_use_pom(bool use_pom) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 154. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-webhook-url.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-webhook-url.mdx new file mode 100644 index 0000000000..7196cc9990 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/set-webhook-url.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/set-webhook-url" +title: "set_webhook_url" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::set_webhook_url" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `set_webhook_url` + +## Signature + +```cpp +AgentBase & set_webhook_url(const std::string & url) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 427. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/setup-routes.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/setup-routes.mdx new file mode 100644 index 0000000000..d0d839d966 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/setup-routes.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/setup-routes" +title: "setup_routes" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::setup_routes" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `setup_routes` + +## Signature + +```cpp +void setup_routes(httplib::Server & server) +``` + +## Parameters + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 528. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/signing-key.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/signing-key.mdx new file mode 100644 index 0000000000..9178b92b70 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/signing-key.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/signing-key" +title: "signing_key" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::signing_key" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `signing_key` + +Read the resolved signing key (constructor / set\_signing\_key / SIGNALWIRE\_SIGNING\_KEY env), or std::nullopt when unset. The returned value is the secret — never log it. + +**Modifiers:** `const` + +## Signature + +```cpp +std::optional< std::string > signing_key() const +``` + +## Returns + +`std::optional< std::string >` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 470. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/stop.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/stop.mdx new file mode 100644 index 0000000000..4150e3e928 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/stop" +title: "stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::stop" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `stop` + +## Signature + +```cpp +void stop() +``` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 500. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/supported-internal-filler-names.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/supported-internal-filler-names.mdx new file mode 100644 index 0000000000..b7ab73b35f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/supported-internal-filler-names.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/supported-internal-filler-names" +title: "supported_internal_filler_names" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::supported_internal_filler_names" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `supported_internal_filler_names` + +The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — set\_internal\_fillers and add\_internal\_filler warn if you pass an unknown name. +Notable absences: change\_step, gather\_submit, and arbitrary user-defined SWAIG function names are NOT supported. + +**Modifiers:** `static` + +## Signature + +```cpp +const std::set< std::string > & supported_internal_filler_names() +``` + +## Returns + +`const std::set< std::string > &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 330. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/trust-proxy-for-signature.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/trust-proxy-for-signature.mdx new file mode 100644 index 0000000000..b1784f5e06 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/trust-proxy-for-signature.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/trust-proxy-for-signature" +title: "trust_proxy_for_signature" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::trust_proxy_for_signature" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `trust_proxy_for_signature` + +If true, X-Forwarded-Proto / X-Forwarded-Host are honored by the webhook middleware when reconstructing the URL. Default false — proxy headers are spoofable so opt in only when the reverse-proxy is trusted. + +## Signature + +```cpp +AgentBase & trust_proxy_for_signature(bool trust) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 476. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/update-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/update-global-data.mdx new file mode 100644 index 0000000000..eaecc65e1d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/update-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/update-global-data" +title: "update_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::update_global_data" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `update_global_data` + +## Signature + +```cpp +AgentBase & update_global_data(const json & data) +``` + +## Parameters + + + +## Returns + +`AgentBase &` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 320. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/validate-auth.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/validate-auth.mdx new file mode 100644 index 0000000000..e4ce7b9d9f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/validate-auth.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/validate-auth" +title: "validate_auth" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::validate_auth" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "protected" +--- +# `validate_auth` + +**Modifiers:** `const` + +## Signature + +```cpp +bool validate_auth(const httplib::Request & req, httplib::Response & res) const +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 540. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/validate-tool-token.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/validate-tool-token.mdx new file mode 100644 index 0000000000..5620e92b06 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/agent-base/validate-tool-token.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/cpp/signalwire/agent/agent-base/validate-tool-token" +title: "validate_tool_token" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::AgentBase::validate_tool_token" + parent: "signalwire::agent::AgentBase" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `validate_tool_token` + +Validate a per-call SWAIG-function token. Returns false when the function is not registered, when the SessionManager rejects the token, or on any underlying exception. +Python parity: state\_mixin.StateMixin.validate\_tool\_token — rejects unknown function names up-front and swallows exceptions. + +**Modifiers:** `const` + +## Signature + +```cpp +bool validate_tool_token( + const std::string & function_name, + const std::string & token, + const std::string & call_id +) const +``` + +## Parameters + + + + + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 282. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/debug-event-callback.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/debug-event-callback.mdx new file mode 100644 index 0000000000..112c08ce70 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/debug-event-callback.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/agent/debug-event-callback" +title: "DebugEventCallback" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::agent::DebugEventCallback" + parent: "signalwire::agent" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `DebugEventCallback` + +Debug event callback type. + +## Signature + +```cpp +typedef std::function< void(const json &event)> DebugEventCallback +``` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 100. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/dynamic-config-callback.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/dynamic-config-callback.mdx new file mode 100644 index 0000000000..d19ba5260e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/dynamic-config-callback.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/agent/dynamic-config-callback" +title: "DynamicConfigCallback" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::agent::DynamicConfigCallback" + parent: "signalwire::agent" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `DynamicConfigCallback` + +Dynamic config callback type. + +## Signature + +```cpp +typedef std::function< void( const std::map< std::string, std::string > &query_params, const json &body_params, const std::map< std::string, std::string > &headers, class AgentBase &agent_copy)> DynamicConfigCallback +``` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 89. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/index.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/index.mdx new file mode 100644 index 0000000000..a86051789a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/cpp/signalwire/agent" +title: "agent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::agent" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" +--- +# `agent` + +## Signature + +```cpp +namespace signalwire::agent +``` + +## Functions + + + + + +## Type Aliases + + + + Debug event callback type. + + + + Dynamic config callback type. + + + + + + Back-compat alias for the original signalwire::agent::PomSection type. The implementation now lives in signalwire::pom::Section — see signalwire/pom/pom.hpp for the full API (render\_markdown, render\_xml, numbered/numberedBullets fields, etc.). New code should use signalwire::pom::Section directly. + + + + Summary callback type. + + + +## Classes + + + + + + Language configuration. + + + + Pronunciation rule. + + + + SWAIG query parameters. + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 31. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/json.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/json.mdx new file mode 100644 index 0000000000..97b434e4ec --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/agent/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::agent::json" + parent: "signalwire::agent" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 33. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/language-config/index.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/language-config/index.mdx new file mode 100644 index 0000000000..35d86da6c7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/language-config/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/agent/language-config" +title: "LanguageConfig" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::agent::LanguageConfig" + parent: "signalwire::agent" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `LanguageConfig` + +Language configuration. + +## Signature + +```cpp +struct signalwire::agent::LanguageConfig +``` + +## Properties + + + + + + + + + + + Per-language params dict (engine-specific tuning, voice settings, etc.). Emitted as the language object's params key in SWML only when non-empty — matches Python reference commit 029ca6f. Treated as "unset" when null OR when an empty object. + + + + +## Methods + + + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 43. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/language-config/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/language-config/to-json.mdx new file mode 100644 index 0000000000..af37c189df --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/language-config/to-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/language-config/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::LanguageConfig::to_json" + parent: "signalwire::agent::LanguageConfig" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `to_json` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 56. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/pom-section.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/pom-section.mdx new file mode 100644 index 0000000000..77eea8a26c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/pom-section.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/agent/pom-section" +title: "PomSection" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::agent::PomSection" + parent: "signalwire::agent" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `PomSection` + +Back-compat alias for the original signalwire::agent::PomSection type. The implementation now lives in signalwire::pom::Section — see signalwire/pom/pom.hpp for the full API (render\_markdown, render\_xml, numbered/numberedBullets fields, etc.). New code should use signalwire::pom::Section directly. + +## Signature + +```cpp +typedef signalwire::pom::Section PomSection +``` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 40. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/pronunciation/index.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/pronunciation/index.mdx new file mode 100644 index 0000000000..457458cd4e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/pronunciation/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/agent/pronunciation" +title: "Pronunciation" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::agent::Pronunciation" + parent: "signalwire::agent" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `Pronunciation` + +Pronunciation rule. + +## Signature + +```cpp +struct signalwire::agent::Pronunciation +``` + +## Properties + + + + + + + +## Methods + + + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 74. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/pronunciation/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/pronunciation/to-json.mdx new file mode 100644 index 0000000000..e528fa26fe --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/pronunciation/to-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/agent/pronunciation/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::agent::Pronunciation::to_json" + parent: "signalwire::agent::Pronunciation" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `to_json` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 79. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/sorted-list-str.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/sorted-list-str.mdx new file mode 100644 index 0000000000..2b8777de81 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/sorted-list-str.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/agent/sorted-list-str" +title: "sorted_list_str" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::agent::sorted_list_str" + parent: "signalwire::agent" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/agent/agent_base.cpp" + visibility: "public" +--- +# `sorted_list_str` + +**Modifiers:** `static` + +## Signature + +```cpp +std::string sorted_list_str(const std::set< std::string > & s) +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`src/agent/agent_base.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/agent/agent_base.cpp) + +Line 457. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/summary-callback.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/summary-callback.mdx new file mode 100644 index 0000000000..816964231d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/summary-callback.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/agent/summary-callback" +title: "SummaryCallback" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::agent::SummaryCallback" + parent: "signalwire::agent" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `SummaryCallback` + +Summary callback type. + +## Signature + +```cpp +typedef std::function< void(const json &summary, const json &raw_data)> SummaryCallback +``` + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 97. diff --git a/fern/products/sdk-reference/cpp/signalwire/agent/swaig-query-param/index.mdx b/fern/products/sdk-reference/cpp/signalwire/agent/swaig-query-param/index.mdx new file mode 100644 index 0000000000..db41aa7233 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/agent/swaig-query-param/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/agent/swaig-query-param" +title: "SwaigQueryParam" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::agent::SwaigQueryParam" + parent: "signalwire::agent" + module: "signalwire.agent" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" + visibility: "public" +--- +# `SwaigQueryParam` + +SWAIG query parameters. + +## Signature + +```cpp +struct signalwire::agent::SwaigQueryParam +``` + +## Properties + + + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 103. diff --git a/fern/products/sdk-reference/cpp/signalwire/base64-decode.mdx b/fern/products/sdk-reference/cpp/signalwire/base64-decode.mdx new file mode 100644 index 0000000000..c59b86c11f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/base64-decode.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/base64-decode" +title: "base64_decode" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::base64_decode" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp" + visibility: "public" +--- +# `base64_decode` + +**Modifiers:** `inline` + +## Signature + +```cpp +std::string base64_decode(const std::string & input) +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/common.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp) + +Line 115. diff --git a/fern/products/sdk-reference/cpp/signalwire/base64-encode.mdx b/fern/products/sdk-reference/cpp/signalwire/base64-encode.mdx new file mode 100644 index 0000000000..891ced2ebb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/base64-encode.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/base64-encode" +title: "base64_encode" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::base64_encode" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp" + visibility: "public" +--- +# `base64_encode` + +**Modifiers:** `inline` + +## Signature + +```cpp +std::string base64_encode(const std::string & input) +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/common.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp) + +Line 97. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/add-context.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/add-context.mdx new file mode 100644 index 0000000000..df6df92cdb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/add-context.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context-builder/add-context" +title: "add_context" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::ContextBuilder::add_context" + parent: "signalwire::contexts::ContextBuilder" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_context` + +Add a new context. + +## Signature + +```cpp +Context & add_context(const std::string & name) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 405. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/attach-tool-name-supplier.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/attach-tool-name-supplier.mdx new file mode 100644 index 0000000000..35a3ef5c88 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/attach-tool-name-supplier.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context-builder/attach-tool-name-supplier" +title: "attach_tool_name_supplier" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::ContextBuilder::attach_tool_name_supplier" + parent: "signalwire::contexts::ContextBuilder" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `attach_tool_name_supplier` + +Attach a tool-name supplier so validate() can check user-defined SWAIG tool names against reserved\_native\_tool\_names(). AgentBase::define\_contexts() wires this up automatically. + +## Signature + +```cpp +ContextBuilder & attach_tool_name_supplier( + std::function< std::vector< std::string >()> supplier +) +``` + +## Parameters + + + +## Returns + +`ContextBuilder &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 414. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/context-builder.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/context-builder.mdx new file mode 100644 index 0000000000..ec270a7af5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/context-builder.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context-builder/context-builder" +title: "ContextBuilder" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::ContextBuilder::ContextBuilder" + parent: "signalwire::contexts::ContextBuilder" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `ContextBuilder` + +## Signature + +```cpp +void ContextBuilder() +``` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 399. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/get-context.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/get-context.mdx new file mode 100644 index 0000000000..e7630ed0cd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/get-context.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context-builder/get-context" +title: "get_context" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::ContextBuilder::get_context" + parent: "signalwire::contexts::ContextBuilder" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `get_context` + +Get an existing context. + +## Signature + +```cpp +Context * get_context(const std::string & name) +``` + +## Parameters + + + +## Returns + +`Context *` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 408. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/has-contexts.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/has-contexts.mdx new file mode 100644 index 0000000000..a433f6a944 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/has-contexts.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context-builder/has-contexts" +title: "has_contexts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::ContextBuilder::has_contexts" + parent: "signalwire::contexts::ContextBuilder" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `has_contexts` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool has_contexts() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 429. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/index.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/index.mdx new file mode 100644 index 0000000000..29407343a8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context-builder" +title: "ContextBuilder" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::contexts::ContextBuilder" + parent: "signalwire::contexts" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `ContextBuilder` + +Builder for multi-step, multi-context AI agent workflows. +A ContextBuilder owns one or more Contexts; each Context owns an ordered list of Steps. Only one context and one step is active at a time. Per chat turn, the runtime injects the current step's instructions as a system message, then asks the LLM for a response. + +Native tools auto-injected by the runtimeWhen a step (or its enclosing context) declares valid\_steps or valid\_contexts, the runtime auto-injects two native tools so the model can navigate the flow: + +next\_step(step: enum) — present when valid\_steps is set +change\_context(context: enum) — present when valid\_contexts is set + +A third native tool — gather\_submit — is injected during gather\_info questioning. These three names are reserved: validate() rejects any agent that defines a SWAIG tool with one of them. See reserved\_native\_tool\_names(). + +Function whitelisting (Step::set\_functions)Each step may declare a functions whitelist. The whitelist is applied in-memory at the start of each LLM turn. CRITICALLY: if a step does NOT declare a functions field, it INHERITS the previous step's active set. See Step::set\_functions for details and examples. + +## Signature + +```cpp +class signalwire::contexts::ContextBuilder +``` + +## Methods + + + + Add a new context. + + + + Attach a tool-name supplier so validate() can check user-defined SWAIG tool names against reserved\_native\_tool\_names(). AgentBase::define\_contexts() wires this up automatically. + + + + + + Get an existing context. + + + + + + Remove all contexts, returning the builder to its initial state. + + + + Serialize all contexts to JSON. + + + + Validate all contexts. Checks: At least one context is defined A single context must be named "default" Every context has at least one step gather\_info completion\_action targets an existing step No user-defined SWAIG tool collides with a reserved native name (via the attached tool-name supplier) + + + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 397. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/reset.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/reset.mdx new file mode 100644 index 0000000000..51c1c6fe87 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/reset.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context-builder/reset" +title: "reset" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::ContextBuilder::reset" + parent: "signalwire::contexts::ContextBuilder" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `reset` + +Remove all contexts, returning the builder to its initial state. + +## Signature + +```cpp +ContextBuilder & reset() +``` + +## Returns + +`ContextBuilder &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 402. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/to-json.mdx new file mode 100644 index 0000000000..91d4b1c931 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/to-json.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context-builder/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::ContextBuilder::to_json" + parent: "signalwire::contexts::ContextBuilder" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `to_json` + +Serialize all contexts to JSON. + +**Modifiers:** `const` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 427. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/validate.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/validate.mdx new file mode 100644 index 0000000000..122e597daa --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context-builder/validate.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context-builder/validate" +title: "validate" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::ContextBuilder::validate" + parent: "signalwire::contexts::ContextBuilder" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `validate` + +Validate all contexts. Checks: +At least one context is defined +A single context must be named "default" +Every context has at least one step +gather\_info completion\_action targets an existing step +No user-defined SWAIG tool collides with a reserved native name (via the attached tool-name supplier) + +**Modifiers:** `const` + +## Signature + +```cpp +void validate() const +``` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 424. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-bullets.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-bullets.mdx new file mode 100644 index 0000000000..f07703e7a0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-bullets.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/add-bullets" +title: "add_bullets" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::add_bullets" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_bullets` + +Add a POM section with bullets to the context prompt. + +## Signature + +```cpp +Context & add_bullets( + const std::string & title, + const std::vector< std::string > & bullets +) +``` + +## Parameters + + + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 310. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-enter-filler.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-enter-filler.mdx new file mode 100644 index 0000000000..e98e355a1c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-enter-filler.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/add-enter-filler" +title: "add_enter_filler" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::add_enter_filler" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_enter_filler` + +Add enter filler for a specific language. + +## Signature + +```cpp +Context & add_enter_filler( + const std::string & lang, + const std::vector< std::string > & fillers +) +``` + +## Parameters + + + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 325. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-exit-filler.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-exit-filler.mdx new file mode 100644 index 0000000000..151acedaff --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-exit-filler.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/add-exit-filler" +title: "add_exit_filler" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::add_exit_filler" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_exit_filler` + +Add exit filler for a specific language. + +## Signature + +```cpp +Context & add_exit_filler( + const std::string & lang, + const std::vector< std::string > & fillers +) +``` + +## Parameters + + + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 328. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-section.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-section.mdx new file mode 100644 index 0000000000..f7f28ddff2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/add-section" +title: "add_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::add_section" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_section` + +Add a POM section to the context prompt. + +## Signature + +```cpp +Context & add_section(const std::string & title, const std::string & body) +``` + +## Parameters + + + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 307. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-step.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-step.mdx new file mode 100644 index 0000000000..def1e97502 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-step.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/add-step" +title: "add_step" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::add_step" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_step` + +Add a new step to this context (returns reference for chaining). + +## Signature + +```cpp +Step & add_step( + const std::string & name, + const std::string & task = "", + const std::vector< std::string > & bullets = {}, + const std::string & criteria = "", + const std::optional< std::variant< std::string, std::vector< std::string > > > & functions = std::nullopt, + const std::vector< std::string > & valid_steps = {} +) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 240. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-system-bullets.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-system-bullets.mdx new file mode 100644 index 0000000000..47559d452f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-system-bullets.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/add-system-bullets" +title: "add_system_bullets" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::add_system_bullets" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_system_bullets` + +Add a POM section with bullets to the system prompt. + +## Signature + +```cpp +Context & add_system_bullets( + const std::string & title, + const std::vector< std::string > & bullets +) +``` + +## Parameters + + + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 316. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-system-section.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-system-section.mdx new file mode 100644 index 0000000000..4dcc6bea2e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/add-system-section.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/add-system-section" +title: "add_system_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::add_system_section" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_system_section` + +Add a POM section to the system prompt. + +## Signature + +```cpp +Context & add_system_section( + const std::string & title, + const std::string & body +) +``` + +## Parameters + + + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 313. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/context.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/context.mdx new file mode 100644 index 0000000000..8a91d9d187 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/context.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/context" +title: "Context" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::Context" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `Context` + +## Signature + + + + ```cpp + void Context() + ``` + + + + ```cpp + void Context(const std::string & name) + ``` + + + +## Parameters (Overload 2) + + + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 236. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/get-step.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/get-step.mdx new file mode 100644 index 0000000000..6f6df6f8e1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/get-step.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/get-step" +title: "get_step" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::get_step" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `get_step` + +Get an existing step by name. + +## Signature + +```cpp +Step * get_step(const std::string & name) +``` + +## Parameters + + + +## Returns + +`Step *` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 248. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/has-steps.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/has-steps.mdx new file mode 100644 index 0000000000..66b24f10ba --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/has-steps.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/has-steps" +title: "has_steps" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::has_steps" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `has_steps` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool has_steps() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 334. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/index.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/index.mdx new file mode 100644 index 0000000000..a7df86b3fa --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/index.mdx @@ -0,0 +1,138 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context" +title: "Context" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::contexts::Context" + parent: "signalwire::contexts" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `Context` + +## Signature + +```cpp +class signalwire::contexts::Context +``` + +## Methods + + + + Add a POM section with bullets to the context prompt. + + + + Add enter filler for a specific language. + + + + Add exit filler for a specific language. + + + + Add a POM section to the context prompt. + + + + Add a new step to this context (returns reference for chaining). + + + + Add a POM section with bullets to the system prompt. + + + + Add a POM section to the system prompt. + + + + + + Get an existing step by name. + + + + + + + + Move a step to a specific position. + + + + + + Remove a step. + + + + Set consolidate. + + + + Set enter fillers. + + + + Set exit fillers. + + + + Set full reset. + + + + Set which step the context starts on when entered. By default, a context starts on its first step (index 0). Use this to skip a preamble step on re-entry via change\_context. + + + + Mark this context as isolated — entering it wipes conversation history. When isolated=true and the context is entered via change\_context, the runtime wipes the conversation array. The model starts fresh with only the new context's system\_prompt + step instructions, with no memory of prior turns. EXCEPTION — reset overrides the wipe: If the context also has a reset configuration (via set\_consolidate or set\_full\_reset), the wipe is skipped in favor of the reset behavior. Use reset with consolidate=true to summarize prior history into a single message instead of dropping it entirely. Use cases: switching to a sensitive billing flow that should not see prior small-talk; handing off to a different agent persona; resetting after a long off-topic detour. + + + + Set post prompt override. + + + + Set prompt text directly. + + + + Set system prompt (for context switching). + + + + Set user prompt. + + + + Set valid contexts for navigation. + + + + Set valid steps for all steps in this context. + + + + + + + + Serialize to JSON. + + + + + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 234. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/initial-step.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/initial-step.mdx new file mode 100644 index 0000000000..2e32476a2e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/initial-step.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/initial-step" +title: "initial_step" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::initial_step" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `initial_step` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::optional< std::string > & initial_step() const +``` + +## Returns + +`const std::optional< std::string > &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 337. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/move-step.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/move-step.mdx new file mode 100644 index 0000000000..9fff978c42 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/move-step.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/move-step" +title: "move_step" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::move_step" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `move_step` + +Move a step to a specific position. + +## Signature + +```cpp +Context & move_step(const std::string & name, int position) +``` + +## Parameters + + + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 254. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/name.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/name.mdx new file mode 100644 index 0000000000..0e302726c6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/name" +title: "name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::name" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `name` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & name() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 333. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/remove-step.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/remove-step.mdx new file mode 100644 index 0000000000..f531cb779a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/remove-step.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/remove-step" +title: "remove_step" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::remove_step" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `remove_step` + +Remove a step. + +## Signature + +```cpp +Context & remove_step(const std::string & name) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 251. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-consolidate.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-consolidate.mdx new file mode 100644 index 0000000000..e27f3e6d76 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-consolidate.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-consolidate" +title: "set_consolidate" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_consolidate" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_consolidate` + +Set consolidate. + +## Signature + +```cpp +Context & set_consolidate(bool c) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 275. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-enter-fillers.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-enter-fillers.mdx new file mode 100644 index 0000000000..9e5c0be1a5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-enter-fillers.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-enter-fillers" +title: "set_enter_fillers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_enter_fillers" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_enter_fillers` + +Set enter fillers. + +## Signature + +```cpp +Context & set_enter_fillers(const json & fillers) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 319. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-exit-fillers.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-exit-fillers.mdx new file mode 100644 index 0000000000..d44ec2d31c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-exit-fillers.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-exit-fillers" +title: "set_exit_fillers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_exit_fillers" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_exit_fillers` + +Set exit fillers. + +## Signature + +```cpp +Context & set_exit_fillers(const json & fillers) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 322. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-full-reset.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-full-reset.mdx new file mode 100644 index 0000000000..4f28d55021 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-full-reset.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-full-reset" +title: "set_full_reset" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_full_reset" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_full_reset` + +Set full reset. + +## Signature + +```cpp +Context & set_full_reset(bool fr) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 278. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-initial-step.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-initial-step.mdx new file mode 100644 index 0000000000..ee7efdb9d6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-initial-step.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-initial-step" +title: "set_initial_step" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_initial_step" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_initial_step` + +Set which step the context starts on when entered. +By default, a context starts on its first step (index 0). Use this to skip a preamble step on re-entry via change\_context. + +## Signature + +```cpp +Context & set_initial_step(const std::string & step_name) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 260. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-isolated.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-isolated.mdx new file mode 100644 index 0000000000..8ec870fa60 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-isolated.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-isolated" +title: "set_isolated" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_isolated" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_isolated` + +Mark this context as isolated — entering it wipes conversation history. +When isolated=true and the context is entered via change\_context, the runtime wipes the conversation array. The model starts fresh with only the new context's system\_prompt + step instructions, with no memory of prior turns. +EXCEPTION — reset overrides the wipe: If the context also has a reset configuration (via set\_consolidate or set\_full\_reset), the wipe is skipped in favor of the reset behavior. Use reset with consolidate=true to summarize prior history into a single message instead of dropping it entirely. +Use cases: switching to a sensitive billing flow that should not see prior small-talk; handing off to a different agent persona; resetting after a long off-topic detour. + +## Signature + +```cpp +Context & set_isolated(bool isolated) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 301. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-post-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-post-prompt.mdx new file mode 100644 index 0000000000..0e094adcdf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-post-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-post-prompt" +title: "set_post_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_post_prompt" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_post_prompt` + +Set post prompt override. + +## Signature + +```cpp +Context & set_post_prompt(const std::string & pp) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 269. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-prompt.mdx new file mode 100644 index 0000000000..88abef0dca --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-prompt" +title: "set_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_prompt" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_prompt` + +Set prompt text directly. + +## Signature + +```cpp +Context & set_prompt(const std::string & prompt) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 304. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-system-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-system-prompt.mdx new file mode 100644 index 0000000000..56d1644543 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-system-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-system-prompt" +title: "set_system_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_system_prompt" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_system_prompt` + +Set system prompt (for context switching). + +## Signature + +```cpp +Context & set_system_prompt(const std::string & sp) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 272. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-user-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-user-prompt.mdx new file mode 100644 index 0000000000..64663d538c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-user-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-user-prompt" +title: "set_user_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_user_prompt" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_user_prompt` + +Set user prompt. + +## Signature + +```cpp +Context & set_user_prompt(const std::string & up) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 281. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-valid-contexts.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-valid-contexts.mdx new file mode 100644 index 0000000000..393154cbca --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-valid-contexts.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-valid-contexts" +title: "set_valid_contexts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_valid_contexts" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_valid_contexts` + +Set valid contexts for navigation. + +## Signature + +```cpp +Context & set_valid_contexts(const std::vector< std::string > & ctxs) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 263. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-valid-steps.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-valid-steps.mdx new file mode 100644 index 0000000000..9ac2f2cf99 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/set-valid-steps.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/set-valid-steps" +title: "set_valid_steps" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::set_valid_steps" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_valid_steps` + +Set valid steps for all steps in this context. + +## Signature + +```cpp +Context & set_valid_steps(const std::vector< std::string > & steps) +``` + +## Parameters + + + +## Returns + +`Context &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 266. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/step-order.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/step-order.mdx new file mode 100644 index 0000000000..959a4a3a38 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/step-order.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/step-order" +title: "step_order" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::step_order" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `step_order` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::vector< std::string > & step_order() const +``` + +## Returns + +`const std::vector< std::string > &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 336. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/steps.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/steps.mdx new file mode 100644 index 0000000000..48c4fe231e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/steps.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/steps" +title: "steps" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::steps" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `steps` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::map< std::string, Step > & steps() const +``` + +## Returns + +`const std::map< std::string, Step > &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 335. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/to-json.mdx new file mode 100644 index 0000000000..9b75cd7314 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/to-json.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::to_json" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `to_json` + +Serialize to JSON. + +**Modifiers:** `const` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 331. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/context/valid-contexts.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/context/valid-contexts.mdx new file mode 100644 index 0000000000..33ce39d614 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/context/valid-contexts.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/context/valid-contexts" +title: "valid_contexts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Context::valid_contexts" + parent: "signalwire::contexts::Context" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `valid_contexts` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::optional< std::vector< std::string > > & valid_contexts() const +``` + +## Returns + +`const std::optional< std::vector< std::string > > &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 338. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/add-question.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/add-question.mdx new file mode 100644 index 0000000000..f880dc600d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/add-question.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/cpp/signalwire/contexts/gather-info/add-question" +title: "add_question" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::GatherInfo::add_question" + parent: "signalwire::contexts::GatherInfo" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_question` + +## Signature + +```cpp +GatherInfo & add_question( + const std::string & key, + const std::string & question, + const std::string & type = "string", + bool confirm = false, + const std::string & prompt = "", + const std::vector< std::string > & functions = {} +) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`GatherInfo &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 65. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/completion-action.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/completion-action.mdx new file mode 100644 index 0000000000..80cd60a7de --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/completion-action.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/gather-info/completion-action" +title: "completion_action" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::GatherInfo::completion_action" + parent: "signalwire::contexts::GatherInfo" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `completion_action` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & completion_action() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 74. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/gather-info.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/gather-info.mdx new file mode 100644 index 0000000000..d35055e3b0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/gather-info.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/contexts/gather-info/gather-info" +title: "GatherInfo" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::GatherInfo::GatherInfo" + parent: "signalwire::contexts::GatherInfo" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `GatherInfo` + +## Signature + +```cpp +void GatherInfo( + const std::string & output_key = "", + const std::string & completion_action = "", + const std::string & prompt = "" +) +``` + +## Parameters + + + + + + + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 61. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/has-questions.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/has-questions.mdx new file mode 100644 index 0000000000..f05deb5d65 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/has-questions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/gather-info/has-questions" +title: "has_questions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::GatherInfo::has_questions" + parent: "signalwire::contexts::GatherInfo" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `has_questions` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool has_questions() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 72. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/index.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/index.mdx new file mode 100644 index 0000000000..55112d5092 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/contexts/gather-info" +title: "GatherInfo" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::contexts::GatherInfo" + parent: "signalwire::contexts" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `GatherInfo` + +## Signature + +```cpp +class signalwire::contexts::GatherInfo +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 59. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/questions.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/questions.mdx new file mode 100644 index 0000000000..34a93646cd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/questions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/gather-info/questions" +title: "questions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::GatherInfo::questions" + parent: "signalwire::contexts::GatherInfo" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `questions` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::vector< GatherQuestion > & questions() const +``` + +## Returns + +`const std::vector< GatherQuestion > &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 73. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/to-json.mdx new file mode 100644 index 0000000000..a0772fa8cc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-info/to-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/gather-info/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::GatherInfo::to_json" + parent: "signalwire::contexts::GatherInfo" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `to_json` + +**Modifiers:** `const` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 70. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/gather-question.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/gather-question.mdx new file mode 100644 index 0000000000..529870d403 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/gather-question.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/cpp/signalwire/contexts/gather-question/gather-question" +title: "GatherQuestion" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::GatherQuestion::GatherQuestion" + parent: "signalwire::contexts::GatherQuestion" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `GatherQuestion` + +## Signature + +```cpp +void GatherQuestion( + const std::string & key, + const std::string & question, + const std::string & type = "string", + bool confirm = false, + const std::string & prompt = "", + const std::vector< std::string > & functions = {} +) +``` + +## Parameters + + + + + + + + + + + + + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 37. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/index.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/index.mdx new file mode 100644 index 0000000000..d11bebc00d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/gather-question" +title: "GatherQuestion" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::contexts::GatherQuestion" + parent: "signalwire::contexts" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `GatherQuestion` + +## Signature + +```cpp +class signalwire::contexts::GatherQuestion +``` + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 35. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/key.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/key.mdx new file mode 100644 index 0000000000..6373853431 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/key.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/gather-question/key" +title: "key" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::GatherQuestion::key" + parent: "signalwire::contexts::GatherQuestion" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `key` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & key() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 44. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/to-json.mdx new file mode 100644 index 0000000000..5dbc57217c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/gather-question/to-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/gather-question/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::GatherQuestion::to_json" + parent: "signalwire::contexts::GatherQuestion" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `to_json` + +**Modifiers:** `const` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 42. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/index.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/index.mdx new file mode 100644 index 0000000000..0bc3c4e6c9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/cpp/signalwire/contexts" +title: "contexts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::contexts" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" +--- +# `contexts` + +## Signature + +```cpp +namespace signalwire::contexts +``` + +## Constants + + + + + +## Functions + + + + Reserved tool names auto-injected by the runtime when contexts/steps are present. User-defined SWAIG tools must not collide with these names: next\_step / change\_context are injected when valid\_steps or valid\_contexts is set so the model can navigate the flow. gather\_submit is injected while a step's gather\_info is collecting answers. ContextBuilder::validate() rejects any agent that registers a user tool sharing one of these names. + + + +## Type Aliases + + + + + +## Classes + + + + + + Builder for multi-step, multi-context AI agent workflows. A ContextBuilder owns one or more Contexts; each Context owns an ordered list of Steps. Only one context and one step is active at a time. Per chat turn, the runtime injects the current step's instructions as a system message, then asks the LLM for a response. + + + + + + + + + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/json.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/json.mdx new file mode 100644 index 0000000000..4c3a548a2a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/contexts/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::contexts::json" + parent: "signalwire::contexts" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 16. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/reserved-native-tool-names.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/reserved-native-tool-names.mdx new file mode 100644 index 0000000000..a4eed2d68f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/reserved-native-tool-names.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/contexts/reserved-native-tool-names" +title: "reserved_native_tool_names" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::contexts::reserved_native_tool_names" + parent: "signalwire::contexts" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/contexts/contexts.cpp" + visibility: "public" +--- +# `reserved_native_tool_names` + +Reserved tool names auto-injected by the runtime when contexts/steps are present. User-defined SWAIG tools must not collide with these names: +next\_step / change\_context are injected when valid\_steps or valid\_contexts is set so the model can navigate the flow. +gather\_submit is injected while a step's gather\_info is collecting answers. ContextBuilder::validate() rejects any agent that registers a user tool sharing one of these names. + +## Signature + +```cpp +const std::set< std::string > & reserved_native_tool_names() +``` + +## Returns + +`const std::set< std::string > &` + +## Source + +[`src/contexts/contexts.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/contexts/contexts.cpp) + +Line 10. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/add-bullets.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/add-bullets.mdx new file mode 100644 index 0000000000..ad493649c1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/add-bullets.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/add-bullets" +title: "add_bullets" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::add_bullets" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_bullets` + +Add a POM section with bullet points. + +## Signature + +```cpp +Step & add_bullets( + const std::string & title, + const std::vector< std::string > & bullets +) +``` + +## Parameters + + + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 99. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/add-gather-question.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/add-gather-question.mdx new file mode 100644 index 0000000000..ce2ee9f00f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/add-gather-question.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/add-gather-question" +title: "add_gather_question" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::add_gather_question" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_gather_question` + +Add a gather question (set\_gather\_info must be called first). +IMPORTANT — gather mode locks function access: While the model is asking gather questions, the runtime forcibly deactivates ALL of the step's other functions. The only callable tools during a gather question are: + +gather\_submit (the native answer-submission tool) +Whatever names you pass in this question's functions argument + +next\_step and change\_context are also filtered out — the model cannot navigate away until the gather completes. This is by design: it forces a tight ask → submit → next-question loop. +If a question needs to call out to a tool (e.g. validate an email, geocode a ZIP), list that tool name in this question's functions argument. Functions listed here are active ONLY for this question. + +## Signature + +```cpp +Step & add_gather_question( + const std::string & key, + const std::string & question, + const std::string & type = "string", + bool confirm = false, + const std::string & prompt = "", + const std::vector< std::string > & functions = {} +) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 186. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/add-section.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/add-section.mdx new file mode 100644 index 0000000000..ab386c4a09 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/add-section" +title: "add_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::add_section" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `add_section` + +Add a POM section to the step. + +## Signature + +```cpp +Step & add_section(const std::string & title, const std::string & body) +``` + +## Parameters + + + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 96. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/clear-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/clear-sections.mdx new file mode 100644 index 0000000000..7318650331 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/clear-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/clear-sections" +title: "clear_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::clear_sections" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `clear_sections` + +Clear all sections and text. + +## Signature + +```cpp +Step & clear_sections() +``` + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 192. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/gather-info.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/gather-info.mdx new file mode 100644 index 0000000000..6e3189b5a7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/gather-info.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/gather-info" +title: "gather_info" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::gather_info" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `gather_info` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::optional< GatherInfo > & gather_info() const +``` + +## Returns + +`const std::optional< GatherInfo > &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 206. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/index.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/index.mdx new file mode 100644 index 0000000000..e147bd50b0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/index.mdx @@ -0,0 +1,108 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step" +title: "Step" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::contexts::Step" + parent: "signalwire::contexts" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `Step` + +## Signature + +```cpp +class signalwire::contexts::Step +``` + +## Methods + + + + Add a POM section with bullet points. + + + + Add a gather question (set\_gather\_info must be called first). IMPORTANT — gather mode locks function access: While the model is asking gather questions, the runtime forcibly deactivates ALL of the step's other functions. The only callable tools during a gather question are: + + + + Add a POM section to the step. + + + + Clear all sections and text. + + + + + + + + Mark this step as terminal for the step flow. IMPORTANT: end=true does NOT end the conversation or hang up the call. It exits step mode entirely after this step executes — clearing the steps list, current step index, valid\_steps, and valid\_contexts. The agent keeps running, but operates only under the base system prompt and the context-level prompt; no more step instructions are injected and no more next\_step tool is offered. To actually end the call, call a hangup tool or define a hangup hook. + + + + Set which non-internal functions are callable while this step is active. IMPORTANT — inheritance behavior: If you do NOT call this method, the step inherits whichever function set was active on the previous step (or the previous context's last step). The server-side runtime only resets the active set when a step explicitly declares its functions field. This is the most common source of bugs in multi-step agents: forgetting set\_functions on a later step lets the previous step's tools leak through. Best practice is to call set\_functions explicitly on every step that should differ from the previous one. Keep the per-step active set small: LLM tool selection accuracy degrades noticeably past ~7-8 simultaneously-active tools per call. Use per-step whitelisting to partition large tool collections. Internal functions (e.g. gather\_submit, hangup hook) are ALWAYS protected and cannot be deactivated by this whitelist. The native navigation tools next\_step and change\_context are injected automatically when set\_valid\_steps / set\_valid\_contexts is used; they are not affected by this list. + + + + Enable info gathering on this step. + + + + + + + + Set reset parameters for context switching. + + + + + + Set whether to auto-advance to the next step. + + + + Set whether to skip waiting for user input. + + + + Set step completion criteria. + + + + Set the step's prompt text directly. + + + + Set which contexts can be navigated to from this step. + + + + Set which steps can be navigated to from this step. + + + + + + Serialize to JSON. + + + + + + + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 87. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/name.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/name.mdx new file mode 100644 index 0000000000..7e70b325f9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/name" +title: "name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::name" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `name` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & name() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 203. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-end.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-end.mdx new file mode 100644 index 0000000000..320a106e86 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-end.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-end" +title: "set_end" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_end" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_end` + +Mark this step as terminal for the step flow. +IMPORTANT: end=true does NOT end the conversation or hang up the call. It exits step mode entirely after this step executes — clearing the steps list, current step index, valid\_steps, and valid\_contexts. The agent keeps running, but operates only under the base system prompt and the context-level prompt; no more step instructions are injected and no more next\_step tool is offered. +To actually end the call, call a hangup tool or define a hangup hook. + +## Signature + +```cpp +Step & set_end(bool end) +``` + +## Parameters + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 153. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-functions.mdx new file mode 100644 index 0000000000..934396485e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-functions.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-functions" +title: "set_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_functions" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_functions` + +Set which non-internal functions are callable while this step is active. +IMPORTANT — inheritance behavior: If you do NOT call this method, the step inherits whichever function set was active on the previous step (or the previous context's last step). The server-side runtime only resets the active set when a step explicitly declares its functions field. This is the most common source of bugs in multi-step agents: forgetting set\_functions on a later step lets the previous step's tools leak through. Best practice is to call set\_functions explicitly on every step that should differ from the previous one. +Keep the per-step active set small: LLM tool selection accuracy degrades noticeably past ~7-8 simultaneously-active tools per call. Use per-step whitelisting to partition large tool collections. +Internal functions (e.g. gather\_submit, hangup hook) are ALWAYS protected and cannot be deactivated by this whitelist. The native navigation tools next\_step and change\_context are injected automatically when set\_valid\_steps / set\_valid\_contexts is used; they are not affected by this list. + +functions + +One of: +std::vector[std::string](std::string) — whitelist of allowed names +empty std::vector — disable all user functions +std::string "none" — synonym for the empty vector + +## Signature + +```cpp +Step & set_functions( + const std::variant< std::string, std::vector< std::string > > & functions +) +``` + +## Parameters + + + One of: std::vector[std::string](std::string) — whitelist of allowed names empty std::vector — disable all user functions std::string "none" — synonym for the empty vector + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 133. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-gather-info.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-gather-info.mdx new file mode 100644 index 0000000000..b3925192f4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-gather-info.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-gather-info" +title: "set_gather_info" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_gather_info" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_gather_info` + +Enable info gathering on this step. + +## Signature + +```cpp +Step & set_gather_info( + const std::string & output_key = "", + const std::string & completion_action = "", + const std::string & prompt = "" +) +``` + +## Parameters + + + + + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 162. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-consolidate.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-consolidate.mdx new file mode 100644 index 0000000000..35f8d3be44 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-consolidate.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-reset-consolidate" +title: "set_reset_consolidate" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_reset_consolidate" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_reset_consolidate` + +## Signature + +```cpp +Step & set_reset_consolidate(bool c) +``` + +## Parameters + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 197. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-full-reset.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-full-reset.mdx new file mode 100644 index 0000000000..7a24079acc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-full-reset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-reset-full-reset" +title: "set_reset_full_reset" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_reset_full_reset" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_reset_full_reset` + +## Signature + +```cpp +Step & set_reset_full_reset(bool fr) +``` + +## Parameters + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 198. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-system-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-system-prompt.mdx new file mode 100644 index 0000000000..0bfbf71737 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-system-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-reset-system-prompt" +title: "set_reset_system_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_reset_system_prompt" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_reset_system_prompt` + +Set reset parameters for context switching. + +## Signature + +```cpp +Step & set_reset_system_prompt(const std::string & sp) +``` + +## Parameters + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 195. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-user-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-user-prompt.mdx new file mode 100644 index 0000000000..4ecf8bd389 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-reset-user-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-reset-user-prompt" +title: "set_reset_user_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_reset_user_prompt" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_reset_user_prompt` + +## Signature + +```cpp +Step & set_reset_user_prompt(const std::string & up) +``` + +## Parameters + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 196. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-skip-to-next-step.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-skip-to-next-step.mdx new file mode 100644 index 0000000000..3ebc552f71 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-skip-to-next-step.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-skip-to-next-step" +title: "set_skip_to_next_step" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_skip_to_next_step" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_skip_to_next_step` + +Set whether to auto-advance to the next step. + +## Signature + +```cpp +Step & set_skip_to_next_step(bool skip) +``` + +## Parameters + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 159. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-skip-user-turn.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-skip-user-turn.mdx new file mode 100644 index 0000000000..260f4a6d2c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-skip-user-turn.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-skip-user-turn" +title: "set_skip_user_turn" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_skip_user_turn" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_skip_user_turn` + +Set whether to skip waiting for user input. + +## Signature + +```cpp +Step & set_skip_user_turn(bool skip) +``` + +## Parameters + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 156. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-step-criteria.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-step-criteria.mdx new file mode 100644 index 0000000000..25adcd38c1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-step-criteria.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-step-criteria" +title: "set_step_criteria" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_step_criteria" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_step_criteria` + +Set step completion criteria. + +## Signature + +```cpp +Step & set_step_criteria(const std::string & criteria) +``` + +## Parameters + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 102. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-text.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-text.mdx new file mode 100644 index 0000000000..d83df097e3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-text.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-text" +title: "set_text" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_text" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_text` + +Set the step's prompt text directly. + +## Signature + +```cpp +Step & set_text(const std::string & text) +``` + +## Parameters + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 93. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-valid-contexts.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-valid-contexts.mdx new file mode 100644 index 0000000000..6330cdc43f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-valid-contexts.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-valid-contexts" +title: "set_valid_contexts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_valid_contexts" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_valid_contexts` + +Set which contexts can be navigated to from this step. + +## Signature + +```cpp +Step & set_valid_contexts(const std::vector< std::string > & ctxs) +``` + +## Parameters + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 139. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-valid-steps.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-valid-steps.mdx new file mode 100644 index 0000000000..a67a930522 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/set-valid-steps.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/set-valid-steps" +title: "set_valid_steps" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::set_valid_steps" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `set_valid_steps` + +Set which steps can be navigated to from this step. + +## Signature + +```cpp +Step & set_valid_steps(const std::vector< std::string > & steps) +``` + +## Parameters + + + +## Returns + +`Step &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 136. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/step.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/step.mdx new file mode 100644 index 0000000000..97894b62a0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/step.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/step" +title: "Step" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::Step" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `Step` + +## Signature + + + + ```cpp + void Step() + ``` + + + + ```cpp + void Step(const std::string & name) + ``` + + + +## Parameters (Overload 2) + + + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 89. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/to-json.mdx new file mode 100644 index 0000000000..c93d8dbf23 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/to-json.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::to_json" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `to_json` + +Serialize to JSON. + +**Modifiers:** `const` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 201. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/valid-contexts.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/valid-contexts.mdx new file mode 100644 index 0000000000..2eba847ff3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/valid-contexts.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/valid-contexts" +title: "valid_contexts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::valid_contexts" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `valid_contexts` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::optional< std::vector< std::string > > & valid_contexts() const +``` + +## Returns + +`const std::optional< std::vector< std::string > > &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 205. diff --git a/fern/products/sdk-reference/cpp/signalwire/contexts/step/valid-steps.mdx b/fern/products/sdk-reference/cpp/signalwire/contexts/step/valid-steps.mdx new file mode 100644 index 0000000000..2f383d9d48 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/contexts/step/valid-steps.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/contexts/step/valid-steps" +title: "valid_steps" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::contexts::Step::valid_steps" + parent: "signalwire::contexts::Step" + module: "signalwire.contexts" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp" + visibility: "public" +--- +# `valid_steps` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::optional< std::vector< std::string > > & valid_steps() const +``` + +## Returns + +`const std::optional< std::vector< std::string > > &` + +## Source + +[`include/signalwire/contexts/contexts.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/contexts/contexts.hpp) + +Line 204. diff --git a/fern/products/sdk-reference/cpp/signalwire/core/index.mdx b/fern/products/sdk-reference/cpp/signalwire/core/index.mdx new file mode 100644 index 0000000000..889bc64c97 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/core/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/cpp/signalwire/core" +title: "core" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::core" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/core/logging_config.hpp" +--- +# `core` + +## Signature + +```cpp +namespace signalwire::core +``` + +## Modules + + + + + +## Source + +[`include/signalwire/core/logging_config.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/core/logging_config.hpp) + +Line 11. diff --git a/fern/products/sdk-reference/cpp/signalwire/core/logging-config/get-execution-mode.mdx b/fern/products/sdk-reference/cpp/signalwire/core/logging-config/get-execution-mode.mdx new file mode 100644 index 0000000000..3b8bc9ed7f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/core/logging-config/get-execution-mode.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/core/logging-config/get-execution-mode" +title: "get_execution_mode" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::core::logging_config::get_execution_mode" + parent: "signalwire::core::logging_config" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/core/logging_config.cpp" + visibility: "public" +--- +# `get_execution_mode` + +Cross-language SDK contract for serverless / deployment-mode detection. +Mirrors signalwire.core.logging\_config.get\_execution\_mode in the Python reference. Order of precedence (FIRST match wins): + +GATEWAY\_INTERFACE -> "cgi" +AWS\_LAMBDA\_FUNCTION\_NAME or LAMBDA\_TASK\_ROOT -> "lambda" +FUNCTION\_TARGET, K\_SERVICE, or GOOGLE\_CLOUD\_PROJECT -> "google\_cloud\_function" +AZURE\_FUNCTIONS\_ENVIRONMENT, FUNCTIONS\_WORKER\_RUNTIME, or AzureWebJobsStorage -> "azure\_function" +otherwise -> "server" + +The detected mode as a canonical lower-case string. One of "cgi", "lambda", "google\_cloud\_function", "azure\_function", or "server". + +## Signature + +```cpp +std::string get_execution_mode() +``` + +## Returns + +`std::string` — The detected mode as a canonical lower-case string. One of "cgi", "lambda", "google\_cloud\_function", "azure\_function", or "server". + +## Source + +[`src/core/logging_config.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/core/logging_config.cpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/core/logging-config/index.mdx b/fern/products/sdk-reference/cpp/signalwire/core/logging-config/index.mdx new file mode 100644 index 0000000000..75569d8019 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/core/logging-config/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/cpp/signalwire/core/logging-config" +title: "logging_config" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::core::logging_config" + parent: "signalwire::core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/core/logging_config.hpp" +--- +# `logging_config` + +## Signature + +```cpp +namespace signalwire::core::logging_config +``` + +## Functions + + + + Cross-language SDK contract for serverless / deployment-mode detection. Mirrors signalwire.core.logging\_config.get\_execution\_mode in the Python reference. Order of precedence (FIRST match wins): + + + +## Source + +[`include/signalwire/core/logging_config.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/core/logging_config.hpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/body.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/body.mdx new file mode 100644 index 0000000000..d00c01d672 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/body.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/body" +title: "body" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::body" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `body` + +Set request body for the last added webhook. + +## Signature + +```cpp +DataMap & body(const json & data) +``` + +## Parameters + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 81. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/data-map.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/data-map.mdx new file mode 100644 index 0000000000..19b5d91274 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/data-map.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/data-map" +title: "DataMap" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::DataMap" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `DataMap` + +**Modifiers:** `explicit` + +## Signature + +```cpp +void DataMap(const std::string & function_name) +``` + +## Parameters + + + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 20. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/description.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/description.mdx new file mode 100644 index 0000000000..824125f3de --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/description.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/description" +title: "description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::description" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `description` + +Alias for purpose(). Sets the LLM-facing tool description. This string is read by the model to decide WHEN to call this tool. See purpose() for bad-vs-good examples. + +## Signature + +```cpp +DataMap & description(const std::string & desc) +``` + +## Parameters + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 43. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/error-keys.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/error-keys.mdx new file mode 100644 index 0000000000..9bcc51a309 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/error-keys.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/error-keys" +title: "error_keys" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::error_keys" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `error_keys` + +Set error keys for the most recent webhook or top-level. + +## Signature + +```cpp +DataMap & error_keys(const std::vector< std::string > & keys) +``` + +## Parameters + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 96. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/expression.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/expression.mdx new file mode 100644 index 0000000000..f2c0c3cd56 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/expression.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/expression" +title: "expression" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::expression" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `expression` + +Add an expression pattern for pattern-based responses. + +## Signature + +```cpp +DataMap & expression( + const std::string & test_value, + const std::string & pattern, + const swaig::FunctionResult & output, + const swaig::FunctionResult * nomatch_output = nullptr +) +``` + +## Parameters + + + + + + + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 66. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/fallback-output.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/fallback-output.mdx new file mode 100644 index 0000000000..ee0425877d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/fallback-output.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/fallback-output" +title: "fallback_output" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::fallback_output" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `fallback_output` + +Set a fallback output at the top level. + +## Signature + +```cpp +DataMap & fallback_output(const swaig::FunctionResult & result) +``` + +## Parameters + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 93. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/foreach.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/foreach.mdx new file mode 100644 index 0000000000..6a070e9d61 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/foreach.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/foreach" +title: "foreach" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::foreach" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `foreach` + +Set foreach configuration for the last webhook. + +## Signature + +```cpp +DataMap & foreach(const json & foreach_config) +``` + +## Parameters + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 87. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/global-error-keys.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/global-error-keys.mdx new file mode 100644 index 0000000000..f467fe82ae --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/global-error-keys.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/global-error-keys" +title: "global_error_keys" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::global_error_keys" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `global_error_keys` + +Set top-level error keys. + +## Signature + +```cpp +DataMap & global_error_keys(const std::vector< std::string > & keys) +``` + +## Parameters + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 99. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/index.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/index.mdx new file mode 100644 index 0000000000..50608e25e0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/index.mdx @@ -0,0 +1,92 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map" +title: "DataMap" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap" + parent: "signalwire::datamap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `DataMap` + +Fluent builder for SWAIG data\_map tools (server-side, no webhook needed). Every setter returns \*this for chaining. + +## Signature + +```cpp +class signalwire::datamap::DataMap +``` + +## Methods + + + + Set request body for the last added webhook. + + + + + + Alias for purpose(). Sets the LLM-facing tool description. This string is read by the model to decide WHEN to call this tool. See purpose() for bad-vs-good examples. + + + + Set error keys for the most recent webhook or top-level. + + + + Add an expression pattern for pattern-based responses. + + + + Set a fallback output at the top level. + + + + Set foreach configuration for the last webhook. + + + + Set top-level error keys. + + + + Set output for the most recent webhook. + + + + Add a parameter to this data-map tool — the desc is LLM-FACING. Each parameter description is rendered into the OpenAI tool schema under parameters.properties.<name>.description and sent to the model. The model uses it to decide HOW to fill in the argument from user speech. It is prompt engineering, not developer FYI. Bad vs good: BAD : .parameter("city", "string", "the city") GOOD: .parameter("city", "string", "The name of the city to get weather for, e.g. " "'San Francisco'. Ask the user if they did not " "provide one. Include the state or country if the " "city name is ambiguous.") + + + + Set request params for the last added webhook (alias for body). + + + + Set the LLM-facing tool description (the "purpose"). PROMPT ENGINEERING, not developer documentation. The description string is rendered into the OpenAI tool schema description field on every LLM turn. The model reads it to decide WHEN to call this tool. A vague purpose() is the #1 cause of "the model has the right tool but doesn't call it" failures with data-map tools. Bad vs good: BAD : .purpose("weather api") GOOD: .purpose("Get the current weather conditions and " "forecast for a specific city. Use this " "whenever the user asks about weather, " "temperature, rain, or similar conditions in " "a named location.") + + + + Convert to a SWAIG function definition JSON. + + + + Add a webhook API call. + + + + Add expressions that run after the most recent webhook. + + + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 18. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/output.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/output.mdx new file mode 100644 index 0000000000..573c594d46 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/output.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/output" +title: "output" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::output" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `output` + +Set output for the most recent webhook. + +## Signature + +```cpp +DataMap & output(const swaig::FunctionResult & result) +``` + +## Parameters + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 90. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/parameter.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/parameter.mdx new file mode 100644 index 0000000000..8a94f21694 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/parameter.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/parameter" +title: "parameter" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::parameter" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `parameter` + +Add a parameter to this data-map tool — the desc is LLM-FACING. +Each parameter description is rendered into the OpenAI tool schema under parameters.properties.<name>.description and sent to the model. The model uses it to decide HOW to fill in the argument from user speech. It is prompt engineering, not developer FYI. +Bad vs good: BAD : .parameter("city", "string", "the city") GOOD: .parameter("city", "string", "The name of the city to get weather for, e.g. " "'San Francisco'. Ask the user if they did not " "provide one. Include the state or country if the " "city name is ambiguous.") + +## Signature + +```cpp +DataMap & parameter( + const std::string & name, + const std::string & param_type, + const std::string & desc, + bool required = false, + const std::vector< std::string > & enum_values = {} +) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 61. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/params.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/params.mdx new file mode 100644 index 0000000000..828e9ad5ef --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/params.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/params" +title: "params" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::params" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `params` + +Set request params for the last added webhook (alias for body). + +## Signature + +```cpp +DataMap & params(const json & data) +``` + +## Parameters + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 84. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/purpose.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/purpose.mdx new file mode 100644 index 0000000000..95062274ac --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/purpose.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/purpose" +title: "purpose" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::purpose" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `purpose` + +Set the LLM-facing tool description (the "purpose"). PROMPT ENGINEERING, not developer documentation. +The description string is rendered into the OpenAI tool schema description field on every LLM turn. The model reads it to decide WHEN to call this tool. A vague purpose() is the #1 cause of "the model has the right tool but doesn't call it" failures with data-map tools. +Bad vs good: BAD : .purpose("weather api") GOOD: .purpose("Get the current weather conditions and " "forecast for a specific city. Use this " "whenever the user asks about weather, " "temperature, rain, or similar conditions in " "a named location.") + +## Signature + +```cpp +DataMap & purpose(const std::string & desc) +``` + +## Parameters + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 38. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/to-swaig-function.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/to-swaig-function.mdx new file mode 100644 index 0000000000..6f7d997483 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/to-swaig-function.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/to-swaig-function" +title: "to_swaig_function" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::to_swaig_function" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `to_swaig_function` + +Convert to a SWAIG function definition JSON. + +**Modifiers:** `const` + +## Signature + +```cpp +json to_swaig_function() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 102. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/webhook-expressions.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/webhook-expressions.mdx new file mode 100644 index 0000000000..e72677283a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/webhook-expressions.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/webhook-expressions" +title: "webhook_expressions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::webhook_expressions" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `webhook_expressions` + +Add expressions that run after the most recent webhook. + +## Signature + +```cpp +DataMap & webhook_expressions(const std::vector< json > & expressions) +``` + +## Parameters + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 78. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/webhook.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/webhook.mdx new file mode 100644 index 0000000000..149f5939cb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/data-map/webhook.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/cpp/signalwire/datamap/data-map/webhook" +title: "webhook" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::datamap::DataMap::webhook" + parent: "signalwire::datamap::DataMap" + module: "signalwire.datamap" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `webhook` + +Add a webhook API call. + +## Signature + +```cpp +DataMap & webhook( + const std::string & method, + const std::string & url, + const json & headers = json::object(), + const std::string & form_param = "", + bool input_args_as_params = false, + const std::vector< std::string > & require_args = {} +) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`DataMap &` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 71. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/index.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/index.mdx new file mode 100644 index 0000000000..6e5966f56f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/datamap" +title: "datamap" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::datamap" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" +--- +# `datamap` + +## Signature + +```cpp +namespace signalwire::datamap +``` + +## Type Aliases + + + + + +## Classes + + + + Fluent builder for SWAIG data\_map tools (server-side, no webhook needed). Every setter returns \*this for chaining. + + + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/datamap/json.mdx b/fern/products/sdk-reference/cpp/signalwire/datamap/json.mdx new file mode 100644 index 0000000000..a2bc161551 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/datamap/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/datamap/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::datamap::json" + parent: "signalwire::datamap" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/datamap/datamap.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/datamap/datamap.hpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/generate-random-password.mdx b/fern/products/sdk-reference/cpp/signalwire/generate-random-password.mdx new file mode 100644 index 0000000000..599fe66dba --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/generate-random-password.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/generate-random-password" +title: "generate_random_password" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::generate_random_password" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp" + visibility: "public" +--- +# `generate_random_password` + +**Modifiers:** `inline` + +## Signature + +```cpp +std::string generate_random_password(int length = 32) +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/common.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp) + +Line 70. diff --git a/fern/products/sdk-reference/cpp/signalwire/generate-uuid.mdx b/fern/products/sdk-reference/cpp/signalwire/generate-uuid.mdx new file mode 100644 index 0000000000..4bef04ebba --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/generate-uuid.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/cpp/signalwire/generate-uuid" +title: "generate_uuid" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::generate_uuid" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp" + visibility: "public" +--- +# `generate_uuid` + +**Modifiers:** `inline` + +## Signature + +```cpp +std::string generate_uuid() +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/common.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp) + +Line 35. diff --git a/fern/products/sdk-reference/cpp/signalwire/get-env.mdx b/fern/products/sdk-reference/cpp/signalwire/get-env.mdx new file mode 100644 index 0000000000..220a05cbd0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/get-env.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/get-env" +title: "get_env" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::get_env" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp" + visibility: "public" +--- +# `get_env` + +**Modifiers:** `inline` + +## Signature + +```cpp +std::string get_env( + const std::string & key, + const std::string & default_val = "" +) +``` + +## Parameters + + + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/common.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp) + +Line 49. diff --git a/fern/products/sdk-reference/cpp/signalwire/get-logger.mdx b/fern/products/sdk-reference/cpp/signalwire/get-logger.mdx new file mode 100644 index 0000000000..ad91dea849 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/get-logger.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/cpp/signalwire/get-logger" +title: "get_logger" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::get_logger" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `get_logger` + +**Modifiers:** `inline` + +## Signature + +```cpp +Logger & get_logger() +``` + +## Returns + +`Logger &` + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 99. diff --git a/fern/products/sdk-reference/cpp/signalwire/index.mdx b/fern/products/sdk-reference/cpp/signalwire/index.mdx new file mode 100644 index 0000000000..44a7f79b29 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/index.mdx @@ -0,0 +1,121 @@ +--- +slug: "/reference/cpp/signalwire" +title: "signalwire" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" +--- +# `signalwire` + +SignalWire webhook signature validation. +Implements both schemes from porting-sdk/webhooks.md: + +Scheme A (RELAY/SWML/JSON): hex(HMAC-SHA1(key, url + raw\_body)) +Scheme B (Compat/cXML form): base64(HMAC-SHA1(key, url + sortedFormParams)) with optional bodySHA256 query-param fallback for JSON-on-compat-surface. + +All comparisons use CRYPTO\_memcmp (constant-time) so the secret is not leaked over repeated requests. The implementation MUST NOT log keys, signatures, or which branch failed — that's a spec requirement. + +## Signature + +```cpp +namespace signalwire +``` + +## Functions + + + + Add a directory to search for skills. Mirrors Python's signalwire.add\_skill\_directory(path) — delegates to the singleton skills::SkillRegistry instance so third-party skill collections can be registered by path. + + + + + + + + + + + + + + + + Get complete schema for all available skills. Mirrors Python's signalwire.list\_skills\_with\_params(). Returns a map keyed by skill name where each value contains parameter metadata. Useful for GUI configuration tools, API documentation, or programmatic skill discovery. C++ skills don't carry rich Python-style parameter introspection in v1, so each entry contains the skill name and an empty parameter map; built-in skills that expose parameter\_schema() via SkillBase get richer detail merged in. + + + + Register a custom skill class with the global skill registry. Mirrors Python's signalwire.register\_skill(skill\_class). Delegates to skills::SkillRegistry::register\_skill. The skill's name comes from the supplied skills::SkillBase factory (which instantiates a SkillBase to read its skill\_name() accessor). + + + + Top-level convenience entry points — mirror Python's signalwire/**init**.py package-level helpers (RestClient, register\_skill, add\_skill\_directory, list\_skills\_with\_params). The audit projects each free function onto the canonical Python signalwire.<name> path. RestClient preserves PascalCase to match Python's same-cased factory function name. Construct a rest::RestClient from positional or keyword credentials. Mirrors Python's top-level signalwire.RestClient(\*args, \*\*kwargs) factory — a thin wrapper that lazy-imports signalwire.rest.RestClient and instantiates it. Supports both positional credentials (args = \{project, token, space\}) and keyword credentials (kwargs\["project"] etc.) with environment-variable fallback. + + + + + + + +## Type Aliases + + + + + +## Classes + + + + + +## Enums + + + + + +## Modules + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/json.mdx b/fern/products/sdk-reference/cpp/signalwire/json.mdx new file mode 100644 index 0000000000..0c9936d9d3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/json.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/cpp/signalwire/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::json" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/common.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp) + +Line 32. diff --git a/fern/products/sdk-reference/cpp/signalwire/list-skills-with-params.mdx b/fern/products/sdk-reference/cpp/signalwire/list-skills-with-params.mdx new file mode 100644 index 0000000000..16ce6200ec --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/list-skills-with-params.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/cpp/signalwire/list-skills-with-params" +title: "list_skills_with_params" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::list_skills_with_params" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/signalwire.cpp" + visibility: "public" +--- +# `list_skills_with_params` + +Get complete schema for all available skills. +Mirrors Python's signalwire.list\_skills\_with\_params(). Returns a map keyed by skill name where each value contains parameter metadata. Useful for GUI configuration tools, API documentation, or programmatic skill discovery. +C++ skills don't carry rich Python-style parameter introspection in v1, so each entry contains the skill name and an empty parameter map; built-in skills that expose parameter\_schema() via SkillBase get richer detail merged in. + +## Signature + +```cpp +std::map< std::string, std::map< std::string, std::string > > list_skills_with_params() +``` + +## Returns + +`std::map< std::string, std::map< std::string, std::string > >` + +## Source + +[`src/signalwire.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/signalwire.cpp) + +Line 99. diff --git a/fern/products/sdk-reference/cpp/signalwire/log-level/index.mdx b/fern/products/sdk-reference/cpp/signalwire/log-level/index.mdx new file mode 100644 index 0000000000..1e57ce4899 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/log-level/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/cpp/signalwire/log-level" +title: "LogLevel" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "enum" + language: "cpp" + qualified_name: "signalwire::LogLevel" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `LogLevel` + +## Signature + +```cpp +enum class LogLevel +``` + +## Variants + + + + + + + + + + + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 11. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/debug.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/debug.mdx new file mode 100644 index 0000000000..a57ea2ffd5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/debug.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logger/debug" +title: "debug" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::Logger::debug" + parent: "signalwire::Logger" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `debug` + +**Modifiers:** `inline` + +## Signature + +```cpp +void debug(const std::string & msg) +``` + +## Parameters + + + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 69. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/error.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/error.mdx new file mode 100644 index 0000000000..ae5e6b5168 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/error.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logger/error" +title: "error" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::Logger::error" + parent: "signalwire::Logger" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `error` + +**Modifiers:** `inline` + +## Signature + +```cpp +void error(const std::string & msg) +``` + +## Parameters + + + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 72. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/index.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/index.mdx new file mode 100644 index 0000000000..24cd78087f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/logger" +title: "Logger" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::Logger" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `Logger` + +## Signature + +```cpp +class signalwire::Logger +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 19. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/info.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/info.mdx new file mode 100644 index 0000000000..1a63b9143a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/info.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logger/info" +title: "info" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::Logger::info" + parent: "signalwire::Logger" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `info` + +**Modifiers:** `inline` + +## Signature + +```cpp +void info(const std::string & msg) +``` + +## Parameters + + + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 70. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/instance.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/instance.mdx new file mode 100644 index 0000000000..6b9d130f41 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/instance.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logger/instance" +title: "instance" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::Logger::instance" + parent: "signalwire::Logger" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `instance` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +Logger & instance() +``` + +## Returns + +`Logger &` + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 21. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/is-suppressed.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/is-suppressed.mdx new file mode 100644 index 0000000000..b67988c491 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/is-suppressed.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logger/is-suppressed" +title: "is_suppressed" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::Logger::is_suppressed" + parent: "signalwire::Logger" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `is_suppressed` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool is_suppressed() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 45. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/level.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/level.mdx new file mode 100644 index 0000000000..1fd6ea879d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/level.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logger/level" +title: "level" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::Logger::level" + parent: "signalwire::Logger" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `level` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +LogLevel level() const +``` + +## Returns + +`LogLevel` + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 31. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/log.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/log.mdx new file mode 100644 index 0000000000..1473ef84e5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/log.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/logger/log" +title: "log" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::Logger::log" + parent: "signalwire::Logger" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `log` + +**Modifiers:** `inline` + +## Signature + +```cpp +void log(LogLevel level, const std::string & message) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 49. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/set-level.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/set-level.mdx new file mode 100644 index 0000000000..c15f971a9a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/set-level.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logger/set-level" +title: "set_level" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::Logger::set_level" + parent: "signalwire::Logger" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `set_level` + +**Modifiers:** `inline` + +## Signature + +```cpp +void set_level(LogLevel level) +``` + +## Parameters + + + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 26. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/suppress.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/suppress.mdx new file mode 100644 index 0000000000..8328123913 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/suppress.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/logger/suppress" +title: "suppress" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::Logger::suppress" + parent: "signalwire::Logger" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `suppress` + +**Modifiers:** `inline` + +## Signature + +```cpp +void suppress() +``` + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 35. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/unsuppress.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/unsuppress.mdx new file mode 100644 index 0000000000..ee47b61184 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/unsuppress.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/logger/unsuppress" +title: "unsuppress" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::Logger::unsuppress" + parent: "signalwire::Logger" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `unsuppress` + +**Modifiers:** `inline` + +## Signature + +```cpp +void unsuppress() +``` + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 40. diff --git a/fern/products/sdk-reference/cpp/signalwire/logger/warn.mdx b/fern/products/sdk-reference/cpp/signalwire/logger/warn.mdx new file mode 100644 index 0000000000..ede1e8e913 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logger/warn.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logger/warn" +title: "warn" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::Logger::warn" + parent: "signalwire::Logger" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp" + visibility: "public" +--- +# `warn` + +**Modifiers:** `inline` + +## Signature + +```cpp +void warn(const std::string & msg) +``` + +## Parameters + + + +## Source + +[`include/signalwire/logging.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging.hpp) + +Line 71. diff --git a/fern/products/sdk-reference/cpp/signalwire/logging/get-log-level.mdx b/fern/products/sdk-reference/cpp/signalwire/logging/get-log-level.mdx new file mode 100644 index 0000000000..e0f9c9be98 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logging/get-log-level.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logging/get-log-level" +title: "get_log_level" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::logging::get_log_level" + parent: "signalwire::logging" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp" + visibility: "public" +--- +# `get_log_level` + +**Modifiers:** `inline` + +## Signature + +```cpp +LogLevel get_log_level() +``` + +## Returns + +`LogLevel` + +## Source + +[`include/signalwire/logging/logger.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/logging/get-logger.mdx b/fern/products/sdk-reference/cpp/signalwire/logging/get-logger.mdx new file mode 100644 index 0000000000..bacd0e8a75 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logging/get-logger.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/logging/get-logger" +title: "get_logger" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::logging::get_logger" + parent: "signalwire::logging" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp" + visibility: "public" +--- +# `get_logger` + +**Modifiers:** `inline` + +## Signature + +```cpp +Logger get_logger(const std::string & name) +``` + +## Parameters + + + +## Returns + +`Logger` + +## Source + +[`include/signalwire/logging/logger.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp) + +Line 51. diff --git a/fern/products/sdk-reference/cpp/signalwire/logging/index.mdx b/fern/products/sdk-reference/cpp/signalwire/logging/index.mdx new file mode 100644 index 0000000000..97451e300b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logging/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/cpp/signalwire/logging" +title: "logging" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::logging" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp" +--- +# `logging` + +## Signature + +```cpp +namespace signalwire::logging +``` + +## Functions + + + + + + + +## Classes + + + + + +## Enums + + + + + +## Source + +[`include/signalwire/logging/logger.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp) + +Line 10. diff --git a/fern/products/sdk-reference/cpp/signalwire/logging/log-level/index.mdx b/fern/products/sdk-reference/cpp/signalwire/logging/log-level/index.mdx new file mode 100644 index 0000000000..bc0464deb2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logging/log-level/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/logging/log-level" +title: "LogLevel" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "enum" + language: "cpp" + qualified_name: "signalwire::logging::LogLevel" + parent: "signalwire::logging" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp" + visibility: "public" +--- +# `LogLevel` + +## Signature + +```cpp +enum class LogLevel +``` + +## Variants + + + + + + + + + + + +## Source + +[`include/signalwire/logging/logger.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/logging/logger/debug.mdx b/fern/products/sdk-reference/cpp/signalwire/logging/logger/debug.mdx new file mode 100644 index 0000000000..70890f9d68 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logging/logger/debug.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logging/logger/debug" +title: "debug" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::logging::Logger::debug" + parent: "signalwire::logging::Logger" + module: "signalwire.logging" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp" + visibility: "public" +--- +# `debug` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +void debug(const std::string & msg) const +``` + +## Parameters + + + +## Source + +[`include/signalwire/logging/logger.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp) + +Line 30. diff --git a/fern/products/sdk-reference/cpp/signalwire/logging/logger/error.mdx b/fern/products/sdk-reference/cpp/signalwire/logging/logger/error.mdx new file mode 100644 index 0000000000..87716acc61 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logging/logger/error.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logging/logger/error" +title: "error" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::logging::Logger::error" + parent: "signalwire::logging::Logger" + module: "signalwire.logging" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp" + visibility: "public" +--- +# `error` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +void error(const std::string & msg) const +``` + +## Parameters + + + +## Source + +[`include/signalwire/logging/logger.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp) + +Line 42. diff --git a/fern/products/sdk-reference/cpp/signalwire/logging/logger/index.mdx b/fern/products/sdk-reference/cpp/signalwire/logging/logger/index.mdx new file mode 100644 index 0000000000..62d17734df --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logging/logger/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/logging/logger" +title: "Logger" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::logging::Logger" + parent: "signalwire::logging" + module: "signalwire.logging" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp" + visibility: "public" +--- +# `Logger` + +## Signature + +```cpp +class signalwire::logging::Logger +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`include/signalwire/logging/logger.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp) + +Line 26. diff --git a/fern/products/sdk-reference/cpp/signalwire/logging/logger/info.mdx b/fern/products/sdk-reference/cpp/signalwire/logging/logger/info.mdx new file mode 100644 index 0000000000..51990ce827 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logging/logger/info.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logging/logger/info" +title: "info" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::logging::Logger::info" + parent: "signalwire::logging::Logger" + module: "signalwire.logging" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp" + visibility: "public" +--- +# `info` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +void info(const std::string & msg) const +``` + +## Parameters + + + +## Source + +[`include/signalwire/logging/logger.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp) + +Line 34. diff --git a/fern/products/sdk-reference/cpp/signalwire/logging/logger/logger.mdx b/fern/products/sdk-reference/cpp/signalwire/logging/logger/logger.mdx new file mode 100644 index 0000000000..25de5a2ec1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logging/logger/logger.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logging/logger/logger" +title: "Logger" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::logging::Logger::Logger" + parent: "signalwire::logging::Logger" + module: "signalwire.logging" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp" + visibility: "public" +--- +# `Logger` + +**Modifiers:** `explicit` `inline` + +## Signature + +```cpp +void Logger(const std::string & name) +``` + +## Parameters + + + +## Source + +[`include/signalwire/logging/logger.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/logging/logger/warn.mdx b/fern/products/sdk-reference/cpp/signalwire/logging/logger/warn.mdx new file mode 100644 index 0000000000..cc2e8c6d44 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/logging/logger/warn.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/logging/logger/warn" +title: "warn" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::logging::Logger::warn" + parent: "signalwire::logging::Logger" + module: "signalwire.logging" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp" + visibility: "public" +--- +# `warn` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +void warn(const std::string & msg) const +``` + +## Parameters + + + +## Source + +[`include/signalwire/logging/logger.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/logging/logger.hpp) + +Line 38. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/index.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/index.mdx new file mode 100644 index 0000000000..07d871ed6e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/cpp/signalwire/pom" +title: "pom" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::pom" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" +--- +# `pom` + +## Signature + +```cpp +namespace signalwire::pom +``` + +## Functions + + + + Emit a json value as YAML. Inverse of yaml\_parse. Pretty output matches the shape PyYAML's yaml.dump(..., default\_flow\_style=False, sort\_keys=False) produces for the POM shape. + + + + + + Parse a YAML document (POM-shaped subset only) into a json value. Supports list-of-dicts at top level; values may be strings, booleans, or lists of either. Throws std::invalid\_argument on malformed input. + + + +## Type Aliases + + + + + +## Classes + + + + Top-level container of an ordered list of sections. + + + + One section in the Prompt Object Model tree. Mirrors Python's signalwire.pom.pom.Section. Fields are public to match the Python attribute access pattern section.body, section.bullets, section.subsections. + + + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 37. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/json.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/json.mdx new file mode 100644 index 0000000000..25f117692b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/pom/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::pom::json" + parent: "signalwire::pom" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 39. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/add-pom-as-subsection.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/add-pom-as-subsection.mdx new file mode 100644 index 0000000000..ce4bf81c3b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/add-pom-as-subsection.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model/add-pom-as-subsection" +title: "add_pom_as_subsection" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel::add_pom_as_subsection" + parent: "signalwire::pom::PromptObjectModel" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `add_pom_as_subsection` + +Add every top-level section of pom\_to\_add as a subsection of the section identified by target\_title. Throws std::invalid\_argument when no matching section exists. + +## Signature + + + + ```cpp + void add_pom_as_subsection( + const std::string & target_title, + const PromptObjectModel & pom_to_add + ) + ``` + + + + ```cpp + void add_pom_as_subsection( + Section & target, + const PromptObjectModel & pom_to_add + ) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + + + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 188. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/add-section.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/add-section.mdx new file mode 100644 index 0000000000..71fd0f148a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/add-section.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model/add-section" +title: "add_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel::add_section" + parent: "signalwire::pom::PromptObjectModel" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `add_section` + +Append a new top-level section. title may be empty only for the very first section (Python enforces "Only the first section can +have no title"); subsequent calls without a title throw std::invalid\_argument. + +## Signature + +```cpp +Section & add_section( + const std::string & title = "", + const std::string & body = "", + const std::vector< std::string > & bullets = {}, + std::optional< bool > numbered = std::nullopt, + bool numbered_bullets = false +) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`Section &` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 152. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/find-section.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/find-section.mdx new file mode 100644 index 0000000000..eef428b224 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/find-section.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model/find-section" +title: "find_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel::find_section" + parent: "signalwire::pom::PromptObjectModel" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `find_section` + +Recursively search for a section by title. Returns a pointer to the owned section so callers can mutate it; returns nullptr when nothing matches. Pointer is invalidated by any subsequent mutation of the POM that grows sections or subsections (caller's responsibility — same contract as std::vector::data()). + +## Signature + + + + ```cpp + Section * find_section(const std::string & title) + ``` + + + + ```cpp + const Section * find_section(const std::string & title) const + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Section *` + +## Returns (Overload 2) + +`const Section *` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 163. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/from-json.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/from-json.mdx new file mode 100644 index 0000000000..1b15329d69 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/from-json.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model/from-json" +title: "from_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel::from_json" + parent: "signalwire::pom::PromptObjectModel" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `from_json` + +Build a POM from a JSON string. Throws nlohmann::json::parse\_error on malformed JSON, and std::invalid\_argument on shape violations (missing required fields, wrong types, etc.). + +**Modifiers:** `static` + +## Signature + + + + ```cpp + PromptObjectModel from_json(const std::string & json_text) + ``` + + + + ```cpp + PromptObjectModel from_json(const json & data) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`PromptObjectModel` + +## Returns (Overload 2) + +`PromptObjectModel` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 142. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/from-yaml.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/from-yaml.mdx new file mode 100644 index 0000000000..d5b91a1596 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/from-yaml.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model/from-yaml" +title: "from_yaml" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel::from_yaml" + parent: "signalwire::pom::PromptObjectModel" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `from_yaml` + +Build a POM from a YAML string (minimal POM-shaped subset only). + +**Modifiers:** `static` + +## Signature + +```cpp +PromptObjectModel from_yaml(const std::string & yaml_text) +``` + +## Parameters + + + +## Returns + +`PromptObjectModel` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 146. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/index.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/index.mdx new file mode 100644 index 0000000000..d88ebe15bb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/index.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model" +title: "PromptObjectModel" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel" + parent: "signalwire::pom" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `PromptObjectModel` + +Top-level container of an ordered list of sections. + +## Signature + +```cpp +class signalwire::pom::PromptObjectModel +``` + +## Properties + + + + + +## Methods + + + + Add every top-level section of pom\_to\_add as a subsection of the section identified by target\_title. Throws std::invalid\_argument when no matching section exists. + + + + Append a new top-level section. title may be empty only for the very first section (Python enforces "Only the first section can have no title"); subsequent calls without a title throw std::invalid\_argument. + + + + Recursively search for a section by title. Returns a pointer to the owned section so callers can mutate it; returns nullptr when nothing matches. Pointer is invalidated by any subsequent mutation of the POM that grows sections or subsections (caller's responsibility — same contract as std::vector::data()). + + + + Build a POM from a JSON string. Throws nlohmann::json::parse\_error on malformed JSON, and std::invalid\_argument on shape violations (missing required fields, wrong types, etc.). + + + + Build a POM from a YAML string (minimal POM-shaped subset only). + + + + + + Render entire POM as Markdown. + + + + Render entire POM as XML (with <?xml ... ?> prolog and a <prompt> root element). + + + + Whole-tree dict view (a json array). Identical content to to\_json, returned as a parsed json value. + + + + Whole-tree JSON serializer. Returns a pretty-printed (indent=2) JSON array string, matching Python's json.dumps(..., indent=2). + + + + Whole-tree YAML serializer. Returns a YAML document representing the JSON-equivalent list-of-dicts structure. + + + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 130. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/prompt-object-model.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/prompt-object-model.mdx new file mode 100644 index 0000000000..a0042c8677 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/prompt-object-model.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model/prompt-object-model" +title: "PromptObjectModel" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel::PromptObjectModel" + parent: "signalwire::pom::PromptObjectModel" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `PromptObjectModel` + +## Signature + + + + ```cpp + void PromptObjectModel() + ``` + + + + ```cpp + void PromptObjectModel(bool debug_flag) + ``` + + + +## Parameters (Overload 2) + + + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 135. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/render-markdown.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/render-markdown.mdx new file mode 100644 index 0000000000..5e4681e894 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/render-markdown.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model/render-markdown" +title: "render_markdown" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel::render_markdown" + parent: "signalwire::pom::PromptObjectModel" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `render_markdown` + +Render entire POM as Markdown. + +**Modifiers:** `const` + +## Signature + +```cpp +std::string render_markdown() const +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 179. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/render-xml.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/render-xml.mdx new file mode 100644 index 0000000000..fc7129e7f5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/render-xml.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model/render-xml" +title: "render_xml" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel::render_xml" + parent: "signalwire::pom::PromptObjectModel" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `render_xml` + +Render entire POM as XML (with <?xml ... ?> prolog and a <prompt> root element). + +**Modifiers:** `const` + +## Signature + +```cpp +std::string render_xml() const +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 183. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/to-dict.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/to-dict.mdx new file mode 100644 index 0000000000..84b986540c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/to-dict.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model/to-dict" +title: "to_dict" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel::to_dict" + parent: "signalwire::pom::PromptObjectModel" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `to_dict` + +Whole-tree dict view (a json array). Identical content to to\_json, returned as a parsed json value. + +**Modifiers:** `const` + +## Signature + +```cpp +json to_dict() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 176. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/to-json.mdx new file mode 100644 index 0000000000..81e9adad8b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/to-json.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel::to_json" + parent: "signalwire::pom::PromptObjectModel" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `to_json` + +Whole-tree JSON serializer. Returns a pretty-printed (indent=2) JSON array string, matching Python's json.dumps(..., indent=2). + +**Modifiers:** `const` + +## Signature + +```cpp +std::string to_json() const +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 168. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/to-yaml.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/to-yaml.mdx new file mode 100644 index 0000000000..de6c0a345d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/prompt-object-model/to-yaml.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/pom/prompt-object-model/to-yaml" +title: "to_yaml" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::PromptObjectModel::to_yaml" + parent: "signalwire::pom::PromptObjectModel" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `to_yaml` + +Whole-tree YAML serializer. Returns a YAML document representing the JSON-equivalent list-of-dicts structure. + +**Modifiers:** `const` + +## Signature + +```cpp +std::string to_yaml() const +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 172. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/section/add-body.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/section/add-body.mdx new file mode 100644 index 0000000000..a4d86aca55 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/section/add-body.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/pom/section/add-body" +title: "add_body" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::Section::add_body" + parent: "signalwire::pom::Section" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `add_body` + +Replace (NOT append) the body text. Mirrors Python's documented "Add OR REPLACE the body text" contract. + +## Signature + +```cpp +void add_body(const std::string & b) +``` + +## Parameters + + + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 90. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/section/add-bullets.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/section/add-bullets.mdx new file mode 100644 index 0000000000..6d3e414906 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/section/add-bullets.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/pom/section/add-bullets" +title: "add_bullets" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::Section::add_bullets" + parent: "signalwire::pom::Section" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `add_bullets` + +Append bullets to the existing list. + +## Signature + +```cpp +void add_bullets(const std::vector< std::string > & bs) +``` + +## Parameters + + + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 93. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/section/add-subsection.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/section/add-subsection.mdx new file mode 100644 index 0000000000..ed877fb8a1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/section/add-subsection.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/pom/section/add-subsection" +title: "add_subsection" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::Section::add_subsection" + parent: "signalwire::pom::Section" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `add_subsection` + +Add a child subsection. Returns a reference to the newly-created subsection so callers can chain further mutations. Throws std::invalid\_argument if title is empty (Python raises ValueError("Subsections must have a title")). + +## Signature + +```cpp +Section & add_subsection( + const std::string & title, + const std::string & body = "", + const std::vector< std::string > & bullets = {}, + std::optional< bool > numbered = std::nullopt, + bool numbered_bullets = false +) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`Section &` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 99. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/section/index.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/section/index.mdx new file mode 100644 index 0000000000..27c89cb44d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/section/index.mdx @@ -0,0 +1,93 @@ +--- +slug: "/reference/cpp/signalwire/pom/section" +title: "Section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::pom::Section" + parent: "signalwire::pom" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `Section` + +One section in the Prompt Object Model tree. +Mirrors Python's signalwire.pom.pom.Section. Fields are public to match the Python attribute access pattern section.body, section.bullets, section.subsections. + +## Signature + +```cpp +class signalwire::pom::Section +``` + +## Properties + + + Optional paragraph of body text. + + + + Optional bullet list. + + + + Whether this section participates in section numbering. Three-state: std::nullopt — not specified (Python None); inherits. true — explicitly numbered. false — explicitly opted out of numbering. Numbering is "all-or-none per sibling group": if any sibling has numbered == true, every sibling gets numbered unless it explicitly opts out with false. + + + + When true, bullets are rendered as a numbered list (1. 2. 3.) in markdown and as <bullet id="1"> in XML, instead of dash bullets. + + + + Nested sections (recursively the same shape). + + + + Section title. Optional only on the very first top-level section (Python enforces "only the first section can have no title"); for subsections a title is always required. + + +## Methods + + + + Replace (NOT append) the body text. Mirrors Python's documented "Add OR REPLACE the body text" contract. + + + + Append bullets to the existing list. + + + + Add a child subsection. Returns a reference to the newly-created subsection so callers can chain further mutations. Throws std::invalid\_argument if title is empty (Python raises ValueError("Subsections must have a title")). + + + + Render this section + subtree as Markdown. level is the heading level for this section (default 2 = ## ); section\_number is the parent path that will prefix this section's title (e.g. \{1, 2\} -> "1.2. "); empty means "no numbering". + + + + Render this section + subtree as XML. indent is the number of 2-space indents to use; section\_number follows the same rule as render\_markdown. + + + + Build a Section. title is optional; everything else has sensible defaults so empty Sections can be created and populated incrementally via add\_body / add\_bullets / add\_subsection. + + + + Python-compatible alias for to\_json — Python exposes to\_dict. Returns the same JSON object. + + + + Convert the section (and its subtree) to a JSON object. Matches the Python key order: title, body, bullets, subsections, numbered, numberedBullets. + + + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 48. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/section/render-markdown.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/section/render-markdown.mdx new file mode 100644 index 0000000000..2619102ad8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/section/render-markdown.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/pom/section/render-markdown" +title: "render_markdown" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::Section::render_markdown" + parent: "signalwire::pom::Section" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `render_markdown` + +Render this section + subtree as Markdown. level is the heading level for this section (default 2 = ## ); section\_number is the parent path that will prefix this section's title (e.g. \{1, 2\} -> "1.2. "); empty means "no numbering". + +**Modifiers:** `const` + +## Signature + +```cpp +std::string render_markdown( + int level = 2, + const std::vector< int > & section_number = {} +) const +``` + +## Parameters + + + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 118. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/section/render-xml.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/section/render-xml.mdx new file mode 100644 index 0000000000..4a8fcb46d1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/section/render-xml.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/pom/section/render-xml" +title: "render_xml" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::Section::render_xml" + parent: "signalwire::pom::Section" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `render_xml` + +Render this section + subtree as XML. indent is the number of 2-space indents to use; section\_number follows the same rule as render\_markdown. + +**Modifiers:** `const` + +## Signature + +```cpp +std::string render_xml( + int indent = 0, + const std::vector< int > & section_number = {} +) const +``` + +## Parameters + + + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 124. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/section/section.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/section/section.mdx new file mode 100644 index 0000000000..80502870a8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/section/section.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/cpp/signalwire/pom/section/section" +title: "Section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::Section::Section" + parent: "signalwire::pom::Section" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `Section` + +Build a Section. title is optional; everything else has sensible defaults so empty Sections can be created and populated incrementally via add\_body / add\_bullets / add\_subsection. + +## Signature + + + + ```cpp + void Section() + ``` + + + + ```cpp + void Section( + std::optional< std::string > t, + std::string b = "", + std::vector< std::string > bs = {}, + std::optional< bool > num = std::nullopt, + bool numbered_bullets = false + ) + ``` + + + +## Parameters (Overload 2) + + + + + + + + + + + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 77. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/section/to-dict.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/section/to-dict.mdx new file mode 100644 index 0000000000..7bb396a1ac --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/section/to-dict.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/pom/section/to-dict" +title: "to_dict" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::Section::to_dict" + parent: "signalwire::pom::Section" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `to_dict` + +Python-compatible alias for to\_json — Python exposes to\_dict. Returns the same JSON object. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json to_dict() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 112. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/section/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/section/to-json.mdx new file mode 100644 index 0000000000..29183220ef --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/section/to-json.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/pom/section/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::pom::Section::to_json" + parent: "signalwire::pom::Section" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp" + visibility: "public" +--- +# `to_json` + +Convert the section (and its subtree) to a JSON object. Matches the Python key order: title, body, bullets, subsections, numbered, numberedBullets. + +**Modifiers:** `const` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/pom/pom.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/pom/pom.hpp) + +Line 108. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/yaml-dump-ordered.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/yaml-dump-ordered.mdx new file mode 100644 index 0000000000..0da46cfe48 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/yaml-dump-ordered.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/pom/yaml-dump-ordered" +title: "yaml_dump_ordered" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::pom::yaml_dump_ordered" + parent: "signalwire::pom" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/pom/pom.cpp" + visibility: "public" +--- +# `yaml_dump_ordered` + +## Signature + +```cpp +std::string yaml_dump_ordered(const nlohmann::ordered_json & value) +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`src/pom/pom.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/pom/pom.cpp) + +Line 1129. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/yaml-dump.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/yaml-dump.mdx new file mode 100644 index 0000000000..0667724b42 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/yaml-dump.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/pom/yaml-dump" +title: "yaml_dump" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::pom::yaml_dump" + parent: "signalwire::pom" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/pom/pom.cpp" + visibility: "public" +--- +# `yaml_dump` + +Emit a json value as YAML. Inverse of yaml\_parse. Pretty output matches the shape PyYAML's yaml.dump(..., default\_flow\_style=False, sort\_keys=False) produces for the POM shape. + +## Signature + +```cpp +std::string yaml_dump(const json & value) +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`src/pom/pom.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/pom/pom.cpp) + +Line 1121. diff --git a/fern/products/sdk-reference/cpp/signalwire/pom/yaml-parse.mdx b/fern/products/sdk-reference/cpp/signalwire/pom/yaml-parse.mdx new file mode 100644 index 0000000000..685808f577 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/pom/yaml-parse.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/pom/yaml-parse" +title: "yaml_parse" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::pom::yaml_parse" + parent: "signalwire::pom" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/pom/pom.cpp" + visibility: "public" +--- +# `yaml_parse` + +Parse a YAML document (POM-shaped subset only) into a json value. Supports list-of-dicts at top level; values may be strings, booleans, or lists of either. Throws std::invalid\_argument on malformed input. + +## Signature + +```cpp +json yaml_parse(const std::string & yaml_text) +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`src/pom/pom.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/pom/pom.cpp) + +Line 1110. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/concierge-agent.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/concierge-agent.mdx new file mode 100644 index 0000000000..98e9a8d599 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/concierge-agent.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/concierge-agent/concierge-agent" +title: "ConciergeAgent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::ConciergeAgent::ConciergeAgent" + parent: "signalwire::prefabs::ConciergeAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `ConciergeAgent` + +**Modifiers:** `explicit` + +## Signature + +```cpp +void ConciergeAgent( + const std::string & name = "concierge", + const std::string & route = "/", + const std::string & host = "0.0.0.0", + int port = 3000 +) +``` + +## Parameters + + + + + + + + + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 67. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/index.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/index.mdx new file mode 100644 index 0000000000..c3f9ee479e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/concierge-agent" +title: "ConciergeAgent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::prefabs::ConciergeAgent" + parent: "signalwire::prefabs" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `ConciergeAgent` + +Venue concierge with amenity info. + +## Signature + +```cpp +class signalwire::prefabs::ConciergeAgent : signalwire::agent::AgentBase +``` + +## Inheritance + +**Extends:** [signalwire::agent::AgentBase](/reference/cpp/signalwire/agent/agent-base) + +## Methods + + + + + + + + + + + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 65. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/set-amenities.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/set-amenities.mdx new file mode 100644 index 0000000000..a16fc4f312 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/set-amenities.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/concierge-agent/set-amenities" +title: "set_amenities" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::ConciergeAgent::set_amenities" + parent: "signalwire::prefabs::ConciergeAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_amenities` + +## Signature + +```cpp +ConciergeAgent & set_amenities(const std::vector< json > & amenities) +``` + +## Parameters + + + +## Returns + +`ConciergeAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 73. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/set-hours.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/set-hours.mdx new file mode 100644 index 0000000000..5cdc919c9b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/set-hours.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/concierge-agent/set-hours" +title: "set_hours" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::ConciergeAgent::set_hours" + parent: "signalwire::prefabs::ConciergeAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_hours` + +## Signature + +```cpp +ConciergeAgent & set_hours(const json & hours) +``` + +## Parameters + + + +## Returns + +`ConciergeAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 74. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/set-venue-name.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/set-venue-name.mdx new file mode 100644 index 0000000000..2925712f89 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/concierge-agent/set-venue-name.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/concierge-agent/set-venue-name" +title: "set_venue_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::ConciergeAgent::set_venue_name" + parent: "signalwire::prefabs::ConciergeAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_venue_name` + +## Signature + +```cpp +ConciergeAgent & set_venue_name(const std::string & name) +``` + +## Parameters + + + +## Returns + +`ConciergeAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 72. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/faq-bot-agent.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/faq-bot-agent.mdx new file mode 100644 index 0000000000..a0ebe6946d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/faq-bot-agent.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/faq-bot-agent/faq-bot-agent" +title: "FAQBotAgent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::FAQBotAgent::FAQBotAgent" + parent: "signalwire::prefabs::FAQBotAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `FAQBotAgent` + +**Modifiers:** `explicit` + +## Signature + +```cpp +void FAQBotAgent( + const std::string & name = "faq_bot", + const std::string & route = "/", + const std::string & host = "0.0.0.0", + int port = 3000 +) +``` + +## Parameters + + + + + + + + + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 54. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/index.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/index.mdx new file mode 100644 index 0000000000..d59bdf5b0b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/faq-bot-agent" +title: "FAQBotAgent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::prefabs::FAQBotAgent" + parent: "signalwire::prefabs" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `FAQBotAgent` + +Keyword-based FAQ matching. + +## Signature + +```cpp +class signalwire::prefabs::FAQBotAgent : signalwire::agent::AgentBase +``` + +## Inheritance + +**Extends:** [signalwire::agent::AgentBase](/reference/cpp/signalwire/agent/agent-base) + +## Methods + + + + + + + + + + + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 52. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/set-faqs.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/set-faqs.mdx new file mode 100644 index 0000000000..bfa0e01e60 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/set-faqs.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/faq-bot-agent/set-faqs" +title: "set_faqs" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::FAQBotAgent::set_faqs" + parent: "signalwire::prefabs::FAQBotAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_faqs` + +## Signature + +```cpp +FAQBotAgent & set_faqs(const std::vector< json > & faqs) +``` + +## Parameters + + + +## Returns + +`FAQBotAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 59. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/set-no-match-message.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/set-no-match-message.mdx new file mode 100644 index 0000000000..78b3719d2f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/set-no-match-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/faq-bot-agent/set-no-match-message" +title: "set_no_match_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::FAQBotAgent::set_no_match_message" + parent: "signalwire::prefabs::FAQBotAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_no_match_message` + +## Signature + +```cpp +FAQBotAgent & set_no_match_message(const std::string & msg) +``` + +## Parameters + + + +## Returns + +`FAQBotAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 60. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/set-suggest-related.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/set-suggest-related.mdx new file mode 100644 index 0000000000..f1275ffddb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/faq-bot-agent/set-suggest-related.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/faq-bot-agent/set-suggest-related" +title: "set_suggest_related" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::FAQBotAgent::set_suggest_related" + parent: "signalwire::prefabs::FAQBotAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_suggest_related` + +## Signature + +```cpp +FAQBotAgent & set_suggest_related(bool suggest) +``` + +## Parameters + + + +## Returns + +`FAQBotAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 61. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/index.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/index.mdx new file mode 100644 index 0000000000..e727a3c212 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/cpp/signalwire/prefabs" +title: "prefabs" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::prefabs" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" +--- +# `prefabs` + +## Signature + +```cpp +namespace signalwire::prefabs +``` + +## Type Aliases + + + + + +## Classes + + + + Venue concierge with amenity info. + + + + Keyword-based FAQ matching. + + + + Sequential question collection with key/value answers. + + + + Department routing with call transfer. + + + + Typed surveys with validation. + + + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 8. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/index.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/index.mdx new file mode 100644 index 0000000000..e9eab60191 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/info-gatherer-agent" +title: "InfoGathererAgent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::prefabs::InfoGathererAgent" + parent: "signalwire::prefabs" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `InfoGathererAgent` + +Sequential question collection with key/value answers. + +## Signature + +```cpp +class signalwire::prefabs::InfoGathererAgent : signalwire::agent::AgentBase +``` + +## Inheritance + +**Extends:** [signalwire::agent::AgentBase](/reference/cpp/signalwire/agent/agent-base) + +## Methods + + + + + + + + + + + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 13. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/info-gatherer-agent.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/info-gatherer-agent.mdx new file mode 100644 index 0000000000..930c1e9093 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/info-gatherer-agent.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/info-gatherer-agent/info-gatherer-agent" +title: "InfoGathererAgent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::InfoGathererAgent::InfoGathererAgent" + parent: "signalwire::prefabs::InfoGathererAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `InfoGathererAgent` + +**Modifiers:** `explicit` + +## Signature + +```cpp +void InfoGathererAgent( + const std::string & name = "info_gatherer", + const std::string & route = "/", + const std::string & host = "0.0.0.0", + int port = 3000 +) +``` + +## Parameters + + + + + + + + + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 15. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/set-completion-message.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/set-completion-message.mdx new file mode 100644 index 0000000000..47fd90ca36 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/set-completion-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/info-gatherer-agent/set-completion-message" +title: "set_completion_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::InfoGathererAgent::set_completion_message" + parent: "signalwire::prefabs::InfoGathererAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_completion_message` + +## Signature + +```cpp +InfoGathererAgent & set_completion_message(const std::string & msg) +``` + +## Parameters + + + +## Returns + +`InfoGathererAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 21. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/set-prefix.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/set-prefix.mdx new file mode 100644 index 0000000000..a50a8c06d5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/set-prefix.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/info-gatherer-agent/set-prefix" +title: "set_prefix" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::InfoGathererAgent::set_prefix" + parent: "signalwire::prefabs::InfoGathererAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_prefix` + +## Signature + +```cpp +InfoGathererAgent & set_prefix(const std::string & prefix) +``` + +## Parameters + + + +## Returns + +`InfoGathererAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/set-questions.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/set-questions.mdx new file mode 100644 index 0000000000..d0168ac26a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/info-gatherer-agent/set-questions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/info-gatherer-agent/set-questions" +title: "set_questions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::InfoGathererAgent::set_questions" + parent: "signalwire::prefabs::InfoGathererAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_questions` + +## Signature + +```cpp +InfoGathererAgent & set_questions(const std::vector< json > & questions) +``` + +## Parameters + + + +## Returns + +`InfoGathererAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 20. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/json.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/json.mdx new file mode 100644 index 0000000000..f2eeb14d3e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::prefabs::json" + parent: "signalwire::prefabs" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 10. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/index.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/index.mdx new file mode 100644 index 0000000000..ae069c97a9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/receptionist-agent" +title: "ReceptionistAgent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::prefabs::ReceptionistAgent" + parent: "signalwire::prefabs" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `ReceptionistAgent` + +Department routing with call transfer. + +## Signature + +```cpp +class signalwire::prefabs::ReceptionistAgent : signalwire::agent::AgentBase +``` + +## Inheritance + +**Extends:** [signalwire::agent::AgentBase](/reference/cpp/signalwire/agent/agent-base) + +## Methods + + + + + + + + + + + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 39. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/receptionist-agent.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/receptionist-agent.mdx new file mode 100644 index 0000000000..1de676c5bb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/receptionist-agent.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/receptionist-agent/receptionist-agent" +title: "ReceptionistAgent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::ReceptionistAgent::ReceptionistAgent" + parent: "signalwire::prefabs::ReceptionistAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `ReceptionistAgent` + +**Modifiers:** `explicit` + +## Signature + +```cpp +void ReceptionistAgent( + const std::string & name = "receptionist", + const std::string & route = "/", + const std::string & host = "0.0.0.0", + int port = 3000 +) +``` + +## Parameters + + + + + + + + + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 41. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/set-departments.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/set-departments.mdx new file mode 100644 index 0000000000..dec6016b7c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/set-departments.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/receptionist-agent/set-departments" +title: "set_departments" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::ReceptionistAgent::set_departments" + parent: "signalwire::prefabs::ReceptionistAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_departments` + +## Signature + +```cpp +ReceptionistAgent & set_departments(const json & departments) +``` + +## Parameters + + + +## Returns + +`ReceptionistAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 46. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/set-greeting.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/set-greeting.mdx new file mode 100644 index 0000000000..b4f58b704f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/set-greeting.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/receptionist-agent/set-greeting" +title: "set_greeting" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::ReceptionistAgent::set_greeting" + parent: "signalwire::prefabs::ReceptionistAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_greeting` + +## Signature + +```cpp +ReceptionistAgent & set_greeting(const std::string & greeting) +``` + +## Parameters + + + +## Returns + +`ReceptionistAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 47. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/set-transfer-message.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/set-transfer-message.mdx new file mode 100644 index 0000000000..18c0133014 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/receptionist-agent/set-transfer-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/receptionist-agent/set-transfer-message" +title: "set_transfer_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::ReceptionistAgent::set_transfer_message" + parent: "signalwire::prefabs::ReceptionistAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_transfer_message` + +## Signature + +```cpp +ReceptionistAgent & set_transfer_message(const std::string & msg) +``` + +## Parameters + + + +## Returns + +`ReceptionistAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 48. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/index.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/index.mdx new file mode 100644 index 0000000000..6f0dc49e3a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/survey-agent" +title: "SurveyAgent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::prefabs::SurveyAgent" + parent: "signalwire::prefabs" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `SurveyAgent` + +Typed surveys with validation. + +## Signature + +```cpp +class signalwire::prefabs::SurveyAgent : signalwire::agent::AgentBase +``` + +## Inheritance + +**Extends:** [signalwire::agent::AgentBase](/reference/cpp/signalwire/agent/agent-base) + +## Methods + + + + + + + + + + + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 26. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/set-completion-message.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/set-completion-message.mdx new file mode 100644 index 0000000000..737f7be970 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/set-completion-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/survey-agent/set-completion-message" +title: "set_completion_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::SurveyAgent::set_completion_message" + parent: "signalwire::prefabs::SurveyAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_completion_message` + +## Signature + +```cpp +SurveyAgent & set_completion_message(const std::string & msg) +``` + +## Parameters + + + +## Returns + +`SurveyAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 34. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/set-intro-message.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/set-intro-message.mdx new file mode 100644 index 0000000000..551c123f11 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/set-intro-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/survey-agent/set-intro-message" +title: "set_intro_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::SurveyAgent::set_intro_message" + parent: "signalwire::prefabs::SurveyAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_intro_message` + +## Signature + +```cpp +SurveyAgent & set_intro_message(const std::string & msg) +``` + +## Parameters + + + +## Returns + +`SurveyAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 35. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/set-questions.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/set-questions.mdx new file mode 100644 index 0000000000..da9e5a0ec5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/set-questions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/survey-agent/set-questions" +title: "set_questions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::SurveyAgent::set_questions" + parent: "signalwire::prefabs::SurveyAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `set_questions` + +## Signature + +```cpp +SurveyAgent & set_questions(const std::vector< json > & questions) +``` + +## Parameters + + + +## Returns + +`SurveyAgent &` + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 33. diff --git a/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/survey-agent.mdx b/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/survey-agent.mdx new file mode 100644 index 0000000000..687a68b77a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/prefabs/survey-agent/survey-agent.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/prefabs/survey-agent/survey-agent" +title: "SurveyAgent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::prefabs::SurveyAgent::SurveyAgent" + parent: "signalwire::prefabs::SurveyAgent" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp" + visibility: "public" +--- +# `SurveyAgent` + +**Modifiers:** `explicit` + +## Signature + +```cpp +void SurveyAgent( + const std::string & name = "survey", + const std::string & route = "/", + const std::string & host = "0.0.0.0", + int port = 3000 +) +``` + +## Parameters + + + + + + + + + +## Source + +[`include/signalwire/prefabs/prefabs.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/prefabs/prefabs.hpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/register-skill.mdx b/fern/products/sdk-reference/cpp/signalwire/register-skill.mdx new file mode 100644 index 0000000000..3009d9e42e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/register-skill.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/register-skill" +title: "register_skill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::register_skill" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/signalwire.cpp" + visibility: "public" +--- +# `register_skill` + +Register a custom skill class with the global skill registry. +Mirrors Python's signalwire.register\_skill(skill\_class). Delegates to skills::SkillRegistry::register\_skill. The skill's name comes from the supplied skills::SkillBase factory (which instantiates a SkillBase to read its skill\_name() accessor). + +## Signature + +```cpp +void register_skill(skills::SkillFactory factory) +``` + +## Parameters + + + +## Source + +[`src/signalwire.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/signalwire.cpp) + +Line 79. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/action.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/action.mdx new file mode 100644 index 0000000000..1b67ea7693 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/action.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/action" +title: "Action" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::Action" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `Action` + +## Signature + + + + ```cpp + void Action() + ``` + + + + ```cpp + void Action(const std::string & control_id) + ``` + + + + ```cpp + void Action( + const std::string & control_id, + RelayClient * client, + const std::string & call_id, + const std::string & node_id + ) + ``` + + + +## Parameters (Overload 2) + + + +## Parameters (Overload 3) + + + + + + + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 27. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/call-id.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/call-id.mdx new file mode 100644 index 0000000000..114a0d6c09 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/call-id.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/call-id" +title: "call_id" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::call_id" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `call_id` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & call_id() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 36. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/completed-callback.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/completed-callback.mdx new file mode 100644 index 0000000000..293cfcab01 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/completed-callback.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/completed-callback" +title: "CompletedCallback" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::relay::Action::CompletedCallback" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `CompletedCallback` + +## Signature + +```cpp +typedef std::function< void(const Action &)> CompletedCallback +``` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 25. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/completed.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/completed.mdx new file mode 100644 index 0000000000..2832284186 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/completed.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/completed" +title: "completed" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::completed" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `completed` + +**Modifiers:** `const` + +## Signature + +```cpp +bool completed() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 34. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/control-id.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/control-id.mdx new file mode 100644 index 0000000000..aa2135fe17 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/control-id.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/control-id" +title: "control_id" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::control_id" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `control_id` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & control_id() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 32. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/event-type-filter.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/event-type-filter.mdx new file mode 100644 index 0000000000..2b7aacceb4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/event-type-filter.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/event-type-filter" +title: "event_type_filter" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::event_type_filter" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `event_type_filter` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::vector< std::string > & event_type_filter() const +``` + +## Returns + +`const std::vector< std::string > &` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 56. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/event-type-matches.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/event-type-matches.mdx new file mode 100644 index 0000000000..3b4414462e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/event-type-matches.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/event-type-matches" +title: "event_type_matches" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::event_type_matches" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `event_type_matches` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool event_type_matches(const std::string & event_type) const +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 59. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/index.mdx new file mode 100644 index 0000000000..fd89bedb0f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/index.mdx @@ -0,0 +1,116 @@ +--- +slug: "/reference/cpp/signalwire/relay/action" +title: "Action" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::relay::Action" + parent: "signalwire::relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `Action` + +Represents a controllable in-progress operation (play, record, collect, etc.) Uses shared internal state so the object can be copied/moved freely while maintaining a single underlying condition\_variable for synchronization. + +## Signature + +```cpp +class signalwire::relay::Action +``` + +## Methods + + + + + + + + + + + + + + + + Method prefix used for sub-command frames (stop/pause/resume/...). Defaults to "calling.play"; set explicitly when an Action is built for a different verb (record, collect, detect, ...). The Call::execute\_action factory plumbs this through. + + + + + + Set a callback to fire when the action completes. + + + + Request the server to pause this action. extra\_params may carry e.g. \{"behavior": "continuous"\} for record-side pause. + + + + Resolve the action immediately (used for call-gone scenarios). + + + + + + + + + + Request the server to resume this action. + + + + Set the wire-event types the Action should accept state updates from. Empty (the default) means "match any component event whose control\_id matches this Action". Used by play\_and\_collect to listen on calling.call.collect only — a calling.call.play(finished) must NOT resolve a play\_and\_collect action. + + + + + + Detect actions resolve on the first event carrying a detect payload, not on a state(finished) — see Python's DetectAction. When this flag is set the action's update\_state path resolves only when params.detect is present. + + + + Collect actions resolve when an event carries a result payload. A play(finished) earlier in the timeline does NOT resolve a CollectAction — see Python's CollectAction terminal-event logic. + + + + Start the inter-digit / final-digit timers on a collect. The matching Python method is StandaloneCollectAction.start\_input\_timers. + + + + + + Request the server to stop this action. Routes to \.stop so an Action returned by record() sends calling.record.stop rather than calling.play.stop. + + + + Update internal state (called by Call/Client when events arrive). + + + + Adjust playback volume (play only). The frame body carries the supplied amount in dB; positive boosts, negative attenuates. + + + + Block until the action completes or times out. + + + +## Type Aliases + + + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 23. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/method-prefix.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/method-prefix.mdx new file mode 100644 index 0000000000..fc417a1857 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/method-prefix.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/method-prefix" +title: "method_prefix" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::method_prefix" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `method_prefix` + +Method prefix used for sub-command frames (stop/pause/resume/...). Defaults to "calling.play"; set explicitly when an Action is built for a different verb (record, collect, detect, ...). The Call::execute\_action factory plumbs this through. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & method_prefix() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 43. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/node-id.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/node-id.mdx new file mode 100644 index 0000000000..83bbfd43d0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/node-id.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/node-id" +title: "node_id" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::node_id" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `node_id` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & node_id() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 37. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/on-completed.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/on-completed.mdx new file mode 100644 index 0000000000..f5ab371e65 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/on-completed.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/on-completed" +title: "on_completed" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::on_completed" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `on_completed` + +Set a callback to fire when the action completes. + +## Signature + +```cpp +void on_completed(CompletedCallback cb) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 109. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/pause.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/pause.mdx new file mode 100644 index 0000000000..56ea9a7313 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/pause.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/pause" +title: "pause" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::pause" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `pause` + +Request the server to pause this action. extra\_params may carry e.g. \{"behavior": "continuous"\} for record-side pause. + +## Signature + +```cpp +void pause(const json & extra_params = json::object()) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 95. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/resolve-on-detect.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/resolve-on-detect.mdx new file mode 100644 index 0000000000..53b01c3f26 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/resolve-on-detect.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/resolve-on-detect" +title: "resolve_on_detect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::resolve_on_detect" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `resolve_on_detect` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool resolve_on_detect() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 74. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/resolve-on-result.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/resolve-on-result.mdx new file mode 100644 index 0000000000..9cb4544e0d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/resolve-on-result.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/resolve-on-result" +title: "resolve_on_result" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::resolve_on_result" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `resolve_on_result` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool resolve_on_result() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 82. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/resolve.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/resolve.mdx new file mode 100644 index 0000000000..b346d98024 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/resolve.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/resolve" +title: "resolve" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::resolve" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `resolve` + +Resolve the action immediately (used for call-gone scenarios). + +## Signature + +```cpp +void resolve( + const std::string & final_state = "finished", + const json & result = json::object() +) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 115. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/result.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/result.mdx new file mode 100644 index 0000000000..05d6854ca2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/result.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/result" +title: "result" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::result" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `result` + +**Modifiers:** `const` + +## Signature + +```cpp +const json & result() const +``` + +## Returns + +`const json &` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 35. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/resume.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/resume.mdx new file mode 100644 index 0000000000..79026158bf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/resume.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/resume" +title: "resume" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::resume" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `resume` + +Request the server to resume this action. + +## Signature + +```cpp +void resume() +``` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 98. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/set-event-type-filter.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/set-event-type-filter.mdx new file mode 100644 index 0000000000..e0b9bfc5b5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/set-event-type-filter.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/set-event-type-filter" +title: "set_event_type_filter" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::set_event_type_filter" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `set_event_type_filter` + +Set the wire-event types the Action should accept state updates from. Empty (the default) means "match any component event whose +control\_id matches this Action". Used by play\_and\_collect to listen on calling.call.collect only — a calling.call.play(finished) must NOT resolve a play\_and\_collect action. + +**Modifiers:** `inline` + +## Signature + +```cpp +void set_event_type_filter(const std::vector< std::string > & types) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 53. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/set-method-prefix.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/set-method-prefix.mdx new file mode 100644 index 0000000000..8084cc8d26 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/set-method-prefix.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/set-method-prefix" +title: "set_method_prefix" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::set_method_prefix" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `set_method_prefix` + +**Modifiers:** `inline` + +## Signature + +```cpp +void set_method_prefix(const std::string & prefix) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 44. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/set-resolve-on-detect.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/set-resolve-on-detect.mdx new file mode 100644 index 0000000000..d8803db593 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/set-resolve-on-detect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/set-resolve-on-detect" +title: "set_resolve_on_detect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::set_resolve_on_detect" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `set_resolve_on_detect` + +Detect actions resolve on the first event carrying a detect payload, not on a state(finished) — see Python's DetectAction. When this flag is set the action's update\_state path resolves only when params.detect is present. + +**Modifiers:** `inline` + +## Signature + +```cpp +void set_resolve_on_detect(bool flag) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 71. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/set-resolve-on-result.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/set-resolve-on-result.mdx new file mode 100644 index 0000000000..8ecd485f63 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/set-resolve-on-result.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/set-resolve-on-result" +title: "set_resolve_on_result" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::set_resolve_on_result" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `set_resolve_on_result` + +Collect actions resolve when an event carries a result payload. A play(finished) earlier in the timeline does NOT resolve a CollectAction — see Python's CollectAction terminal-event logic. + +**Modifiers:** `inline` + +## Signature + +```cpp +void set_resolve_on_result(bool flag) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 79. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/start-input-timers.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/start-input-timers.mdx new file mode 100644 index 0000000000..8b27ad540b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/start-input-timers.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/start-input-timers" +title: "start_input_timers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::start_input_timers" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `start_input_timers` + +Start the inter-digit / final-digit timers on a collect. The matching Python method is StandaloneCollectAction.start\_input\_timers. + +## Signature + +```cpp +void start_input_timers() +``` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 106. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/state.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/state.mdx new file mode 100644 index 0000000000..624badaed7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/state.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/state" +title: "state" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::state" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `state` + +**Modifiers:** `const` + +## Signature + +```cpp +const std::string & state() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 33. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/stop.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/stop.mdx new file mode 100644 index 0000000000..8cd9a883e2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/stop" +title: "stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::stop" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `stop` + +Request the server to stop this action. Routes to \.stop so an Action returned by record() sends calling.record.stop rather than calling.play.stop. + +## Signature + +```cpp +void stop() +``` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 90. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/update-state.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/update-state.mdx new file mode 100644 index 0000000000..21bfc0f359 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/update-state.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/update-state" +title: "update_state" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::update_state" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `update_state` + +Update internal state (called by Call/Client when events arrive). + +## Signature + +```cpp +void update_state( + const std::string & new_state, + const json & result = json::object() +) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 112. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/volume.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/volume.mdx new file mode 100644 index 0000000000..1f27af1d85 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/volume.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/volume" +title: "volume" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::volume" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `volume` + +Adjust playback volume (play only). The frame body carries the supplied amount in dB; positive boosts, negative attenuates. + +## Signature + +```cpp +void volume(double amount) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 102. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/action/wait.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/action/wait.mdx new file mode 100644 index 0000000000..7529e0596c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/action/wait.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/action/wait" +title: "wait" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Action::wait" + parent: "signalwire::relay::Action" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `wait` + +Block until the action completes or times out. + +## Signature + +```cpp +bool wait(int timeout_ms = 0) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 85. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/base64-encode.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/base64-encode.mdx new file mode 100644 index 0000000000..52c8f07278 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/base64-encode.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/relay/base64-encode" +title: "base64_encode" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::relay::base64_encode" + parent: "signalwire::relay" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/relay/websocket.cpp" + visibility: "public" +--- +# `base64_encode` + +**Modifiers:** `static` + +## Signature + +```cpp +std::string base64_encode(const unsigned char * data, size_t len) +``` + +## Parameters + + + + + +## Returns + +`std::string` + +## Source + +[`src/relay/websocket.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/relay/websocket.cpp) + +Line 54. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call-event-handler.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call-event-handler.mdx new file mode 100644 index 0000000000..7cac58af8b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call-event-handler.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/relay/call-event-handler" +title: "CallEventHandler" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::relay::CallEventHandler" + parent: "signalwire::relay" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `CallEventHandler` + +Callback for call events. + +## Signature + +```cpp +typedef std::function< void(const CallEvent &)> CallEventHandler +``` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 26. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call-event/from-relay-event.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call-event/from-relay-event.mdx new file mode 100644 index 0000000000..817380c2ef --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call-event/from-relay-event.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/call-event/from-relay-event" +title: "from_relay_event" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::CallEvent::from_relay_event" + parent: "signalwire::relay::CallEvent" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp" + visibility: "public" +--- +# `from_relay_event` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +CallEvent from_relay_event(const RelayEvent & ev) +``` + +## Parameters + + + +## Returns + +`CallEvent` + +## Source + +[`include/signalwire/relay/relay_event.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp) + +Line 45. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call-event/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call-event/index.mdx new file mode 100644 index 0000000000..8c09d24f28 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call-event/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/relay/call-event" +title: "CallEvent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::relay::CallEvent" + parent: "signalwire::relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp" + visibility: "public" +--- +# `CallEvent` + +Call-specific event parsed from calling.call.state and other call events. + +## Signature + +```cpp +struct signalwire::relay::CallEvent : signalwire::relay::RelayEvent +``` + +## Inheritance + +**Extends:** [signalwire::relay::RelayEvent](/reference/cpp/signalwire/relay/relay-event) + +## Properties + + + + + + + + + + + +## Methods + + + + + +## Source + +[`include/signalwire/relay/relay_event.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp) + +Line 38. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/ai.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/ai.mdx new file mode 100644 index 0000000000..76a7ae90f7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/ai.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/ai" +title: "ai" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::ai" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `ai` + +## Signature + +```cpp +Action ai(const json & params, const std::string & control_id = "") +``` + +## Parameters + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 78. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/answer.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/answer.mdx new file mode 100644 index 0000000000..87a2648591 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/answer.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/answer" +title: "answer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::answer" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `answer` + +## Signature + +```cpp +Action answer() +``` + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 50. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/call-id.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/call-id.mdx new file mode 100644 index 0000000000..120309802f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/call-id.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/call-id" +title: "call_id" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::call_id" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `call_id` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & call_id() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 38. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/call.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/call.mdx new file mode 100644 index 0000000000..8dd0f4284c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/call.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/call" +title: "Call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::Call" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `Call` + +## Signature + + + + ```cpp + void Call() + ``` + + + + ```cpp + void Call(const std::string & call_id, const std::string & node_id) + ``` + + + + ```cpp + void Call( + const std::string & call_id, + const std::string & node_id, + RelayClient * client + ) + ``` + + + +## Parameters (Overload 2) + + + + + +## Parameters (Overload 3) + + + + + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 33. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/collect.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/collect.mdx new file mode 100644 index 0000000000..59c9e3477d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/collect.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/collect" +title: "collect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::collect" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `collect` + +## Signature + +```cpp +Action collect(const json & params, const std::string & control_id = "") +``` + +## Parameters + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 61. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/connect.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/connect.mdx new file mode 100644 index 0000000000..2d980c53a1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/connect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/connect" +title: "connect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::connect" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `connect` + +## Signature + +```cpp +Action connect(const json & devices) +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 63. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/detect.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/detect.mdx new file mode 100644 index 0000000000..3a8a8db061 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/detect.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/detect" +title: "detect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::detect" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `detect` + +## Signature + +```cpp +Action detect(const json & params, const std::string & control_id = "") +``` + +## Parameters + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 65. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/direction.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/direction.mdx new file mode 100644 index 0000000000..1bef72b2fe --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/direction.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/direction" +title: "direction" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::direction" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `direction` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & direction() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 41. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/disconnect.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/disconnect.mdx new file mode 100644 index 0000000000..58a63310b3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/disconnect.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/disconnect" +title: "disconnect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::disconnect" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `disconnect` + +## Signature + +```cpp +Action disconnect() +``` + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 64. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/dispatch-event.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/dispatch-event.mdx new file mode 100644 index 0000000000..89670101f5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/dispatch-event.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/dispatch-event" +title: "dispatch_event" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::dispatch_event" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `dispatch_event` + +## Signature + +```cpp +void dispatch_event(const CallEvent & ev) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 107. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/execute-swml.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/execute-swml.mdx new file mode 100644 index 0000000000..d7acabc57c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/execute-swml.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/execute-swml" +title: "execute_swml" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::execute_swml" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `execute_swml` + +## Signature + +```cpp +Action execute_swml(const json & swml) +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 93. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/find-action.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/find-action.mdx new file mode 100644 index 0000000000..e48ce15740 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/find-action.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/find-action" +title: "find_action" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::find_action" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `find_action` + +## Signature + +```cpp +Action * find_action(const std::string & control_id) +``` + +## Parameters + + + +## Returns + +`Action *` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 112. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/from.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/from.mdx new file mode 100644 index 0000000000..817cc73c0a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/from.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/from" +title: "from" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::from" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `from` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & from() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 42. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/hangup.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/hangup.mdx new file mode 100644 index 0000000000..d822ae0950 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/hangup.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/hangup" +title: "hangup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::hangup" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `hangup` + +## Signature + +```cpp +Action hangup(const std::string & reason = "hangup") +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 51. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/hold.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/hold.mdx new file mode 100644 index 0000000000..1d1c0c4a2e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/hold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/hold" +title: "hold" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::hold" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `hold` + +## Signature + +```cpp +Action hold() +``` + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 88. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/index.mdx new file mode 100644 index 0000000000..54b4c5d964 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/index.mdx @@ -0,0 +1,140 @@ +--- +slug: "/reference/cpp/signalwire/relay/call" +title: "Call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::relay::Call" + parent: "signalwire::relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `Call` + +Represents a live call with methods for call control. Uses shared internal state so the object can be copied/returned by value. All command methods send JSON-RPC requests through the RelayClient. + +## Signature + +```cpp +class signalwire::relay::Call +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 31. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/is-answered.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/is-answered.mdx new file mode 100644 index 0000000000..e77f47e263 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/is-answered.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/is-answered" +title: "is_answered" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::is_answered" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `is_answered` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool is_answered() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 46. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/is-ended.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/is-ended.mdx new file mode 100644 index 0000000000..580673f7aa --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/is-ended.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/is-ended" +title: "is_ended" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::is_ended" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `is_ended` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool is_ended() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 47. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/join-conference.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/join-conference.mdx new file mode 100644 index 0000000000..b28b7551d2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/join-conference.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/join-conference" +title: "join_conference" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::join_conference" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `join_conference` + +## Signature + +```cpp +Action join_conference( + const std::string & name, + const json & params = json::object() +) +``` + +## Parameters + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 91. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/join-room.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/join-room.mdx new file mode 100644 index 0000000000..d2a9aacb6c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/join-room.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/join-room" +title: "join_room" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::join_room" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `join_room` + +## Signature + +```cpp +Action join_room(const std::string & name) +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 92. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/live-transcribe.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/live-transcribe.mdx new file mode 100644 index 0000000000..17a1bf95d8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/live-transcribe.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/live-transcribe" +title: "live_transcribe" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::live_transcribe" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `live_transcribe` + +## Signature + +```cpp +Action live_transcribe(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 74. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/live-translate.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/live-translate.mdx new file mode 100644 index 0000000000..88187c5c45 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/live-translate.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/live-translate" +title: "live_translate" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::live_translate" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `live_translate` + +## Signature + +```cpp +Action live_translate(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 77. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/node-id.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/node-id.mdx new file mode 100644 index 0000000000..1aea3d90d5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/node-id.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/node-id" +title: "node_id" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::node_id" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `node_id` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & node_id() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 39. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/on-event.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/on-event.mdx new file mode 100644 index 0000000000..900379c2e8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/on-event.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/on-event" +title: "on_event" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::on_event" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `on_event` + +## Signature + +```cpp +void on_event(CallEventHandler handler) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 96. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/pay.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/pay.mdx new file mode 100644 index 0000000000..7eb92f2bc6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/pay.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/pay" +title: "pay" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::pay" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `pay` + +## Signature + +```cpp +Action pay(const json & params, const std::string & control_id = "") +``` + +## Parameters + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 80. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/play-and-collect.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/play-and-collect.mdx new file mode 100644 index 0000000000..0f931b5086 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/play-and-collect.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/play-and-collect" +title: "play_and_collect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::play_and_collect" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `play_and_collect` + +## Signature + +```cpp +Action play_and_collect( + const json & play_media, + const json & collect_params, + const std::string & control_id = "" +) +``` + +## Parameters + + + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 59. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/play.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/play.mdx new file mode 100644 index 0000000000..a2d5312c6a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/play.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/play" +title: "play" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::play" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `play` + +## Signature + +```cpp +Action play( + const json & media, + double volume = 0.0, + const std::string & control_id = "" +) +``` + +## Parameters + + + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 52. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/prompt.mdx new file mode 100644 index 0000000000..f9275c6e0e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/prompt.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/prompt" +title: "prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::prompt" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `prompt` + +## Signature + +```cpp +Action prompt( + const json & play_media, + const json & collect_params, + const std::string & control_id = "" +) +``` + +## Parameters + + + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 57. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/receive-fax.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/receive-fax.mdx new file mode 100644 index 0000000000..8fa4bf6099 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/receive-fax.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/receive-fax" +title: "receive_fax" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::receive_fax" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `receive_fax` + +## Signature + +```cpp +Action receive_fax(const std::string & control_id = "") +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 85. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/record-call.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/record-call.mdx new file mode 100644 index 0000000000..5ef3b05045 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/record-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/record-call" +title: "record_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::record_call" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `record_call` + +## Signature + +```cpp +Action record_call(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 56. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/record.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/record.mdx new file mode 100644 index 0000000000..a8233cddd1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/record.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/record" +title: "record" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::record" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `record` + +## Signature + +```cpp +Action record( + const json & params = json::object(), + const std::string & control_id = "" +) +``` + +## Parameters + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 54. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/register-action.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/register-action.mdx new file mode 100644 index 0000000000..604e6f48a8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/register-action.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/register-action" +title: "register_action" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::register_action" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `register_action` + +## Signature + +```cpp +void register_action(const std::string & control_id, Action * action) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 110. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/resolve-all-actions.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/resolve-all-actions.mdx new file mode 100644 index 0000000000..e797a0d20f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/resolve-all-actions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/resolve-all-actions" +title: "resolve_all_actions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::resolve_all_actions" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `resolve_all_actions` + +## Signature + +```cpp +void resolve_all_actions(const std::string & final_state = "finished") +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 115. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/send-digits.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/send-digits.mdx new file mode 100644 index 0000000000..97216f0469 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/send-digits.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/send-digits" +title: "send_digits" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::send_digits" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `send_digits` + +## Signature + +```cpp +Action send_digits(const std::string & digits) +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 72. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/send-fax.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/send-fax.mdx new file mode 100644 index 0000000000..f7476ff7b3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/send-fax.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/send-fax" +title: "send_fax" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::send_fax" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `send_fax` + +## Signature + +```cpp +Action send_fax( + const std::string & document_url, + const std::string & header = "", + const std::string & identity = "", + const std::string & control_id = "" +) +``` + +## Parameters + + + + + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 82. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/set-client.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/set-client.mdx new file mode 100644 index 0000000000..9e9334f5cc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/set-client.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/set-client" +title: "set_client" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::set_client" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `set_client` + +**Modifiers:** `inline` + +## Signature + +```cpp +void set_client(RelayClient * c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 105. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/set-direction.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/set-direction.mdx new file mode 100644 index 0000000000..27a3839783 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/set-direction.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/set-direction" +title: "set_direction" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::set_direction" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `set_direction` + +**Modifiers:** `inline` + +## Signature + +```cpp +void set_direction(const std::string & dir) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 101. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/set-from.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/set-from.mdx new file mode 100644 index 0000000000..aeaffe2b37 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/set-from.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/set-from" +title: "set_from" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::set_from" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `set_from` + +**Modifiers:** `inline` + +## Signature + +```cpp +void set_from(const std::string & f) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 102. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/set-tag.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/set-tag.mdx new file mode 100644 index 0000000000..7638692944 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/set-tag.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/set-tag" +title: "set_tag" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::set_tag" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `set_tag` + +**Modifiers:** `inline` + +## Signature + +```cpp +void set_tag(const std::string & t) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 104. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/set-to.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/set-to.mdx new file mode 100644 index 0000000000..3692ec0bd4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/set-to.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/set-to" +title: "set_to" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::set_to" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `set_to` + +**Modifiers:** `inline` + +## Signature + +```cpp +void set_to(const std::string & t) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 103. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/sip-refer.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/sip-refer.mdx new file mode 100644 index 0000000000..ff8268100d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/sip-refer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/sip-refer" +title: "sip_refer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::sip_refer" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `sip_refer` + +## Signature + +```cpp +Action sip_refer(const std::string & to_uri) +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 90. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/state.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/state.mdx new file mode 100644 index 0000000000..0637bf674c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/state.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/state" +title: "state" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::state" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `state` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & state() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 40. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/stop-tap.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/stop-tap.mdx new file mode 100644 index 0000000000..34b5778c31 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/stop-tap.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/stop-tap" +title: "stop_tap" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::stop_tap" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `stop_tap` + +## Signature + +```cpp +Action stop_tap(const std::string & control_id) +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 71. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/stream.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/stream.mdx new file mode 100644 index 0000000000..ca2373eaf3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/stream.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/stream" +title: "stream" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::stream" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `stream` + +## Signature + +```cpp +Action stream(const json & params, const std::string & control_id = "") +``` + +## Parameters + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 86. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/tag.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/tag.mdx new file mode 100644 index 0000000000..aa574c2233 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/tag.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/tag" +title: "tag" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::tag" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `tag` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & tag() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 44. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/tap-audio.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/tap-audio.mdx new file mode 100644 index 0000000000..e3ba2b5a85 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/tap-audio.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/tap-audio" +title: "tap_audio" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::tap_audio" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `tap_audio` + +## Signature + +```cpp +Action tap_audio(const json & params, const std::string & control_id = "") +``` + +## Parameters + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 67. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/tap.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/tap.mdx new file mode 100644 index 0000000000..964793585d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/tap.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/tap" +title: "tap" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::tap" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `tap` + +## Signature + +```cpp +Action tap(const json & params, const std::string & control_id = "") +``` + +## Parameters + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 69. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/to.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/to.mdx new file mode 100644 index 0000000000..4245ba9d02 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/to.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/to" +title: "to" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::to" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `to` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & to() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 43. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/transcribe.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/transcribe.mdx new file mode 100644 index 0000000000..b40c4538f3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/transcribe.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/transcribe" +title: "transcribe" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::transcribe" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `transcribe` + +## Signature + +```cpp +Action transcribe( + const json & params = json::object(), + const std::string & control_id = "" +) +``` + +## Parameters + + + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 75. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/transfer.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/transfer.mdx new file mode 100644 index 0000000000..1b25f8f812 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/transfer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/transfer" +title: "transfer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::transfer" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `transfer` + +## Signature + +```cpp +Action transfer(const json & params) +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 73. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/unhold.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/unhold.mdx new file mode 100644 index 0000000000..e8e40138ea --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/unhold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/unhold" +title: "unhold" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::unhold" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `unhold` + +## Signature + +```cpp +Action unhold() +``` + +## Returns + +`Action` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 89. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/unregister-action.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/unregister-action.mdx new file mode 100644 index 0000000000..27e29dbb36 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/unregister-action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/unregister-action" +title: "unregister_action" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::unregister_action" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `unregister_action` + +## Signature + +```cpp +void unregister_action(const std::string & control_id) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 111. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/update-state.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/update-state.mdx new file mode 100644 index 0000000000..c02a64b947 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/update-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/update-state" +title: "update_state" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::update_state" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `update_state` + +## Signature + +```cpp +void update_state(const std::string & new_state) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 100. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/call/wait-for-ended.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/call/wait-for-ended.mdx new file mode 100644 index 0000000000..8b1b193f0f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/call/wait-for-ended.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/call/wait-for-ended" +title: "wait_for_ended" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Call::wait_for_ended" + parent: "signalwire::relay::Call" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp" + visibility: "public" +--- +# `wait_for_ended` + +## Signature + +```cpp +bool wait_for_ended(int timeout_ms = 0) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/call.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/call.hpp) + +Line 97. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/component-event/from-relay-event.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/component-event/from-relay-event.mdx new file mode 100644 index 0000000000..2174e9d3ca --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/component-event/from-relay-event.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/component-event/from-relay-event" +title: "from_relay_event" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::ComponentEvent::from_relay_event" + parent: "signalwire::relay::ComponentEvent" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp" + visibility: "public" +--- +# `from_relay_event` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +ComponentEvent from_relay_event(const RelayEvent & ev) +``` + +## Parameters + + + +## Returns + +`ComponentEvent` + +## Source + +[`include/signalwire/relay/relay_event.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp) + +Line 71. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/component-event/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/component-event/index.mdx new file mode 100644 index 0000000000..561f2601a2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/component-event/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/relay/component-event" +title: "ComponentEvent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::relay::ComponentEvent" + parent: "signalwire::relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp" + visibility: "public" +--- +# `ComponentEvent` + +Play/Record/Collect component event with control\_id for action routing. + +## Signature + +```cpp +struct signalwire::relay::ComponentEvent : signalwire::relay::RelayEvent +``` + +## Inheritance + +**Extends:** [signalwire::relay::RelayEvent](/reference/cpp/signalwire/relay/relay-event) + +## Properties + + + + + + + +## Methods + + + + + +## Source + +[`include/signalwire/relay/relay_event.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp) + +Line 66. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/dial-event/from-relay-event.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/dial-event/from-relay-event.mdx new file mode 100644 index 0000000000..f9199b2b18 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/dial-event/from-relay-event.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/dial-event/from-relay-event" +title: "from_relay_event" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::DialEvent::from_relay_event" + parent: "signalwire::relay::DialEvent" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp" + visibility: "public" +--- +# `from_relay_event` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +DialEvent from_relay_event(const RelayEvent & ev) +``` + +## Parameters + + + +## Returns + +`DialEvent` + +## Source + +[`include/signalwire/relay/relay_event.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp) + +Line 113. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/dial-event/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/dial-event/index.mdx new file mode 100644 index 0000000000..45778bcbc3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/dial-event/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/relay/dial-event" +title: "DialEvent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::relay::DialEvent" + parent: "signalwire::relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp" + visibility: "public" +--- +# `DialEvent` + +Dial-specific event with nested call info and tag-based correlation. + +## Signature + +```cpp +struct signalwire::relay::DialEvent : signalwire::relay::RelayEvent +``` + +## Inheritance + +**Extends:** [signalwire::relay::RelayEvent](/reference/cpp/signalwire/relay/relay-event) + +## Properties + + + + + + + +## Methods + + + + + +## Source + +[`include/signalwire/relay/relay_event.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp) + +Line 108. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/event-handler.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/event-handler.mdx new file mode 100644 index 0000000000..ed8c516d35 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/event-handler.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/relay/event-handler" +title: "EventHandler" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::relay::EventHandler" + parent: "signalwire::relay" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `EventHandler` + +Generic callback for any inbound signalwire.event. Fired in addition to the typed handlers (on\_call, on\_message, action callbacks). Useful for tracing and for tests/audits that need to assert event delivery. + +## Signature + +```cpp +typedef std::function< void(const RelayEvent &)> EventHandler +``` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 37. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/inbound-call-handler.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/inbound-call-handler.mdx new file mode 100644 index 0000000000..73a0db4b53 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/inbound-call-handler.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/relay/inbound-call-handler" +title: "InboundCallHandler" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::relay::InboundCallHandler" + parent: "signalwire::relay" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `InboundCallHandler` + +Callback for inbound calls. + +## Signature + +```cpp +typedef std::function< void(Call &)> InboundCallHandler +``` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 29. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/inbound-message-handler.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/inbound-message-handler.mdx new file mode 100644 index 0000000000..3ccaa4fef9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/inbound-message-handler.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/relay/inbound-message-handler" +title: "InboundMessageHandler" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::relay::InboundMessageHandler" + parent: "signalwire::relay" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `InboundMessageHandler` + +Callback for inbound messages. + +## Signature + +```cpp +typedef std::function< void(const Message &)> InboundMessageHandler +``` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 32. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/index.mdx new file mode 100644 index 0000000000..d6524ff0fd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/index.mdx @@ -0,0 +1,179 @@ +--- +slug: "/reference/cpp/signalwire/relay" +title: "relay" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::relay" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" +--- +# `relay` + +## Signature + +```cpp +namespace signalwire::relay +``` + +## Constants + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Functions + + + + + + + +## Type Aliases + + + + Callback for call events. + + + + Generic callback for any inbound signalwire.event. Fired in addition to the typed handlers (on\_call, on\_message, action callbacks). Useful for tracing and for tests/audits that need to assert event delivery. + + + + Callback for inbound calls. + + + + Callback for inbound messages. + + + + + +## Classes + + + + Represents a controllable in-progress operation (play, record, collect, etc.) Uses shared internal state so the object can be copied/moved freely while maintaining a single underlying condition\_variable for synchronization. + + + + Represents a live call with methods for call control. Uses shared internal state so the object can be copied/returned by value. All command methods send JSON-RPC requests through the RelayClient. + + + + Call-specific event parsed from calling.call.state and other call events. + + + + Play/Record/Collect component event with control\_id for action routing. + + + + Dial-specific event with nested call info and tag-based correlation. + + + + Represents an SMS/MMS message tracked through delivery states. States: "queued", "initiated", "sent", "delivered", "undelivered", "failed" Uses shared internal state so the object can be copied/returned by value — copies of a Message observe the same state updates as the underlying instance the registry tracks. + + + + Messaging event for SMS/MMS state changes and inbound messages. + + + + Real-time call control and messaging client over WebSocket. Implements the full JSON-RPC 2.0 protocol with four correlation mechanisms: JSON-RPC id -> pending map for RPC response matching call\_id -> Call object map for event routing control\_id -> Action per Call for action event routing tag -> pending dials map for dial event matching + + + + Configuration for the RELAY client. + + + + Base class for all RELAY events parsed from signalwire.event JSON-RPC messages. + + + + Minimal WebSocket client using raw TCP sockets + OpenSSL TLS. Implements RFC 6455 text frame encoding/decoding for JSON-RPC transport. + + + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/json.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/json.mdx new file mode 100644 index 0000000000..8a7e5bcbfb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/relay/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::relay::json" + parent: "signalwire::relay" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/relay/action.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/action.hpp) + +Line 16. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message-event/from-relay-event.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message-event/from-relay-event.mdx new file mode 100644 index 0000000000..0a48c45551 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message-event/from-relay-event.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/message-event/from-relay-event" +title: "from_relay_event" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::MessageEvent::from_relay_event" + parent: "signalwire::relay::MessageEvent" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp" + visibility: "public" +--- +# `from_relay_event` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +MessageEvent from_relay_event(const RelayEvent & ev) +``` + +## Parameters + + + +## Returns + +`MessageEvent` + +## Source + +[`include/signalwire/relay/relay_event.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp) + +Line 92. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message-event/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message-event/index.mdx new file mode 100644 index 0000000000..b1b0bd95b8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message-event/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/relay/message-event" +title: "MessageEvent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::relay::MessageEvent" + parent: "signalwire::relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp" + visibility: "public" +--- +# `MessageEvent` + +Messaging event for SMS/MMS state changes and inbound messages. + +## Signature + +```cpp +struct signalwire::relay::MessageEvent : signalwire::relay::RelayEvent +``` + +## Inheritance + +**Extends:** [signalwire::relay::RelayEvent](/reference/cpp/signalwire/relay/relay-event) + +## Properties + + + + + + + + + + + +## Methods + + + + + +## Source + +[`include/signalwire/relay/relay_event.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp) + +Line 85. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/completed-callback.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/completed-callback.mdx new file mode 100644 index 0000000000..d7018096ee --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/completed-callback.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/completed-callback" +title: "CompletedCallback" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::relay::Message::CompletedCallback" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `CompletedCallback` + +## Signature + +```cpp +typedef std::function< void(const Message &)> CompletedCallback +``` + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 25. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/from-params.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/from-params.mdx new file mode 100644 index 0000000000..db811008dd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/from-params.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/from-params" +title: "from_params" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::from_params" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `from_params` + +Parse from a RELAY event params object. + +**Modifiers:** `static` + +## Signature + +```cpp +Message from_params(const json & params) +``` + +## Parameters + + + +## Returns + +`Message` + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 33. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/index.mdx new file mode 100644 index 0000000000..9118645aa7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/index.mdx @@ -0,0 +1,94 @@ +--- +slug: "/reference/cpp/signalwire/relay/message" +title: "Message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::relay::Message" + parent: "signalwire::relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `Message` + +Represents an SMS/MMS message tracked through delivery states. States: "queued", "initiated", "sent", "delivered", "undelivered", "failed" Uses shared internal state so the object can be copied/returned by value — copies of a Message observe the same state updates as the underlying instance the registry tracks. + +## Signature + +```cpp +struct signalwire::relay::Message +``` + +## Properties + + + + + + + + + + + + + + + + + +## Methods + + + + + + Parse from a RELAY event params object. + + + + + + + + + + + + Set callback for when message reaches terminal state. If the message is already terminal the callback fires immediately. + + + + + + + + + + + + + + Update state from a messaging.state event. Notifies waiters / callbacks when the state is terminal. + + + + Block until message reaches a terminal state. Returns true if terminal, false on timeout. + + + +## Type Aliases + + + + + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/is-delivered.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/is-delivered.mdx new file mode 100644 index 0000000000..8bf21dfd03 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/is-delivered.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/is-delivered" +title: "is_delivered" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::is_delivered" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `is_delivered` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool is_delivered() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 53. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/is-failed.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/is-failed.mdx new file mode 100644 index 0000000000..e87935e79a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/is-failed.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/is-failed" +title: "is_failed" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::is_failed" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `is_failed` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool is_failed() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 54. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/is-terminal.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/is-terminal.mdx new file mode 100644 index 0000000000..d0eed463cd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/is-terminal.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/is-terminal" +title: "is_terminal" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::is_terminal" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `is_terminal` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool is_terminal() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 58. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/message.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/message.mdx new file mode 100644 index 0000000000..74d55f3532 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/message.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/message" +title: "Message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::Message" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `Message` + +## Signature + + + + ```cpp + void Message() + ``` + + + + ```cpp + void Message(const Message &) + ``` + + + +## Parameters (Overload 2) + + + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 27. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/message__2.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/message__2.mdx new file mode 100644 index 0000000000..93b7fa5e0c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/message__2.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/message__2" +title: "~Message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::~Message" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `~Message` + +## Signature + +```cpp +void ~Message() +``` + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 30. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/on-completed.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/on-completed.mdx new file mode 100644 index 0000000000..07a409ca80 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/on-completed.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/on-completed" +title: "on_completed" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::on_completed" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `on_completed` + +Set callback for when message reaches terminal state. If the message is already terminal the callback fires immediately. + +## Signature + +```cpp +void on_completed(CompletedCallback cb) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 70. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/operator.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/operator.mdx new file mode 100644 index 0000000000..0aae723f06 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/operator.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/operator" +title: "operator=" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::operator=" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `operator=` + +## Signature + +```cpp +Message & operator=(const Message &) +``` + +## Parameters + + + +## Returns + +`Message &` + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 29. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/reason.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/reason.mdx new file mode 100644 index 0000000000..c7e6f85637 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/reason.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/reason" +title: "reason" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::reason" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `reason` + +**Modifiers:** `const` + +## Signature + +```cpp +const std::string & reason() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 49. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/set-reason.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/set-reason.mdx new file mode 100644 index 0000000000..7fbb50cab3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/set-reason.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/set-reason" +title: "set_reason" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::set_reason" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `set_reason` + +## Signature + +```cpp +void set_reason(const std::string & r) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 51. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/set-state.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/set-state.mdx new file mode 100644 index 0000000000..d9dc2525ae --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/set-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/set-state" +title: "set_state" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::set_state" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `set_state` + +## Signature + +```cpp +void set_state(const std::string & s) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 50. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/state.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/state.mdx new file mode 100644 index 0000000000..d86d25a57e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/state.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/state" +title: "state" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::state" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `state` + +**Modifiers:** `const` + +## Signature + +```cpp +const std::string & state() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 48. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/update-state.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/update-state.mdx new file mode 100644 index 0000000000..561b184469 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/update-state.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/update-state" +title: "update_state" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::update_state" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `update_state` + +Update state from a messaging.state event. Notifies waiters / callbacks when the state is terminal. + +## Signature + +```cpp +void update_state(const std::string & new_state) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 62. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/message/wait.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/message/wait.mdx new file mode 100644 index 0000000000..c51571cd28 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/message/wait.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/message/wait" +title: "wait" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::Message::wait" + parent: "signalwire::relay::Message" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp" + visibility: "public" +--- +# `wait` + +Block until message reaches a terminal state. Returns true if terminal, false on timeout. + +## Signature + +```cpp +bool wait(int timeout_ms = 0) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/message.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/message.hpp) + +Line 66. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/config.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/config.mdx new file mode 100644 index 0000000000..caa999593d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/config.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/config" +title: "config" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::config" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `config` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const RelayConfig & config() const +``` + +## Returns + +`const RelayConfig &` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 132. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/connect.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/connect.mdx new file mode 100644 index 0000000000..ff21978318 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/connect.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/connect" +title: "connect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::connect" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `connect` + +## Signature + +```cpp +bool connect() +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 77. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/dial.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/dial.mdx new file mode 100644 index 0000000000..33b8c4304e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/dial.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/dial" +title: "dial" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::dial" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `dial` + +Dial outbound. The devices argument is the nested "device-of-leg-of-leg" array used by the Python SDK (\[\[\{type:phone,...\}]]). Returns a Call once the server emits calling.call.dial(answered) for the dial's tag, or an empty Call on timeout / failure. +tag lets callers pin an explicit dial tag for journal-based assertions; if blank, a UUID is generated. dial\_timeout\_ms caps how long dial() blocks waiting for the server's terminal dial event. max\_duration (seconds) is forwarded into the calling.dial frame when non-zero. + +## Signature + +```cpp +Call dial( + const json & devices, + const std::string & tag = "", + int dial_timeout_ms = 120000, + int max_duration = 0 +) +``` + +## Parameters + + + + + + + + + +## Returns + +`Call` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 97. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/disconnect.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/disconnect.mdx new file mode 100644 index 0000000000..4bed3acc9b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/disconnect.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/disconnect" +title: "disconnect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::disconnect" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `disconnect` + +## Signature + +```cpp +void disconnect() +``` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 78. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/execute.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/execute.mdx new file mode 100644 index 0000000000..0d893a5851 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/execute.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/execute" +title: "execute" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::execute" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `execute` + +## Signature + +```cpp +json execute(const std::string & method, const json & params) +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 136. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/find-call.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/find-call.mdx new file mode 100644 index 0000000000..5ef9b92233 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/find-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/find-call" +title: "find_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::find_call" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `find_call` + +## Signature + +```cpp +Call * find_call(const std::string & call_id) +``` + +## Parameters + + + +## Returns + +`Call *` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 141. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/from-env.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/from-env.mdx new file mode 100644 index 0000000000..850b3bd4c4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/from-env.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/from-env" +title: "from_env" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::from_env" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `from_env` + +Construct from environment variables: SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, SIGNALWIRE\_SPACE + +**Modifiers:** `static` + +## Signature + +```cpp +RelayClient from_env() +``` + +## Returns + +`RelayClient` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 74. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/index.mdx new file mode 100644 index 0000000000..8eac6c83e1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/index.mdx @@ -0,0 +1,94 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client" +title: "RelayClient" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient" + parent: "signalwire::relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `RelayClient` + +Real-time call control and messaging client over WebSocket. Implements the full JSON-RPC 2.0 protocol with four correlation mechanisms: +JSON-RPC id -> pending map for RPC response matching +call\_id -> Call object map for event routing +control\_id -> Action per Call for action event routing +tag -> pending dials map for dial event matching + +## Signature + +```cpp +class signalwire::relay::RelayClient +``` + +## Methods + + + + + + + + + + Dial outbound. The devices argument is the nested "device-of-leg-of-leg" array used by the Python SDK (\[\[\{type:phone,...\}]]). Returns a Call once the server emits calling.call.dial(answered) for the dial's tag, or an empty Call on timeout / failure. tag lets callers pin an explicit dial tag for journal-based assertions; if blank, a UUID is generated. dial\_timeout\_ms caps how long dial() blocks waiting for the server's terminal dial event. max\_duration (seconds) is forwarded into the calling.dial frame when non-zero. + + + + + + + + + + Construct from environment variables: SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, SIGNALWIRE\_SPACE + + + + + + + + Register a generic event observer. Called for every dispatched signalwire.event after typed routing (on\_call/on\_message/action callbacks) has run. Multiple registrations are NOT supported — the most-recent registration wins. + + + + + + + + + + + + Construct from explicit configuration. + + + + + + Send an SMS/MMS message via messaging.send. Returns a Message tracker whose state advances as the server pushes messaging.state events. Use Message::wait() to block until the terminal state (delivered / undelivered / failed). + + + + Send a JSON-RPC request to the server. Public so harnesses and tests can drive arbitrary methods (e.g. an explicit signalwire.subscribe ack frame for the audit fixture). + + + + + + + + + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 56. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/is-connected.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/is-connected.mdx new file mode 100644 index 0000000000..7653271d3d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/is-connected.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/is-connected" +title: "is_connected" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::is_connected" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `is_connected` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool is_connected() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 80. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/on-call.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/on-call.mdx new file mode 100644 index 0000000000..51a1c1086a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/on-call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/on-call" +title: "on_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::on_call" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `on_call` + +## Signature + +```cpp +void on_call(InboundCallHandler handler) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 83. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/on-event.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/on-event.mdx new file mode 100644 index 0000000000..8958e58828 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/on-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/on-event" +title: "on_event" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::on_event" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `on_event` + +Register a generic event observer. Called for every dispatched signalwire.event after typed routing (on\_call/on\_message/action callbacks) has run. Multiple registrations are NOT supported — the most-recent registration wins. + +## Signature + +```cpp +void on_event(EventHandler handler) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 106. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/on-message.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/on-message.mdx new file mode 100644 index 0000000000..daf9e11675 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/on-message.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/on-message" +title: "on_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::on_message" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `on_message` + +## Signature + +```cpp +void on_message(InboundMessageHandler handler) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 114. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/operator.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/operator.mdx new file mode 100644 index 0000000000..5176c46b3f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/operator.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/operator" +title: "operator=" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::operator=" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `operator=` + +## Signature + +```cpp +RelayClient & operator=(const RelayClient &) +``` + +## Parameters + + + +## Returns + +`RelayClient &` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 70. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/register-call.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/register-call.mdx new file mode 100644 index 0000000000..0e6004efaf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/register-call.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/register-call" +title: "register_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::register_call" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `register_call` + +## Signature + +```cpp +void register_call(const std::string & call_id, Call * call) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 139. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/relay-client.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/relay-client.mdx new file mode 100644 index 0000000000..83173dd0c0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/relay-client.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/relay-client" +title: "RelayClient" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::RelayClient" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `RelayClient` + +Construct from explicit configuration. + +**Modifiers:** `explicit` + +## Signature + + + + ```cpp + void RelayClient(const RelayConfig & config = RelayConfig{}) + ``` + + + + ```cpp + void RelayClient( + const std::string & project, + const std::string & token, + const std::string & host = DEFAULT_HOST, + const std::vector< std::string > & contexts = {"default"} + ) + ``` + + + + ```cpp + void RelayClient(const RelayClient &) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + + + + + +## Parameters (Overload 3) + + + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 59. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/relay-client__2.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/relay-client__2.mdx new file mode 100644 index 0000000000..c73468f104 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/relay-client__2.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/relay-client__2" +title: "~RelayClient" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::~RelayClient" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `~RelayClient` + +## Signature + +```cpp +void ~RelayClient() +``` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 67. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/relay-protocol.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/relay-protocol.mdx new file mode 100644 index 0000000000..12974791e0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/relay-protocol.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/relay-protocol" +title: "relay_protocol" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::relay_protocol" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `relay_protocol` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & relay_protocol() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 133. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/run.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/run.mdx new file mode 100644 index 0000000000..48e6300223 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/run.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/run" +title: "run" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::run" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `run` + +## Signature + +```cpp +void run() +``` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 79. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/send-message.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/send-message.mdx new file mode 100644 index 0000000000..e5307f8d72 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/send-message.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/send-message" +title: "send_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::send_message" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `send_message` + +Send an SMS/MMS message via messaging.send. Returns a Message tracker whose state advances as the server pushes messaging.state events. Use Message::wait() to block until the terminal state (delivered / undelivered / failed). + +## Signature + +```cpp +Message send_message( + const std::string & from, + const std::string & to, + const std::string & body, + const std::vector< std::string > & media = {}, + const std::vector< std::string > & tags = {}, + const std::string & region = "", + const std::string & context = "" +) +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`Message` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 120. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/send-raw-request.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/send-raw-request.mdx new file mode 100644 index 0000000000..2e20930060 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/send-raw-request.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/send-raw-request" +title: "send_raw_request" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::send_raw_request" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `send_raw_request` + +Send a JSON-RPC request to the server. Public so harnesses and tests can drive arbitrary methods (e.g. an explicit signalwire.subscribe ack frame for the audit fixture). + +## Signature + +```cpp +json send_raw_request(const std::string & method, const json & params) +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 111. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/subscribe.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/subscribe.mdx new file mode 100644 index 0000000000..a2dedca38e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/subscribe.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/subscribe" +title: "subscribe" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::subscribe" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `subscribe` + +## Signature + +```cpp +void subscribe(const std::vector< std::string > & contexts) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 128. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/unregister-call.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/unregister-call.mdx new file mode 100644 index 0000000000..c911cc0b45 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/unregister-call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/unregister-call" +title: "unregister_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::unregister_call" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `unregister_call` + +## Signature + +```cpp +void unregister_call(const std::string & call_id) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 140. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/unsubscribe.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/unsubscribe.mdx new file mode 100644 index 0000000000..64e07de1ff --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-client/unsubscribe.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-client/unsubscribe" +title: "unsubscribe" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayClient::unsubscribe" + parent: "signalwire::relay::RelayClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `unsubscribe` + +## Signature + +```cpp +void unsubscribe(const std::vector< std::string > & contexts) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 129. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-config/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-config/index.mdx new file mode 100644 index 0000000000..e662208502 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-config/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-config" +title: "RelayConfig" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::relay::RelayConfig" + parent: "signalwire::relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp" + visibility: "public" +--- +# `RelayConfig` + +Configuration for the RELAY client. + +## Signature + +```cpp +struct signalwire::relay::RelayConfig +``` + +## Properties + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/relay/client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/client.hpp) + +Line 40. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-event/from-json.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-event/from-json.mdx new file mode 100644 index 0000000000..919ca094b8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-event/from-json.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-event/from-json" +title: "from_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayEvent::from_json" + parent: "signalwire::relay::RelayEvent" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp" + visibility: "public" +--- +# `from_json` + +Parse from a signalwire.event params JSON. The outer params contains event\_type and the inner params with event-specific data. + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +RelayEvent from_json(const json & j) +``` + +## Parameters + + + +## Returns + +`RelayEvent` + +## Source + +[`include/signalwire/relay/relay_event.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-event/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-event/index.mdx new file mode 100644 index 0000000000..bdd24a3d1c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-event/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-event" +title: "RelayEvent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::relay::RelayEvent" + parent: "signalwire::relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp" + visibility: "public" +--- +# `RelayEvent` + +Base class for all RELAY events parsed from signalwire.event JSON-RPC messages. + +## Signature + +```cpp +struct signalwire::relay::RelayEvent +``` + +## Properties + + + + + + + + + +## Methods + + + + Parse from a signalwire.event params JSON. The outer params contains event\_type and the inner params with event-specific data. + + + + + +## Source + +[`include/signalwire/relay/relay_event.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp) + +Line 16. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/relay-event/relay-event.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/relay-event/relay-event.mdx new file mode 100644 index 0000000000..bfb3d9807e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/relay-event/relay-event.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/relay/relay-event/relay-event" +title: "RelayEvent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::RelayEvent::RelayEvent" + parent: "signalwire::relay::RelayEvent" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp" + visibility: "public" +--- +# `RelayEvent` + +## Signature + + + + ```cpp + void RelayEvent() + ``` + + + + ```cpp + void RelayEvent(const std::string & type) + ``` + + + +## Parameters (Overload 2) + + + +## Source + +[`include/signalwire/relay/relay_event.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/relay_event.hpp) + +Line 23. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/tcp-connect.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/tcp-connect.mdx new file mode 100644 index 0000000000..402a015eb7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/tcp-connect.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/cpp/signalwire/relay/tcp-connect" +title: "tcp_connect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::relay::tcp_connect" + parent: "signalwire::relay" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/relay/websocket.cpp" + visibility: "public" +--- +# `tcp_connect` + +**Modifiers:** `static` + +## Signature + +```cpp +bool tcp_connect( + int & sock_fd, + const std::string & host, + int port, + WebSocketClient::ErrorCallback & on_error +) +``` + +## Parameters + + + + + + + + + +## Returns + +`bool` + +## Source + +[`src/relay/websocket.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/relay/websocket.cpp) + +Line 81. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/close-callback.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/close-callback.mdx new file mode 100644 index 0000000000..a2b959df23 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/close-callback.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/close-callback" +title: "CloseCallback" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::CloseCallback" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `CloseCallback` + +## Signature + +```cpp +typedef std::function< void(int code, const std::string &reason)> CloseCallback +``` + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 21. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/close.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/close.mdx new file mode 100644 index 0000000000..61bec83b6e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/close.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/close" +title: "close" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::close" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `close` + +Close the WebSocket connection gracefully. + +## Signature + +```cpp +void close(int code = 1000, const std::string & reason = "") +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 39. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/connect-plain.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/connect-plain.mdx new file mode 100644 index 0000000000..c11bfb7668 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/connect-plain.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/connect-plain" +title: "connect_plain" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::connect_plain" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `connect_plain` + +Connect to ws://host:port/ without TLS (plain TCP). Used by audit fixtures and local dev servers that don't speak TLS. Production always uses TLS via the connect() overload above. + +## Signature + +```cpp +bool connect_plain(const std::string & host, int port) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 36. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/connect.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/connect.mdx new file mode 100644 index 0000000000..4bb4faa9c8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/connect.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/connect" +title: "connect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::connect" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `connect` + +Connect to wss://host:port/ with TLS. + +## Signature + +```cpp +bool connect(const std::string & host, int port = 443) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 31. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/error-callback.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/error-callback.mdx new file mode 100644 index 0000000000..f9049e5c06 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/error-callback.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/error-callback" +title: "ErrorCallback" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::ErrorCallback" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `ErrorCallback` + +## Signature + +```cpp +typedef std::function< void(const std::string &error)> ErrorCallback +``` + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/index.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/index.mdx new file mode 100644 index 0000000000..840a24b14b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/index.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client" +title: "WebSocketClient" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient" + parent: "signalwire::relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `WebSocketClient` + +Minimal WebSocket client using raw TCP sockets + OpenSSL TLS. Implements RFC 6455 text frame encoding/decoding for JSON-RPC transport. + +## Signature + +```cpp +class signalwire::relay::WebSocketClient +``` + +## Methods + + + + + + Close the WebSocket connection gracefully. + + + + Connect to wss://host:port/ with TLS. + + + + Connect to ws://host:port/ without TLS (plain TCP). Used by audit fixtures and local dev servers that don't speak TLS. Production always uses TLS via the connect() overload above. + + + + Check if connected. + + + + Set callback for connection close. + + + + Set callback for errors. + + + + Set callback for received text messages. + + + + + + Send a text frame. + + + + + +## Type Aliases + + + + + + + + + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 18. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/is-connected.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/is-connected.mdx new file mode 100644 index 0000000000..2acc2abbc5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/is-connected.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/is-connected" +title: "is_connected" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::is_connected" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `is_connected` + +Check if connected. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool is_connected() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 45. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/message-callback.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/message-callback.mdx new file mode 100644 index 0000000000..d865072d72 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/message-callback.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/message-callback" +title: "MessageCallback" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::MessageCallback" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `MessageCallback` + +## Signature + +```cpp +typedef std::function< void(const std::string &)> MessageCallback +``` + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 20. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/on-close.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/on-close.mdx new file mode 100644 index 0000000000..8582a451d0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/on-close.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/on-close" +title: "on_close" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::on_close" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `on_close` + +Set callback for connection close. + +**Modifiers:** `inline` + +## Signature + +```cpp +void on_close(CloseCallback cb) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 51. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/on-error.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/on-error.mdx new file mode 100644 index 0000000000..ca640a53f0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/on-error.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/on-error" +title: "on_error" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::on_error" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `on_error` + +Set callback for errors. + +**Modifiers:** `inline` + +## Signature + +```cpp +void on_error(ErrorCallback cb) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 54. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/on-message.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/on-message.mdx new file mode 100644 index 0000000000..74260b9134 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/on-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/on-message" +title: "on_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::on_message" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `on_message` + +Set callback for received text messages. + +**Modifiers:** `inline` + +## Signature + +```cpp +void on_message(MessageCallback cb) +``` + +## Parameters + + + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 48. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/operator.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/operator.mdx new file mode 100644 index 0000000000..7d1cc78521 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/operator.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/operator" +title: "operator=" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::operator=" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `operator=` + +## Signature + +```cpp +WebSocketClient & operator=(const WebSocketClient &) +``` + +## Parameters + + + +## Returns + +`WebSocketClient &` + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/send.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/send.mdx new file mode 100644 index 0000000000..5c79d43138 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/send.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/send" +title: "send" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::send" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `send` + +Send a text frame. + +## Signature + +```cpp +bool send(const std::string & message) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 42. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/web-socket-client.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/web-socket-client.mdx new file mode 100644 index 0000000000..b75ade50b0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/web-socket-client.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/web-socket-client" +title: "WebSocketClient" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::WebSocketClient" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `WebSocketClient` + +## Signature + + + + ```cpp + void WebSocketClient() + ``` + + + + ```cpp + void WebSocketClient(const WebSocketClient &) + ``` + + + +## Parameters (Overload 2) + + + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/web-socket-client__2.mdx b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/web-socket-client__2.mdx new file mode 100644 index 0000000000..1cf02e2a58 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/relay/web-socket-client/web-socket-client__2.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/relay/web-socket-client/web-socket-client__2" +title: "~WebSocketClient" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::relay::WebSocketClient::~WebSocketClient" + parent: "signalwire::relay::WebSocketClient" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp" + visibility: "public" +--- +# `~WebSocketClient` + +## Signature + +```cpp +void ~WebSocketClient() +``` + +## Source + +[`include/signalwire/relay/websocket.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/relay/websocket.hpp) + +Line 25. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest-client.mdx b/fern/products/sdk-reference/cpp/signalwire/rest-client.mdx new file mode 100644 index 0000000000..ca375fcfcf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest-client.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/rest-client" +title: "RestClient" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::RestClient" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/signalwire.cpp" + visibility: "public" +--- +# `RestClient` + +Top-level convenience entry points — mirror Python's signalwire/**init**.py package-level helpers (RestClient, register\_skill, add\_skill\_directory, list\_skills\_with\_params). +The audit projects each free function onto the canonical Python signalwire.<name> path. RestClient preserves PascalCase to match Python's same-cased factory function name. Construct a rest::RestClient from positional or keyword credentials. +Mirrors Python's top-level signalwire.RestClient(\*args, \*\*kwargs) factory — a thin wrapper that lazy-imports signalwire.rest.RestClient and instantiates it. Supports both positional credentials (args = \{project, token, space\}) and keyword credentials (kwargs\["project"] etc.) with environment-variable fallback. + +std::invalid\_argument + +when credentials cannot be derived from either args, kwargs, or the standard environment variables (SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, SIGNALWIRE\_SPACE). + +## Signature + +```cpp +rest::RestClient RestClient( + const std::vector< std::string > & args = {}, + const std::map< std::string, std::string > & kwargs = {} +) +``` + +## Parameters + + + + + +## Returns + +`rest::RestClient` + +## Throws + +- `std::invalid_argument` — when credentials cannot be derived from either args, kwargs, or the standard environment variables (SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, SIGNALWIRE\_SPACE). + +## Source + +[`src/signalwire.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/signalwire.cpp) + +Line 46. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/create.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/create.mdx new file mode 100644 index 0000000000..a4de7b94b8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/crud-resource/create" +title: "create" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::CrudResource::create" + parent: "signalwire::rest::CrudResource" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `create` + +**Modifiers:** `const` + +## Signature + +```cpp +json create(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 78. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/crud-resource.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/crud-resource.mdx new file mode 100644 index 0000000000..c21ec28a85 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/crud-resource.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/crud-resource/crud-resource" +title: "CrudResource" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::CrudResource::CrudResource" + parent: "signalwire::rest::CrudResource" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `CrudResource` + +## Signature + +```cpp +void CrudResource(const HttpClient & client, const std::string & base_path) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 75. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/del.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/del.mdx new file mode 100644 index 0000000000..fa7dde578c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/del.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/crud-resource/del" +title: "del" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::CrudResource::del" + parent: "signalwire::rest::CrudResource" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `del` + +**Modifiers:** `const` + +## Signature + +```cpp +json del(const std::string & id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 81. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/get.mdx new file mode 100644 index 0000000000..73b8d54f88 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/crud-resource/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::CrudResource::get" + parent: "signalwire::rest::CrudResource" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` + +## Signature + +```cpp +json get(const std::string & id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 79. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/index.mdx new file mode 100644 index 0000000000..fcb9ca5c99 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/crud-resource" +title: "CrudResource" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::CrudResource" + parent: "signalwire::rest" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `CrudResource` + +Generic CRUD resource for REST API namespaces. + +## Signature + +```cpp +class signalwire::rest::CrudResource +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 73. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/list.mdx new file mode 100644 index 0000000000..897f99541d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/crud-resource/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::CrudResource::list" + parent: "signalwire::rest::CrudResource" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 77. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/update.mdx new file mode 100644 index 0000000000..96ecc9a03c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/crud-resource/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/crud-resource/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::CrudResource::update" + parent: "signalwire::rest::CrudResource" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` + +## Signature + +```cpp +json update(const std::string & id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 80. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/http-client/base-url.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/base-url.mdx new file mode 100644 index 0000000000..43c9a4d1ea --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/base-url.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/http-client/base-url" +title: "base_url" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::HttpClient::base_url" + parent: "signalwire::rest::HttpClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `base_url` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & base_url() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 60. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/http-client/del.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/del.mdx new file mode 100644 index 0000000000..d404013475 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/del.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/http-client/del" +title: "del" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::HttpClient::del" + parent: "signalwire::rest::HttpClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `del` + +DELETE request. + +**Modifiers:** `const` + +## Signature + +```cpp +json del(const std::string & path) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 52. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/http-client/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/get.mdx new file mode 100644 index 0000000000..0f1cf9612c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/get.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/rest/http-client/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::HttpClient::get" + parent: "signalwire::rest::HttpClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `get` + +GET request. + +**Modifiers:** `const` + +## Signature + +```cpp +json get( + const std::string & path, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 36. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/http-client/http-client.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/http-client.mdx new file mode 100644 index 0000000000..b41bb8c12d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/http-client.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/http-client/http-client" +title: "HttpClient" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::HttpClient::HttpClient" + parent: "signalwire::rest::HttpClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `HttpClient` + +## Signature + +```cpp +void HttpClient( + const std::string & base_url, + const std::string & username, + const std::string & password +) +``` + +## Parameters + + + + + + + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 31. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/http-client/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/index.mdx new file mode 100644 index 0000000000..28495ff3d0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/cpp/signalwire/rest/http-client" +title: "HttpClient" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::HttpClient" + parent: "signalwire::rest" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `HttpClient` + +HTTP client with Basic Auth support using cpp-httplib. + +## Signature + +```cpp +class signalwire::rest::HttpClient +``` + +## Methods + + + + + + DELETE request. + + + + GET request. + + + + + + PATCH request. + + + + POST request. + + + + PUT request. + + + + Set additional default headers. + + + + Set request timeout in seconds. + + + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 29. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/http-client/patch.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/patch.mdx new file mode 100644 index 0000000000..4c1bd78511 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/patch.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/rest/http-client/patch" +title: "patch" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::HttpClient::patch" + parent: "signalwire::rest::HttpClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `patch` + +PATCH request. + +**Modifiers:** `const` + +## Signature + +```cpp +json patch(const std::string & path, const json & body = json::object()) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 48. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/http-client/post.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/post.mdx new file mode 100644 index 0000000000..056a21d590 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/post.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/rest/http-client/post" +title: "post" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::HttpClient::post" + parent: "signalwire::rest::HttpClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `post` + +POST request. + +**Modifiers:** `const` + +## Signature + +```cpp +json post(const std::string & path, const json & body = json::object()) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 40. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/http-client/put.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/put.mdx new file mode 100644 index 0000000000..aa19f99c07 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/put.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/rest/http-client/put" +title: "put" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::HttpClient::put" + parent: "signalwire::rest::HttpClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `put` + +PUT request. + +**Modifiers:** `const` + +## Signature + +```cpp +json put(const std::string & path, const json & body = json::object()) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 44. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/http-client/set-header.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/set-header.mdx new file mode 100644 index 0000000000..1bfa8216b1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/set-header.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/http-client/set-header" +title: "set_header" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::HttpClient::set_header" + parent: "signalwire::rest::HttpClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `set_header` + +Set additional default headers. + +## Signature + +```cpp +void set_header(const std::string & key, const std::string & value) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 55. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/http-client/set-timeout.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/set-timeout.mdx new file mode 100644 index 0000000000..eb780bc406 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/http-client/set-timeout.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/http-client/set-timeout" +title: "set_timeout" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::HttpClient::set_timeout" + parent: "signalwire::rest::HttpClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `set_timeout` + +Set request timeout in seconds. + +## Signature + +```cpp +void set_timeout(int seconds) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 58. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/index.mdx new file mode 100644 index 0000000000..4212a3555c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/cpp/signalwire/rest" +title: "rest" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::rest" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" +--- +# `rest` + +## Signature + +```cpp +namespace signalwire::rest +``` + +## Functions + + + + + + + + Serialize a PhoneCallHandler to its wire string. + + + +## Type Aliases + + + + + +## Classes + + + + Generic CRUD resource for REST API namespaces. + + + + HTTP client with Basic Auth support using cpp-httplib. + + + + Iterates items across paginated API responses. Mirrors signalwire-python's signalwire.rest.\_pagination.PaginatedIterator: fetches the configured path with the configured params, walks the data\_key array, then follows links.next (parsing its query string for the next page's params) until the response carries no links.next. Iteration is lazy the constructor records inputs but performs no HTTP. The first has\_next() / next() call performs the first fetch. Cursor query params are extracted by parsing links.next like Python's urllib.parse.urlparse + parse\_qs. + + + + Top-level SignalWire REST client with all API namespaces. + + + + Error thrown on non-2xx REST API responses. + + + +## Enums + + + + Enumeration of call\_handler values accepted by phone\_numbers.update. Setting a phone number's call\_handler + the handler-specific companion field routes inbound calls and auto-materializes the matching Fabric resource on the server. The typed set\_\* helpers on PhoneNumbersNamespace wrap the low-level update call with the right combination — prefer those over constructing the wire body by hand. Named PhoneCallHandler (not CallHandler) to avoid colliding with signalwire::relay::InboundCallHandler — the callback type used by the RELAY client for inbound-call events. + + + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/json.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/json.mdx new file mode 100644 index 0000000000..6f5576874f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/rest/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::rest::json" + parent: "signalwire::rest" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/make-headers.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/make-headers.mdx new file mode 100644 index 0000000000..43c13bb5cd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/make-headers.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/make-headers" +title: "make_headers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::rest::make_headers" + parent: "signalwire::rest" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/rest/http_client.cpp" + visibility: "public" +--- +# `make_headers` + +**Modifiers:** `static` + +## Signature + +```cpp +httplib::Headers make_headers( + const std::string & auth, + const std::map< std::string, std::string > & extra +) +``` + +## Parameters + + + + + +## Returns + +`httplib::Headers` + +## Source + +[`src/rest/http_client.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/rest/http_client.cpp) + +Line 77. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/data-key.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/data-key.mdx new file mode 100644 index 0000000000..5fe0a74cd1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/data-key.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/paginated-iterator/data-key" +title: "data_key" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::PaginatedIterator::data_key" + parent: "signalwire::rest::PaginatedIterator" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `data_key` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & data_key() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 118. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/done.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/done.mdx new file mode 100644 index 0000000000..ff1428d66d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/done.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/paginated-iterator/done" +title: "done" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::PaginatedIterator::done" + parent: "signalwire::rest::PaginatedIterator" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `done` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool done() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 121. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/has-next.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/has-next.mdx new file mode 100644 index 0000000000..f5bfbe03f0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/has-next.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/paginated-iterator/has-next" +title: "has_next" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::PaginatedIterator::has_next" + parent: "signalwire::rest::PaginatedIterator" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `has_next` + +Returns true if another item can be fetched. Performs HTTP if the in-memory buffer is exhausted but more pages remain. + +## Signature + +```cpp +bool has_next() +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 108. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/http.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/http.mdx new file mode 100644 index 0000000000..dc098b57ad --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/http.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/paginated-iterator/http" +title: "http" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::PaginatedIterator::http" + parent: "signalwire::rest::PaginatedIterator" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `http` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const HttpClient & http() const +``` + +## Returns + +`const HttpClient &` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 115. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/index.mdx new file mode 100644 index 0000000000..479f778c4d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/cpp/signalwire/rest/paginated-iterator" +title: "PaginatedIterator" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::PaginatedIterator" + parent: "signalwire::rest" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `PaginatedIterator` + +Iterates items across paginated API responses. +Mirrors signalwire-python's signalwire.rest.\_pagination.PaginatedIterator: fetches the configured path with the configured params, walks the data\_key array, then follows links.next (parsing its query string for the next page's params) until the response carries no links.next. +Iteration is lazy the constructor records inputs but performs no HTTP. The first has\_next() / next() call performs the first fetch. Cursor query params are extracted by parsing links.next like Python's urllib.parse.urlparse + parse\_qs. + +## Signature + +```cpp +class signalwire::rest::PaginatedIterator +``` + +## Methods + + + + + + + + Returns true if another item can be fetched. Performs HTTP if the in-memory buffer is exhausted but more pages remain. + + + + + + + + + + Returns the next item; throws std::out\_of\_range when the iterator is exhausted (mirrors Python's StopIteration). + + + + + + + + + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 99. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/index__2.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/index__2.mdx new file mode 100644 index 0000000000..1fd8df7a0f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/index__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/paginated-iterator/index__2" +title: "index" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::PaginatedIterator::index" + parent: "signalwire::rest::PaginatedIterator" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `index` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +size_t index() const +``` + +## Returns + +`size_t` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 119. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/items.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/items.mdx new file mode 100644 index 0000000000..c40b0473a5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/items.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/paginated-iterator/items" +title: "items" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::PaginatedIterator::items" + parent: "signalwire::rest::PaginatedIterator" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `items` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::vector< json > & items() const +``` + +## Returns + +`const std::vector< json > &` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 120. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/next.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/next.mdx new file mode 100644 index 0000000000..e45cf777bc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/next.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/paginated-iterator/next" +title: "next" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::PaginatedIterator::next" + parent: "signalwire::rest::PaginatedIterator" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `next` + +Returns the next item; throws std::out\_of\_range when the iterator is exhausted (mirrors Python's StopIteration). + +## Signature + +```cpp +json next() +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 112. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/paginated-iterator.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/paginated-iterator.mdx new file mode 100644 index 0000000000..324309329e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/paginated-iterator.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/paginated-iterator/paginated-iterator" +title: "PaginatedIterator" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::PaginatedIterator::PaginatedIterator" + parent: "signalwire::rest::PaginatedIterator" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `PaginatedIterator` + +## Signature + +```cpp +void PaginatedIterator( + const HttpClient & http, + const std::string & path, + const std::map< std::string, std::string > & params = {}, + const std::string & data_key = "data" +) +``` + +## Parameters + + + + + + + + + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 101. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/params.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/params.mdx new file mode 100644 index 0000000000..414850bc0f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/params.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/paginated-iterator/params" +title: "params" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::PaginatedIterator::params" + parent: "signalwire::rest::PaginatedIterator" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `params` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::map< std::string, std::string > & params() const +``` + +## Returns + +`const std::map< std::string, std::string > &` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 117. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/path.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/path.mdx new file mode 100644 index 0000000000..5ce99b30c1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/paginated-iterator/path.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/paginated-iterator/path" +title: "path" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::PaginatedIterator::path" + parent: "signalwire::rest::PaginatedIterator" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `path` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & path() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 116. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/parse-url.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/parse-url.mdx new file mode 100644 index 0000000000..0ccf32eb94 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/parse-url.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/parse-url" +title: "parse_url" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::rest::parse_url" + parent: "signalwire::rest" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/rest/http_client.cpp" + visibility: "public" +--- +# `parse_url` + +**Modifiers:** `static` + +## Signature + +```cpp +std::pair< std::string, std::string > parse_url(const std::string & base_url) +``` + +## Parameters + + + +## Returns + +`std::pair< std::string, std::string >` + +## Source + +[`src/rest/http_client.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/rest/http_client.cpp) + +Line 65. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/phone-call-handler/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/phone-call-handler/index.mdx new file mode 100644 index 0000000000..c0a0212a2f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/phone-call-handler/index.mdx @@ -0,0 +1,118 @@ +--- +slug: "/reference/cpp/signalwire/rest/phone-call-handler" +title: "PhoneCallHandler" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "enum" + language: "cpp" + qualified_name: "signalwire::rest::PhoneCallHandler" + parent: "signalwire::rest" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/phone_call_handler.hpp" + visibility: "public" +--- +# `PhoneCallHandler` + +Enumeration of call\_handler values accepted by phone\_numbers.update. +Setting a phone number's call\_handler + the handler-specific companion field routes inbound calls and auto-materializes the matching Fabric resource on the server. The typed set\_\* helpers on PhoneNumbersNamespace wrap the low-level update call with the right combination — prefer those over constructing the wire body by hand. +Named PhoneCallHandler (not CallHandler) to avoid colliding with signalwire::relay::InboundCallHandler — the callback type used by the RELAY client for inbound-call events. + +Enum value\ +Wire value\ +Companion field\ +Auto-materializes + +RelayScript\ +relay\_script\ +call\_relay\_script\_url\ +swml\_webhook + +LamlWebhooks\ +laml\_webhooks\ +call\_request\_url\ +cxml\_webhook + +LamlApplication\ +laml\_application\ +call\_laml\_application\_id\ +cxml\_application + +AiAgent\ +ai\_agent\ +call\_ai\_agent\_id\ +ai\_agent + +CallFlow\ +call\_flow\ +call\_flow\_id\ +call\_flow + +RelayApplication\ +relay\_application\ +call\_relay\_application\ +relay\_application + +RelayTopic\ +relay\_topic\ +call\_relay\_topic\ +(RELAY routing) + +RelayContext\ +relay\_context\ +call\_relay\_context\ +(legacy) + +RelayConnector\ +relay\_connector\ +(connector config)\ +(internal) + +VideoRoom\ +video\_room\ +call\_video\_room\_id\ +(Video API) + +Dialogflow\ +dialogflow\ +call\_dialogflow\_agent\_id\ +(none) + +Note: LamlWebhooks (wire value laml\_webhooks) produces a cXML handler despite the plural name. For SWML, use RelayScript. + +## Signature + +```cpp +enum class PhoneCallHandler +``` + +## Variants + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/phone_call_handler.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/phone_call_handler.hpp) + +Line 39. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/addresses-namespace/addresses-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/addresses-namespace/addresses-namespace.mdx new file mode 100644 index 0000000000..77a99a50d1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/addresses-namespace/addresses-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/addresses-namespace/addresses-namespace" +title: "AddressesNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::AddressesNamespace::AddressesNamespace" + parent: "signalwire::rest::RestClient::AddressesNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `AddressesNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void AddressesNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1146. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/addresses-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/addresses-namespace/index.mdx new file mode 100644 index 0000000000..7f317e04be --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/addresses-namespace/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/addresses-namespace" +title: "AddressesNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::AddressesNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `AddressesNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::AddressesNamespace : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1145. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/addresses.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/addresses.mdx new file mode 100644 index 0000000000..a6e680c828 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/addresses.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/addresses" +title: "addresses" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::addresses" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `addresses` + +**Modifiers:** `inline` + +## Signature + +```cpp +AddressesNamespace & addresses() +``` + +## Returns + +`AddressesNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1438. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-hold.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-hold.mdx new file mode 100644 index 0000000000..c3a1671b28 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-hold.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-hold" +title: "ai_hold" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::ai_hold" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ai_hold` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json ai_hold( + const std::string & call_id, + const json & params = json::object() +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 394. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-message.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-message.mdx new file mode 100644 index 0000000000..77e5c4eaa6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-message.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-message" +title: "ai_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::ai_message" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ai_message` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json ai_message(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 391. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-stop.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-stop.mdx new file mode 100644 index 0000000000..14e248cf41 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-stop.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-stop" +title: "ai_stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::ai_stop" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ai_stop` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json ai_stop( + const std::string & call_id, + const json & params = json::object() +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 402. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-unhold.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-unhold.mdx new file mode 100644 index 0000000000..1b0c50005e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-unhold.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/ai-unhold" +title: "ai_unhold" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::ai_unhold" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ai_unhold` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json ai_unhold( + const std::string & call_id, + const json & params = json::object() +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 398. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/answer.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/answer.mdx new file mode 100644 index 0000000000..4eeb7052bb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/answer.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/answer" +title: "answer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::answer" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `answer` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json answer(const std::string & id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 446. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/calling-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/calling-namespace.mdx new file mode 100644 index 0000000000..f8a51e1c2f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/calling-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/calling-namespace" +title: "CallingNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::CallingNamespace" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CallingNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CallingNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 275. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/collect-start-input-timers.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/collect-start-input-timers.mdx new file mode 100644 index 0000000000..3040af3e22 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/collect-start-input-timers.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/collect-start-input-timers" +title: "collect_start_input_timers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::collect_start_input_timers" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `collect_start_input_timers` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json collect_start_input_timers( + const std::string & call_id, + const json & params +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 344. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/collect-stop.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/collect-stop.mdx new file mode 100644 index 0000000000..6906aa99ea --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/collect-stop.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/collect-stop" +title: "collect_stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::collect_stop" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `collect_stop` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json collect_stop(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 341. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/collect.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/collect.mdx new file mode 100644 index 0000000000..0f571f57f1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/collect.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/collect" +title: "collect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::collect" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `collect` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json collect(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 338. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/connect.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/connect.mdx new file mode 100644 index 0000000000..c49124cd8a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/connect.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/connect" +title: "connect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::connect" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `connect` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json connect(const std::string & id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 444. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/denoise-stop.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/denoise-stop.mdx new file mode 100644 index 0000000000..17a3f7452d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/denoise-stop.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/denoise-stop" +title: "denoise_stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::denoise_stop" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `denoise_stop` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json denoise_stop(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 378. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/denoise.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/denoise.mdx new file mode 100644 index 0000000000..51ec2a4979 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/denoise.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/denoise" +title: "denoise" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::denoise" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `denoise` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json denoise( + const std::string & call_id, + const json & params = json::object() +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 374. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/detect-stop.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/detect-stop.mdx new file mode 100644 index 0000000000..1091533717 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/detect-stop.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/detect-stop" +title: "detect_stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::detect_stop" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `detect_stop` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json detect_stop(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 353. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/detect.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/detect.mdx new file mode 100644 index 0000000000..ef1d6dab5c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/detect.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/detect" +title: "detect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::detect" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `detect` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json detect(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 350. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/dial.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/dial.mdx new file mode 100644 index 0000000000..afceb8443b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/dial.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/dial" +title: "dial" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::dial" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `dial` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json dial(const json & params) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 294. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/disconnect.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/disconnect.mdx new file mode 100644 index 0000000000..1e425e541f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/disconnect.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/disconnect" +title: "disconnect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::disconnect" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `disconnect` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json disconnect( + const std::string & call_id, + const json & params = json::object() +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 302. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/end-call.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/end-call.mdx new file mode 100644 index 0000000000..34d539d78d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/end-call.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/end-call" +title: "end_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::end_call" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `end_call` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json end_call(const std::string & id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 443. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/end.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/end.mdx new file mode 100644 index 0000000000..b7aa5d6841 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/end.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/end" +title: "end" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::end" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `end` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json end( + const std::string & call_id, + const json & params = json::object() +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 296. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/execute.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/execute.mdx new file mode 100644 index 0000000000..7b98b42759 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/execute.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/execute" +title: "execute" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::execute" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `execute` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json execute( + const std::string & command, + const json & params, + const std::optional< std::string > & call_id = std::nullopt +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 285. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/get-call.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/get-call.mdx new file mode 100644 index 0000000000..60c39d8649 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/get-call.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/get-call" +title: "get_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::get_call" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_call` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_call(const std::string & id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 441. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/hangup.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/hangup.mdx new file mode 100644 index 0000000000..596b43c970 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/hangup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/hangup" +title: "hangup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::hangup" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `hangup` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json hangup(const std::string & id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 447. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/hold.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/hold.mdx new file mode 100644 index 0000000000..363b35e26a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/hold.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/hold" +title: "hold" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::hold" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `hold` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json hold(const std::string & id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 448. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/index.mdx new file mode 100644 index 0000000000..7adcdb74f7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/index.mdx @@ -0,0 +1,134 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace" +title: "CallingNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CallingNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CallingNamespace +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 272. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/list-calls.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/list-calls.mdx new file mode 100644 index 0000000000..2d74aa65d9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/list-calls.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/list-calls" +title: "list_calls" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::list_calls" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_calls` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_calls(const std::map< std::string, std::string > & p = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 440. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/live-transcribe.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/live-transcribe.mdx new file mode 100644 index 0000000000..3aca6ddd7a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/live-transcribe.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/live-transcribe" +title: "live_transcribe" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::live_transcribe" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `live_transcribe` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json live_transcribe(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 408. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/live-translate.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/live-translate.mdx new file mode 100644 index 0000000000..dd43c8768c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/live-translate.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/live-translate" +title: "live_translate" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::live_translate" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `live_translate` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json live_translate(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 411. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-pause.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-pause.mdx new file mode 100644 index 0000000000..0d51d47883 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-pause.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/play-pause" +title: "play_pause" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::play_pause" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `play_pause` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json play_pause(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 310. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-resume.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-resume.mdx new file mode 100644 index 0000000000..aabc42efe5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-resume.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/play-resume" +title: "play_resume" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::play_resume" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `play_resume` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json play_resume(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 313. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-stop.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-stop.mdx new file mode 100644 index 0000000000..aecf2c07b3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-stop.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/play-stop" +title: "play_stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::play_stop" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `play_stop` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json play_stop(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 316. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-volume.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-volume.mdx new file mode 100644 index 0000000000..32b466fbdc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play-volume.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/play-volume" +title: "play_volume" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::play_volume" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `play_volume` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json play_volume(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 319. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play.mdx new file mode 100644 index 0000000000..5264889820 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/play.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/play" +title: "play" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::play" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `play` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json play(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 307. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/receive-fax-stop.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/receive-fax-stop.mdx new file mode 100644 index 0000000000..9fdd2bbca2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/receive-fax-stop.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/receive-fax-stop" +title: "receive_fax_stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::receive_fax_stop" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `receive_fax_stop` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json receive_fax_stop( + const std::string & call_id, + const json & params = json::object() +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 420. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record-pause.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record-pause.mdx new file mode 100644 index 0000000000..6c83877651 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record-pause.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/record-pause" +title: "record_pause" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::record_pause" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `record_pause` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json record_pause(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 327. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record-resume.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record-resume.mdx new file mode 100644 index 0000000000..321b64d9b6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record-resume.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/record-resume" +title: "record_resume" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::record_resume" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `record_resume` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json record_resume(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 330. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record-stop.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record-stop.mdx new file mode 100644 index 0000000000..fe375708bd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record-stop.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/record-stop" +title: "record_stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::record_stop" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `record_stop` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json record_stop(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 333. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record.mdx new file mode 100644 index 0000000000..40474d20c1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/record.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/record" +title: "record" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::record" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `record` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json record(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 324. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/refer.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/refer.mdx new file mode 100644 index 0000000000..f12a1c7c2a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/refer.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/refer" +title: "refer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::refer" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `refer` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json refer(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 426. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/send-digits.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/send-digits.mdx new file mode 100644 index 0000000000..614573017a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/send-digits.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/send-digits" +title: "send_digits" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::send_digits" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `send_digits` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json send_digits(const std::string & id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 445. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/send-fax-stop.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/send-fax-stop.mdx new file mode 100644 index 0000000000..96c1b11465 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/send-fax-stop.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/send-fax-stop" +title: "send_fax_stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::send_fax_stop" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `send_fax_stop` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json send_fax_stop( + const std::string & call_id, + const json & params = json::object() +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 416. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/stream-stop.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/stream-stop.mdx new file mode 100644 index 0000000000..6b6bf4d46a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/stream-stop.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/stream-stop" +title: "stream_stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::stream_stop" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `stream_stop` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json stream_stop(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 369. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/stream.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/stream.mdx new file mode 100644 index 0000000000..be644fda4d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/stream.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/stream" +title: "stream" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::stream" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `stream` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json stream(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 366. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/tap-stop.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/tap-stop.mdx new file mode 100644 index 0000000000..0d9c0b459e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/tap-stop.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/tap-stop" +title: "tap_stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::tap_stop" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `tap_stop` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json tap_stop(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 361. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/tap.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/tap.mdx new file mode 100644 index 0000000000..e547a3e18d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/tap.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/tap" +title: "tap" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::tap" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `tap` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json tap(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 358. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/transcribe-stop.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/transcribe-stop.mdx new file mode 100644 index 0000000000..e18bd9007e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/transcribe-stop.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/transcribe-stop" +title: "transcribe_stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::transcribe_stop" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `transcribe_stop` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json transcribe_stop(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 386. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/transcribe.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/transcribe.mdx new file mode 100644 index 0000000000..e356897d51 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/transcribe.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/transcribe" +title: "transcribe" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::transcribe" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `transcribe` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json transcribe(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 383. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/transfer.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/transfer.mdx new file mode 100644 index 0000000000..0c43cba804 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/transfer.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/transfer" +title: "transfer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::transfer" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `transfer` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json transfer(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 299. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/unhold.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/unhold.mdx new file mode 100644 index 0000000000..bcd59f3529 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/unhold.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/unhold" +title: "unhold" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::unhold" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `unhold` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json unhold(const std::string & id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 449. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/update-call.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/update-call.mdx new file mode 100644 index 0000000000..d6c2f3273d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/update-call.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/update-call" +title: "update_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::update_call" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update_call` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update_call(const std::string & id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 442. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/update.mdx new file mode 100644 index 0000000000..47021f5640 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::update" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const json & params) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 295. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/user-event.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/user-event.mdx new file mode 100644 index 0000000000..57bbe1bcb1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling-namespace/user-event.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling-namespace/user-event" +title: "user_event" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CallingNamespace::user_event" + parent: "signalwire::rest::RestClient::CallingNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `user_event` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json user_event(const std::string & call_id, const json & params) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 431. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling.mdx new file mode 100644 index 0000000000..fec63ac36b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/calling.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/calling" +title: "calling" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::calling" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `calling` + +**Modifiers:** `inline` + +## Signature + +```cpp +CallingNamespace & calling() +``` + +## Returns + +`CallingNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1433. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/chat-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/chat-namespace.mdx new file mode 100644 index 0000000000..4c826ec283 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/chat-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/chat-namespace/chat-namespace" +title: "ChatNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ChatNamespace::ChatNamespace" + parent: "signalwire::rest::RestClient::ChatNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ChatNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void ChatNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1423. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/index.mdx new file mode 100644 index 0000000000..0a3aac97d3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/chat-namespace" +title: "ChatNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ChatNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ChatNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::ChatNamespace +``` + +## Properties + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1421. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/list-messages.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/list-messages.mdx new file mode 100644 index 0000000000..e35dae74d7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/list-messages.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/chat-namespace/list-messages" +title: "list_messages" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ChatNamespace::list_messages" + parent: "signalwire::rest::RestClient::ChatNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_messages` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_messages(const std::map< std::string, std::string > & p = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1425. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/send-message.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/send-message.mdx new file mode 100644 index 0000000000..a98bbcfe5a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat-namespace/send-message.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/chat-namespace/send-message" +title: "send_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ChatNamespace::send_message" + parent: "signalwire::rest::RestClient::ChatNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `send_message` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json send_message(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1424. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat.mdx new file mode 100644 index 0000000000..3524b12d54 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/chat.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/chat" +title: "chat" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::chat" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `chat` + +**Modifiers:** `inline` + +## Signature + +```cpp +ChatNamespace & chat() +``` + +## Returns + +`ChatNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1452. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/compat-accounts.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/compat-accounts.mdx new file mode 100644 index 0000000000..67e2aa4717 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/compat-accounts.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-accounts/compat-accounts" +title: "CompatAccounts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatAccounts::CompatAccounts" + parent: "signalwire::rest::RestClient::CompatAccounts" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatAccounts` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatAccounts(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 930. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/create.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/create.mdx new file mode 100644 index 0000000000..c027f5e7fb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-accounts/create" +title: "create" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatAccounts::create" + parent: "signalwire::rest::RestClient::CompatAccounts" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 934. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/get.mdx new file mode 100644 index 0000000000..098f05db6b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-accounts/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatAccounts::get" + parent: "signalwire::rest::RestClient::CompatAccounts" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & sid) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 935. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/index.mdx new file mode 100644 index 0000000000..3d12009a0b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-accounts" +title: "CompatAccounts" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatAccounts" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatAccounts` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatAccounts +``` + +## Properties + + + + + +## Methods + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 927. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/list.mdx new file mode 100644 index 0000000000..fcd021e769 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-accounts/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatAccounts::list" + parent: "signalwire::rest::RestClient::CompatAccounts" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 931. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/update.mdx new file mode 100644 index 0000000000..1b0e3a7075 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-accounts/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-accounts/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatAccounts::update" + parent: "signalwire::rest::RestClient::CompatAccounts" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 939. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-applications/compat-applications.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-applications/compat-applications.mdx new file mode 100644 index 0000000000..e08f4a088e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-applications/compat-applications.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-applications/compat-applications" +title: "CompatApplications" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatApplications::CompatApplications" + parent: "signalwire::rest::RestClient::CompatApplications" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatApplications` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatApplications(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 945. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-applications/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-applications/index.mdx new file mode 100644 index 0000000000..c452c82d6f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-applications/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-applications" +title: "CompatApplications" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatApplications" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatApplications` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatApplications : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 944. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-applications/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-applications/update.mdx new file mode 100644 index 0000000000..fe07c4e542 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-applications/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-applications/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatApplications::update" + parent: "signalwire::rest::RestClient::CompatApplications" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 947. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/compat-calls.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/compat-calls.mdx new file mode 100644 index 0000000000..a53f2a4f19 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/compat-calls.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-calls/compat-calls" +title: "CompatCalls" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatCalls::CompatCalls" + parent: "signalwire::rest::RestClient::CompatCalls" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatCalls` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatCalls(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 803. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/index.mdx new file mode 100644 index 0000000000..6045af66d9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-calls" +title: "CompatCalls" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatCalls" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatCalls` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatCalls : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 802. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/start-recording.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/start-recording.mdx new file mode 100644 index 0000000000..1759cd98c4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/start-recording.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-calls/start-recording" +title: "start_recording" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatCalls::start_recording" + parent: "signalwire::rest::RestClient::CompatCalls" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `start_recording` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json start_recording(const std::string & call_sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 812. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/start-stream.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/start-stream.mdx new file mode 100644 index 0000000000..e4cc149ecb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/start-stream.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-calls/start-stream" +title: "start_stream" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatCalls::start_stream" + parent: "signalwire::rest::RestClient::CompatCalls" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `start_stream` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json start_stream(const std::string & call_sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 822. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/stop-stream.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/stop-stream.mdx new file mode 100644 index 0000000000..e3d77505fd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/stop-stream.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-calls/stop-stream" +title: "stop_stream" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatCalls::stop_stream" + parent: "signalwire::rest::RestClient::CompatCalls" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `stop_stream` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json stop_stream( + const std::string & call_sid, + const std::string & stream_sid, + const json & data +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 825. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/update-recording.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/update-recording.mdx new file mode 100644 index 0000000000..5ffbe95390 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/update-recording.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-calls/update-recording" +title: "update_recording" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatCalls::update_recording" + parent: "signalwire::rest::RestClient::CompatCalls" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update_recording` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update_recording( + const std::string & call_sid, + const std::string & recording_sid, + const json & data +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 815. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/update.mdx new file mode 100644 index 0000000000..38b689e375 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-calls/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-calls/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatCalls::update" + parent: "signalwire::rest::RestClient::CompatCalls" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 807. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/compat-conferences.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/compat-conferences.mdx new file mode 100644 index 0000000000..1c11d974a4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/compat-conferences.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/compat-conferences" +title: "CompatConferences" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::CompatConferences" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatConferences` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatConferences(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 963. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/delete-recording.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/delete-recording.mdx new file mode 100644 index 0000000000..78d7f0ebe3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/delete-recording.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/delete-recording" +title: "delete_recording" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::delete_recording" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `delete_recording` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json delete_recording( + const std::string & conference_sid, + const std::string & recording_sid +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1009. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/get-participant.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/get-participant.mdx new file mode 100644 index 0000000000..7980927bb7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/get-participant.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/get-participant" +title: "get_participant" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::get_participant" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_participant` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_participant( + const std::string & conference_sid, + const std::string & call_sid +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 981. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/get-recording.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/get-recording.mdx new file mode 100644 index 0000000000..dfea8cfbe0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/get-recording.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/get-recording" +title: "get_recording" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::get_recording" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_recording` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_recording( + const std::string & conference_sid, + const std::string & recording_sid +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1000. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/get.mdx new file mode 100644 index 0000000000..80db14d4f3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::get" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & sid) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 969. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/index.mdx new file mode 100644 index 0000000000..685482a167 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences" +title: "CompatConferences" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatConferences` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatConferences +``` + +## Properties + + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 960. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/list-participants.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/list-participants.mdx new file mode 100644 index 0000000000..f6f1ddfba2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/list-participants.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/list-participants" +title: "list_participants" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::list_participants" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_participants` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_participants( + const std::string & conference_sid, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 977. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/list-recordings.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/list-recordings.mdx new file mode 100644 index 0000000000..31b647975b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/list-recordings.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/list-recordings" +title: "list_recordings" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::list_recordings" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_recordings` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_recordings( + const std::string & conference_sid, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 996. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/list.mdx new file mode 100644 index 0000000000..1f73760185 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::list" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 966. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/remove-participant.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/remove-participant.mdx new file mode 100644 index 0000000000..6f49ec0298 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/remove-participant.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/remove-participant" +title: "remove_participant" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::remove_participant" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `remove_participant` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json remove_participant( + const std::string & conference_sid, + const std::string & call_sid +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 990. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/start-stream.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/start-stream.mdx new file mode 100644 index 0000000000..7c4f28584b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/start-stream.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/start-stream" +title: "start_stream" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::start_stream" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `start_stream` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json start_stream(const std::string & conference_sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1015. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/stop-stream.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/stop-stream.mdx new file mode 100644 index 0000000000..1dec9db4ab --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/stop-stream.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/stop-stream" +title: "stop_stream" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::stop_stream" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `stop_stream` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json stop_stream( + const std::string & conference_sid, + const std::string & stream_sid, + const json & data +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1018. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/update-participant.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/update-participant.mdx new file mode 100644 index 0000000000..c655b366ad --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/update-participant.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/update-participant" +title: "update_participant" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::update_participant" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update_participant` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update_participant( + const std::string & conference_sid, + const std::string & call_sid, + const json & data +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 985. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/update-recording.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/update-recording.mdx new file mode 100644 index 0000000000..e6f1020b34 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/update-recording.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/update-recording" +title: "update_recording" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::update_recording" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update_recording` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update_recording( + const std::string & conference_sid, + const std::string & recording_sid, + const json & data +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1004. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/update.mdx new file mode 100644 index 0000000000..954b89c99c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-conferences/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-conferences/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatConferences::update" + parent: "signalwire::rest::RestClient::CompatConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 972. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/compat-faxes.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/compat-faxes.mdx new file mode 100644 index 0000000000..b62d6de6d1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/compat-faxes.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-faxes/compat-faxes" +title: "CompatFaxes" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatFaxes::CompatFaxes" + parent: "signalwire::rest::RestClient::CompatFaxes" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatFaxes` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatFaxes(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 855. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/delete-media.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/delete-media.mdx new file mode 100644 index 0000000000..b7a691f7b2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/delete-media.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-faxes/delete-media" +title: "delete_media" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatFaxes::delete_media" + parent: "signalwire::rest::RestClient::CompatFaxes" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `delete_media` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json delete_media( + const std::string & fax_sid, + const std::string & media_sid +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 870. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/get-media.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/get-media.mdx new file mode 100644 index 0000000000..9b691adecd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/get-media.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-faxes/get-media" +title: "get_media" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatFaxes::get_media" + parent: "signalwire::rest::RestClient::CompatFaxes" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_media` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_media(const std::string & fax_sid, const std::string & media_sid) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 866. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/index.mdx new file mode 100644 index 0000000000..565e46fdc2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-faxes" +title: "CompatFaxes" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatFaxes" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatFaxes` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatFaxes : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 854. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/list-media.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/list-media.mdx new file mode 100644 index 0000000000..23509cfc7e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/list-media.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-faxes/list-media" +title: "list_media" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatFaxes::list_media" + parent: "signalwire::rest::RestClient::CompatFaxes" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_media` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_media( + const std::string & fax_sid, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 862. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/update.mdx new file mode 100644 index 0000000000..b63dda7ff0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-faxes/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-faxes/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatFaxes::update" + parent: "signalwire::rest::RestClient::CompatFaxes" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 858. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-laml-bins/compat-laml-bins.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-laml-bins/compat-laml-bins.mdx new file mode 100644 index 0000000000..fb42573afe --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-laml-bins/compat-laml-bins.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-laml-bins/compat-laml-bins" +title: "CompatLamlBins" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatLamlBins::CompatLamlBins" + parent: "signalwire::rest::RestClient::CompatLamlBins" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatLamlBins` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatLamlBins(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 953. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-laml-bins/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-laml-bins/index.mdx new file mode 100644 index 0000000000..5f60965411 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-laml-bins/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-laml-bins" +title: "CompatLamlBins" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatLamlBins" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatLamlBins` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatLamlBins : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 952. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-laml-bins/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-laml-bins/update.mdx new file mode 100644 index 0000000000..b28d97fc3b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-laml-bins/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-laml-bins/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatLamlBins::update" + parent: "signalwire::rest::RestClient::CompatLamlBins" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 955. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/compat-messages.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/compat-messages.mdx new file mode 100644 index 0000000000..750aa9dc25 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/compat-messages.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-messages/compat-messages" +title: "CompatMessages" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatMessages::CompatMessages" + parent: "signalwire::rest::RestClient::CompatMessages" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatMessages` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatMessages(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 833. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/delete-media.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/delete-media.mdx new file mode 100644 index 0000000000..b9a7ca30d3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/delete-media.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-messages/delete-media" +title: "delete_media" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatMessages::delete_media" + parent: "signalwire::rest::RestClient::CompatMessages" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `delete_media` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json delete_media( + const std::string & message_sid, + const std::string & media_sid +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 848. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/get-media.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/get-media.mdx new file mode 100644 index 0000000000..e6ae7193fd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/get-media.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-messages/get-media" +title: "get_media" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatMessages::get_media" + parent: "signalwire::rest::RestClient::CompatMessages" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_media` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_media( + const std::string & message_sid, + const std::string & media_sid +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 844. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/index.mdx new file mode 100644 index 0000000000..97d3d62ef7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-messages" +title: "CompatMessages" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatMessages" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatMessages` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatMessages : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 832. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/list-media.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/list-media.mdx new file mode 100644 index 0000000000..a91a0cea9c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/list-media.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-messages/list-media" +title: "list_media" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatMessages::list_media" + parent: "signalwire::rest::RestClient::CompatMessages" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_media` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_media( + const std::string & message_sid, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 840. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/update.mdx new file mode 100644 index 0000000000..65db39d0da --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-messages/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-messages/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatMessages::update" + parent: "signalwire::rest::RestClient::CompatMessages" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 836. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/compat-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/compat-namespace.mdx new file mode 100644 index 0000000000..035501199a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/compat-namespace.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-namespace/compat-namespace" +title: "CompatNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatNamespace::CompatNamespace" + parent: "signalwire::rest::RestClient::CompatNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatNamespace(const HttpClient & c, const std::string & account_sid) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1111. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/create-call.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/create-call.mdx new file mode 100644 index 0000000000..58d95d9dc2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/create-call.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-namespace/create-call" +title: "create_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatNamespace::create_call" + parent: "signalwire::rest::RestClient::CompatNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create_call` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create_call(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1131. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/index.mdx new file mode 100644 index 0000000000..b302e5d665 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-namespace" +title: "CompatNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatNamespace +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1093. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/list-calls.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/list-calls.mdx new file mode 100644 index 0000000000..82ec4117d5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/list-calls.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-namespace/list-calls" +title: "list_calls" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatNamespace::list_calls" + parent: "signalwire::rest::RestClient::CompatNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_calls` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_calls(const std::map< std::string, std::string > & p = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1133. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/list-messages.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/list-messages.mdx new file mode 100644 index 0000000000..c48fcf3dbd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/list-messages.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-namespace/list-messages" +title: "list_messages" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatNamespace::list_messages" + parent: "signalwire::rest::RestClient::CompatNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_messages` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_messages(const std::map< std::string, std::string > & p = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1134. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/send-message.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/send-message.mdx new file mode 100644 index 0000000000..2a1246712a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-namespace/send-message.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-namespace/send-message" +title: "send_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatNamespace::send_message" + parent: "signalwire::rest::RestClient::CompatNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `send_message` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json send_message(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1132. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/compat-phone-numbers.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/compat-phone-numbers.mdx new file mode 100644 index 0000000000..b21ab72f53 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/compat-phone-numbers.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/compat-phone-numbers" +title: "CompatPhoneNumbers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatPhoneNumbers::CompatPhoneNumbers" + parent: "signalwire::rest::RestClient::CompatPhoneNumbers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatPhoneNumbers` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatPhoneNumbers(const HttpClient & c, const std::string & account_base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 882. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/get.mdx new file mode 100644 index 0000000000..d8b65374e9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatPhoneNumbers::get" + parent: "signalwire::rest::RestClient::CompatPhoneNumbers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & sid) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 891. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/import-number.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/import-number.mdx new file mode 100644 index 0000000000..52ea70a4b2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/import-number.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/import-number" +title: "import_number" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatPhoneNumbers::import_number" + parent: "signalwire::rest::RestClient::CompatPhoneNumbers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `import_number` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json import_number(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 903. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/index.mdx new file mode 100644 index 0000000000..f2c9cb435e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-phone-numbers" +title: "CompatPhoneNumbers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatPhoneNumbers" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatPhoneNumbers` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatPhoneNumbers +``` + +## Properties + + + + + + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 876. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/list-available-countries.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/list-available-countries.mdx new file mode 100644 index 0000000000..a4b1780298 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/list-available-countries.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/list-available-countries" +title: "list_available_countries" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatPhoneNumbers::list_available_countries" + parent: "signalwire::rest::RestClient::CompatPhoneNumbers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_available_countries` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_available_countries( + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 906. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/list.mdx new file mode 100644 index 0000000000..f47dfa0373 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatPhoneNumbers::list" + parent: "signalwire::rest::RestClient::CompatPhoneNumbers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 888. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/purchase.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/purchase.mdx new file mode 100644 index 0000000000..13f9764b1d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/purchase.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/purchase" +title: "purchase" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatPhoneNumbers::purchase" + parent: "signalwire::rest::RestClient::CompatPhoneNumbers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `purchase` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json purchase(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 900. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/search-local.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/search-local.mdx new file mode 100644 index 0000000000..df383b29af --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/search-local.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/search-local" +title: "search_local" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatPhoneNumbers::search_local" + parent: "signalwire::rest::RestClient::CompatPhoneNumbers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `search_local` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json search_local( + const std::string & country, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 909. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/search-toll-free.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/search-toll-free.mdx new file mode 100644 index 0000000000..327c9fb39f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/search-toll-free.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/search-toll-free" +title: "search_toll_free" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatPhoneNumbers::search_toll_free" + parent: "signalwire::rest::RestClient::CompatPhoneNumbers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `search_toll_free` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json search_toll_free( + const std::string & country, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 913. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/update.mdx new file mode 100644 index 0000000000..2feafe2595 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-phone-numbers/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatPhoneNumbers::update" + parent: "signalwire::rest::RestClient::CompatPhoneNumbers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 894. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/compat-queues.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/compat-queues.mdx new file mode 100644 index 0000000000..417d6924b6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/compat-queues.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-queues/compat-queues" +title: "CompatQueues" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatQueues::CompatQueues" + parent: "signalwire::rest::RestClient::CompatQueues" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatQueues` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatQueues(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1026. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/dequeue-member.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/dequeue-member.mdx new file mode 100644 index 0000000000..efbc96f425 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/dequeue-member.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-queues/dequeue-member" +title: "dequeue_member" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatQueues::dequeue_member" + parent: "signalwire::rest::RestClient::CompatQueues" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `dequeue_member` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json dequeue_member( + const std::string & queue_sid, + const std::string & call_sid, + const json & data +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1039. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/get-member.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/get-member.mdx new file mode 100644 index 0000000000..7cc090d86b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/get-member.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-queues/get-member" +title: "get_member" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatQueues::get_member" + parent: "signalwire::rest::RestClient::CompatQueues" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_member` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_member( + const std::string & queue_sid, + const std::string & call_sid +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1035. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/index.mdx new file mode 100644 index 0000000000..1ea20275ee --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-queues" +title: "CompatQueues" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatQueues" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatQueues` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatQueues : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1025. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/list-members.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/list-members.mdx new file mode 100644 index 0000000000..ad36beb4bd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/list-members.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-queues/list-members" +title: "list_members" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatQueues::list_members" + parent: "signalwire::rest::RestClient::CompatQueues" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_members` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_members( + const std::string & queue_sid, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1031. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/update.mdx new file mode 100644 index 0000000000..b3f3b3719d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-queues/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-queues/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatQueues::update" + parent: "signalwire::rest::RestClient::CompatQueues" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & sid, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1028. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/compat-recordings.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/compat-recordings.mdx new file mode 100644 index 0000000000..f8662b1938 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/compat-recordings.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-recordings/compat-recordings" +title: "CompatRecordings" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatRecordings::CompatRecordings" + parent: "signalwire::rest::RestClient::CompatRecordings" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatRecordings` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatRecordings(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1049. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/get.mdx new file mode 100644 index 0000000000..ba5586e922 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-recordings/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatRecordings::get" + parent: "signalwire::rest::RestClient::CompatRecordings" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & sid) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1054. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/index.mdx new file mode 100644 index 0000000000..35583d92b6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-recordings" +title: "CompatRecordings" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatRecordings" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatRecordings` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatRecordings +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1046. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/list.mdx new file mode 100644 index 0000000000..0360259abf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-recordings/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-recordings/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatRecordings::list" + parent: "signalwire::rest::RestClient::CompatRecordings" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1051. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/compat-tokens.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/compat-tokens.mdx new file mode 100644 index 0000000000..d0d80df720 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/compat-tokens.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-tokens/compat-tokens" +title: "CompatTokens" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatTokens::CompatTokens" + parent: "signalwire::rest::RestClient::CompatTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatTokens` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatTokens(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1081. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/create.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/create.mdx new file mode 100644 index 0000000000..24cdb1fcf0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-tokens/create" +title: "create" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatTokens::create" + parent: "signalwire::rest::RestClient::CompatTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1083. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/index.mdx new file mode 100644 index 0000000000..de4d2d8300 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-tokens" +title: "CompatTokens" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatTokens" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatTokens` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatTokens +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1078. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/update.mdx new file mode 100644 index 0000000000..b24081525d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-tokens/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-tokens/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatTokens::update" + parent: "signalwire::rest::RestClient::CompatTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & token_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1085. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/compat-transcriptions.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/compat-transcriptions.mdx new file mode 100644 index 0000000000..029ae1bb06 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/compat-transcriptions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-transcriptions/compat-transcriptions" +title: "CompatTranscriptions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatTranscriptions::CompatTranscriptions" + parent: "signalwire::rest::RestClient::CompatTranscriptions" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatTranscriptions` + +**Modifiers:** `inline` + +## Signature + +```cpp +void CompatTranscriptions(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1065. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/get.mdx new file mode 100644 index 0000000000..c012063b6d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-transcriptions/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatTranscriptions::get" + parent: "signalwire::rest::RestClient::CompatTranscriptions" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & sid) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1070. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/index.mdx new file mode 100644 index 0000000000..2affbe8e73 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-transcriptions" +title: "CompatTranscriptions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatTranscriptions" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CompatTranscriptions` + +## Signature + +```cpp +struct signalwire::rest::RestClient::CompatTranscriptions +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1062. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/list.mdx new file mode 100644 index 0000000000..4781ab53bf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat-transcriptions/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat-transcriptions/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::CompatTranscriptions::list" + parent: "signalwire::rest::RestClient::CompatTranscriptions" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1067. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat.mdx new file mode 100644 index 0000000000..b3638d5aa0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/compat.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/compat" +title: "compat" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::compat" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `compat` + +**Modifiers:** `inline` + +## Signature + +```cpp +CompatNamespace & compat() +``` + +## Returns + +`CompatNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1437. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/datasphere-documents.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/datasphere-documents.mdx new file mode 100644 index 0000000000..e4c7dc0452 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/datasphere-documents.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/datasphere-documents/datasphere-documents" +title: "DatasphereDocuments" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::DatasphereDocuments::DatasphereDocuments" + parent: "signalwire::rest::RestClient::DatasphereDocuments" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `DatasphereDocuments` + +**Modifiers:** `inline` + +## Signature + +```cpp +void DatasphereDocuments(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 612. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/delete-chunk.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/delete-chunk.mdx new file mode 100644 index 0000000000..9d24f1f9de --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/delete-chunk.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/datasphere-documents/delete-chunk" +title: "delete_chunk" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::DatasphereDocuments::delete_chunk" + parent: "signalwire::rest::RestClient::DatasphereDocuments" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `delete_chunk` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json delete_chunk( + const std::string & document_id, + const std::string & chunk_id +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 625. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/get-chunk.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/get-chunk.mdx new file mode 100644 index 0000000000..99f2cd11c2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/get-chunk.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/datasphere-documents/get-chunk" +title: "get_chunk" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::DatasphereDocuments::get_chunk" + parent: "signalwire::rest::RestClient::DatasphereDocuments" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_chunk` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_chunk( + const std::string & document_id, + const std::string & chunk_id +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 621. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/index.mdx new file mode 100644 index 0000000000..1046cae980 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/datasphere-documents" +title: "DatasphereDocuments" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::DatasphereDocuments" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `DatasphereDocuments` + +## Signature + +```cpp +struct signalwire::rest::RestClient::DatasphereDocuments : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 611. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/list-chunks.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/list-chunks.mdx new file mode 100644 index 0000000000..569f66b313 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/list-chunks.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/datasphere-documents/list-chunks" +title: "list_chunks" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::DatasphereDocuments::list_chunks" + parent: "signalwire::rest::RestClient::DatasphereDocuments" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_chunks` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_chunks( + const std::string & document_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 617. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/search.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/search.mdx new file mode 100644 index 0000000000..d90abf2c18 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-documents/search.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/datasphere-documents/search" +title: "search" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::DatasphereDocuments::search" + parent: "signalwire::rest::RestClient::DatasphereDocuments" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `search` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json search(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 614. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-namespace/datasphere-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-namespace/datasphere-namespace.mdx new file mode 100644 index 0000000000..274405060a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-namespace/datasphere-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/datasphere-namespace/datasphere-namespace" +title: "DatasphereNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::DatasphereNamespace::DatasphereNamespace" + parent: "signalwire::rest::RestClient::DatasphereNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `DatasphereNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void DatasphereNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 635. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-namespace/index.mdx new file mode 100644 index 0000000000..51cd081a00 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-namespace/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/datasphere-namespace" +title: "DatasphereNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::DatasphereNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `DatasphereNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::DatasphereNamespace +``` + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 631. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-namespace/search.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-namespace/search.mdx new file mode 100644 index 0000000000..4cf93a45fa --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere-namespace/search.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/datasphere-namespace/search" +title: "search" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::DatasphereNamespace::search" + parent: "signalwire::rest::RestClient::DatasphereNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `search` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json search(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 641. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere.mdx new file mode 100644 index 0000000000..728e0924a8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/datasphere.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/datasphere" +title: "datasphere" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::datasphere" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `datasphere` + +**Modifiers:** `inline` + +## Signature + +```cpp +DatasphereNamespace & datasphere() +``` + +## Returns + +`DatasphereNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1435. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/fabric-addresses.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/fabric-addresses.mdx new file mode 100644 index 0000000000..e992dd97e4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/fabric-addresses.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-addresses/fabric-addresses" +title: "FabricAddresses" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricAddresses::FabricAddresses" + parent: "signalwire::rest::RestClient::FabricAddresses" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricAddresses` + +**Modifiers:** `inline` + +## Signature + +```cpp +void FabricAddresses(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 151. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/get.mdx new file mode 100644 index 0000000000..3538fc1809 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-addresses/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricAddresses::get" + parent: "signalwire::rest::RestClient::FabricAddresses" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & address_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 155. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/index.mdx new file mode 100644 index 0000000000..144654ede8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-addresses" +title: "FabricAddresses" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricAddresses" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricAddresses` + +## Signature + +```cpp +struct signalwire::rest::RestClient::FabricAddresses +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 148. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/list.mdx new file mode 100644 index 0000000000..21a385dae6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-addresses/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-addresses/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricAddresses::list" + parent: "signalwire::rest::RestClient::FabricAddresses" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 152. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/deploy-version.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/deploy-version.mdx new file mode 100644 index 0000000000..8c98f71b5b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/deploy-version.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-call-flows/deploy-version" +title: "deploy_version" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricCallFlows::deploy_version" + parent: "signalwire::rest::RestClient::FabricCallFlows" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `deploy_version` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json deploy_version(const std::string & flow_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 92. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/fabric-call-flows.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/fabric-call-flows.mdx new file mode 100644 index 0000000000..36b004c2fd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/fabric-call-flows.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-call-flows/fabric-call-flows" +title: "FabricCallFlows" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricCallFlows::FabricCallFlows" + parent: "signalwire::rest::RestClient::FabricCallFlows" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricCallFlows` + +**Modifiers:** `inline` + +## Signature + +```cpp +void FabricCallFlows(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 76. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/index.mdx new file mode 100644 index 0000000000..1a923cd246 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-call-flows" +title: "FabricCallFlows" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricCallFlows" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricCallFlows` + +## Signature + +```cpp +struct signalwire::rest::RestClient::FabricCallFlows : signalwire::rest::RestClient::FabricResourcePUT +``` + +## Inheritance + +**Extends:** [signalwire::rest::RestClient::FabricResourcePUT](/reference/cpp/signalwire/rest/rest-client/fabric-resource-put) + +## Methods + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 75. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/list-addresses.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/list-addresses.mdx new file mode 100644 index 0000000000..e989da00ac --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/list-addresses.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-call-flows/list-addresses" +title: "list_addresses" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricCallFlows::list_addresses" + parent: "signalwire::rest::RestClient::FabricCallFlows" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_addresses` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_addresses( + const std::string & flow_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 84. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/list-versions.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/list-versions.mdx new file mode 100644 index 0000000000..84dd41cb87 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/list-versions.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-call-flows/list-versions" +title: "list_versions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricCallFlows::list_versions" + parent: "signalwire::rest::RestClient::FabricCallFlows" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_versions` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_versions( + const std::string & flow_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 88. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/singular-base.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/singular-base.mdx new file mode 100644 index 0000000000..5cbba19d41 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-call-flows/singular-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-call-flows/singular-base" +title: "singular_base" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricCallFlows::singular_base" + parent: "signalwire::rest::RestClient::FabricCallFlows" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `singular_base` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +std::string singular_base() const +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 81. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/fabric-conference-rooms.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/fabric-conference-rooms.mdx new file mode 100644 index 0000000000..a879e2aced --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/fabric-conference-rooms.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/fabric-conference-rooms" +title: "FabricConferenceRooms" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricConferenceRooms::FabricConferenceRooms" + parent: "signalwire::rest::RestClient::FabricConferenceRooms" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricConferenceRooms` + +**Modifiers:** `inline` + +## Signature + +```cpp +void FabricConferenceRooms(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 98. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/index.mdx new file mode 100644 index 0000000000..98d3ef6aba --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms" +title: "FabricConferenceRooms" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricConferenceRooms" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricConferenceRooms` + +## Signature + +```cpp +struct signalwire::rest::RestClient::FabricConferenceRooms : signalwire::rest::RestClient::FabricResourcePUT +``` + +## Inheritance + +**Extends:** [signalwire::rest::RestClient::FabricResourcePUT](/reference/cpp/signalwire/rest/rest-client/fabric-resource-put) + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 97. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/list-addresses.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/list-addresses.mdx new file mode 100644 index 0000000000..382cbe3c75 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/list-addresses.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/list-addresses" +title: "list_addresses" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricConferenceRooms::list_addresses" + parent: "signalwire::rest::RestClient::FabricConferenceRooms" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_addresses` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_addresses( + const std::string & room_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 105. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/singular-base.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/singular-base.mdx new file mode 100644 index 0000000000..3ad711a8f5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/singular-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-conference-rooms/singular-base" +title: "singular_base" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricConferenceRooms::singular_base" + parent: "signalwire::rest::RestClient::FabricConferenceRooms" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `singular_base` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +std::string singular_base() const +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 102. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications/create.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications/create.mdx new file mode 100644 index 0000000000..15bf3e026b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications/create" +title: "create" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricCxmlApplications::create" + parent: "signalwire::rest::RestClient::FabricCxmlApplications" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create(const json &) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 142. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications/fabric-cxml-applications.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications/fabric-cxml-applications.mdx new file mode 100644 index 0000000000..d9b9a35d02 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications/fabric-cxml-applications.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications/fabric-cxml-applications" +title: "FabricCxmlApplications" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricCxmlApplications::FabricCxmlApplications" + parent: "signalwire::rest::RestClient::FabricCxmlApplications" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricCxmlApplications` + +**Modifiers:** `inline` + +## Signature + +```cpp +void FabricCxmlApplications(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 139. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications/index.mdx new file mode 100644 index 0000000000..bab89ae31f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-cxml-applications" +title: "FabricCxmlApplications" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricCxmlApplications" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricCxmlApplications` + +## Signature + +```cpp +struct signalwire::rest::RestClient::FabricCxmlApplications : signalwire::rest::RestClient::FabricResourcePUT +``` + +## Inheritance + +**Extends:** [signalwire::rest::RestClient::FabricResourcePUT](/reference/cpp/signalwire/rest/rest-client/fabric-resource-put) + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 138. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/assign-domain-application.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/assign-domain-application.mdx new file mode 100644 index 0000000000..cb6d9c1dc6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/assign-domain-application.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/assign-domain-application" +title: "assign_domain_application" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricGenericResources::assign_domain_application" + parent: "signalwire::rest::RestClient::FabricGenericResources" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `assign_domain_application` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json assign_domain_application( + const std::string & resource_id, + const json & data +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 177. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/assign-phone-route.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/assign-phone-route.mdx new file mode 100644 index 0000000000..1ee6ca8fa4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/assign-phone-route.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/assign-phone-route" +title: "assign_phone_route" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricGenericResources::assign_phone_route" + parent: "signalwire::rest::RestClient::FabricGenericResources" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `assign_phone_route` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json assign_phone_route( + const std::string & resource_id, + const json & data +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 182. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/fabric-generic-resources.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/fabric-generic-resources.mdx new file mode 100644 index 0000000000..2c427ae8b8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/fabric-generic-resources.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/fabric-generic-resources" +title: "FabricGenericResources" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricGenericResources::FabricGenericResources" + parent: "signalwire::rest::RestClient::FabricGenericResources" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricGenericResources` + +**Modifiers:** `inline` + +## Signature + +```cpp +void FabricGenericResources(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 163. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/get.mdx new file mode 100644 index 0000000000..409953d223 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricGenericResources::get" + parent: "signalwire::rest::RestClient::FabricGenericResources" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & resource_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 167. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/index.mdx new file mode 100644 index 0000000000..d8c00024f3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-generic-resources" +title: "FabricGenericResources" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricGenericResources" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricGenericResources` + +## Signature + +```cpp +struct signalwire::rest::RestClient::FabricGenericResources +``` + +## Properties + + + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 160. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/list-addresses.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/list-addresses.mdx new file mode 100644 index 0000000000..ee81a008b3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/list-addresses.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/list-addresses" +title: "list_addresses" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricGenericResources::list_addresses" + parent: "signalwire::rest::RestClient::FabricGenericResources" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_addresses` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_addresses( + const std::string & resource_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 173. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/list.mdx new file mode 100644 index 0000000000..28c4c59cea --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-generic-resources/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricGenericResources::list" + parent: "signalwire::rest::RestClient::FabricGenericResources" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 164. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-namespace/fabric-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-namespace/fabric-namespace.mdx new file mode 100644 index 0000000000..97e3f2b94f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-namespace/fabric-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-namespace/fabric-namespace" +title: "FabricNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricNamespace::FabricNamespace" + parent: "signalwire::rest::RestClient::FabricNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void FabricNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 247. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-namespace/index.mdx new file mode 100644 index 0000000000..3e30ed39c7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-namespace/index.mdx @@ -0,0 +1,80 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-namespace" +title: "FabricNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::FabricNamespace +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 209. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource-put/fabric-resource-put.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource-put/fabric-resource-put.mdx new file mode 100644 index 0000000000..983262cc62 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource-put/fabric-resource-put.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-resource-put/fabric-resource-put" +title: "FabricResourcePUT" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricResourcePUT::FabricResourcePUT" + parent: "signalwire::rest::RestClient::FabricResourcePUT" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricResourcePUT` + +**Modifiers:** `inline` + +## Signature + +```cpp +void FabricResourcePUT(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 67. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource-put/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource-put/index.mdx new file mode 100644 index 0000000000..b9f5799c1e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource-put/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-resource-put" +title: "FabricResourcePUT" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricResourcePUT" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricResourcePUT` + +## Signature + +```cpp +struct signalwire::rest::RestClient::FabricResourcePUT : signalwire::rest::RestClient::FabricResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::RestClient::FabricResource](/reference/cpp/signalwire/rest/rest-client/fabric-resource) + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 66. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource-put/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource-put/update.mdx new file mode 100644 index 0000000000..d329e33bfa --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource-put/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-resource-put/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricResourcePUT::update" + parent: "signalwire::rest::RestClient::FabricResourcePUT" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & resource_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 70. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource/fabric-resource.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource/fabric-resource.mdx new file mode 100644 index 0000000000..d258bcfe6d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource/fabric-resource.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-resource/fabric-resource" +title: "FabricResource" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricResource::FabricResource" + parent: "signalwire::rest::RestClient::FabricResource" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricResource` + +**Modifiers:** `inline` + +## Signature + +```cpp +void FabricResource(const HttpClient & c, const std::string & base) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 57. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource/index.mdx new file mode 100644 index 0000000000..18d8ef5e19 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-resource" +title: "FabricResource" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricResource" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricResource` + +## Signature + +```cpp +struct signalwire::rest::RestClient::FabricResource : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 56. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource/list-addresses.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource/list-addresses.mdx new file mode 100644 index 0000000000..c3efbe40c4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-resource/list-addresses.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-resource/list-addresses" +title: "list_addresses" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricResource::list_addresses" + parent: "signalwire::rest::RestClient::FabricResource" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_addresses` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_addresses( + const std::string & resource_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 60. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/create-sip-endpoint.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/create-sip-endpoint.mdx new file mode 100644 index 0000000000..0d6033a1d1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/create-sip-endpoint.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-subscribers/create-sip-endpoint" +title: "create_sip_endpoint" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricSubscribers::create_sip_endpoint" + parent: "signalwire::rest::RestClient::FabricSubscribers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create_sip_endpoint` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create_sip_endpoint( + const std::string & subscriber_id, + const json & data +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 119. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/delete-sip-endpoint.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/delete-sip-endpoint.mdx new file mode 100644 index 0000000000..c703b56ae3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/delete-sip-endpoint.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-subscribers/delete-sip-endpoint" +title: "delete_sip_endpoint" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricSubscribers::delete_sip_endpoint" + parent: "signalwire::rest::RestClient::FabricSubscribers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `delete_sip_endpoint` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json delete_sip_endpoint( + const std::string & subscriber_id, + const std::string & endpoint_id +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 132. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/fabric-subscribers.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/fabric-subscribers.mdx new file mode 100644 index 0000000000..c5bdde05ef --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/fabric-subscribers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-subscribers/fabric-subscribers" +title: "FabricSubscribers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricSubscribers::FabricSubscribers" + parent: "signalwire::rest::RestClient::FabricSubscribers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricSubscribers` + +**Modifiers:** `inline` + +## Signature + +```cpp +void FabricSubscribers(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 112. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/get-sip-endpoint.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/get-sip-endpoint.mdx new file mode 100644 index 0000000000..fecf1b5760 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/get-sip-endpoint.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-subscribers/get-sip-endpoint" +title: "get_sip_endpoint" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricSubscribers::get_sip_endpoint" + parent: "signalwire::rest::RestClient::FabricSubscribers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_sip_endpoint` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_sip_endpoint( + const std::string & subscriber_id, + const std::string & endpoint_id +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 122. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/index.mdx new file mode 100644 index 0000000000..a2df74427d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-subscribers" +title: "FabricSubscribers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricSubscribers" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricSubscribers` + +## Signature + +```cpp +struct signalwire::rest::RestClient::FabricSubscribers : signalwire::rest::RestClient::FabricResourcePUT +``` + +## Inheritance + +**Extends:** [signalwire::rest::RestClient::FabricResourcePUT](/reference/cpp/signalwire/rest/rest-client/fabric-resource-put) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 111. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/list-sip-endpoints.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/list-sip-endpoints.mdx new file mode 100644 index 0000000000..0eb04bb366 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/list-sip-endpoints.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-subscribers/list-sip-endpoints" +title: "list_sip_endpoints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricSubscribers::list_sip_endpoints" + parent: "signalwire::rest::RestClient::FabricSubscribers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_sip_endpoints` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_sip_endpoints( + const std::string & subscriber_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 115. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/update-sip-endpoint.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/update-sip-endpoint.mdx new file mode 100644 index 0000000000..eaff49ddd5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-subscribers/update-sip-endpoint.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-subscribers/update-sip-endpoint" +title: "update_sip_endpoint" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricSubscribers::update_sip_endpoint" + parent: "signalwire::rest::RestClient::FabricSubscribers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update_sip_endpoint` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update_sip_endpoint( + const std::string & subscriber_id, + const std::string & endpoint_id, + const json & data +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 127. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-embed-token.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-embed-token.mdx new file mode 100644 index 0000000000..7057f2e2c9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-embed-token.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-embed-token" +title: "create_embed_token" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricTokens::create_embed_token" + parent: "signalwire::rest::RestClient::FabricTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create_embed_token` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create_embed_token(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 204. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-guest-token.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-guest-token.mdx new file mode 100644 index 0000000000..5e35315cad --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-guest-token.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-guest-token" +title: "create_guest_token" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricTokens::create_guest_token" + parent: "signalwire::rest::RestClient::FabricTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create_guest_token` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create_guest_token(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 201. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-invite-token.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-invite-token.mdx new file mode 100644 index 0000000000..05696c21ff --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-invite-token.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-invite-token" +title: "create_invite_token" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricTokens::create_invite_token" + parent: "signalwire::rest::RestClient::FabricTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create_invite_token` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create_invite_token(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 198. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-subscriber-token.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-subscriber-token.mdx new file mode 100644 index 0000000000..2ea03a4bdf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-subscriber-token.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-tokens/create-subscriber-token" +title: "create_subscriber_token" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricTokens::create_subscriber_token" + parent: "signalwire::rest::RestClient::FabricTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create_subscriber_token` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create_subscriber_token(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 192. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/fabric-tokens.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/fabric-tokens.mdx new file mode 100644 index 0000000000..c0e5bc648e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/fabric-tokens.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-tokens/fabric-tokens" +title: "FabricTokens" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricTokens::FabricTokens" + parent: "signalwire::rest::RestClient::FabricTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricTokens` + +**Modifiers:** `inline` + +## Signature + +```cpp +void FabricTokens(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 190. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/index.mdx new file mode 100644 index 0000000000..2c837085db --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-tokens" +title: "FabricTokens" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricTokens" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `FabricTokens` + +## Signature + +```cpp +struct signalwire::rest::RestClient::FabricTokens +``` + +## Properties + + + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 187. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/refresh-subscriber-token.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/refresh-subscriber-token.mdx new file mode 100644 index 0000000000..5fe07c5476 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric-tokens/refresh-subscriber-token.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric-tokens/refresh-subscriber-token" +title: "refresh_subscriber_token" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::FabricTokens::refresh_subscriber_token" + parent: "signalwire::rest::RestClient::FabricTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `refresh_subscriber_token` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json refresh_subscriber_token(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 195. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric.mdx new file mode 100644 index 0000000000..8de74ae06e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/fabric.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/fabric" +title: "fabric" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::fabric" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `fabric` + +**Modifiers:** `inline` + +## Signature + +```cpp +FabricNamespace & fabric() +``` + +## Returns + +`FabricNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1432. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/from-env.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/from-env.mdx new file mode 100644 index 0000000000..3b8297d0fb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/from-env.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/from-env" +title: "from_env" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::from_env" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `from_env` + +Initialize from environment variables. + +**Modifiers:** `static` + +## Signature + +```cpp +RestClient from_env() +``` + +## Returns + +`RestClient` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 25. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/http-client.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/http-client.mdx new file mode 100644 index 0000000000..a4f0ea5008 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/http-client.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/http-client" +title: "http_client" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::http_client" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `http_client` + +Get the underlying HTTP client. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const HttpClient & http_client() const +``` + +## Returns + +`const HttpClient &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1455. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace/create.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace/create.mdx new file mode 100644 index 0000000000..ca50fa00d8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace/create" +title: "create" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ImportedNumbersNamespace::create" + parent: "signalwire::rest::RestClient::ImportedNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1231. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace/imported-numbers-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace/imported-numbers-namespace.mdx new file mode 100644 index 0000000000..a0abb89ae7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace/imported-numbers-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace/imported-numbers-namespace" +title: "ImportedNumbersNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ImportedNumbersNamespace::ImportedNumbersNamespace" + parent: "signalwire::rest::RestClient::ImportedNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ImportedNumbersNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void ImportedNumbersNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1229. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace/index.mdx new file mode 100644 index 0000000000..f238b90149 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/imported-numbers-namespace" +title: "ImportedNumbersNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ImportedNumbersNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ImportedNumbersNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::ImportedNumbersNamespace : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1228. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers.mdx new file mode 100644 index 0000000000..d295fb7c86 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/imported-numbers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/imported-numbers" +title: "imported_numbers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::imported_numbers" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `imported_numbers` + +**Modifiers:** `inline` + +## Signature + +```cpp +ImportedNumbersNamespace & imported_numbers() +``` + +## Returns + +`ImportedNumbersNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1446. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/index.mdx new file mode 100644 index 0000000000..0a51cfeaa1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/index.mdx @@ -0,0 +1,216 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client" +title: "RestClient" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient" + parent: "signalwire::rest" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RestClient` + +Top-level SignalWire REST client with all API namespaces. + +## Signature + +```cpp +class signalwire::rest::RestClient +``` + +## Methods + + + + + + + + + + + + + + + + Initialize from environment variables. + + + + Get the underlying HTTP client. + + + + + + + + + + + + + + + + + + Project ID accessor (read-only). + + + + + + + + + + + + + + + + + + + + + + Construct with an explicit pre-built base URL (http://... or https://...) instead of synthesizing one from the SignalWire space hostname. Used by audit harnesses pointing the client at loopback fixtures. The space-based constructor remains the production path. + + + +## Classes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 18. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-conferences/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-conferences/index.mdx new file mode 100644 index 0000000000..274c351bd7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-conferences/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-conferences" +title: "LogsConferences" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsConferences" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LogsConferences` + +## Signature + +```cpp +struct signalwire::rest::RestClient::LogsConferences +``` + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1373. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-conferences/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-conferences/list.mdx new file mode 100644 index 0000000000..7de07a14e2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-conferences/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-conferences/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsConferences::list" + parent: "signalwire::rest::RestClient::LogsConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1377. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-conferences/logs-conferences.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-conferences/logs-conferences.mdx new file mode 100644 index 0000000000..4cbcd62644 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-conferences/logs-conferences.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-conferences/logs-conferences" +title: "LogsConferences" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsConferences::LogsConferences" + parent: "signalwire::rest::RestClient::LogsConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LogsConferences` + +**Modifiers:** `inline` + +## Signature + +```cpp +void LogsConferences(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1376. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/get.mdx new file mode 100644 index 0000000000..b4fb62f3af --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-fax/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsFax::get" + parent: "signalwire::rest::RestClient::LogsFax" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & log_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1368. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/index.mdx new file mode 100644 index 0000000000..1f0fca1fc9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-fax" +title: "LogsFax" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsFax" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LogsFax` + +## Signature + +```cpp +struct signalwire::rest::RestClient::LogsFax +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1361. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/list.mdx new file mode 100644 index 0000000000..2d9917f211 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-fax/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsFax::list" + parent: "signalwire::rest::RestClient::LogsFax" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1365. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/logs-fax.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/logs-fax.mdx new file mode 100644 index 0000000000..61e7af43b2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-fax/logs-fax.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-fax/logs-fax" +title: "LogsFax" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsFax::LogsFax" + parent: "signalwire::rest::RestClient::LogsFax" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LogsFax` + +**Modifiers:** `inline` + +## Signature + +```cpp +void LogsFax(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1364. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/get.mdx new file mode 100644 index 0000000000..e2a83a628b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-messages/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsMessages::get" + parent: "signalwire::rest::RestClient::LogsMessages" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & log_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1340. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/index.mdx new file mode 100644 index 0000000000..1cbaccc3e5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-messages" +title: "LogsMessages" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsMessages" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LogsMessages` + +## Signature + +```cpp +struct signalwire::rest::RestClient::LogsMessages +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1333. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/list.mdx new file mode 100644 index 0000000000..cede7366c9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-messages/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsMessages::list" + parent: "signalwire::rest::RestClient::LogsMessages" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1337. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/logs-messages.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/logs-messages.mdx new file mode 100644 index 0000000000..f06c977b47 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-messages/logs-messages.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-messages/logs-messages" +title: "LogsMessages" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsMessages::LogsMessages" + parent: "signalwire::rest::RestClient::LogsMessages" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LogsMessages` + +**Modifiers:** `inline` + +## Signature + +```cpp +void LogsMessages(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1336. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-namespace/index.mdx new file mode 100644 index 0000000000..8916252b9a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-namespace/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-namespace" +title: "LogsNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LogsNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::LogsNamespace +``` + +## Properties + + + + + + + + + +## Methods + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1382. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-namespace/logs-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-namespace/logs-namespace.mdx new file mode 100644 index 0000000000..2c5472a4be --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-namespace/logs-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-namespace/logs-namespace" +title: "LogsNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsNamespace::LogsNamespace" + parent: "signalwire::rest::RestClient::LogsNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LogsNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void LogsNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1387. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/get.mdx new file mode 100644 index 0000000000..35ae0662d0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-voice/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsVoice::get" + parent: "signalwire::rest::RestClient::LogsVoice" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & log_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1352. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/index.mdx new file mode 100644 index 0000000000..58486ca825 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-voice" +title: "LogsVoice" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsVoice" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LogsVoice` + +## Signature + +```cpp +struct signalwire::rest::RestClient::LogsVoice +``` + +## Properties + + + + + +## Methods + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1345. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/list-events.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/list-events.mdx new file mode 100644 index 0000000000..9644b39e05 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/list-events.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-voice/list-events" +title: "list_events" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsVoice::list_events" + parent: "signalwire::rest::RestClient::LogsVoice" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_events` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_events( + const std::string & log_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1355. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/list.mdx new file mode 100644 index 0000000000..db26b3be95 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-voice/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsVoice::list" + parent: "signalwire::rest::RestClient::LogsVoice" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1349. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/logs-voice.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/logs-voice.mdx new file mode 100644 index 0000000000..9c0ffb5665 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs-voice/logs-voice.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs-voice/logs-voice" +title: "LogsVoice" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LogsVoice::LogsVoice" + parent: "signalwire::rest::RestClient::LogsVoice" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LogsVoice` + +**Modifiers:** `inline` + +## Signature + +```cpp +void LogsVoice(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1348. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs.mdx new file mode 100644 index 0000000000..6c325c10bb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/logs.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/logs" +title: "logs" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::logs" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `logs` + +**Modifiers:** `inline` + +## Signature + +```cpp +LogsNamespace & logs() +``` + +## Returns + +`LogsNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1449. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup-namespace/index.mdx new file mode 100644 index 0000000000..695170dde1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup-namespace/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/lookup-namespace" +title: "LookupNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LookupNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LookupNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::LookupNamespace +``` + +## Properties + + + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1209. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup-namespace/lookup-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup-namespace/lookup-namespace.mdx new file mode 100644 index 0000000000..b42ed7dddb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup-namespace/lookup-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/lookup-namespace/lookup-namespace" +title: "LookupNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LookupNamespace::LookupNamespace" + parent: "signalwire::rest::RestClient::LookupNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `LookupNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void LookupNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1211. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup-namespace/lookup.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup-namespace/lookup.mdx new file mode 100644 index 0000000000..bc17201943 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup-namespace/lookup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/lookup-namespace/lookup" +title: "lookup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::LookupNamespace::lookup" + parent: "signalwire::rest::RestClient::LookupNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `lookup` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json lookup(const std::string & number) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1212. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup.mdx new file mode 100644 index 0000000000..b85e106cb7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/lookup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/lookup" +title: "lookup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::lookup" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `lookup` + +**Modifiers:** `inline` + +## Signature + +```cpp +LookupNamespace & lookup() +``` + +## Returns + +`LookupNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1444. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/call.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/call.mdx new file mode 100644 index 0000000000..194262c2f9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/call.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/mfa-namespace/call" +title: "call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::MFANamespace::call" + parent: "signalwire::rest::RestClient::MFANamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `call` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json call(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1241. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/index.mdx new file mode 100644 index 0000000000..6a67025cc4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/mfa-namespace" +title: "MFANamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::MFANamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `MFANamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::MFANamespace +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1236. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/mfa-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/mfa-namespace.mdx new file mode 100644 index 0000000000..6a47e181b0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/mfa-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/mfa-namespace/mfa-namespace" +title: "MFANamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::MFANamespace::MFANamespace" + parent: "signalwire::rest::RestClient::MFANamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `MFANamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void MFANamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1238. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/request-code.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/request-code.mdx new file mode 100644 index 0000000000..ce944d3ab4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/request-code.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/mfa-namespace/request-code" +title: "request_code" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::MFANamespace::request_code" + parent: "signalwire::rest::RestClient::MFANamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `request_code` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json request_code(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1246. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/sms.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/sms.mdx new file mode 100644 index 0000000000..b2be2a6d2d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/sms.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/mfa-namespace/sms" +title: "sms" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::MFANamespace::sms" + parent: "signalwire::rest::RestClient::MFANamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `sms` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json sms(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1240. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/verify-code.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/verify-code.mdx new file mode 100644 index 0000000000..3fde886e02 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/verify-code.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/mfa-namespace/verify-code" +title: "verify_code" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::MFANamespace::verify_code" + parent: "signalwire::rest::RestClient::MFANamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `verify_code` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json verify_code(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1247. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/verify.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/verify.mdx new file mode 100644 index 0000000000..4878e6ef87 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa-namespace/verify.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/mfa-namespace/verify" +title: "verify" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::MFANamespace::verify" + parent: "signalwire::rest::RestClient::MFANamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `verify` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json verify(const std::string & request_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1242. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa.mdx new file mode 100644 index 0000000000..7b222757ac --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/mfa.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/mfa" +title: "mfa" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::mfa" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `mfa` + +**Modifiers:** `inline` + +## Signature + +```cpp +MFANamespace & mfa() +``` + +## Returns + +`MFANamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1447. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/add-membership.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/add-membership.mdx new file mode 100644 index 0000000000..cefc4d1228 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/add-membership.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/number-groups-namespace/add-membership" +title: "add_membership" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::NumberGroupsNamespace::add_membership" + parent: "signalwire::rest::RestClient::NumberGroupsNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `add_membership` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json add_membership(const std::string & group_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1186. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/delete-membership.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/delete-membership.mdx new file mode 100644 index 0000000000..d94449412d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/delete-membership.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/number-groups-namespace/delete-membership" +title: "delete_membership" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::NumberGroupsNamespace::delete_membership" + parent: "signalwire::rest::RestClient::NumberGroupsNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `delete_membership` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json delete_membership(const std::string & membership_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1192. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/get-membership.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/get-membership.mdx new file mode 100644 index 0000000000..c52554a103 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/get-membership.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/number-groups-namespace/get-membership" +title: "get_membership" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::NumberGroupsNamespace::get_membership" + parent: "signalwire::rest::RestClient::NumberGroupsNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_membership` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_membership(const std::string & membership_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1189. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/index.mdx new file mode 100644 index 0000000000..77f10a621f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/number-groups-namespace" +title: "NumberGroupsNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::NumberGroupsNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `NumberGroupsNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::NumberGroupsNamespace : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1175. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/list-memberships.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/list-memberships.mdx new file mode 100644 index 0000000000..b1663090df --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/list-memberships.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/number-groups-namespace/list-memberships" +title: "list_memberships" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::NumberGroupsNamespace::list_memberships" + parent: "signalwire::rest::RestClient::NumberGroupsNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_memberships` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_memberships( + const std::string & group_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1182. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/number-groups-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/number-groups-namespace.mdx new file mode 100644 index 0000000000..33b1bd58d9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/number-groups-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/number-groups-namespace/number-groups-namespace" +title: "NumberGroupsNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::NumberGroupsNamespace::NumberGroupsNamespace" + parent: "signalwire::rest::RestClient::NumberGroupsNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `NumberGroupsNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void NumberGroupsNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1176. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/update.mdx new file mode 100644 index 0000000000..d2c43b8b59 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups-namespace/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/number-groups-namespace/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::NumberGroupsNamespace::update" + parent: "signalwire::rest::RestClient::NumberGroupsNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1178. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups.mdx new file mode 100644 index 0000000000..3657c26ba4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/number-groups.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/number-groups" +title: "number_groups" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::number_groups" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `number_groups` + +**Modifiers:** `inline` + +## Signature + +```cpp +NumberGroupsNamespace & number_groups() +``` + +## Returns + +`NumberGroupsNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1441. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/buy.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/buy.mdx new file mode 100644 index 0000000000..5990b9dc28 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/buy.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/buy" +title: "buy" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::buy" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `buy` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json buy(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 455. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/call-flow-options/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/call-flow-options/index.mdx new file mode 100644 index 0000000000..16cd4a4fa9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/call-flow-options/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/call-flow-options" +title: "CallFlowOptions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::CallFlowOptions" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CallFlowOptions` + +Options for binding a phone number to a call flow. + +## Signature + +```cpp +struct signalwire::rest::RestClient::PhoneNumbersNamespace::CallFlowOptions +``` + +## Properties + + + Accepts "working\_copy" or "current\_deployed" (server default when omitted). + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 479. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/cxml-webhook-options/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/cxml-webhook-options/index.mdx new file mode 100644 index 0000000000..4a76b98960 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/cxml-webhook-options/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/cxml-webhook-options" +title: "CxmlWebhookOptions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::CxmlWebhookOptions" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `CxmlWebhookOptions` + +Options for binding a phone number to a cXML (Twilio-compat) webhook. + +## Signature + +```cpp +struct signalwire::rest::RestClient::PhoneNumbersNamespace::CxmlWebhookOptions +``` + +## Properties + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 473. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/index.mdx new file mode 100644 index 0000000000..ce0a0fd970 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/index.mdx @@ -0,0 +1,102 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace" +title: "PhoneNumbersNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `PhoneNumbersNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::PhoneNumbersNamespace : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + Route inbound calls to an AI Agent Fabric resource by ID. + + + + Route inbound calls to a Call Flow by ID. opts.version accepts "working\_copy" or "current\_deployed". + + + + Route inbound calls to an existing cXML application by ID. + + + + Route inbound calls to a cXML (Twilio-compat / LAML) webhook. Despite the wire value laml\_webhooks being plural, this creates a single cxml\_webhook Fabric resource. Extra options populate fallback and status-callback fields. + + + + Route inbound calls to a named RELAY application. + + + + Route inbound calls to a RELAY topic (client subscription). + + + + Route inbound calls to an SWML webhook URL. Server auto-creates a swml\_webhook Fabric resource keyed off this URL. + + + +## Classes + + + + Options for binding a phone number to a call flow. + + + + Options for binding a phone number to a cXML (Twilio-compat) webhook. + + + + Options for binding a phone number to a RELAY topic. + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 452. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-ai-agent-body.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-ai-agent-body.mdx new file mode 100644 index 0000000000..cdc77347c4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-ai-agent-body.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-ai-agent-body" +title: "make_ai_agent_body" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::make_ai_agent_body" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `make_ai_agent_body` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +json make_ai_agent_body(const std::string & agent_id) +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 517. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-call-flow-body.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-call-flow-body.mdx new file mode 100644 index 0000000000..cc6612cffc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-call-flow-body.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-call-flow-body" +title: "make_call_flow_body" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::make_call_flow_body" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `make_call_flow_body` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +json make_call_flow_body( + const std::string & flow_id, + const CallFlowOptions & opts = {} +) +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 524. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-cxml-application-body.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-cxml-application-body.mdx new file mode 100644 index 0000000000..6711ed8760 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-cxml-application-body.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-cxml-application-body" +title: "make_cxml_application_body" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::make_cxml_application_body" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `make_cxml_application_body` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +json make_cxml_application_body(const std::string & application_id) +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 510. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-cxml-webhook-body.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-cxml-webhook-body.mdx new file mode 100644 index 0000000000..15ce3252ab --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-cxml-webhook-body.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-cxml-webhook-body" +title: "make_cxml_webhook_body" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::make_cxml_webhook_body" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `make_cxml_webhook_body` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +json make_cxml_webhook_body( + const std::string & url, + const CxmlWebhookOptions & opts = {} +) +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 499. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-relay-application-body.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-relay-application-body.mdx new file mode 100644 index 0000000000..7da335015a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-relay-application-body.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-relay-application-body" +title: "make_relay_application_body" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::make_relay_application_body" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `make_relay_application_body` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +json make_relay_application_body(const std::string & name) +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 534. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-relay-topic-body.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-relay-topic-body.mdx new file mode 100644 index 0000000000..31054e56e0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-relay-topic-body.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-relay-topic-body" +title: "make_relay_topic_body" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::make_relay_topic_body" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `make_relay_topic_body` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +json make_relay_topic_body( + const std::string & topic, + const RelayTopicOptions & opts = {} +) +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 541. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-swml-webhook-body.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-swml-webhook-body.mdx new file mode 100644 index 0000000000..f655144b0d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-swml-webhook-body.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/make-swml-webhook-body" +title: "make_swml_webhook_body" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::make_swml_webhook_body" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `make_swml_webhook_body` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +json make_swml_webhook_body(const std::string & url) +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 492. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/phone-numbers-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/phone-numbers-namespace.mdx new file mode 100644 index 0000000000..117607a41f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/phone-numbers-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/phone-numbers-namespace" +title: "PhoneNumbersNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::PhoneNumbersNamespace" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `PhoneNumbersNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void PhoneNumbersNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 453. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/relay-topic-options/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/relay-topic-options/index.mdx new file mode 100644 index 0000000000..31476d58f1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/relay-topic-options/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/relay-topic-options" +title: "RelayTopicOptions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::RelayTopicOptions" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RelayTopicOptions` + +Options for binding a phone number to a RELAY topic. + +## Signature + +```cpp +struct signalwire::rest::RestClient::PhoneNumbersNamespace::RelayTopicOptions +``` + +## Properties + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 486. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/release.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/release.mdx new file mode 100644 index 0000000000..302738435b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/release.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/release" +title: "release" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::release" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `release` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json release(const std::string & id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 456. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/search.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/search.mdx new file mode 100644 index 0000000000..5891024c6a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/search.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/search" +title: "search" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::search" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `search` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json search(const std::map< std::string, std::string > & p) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 454. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-ai-agent.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-ai-agent.mdx new file mode 100644 index 0000000000..67a8b3f7fc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-ai-agent.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-ai-agent" +title: "set_ai_agent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::set_ai_agent" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `set_ai_agent` + +Route inbound calls to an AI Agent Fabric resource by ID. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json set_ai_agent( + const std::string & resource_id, + const std::string & agent_id +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 577. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-call-flow.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-call-flow.mdx new file mode 100644 index 0000000000..53ed80b321 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-call-flow.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-call-flow" +title: "set_call_flow" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::set_call_flow" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `set_call_flow` + +Route inbound calls to a Call Flow by ID. opts.version accepts "working\_copy" or "current\_deployed". + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json set_call_flow( + const std::string & resource_id, + const std::string & flow_id, + const CallFlowOptions & opts = {} +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 584. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-cxml-application.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-cxml-application.mdx new file mode 100644 index 0000000000..0df0938bcb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-cxml-application.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-cxml-application" +title: "set_cxml_application" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::set_cxml_application" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `set_cxml_application` + +Route inbound calls to an existing cXML application by ID. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json set_cxml_application( + const std::string & resource_id, + const std::string & application_id +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 571. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-cxml-webhook.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-cxml-webhook.mdx new file mode 100644 index 0000000000..620ef25c07 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-cxml-webhook.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-cxml-webhook" +title: "set_cxml_webhook" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::set_cxml_webhook" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `set_cxml_webhook` + +Route inbound calls to a cXML (Twilio-compat / LAML) webhook. Despite the wire value laml\_webhooks being plural, this creates a single cxml\_webhook Fabric resource. Extra options populate fallback and status-callback fields. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json set_cxml_webhook( + const std::string & resource_id, + const std::string & url, + const CxmlWebhookOptions & opts = {} +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 564. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-relay-application.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-relay-application.mdx new file mode 100644 index 0000000000..188b972655 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-relay-application.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-relay-application" +title: "set_relay_application" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::set_relay_application" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `set_relay_application` + +Route inbound calls to a named RELAY application. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json set_relay_application( + const std::string & resource_id, + const std::string & name +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 591. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-relay-topic.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-relay-topic.mdx new file mode 100644 index 0000000000..e88014986d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-relay-topic.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-relay-topic" +title: "set_relay_topic" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::set_relay_topic" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `set_relay_topic` + +Route inbound calls to a RELAY topic (client subscription). + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json set_relay_topic( + const std::string & resource_id, + const std::string & topic, + const RelayTopicOptions & opts = {} +) const +``` + +## Parameters + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 597. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-swml-webhook.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-swml-webhook.mdx new file mode 100644 index 0000000000..1e43ef8c70 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-swml-webhook.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers-namespace/set-swml-webhook" +title: "set_swml_webhook" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PhoneNumbersNamespace::set_swml_webhook" + parent: "signalwire::rest::RestClient::PhoneNumbersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `set_swml_webhook` + +Route inbound calls to an SWML webhook URL. Server auto-creates a swml\_webhook Fabric resource keyed off this URL. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json set_swml_webhook( + const std::string & resource_id, + const std::string & url +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 556. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers.mdx new file mode 100644 index 0000000000..b0ada825f9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/phone-numbers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/phone-numbers" +title: "phone_numbers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::phone_numbers" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `phone_numbers` + +**Modifiers:** `inline` + +## Signature + +```cpp +PhoneNumbersNamespace & phone_numbers() +``` + +## Returns + +`PhoneNumbersNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1434. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-id.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-id.mdx new file mode 100644 index 0000000000..d2afaaa976 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-id.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/project-id" +title: "project_id" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::project_id" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `project_id` + +Project ID accessor (read-only). + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & project_id() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 37. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/get-project.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/get-project.mdx new file mode 100644 index 0000000000..199d47a57f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/get-project.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/project-namespace/get-project" +title: "get_project" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ProjectNamespace::get_project" + parent: "signalwire::rest::RestClient::ProjectNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_project` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_project() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1411. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/index.mdx new file mode 100644 index 0000000000..a13bf0bb8f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/project-namespace" +title: "ProjectNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ProjectNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ProjectNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::ProjectNamespace +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1405. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/project-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/project-namespace.mdx new file mode 100644 index 0000000000..8029be6871 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/project-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/project-namespace/project-namespace" +title: "ProjectNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ProjectNamespace::ProjectNamespace" + parent: "signalwire::rest::RestClient::ProjectNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ProjectNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void ProjectNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1408. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/update-project.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/update-project.mdx new file mode 100644 index 0000000000..d3ba2c916b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-namespace/update-project.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/project-namespace/update-project" +title: "update_project" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ProjectNamespace::update_project" + parent: "signalwire::rest::RestClient::ProjectNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update_project` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update_project(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1412. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/create.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/create.mdx new file mode 100644 index 0000000000..07193af999 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/project-tokens/create" +title: "create" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ProjectTokens::create" + parent: "signalwire::rest::RestClient::ProjectTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1396. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/index.mdx new file mode 100644 index 0000000000..aef59aa04d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/project-tokens" +title: "ProjectTokens" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ProjectTokens" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ProjectTokens` + +## Signature + +```cpp +struct signalwire::rest::RestClient::ProjectTokens +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1392. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/project-tokens.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/project-tokens.mdx new file mode 100644 index 0000000000..3c4f0e297f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/project-tokens.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/project-tokens/project-tokens" +title: "ProjectTokens" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ProjectTokens::ProjectTokens" + parent: "signalwire::rest::RestClient::ProjectTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ProjectTokens` + +**Modifiers:** `inline` + +## Signature + +```cpp +void ProjectTokens(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1395. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/update.mdx new file mode 100644 index 0000000000..c8a267a3f1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project-tokens/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/project-tokens/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ProjectTokens::update" + parent: "signalwire::rest::RestClient::ProjectTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & token_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1397. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project.mdx new file mode 100644 index 0000000000..5587c8867f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/project.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/project" +title: "project" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::project" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `project` + +**Modifiers:** `inline` + +## Signature + +```cpp +ProjectNamespace & project() +``` + +## Returns + +`ProjectNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1450. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pub-sub-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pub-sub-namespace/index.mdx new file mode 100644 index 0000000000..d40669762c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pub-sub-namespace/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/pub-sub-namespace" +title: "PubSubNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PubSubNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `PubSubNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::PubSubNamespace +``` + +## Properties + + + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1415. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pub-sub-namespace/pub-sub-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pub-sub-namespace/pub-sub-namespace.mdx new file mode 100644 index 0000000000..2629b14913 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pub-sub-namespace/pub-sub-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/pub-sub-namespace/pub-sub-namespace" +title: "PubSubNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PubSubNamespace::PubSubNamespace" + parent: "signalwire::rest::RestClient::PubSubNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `PubSubNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void PubSubNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1417. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pub-sub-namespace/publish.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pub-sub-namespace/publish.mdx new file mode 100644 index 0000000000..de3f4c1213 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pub-sub-namespace/publish.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/pub-sub-namespace/publish" +title: "publish" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::PubSubNamespace::publish" + parent: "signalwire::rest::RestClient::PubSubNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `publish` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json publish(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1418. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pubsub.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pubsub.mdx new file mode 100644 index 0000000000..04200647de --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/pubsub.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/pubsub" +title: "pubsub" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::pubsub" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `pubsub` + +**Modifiers:** `inline` + +## Signature + +```cpp +PubSubNamespace & pubsub() +``` + +## Returns + +`PubSubNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1451. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/get-member.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/get-member.mdx new file mode 100644 index 0000000000..84738dc88f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/get-member.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/queues-namespace/get-member" +title: "get_member" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::QueuesNamespace::get_member" + parent: "signalwire::rest::RestClient::QueuesNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_member` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_member( + const std::string & queue_id, + const std::string & member_id +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1164. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/get-next-member.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/get-next-member.mdx new file mode 100644 index 0000000000..2cb96ffccd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/get-next-member.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/queues-namespace/get-next-member" +title: "get_next_member" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::QueuesNamespace::get_next_member" + parent: "signalwire::rest::RestClient::QueuesNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get_next_member` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get_next_member(const std::string & queue_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1161. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/index.mdx new file mode 100644 index 0000000000..008e71c5b8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/queues-namespace" +title: "QueuesNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::QueuesNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `QueuesNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::QueuesNamespace : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1151. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/list-members.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/list-members.mdx new file mode 100644 index 0000000000..db3dd8aaa8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/list-members.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/queues-namespace/list-members" +title: "list_members" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::QueuesNamespace::list_members" + parent: "signalwire::rest::RestClient::QueuesNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_members` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_members( + const std::string & queue_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1157. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/queues-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/queues-namespace.mdx new file mode 100644 index 0000000000..b4d1fc8155 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/queues-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/queues-namespace/queues-namespace" +title: "QueuesNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::QueuesNamespace::QueuesNamespace" + parent: "signalwire::rest::RestClient::QueuesNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `QueuesNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void QueuesNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1152. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/update.mdx new file mode 100644 index 0000000000..985ab3a69b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues-namespace/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/queues-namespace/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::QueuesNamespace::update" + parent: "signalwire::rest::RestClient::QueuesNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1154. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues.mdx new file mode 100644 index 0000000000..b9b7781971 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/queues.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/queues" +title: "queues" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::queues" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `queues` + +**Modifiers:** `inline` + +## Signature + +```cpp +QueuesNamespace & queues() +``` + +## Returns + +`QueuesNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1439. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/recordings-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/recordings-namespace/index.mdx new file mode 100644 index 0000000000..54b9df9014 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/recordings-namespace/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/recordings-namespace" +title: "RecordingsNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RecordingsNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RecordingsNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::RecordingsNamespace : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1169. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/recordings-namespace/recordings-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/recordings-namespace/recordings-namespace.mdx new file mode 100644 index 0000000000..9af469d8a4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/recordings-namespace/recordings-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/recordings-namespace/recordings-namespace" +title: "RecordingsNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RecordingsNamespace::RecordingsNamespace" + parent: "signalwire::rest::RestClient::RecordingsNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RecordingsNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void RecordingsNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1170. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/recordings.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/recordings.mdx new file mode 100644 index 0000000000..9c15413eb6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/recordings.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/recordings" +title: "recordings" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::recordings" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `recordings` + +**Modifiers:** `inline` + +## Signature + +```cpp +RecordingsNamespace & recordings() +``` + +## Returns + +`RecordingsNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1440. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/create-campaign.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/create-campaign.mdx new file mode 100644 index 0000000000..d961fb4ba8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/create-campaign.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-brands/create-campaign" +title: "create_campaign" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryBrands::create_campaign" + parent: "signalwire::rest::RestClient::RegistryBrands" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create_campaign` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create_campaign(const std::string & brand_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1269. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/create.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/create.mdx new file mode 100644 index 0000000000..ae1a257a2f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-brands/create" +title: "create" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryBrands::create" + parent: "signalwire::rest::RestClient::RegistryBrands" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1261. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/get.mdx new file mode 100644 index 0000000000..2b6e0a56a4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-brands/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryBrands::get" + parent: "signalwire::rest::RestClient::RegistryBrands" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & brand_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1262. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/index.mdx new file mode 100644 index 0000000000..cc00ab9584 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-brands" +title: "RegistryBrands" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryBrands" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RegistryBrands` + +## Signature + +```cpp +struct signalwire::rest::RestClient::RegistryBrands +``` + +## Properties + + + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1254. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/list-campaigns.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/list-campaigns.mdx new file mode 100644 index 0000000000..32edf0f1c0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/list-campaigns.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-brands/list-campaigns" +title: "list_campaigns" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryBrands::list_campaigns" + parent: "signalwire::rest::RestClient::RegistryBrands" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_campaigns` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_campaigns( + const std::string & brand_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1265. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/list.mdx new file mode 100644 index 0000000000..2c192cd437 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-brands/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryBrands::list" + parent: "signalwire::rest::RestClient::RegistryBrands" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1258. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/registry-brands.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/registry-brands.mdx new file mode 100644 index 0000000000..e449ecf4a2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-brands/registry-brands.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-brands/registry-brands" +title: "RegistryBrands" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryBrands::RegistryBrands" + parent: "signalwire::rest::RestClient::RegistryBrands" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RegistryBrands` + +**Modifiers:** `inline` + +## Signature + +```cpp +void RegistryBrands(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1257. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/create-order.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/create-order.mdx new file mode 100644 index 0000000000..3511f1b1c0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/create-order.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-campaigns/create-order" +title: "create_order" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryCampaigns::create_order" + parent: "signalwire::rest::RestClient::RegistryCampaigns" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create_order` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create_order(const std::string & campaign_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1293. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/get.mdx new file mode 100644 index 0000000000..86ad56854c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-campaigns/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryCampaigns::get" + parent: "signalwire::rest::RestClient::RegistryCampaigns" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & campaign_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1278. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/index.mdx new file mode 100644 index 0000000000..1d9aeb0891 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-campaigns" +title: "RegistryCampaigns" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryCampaigns" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RegistryCampaigns` + +## Signature + +```cpp +struct signalwire::rest::RestClient::RegistryCampaigns +``` + +## Properties + + + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1274. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/list-numbers.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/list-numbers.mdx new file mode 100644 index 0000000000..2688ae9a0b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/list-numbers.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-campaigns/list-numbers" +title: "list_numbers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryCampaigns::list_numbers" + parent: "signalwire::rest::RestClient::RegistryCampaigns" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_numbers` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_numbers( + const std::string & campaign_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1285. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/list-orders.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/list-orders.mdx new file mode 100644 index 0000000000..5aebb184bb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/list-orders.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-campaigns/list-orders" +title: "list_orders" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryCampaigns::list_orders" + parent: "signalwire::rest::RestClient::RegistryCampaigns" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_orders` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_orders( + const std::string & campaign_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1289. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/registry-campaigns.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/registry-campaigns.mdx new file mode 100644 index 0000000000..ef992e7874 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/registry-campaigns.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-campaigns/registry-campaigns" +title: "RegistryCampaigns" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryCampaigns::RegistryCampaigns" + parent: "signalwire::rest::RestClient::RegistryCampaigns" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RegistryCampaigns` + +**Modifiers:** `inline` + +## Signature + +```cpp +void RegistryCampaigns(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1277. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/update.mdx new file mode 100644 index 0000000000..757f8c043c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-campaigns/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-campaigns/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryCampaigns::update" + parent: "signalwire::rest::RestClient::RegistryCampaigns" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & campaign_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1282. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-namespace/index.mdx new file mode 100644 index 0000000000..2d938ec105 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-namespace/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-namespace" +title: "RegistryNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RegistryNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::RegistryNamespace +``` + +## Properties + + + + + + + + + +## Methods + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1316. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-namespace/registry-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-namespace/registry-namespace.mdx new file mode 100644 index 0000000000..590ce29f5c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-namespace/registry-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-namespace/registry-namespace" +title: "RegistryNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryNamespace::RegistryNamespace" + parent: "signalwire::rest::RestClient::RegistryNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RegistryNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void RegistryNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1321. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-numbers/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-numbers/index.mdx new file mode 100644 index 0000000000..0c235b2f20 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-numbers/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-numbers" +title: "RegistryNumbers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryNumbers" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RegistryNumbers` + +## Signature + +```cpp +struct signalwire::rest::RestClient::RegistryNumbers +``` + +## Properties + + + + + +## Methods + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1307. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-numbers/registry-numbers.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-numbers/registry-numbers.mdx new file mode 100644 index 0000000000..e71ca65920 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-numbers/registry-numbers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-numbers/registry-numbers" +title: "RegistryNumbers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryNumbers::RegistryNumbers" + parent: "signalwire::rest::RestClient::RegistryNumbers" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RegistryNumbers` + +**Modifiers:** `inline` + +## Signature + +```cpp +void RegistryNumbers(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1310. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-orders/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-orders/get.mdx new file mode 100644 index 0000000000..3e647a919f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-orders/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-orders/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryOrders::get" + parent: "signalwire::rest::RestClient::RegistryOrders" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & order_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1302. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-orders/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-orders/index.mdx new file mode 100644 index 0000000000..7d66caec49 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-orders/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-orders" +title: "RegistryOrders" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryOrders" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RegistryOrders` + +## Signature + +```cpp +struct signalwire::rest::RestClient::RegistryOrders +``` + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1298. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-orders/registry-orders.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-orders/registry-orders.mdx new file mode 100644 index 0000000000..e9ebff75ba --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry-orders/registry-orders.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry-orders/registry-orders" +title: "RegistryOrders" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RegistryOrders::RegistryOrders" + parent: "signalwire::rest::RestClient::RegistryOrders" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RegistryOrders` + +**Modifiers:** `inline` + +## Signature + +```cpp +void RegistryOrders(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1301. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry.mdx new file mode 100644 index 0000000000..e496d2bb54 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/registry.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/registry" +title: "registry" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::registry" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `registry` + +**Modifiers:** `inline` + +## Signature + +```cpp +RegistryNamespace & registry() +``` + +## Returns + +`RegistryNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1448. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/rest-client.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/rest-client.mdx new file mode 100644 index 0000000000..eff4ea2e13 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/rest-client.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/rest-client" +title: "RestClient" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::RestClient" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `RestClient` + +## Signature + +```cpp +void RestClient( + const std::string & space, + const std::string & project_id, + const std::string & token +) +``` + +## Parameters + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 20. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes-namespace/index.mdx new file mode 100644 index 0000000000..e53e97d2dc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes-namespace/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/short-codes-namespace" +title: "ShortCodesNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ShortCodesNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ShortCodesNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::ShortCodesNamespace : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1215. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes-namespace/short-codes-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes-namespace/short-codes-namespace.mdx new file mode 100644 index 0000000000..269bf1b96e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes-namespace/short-codes-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/short-codes-namespace/short-codes-namespace" +title: "ShortCodesNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ShortCodesNamespace::ShortCodesNamespace" + parent: "signalwire::rest::RestClient::ShortCodesNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `ShortCodesNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void ShortCodesNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1216. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes-namespace/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes-namespace/update.mdx new file mode 100644 index 0000000000..51c6048b78 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes-namespace/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/short-codes-namespace/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::ShortCodesNamespace::update" + parent: "signalwire::rest::RestClient::ShortCodesNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1218. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes.mdx new file mode 100644 index 0000000000..0120734e25 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/short-codes.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/short-codes" +title: "short_codes" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::short_codes" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `short_codes` + +**Modifiers:** `inline` + +## Signature + +```cpp +ShortCodesNamespace & short_codes() +``` + +## Returns + +`ShortCodesNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1445. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/get.mdx new file mode 100644 index 0000000000..0e4271f601 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/get.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::SipProfileNamespace::get" + parent: "signalwire::rest::RestClient::SipProfileNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1205. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/index.mdx new file mode 100644 index 0000000000..efa2f3242e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/sip-profile-namespace" +title: "SipProfileNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::SipProfileNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `SipProfileNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::SipProfileNamespace : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1203. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/sip-profile-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/sip-profile-namespace.mdx new file mode 100644 index 0000000000..ab69ca61eb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/sip-profile-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/sip-profile-namespace" +title: "SipProfileNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::SipProfileNamespace::SipProfileNamespace" + parent: "signalwire::rest::RestClient::SipProfileNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `SipProfileNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void SipProfileNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1204. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/update.mdx new file mode 100644 index 0000000000..9def6b9cc1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/sip-profile-namespace/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::SipProfileNamespace::update" + parent: "signalwire::rest::RestClient::SipProfileNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1206. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile.mdx new file mode 100644 index 0000000000..b50b8d9f2a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/sip-profile.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/sip-profile" +title: "sip_profile" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::sip_profile" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `sip_profile` + +**Modifiers:** `inline` + +## Signature + +```cpp +SipProfileNamespace & sip_profile() +``` + +## Returns + +`SipProfileNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1443. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/verified-callers-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/verified-callers-namespace/index.mdx new file mode 100644 index 0000000000..d9067fe672 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/verified-callers-namespace/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/verified-callers-namespace" +title: "VerifiedCallersNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VerifiedCallersNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VerifiedCallersNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::VerifiedCallersNamespace : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1197. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/verified-callers-namespace/verified-callers-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/verified-callers-namespace/verified-callers-namespace.mdx new file mode 100644 index 0000000000..da1740ddc4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/verified-callers-namespace/verified-callers-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/verified-callers-namespace/verified-callers-namespace" +title: "VerifiedCallersNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VerifiedCallersNamespace::VerifiedCallersNamespace" + parent: "signalwire::rest::RestClient::VerifiedCallersNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VerifiedCallersNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void VerifiedCallersNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1198. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/verified-callers.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/verified-callers.mdx new file mode 100644 index 0000000000..07e4563669 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/verified-callers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/verified-callers" +title: "verified_callers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::verified_callers" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `verified_callers` + +**Modifiers:** `inline` + +## Signature + +```cpp +VerifiedCallersNamespace & verified_callers() +``` + +## Returns + +`VerifiedCallersNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1442. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/get.mdx new file mode 100644 index 0000000000..10eb239c07 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-conference-tokens/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoConferenceTokens::get" + parent: "signalwire::rest::RestClient::VideoConferenceTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & token_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 747. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/index.mdx new file mode 100644 index 0000000000..86cc320230 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-conference-tokens" +title: "VideoConferenceTokens" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoConferenceTokens" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoConferenceTokens` + +## Signature + +```cpp +struct signalwire::rest::RestClient::VideoConferenceTokens +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 743. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/reset.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/reset.mdx new file mode 100644 index 0000000000..b66942fae5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/reset.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-conference-tokens/reset" +title: "reset" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoConferenceTokens::reset" + parent: "signalwire::rest::RestClient::VideoConferenceTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `reset` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json reset(const std::string & token_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 750. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/video-conference-tokens.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/video-conference-tokens.mdx new file mode 100644 index 0000000000..a4fd0fb476 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conference-tokens/video-conference-tokens.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-conference-tokens/video-conference-tokens" +title: "VideoConferenceTokens" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoConferenceTokens::VideoConferenceTokens" + parent: "signalwire::rest::RestClient::VideoConferenceTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoConferenceTokens` + +**Modifiers:** `inline` + +## Signature + +```cpp +void VideoConferenceTokens(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 746. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/create-stream.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/create-stream.mdx new file mode 100644 index 0000000000..95202d5774 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/create-stream.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-conferences/create-stream" +title: "create_stream" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoConferences::create_stream" + parent: "signalwire::rest::RestClient::VideoConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create_stream` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create_stream(const std::string & conf_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 738. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/index.mdx new file mode 100644 index 0000000000..55e93547c9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-conferences" +title: "VideoConferences" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoConferences" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoConferences` + +## Signature + +```cpp +struct signalwire::rest::RestClient::VideoConferences : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 723. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/list-conference-tokens.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/list-conference-tokens.mdx new file mode 100644 index 0000000000..3b4a6ec3ab --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/list-conference-tokens.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-conferences/list-conference-tokens" +title: "list_conference_tokens" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoConferences::list_conference_tokens" + parent: "signalwire::rest::RestClient::VideoConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_conference_tokens` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_conference_tokens( + const std::string & conf_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 730. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/list-streams.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/list-streams.mdx new file mode 100644 index 0000000000..0bd633ade6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/list-streams.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-conferences/list-streams" +title: "list_streams" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoConferences::list_streams" + parent: "signalwire::rest::RestClient::VideoConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_streams` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_streams( + const std::string & conf_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 734. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/update.mdx new file mode 100644 index 0000000000..1e330bb7de --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-conferences/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoConferences::update" + parent: "signalwire::rest::RestClient::VideoConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & conf_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 727. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/video-conferences.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/video-conferences.mdx new file mode 100644 index 0000000000..a5c6206339 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-conferences/video-conferences.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-conferences/video-conferences" +title: "VideoConferences" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoConferences::VideoConferences" + parent: "signalwire::rest::RestClient::VideoConferences" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoConferences` + +**Modifiers:** `inline` + +## Signature + +```cpp +void VideoConferences(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 724. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-namespace/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-namespace/index.mdx new file mode 100644 index 0000000000..35101757aa --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-namespace/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-namespace" +title: "VideoNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoNamespace" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoNamespace` + +## Signature + +```cpp +struct signalwire::rest::RestClient::VideoNamespace +``` + +## Properties + + + + + + + + + + + + + + + + + +## Methods + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 771. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-namespace/video-namespace.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-namespace/video-namespace.mdx new file mode 100644 index 0000000000..6a8e9179bd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-namespace/video-namespace.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-namespace/video-namespace" +title: "VideoNamespace" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoNamespace::VideoNamespace" + parent: "signalwire::rest::RestClient::VideoNamespace" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoNamespace` + +**Modifiers:** `inline` + +## Signature + +```cpp +void VideoNamespace(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 785. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/get.mdx new file mode 100644 index 0000000000..25ce5cc6da --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-recordings/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomRecordings::get" + parent: "signalwire::rest::RestClient::VideoRoomRecordings" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & recording_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 711. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/index.mdx new file mode 100644 index 0000000000..b7285fba71 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-recordings" +title: "VideoRoomRecordings" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomRecordings" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoRoomRecordings` + +## Signature + +```cpp +struct signalwire::rest::RestClient::VideoRoomRecordings +``` + +## Properties + + + + + +## Methods + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 704. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/list-events.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/list-events.mdx new file mode 100644 index 0000000000..66cbbb6330 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/list-events.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-recordings/list-events" +title: "list_events" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomRecordings::list_events" + parent: "signalwire::rest::RestClient::VideoRoomRecordings" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_events` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_events( + const std::string & recording_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 717. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/list.mdx new file mode 100644 index 0000000000..1347ab6c14 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-recordings/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomRecordings::list" + parent: "signalwire::rest::RestClient::VideoRoomRecordings" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 708. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/video-room-recordings.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/video-room-recordings.mdx new file mode 100644 index 0000000000..cc485d6003 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-recordings/video-room-recordings.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-recordings/video-room-recordings" +title: "VideoRoomRecordings" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomRecordings::VideoRoomRecordings" + parent: "signalwire::rest::RestClient::VideoRoomRecordings" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoRoomRecordings` + +**Modifiers:** `inline` + +## Signature + +```cpp +void VideoRoomRecordings(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 707. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/get.mdx new file mode 100644 index 0000000000..9f52d58d69 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-sessions/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomSessions::get" + parent: "signalwire::rest::RestClient::VideoRoomSessions" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & session_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 687. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/index.mdx new file mode 100644 index 0000000000..6cdc45aee7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-sessions" +title: "VideoRoomSessions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomSessions" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoRoomSessions` + +## Signature + +```cpp +struct signalwire::rest::RestClient::VideoRoomSessions +``` + +## Properties + + + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 680. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-events.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-events.mdx new file mode 100644 index 0000000000..193c5c3be0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-events.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-events" +title: "list_events" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomSessions::list_events" + parent: "signalwire::rest::RestClient::VideoRoomSessions" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_events` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_events( + const std::string & session_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 690. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-members.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-members.mdx new file mode 100644 index 0000000000..5b88cd667d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-members.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-members" +title: "list_members" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomSessions::list_members" + parent: "signalwire::rest::RestClient::VideoRoomSessions" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_members` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_members( + const std::string & session_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 694. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-recordings.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-recordings.mdx new file mode 100644 index 0000000000..b3f5ed9783 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-recordings.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-sessions/list-recordings" +title: "list_recordings" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomSessions::list_recordings" + parent: "signalwire::rest::RestClient::VideoRoomSessions" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_recordings` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_recordings( + const std::string & session_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 698. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list.mdx new file mode 100644 index 0000000000..896c0db507 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-sessions/list" +title: "list" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomSessions::list" + parent: "signalwire::rest::RestClient::VideoRoomSessions" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list(const std::map< std::string, std::string > & params = {}) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 684. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/video-room-sessions.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/video-room-sessions.mdx new file mode 100644 index 0000000000..7811a54cc0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-sessions/video-room-sessions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-sessions/video-room-sessions" +title: "VideoRoomSessions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomSessions::VideoRoomSessions" + parent: "signalwire::rest::RestClient::VideoRoomSessions" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoRoomSessions` + +**Modifiers:** `inline` + +## Signature + +```cpp +void VideoRoomSessions(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 683. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-tokens/create.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-tokens/create.mdx new file mode 100644 index 0000000000..751cc3a14a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-tokens/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-tokens/create" +title: "create" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomTokens::create" + parent: "signalwire::rest::RestClient::VideoRoomTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create(const json & data) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 677. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-tokens/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-tokens/index.mdx new file mode 100644 index 0000000000..9a2fe9c4d3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-tokens/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-tokens" +title: "VideoRoomTokens" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomTokens" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoRoomTokens` + +## Signature + +```cpp +struct signalwire::rest::RestClient::VideoRoomTokens +``` + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 673. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-tokens/video-room-tokens.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-tokens/video-room-tokens.mdx new file mode 100644 index 0000000000..398aa31d90 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-room-tokens/video-room-tokens.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-room-tokens/video-room-tokens" +title: "VideoRoomTokens" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRoomTokens::VideoRoomTokens" + parent: "signalwire::rest::RestClient::VideoRoomTokens" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoRoomTokens` + +**Modifiers:** `inline` + +## Signature + +```cpp +void VideoRoomTokens(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 676. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/create-stream.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/create-stream.mdx new file mode 100644 index 0000000000..917eeeb230 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/create-stream.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-rooms/create-stream" +title: "create_stream" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRooms::create_stream" + parent: "signalwire::rest::RestClient::VideoRooms" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `create_stream` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json create_stream(const std::string & room_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 668. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/index.mdx new file mode 100644 index 0000000000..78b61a511f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-rooms" +title: "VideoRooms" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRooms" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoRooms` + +## Signature + +```cpp +struct signalwire::rest::RestClient::VideoRooms : signalwire::rest::CrudResource +``` + +## Inheritance + +**Extends:** [signalwire::rest::CrudResource](/reference/cpp/signalwire/rest/crud-resource) + +## Methods + + + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 658. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/list-streams.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/list-streams.mdx new file mode 100644 index 0000000000..bab30193fb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/list-streams.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-rooms/list-streams" +title: "list_streams" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRooms::list_streams" + parent: "signalwire::rest::RestClient::VideoRooms" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `list_streams` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json list_streams( + const std::string & room_id, + const std::map< std::string, std::string > & params = {} +) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 664. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/update.mdx new file mode 100644 index 0000000000..c1acf50656 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-rooms/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRooms::update" + parent: "signalwire::rest::RestClient::VideoRooms" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & room_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 661. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/video-rooms.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/video-rooms.mdx new file mode 100644 index 0000000000..0e5baf554a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-rooms/video-rooms.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-rooms/video-rooms" +title: "VideoRooms" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoRooms::VideoRooms" + parent: "signalwire::rest::RestClient::VideoRooms" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoRooms` + +**Modifiers:** `inline` + +## Signature + +```cpp +void VideoRooms(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 659. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/get.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/get.mdx new file mode 100644 index 0000000000..69db33d45e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-streams/get" +title: "get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoStreams::get" + parent: "signalwire::rest::RestClient::VideoStreams" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `get` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json get(const std::string & stream_id) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 759. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/index.mdx new file mode 100644 index 0000000000..eb5502d0dc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-streams" +title: "VideoStreams" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoStreams" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoStreams` + +## Signature + +```cpp +struct signalwire::rest::RestClient::VideoStreams +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 755. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/update.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/update.mdx new file mode 100644 index 0000000000..d7fac73db1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-streams/update" +title: "update" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoStreams::update" + parent: "signalwire::rest::RestClient::VideoStreams" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `update` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json update(const std::string & stream_id, const json & data) const +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 763. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/video-streams.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/video-streams.mdx new file mode 100644 index 0000000000..04ff659780 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video-streams/video-streams.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video-streams/video-streams" +title: "VideoStreams" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::VideoStreams::VideoStreams" + parent: "signalwire::rest::RestClient::VideoStreams" + module: "signalwire.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `VideoStreams` + +**Modifiers:** `inline` + +## Signature + +```cpp +void VideoStreams(const HttpClient & c) +``` + +## Parameters + + + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 758. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video.mdx new file mode 100644 index 0000000000..827454b283 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/video.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/video" +title: "video" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::video" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `video` + +**Modifiers:** `inline` + +## Signature + +```cpp +VideoNamespace & video() +``` + +## Returns + +`VideoNamespace &` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 1436. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/with-base-url.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/with-base-url.mdx new file mode 100644 index 0000000000..58a5647dc4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/rest-client/with-base-url.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/rest/rest-client/with-base-url" +title: "with_base_url" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::RestClient::with_base_url" + parent: "signalwire::rest::RestClient" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp" + visibility: "public" +--- +# `with_base_url` + +Construct with an explicit pre-built base URL (http://... or https://...) instead of synthesizing one from the SignalWire space hostname. Used by audit harnesses pointing the client at loopback fixtures. The space-based constructor remains the production path. + +**Modifiers:** `static` + +## Signature + +```cpp +RestClient with_base_url( + const std::string & base_url, + const std::string & project_id, + const std::string & token +) +``` + +## Parameters + + + + + + + +## Returns + +`RestClient` + +## Source + +[`include/signalwire/rest/rest_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/rest_client.hpp) + +Line 32. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/body.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/body.mdx new file mode 100644 index 0000000000..cd64ac2527 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/body.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/signal-wire-rest-error/body" +title: "body" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::SignalWireRestError::body" + parent: "signalwire::rest::SignalWireRestError" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `body` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & body() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/index.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/index.mdx new file mode 100644 index 0000000000..12c45585a7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/rest/signal-wire-rest-error" +title: "SignalWireRestError" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::rest::SignalWireRestError" + parent: "signalwire::rest" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `SignalWireRestError` + +Error thrown on non-2xx REST API responses. + +## Signature + +```cpp +class signalwire::rest::SignalWireRestError : std::runtime_error +``` + +## Inheritance + +**Extends:** `std::runtime_error` + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 17. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/signal-wire-rest-error.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/signal-wire-rest-error.mdx new file mode 100644 index 0000000000..bd4ae6fb02 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/signal-wire-rest-error.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/rest/signal-wire-rest-error/signal-wire-rest-error" +title: "SignalWireRestError" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::SignalWireRestError::SignalWireRestError" + parent: "signalwire::rest::SignalWireRestError" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `SignalWireRestError` + +**Modifiers:** `inline` + +## Signature + +```cpp +void SignalWireRestError( + int status, + const std::string & message, + const std::string & body = "" +) +``` + +## Parameters + + + + + + + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 19. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/status.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/status.mdx new file mode 100644 index 0000000000..3dd696699a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/signal-wire-rest-error/status.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/rest/signal-wire-rest-error/status" +title: "status" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::rest::SignalWireRestError::status" + parent: "signalwire::rest::SignalWireRestError" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp" + visibility: "public" +--- +# `status` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +int status() const +``` + +## Returns + +`int` + +## Source + +[`include/signalwire/rest/http_client.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/http_client.hpp) + +Line 21. diff --git a/fern/products/sdk-reference/cpp/signalwire/rest/to-wire-string.mdx b/fern/products/sdk-reference/cpp/signalwire/rest/to-wire-string.mdx new file mode 100644 index 0000000000..b487445f74 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/rest/to-wire-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/rest/to-wire-string" +title: "to_wire_string" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::rest::to_wire_string" + parent: "signalwire::rest" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/phone_call_handler.hpp" + visibility: "public" +--- +# `to_wire_string` + +Serialize a PhoneCallHandler to its wire string. + +**Modifiers:** `inline` + +## Signature + +```cpp +std::string to_wire_string(PhoneCallHandler h) +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/rest/phone_call_handler.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/rest/phone_call_handler.hpp) + +Line 54. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/form-params.mdx b/fern/products/sdk-reference/cpp/signalwire/security/form-params.mdx new file mode 100644 index 0000000000..66aa9c5270 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/form-params.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/cpp/signalwire/security/form-params" +title: "FormParams" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::security::FormParams" + parent: "signalwire::security" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/webhook_validator.hpp" + visibility: "public" +--- +# `FormParams` + +Pre-parsed form parameters for ValidateRequest: ordered list of (key, list-of-values) tuples. Repeated keys are represented as one entry whose values vector holds each occurrence in submission order. +Used as one alternative in ParamsOrBody; the other alternative is the raw body string. + +## Signature + +```cpp +typedef std::vector< std::pair< std::string, std::vector< std::string > > > FormParams +``` + +## Source + +[`include/signalwire/security/webhook_validator.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/webhook_validator.hpp) + +Line 32. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/http-handler.mdx b/fern/products/sdk-reference/cpp/signalwire/security/http-handler.mdx new file mode 100644 index 0000000000..49384651b9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/http-handler.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/security/http-handler" +title: "HttpHandler" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::security::HttpHandler" + parent: "signalwire::security" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/webhook_middleware.hpp" + visibility: "public" +--- +# `HttpHandler` + +A cpp-httplib handler signature, lifted into a typedef so the adapter stays framework-agnostic at the call site (the only deps needed by this header are a forward declaration of httplib::Request/Response). + +## Signature + +```cpp +typedef std::function< void(const httplib::Request &, httplib::Response &)> HttpHandler +``` + +## Source + +[`include/signalwire/security/webhook_middleware.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/webhook_middleware.hpp) + +Line 19. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/index.mdx b/fern/products/sdk-reference/cpp/signalwire/security/index.mdx new file mode 100644 index 0000000000..35cf4427b9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/cpp/signalwire/security" +title: "security" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::security" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp" +--- +# `security` + +## Signature + +```cpp +namespace signalwire::security +``` + +## Functions + + + + Legacy @signalwire/compatibility-api drop-in entry point. If params\_or\_raw\_body holds a std::string, delegates to ValidateWebhookSignature (Scheme A then Scheme B with parsed form). If it holds a FormParams, treats it as pre-parsed form params and runs Scheme B directly (with URL port normalization). + + + + Validate a SignalWire webhook signature against both schemes. Tries Scheme A (hex JSON) first; on miss falls back to Scheme B (base64 form) with URL port normalization, repeated-key handling, and optional ?bodySHA256= body-hash check for JSON bodies on the compat surface. + + + + Wrap a downstream cpp-httplib POST handler with SignalWire webhook signature validation. Behavior: + + + +## Type Aliases + + + + Pre-parsed form parameters for ValidateRequest: ordered list of (key, list-of-values) tuples. Repeated keys are represented as one entry whose values vector holds each occurrence in submission order. Used as one alternative in ParamsOrBody; the other alternative is the raw body string. + + + + A cpp-httplib handler signature, lifted into a typedef so the adapter stays framework-agnostic at the call site (the only deps needed by this header are a forward declaration of httplib::Request/Response). + + + + Drop-in shape for ValidateRequest mirroring @signalwire/compatibility-api's RestClient.validateRequest: either a raw body string (delegates to the combined validator) or a pre-parsed form-params list (runs Scheme B directly). + + + +## Classes + + + + Manages HMAC-SHA256 based session tokens for secure SWAIG tool calls. Token format: base64(functionName:callID:expiryTimestamp) + "." + hex(hmac\_signature) + + + + Optional knobs for WrapWithSignatureValidation. trust\_proxy controls whether X-Forwarded-Proto / X-Forwarded-Host headers are honored when reconstructing the public URL — opt-in because proxy headers are spoofable. proxy\_url\_base is consulted before the proxy headers and is meant for SWML\_PROXY\_URL\_BASE callers. + + + +## Source + +[`include/signalwire/security/session_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp) + +Line 9. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/params-or-body.mdx b/fern/products/sdk-reference/cpp/signalwire/security/params-or-body.mdx new file mode 100644 index 0000000000..46a9401799 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/params-or-body.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/security/params-or-body" +title: "ParamsOrBody" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::security::ParamsOrBody" + parent: "signalwire::security" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/webhook_validator.hpp" + visibility: "public" +--- +# `ParamsOrBody` + +Drop-in shape for ValidateRequest mirroring @signalwire/compatibility-api's RestClient.validateRequest: either a raw body string (delegates to the combined validator) or a pre-parsed form-params list (runs Scheme B directly). + +## Signature + +```cpp +typedef std::variant< std::string, FormParams > ParamsOrBody +``` + +## Source + +[`include/signalwire/security/webhook_validator.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/webhook_validator.hpp) + +Line 38. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/session-manager/create-token.mdx b/fern/products/sdk-reference/cpp/signalwire/security/session-manager/create-token.mdx new file mode 100644 index 0000000000..caa9bd58f5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/session-manager/create-token.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/cpp/signalwire/security/session-manager/create-token" +title: "create_token" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::security::SessionManager::create_token" + parent: "signalwire::security::SessionManager" + module: "signalwire.security" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp" + visibility: "public" +--- +# `create_token` + +Create a signed token for a function call + +function\_name + +The SWAIG function name + +call\_id + +The call identifier + +expiry\_seconds + +Seconds until expiry (default 3600) + +The signed token string + +**Modifiers:** `const` + +## Signature + +```cpp +std::string create_token( + const std::string & function_name, + const std::string & call_id, + int expiry_seconds = 3600 +) const +``` + +## Parameters + + + The SWAIG function name + + + + The call identifier + + + + Seconds until expiry (default 3600) + + +## Returns + +`std::string` — The signed token string + +## Source + +[`include/signalwire/security/session_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp) + +Line 27. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/session-manager/index.mdx b/fern/products/sdk-reference/cpp/signalwire/security/session-manager/index.mdx new file mode 100644 index 0000000000..cdb1f5a0f6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/session-manager/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/cpp/signalwire/security/session-manager" +title: "SessionManager" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::security::SessionManager" + parent: "signalwire::security" + module: "signalwire.security" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp" + visibility: "public" +--- +# `SessionManager` + +Manages HMAC-SHA256 based session tokens for secure SWAIG tool calls. +Token format: base64(functionName:callID:expiryTimestamp) + "." + hex(hmac\_signature) + +## Signature + +```cpp +class signalwire::security::SessionManager +``` + +## Methods + + + + Create a signed token for a function call + + + + Construct with a random 32-byte secret. + + + + Timing-safe comparison of two byte sequences. + + + + Validate a token + + + +## Source + +[`include/signalwire/security/session_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/session-manager/session-manager.mdx b/fern/products/sdk-reference/cpp/signalwire/security/session-manager/session-manager.mdx new file mode 100644 index 0000000000..74856d137c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/session-manager/session-manager.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/security/session-manager/session-manager" +title: "SessionManager" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::security::SessionManager::SessionManager" + parent: "signalwire::security::SessionManager" + module: "signalwire.security" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp" + visibility: "public" +--- +# `SessionManager` + +Construct with a random 32-byte secret. + +## Signature + + + + ```cpp + void SessionManager() + ``` + + + + ```cpp + void SessionManager(const std::vector< uint8_t > & secret) + ``` + + + +## Parameters (Overload 2) + + + +## Source + +[`include/signalwire/security/session_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp) + +Line 17. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/session-manager/timing-safe-compare.mdx b/fern/products/sdk-reference/cpp/signalwire/security/session-manager/timing-safe-compare.mdx new file mode 100644 index 0000000000..6bdae6fdb8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/session-manager/timing-safe-compare.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/security/session-manager/timing-safe-compare" +title: "timing_safe_compare" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::security::SessionManager::timing_safe_compare" + parent: "signalwire::security::SessionManager" + module: "signalwire.security" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp" + visibility: "public" +--- +# `timing_safe_compare` + +Timing-safe comparison of two byte sequences. + +**Modifiers:** `static` + +## Signature + +```cpp +bool timing_safe_compare(const std::string & a, const std::string & b) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/security/session_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp) + +Line 41. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/session-manager/validate-token.mdx b/fern/products/sdk-reference/cpp/signalwire/security/session-manager/validate-token.mdx new file mode 100644 index 0000000000..f822dbf283 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/session-manager/validate-token.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/cpp/signalwire/security/session-manager/validate-token" +title: "validate_token" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::security::SessionManager::validate_token" + parent: "signalwire::security::SessionManager" + module: "signalwire.security" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp" + visibility: "public" +--- +# `validate_token` + +Validate a token + +token + +The token to validate + +function\_name + +Expected function name + +call\_id + +Expected call ID + +true if token is valid and not expired + +**Modifiers:** `const` + +## Signature + +```cpp +bool validate_token( + const std::string & token, + const std::string & function_name, + const std::string & call_id +) const +``` + +## Parameters + + + The token to validate + + + + Expected function name + + + + Expected call ID + + +## Returns + +`bool` — true if token is valid and not expired + +## Source + +[`include/signalwire/security/session_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/session_manager.hpp) + +Line 36. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/validate-request.mdx b/fern/products/sdk-reference/cpp/signalwire/security/validate-request.mdx new file mode 100644 index 0000000000..a9bf86bae8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/validate-request.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/cpp/signalwire/security/validate-request" +title: "ValidateRequest" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::security::ValidateRequest" + parent: "signalwire::security" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/security/webhook_validator.cpp" + visibility: "public" +--- +# `ValidateRequest` + +Legacy @signalwire/compatibility-api drop-in entry point. +If params\_or\_raw\_body holds a std::string, delegates to ValidateWebhookSignature (Scheme A then Scheme B with parsed form). +If it holds a FormParams, treats it as pre-parsed form params and runs Scheme B directly (with URL port normalization). + +std::invalid\_argument + +when signing\_key is empty. + +## Signature + +```cpp +bool ValidateRequest( + std::string_view signing_key, + std::string_view signature, + std::string_view url, + const ParamsOrBody & params_or_raw_body +) +``` + +## Parameters + + + + + + + + + +## Returns + +`bool` + +## Throws + +- `std::invalid_argument` — when signing\_key is empty. + +## Source + +[`src/security/webhook_validator.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/security/webhook_validator.cpp) + +Line 457. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/validate-webhook-signature.mdx b/fern/products/sdk-reference/cpp/signalwire/security/validate-webhook-signature.mdx new file mode 100644 index 0000000000..7d499ed5ee --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/validate-webhook-signature.mdx @@ -0,0 +1,84 @@ +--- +slug: "/reference/cpp/signalwire/security/validate-webhook-signature" +title: "ValidateWebhookSignature" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::security::ValidateWebhookSignature" + parent: "signalwire::security" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/security/webhook_validator.cpp" + visibility: "public" +--- +# `ValidateWebhookSignature` + +Validate a SignalWire webhook signature against both schemes. +Tries Scheme A (hex JSON) first; on miss falls back to Scheme B (base64 form) with URL port normalization, repeated-key handling, and optional ?bodySHA256= body-hash check for JSON bodies on the compat surface. + +signing\_key + +The customer's Signing Key. UTF-8 string. MUST NOT be empty — empty throws std::invalid\_argument, that's a programming error not a validation failure. + +signature + +The X-SignalWire-Signature header value (or the legacy X-Twilio-Signature alias). Empty returns false without throwing. + +url + +Full URL SignalWire POSTed to (scheme, host, optional port, path, query) — must match what the platform saw, see the URL-reconstruction section of porting-sdk/webhooks.md. + +raw\_body + +Raw request body bytes as a UTF-8 string, BEFORE any JSON / form parsing. Re-serialized JSON breaks Scheme A. + +true if either scheme matches; false otherwise. + +std::invalid\_argument + +when signing\_key is empty. + +## Signature + +```cpp +bool ValidateWebhookSignature( + std::string_view signing_key, + std::string_view signature, + std::string_view url, + std::string_view raw_body +) +``` + +## Parameters + + + The customer's Signing Key. UTF-8 string. MUST NOT be empty — empty throws std::invalid\_argument, that's a programming error not a validation failure. + + + + The X-SignalWire-Signature header value (or the legacy X-Twilio-Signature alias). Empty returns false without throwing. + + + + Full URL SignalWire POSTed to (scheme, host, optional port, path, query) — must match what the platform saw, see the URL-reconstruction section of porting-sdk/webhooks.md. + + + + Raw request body bytes as a UTF-8 string, BEFORE any JSON / form parsing. Re-serialized JSON breaks Scheme A. + + +## Returns + +`bool` — true if either scheme matches; false otherwise. + +## Throws + +- `std::invalid_argument` — when signing\_key is empty. + +## Source + +[`src/security/webhook_validator.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/security/webhook_validator.cpp) + +Line 406. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/webhook-validator-options/index.mdx b/fern/products/sdk-reference/cpp/signalwire/security/webhook-validator-options/index.mdx new file mode 100644 index 0000000000..c26f57be45 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/webhook-validator-options/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/security/webhook-validator-options" +title: "WebhookValidatorOptions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::security::WebhookValidatorOptions" + parent: "signalwire::security" + module: "signalwire.security" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/webhook_middleware.hpp" + visibility: "public" +--- +# `WebhookValidatorOptions` + +Optional knobs for WrapWithSignatureValidation. trust\_proxy controls whether X-Forwarded-Proto / X-Forwarded-Host headers are honored when reconstructing the public URL — opt-in because proxy headers are spoofable. proxy\_url\_base is consulted before the proxy headers and is meant for SWML\_PROXY\_URL\_BASE callers. + +## Signature + +```cpp +struct signalwire::security::WebhookValidatorOptions +``` + +## Properties + + + Optional base URL (e.g. https://abcd.ngrok.io) joined with the request path + query when reconstructing the URL. Wins over proxy headers and request.host. + + + + If true, honor X-Forwarded-Proto / X-Forwarded-Host when reconstructing the URL. Default false. + + +## Source + +[`include/signalwire/security/webhook_middleware.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/security/webhook_middleware.hpp) + +Line 26. diff --git a/fern/products/sdk-reference/cpp/signalwire/security/wrap-with-signature-validation.mdx b/fern/products/sdk-reference/cpp/signalwire/security/wrap-with-signature-validation.mdx new file mode 100644 index 0000000000..41b7b2448d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/security/wrap-with-signature-validation.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/cpp/signalwire/security/wrap-with-signature-validation" +title: "WrapWithSignatureValidation" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::security::WrapWithSignatureValidation" + parent: "signalwire::security" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/security/webhook_middleware.cpp" + visibility: "public" +--- +# `WrapWithSignatureValidation` + +Wrap a downstream cpp-httplib POST handler with SignalWire webhook signature validation. +Behavior: + +Read req.body (cpp-httplib has already buffered it). +Pull X-SignalWire-Signature (or the X-Twilio-Signature legacy alias) from headers. +Reconstruct the public URL the platform POSTed to (proxy-aware). +Call ValidateWebhookSignature. +On invalid / missing signature: respond 403 Forbidden with no body detail. The downstream handler is NOT called. Per the porting-sdk spec, the validator MUST NOT log which branch failed or the expected signature. +On valid: call downstream(req, res). The handler can read req.body directly — cpp-httplib buffers it for repeat reads. + +signing\_key + +Customer's Signing Key (SignalWire Dashboard → API Credentials). MUST NOT be empty — empty throws std::invalid\_argument at wrap time, that's a programming error not a runtime failure. + +downstream + +Handler to invoke on a valid signature. + +opts + +Optional URL reconstruction knobs. + +A handler suitable for server.Post(path, handler). + +std::invalid\_argument + +if signing\_key is empty. + +## Signature + +```cpp +HttpHandler WrapWithSignatureValidation( + std::string_view signing_key, + HttpHandler downstream, + WebhookValidatorOptions opts = {} +) +``` + +## Parameters + + + Customer's Signing Key (SignalWire Dashboard → API Credentials). MUST NOT be empty — empty throws std::invalid\_argument at wrap time, that's a programming error not a runtime failure. + + + + Handler to invoke on a valid signature. + + + + Optional URL reconstruction knobs. + + +## Returns + +`HttpHandler` — A handler suitable for server.Post(path, handler). + +## Throws + +- `std::invalid_argument` — if signing\_key is empty. + +## Source + +[`src/security/webhook_middleware.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/security/webhook_middleware.cpp) + +Line 107. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/agent-server/agent-server.mdx b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/agent-server.mdx new file mode 100644 index 0000000000..367f54c8b4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/agent-server.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/server/agent-server/agent-server" +title: "AgentServer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::server::AgentServer::AgentServer" + parent: "signalwire::server::AgentServer" + module: "signalwire.server" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `AgentServer` + +**Modifiers:** `explicit` + +## Signature + +```cpp +void AgentServer(const std::string & host = "0.0.0.0", int port = 3000) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/agent-server/agent-server__2.mdx b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/agent-server__2.mdx new file mode 100644 index 0000000000..2aab93cd17 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/agent-server__2.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/server/agent-server/agent-server__2" +title: "~AgentServer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::server::AgentServer::~AgentServer" + parent: "signalwire::server::AgentServer" + module: "signalwire.server" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `~AgentServer` + +## Signature + +```cpp +void ~AgentServer() +``` + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 25. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/agent-server/enable-sip-routing.mdx b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/enable-sip-routing.mdx new file mode 100644 index 0000000000..08f798033e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/enable-sip-routing.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/server/agent-server/enable-sip-routing" +title: "enable_sip_routing" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::server::AgentServer::enable_sip_routing" + parent: "signalwire::server::AgentServer" + module: "signalwire.server" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `enable_sip_routing` + +Enable SIP routing. + +## Signature + +```cpp +AgentServer & enable_sip_routing(bool enable = true) +``` + +## Parameters + + + +## Returns + +`AgentServer &` + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 37. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/agent-server/index.mdx b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/index.mdx new file mode 100644 index 0000000000..d92ef180cf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/index.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/cpp/signalwire/server/agent-server" +title: "AgentServer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::server::AgentServer" + parent: "signalwire::server" + module: "signalwire.server" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `AgentServer` + +Multi-agent hosting server. + +## Signature + +```cpp +class signalwire::server::AgentServer +``` + +## Methods + + + + + + + + Enable SIP routing. + + + + List registered routes. + + + + Map a SIP username to an agent route. + + + + Register an agent at a specific route. + + + + Start the server (blocking). + + + + Enable static file serving from a directory. + + + + Stop the server. + + + + Unregister an agent by route. + + + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/agent-server/list-routes.mdx b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/list-routes.mdx new file mode 100644 index 0000000000..d36afce672 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/list-routes.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/server/agent-server/list-routes" +title: "list_routes" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::server::AgentServer::list_routes" + parent: "signalwire::server::AgentServer" + module: "signalwire.server" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `list_routes` + +List registered routes. + +**Modifiers:** `const` + +## Signature + +```cpp +std::vector< std::string > list_routes() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 34. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/agent-server/map-sip-username.mdx b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/map-sip-username.mdx new file mode 100644 index 0000000000..a4e733827a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/map-sip-username.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/server/agent-server/map-sip-username" +title: "map_sip_username" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::server::AgentServer::map_sip_username" + parent: "signalwire::server::AgentServer" + module: "signalwire.server" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `map_sip_username` + +Map a SIP username to an agent route. + +## Signature + +```cpp +AgentServer & map_sip_username( + const std::string & username, + const std::string & route +) +``` + +## Parameters + + + + + +## Returns + +`AgentServer &` + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 40. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/agent-server/register-agent.mdx b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/register-agent.mdx new file mode 100644 index 0000000000..9333bd5439 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/register-agent.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/server/agent-server/register-agent" +title: "register_agent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::server::AgentServer::register_agent" + parent: "signalwire::server::AgentServer" + module: "signalwire.server" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `register_agent` + +Register an agent at a specific route. + +## Signature + +```cpp +AgentServer & register_agent( + std::shared_ptr< agent::AgentBase > agent, + const std::string & route +) +``` + +## Parameters + + + + + +## Returns + +`AgentServer &` + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/agent-server/run.mdx b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/run.mdx new file mode 100644 index 0000000000..504e5dcd33 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/run.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/server/agent-server/run" +title: "run" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::server::AgentServer::run" + parent: "signalwire::server::AgentServer" + module: "signalwire.server" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `run` + +Start the server (blocking). + +## Signature + +```cpp +void run() +``` + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 46. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/agent-server/set-static-dir.mdx b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/set-static-dir.mdx new file mode 100644 index 0000000000..4bfd360202 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/set-static-dir.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/server/agent-server/set-static-dir" +title: "set_static_dir" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::server::AgentServer::set_static_dir" + parent: "signalwire::server::AgentServer" + module: "signalwire.server" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `set_static_dir` + +Enable static file serving from a directory. + +## Signature + +```cpp +AgentServer & set_static_dir(const std::string & dir) +``` + +## Parameters + + + +## Returns + +`AgentServer &` + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 43. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/agent-server/stop.mdx b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/stop.mdx new file mode 100644 index 0000000000..3b5a65f327 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/server/agent-server/stop" +title: "stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::server::AgentServer::stop" + parent: "signalwire::server::AgentServer" + module: "signalwire.server" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `stop` + +Stop the server. + +## Signature + +```cpp +void stop() +``` + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 49. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/agent-server/unregister-agent.mdx b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/unregister-agent.mdx new file mode 100644 index 0000000000..658620cf63 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/agent-server/unregister-agent.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/server/agent-server/unregister-agent" +title: "unregister_agent" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::server::AgentServer::unregister_agent" + parent: "signalwire::server::AgentServer" + module: "signalwire.server" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `unregister_agent` + +Unregister an agent by route. + +## Signature + +```cpp +AgentServer & unregister_agent(const std::string & route) +``` + +## Parameters + + + +## Returns + +`AgentServer &` + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 31. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/index.mdx b/fern/products/sdk-reference/cpp/signalwire/server/index.mdx new file mode 100644 index 0000000000..eaa9d4d165 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/server" +title: "server" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::server" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp" +--- +# `server` + +## Signature + +```cpp +namespace signalwire::server +``` + +## Type Aliases + + + + + +## Classes + + + + Multi-agent hosting server. + + + +## Source + +[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/server/json.mdx b/fern/products/sdk-reference/cpp/signalwire/server/json.mdx new file mode 100644 index 0000000000..9adb7daffd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/server/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/server/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::server::json" + parent: "signalwire::server" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/server/agent_server.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/server/agent_server.hpp) + +Line 19. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/get-datamap-functions.mdx new file mode 100644 index 0000000000..e005007954 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkillR::get_datamap_functions" + parent: "signalwire::skills::ApiNinjasTriviaSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 383. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/index.mdx new file mode 100644 index 0000000000..e4339f8214 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r" +title: "ApiNinjasTriviaSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `ApiNinjasTriviaSkillR` + +## Signature + +```cpp +class signalwire::skills::ApiNinjasTriviaSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 383. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/register-tools.mdx new file mode 100644 index 0000000000..f6126dda1c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkillR::register_tools" + parent: "signalwire::skills::ApiNinjasTriviaSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 383. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/setup.mdx new file mode 100644 index 0000000000..46672da44b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkillR::setup" + parent: "signalwire::skills::ApiNinjasTriviaSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 383. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/skill-description.mdx new file mode 100644 index 0000000000..de54ca452d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkillR::skill_description" + parent: "signalwire::skills::ApiNinjasTriviaSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 383. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/skill-name.mdx new file mode 100644 index 0000000000..c94858e1aa --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkillR::skill_name" + parent: "signalwire::skills::ApiNinjasTriviaSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 383. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/supports-multiple-instances.mdx new file mode 100644 index 0000000000..51d90b86a5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill-r/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkillR::supports_multiple_instances" + parent: "signalwire::skills::ApiNinjasTriviaSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 383. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/get-datamap-functions.mdx new file mode 100644 index 0000000000..d9b3d37dc2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkill::get_datamap_functions" + parent: "signalwire::skills::ApiNinjasTriviaSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp) + +Line 25. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/index.mdx new file mode 100644 index 0000000000..263b862c85 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill" +title: "ApiNinjasTriviaSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp" + visibility: "public" +--- +# `ApiNinjasTriviaSkill` + +## Signature + +```cpp +class signalwire::skills::ApiNinjasTriviaSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/api_ninjas_trivia.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp) + +Line 10. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/register-tools.mdx new file mode 100644 index 0000000000..06afa2f707 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkill::register_tools" + parent: "signalwire::skills::ApiNinjasTriviaSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp) + +Line 23. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/setup.mdx new file mode 100644 index 0000000000..63407bcfbc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkill::setup" + parent: "signalwire::skills::ApiNinjasTriviaSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp) + +Line 16. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/skill-description.mdx new file mode 100644 index 0000000000..ee31502b24 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkill::skill_description" + parent: "signalwire::skills::ApiNinjasTriviaSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp) + +Line 13. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/skill-name.mdx new file mode 100644 index 0000000000..448779d3fe --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkill::skill_name" + parent: "signalwire::skills::ApiNinjasTriviaSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..7ecead14a3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/api-ninjas-trivia-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/api-ninjas-trivia-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ApiNinjasTriviaSkill::supports_multiple_instances" + parent: "signalwire::skills::ApiNinjasTriviaSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/api_ninjas_trivia.cpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/index.mdx new file mode 100644 index 0000000000..fb58636015 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill-r" +title: "ClaudeSkillsSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `ClaudeSkillsSkillR` + +## Signature + +```cpp +class signalwire::skills::ClaudeSkillsSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 389. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/register-tools.mdx new file mode 100644 index 0000000000..cd2e714f78 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkillR::register_tools" + parent: "signalwire::skills::ClaudeSkillsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 389. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/setup.mdx new file mode 100644 index 0000000000..0e8e5029b9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkillR::setup" + parent: "signalwire::skills::ClaudeSkillsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 389. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/skill-description.mdx new file mode 100644 index 0000000000..9e0ed56706 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkillR::skill_description" + parent: "signalwire::skills::ClaudeSkillsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 389. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/skill-name.mdx new file mode 100644 index 0000000000..54a86aa108 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkillR::skill_name" + parent: "signalwire::skills::ClaudeSkillsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 389. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/supports-multiple-instances.mdx new file mode 100644 index 0000000000..c48c4f776b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill-r/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill-r/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkillR::supports_multiple_instances" + parent: "signalwire::skills::ClaudeSkillsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 389. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/get-hints.mdx new file mode 100644 index 0000000000..390231a311 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkill::get_hints" + parent: "signalwire::skills::ClaudeSkillsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`src/skills/builtin/claude_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp) + +Line 37. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/index.mdx new file mode 100644 index 0000000000..6fff0d3471 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill" +title: "ClaudeSkillsSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp" + visibility: "public" +--- +# `ClaudeSkillsSkill` + +## Signature + +```cpp +class signalwire::skills::ClaudeSkillsSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get speech recognition hints to merge into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/claude_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp) + +Line 9. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/register-tools.mdx new file mode 100644 index 0000000000..3cfe0437bf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkill::register_tools" + parent: "signalwire::skills::ClaudeSkillsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/claude_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/setup.mdx new file mode 100644 index 0000000000..7fd95528ff --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkill::setup" + parent: "signalwire::skills::ClaudeSkillsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/claude_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp) + +Line 15. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/skill-description.mdx new file mode 100644 index 0000000000..5ecc3bce30 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkill::skill_description" + parent: "signalwire::skills::ClaudeSkillsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/claude_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/skill-name.mdx new file mode 100644 index 0000000000..03949f25cd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkill::skill_name" + parent: "signalwire::skills::ClaudeSkillsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/claude_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp) + +Line 11. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..e719fabc5a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/claude-skills-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/claude-skills-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::ClaudeSkillsSkill::supports_multiple_instances" + parent: "signalwire::skills::ClaudeSkillsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/claude_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/claude_skills.cpp) + +Line 13. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/index.mdx new file mode 100644 index 0000000000..e63af6de0a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill-r" +title: "CustomSkillsSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `CustomSkillsSkillR` + +## Signature + +```cpp +class signalwire::skills::CustomSkillsSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 393. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/register-tools.mdx new file mode 100644 index 0000000000..4a2efcaa3a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkillR::register_tools" + parent: "signalwire::skills::CustomSkillsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 393. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/setup.mdx new file mode 100644 index 0000000000..1a518cc6df --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkillR::setup" + parent: "signalwire::skills::CustomSkillsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 393. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/skill-description.mdx new file mode 100644 index 0000000000..0573711dc1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkillR::skill_description" + parent: "signalwire::skills::CustomSkillsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 393. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/skill-name.mdx new file mode 100644 index 0000000000..73f1331019 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkillR::skill_name" + parent: "signalwire::skills::CustomSkillsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 393. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/supports-multiple-instances.mdx new file mode 100644 index 0000000000..10de90f8eb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill-r/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill-r/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkillR::supports_multiple_instances" + parent: "signalwire::skills::CustomSkillsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 393. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/index.mdx new file mode 100644 index 0000000000..b671e3aab8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill" +title: "CustomSkillsSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp" + visibility: "public" +--- +# `CustomSkillsSkill` + +## Signature + +```cpp +class signalwire::skills::CustomSkillsSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/custom_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp) + +Line 9. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/register-tools.mdx new file mode 100644 index 0000000000..5dc696f43e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkill::register_tools" + parent: "signalwire::skills::CustomSkillsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/custom_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp) + +Line 20. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/setup.mdx new file mode 100644 index 0000000000..99c8850fa9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkill::setup" + parent: "signalwire::skills::CustomSkillsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/custom_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp) + +Line 15. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/skill-description.mdx new file mode 100644 index 0000000000..a10d234787 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkill::skill_description" + parent: "signalwire::skills::CustomSkillsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/custom_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/skill-name.mdx new file mode 100644 index 0000000000..42e689f452 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkill::skill_name" + parent: "signalwire::skills::CustomSkillsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/custom_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp) + +Line 11. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..c8c2e23272 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/custom-skills-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/custom-skills-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::CustomSkillsSkill::supports_multiple_instances" + parent: "signalwire::skills::CustomSkillsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/custom_skills.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/custom_skills.cpp) + +Line 13. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/get-datamap-functions.mdx new file mode 100644 index 0000000000..1369ca5686 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill-r/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkillR::get_datamap_functions" + parent: "signalwire::skills::DatasphereServerlessSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 377. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/index.mdx new file mode 100644 index 0000000000..fab96bdcf6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill-r" +title: "DatasphereServerlessSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `DatasphereServerlessSkillR` + +## Signature + +```cpp +class signalwire::skills::DatasphereServerlessSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 377. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/register-tools.mdx new file mode 100644 index 0000000000..3f07a45519 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkillR::register_tools" + parent: "signalwire::skills::DatasphereServerlessSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 377. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/setup.mdx new file mode 100644 index 0000000000..0b1c928d0d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkillR::setup" + parent: "signalwire::skills::DatasphereServerlessSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 377. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/skill-description.mdx new file mode 100644 index 0000000000..c720c8f4f7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkillR::skill_description" + parent: "signalwire::skills::DatasphereServerlessSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 377. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/skill-name.mdx new file mode 100644 index 0000000000..cded50c55f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkillR::skill_name" + parent: "signalwire::skills::DatasphereServerlessSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 377. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/supports-multiple-instances.mdx new file mode 100644 index 0000000000..b1e5bead84 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill-r/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill-r/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkillR::supports_multiple_instances" + parent: "signalwire::skills::DatasphereServerlessSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 377. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/get-datamap-functions.mdx new file mode 100644 index 0000000000..7f0d35a3f8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkill::get_datamap_functions" + parent: "signalwire::skills::DatasphereServerlessSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/builtin/datasphere_serverless.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp) + +Line 31. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/get-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/get-global-data.mdx new file mode 100644 index 0000000000..679b984a6b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/get-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill/get-global-data" +title: "get_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkill::get_global_data" + parent: "signalwire::skills::DatasphereServerlessSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp" + visibility: "public" +--- +# `get_global_data` + +Get global data to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +json get_global_data() const +``` + +## Returns + +`json` + +## Source + +[`src/skills/builtin/datasphere_serverless.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp) + +Line 58. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..86ae33335e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkill::get_prompt_sections" + parent: "signalwire::skills::DatasphereServerlessSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/builtin/datasphere_serverless.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp) + +Line 52. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/index.mdx new file mode 100644 index 0000000000..13f38399bf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill" +title: "DatasphereServerlessSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp" + visibility: "public" +--- +# `DatasphereServerlessSkill` + +## Signature + +```cpp +class signalwire::skills::DatasphereServerlessSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Get global data to merge into agent. + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/datasphere_serverless.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp) + +Line 11. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/register-tools.mdx new file mode 100644 index 0000000000..c1edc252cc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkill::register_tools" + parent: "signalwire::skills::DatasphereServerlessSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/datasphere_serverless.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp) + +Line 29. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/setup.mdx new file mode 100644 index 0000000000..84f5e9c328 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkill::setup" + parent: "signalwire::skills::DatasphereServerlessSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/datasphere_serverless.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp) + +Line 19. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/skill-description.mdx new file mode 100644 index 0000000000..98cdc45467 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkill::skill_description" + parent: "signalwire::skills::DatasphereServerlessSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/datasphere_serverless.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/skill-name.mdx new file mode 100644 index 0000000000..3201c96bdb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkill::skill_name" + parent: "signalwire::skills::DatasphereServerlessSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/datasphere_serverless.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp) + +Line 13. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..c2306cd6fd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-serverless-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-serverless-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereServerlessSkill::supports_multiple_instances" + parent: "signalwire::skills::DatasphereServerlessSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/datasphere_serverless.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere_serverless.cpp) + +Line 17. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/get-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/get-global-data.mdx new file mode 100644 index 0000000000..2c2733a5b4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/get-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill-r/get-global-data" +title: "get_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkillR::get_global_data" + parent: "signalwire::skills::DatasphereSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_global_data` + +Get global data to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +json get_global_data() const +``` + +## Returns + +`json` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 374. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/index.mdx new file mode 100644 index 0000000000..e42c8bbf0d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill-r" +title: "DatasphereSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `DatasphereSkillR` + +## Signature + +```cpp +class signalwire::skills::DatasphereSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get global data to merge into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 296. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/register-tools.mdx new file mode 100644 index 0000000000..1c0cb21acc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkillR::register_tools" + parent: "signalwire::skills::DatasphereSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 316. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/setup.mdx new file mode 100644 index 0000000000..edb96eb3f1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkillR::setup" + parent: "signalwire::skills::DatasphereSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 304. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/skill-description.mdx new file mode 100644 index 0000000000..4ea22bf247 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkillR::skill_description" + parent: "signalwire::skills::DatasphereSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 302. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/skill-name.mdx new file mode 100644 index 0000000000..32f1d12a3a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkillR::skill_name" + parent: "signalwire::skills::DatasphereSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 301. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/supports-multiple-instances.mdx new file mode 100644 index 0000000000..94ee00bdb7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill-r/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill-r/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkillR::supports_multiple_instances" + parent: "signalwire::skills::DatasphereSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 303. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/get-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/get-global-data.mdx new file mode 100644 index 0000000000..f52945d50c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/get-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill/get-global-data" +title: "get_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkill::get_global_data" + parent: "signalwire::skills::DatasphereSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp" + visibility: "public" +--- +# `get_global_data` + +Get global data to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +json get_global_data() const +``` + +## Returns + +`json` + +## Source + +[`src/skills/builtin/datasphere.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp) + +Line 106. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..8186be9cc7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkill::get_prompt_sections" + parent: "signalwire::skills::DatasphereSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/builtin/datasphere.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp) + +Line 99. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/index.mdx new file mode 100644 index 0000000000..24ac5ac9fc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill" +title: "DatasphereSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp" + visibility: "public" +--- +# `DatasphereSkill` + +SignalWire DataSphere RAG search skill — issues a real POST against the DataSphere /api/datasphere/documents/\{document\_id\}/search endpoint with the user query in the JSON body, parses the results\[] array, and returns a flattened text summary. Matches the Python DatasphereSkill upstream-call shape. +DATASPHERE\_BASE\_URL env var overrides the upstream URL (used by audit\_skills\_dispatch.py); when unset, the real upstream is built from space\_name (https://\{space\}.signalwire.com). + +## Signature + +```cpp +class signalwire::skills::DatasphereSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get global data to merge into agent. + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/datasphere.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/register-tools.mdx new file mode 100644 index 0000000000..e4baa1bd0e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkill::register_tools" + parent: "signalwire::skills::DatasphereSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/datasphere.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp) + +Line 42. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/setup.mdx new file mode 100644 index 0000000000..ddef9469b2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkill::setup" + parent: "signalwire::skills::DatasphereSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/datasphere.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp) + +Line 30. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/skill-description.mdx new file mode 100644 index 0000000000..9918ad076f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkill::skill_description" + parent: "signalwire::skills::DatasphereSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/datasphere.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp) + +Line 25. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/skill-name.mdx new file mode 100644 index 0000000000..397d3037ee --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkill::skill_name" + parent: "signalwire::skills::DatasphereSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/datasphere.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..a8f0c75909 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/datasphere-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/datasphere-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DatasphereSkill::supports_multiple_instances" + parent: "signalwire::skills::DatasphereSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/datasphere.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datasphere.cpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..d23a01990a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/date-time-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DateTimeSkill::get_prompt_sections" + parent: "signalwire::skills::DateTimeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/builtin/datetime.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp) + +Line 74. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/index.mdx new file mode 100644 index 0000000000..9f4ab65d0a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/date-time-skill" +title: "DateTimeSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::DateTimeSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp" + visibility: "public" +--- +# `DateTimeSkill` + +## Signature + +```cpp +class signalwire::skills::DateTimeSkill : signalwire::skills::SkillBase, signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base), [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/datetime.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp) + +Line 13. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/register-tools.mdx new file mode 100644 index 0000000000..7bf363613c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/date-time-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DateTimeSkill::register_tools" + parent: "signalwire::skills::DateTimeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/datetime.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/setup.mdx new file mode 100644 index 0000000000..b43b2497e9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/date-time-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DateTimeSkill::setup" + parent: "signalwire::skills::DateTimeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/datetime.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp) + +Line 19. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/skill-description.mdx new file mode 100644 index 0000000000..1d03139d4a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/date-time-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DateTimeSkill::skill_description" + parent: "signalwire::skills::DateTimeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/datetime.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp) + +Line 16. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/skill-name.mdx new file mode 100644 index 0000000000..7ebeae4f00 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/date-time-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DateTimeSkill::skill_name" + parent: "signalwire::skills::DateTimeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/datetime.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp) + +Line 15. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..45c6f2acb9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/date-time-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/date-time-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::DateTimeSkill::supports_multiple_instances" + parent: "signalwire::skills::DateTimeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/datetime.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/datetime.cpp) + +Line 17. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/ensure-builtin-skills-registered.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/ensure-builtin-skills-registered.mdx new file mode 100644 index 0000000000..e075b8c86b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/ensure-builtin-skills-registered.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/skills/ensure-builtin-skills-registered" +title: "ensure_builtin_skills_registered" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::skills::ensure_builtin_skills_registered" + parent: "signalwire::skills" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `ensure_builtin_skills_registered` + +Ensure all built-in skills are registered. Called automatically but can be called explicitly to force linkage. + +## Signature + +```cpp +void ensure_builtin_skills_registered() +``` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 426. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/get-hints.mdx new file mode 100644 index 0000000000..3f6f6cb24a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill-r/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkillR::get_hints" + parent: "signalwire::skills::GoogleMapsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 226. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/index.mdx new file mode 100644 index 0000000000..eedd778cd9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill-r" +title: "GoogleMapsSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `GoogleMapsSkillR` + +## Signature + +```cpp +class signalwire::skills::GoogleMapsSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get speech recognition hints to merge into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 226. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/register-tools.mdx new file mode 100644 index 0000000000..db0d20b558 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkillR::register_tools" + parent: "signalwire::skills::GoogleMapsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 226. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/setup.mdx new file mode 100644 index 0000000000..188fdd2d5a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkillR::setup" + parent: "signalwire::skills::GoogleMapsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 226. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/skill-description.mdx new file mode 100644 index 0000000000..17cfa2d309 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkillR::skill_description" + parent: "signalwire::skills::GoogleMapsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 226. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/skill-name.mdx new file mode 100644 index 0000000000..f1fe080798 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkillR::skill_name" + parent: "signalwire::skills::GoogleMapsSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 226. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/get-hints.mdx new file mode 100644 index 0000000000..ac9f316303 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkill::get_hints" + parent: "signalwire::skills::GoogleMapsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`src/skills/builtin/google_maps.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp) + +Line 53. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..7b9724164c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkill::get_prompt_sections" + parent: "signalwire::skills::GoogleMapsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/builtin/google_maps.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp) + +Line 57. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/index.mdx new file mode 100644 index 0000000000..820faa671d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill" +title: "GoogleMapsSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp" + visibility: "public" +--- +# `GoogleMapsSkill` + +## Signature + +```cpp +class signalwire::skills::GoogleMapsSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get speech recognition hints to merge into agent. + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + +## Source + +[`src/skills/builtin/google_maps.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp) + +Line 9. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/register-tools.mdx new file mode 100644 index 0000000000..c185b2d3a8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkill::register_tools" + parent: "signalwire::skills::GoogleMapsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/google_maps.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/setup.mdx new file mode 100644 index 0000000000..09b7928339 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkill::setup" + parent: "signalwire::skills::GoogleMapsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/google_maps.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp) + +Line 16. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/skill-description.mdx new file mode 100644 index 0000000000..8647c7ddf5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkill::skill_description" + parent: "signalwire::skills::GoogleMapsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/google_maps.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/skill-name.mdx new file mode 100644 index 0000000000..daef2051f5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/google-maps-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/google-maps-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::GoogleMapsSkill::skill_name" + parent: "signalwire::skills::GoogleMapsSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/google_maps.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/google_maps.cpp) + +Line 11. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/http-get.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/http-get.mdx new file mode 100644 index 0000000000..72d577b5a3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/http-get.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/skills/http-get" +title: "http_get" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::skills::http_get" + parent: "signalwire::skills" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skills_http.cpp" + visibility: "public" +--- +# `http_get` + +Issue a real HTTP GET. Implementation uses cpp-httplib so it works against any plain-HTTP host (including loopback fixtures used by the audit\_skills\_dispatch.py audit). Skills that need TLS to reach production upstreams set the appropriate base-URL env var (e.g. WEB\_SEARCH\_BASE\_URL) — production deployments point at TLS proxies or a dev-side rewriter; the SDK keeps its transport stack OpenSSL-3 independent until the wider port adopts it. + +## Signature + +```cpp +SkillHttpResponse http_get( + const std::string & url, + const std::map< std::string, std::string > & headers = {}, + int timeout_seconds = 10 +) +``` + +## Parameters + + + + + + + +## Returns + +`SkillHttpResponse` + +## Source + +[`src/skills/skills_http.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skills_http.cpp) + +Line 53. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/http-post.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/http-post.mdx new file mode 100644 index 0000000000..91d88262d5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/http-post.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/skills/http-post" +title: "http_post" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::skills::http_post" + parent: "signalwire::skills" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skills_http.cpp" + visibility: "public" +--- +# `http_post` + +Issue a real HTTP POST with body as the request body and content\_type for Content-Type. Same semantics as http\_get for status / error / body. + +## Signature + +```cpp +SkillHttpResponse http_post( + const std::string & url, + const std::string & body, + const std::string & content_type = "application/json", + const std::map< std::string, std::string > & headers = {}, + int timeout_seconds = 10 +) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SkillHttpResponse` + +## Source + +[`src/skills/skills_http.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skills_http.cpp) + +Line 76. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/index.mdx new file mode 100644 index 0000000000..82a3b5e7a3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/index.mdx @@ -0,0 +1,155 @@ +--- +slug: "/reference/cpp/signalwire/skills" +title: "skills" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::skills" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" +--- +# `skills` + +## Signature + +```cpp +namespace signalwire::skills +``` + +## Functions + + + + Ensure all built-in skills are registered. Called automatically but can be called explicitly to force linkage. + + + + Issue a real HTTP GET. Implementation uses cpp-httplib so it works against any plain-HTTP host (including loopback fixtures used by the audit\_skills\_dispatch.py audit). Skills that need TLS to reach production upstreams set the appropriate base-URL env var (e.g. WEB\_SEARCH\_BASE\_URL) — production deployments point at TLS proxies or a dev-side rewriter; the SDK keeps its transport stack OpenSSL-3 independent until the wider port adopts it. + + + + Issue a real HTTP POST with body as the request body and content\_type for Content-Type. Same semantics as http\_get for status / error / body. + + + +## Type Aliases + + + + + + Factory function type for creating skill instances. + + + +## Classes + + + + + + + + + + + + + + + + + + + + SignalWire DataSphere RAG search skill — issues a real POST against the DataSphere /api/datasphere/documents/\{document\_id\}/search endpoint with the user query in the JSON body, parses the results\[] array, and returns a flattened text summary. Matches the Python DatasphereSkill upstream-call shape. DATASPHERE\_BASE\_URL env var overrides the upstream URL (used by audit\_skills\_dispatch.py); when unset, the real upstream is built from space\_name (https://\{space\}.signalwire.com). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Abstract base class for all skills. + + + + Result of a skill HTTP request. status is the HTTP status code (0 indicates a transport-level error — connection refused, DNS, etc.). body is the raw response body. error is non-empty when status is 0. + + + + Manages skill lifecycle: creation, setup, registration with agents. + + + + POM section for skill prompts. + + + + Global registry of skill factories. + + + + Spider scrape skill — issues a real GET against the URL the LLM passes in. Strips HTML tags from the response and returns the text payload. Matches Python SpiderSkill's scrape\_url behavior. SPIDER\_BASE\_URL env var overrides the host portion of the URL the caller passes in (used by audit\_skills\_dispatch.py to redirect scrape requests at a loopback fixture). + + + + + + + + + + + + + + Google Custom Search API skill — issues a real GET against Google's customsearch/v1 endpoint, parses the items\[] results, and returns a human-readable summary. Matches Python's WebSearchSkill behavior. Configuration: api\_key (or env GOOGLE\_SEARCH\_API\_KEY / GOOGLE\_API\_KEY) search\_engine\_id (or env GOOGLE\_SEARCH\_ENGINE\_ID / GOOGLE\_CSE\_ID) num\_results (default 3) tool\_name (default "web\_search") WEB\_SEARCH\_BASE\_URL env var overrides the upstream URL (used by audit\_skills\_dispatch.py to point the skill at a fixture) + + + + + + Wikipedia search skill — issues a real GET against the Wikipedia API /w/api.php endpoint with action=query\&list=search, parses the query.search\[] results, and returns titles + snippets. Matches the Python WikipediaSearchSkill upstream call shape. WIKIPEDIA\_BASE\_URL env var overrides the API root (used by audit\_skills\_dispatch.py to point the skill at its loopback fixture). + + + + + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/get-instance-key.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/get-instance-key.mdx new file mode 100644 index 0000000000..6e10e0a904 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/get-instance-key.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill-r/get-instance-key" +title: "get_instance_key" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkillR::get_instance_key" + parent: "signalwire::skills::InfoGathererSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_instance_key` + +Get instance key for multi-instance skills. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string get_instance_key() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 387. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/index.mdx new file mode 100644 index 0000000000..7b5263c6f2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill-r" +title: "InfoGathererSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `InfoGathererSkillR` + +## Signature + +```cpp +class signalwire::skills::InfoGathererSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get instance key for multi-instance skills. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 387. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/register-tools.mdx new file mode 100644 index 0000000000..a01e3a4097 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkillR::register_tools" + parent: "signalwire::skills::InfoGathererSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 387. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/setup.mdx new file mode 100644 index 0000000000..8b1f701c11 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkillR::setup" + parent: "signalwire::skills::InfoGathererSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 387. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/skill-description.mdx new file mode 100644 index 0000000000..74b44b44c7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkillR::skill_description" + parent: "signalwire::skills::InfoGathererSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 387. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/skill-name.mdx new file mode 100644 index 0000000000..3ea345b229 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkillR::skill_name" + parent: "signalwire::skills::InfoGathererSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 387. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/supports-multiple-instances.mdx new file mode 100644 index 0000000000..549360f4fc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill-r/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill-r/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkillR::supports_multiple_instances" + parent: "signalwire::skills::InfoGathererSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 387. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/get-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/get-global-data.mdx new file mode 100644 index 0000000000..c36d5ec095 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/get-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill/get-global-data" +title: "get_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkill::get_global_data" + parent: "signalwire::skills::InfoGathererSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp" + visibility: "public" +--- +# `get_global_data` + +Get global data to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +json get_global_data() const +``` + +## Returns + +`json` + +## Source + +[`src/skills/builtin/info_gatherer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp) + +Line 110. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/get-instance-key.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/get-instance-key.mdx new file mode 100644 index 0000000000..81f4b093d2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/get-instance-key.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkill::get_instance_key" + parent: "signalwire::skills::InfoGathererSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp" + visibility: "public" +--- +# `get_instance_key` + +Get instance key for multi-instance skills. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string get_instance_key() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/info_gatherer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp) + +Line 131. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..38397648e9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkill::get_prompt_sections" + parent: "signalwire::skills::InfoGathererSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/builtin/info_gatherer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp) + +Line 122. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/index.mdx new file mode 100644 index 0000000000..79fd25fbde --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill" +title: "InfoGathererSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp" + visibility: "public" +--- +# `InfoGathererSkill` + +## Signature + +```cpp +class signalwire::skills::InfoGathererSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get global data to merge into agent. + + + + Get instance key for multi-instance skills. + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/info_gatherer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp) + +Line 9. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/register-tools.mdx new file mode 100644 index 0000000000..58dcaa331d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkill::register_tools" + parent: "signalwire::skills::InfoGathererSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/info_gatherer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp) + +Line 25. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/setup.mdx new file mode 100644 index 0000000000..7a00bf70cc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkill::setup" + parent: "signalwire::skills::InfoGathererSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/info_gatherer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp) + +Line 17. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/skill-description.mdx new file mode 100644 index 0000000000..75002b2593 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkill::skill_description" + parent: "signalwire::skills::InfoGathererSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/info_gatherer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/skill-name.mdx new file mode 100644 index 0000000000..23375c6ada --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkill::skill_name" + parent: "signalwire::skills::InfoGathererSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/info_gatherer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp) + +Line 11. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..8179ed20fa --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/info-gatherer-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/info-gatherer-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::InfoGathererSkill::supports_multiple_instances" + parent: "signalwire::skills::InfoGathererSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/info_gatherer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/info_gatherer.cpp) + +Line 15. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/get-datamap-functions.mdx new file mode 100644 index 0000000000..c8e4dda55d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill-r/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkillR::get_datamap_functions" + parent: "signalwire::skills::JokeSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 72. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/get-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/get-global-data.mdx new file mode 100644 index 0000000000..639578ab7a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/get-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill-r/get-global-data" +title: "get_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkillR::get_global_data" + parent: "signalwire::skills::JokeSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_global_data` + +Get global data to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +json get_global_data() const +``` + +## Returns + +`json` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 74. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/get-prompt-sections.mdx new file mode 100644 index 0000000000..71d8665f4b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill-r/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkillR::get_prompt_sections" + parent: "signalwire::skills::JokeSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 73. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/index.mdx new file mode 100644 index 0000000000..a21cb396f0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill-r" +title: "JokeSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `JokeSkillR` + +## Signature + +```cpp +class signalwire::skills::JokeSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Get global data to merge into agent. + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 65. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/register-tools.mdx new file mode 100644 index 0000000000..97cb5ed51c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkillR::register_tools" + parent: "signalwire::skills::JokeSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 71. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/setup.mdx new file mode 100644 index 0000000000..c53cc48c4f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkillR::setup" + parent: "signalwire::skills::JokeSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 70. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/skill-description.mdx new file mode 100644 index 0000000000..87c5d4575a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkillR::skill_description" + parent: "signalwire::skills::JokeSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 69. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/skill-name.mdx new file mode 100644 index 0000000000..93f4e687f3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkillR::skill_name" + parent: "signalwire::skills::JokeSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 68. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/get-datamap-functions.mdx new file mode 100644 index 0000000000..d41747739a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkill::get_datamap_functions" + parent: "signalwire::skills::JokeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/builtin/joke.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/get-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/get-global-data.mdx new file mode 100644 index 0000000000..b4bf7cb2c3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/get-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill/get-global-data" +title: "get_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkill::get_global_data" + parent: "signalwire::skills::JokeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp" + visibility: "public" +--- +# `get_global_data` + +Get global data to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +json get_global_data() const +``` + +## Returns + +`json` + +## Source + +[`src/skills/builtin/joke.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp) + +Line 41. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..e414a6e61e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkill::get_prompt_sections" + parent: "signalwire::skills::JokeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/builtin/joke.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp) + +Line 36. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/index.mdx new file mode 100644 index 0000000000..53827604c8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill" +title: "JokeSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp" + visibility: "public" +--- +# `JokeSkill` + +## Signature + +```cpp +class signalwire::skills::JokeSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Get global data to merge into agent. + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + +## Source + +[`src/skills/builtin/joke.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp) + +Line 10. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/register-tools.mdx new file mode 100644 index 0000000000..6391279df2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkill::register_tools" + parent: "signalwire::skills::JokeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/joke.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/setup.mdx new file mode 100644 index 0000000000..673a507bb6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkill::setup" + parent: "signalwire::skills::JokeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/joke.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp) + +Line 15. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/skill-description.mdx new file mode 100644 index 0000000000..92c690cd7f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkill::skill_description" + parent: "signalwire::skills::JokeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/joke.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp) + +Line 13. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/skill-name.mdx new file mode 100644 index 0000000000..ea0af1da6c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/joke-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/joke-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::JokeSkill::skill_name" + parent: "signalwire::skills::JokeSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/joke.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/joke.cpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/json.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/json.mdx new file mode 100644 index 0000000000..2bdcaec157 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/skills/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::skills::json" + parent: "signalwire::skills" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 16. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/get-prompt-sections.mdx new file mode 100644 index 0000000000..ce71cbf6d4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill-r/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::MathSkillR::get_prompt_sections" + parent: "signalwire::skills::MathSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 61. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/index.mdx new file mode 100644 index 0000000000..49e933bae3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill-r" +title: "MathSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::MathSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `MathSkillR` + +## Signature + +```cpp +class signalwire::skills::MathSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 40. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/register-tools.mdx new file mode 100644 index 0000000000..c065c147dd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::MathSkillR::register_tools" + parent: "signalwire::skills::MathSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 57. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/setup.mdx new file mode 100644 index 0000000000..6440329b91 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::MathSkillR::setup" + parent: "signalwire::skills::MathSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 56. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/skill-description.mdx new file mode 100644 index 0000000000..aa931a155e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::MathSkillR::skill_description" + parent: "signalwire::skills::MathSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 55. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/skill-name.mdx new file mode 100644 index 0000000000..41475eede2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::MathSkillR::skill_name" + parent: "signalwire::skills::MathSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 54. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..0d3189ee52 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::MathSkill::get_prompt_sections" + parent: "signalwire::skills::MathSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/builtin/math.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp) + +Line 139. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/index.mdx new file mode 100644 index 0000000000..d88c01e269 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill" +title: "MathSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::MathSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp" + visibility: "public" +--- +# `MathSkill` + +## Signature + +```cpp +class signalwire::skills::MathSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/math.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp) + +Line 100. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/register-tools.mdx new file mode 100644 index 0000000000..17bda5f877 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::MathSkill::register_tools" + parent: "signalwire::skills::MathSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/math.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp) + +Line 108. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/setup.mdx new file mode 100644 index 0000000000..aed3d788ef --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::MathSkill::setup" + parent: "signalwire::skills::MathSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/math.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp) + +Line 106. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/skill-description.mdx new file mode 100644 index 0000000000..104eb6443f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::MathSkill::skill_description" + parent: "signalwire::skills::MathSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/math.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp) + +Line 103. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/skill-name.mdx new file mode 100644 index 0000000000..f4f2dc0058 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::MathSkill::skill_name" + parent: "signalwire::skills::MathSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/math.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp) + +Line 102. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..6f4a388d46 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/math-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/math-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::MathSkill::supports_multiple_instances" + parent: "signalwire::skills::MathSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/math.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/math.cpp) + +Line 104. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/get-hints.mdx new file mode 100644 index 0000000000..b2a7654539 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill-r/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkillR::get_hints" + parent: "signalwire::skills::McpGatewaySkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 391. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/index.mdx new file mode 100644 index 0000000000..1f1d275589 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill-r" +title: "McpGatewaySkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `McpGatewaySkillR` + +## Signature + +```cpp +class signalwire::skills::McpGatewaySkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get speech recognition hints to merge into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 391. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/register-tools.mdx new file mode 100644 index 0000000000..5314255cf3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkillR::register_tools" + parent: "signalwire::skills::McpGatewaySkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 391. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/setup.mdx new file mode 100644 index 0000000000..0fe17c29f2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkillR::setup" + parent: "signalwire::skills::McpGatewaySkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 391. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/skill-description.mdx new file mode 100644 index 0000000000..7538875fe9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkillR::skill_description" + parent: "signalwire::skills::McpGatewaySkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 391. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/skill-name.mdx new file mode 100644 index 0000000000..e621032900 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkillR::skill_name" + parent: "signalwire::skills::McpGatewaySkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 391. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/get-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/get-global-data.mdx new file mode 100644 index 0000000000..223754bd03 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/get-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill/get-global-data" +title: "get_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkill::get_global_data" + parent: "signalwire::skills::McpGatewaySkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp" + visibility: "public" +--- +# `get_global_data` + +Get global data to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +json get_global_data() const +``` + +## Returns + +`json` + +## Source + +[`src/skills/builtin/mcp_gateway.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp) + +Line 55. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/get-hints.mdx new file mode 100644 index 0000000000..38520f113b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkill::get_hints" + parent: "signalwire::skills::McpGatewaySkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`src/skills/builtin/mcp_gateway.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp) + +Line 45. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..0db510745f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkill::get_prompt_sections" + parent: "signalwire::skills::McpGatewaySkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/builtin/mcp_gateway.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp) + +Line 69. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/index.mdx new file mode 100644 index 0000000000..6ef0338ee1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill" +title: "McpGatewaySkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp" + visibility: "public" +--- +# `McpGatewaySkill` + +## Signature + +```cpp +class signalwire::skills::McpGatewaySkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get global data to merge into agent. + + + + Get speech recognition hints to merge into agent. + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + +## Source + +[`src/skills/builtin/mcp_gateway.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp) + +Line 9. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/register-tools.mdx new file mode 100644 index 0000000000..52b4e8861d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkill::register_tools" + parent: "signalwire::skills::McpGatewaySkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/mcp_gateway.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp) + +Line 21. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/setup.mdx new file mode 100644 index 0000000000..ecb6a0c3f0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkill::setup" + parent: "signalwire::skills::McpGatewaySkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/mcp_gateway.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/skill-description.mdx new file mode 100644 index 0000000000..fdf5ee45a1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkill::skill_description" + parent: "signalwire::skills::McpGatewaySkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/mcp_gateway.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/skill-name.mdx new file mode 100644 index 0000000000..fe3f462277 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/mcp-gateway-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/mcp-gateway-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::McpGatewaySkill::skill_name" + parent: "signalwire::skills::McpGatewaySkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/mcp_gateway.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/mcp_gateway.cpp) + +Line 11. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/get-hints.mdx new file mode 100644 index 0000000000..6a3a4f2e27 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill-r/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkillR::get_hints" + parent: "signalwire::skills::NativeVectorSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 385. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/index.mdx new file mode 100644 index 0000000000..f3b1ba5edd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill-r" +title: "NativeVectorSearchSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `NativeVectorSearchSkillR` + +## Signature + +```cpp +class signalwire::skills::NativeVectorSearchSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get speech recognition hints to merge into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 385. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/register-tools.mdx new file mode 100644 index 0000000000..12a66ad703 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkillR::register_tools" + parent: "signalwire::skills::NativeVectorSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 385. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/setup.mdx new file mode 100644 index 0000000000..2c825fea43 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkillR::setup" + parent: "signalwire::skills::NativeVectorSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 385. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/skill-description.mdx new file mode 100644 index 0000000000..b4fa5c919a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkillR::skill_description" + parent: "signalwire::skills::NativeVectorSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 385. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/skill-name.mdx new file mode 100644 index 0000000000..fce208acdb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkillR::skill_name" + parent: "signalwire::skills::NativeVectorSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 385. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/supports-multiple-instances.mdx new file mode 100644 index 0000000000..c7aa93a595 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill-r/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill-r/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkillR::supports_multiple_instances" + parent: "signalwire::skills::NativeVectorSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 385. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/get-hints.mdx new file mode 100644 index 0000000000..41103be0df --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkill::get_hints" + parent: "signalwire::skills::NativeVectorSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`src/skills/builtin/native_vector_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp) + +Line 44. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/index.mdx new file mode 100644 index 0000000000..727b2f6f46 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill" +title: "NativeVectorSearchSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp" + visibility: "public" +--- +# `NativeVectorSearchSkill` + +## Signature + +```cpp +class signalwire::skills::NativeVectorSearchSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get speech recognition hints to merge into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/native_vector_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp) + +Line 9. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/register-tools.mdx new file mode 100644 index 0000000000..d21500c0bc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkill::register_tools" + parent: "signalwire::skills::NativeVectorSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/native_vector_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp) + +Line 27. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/setup.mdx new file mode 100644 index 0000000000..a551f559c1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkill::setup" + parent: "signalwire::skills::NativeVectorSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/native_vector_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp) + +Line 17. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/skill-description.mdx new file mode 100644 index 0000000000..f5fa6e3d48 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkill::skill_description" + parent: "signalwire::skills::NativeVectorSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/native_vector_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/skill-name.mdx new file mode 100644 index 0000000000..79aae792e1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkill::skill_name" + parent: "signalwire::skills::NativeVectorSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/native_vector_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp) + +Line 11. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..22971e2544 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/native-vector-search-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/native-vector-search-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::NativeVectorSearchSkill::supports_multiple_instances" + parent: "signalwire::skills::NativeVectorSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/native_vector_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/native_vector_search.cpp) + +Line 15. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/get-datamap-functions.mdx new file mode 100644 index 0000000000..bcf2aa7311 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill-r/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkillR::get_datamap_functions" + parent: "signalwire::skills::PlayBackgroundFileSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 381. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/index.mdx new file mode 100644 index 0000000000..159b44ccb8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill-r" +title: "PlayBackgroundFileSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `PlayBackgroundFileSkillR` + +## Signature + +```cpp +class signalwire::skills::PlayBackgroundFileSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 381. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/register-tools.mdx new file mode 100644 index 0000000000..8b9fcb0868 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkillR::register_tools" + parent: "signalwire::skills::PlayBackgroundFileSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 381. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/setup.mdx new file mode 100644 index 0000000000..781a79cb33 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkillR::setup" + parent: "signalwire::skills::PlayBackgroundFileSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 381. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/skill-description.mdx new file mode 100644 index 0000000000..b94e16393e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkillR::skill_description" + parent: "signalwire::skills::PlayBackgroundFileSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 381. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/skill-name.mdx new file mode 100644 index 0000000000..6527f1b9b0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkillR::skill_name" + parent: "signalwire::skills::PlayBackgroundFileSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 381. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/supports-multiple-instances.mdx new file mode 100644 index 0000000000..2eac73f279 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill-r/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill-r/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkillR::supports_multiple_instances" + parent: "signalwire::skills::PlayBackgroundFileSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 381. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/get-datamap-functions.mdx new file mode 100644 index 0000000000..b593d5b0a1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkill::get_datamap_functions" + parent: "signalwire::skills::PlayBackgroundFileSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/builtin/play_background_file.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/index.mdx new file mode 100644 index 0000000000..1230d9ceed --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill" +title: "PlayBackgroundFileSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp" + visibility: "public" +--- +# `PlayBackgroundFileSkill` + +## Signature + +```cpp +class signalwire::skills::PlayBackgroundFileSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/play_background_file.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp) + +Line 10. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/register-tools.mdx new file mode 100644 index 0000000000..b9f76ff8f8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkill::register_tools" + parent: "signalwire::skills::PlayBackgroundFileSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/play_background_file.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/setup.mdx new file mode 100644 index 0000000000..039103deb4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkill::setup" + parent: "signalwire::skills::PlayBackgroundFileSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/play_background_file.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp) + +Line 16. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/skill-description.mdx new file mode 100644 index 0000000000..f3675ed7eb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkill::skill_description" + parent: "signalwire::skills::PlayBackgroundFileSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/play_background_file.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp) + +Line 13. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/skill-name.mdx new file mode 100644 index 0000000000..381a985b83 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkill::skill_name" + parent: "signalwire::skills::PlayBackgroundFileSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/play_background_file.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..471d5b388f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/play-background-file-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/play-background-file-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::PlayBackgroundFileSkill::supports_multiple_instances" + parent: "signalwire::skills::PlayBackgroundFileSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/play_background_file.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/play_background_file.cpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/cleanup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/cleanup.mdx new file mode 100644 index 0000000000..a43fd191e9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/cleanup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/cleanup" +title: "cleanup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::cleanup" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `cleanup` + +Cleanup resources. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +void cleanup() +``` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 70. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/define-tool.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/define-tool.mdx new file mode 100644 index 0000000000..828d44a39f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/define-tool.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/define-tool" +title: "define_tool" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::define_tool" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `define_tool` + +Define a tool (convenience for register\_tools implementations). + +**Modifiers:** `inline` + +## Signature + +```cpp +swaig::ToolDefinition define_tool( + const std::string & name, + const std::string & description, + const json & parameters, + swaig::ToolHandler handler, + bool secure = false +) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`swaig::ToolDefinition` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 77. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-datamap-functions.mdx new file mode 100644 index 0000000000..a05bfb3e6d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::get_datamap_functions" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 61. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-global-data.mdx new file mode 100644 index 0000000000..b149610b94 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/get-global-data" +title: "get_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::get_global_data" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `get_global_data` + +Get global data to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +json get_global_data() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 55. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-hints.mdx new file mode 100644 index 0000000000..e58d1c2e52 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::get_hints" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 52. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-instance-key.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-instance-key.mdx new file mode 100644 index 0000000000..221153db10 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-instance-key.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/get-instance-key" +title: "get_instance_key" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::get_instance_key" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `get_instance_key` + +Get instance key for multi-instance skills. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string get_instance_key() const +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 67. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-param-or-env.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-param-or-env.mdx new file mode 100644 index 0000000000..9d741fa1d1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-param-or-env.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/get-param-or-env" +title: "get_param_or_env" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::get_param_or_env" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `get_param_or_env` + +Get a string parameter with env var fallback. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +std::string get_param_or_env( + const json & params, + const std::string & key, + const std::string & env_var, + const std::string & default_val = "" +) const +``` + +## Parameters + + + + + + + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 102. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-param.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-param.mdx new file mode 100644 index 0000000000..37a5303940 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-param.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/get-param" +title: "get_param" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::get_param" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `get_param` + +Get a parameter value with a default. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +template +T get_param( + const json & params, + const std::string & key, + const T & default_val +) const +``` + +## Type Parameters + + + +## Parameters + + + + + + + +## Returns + +`T` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 94. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-parameter-schema.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-parameter-schema.mdx new file mode 100644 index 0000000000..f5fc067cee --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::get_parameter_schema" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `get_parameter_schema` + +Get parameter schema for GUI tools. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +json get_parameter_schema() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 64. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-prompt-sections.mdx new file mode 100644 index 0000000000..4c6b790a57 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::get_prompt_sections" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 58. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/index.mdx new file mode 100644 index 0000000000..f01f78d211 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/index.mdx @@ -0,0 +1,96 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base" +title: "SkillBase" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `SkillBase` + +Abstract base class for all skills. + +## Signature + +```cpp +class signalwire::skills::SkillBase +``` + +## Methods + + + + + + Cleanup resources. + + + + Define a tool (convenience for register\_tools implementations). + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Get global data to merge into agent. + + + + Get speech recognition hints to merge into agent. + + + + Get instance key for multi-instance skills. + + + + Get a parameter value with a default. + + + + Get a string parameter with env var fallback. + + + + Get parameter schema for GUI tools. + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + + + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 26. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/register-tools.mdx new file mode 100644 index 0000000000..eeeea295b0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::register_tools" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `virtual` `pure` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() = 0 +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 45. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/required-env-vars.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/required-env-vars.mdx new file mode 100644 index 0000000000..cd32f68aa7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/required-env-vars.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/required-env-vars" +title: "required_env_vars" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::required_env_vars" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `required_env_vars` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > required_env_vars() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 38. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/required-packages.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/required-packages.mdx new file mode 100644 index 0000000000..8e274b0748 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/required-packages.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/required-packages" +title: "required_packages" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::required_packages" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `required_packages` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > required_packages() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 39. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/setup.mdx new file mode 100644 index 0000000000..ea5f291a75 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::setup" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `virtual` `pure` + +## Signature + +```cpp +bool setup(const json & params) = 0 +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 42. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-base.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-base.mdx new file mode 100644 index 0000000000..1942d4ad5d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-base.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/skill-base" +title: "~SkillBase" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::~SkillBase" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `~SkillBase` + +**Modifiers:** `virtual` + +## Signature + +```cpp +void ~SkillBase() +``` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-description.mdx new file mode 100644 index 0000000000..70f9e06150 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::skill_description" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `virtual` `pure` + +## Signature + +```cpp +std::string skill_description() const = 0 +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 35. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-name.mdx new file mode 100644 index 0000000000..59c9bddfa9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::skill_name" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `virtual` `pure` + +## Signature + +```cpp +std::string skill_name() const = 0 +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 34. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-version.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-version.mdx new file mode 100644 index 0000000000..c78e3079f0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/skill-version.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/skill-version" +title: "skill_version" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::skill_version" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `skill_version` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_version() const +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 36. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/supports-multiple-instances.mdx new file mode 100644 index 0000000000..0be8de13a7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-base/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-base/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillBase::supports_multiple_instances" + parent: "signalwire::skills::SkillBase" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 37. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-factory.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-factory.mdx new file mode 100644 index 0000000000..ef928bc507 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-factory.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-factory" +title: "SkillFactory" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::skills::SkillFactory" + parent: "signalwire::skills" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `SkillFactory` + +Factory function type for creating skill instances. + +## Signature + +```cpp +typedef std::function< std::unique_ptr< SkillBase >()> SkillFactory +``` + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 118. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-http-response/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-http-response/index.mdx new file mode 100644 index 0000000000..3392daecc7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-http-response/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-http-response" +title: "SkillHttpResponse" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::SkillHttpResponse" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skills_http.hpp" + visibility: "public" +--- +# `SkillHttpResponse` + +Result of a skill HTTP request. status is the HTTP status code (0 indicates a transport-level error — connection refused, DNS, etc.). body is the raw response body. error is non-empty when status is 0. + +## Signature + +```cpp +struct signalwire::skills::SkillHttpResponse +``` + +## Properties + + + + + + + +## Source + +[`include/signalwire/skills/skills_http.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skills_http.hpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/cleanup-all.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/cleanup-all.mdx new file mode 100644 index 0000000000..7a4bea2ee1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/cleanup-all.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-manager/cleanup-all" +title: "cleanup_all" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillManager::cleanup_all" + parent: "signalwire::skills::SkillManager" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp" + visibility: "public" +--- +# `cleanup_all` + +Cleanup all skills. + +## Signature + +```cpp +void cleanup_all() +``` + +## Source + +[`include/signalwire/skills/skill_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp) + +Line 40. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/index.mdx new file mode 100644 index 0000000000..ae2d510c33 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-manager" +title: "SkillManager" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::SkillManager" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp" + visibility: "public" +--- +# `SkillManager` + +Manages skill lifecycle: creation, setup, registration with agents. + +## Signature + +```cpp +class signalwire::skills::SkillManager +``` + +## Methods + + + + Cleanup all skills. + + + + Check if a skill is loaded. + + + + List loaded skills. + + + + Load a skill by name with params and register it with the agent. + + + + + + Unload a skill. + + + +## Source + +[`include/signalwire/skills/skill_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/is-loaded.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/is-loaded.mdx new file mode 100644 index 0000000000..b2059b8e22 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/is-loaded.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-manager/is-loaded" +title: "is_loaded" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillManager::is_loaded" + parent: "signalwire::skills::SkillManager" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp" + visibility: "public" +--- +# `is_loaded` + +Check if a skill is loaded. + +**Modifiers:** `const` + +## Signature + +```cpp +bool is_loaded(const std::string & skill_name) const +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/skills/skill_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp) + +Line 34. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/list-loaded.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/list-loaded.mdx new file mode 100644 index 0000000000..f65f57bce5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/list-loaded.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-manager/list-loaded" +title: "list_loaded" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillManager::list_loaded" + parent: "signalwire::skills::SkillManager" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp" + visibility: "public" +--- +# `list_loaded` + +List loaded skills. + +**Modifiers:** `const` + +## Signature + +```cpp +std::vector< std::string > list_loaded() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/skills/skill_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp) + +Line 37. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/load-skill.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/load-skill.mdx new file mode 100644 index 0000000000..12f1340022 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/load-skill.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-manager/load-skill" +title: "load_skill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillManager::load_skill" + parent: "signalwire::skills::SkillManager" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp" + visibility: "public" +--- +# `load_skill` + +Load a skill by name with params and register it with the agent. + +## Signature + +```cpp +bool load_skill( + const std::string & skill_name, + const json & params, + agent::AgentBase & agent +) +``` + +## Parameters + + + + + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/skills/skill_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp) + +Line 27. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/skill-manager.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/skill-manager.mdx new file mode 100644 index 0000000000..f447eb40d2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/skill-manager.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-manager/skill-manager" +title: "SkillManager" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillManager::SkillManager" + parent: "signalwire::skills::SkillManager" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp" + visibility: "public" +--- +# `SkillManager` + +## Signature + +```cpp +void SkillManager() +``` + +## Source + +[`include/signalwire/skills/skill_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/unload-skill.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/unload-skill.mdx new file mode 100644 index 0000000000..9777bc67d9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-manager/unload-skill.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-manager/unload-skill" +title: "unload_skill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillManager::unload_skill" + parent: "signalwire::skills::SkillManager" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp" + visibility: "public" +--- +# `unload_skill` + +Unload a skill. + +## Signature + +```cpp +void unload_skill(const std::string & skill_name) +``` + +## Parameters + + + +## Source + +[`include/signalwire/skills/skill_manager.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_manager.hpp) + +Line 31. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-prompt-section/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-prompt-section/index.mdx new file mode 100644 index 0000000000..0f4116a1ef --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-prompt-section/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-prompt-section" +title: "SkillPromptSection" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::SkillPromptSection" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp" + visibility: "public" +--- +# `SkillPromptSection` + +POM section for skill prompts. + +## Signature + +```cpp +struct signalwire::skills::SkillPromptSection +``` + +## Properties + + + + + + + +## Source + +[`include/signalwire/skills/skill_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_base.hpp) + +Line 19. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/add-skill-directory.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/add-skill-directory.mdx new file mode 100644 index 0000000000..4395929dc7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/add-skill-directory.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-registry/add-skill-directory" +title: "add_skill_directory" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillRegistry::add_skill_directory" + parent: "signalwire::skills::SkillRegistry" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp" + visibility: "public" +--- +# `add_skill_directory` + +Add a directory to search for skills. +Mirrors Python's signalwire.skills.registry.SkillRegistry.add\_skill\_directory: validate that the path exists and is a directory, then append it (de-duplicated) to external\_paths\_. Throws std::invalid\_argument (the C++ analog of Python's ValueError) for invalid input — the path doesn't exist or isn't a directory. + +**Modifiers:** `inline` + +## Signature + +```cpp +void add_skill_directory(const std::string & path) +``` + +## Parameters + + + +## Source + +[`include/signalwire/skills/skill_registry.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp) + +Line 65. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/create.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/create.mdx new file mode 100644 index 0000000000..60cf930094 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/create.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-registry/create" +title: "create" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillRegistry::create" + parent: "signalwire::skills::SkillRegistry" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp" + visibility: "public" +--- +# `create` + +Create a skill instance by name. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +std::unique_ptr< SkillBase > create(const std::string & name) const +``` + +## Parameters + + + +## Returns + +`std::unique_ptr< SkillBase >` + +## Source + +[`include/signalwire/skills/skill_registry.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp) + +Line 32. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/external-paths.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/external-paths.mdx new file mode 100644 index 0000000000..c8fef22c2c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/external-paths.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-registry/external-paths" +title: "external_paths" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillRegistry::external_paths" + parent: "signalwire::skills::SkillRegistry" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp" + visibility: "public" +--- +# `external_paths` + +Returns the registered external skill directories. Mirrors Python's SkillRegistry.\_external\_paths (private list, exposed here as a public accessor for parity-test inspection — C++ has no convention for protected attributes that tests can poke). + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +std::vector< std::string > external_paths() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/skills/skill_registry.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp) + +Line 84. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/has-skill.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/has-skill.mdx new file mode 100644 index 0000000000..4daf98add8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/has-skill.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-registry/has-skill" +title: "has_skill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillRegistry::has_skill" + parent: "signalwire::skills::SkillRegistry" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp" + visibility: "public" +--- +# `has_skill` + +Check if a skill is registered. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool has_skill(const std::string & name) const +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/skills/skill_registry.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp) + +Line 42. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/index.mdx new file mode 100644 index 0000000000..4dbed98807 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-registry" +title: "SkillRegistry" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::SkillRegistry" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp" + visibility: "public" +--- +# `SkillRegistry` + +Global registry of skill factories. + +## Signature + +```cpp +class signalwire::skills::SkillRegistry +``` + +## Methods + + + + Add a directory to search for skills. Mirrors Python's signalwire.skills.registry.SkillRegistry.add\_skill\_directory: validate that the path exists and is a directory, then append it (de-duplicated) to external\_paths\_. Throws std::invalid\_argument (the C++ analog of Python's ValueError) for invalid input — the path doesn't exist or isn't a directory. + + + + Create a skill instance by name. + + + + Returns the registered external skill directories. Mirrors Python's SkillRegistry.\_external\_paths (private list, exposed here as a public accessor for parity-test inspection — C++ has no convention for protected attributes that tests can poke). + + + + Check if a skill is registered. + + + + + + List all registered skill names. + + + + Register a skill factory. + + + +## Source + +[`include/signalwire/skills/skill_registry.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp) + +Line 18. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/instance.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/instance.mdx new file mode 100644 index 0000000000..a38e7e9633 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/instance.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-registry/instance" +title: "instance" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillRegistry::instance" + parent: "signalwire::skills::SkillRegistry" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp" + visibility: "public" +--- +# `instance` + +**Modifiers:** `static` `inline` + +## Signature + +```cpp +SkillRegistry & instance() +``` + +## Returns + +`SkillRegistry &` + +## Source + +[`include/signalwire/skills/skill_registry.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp) + +Line 20. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/list-skills.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/list-skills.mdx new file mode 100644 index 0000000000..c2bdd237fc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/list-skills.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-registry/list-skills" +title: "list_skills" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillRegistry::list_skills" + parent: "signalwire::skills::SkillRegistry" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp" + visibility: "public" +--- +# `list_skills` + +List all registered skill names. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +std::vector< std::string > list_skills() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/skills/skill_registry.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp) + +Line 48. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/register-skill.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/register-skill.mdx new file mode 100644 index 0000000000..d4f9b256ec --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/skill-registry/register-skill.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/skills/skill-registry/register-skill" +title: "register_skill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SkillRegistry::register_skill" + parent: "signalwire::skills::SkillRegistry" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp" + visibility: "public" +--- +# `register_skill` + +Register a skill factory. + +**Modifiers:** `inline` + +## Signature + +```cpp +void register_skill(const std::string & name, SkillFactory factory) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/skills/skill_registry.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/skills/skill_registry.hpp) + +Line 26. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/get-hints.mdx new file mode 100644 index 0000000000..9d351de639 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill-r/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkillR::get_hints" + parent: "signalwire::skills::SpiderSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 284. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/index.mdx new file mode 100644 index 0000000000..19570b0594 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill-r" +title: "SpiderSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `SpiderSkillR` + +## Signature + +```cpp +class signalwire::skills::SpiderSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get speech recognition hints to merge into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 232. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/register-tools.mdx new file mode 100644 index 0000000000..611bffa99c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkillR::register_tools" + parent: "signalwire::skills::SpiderSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 254. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/setup.mdx new file mode 100644 index 0000000000..3ec31780ca --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkillR::setup" + parent: "signalwire::skills::SpiderSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 253. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/skill-description.mdx new file mode 100644 index 0000000000..35e20f1bd5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkillR::skill_description" + parent: "signalwire::skills::SpiderSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 251. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/skill-name.mdx new file mode 100644 index 0000000000..5d82163c81 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkillR::skill_name" + parent: "signalwire::skills::SpiderSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 250. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/supports-multiple-instances.mdx new file mode 100644 index 0000000000..f4dd040835 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill-r/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill-r/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkillR::supports_multiple_instances" + parent: "signalwire::skills::SpiderSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 252. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/get-hints.mdx new file mode 100644 index 0000000000..3c622d79f4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkill::get_hints" + parent: "signalwire::skills::SpiderSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`src/skills/builtin/spider.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp) + +Line 153. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/index.mdx new file mode 100644 index 0000000000..dc66878a5a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill" +title: "SpiderSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp" + visibility: "public" +--- +# `SpiderSkill` + +Spider scrape skill — issues a real GET against the URL the LLM passes in. Strips HTML tags from the response and returns the text payload. Matches Python SpiderSkill's scrape\_url behavior. +SPIDER\_BASE\_URL env var overrides the host portion of the URL the caller passes in (used by audit\_skills\_dispatch.py to redirect scrape requests at a loopback fixture). + +## Signature + +```cpp +class signalwire::skills::SpiderSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get speech recognition hints to merge into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/spider.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp) + +Line 54. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/register-tools.mdx new file mode 100644 index 0000000000..7e4fe3b308 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkill::register_tools" + parent: "signalwire::skills::SpiderSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/spider.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp) + +Line 62. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/setup.mdx new file mode 100644 index 0000000000..8d172afa06 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkill::setup" + parent: "signalwire::skills::SpiderSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/spider.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp) + +Line 60. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/skill-description.mdx new file mode 100644 index 0000000000..3352b85346 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkill::skill_description" + parent: "signalwire::skills::SpiderSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/spider.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp) + +Line 57. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/skill-name.mdx new file mode 100644 index 0000000000..4b5031699e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkill::skill_name" + parent: "signalwire::skills::SpiderSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/spider.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp) + +Line 56. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..287405d05d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/spider-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/spider-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SpiderSkill::supports_multiple_instances" + parent: "signalwire::skills::SpiderSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/spider.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/spider.cpp) + +Line 58. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/get-datamap-functions.mdx new file mode 100644 index 0000000000..1cbc9b1158 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill-r/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkillR::get_datamap_functions" + parent: "signalwire::skills::SwmlTransferSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 379. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/get-hints.mdx new file mode 100644 index 0000000000..2d3efc70cb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill-r/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkillR::get_hints" + parent: "signalwire::skills::SwmlTransferSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 379. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/index.mdx new file mode 100644 index 0000000000..ee42dfd2f6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill-r" +title: "SwmlTransferSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `SwmlTransferSkillR` + +## Signature + +```cpp +class signalwire::skills::SwmlTransferSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Get speech recognition hints to merge into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 379. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/register-tools.mdx new file mode 100644 index 0000000000..7860be90fa --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkillR::register_tools" + parent: "signalwire::skills::SwmlTransferSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 379. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/setup.mdx new file mode 100644 index 0000000000..57c4c04f2c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkillR::setup" + parent: "signalwire::skills::SwmlTransferSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 379. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/skill-description.mdx new file mode 100644 index 0000000000..d3d9cba6e2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkillR::skill_description" + parent: "signalwire::skills::SwmlTransferSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 379. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/skill-name.mdx new file mode 100644 index 0000000000..b5967c2bba --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkillR::skill_name" + parent: "signalwire::skills::SwmlTransferSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 379. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/supports-multiple-instances.mdx new file mode 100644 index 0000000000..14d7b1d2b0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill-r/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill-r/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkillR::supports_multiple_instances" + parent: "signalwire::skills::SwmlTransferSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 379. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/get-datamap-functions.mdx new file mode 100644 index 0000000000..9fa69e471e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkill::get_datamap_functions" + parent: "signalwire::skills::SwmlTransferSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/builtin/swml_transfer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp) + +Line 26. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/get-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/get-hints.mdx new file mode 100644 index 0000000000..16df96878d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill/get-hints" +title: "get_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkill::get_hints" + parent: "signalwire::skills::SwmlTransferSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp" + visibility: "public" +--- +# `get_hints` + +Get speech recognition hints to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< std::string > get_hints() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`src/skills/builtin/swml_transfer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp) + +Line 62. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..21d2deda2e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkill::get_prompt_sections" + parent: "signalwire::skills::SwmlTransferSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/builtin/swml_transfer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp) + +Line 81. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/index.mdx new file mode 100644 index 0000000000..0edf713e55 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill" +title: "SwmlTransferSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp" + visibility: "public" +--- +# `SwmlTransferSkill` + +## Signature + +```cpp +class signalwire::skills::SwmlTransferSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Get speech recognition hints to merge into agent. + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + +## Source + +[`src/skills/builtin/swml_transfer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp) + +Line 10. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/register-tools.mdx new file mode 100644 index 0000000000..de42ffba51 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkill::register_tools" + parent: "signalwire::skills::SwmlTransferSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/swml_transfer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/setup.mdx new file mode 100644 index 0000000000..9210d7bd1b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkill::setup" + parent: "signalwire::skills::SwmlTransferSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/swml_transfer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp) + +Line 18. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/skill-description.mdx new file mode 100644 index 0000000000..ca9482cdd1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkill::skill_description" + parent: "signalwire::skills::SwmlTransferSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/swml_transfer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp) + +Line 13. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/skill-name.mdx new file mode 100644 index 0000000000..db63a008c9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkill::skill_name" + parent: "signalwire::skills::SwmlTransferSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/swml_transfer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..c45b3e4775 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/swml-transfer-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/swml-transfer-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::SwmlTransferSkill::supports_multiple_instances" + parent: "signalwire::skills::SwmlTransferSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/swml_transfer.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/swml_transfer.cpp) + +Line 16. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/get-datamap-functions.mdx new file mode 100644 index 0000000000..ab92d7e03d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill-r/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkillR::get_datamap_functions" + parent: "signalwire::skills::WeatherApiSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 85. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/index.mdx new file mode 100644 index 0000000000..73fde7811f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill-r" +title: "WeatherApiSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `WeatherApiSkillR` + +## Signature + +```cpp +class signalwire::skills::WeatherApiSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 78. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/register-tools.mdx new file mode 100644 index 0000000000..eb789cc128 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkillR::register_tools" + parent: "signalwire::skills::WeatherApiSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 84. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/setup.mdx new file mode 100644 index 0000000000..625aa7624a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkillR::setup" + parent: "signalwire::skills::WeatherApiSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 83. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/skill-description.mdx new file mode 100644 index 0000000000..dfe7662f25 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkillR::skill_description" + parent: "signalwire::skills::WeatherApiSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 82. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/skill-name.mdx new file mode 100644 index 0000000000..a711e8e8f6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkillR::skill_name" + parent: "signalwire::skills::WeatherApiSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 81. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/get-datamap-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/get-datamap-functions.mdx new file mode 100644 index 0000000000..e129d2c426 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/get-datamap-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill/get-datamap-functions" +title: "get_datamap_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkill::get_datamap_functions" + parent: "signalwire::skills::WeatherApiSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp" + visibility: "public" +--- +# `get_datamap_functions` + +Get SWAIG DataMap functions (for DataMap-based skills). + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< json > get_datamap_functions() const +``` + +## Returns + +`std::vector< json >` + +## Source + +[`src/skills/builtin/weather_api.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp) + +Line 25. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/index.mdx new file mode 100644 index 0000000000..de52694d8d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill" +title: "WeatherApiSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp" + visibility: "public" +--- +# `WeatherApiSkill` + +## Signature + +```cpp +class signalwire::skills::WeatherApiSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get SWAIG DataMap functions (for DataMap-based skills). + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + +## Source + +[`src/skills/builtin/weather_api.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp) + +Line 10. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/register-tools.mdx new file mode 100644 index 0000000000..ddbc2621a6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkill::register_tools" + parent: "signalwire::skills::WeatherApiSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/weather_api.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp) + +Line 23. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/setup.mdx new file mode 100644 index 0000000000..f749543ff2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkill::setup" + parent: "signalwire::skills::WeatherApiSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/weather_api.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp) + +Line 15. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/skill-description.mdx new file mode 100644 index 0000000000..65c1be8b72 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkill::skill_description" + parent: "signalwire::skills::WeatherApiSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/weather_api.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp) + +Line 13. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/skill-name.mdx new file mode 100644 index 0000000000..e6628f5a13 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/weather-api-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/weather-api-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WeatherApiSkill::skill_name" + parent: "signalwire::skills::WeatherApiSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/weather_api.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/weather_api.cpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/get-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/get-global-data.mdx new file mode 100644 index 0000000000..8216c96006 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/get-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill-r/get-global-data" +title: "get_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkillR::get_global_data" + parent: "signalwire::skills::WebSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_global_data` + +Get global data to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +json get_global_data() const +``` + +## Returns + +`json` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 163. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/get-prompt-sections.mdx new file mode 100644 index 0000000000..973d0f71b4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill-r/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkillR::get_prompt_sections" + parent: "signalwire::skills::WebSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 162. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/index.mdx new file mode 100644 index 0000000000..11927fdeb2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill-r" +title: "WebSearchSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `WebSearchSkillR` + +## Signature + +```cpp +class signalwire::skills::WebSearchSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get global data to merge into agent. + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 95. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/register-tools.mdx new file mode 100644 index 0000000000..0196a49e92 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkillR::register_tools" + parent: "signalwire::skills::WebSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 117. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/setup.mdx new file mode 100644 index 0000000000..91ed768ba1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkillR::setup" + parent: "signalwire::skills::WebSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 105. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/skill-description.mdx new file mode 100644 index 0000000000..cf6acbcb1d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkillR::skill_description" + parent: "signalwire::skills::WebSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 102. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/skill-name.mdx new file mode 100644 index 0000000000..9c1396a3b3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkillR::skill_name" + parent: "signalwire::skills::WebSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 101. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/skill-version.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/skill-version.mdx new file mode 100644 index 0000000000..00bad99e58 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/skill-version.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill-r/skill-version" +title: "skill_version" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkillR::skill_version" + parent: "signalwire::skills::WebSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_version` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_version() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 103. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/supports-multiple-instances.mdx new file mode 100644 index 0000000000..9821b2df06 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill-r/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill-r/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkillR::supports_multiple_instances" + parent: "signalwire::skills::WebSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 104. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/get-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..9b90a09fe4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/get-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill/get-global-data" +title: "get_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkill::get_global_data" + parent: "signalwire::skills::WebSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp" + visibility: "public" +--- +# `get_global_data` + +Get global data to merge into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +json get_global_data() const +``` + +## Returns + +`json` + +## Source + +[`src/skills/builtin/web_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp) + +Line 133. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..f340376746 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkill::get_prompt_sections" + parent: "signalwire::skills::WebSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/builtin/web_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp) + +Line 126. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/index.mdx new file mode 100644 index 0000000000..d1fdd6e45a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill" +title: "WebSearchSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp" + visibility: "public" +--- +# `WebSearchSkill` + +Google Custom Search API skill — issues a real GET against Google's customsearch/v1 endpoint, parses the items\[] results, and returns a human-readable summary. Matches Python's WebSearchSkill behavior. +Configuration: +api\_key (or env GOOGLE\_SEARCH\_API\_KEY / GOOGLE\_API\_KEY) +search\_engine\_id (or env GOOGLE\_SEARCH\_ENGINE\_ID / GOOGLE\_CSE\_ID) +num\_results (default 3) +tool\_name (default "web\_search") +WEB\_SEARCH\_BASE\_URL env var overrides the upstream URL (used by audit\_skills\_dispatch.py to point the skill at a fixture) + +## Signature + +```cpp +class signalwire::skills::WebSearchSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get global data to merge into agent. + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + + + + + +## Source + +[`src/skills/builtin/web_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/register-tools.mdx new file mode 100644 index 0000000000..f11be92282 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkill::register_tools" + parent: "signalwire::skills::WebSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/web_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp) + +Line 48. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/setup.mdx new file mode 100644 index 0000000000..50b1be1ecf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkill::setup" + parent: "signalwire::skills::WebSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/web_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp) + +Line 31. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/skill-description.mdx new file mode 100644 index 0000000000..2f64ba5fc4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkill::skill_description" + parent: "signalwire::skills::WebSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/web_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp) + +Line 27. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/skill-name.mdx new file mode 100644 index 0000000000..b8997ea91d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkill::skill_name" + parent: "signalwire::skills::WebSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/web_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp) + +Line 26. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/skill-version.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/skill-version.mdx new file mode 100644 index 0000000000..fb1ac024d9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/skill-version.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill/skill-version" +title: "skill_version" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkill::skill_version" + parent: "signalwire::skills::WebSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp" + visibility: "public" +--- +# `skill_version` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_version() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/web_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..c34872dd0a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/web-search-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/web-search-skill/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WebSearchSkill::supports_multiple_instances" + parent: "signalwire::skills::WebSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp" + visibility: "public" +--- +# `supports_multiple_instances` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +bool supports_multiple_instances() const +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/web_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/web_search.cpp) + +Line 29. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/get-prompt-sections.mdx new file mode 100644 index 0000000000..9914c39d0a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill-r/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkillR::get_prompt_sections" + parent: "signalwire::skills::WikipediaSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 221. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/index.mdx new file mode 100644 index 0000000000..777bec7976 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill-r" +title: "WikipediaSearchSkillR" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkillR" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `WikipediaSearchSkillR` + +## Signature + +```cpp +class signalwire::skills::WikipediaSearchSkillR : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 169. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/register-tools.mdx new file mode 100644 index 0000000000..706deb4b24 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill-r/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkillR::register_tools" + parent: "signalwire::skills::WikipediaSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 181. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/setup.mdx new file mode 100644 index 0000000000..8cce766d88 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill-r/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkillR::setup" + parent: "signalwire::skills::WikipediaSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 175. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/skill-description.mdx new file mode 100644 index 0000000000..004221dd2f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill-r/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkillR::skill_description" + parent: "signalwire::skills::WikipediaSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 174. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/skill-name.mdx new file mode 100644 index 0000000000..a798663f33 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill-r/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill-r/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkillR::skill_name" + parent: "signalwire::skills::WikipediaSearchSkillR" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/skill_registry.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/skill_registry.cpp) + +Line 173. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..87e9c5c251 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkill::get_prompt_sections" + parent: "signalwire::skills::WikipediaSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp" + visibility: "public" +--- +# `get_prompt_sections` + +Get prompt sections to inject into agent. + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::vector< SkillPromptSection > get_prompt_sections() const +``` + +## Returns + +`std::vector< SkillPromptSection >` + +## Source + +[`src/skills/builtin/wikipedia_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp) + +Line 102. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/index.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/index.mdx new file mode 100644 index 0000000000..08c9f356a7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill" +title: "WikipediaSearchSkill" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkill" + parent: "signalwire::skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp" + visibility: "public" +--- +# `WikipediaSearchSkill` + +Wikipedia search skill — issues a real GET against the Wikipedia API /w/api.php endpoint with action=query\&list=search, parses the query.search\[] results, and returns titles + snippets. Matches the Python WikipediaSearchSkill upstream call shape. +WIKIPEDIA\_BASE\_URL env var overrides the API root (used by audit\_skills\_dispatch.py to point the skill at its loopback fixture). + +## Signature + +```cpp +class signalwire::skills::WikipediaSearchSkill : signalwire::skills::SkillBase +``` + +## Inheritance + +**Extends:** [signalwire::skills::SkillBase](/reference/cpp/signalwire/skills/skill-base) + +## Methods + + + + Get prompt sections to inject into agent. + + + + Register tools with the agent. Returns tool definitions. + + + + Initialize the skill with given params. Return true on success. + + + + + + + +## Source + +[`src/skills/builtin/wikipedia_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp) + +Line 20. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/register-tools.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/register-tools.mdx new file mode 100644 index 0000000000..f2fcad29b8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/register-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill/register-tools" +title: "register_tools" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkill::register_tools" + parent: "signalwire::skills::WikipediaSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp" + visibility: "public" +--- +# `register_tools` + +Register tools with the agent. Returns tool definitions. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +std::vector< swaig::ToolDefinition > register_tools() +``` + +## Returns + +`std::vector< swaig::ToolDefinition >` + +## Source + +[`src/skills/builtin/wikipedia_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp) + +Line 35. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/setup.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/setup.mdx new file mode 100644 index 0000000000..4c5f4c2ca2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill/setup" +title: "setup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkill::setup" + parent: "signalwire::skills::WikipediaSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp" + visibility: "public" +--- +# `setup` + +Initialize the skill with given params. Return true on success. + +**Modifiers:** `inline` `virtual` + +## Signature + +```cpp +bool setup(const json & params) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/wikipedia_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp) + +Line 27. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/skill-description.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/skill-description.mdx new file mode 100644 index 0000000000..4231f9a516 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/skill-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill/skill-description" +title: "skill_description" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkill::skill_description" + parent: "signalwire::skills::WikipediaSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp" + visibility: "public" +--- +# `skill_description` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_description() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/wikipedia_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp) + +Line 23. diff --git a/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/skill-name.mdx b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/skill-name.mdx new file mode 100644 index 0000000000..465b05af78 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/skills/wikipedia-search-skill/skill-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/skills/wikipedia-search-skill/skill-name" +title: "skill_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::skills::WikipediaSearchSkill::skill_name" + parent: "signalwire::skills::WikipediaSearchSkill" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp" + visibility: "public" +--- +# `skill_name` + +**Modifiers:** `const` `inline` `virtual` + +## Signature + +```cpp +std::string skill_name() const +``` + +## Returns + +`std::string` + +## Source + +[`src/skills/builtin/wikipedia_search.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/skills/builtin/wikipedia_search.cpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/add-action.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/add-action.mdx new file mode 100644 index 0000000000..4670bdadf1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/add-action.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/add-action" +title: "add_action" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::add_action" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `add_action` + +## Signature + +```cpp +FunctionResult & add_action(const std::string & name, const json & data) +``` + +## Parameters + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 25. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/add-actions.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/add-actions.mdx new file mode 100644 index 0000000000..f3c0e4b846 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/add-actions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/add-actions" +title: "add_actions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::add_actions" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `add_actions` + +## Signature + +```cpp +FunctionResult & add_actions(const std::vector< json > & actions) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 26. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/add-dynamic-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/add-dynamic-hints.mdx new file mode 100644 index 0000000000..c087b152f5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/add-dynamic-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/add-dynamic-hints" +title: "add_dynamic_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::add_dynamic_hints" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `add_dynamic_hints` + +## Signature + +```cpp +FunctionResult & add_dynamic_hints(const json & hints) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 84. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/clear-dynamic-hints.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/clear-dynamic-hints.mdx new file mode 100644 index 0000000000..7ffaae3248 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/clear-dynamic-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/clear-dynamic-hints" +title: "clear_dynamic_hints" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::clear_dynamic_hints" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `clear_dynamic_hints` + +## Signature + +```cpp +FunctionResult & clear_dynamic_hints() +``` + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 85. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/connect.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/connect.mdx new file mode 100644 index 0000000000..334d8582f2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/connect.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/connect" +title: "connect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::connect" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `connect` + +## Signature + +```cpp +FunctionResult & connect( + const std::string & destination, + bool final = true, + const std::string & from_addr = "" +) +``` + +## Parameters + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 32. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/create-payment-action.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/create-payment-action.mdx new file mode 100644 index 0000000000..962d482105 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/create-payment-action.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/create-payment-action" +title: "create_payment_action" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::create_payment_action" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `create_payment_action` + +**Modifiers:** `static` + +## Signature + +```cpp +json create_payment_action( + const std::string & action_type, + const std::string & phrase +) +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 157. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/create-payment-parameter.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/create-payment-parameter.mdx new file mode 100644 index 0000000000..2db49e6e1c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/create-payment-parameter.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/create-payment-parameter" +title: "create_payment_parameter" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::create_payment_parameter" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `create_payment_parameter` + +**Modifiers:** `static` + +## Signature + +```cpp +json create_payment_parameter( + const std::string & name, + const std::string & value +) +``` + +## Parameters + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 159. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/create-payment-prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/create-payment-prompt.mdx new file mode 100644 index 0000000000..aef8befd7d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/create-payment-prompt.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/create-payment-prompt" +title: "create_payment_prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::create_payment_prompt" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `create_payment_prompt` + +**Modifiers:** `static` + +## Signature + +```cpp +json create_payment_prompt( + const std::string & for_situation, + const std::vector< json > & actions, + const std::string & card_type = "", + const std::string & error_type = "" +) +``` + +## Parameters + + + + + + + + + +## Returns + +`json` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 153. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/enable-extensive-data.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/enable-extensive-data.mdx new file mode 100644 index 0000000000..0345e9dbb5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/enable-extensive-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/enable-extensive-data" +title: "enable_extensive_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::enable_extensive_data" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `enable_extensive_data` + +## Signature + +```cpp +FunctionResult & enable_extensive_data(bool enabled = true) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 90. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/enable-functions-on-timeout.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/enable-functions-on-timeout.mdx new file mode 100644 index 0000000000..9e8748616a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/enable-functions-on-timeout.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/enable-functions-on-timeout" +title: "enable_functions_on_timeout" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::enable_functions_on_timeout" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `enable_functions_on_timeout` + +## Signature + +```cpp +FunctionResult & enable_functions_on_timeout(bool enabled = true) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 89. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/execute-rpc.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/execute-rpc.mdx new file mode 100644 index 0000000000..d5f5402e8f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/execute-rpc.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/execute-rpc" +title: "execute_rpc" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::execute_rpc" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `execute_rpc` + +## Signature + +```cpp +FunctionResult & execute_rpc( + const std::string & method, + const json & params = json::object(), + const std::string & call_id = "", + const std::string & node_id = "" +) +``` + +## Parameters + + + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 139. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/execute-swml.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/execute-swml.mdx new file mode 100644 index 0000000000..1a0d0eb3e8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/execute-swml.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/execute-swml" +title: "execute_swml" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::execute_swml" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `execute_swml` + +## Signature + +```cpp +FunctionResult & execute_swml(const json & swml_content, bool transfer = false) +``` + +## Parameters + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 98. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/function-result.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/function-result.mdx new file mode 100644 index 0000000000..a1a0abea95 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/function-result.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/function-result" +title: "FunctionResult" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::FunctionResult" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `FunctionResult` + +**Modifiers:** `explicit` + +## Signature + +```cpp +void FunctionResult( + const std::string & response = "", + bool post_process = false +) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 17. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/hangup.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/hangup.mdx new file mode 100644 index 0000000000..a087bed49d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/hangup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/hangup" +title: "hangup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::hangup" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `hangup` + +## Signature + +```cpp +FunctionResult & hangup() +``` + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 36. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/hold.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/hold.mdx new file mode 100644 index 0000000000..b472536f72 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/hold.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/hold" +title: "hold" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::hold" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `hold` + +## Signature + +```cpp +FunctionResult & hold(int timeout = 300) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 37. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/index.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/index.mdx new file mode 100644 index 0000000000..6f4c49db08 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/index.mdx @@ -0,0 +1,136 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result" +title: "FunctionResult" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult" + parent: "signalwire::swaig" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `FunctionResult` + +Builder for SWAIG function results with 40+ action methods. Every method returns \*this for chaining. + +## Signature + +```cpp +class signalwire::swaig::FunctionResult +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 15. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/join-conference.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/join-conference.mdx new file mode 100644 index 0000000000..5af78ea59e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/join-conference.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/join-conference" +title: "join_conference" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::join_conference" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `join_conference` + +## Signature + +```cpp +FunctionResult & join_conference( + const std::string & name, + bool muted = false, + const std::string & beep = "true" +) +``` + +## Parameters + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 99. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/join-room.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/join-room.mdx new file mode 100644 index 0000000000..edcf511f8e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/join-room.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/join-room" +title: "join_room" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::join_room" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `join_room` + +## Signature + +```cpp +FunctionResult & join_room(const std::string & name) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 101. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/pay.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/pay.mdx new file mode 100644 index 0000000000..6732892fc3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/pay.mdx @@ -0,0 +1,92 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/pay" +title: "pay" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::pay" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `pay` + +## Signature + +```cpp +FunctionResult & pay( + const std::string & payment_connector_url, + const std::string & input_method = "dtmf", + const std::string & status_url = "", + const std::string & payment_method = "credit-card", + int timeout = 5, + int max_attempts = 1, + bool security_code = true, + const std::string & postal_code = "true", + int min_postal_code_length = 0, + const std::string & token_type = "reusable", + const std::string & charge_amount = "", + const std::string & currency = "usd", + const std::string & language = "en-US", + const std::string & voice = "woman", + const std::string & description = "", + const std::string & valid_card_types = "visa mastercard amex", + const std::vector< json > & parameters = {}, + const std::vector< json > & prompts = {}, + const std::string & ai_response = "The payment status is ${pay_result}, do not mention anything else about collecting payment if successful." +) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 114. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/play-background-file.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/play-background-file.mdx new file mode 100644 index 0000000000..5cbcb30743 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/play-background-file.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/play-background-file" +title: "play_background_file" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::play_background_file" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `play_background_file` + +## Signature + +```cpp +FunctionResult & play_background_file( + const std::string & filename, + bool wait = false +) +``` + +## Parameters + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 65. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/record-call.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/record-call.mdx new file mode 100644 index 0000000000..b352fe1e6a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/record-call.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/record-call" +title: "record_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::record_call" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `record_call` + +## Signature + +```cpp +FunctionResult & record_call( + const std::string & control_id = "", + bool stereo = false, + const std::string & format = "wav", + const std::string & direction = "both", + const std::string & terminators = "", + bool beep = false, + double input_sensitivity = 44.0, + std::optional< double > initial_timeout = std::nullopt, + std::optional< double > end_silence_timeout = std::nullopt, + std::optional< double > max_length = std::nullopt, + const std::string & status_url = "" +) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 67. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/remove-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/remove-global-data.mdx new file mode 100644 index 0000000000..864726b8e3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/remove-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/remove-global-data" +title: "remove_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::remove_global_data" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `remove_global_data` + +## Signature + +```cpp +FunctionResult & remove_global_data(const json & keys) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 48. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/remove-metadata.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/remove-metadata.mdx new file mode 100644 index 0000000000..865cb195a3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/remove-metadata.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/remove-metadata" +title: "remove_metadata" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::remove_metadata" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `remove_metadata` + +## Signature + +```cpp +FunctionResult & remove_metadata(const json & keys) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 50. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/replace-in-history.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/replace-in-history.mdx new file mode 100644 index 0000000000..ad4e9d8e78 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/replace-in-history.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/replace-in-history" +title: "replace_in_history" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::replace_in_history" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `replace_in_history` + +## Signature + +```cpp +FunctionResult & replace_in_history(const json & text) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 58. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/rpc-ai-message.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/rpc-ai-message.mdx new file mode 100644 index 0000000000..4cbcfd8e9b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/rpc-ai-message.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/rpc-ai-message" +title: "rpc_ai_message" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::rpc_ai_message" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `rpc_ai_message` + +## Signature + +```cpp +FunctionResult & rpc_ai_message( + const std::string & call_id, + const std::string & message_text, + const std::string & role = "system" +) +``` + +## Parameters + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 145. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/rpc-ai-unhold.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/rpc-ai-unhold.mdx new file mode 100644 index 0000000000..1fa1c2e20b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/rpc-ai-unhold.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/rpc-ai-unhold" +title: "rpc_ai_unhold" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::rpc_ai_unhold" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `rpc_ai_unhold` + +## Signature + +```cpp +FunctionResult & rpc_ai_unhold(const std::string & call_id) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 147. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/rpc-dial.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/rpc-dial.mdx new file mode 100644 index 0000000000..8c2d068604 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/rpc-dial.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/rpc-dial" +title: "rpc_dial" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::rpc_dial" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `rpc_dial` + +## Signature + +```cpp +FunctionResult & rpc_dial( + const std::string & to_number, + const std::string & from_number, + const std::string & dest_swml, + const std::string & device_type = "phone" +) +``` + +## Parameters + + + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 142. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/say.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/say.mdx new file mode 100644 index 0000000000..d358633ebe --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/say.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/say" +title: "say" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::say" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `say` + +## Signature + +```cpp +FunctionResult & say(const std::string & text) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 64. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/send-sms.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/send-sms.mdx new file mode 100644 index 0000000000..77e035ec51 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/send-sms.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/send-sms" +title: "send_sms" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::send_sms" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `send_sms` + +## Signature + +```cpp +FunctionResult & send_sms( + const std::string & to, + const std::string & from, + const std::string & body = "", + const std::vector< std::string > & media = {}, + const std::vector< std::string > & tags = {}, + const std::string & region = "" +) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 109. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-end-of-speech-timeout.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-end-of-speech-timeout.mdx new file mode 100644 index 0000000000..79e8c6a809 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-end-of-speech-timeout.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/set-end-of-speech-timeout" +title: "set_end_of_speech_timeout" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::set_end_of_speech_timeout" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `set_end_of_speech_timeout` + +## Signature + +```cpp +FunctionResult & set_end_of_speech_timeout(int milliseconds) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 86. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-metadata.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-metadata.mdx new file mode 100644 index 0000000000..cffabbb154 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-metadata.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/set-metadata" +title: "set_metadata" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::set_metadata" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `set_metadata` + +## Signature + +```cpp +FunctionResult & set_metadata(const json & data) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 49. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-post-process.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-post-process.mdx new file mode 100644 index 0000000000..dc781315fa --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-post-process.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/set-post-process" +title: "set_post_process" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::set_post_process" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `set_post_process` + +## Signature + +```cpp +FunctionResult & set_post_process(bool pp) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-response.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-response.mdx new file mode 100644 index 0000000000..30be885127 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-response.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/set-response" +title: "set_response" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::set_response" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `set_response` + +## Signature + +```cpp +FunctionResult & set_response(const std::string & response) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 23. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-speech-event-timeout.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-speech-event-timeout.mdx new file mode 100644 index 0000000000..11ec314f9f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/set-speech-event-timeout.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/set-speech-event-timeout" +title: "set_speech_event_timeout" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::set_speech_event_timeout" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `set_speech_event_timeout` + +## Signature + +```cpp +FunctionResult & set_speech_event_timeout(int milliseconds) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 87. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/simulate-user-input.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/simulate-user-input.mdx new file mode 100644 index 0000000000..a7140b59dd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/simulate-user-input.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/simulate-user-input" +title: "simulate_user_input" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::simulate_user_input" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `simulate_user_input` + +## Signature + +```cpp +FunctionResult & simulate_user_input(const std::string & text) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 92. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/sip-refer.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/sip-refer.mdx new file mode 100644 index 0000000000..e1d98a57b0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/sip-refer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/sip-refer" +title: "sip_refer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::sip_refer" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `sip_refer` + +## Signature + +```cpp +FunctionResult & sip_refer(const std::string & to_uri) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 102. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop-background-file.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop-background-file.mdx new file mode 100644 index 0000000000..6878118a79 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop-background-file.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/stop-background-file" +title: "stop_background_file" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::stop_background_file" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `stop_background_file` + +## Signature + +```cpp +FunctionResult & stop_background_file() +``` + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 66. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop-record-call.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop-record-call.mdx new file mode 100644 index 0000000000..e58ca35984 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop-record-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/stop-record-call" +title: "stop_record_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::stop_record_call" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `stop_record_call` + +## Signature + +```cpp +FunctionResult & stop_record_call(const std::string & control_id = "") +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 78. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop-tap.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop-tap.mdx new file mode 100644 index 0000000000..2b0a57bf7e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop-tap.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/stop-tap" +title: "stop_tap" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::stop_tap" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `stop_tap` + +## Signature + +```cpp +FunctionResult & stop_tap(const std::string & control_id = "") +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 108. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop.mdx new file mode 100644 index 0000000000..77bd529bbe --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/stop.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/stop" +title: "stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::stop" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `stop` + +## Signature + +```cpp +FunctionResult & stop() +``` + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 41. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/switch-context.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/switch-context.mdx new file mode 100644 index 0000000000..a4d291f0c4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/switch-context.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/switch-context" +title: "switch_context" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::switch_context" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `switch_context` + +## Signature + +```cpp +FunctionResult & switch_context( + const std::string & system_prompt = "", + const std::string & user_prompt = "", + bool consolidate = false, + bool full_reset = false +) +``` + +## Parameters + + + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 54. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-change-context.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-change-context.mdx new file mode 100644 index 0000000000..cd4e604e6e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-change-context.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/swml-change-context" +title: "swml_change_context" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::swml_change_context" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `swml_change_context` + +## Signature + +```cpp +FunctionResult & swml_change_context(const std::string & context_name) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 53. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-change-step.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-change-step.mdx new file mode 100644 index 0000000000..768bd0259c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-change-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/swml-change-step" +title: "swml_change_step" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::swml_change_step" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `swml_change_step` + +## Signature + +```cpp +FunctionResult & swml_change_step(const std::string & step_name) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 52. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-transfer.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-transfer.mdx new file mode 100644 index 0000000000..ac0ce25098 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-transfer.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/swml-transfer" +title: "swml_transfer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::swml_transfer" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `swml_transfer` + +## Signature + +```cpp +FunctionResult & swml_transfer( + const std::string & dest, + const std::string & ai_response, + bool final = true +) +``` + +## Parameters + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 34. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-user-event.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-user-event.mdx new file mode 100644 index 0000000000..0ed4b7929d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/swml-user-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/swml-user-event" +title: "swml_user_event" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::swml_user_event" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `swml_user_event` + +## Signature + +```cpp +FunctionResult & swml_user_event(const json & event_data) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 51. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/tap.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/tap.mdx new file mode 100644 index 0000000000..29080eab91 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/tap.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/tap" +title: "tap" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::tap" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `tap` + +## Signature + +```cpp +FunctionResult & tap( + const std::string & uri, + const std::string & control_id = "", + const std::string & direction = "both", + const std::string & codec = "PCMU", + int rtp_ptime = 20, + const std::string & status_url = "" +) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 103. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/to-json.mdx new file mode 100644 index 0000000000..dbea4e39b1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/to-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::to_json" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `to_json` + +**Modifiers:** `const` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 166. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/to-string.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/to-string.mdx new file mode 100644 index 0000000000..e603ac132c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/to-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/to-string" +title: "to_string" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::to_string" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `to_string` + +**Modifiers:** `const` + +## Signature + +```cpp +std::string to_string(int indent = -1) const +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 167. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/toggle-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/toggle-functions.mdx new file mode 100644 index 0000000000..1c1994902a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/toggle-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/toggle-functions" +title: "toggle_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::toggle_functions" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `toggle_functions` + +## Signature + +```cpp +FunctionResult & toggle_functions(const json & function_toggles) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 88. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/update-global-data.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/update-global-data.mdx new file mode 100644 index 0000000000..fa8366dd02 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/update-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/update-global-data" +title: "update_global_data" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::update_global_data" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `update_global_data` + +## Signature + +```cpp +FunctionResult & update_global_data(const json & data) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 47. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/update-settings.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/update-settings.mdx new file mode 100644 index 0000000000..80ef27a2e2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/update-settings.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/update-settings" +title: "update_settings" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::update_settings" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `update_settings` + +## Signature + +```cpp +FunctionResult & update_settings(const json & settings) +``` + +## Parameters + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 91. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/wait-for-user.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/wait-for-user.mdx new file mode 100644 index 0000000000..a199bc603b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/function-result/wait-for-user.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/swaig/function-result/wait-for-user" +title: "wait_for_user" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::FunctionResult::wait_for_user" + parent: "signalwire::swaig::FunctionResult" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `wait_for_user` + +## Signature + +```cpp +FunctionResult & wait_for_user( + std::optional< bool > enabled = std::nullopt, + std::optional< int > timeout = std::nullopt, + bool answer_first = false +) +``` + +## Parameters + + + + + + + +## Returns + +`FunctionResult &` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 38. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/index.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/index.mdx new file mode 100644 index 0000000000..84f54288f0 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/cpp/signalwire/swaig" +title: "swaig" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::swaig" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" +--- +# `swaig` + +## Signature + +```cpp +namespace signalwire::swaig +``` + +## Type Aliases + + + + + + + +## Classes + + + + Builder for SWAIG function results with 40+ action methods. Every method returns \*this for chaining. + + + + Definition of a SWAIG tool (function). + + + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 9. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/json.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/json.mdx new file mode 100644 index 0000000000..cc8b853a5c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/swaig/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::swaig::json" + parent: "signalwire::swaig" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/swaig/function_result.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/function_result.hpp) + +Line 11. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/tool-definition/index.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/tool-definition/index.mdx new file mode 100644 index 0000000000..18183c92bf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/tool-definition/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/swaig/tool-definition" +title: "ToolDefinition" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::swaig::ToolDefinition" + parent: "signalwire::swaig" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/tool_definition.hpp" + visibility: "public" +--- +# `ToolDefinition` + +Definition of a SWAIG tool (function). + +## Signature + +```cpp +struct signalwire::swaig::ToolDefinition +``` + +## Properties + + + + + + + + + + + +## Methods + + + + Render to the SWAIG function JSON format (for inclusion in SWML). + + + +## Source + +[`include/signalwire/swaig/tool_definition.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/tool_definition.hpp) + +Line 15. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/tool-definition/to-swaig-json.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/tool-definition/to-swaig-json.mdx new file mode 100644 index 0000000000..00387e4f31 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/tool-definition/to-swaig-json.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swaig/tool-definition/to-swaig-json" +title: "to_swaig_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swaig::ToolDefinition::to_swaig_json" + parent: "signalwire::swaig::ToolDefinition" + module: "signalwire.swaig" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/tool_definition.hpp" + visibility: "public" +--- +# `to_swaig_json` + +Render to the SWAIG function JSON format (for inclusion in SWML). + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json to_swaig_json(const std::string & web_hook_url = "") const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/swaig/tool_definition.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/tool_definition.hpp) + +Line 23. diff --git a/fern/products/sdk-reference/cpp/signalwire/swaig/tool-handler.mdx b/fern/products/sdk-reference/cpp/signalwire/swaig/tool-handler.mdx new file mode 100644 index 0000000000..f778eb672f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swaig/tool-handler.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/swaig/tool-handler" +title: "ToolHandler" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::swaig::ToolHandler" + parent: "signalwire::swaig" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/tool_definition.hpp" + visibility: "public" +--- +# `ToolHandler` + +## Signature + +```cpp +typedef std::function< FunctionResult(const json &args, const json &raw_data)> ToolHandler +``` + +## Source + +[`include/signalwire/swaig/tool_definition.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swaig/tool_definition.hpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/document/add-verb-to-section.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/document/add-verb-to-section.mdx new file mode 100644 index 0000000000..decfe6654f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/document/add-verb-to-section.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/swml/document/add-verb-to-section" +title: "add_verb_to_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Document::add_verb_to_section" + parent: "signalwire::swml::Document" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `add_verb_to_section` + +Add a verb to a specific section. + +**Modifiers:** `inline` + +## Signature + +```cpp +Document & add_verb_to_section( + const std::string & section_name, + const std::string & verb_name, + const json & params +) +``` + +## Parameters + + + + + + + +## Returns + +`Document &` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 87. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/document/add-verb.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/document/add-verb.mdx new file mode 100644 index 0000000000..57a897eca1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/document/add-verb.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/swml/document/add-verb" +title: "add_verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Document::add_verb" + parent: "signalwire::swml::Document" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `add_verb` + +Add a verb to the main section. + +**Modifiers:** `inline` + +## Signature + +```cpp +Document & add_verb(const std::string & verb_name, const json & params) +``` + +## Parameters + + + + + +## Returns + +`Document &` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 81. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/document/document.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/document/document.mdx new file mode 100644 index 0000000000..8fb2babdb9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/document/document.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/swml/document/document" +title: "Document" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Document::Document" + parent: "signalwire::swml::Document" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `Document` + +**Modifiers:** `inline` + +## Signature + +```cpp +void Document() +``` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 55. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/document/has-section.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/document/has-section.mdx new file mode 100644 index 0000000000..f7633b3f00 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/document/has-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/document/has-section" +title: "has_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Document::has_section" + parent: "signalwire::swml::Document" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `has_section` + +Check if a section exists. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +bool has_section(const std::string & name) const +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 95. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/document/index.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/document/index.mdx new file mode 100644 index 0000000000..8e6bfdb8b1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/document/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/cpp/signalwire/swml/document" +title: "Document" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::swml::Document" + parent: "signalwire::swml" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `Document` + +A complete SWML document with version and sections. + +## Signature + +```cpp +class signalwire::swml::Document +``` + +## Methods + + + + Add a verb to the main section. + + + + Add a verb to a specific section. + + + + + + Check if a section exists. + + + + Get the main section. + + + + Get or create a section by name. + + + + Set the document version. + + + + Render to JSON. + + + + Render to JSON string. + + + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 53. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/document/main.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/document/main.mdx new file mode 100644 index 0000000000..d2ec6cc648 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/document/main.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/document/main" +title: "main" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Document::main" + parent: "signalwire::swml::Document" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `main` + +Get the main section. + +**Modifiers:** `inline` + +## Signature + +```cpp +Section & main() +``` + +## Returns + +`Section &` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 76. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/document/section.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/document/section.mdx new file mode 100644 index 0000000000..e78aa050f3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/document/section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/document/section" +title: "section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Document::section" + parent: "signalwire::swml::Document" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `section` + +Get or create a section by name. + +**Modifiers:** `inline` + +## Signature + +```cpp +Section & section(const std::string & name) +``` + +## Parameters + + + +## Returns + +`Section &` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 66. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/document/set-version.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/document/set-version.mdx new file mode 100644 index 0000000000..d9408cbfe2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/document/set-version.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/document/set-version" +title: "set_version" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Document::set_version" + parent: "signalwire::swml::Document" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `set_version` + +Set the document version. + +**Modifiers:** `inline` + +## Signature + +```cpp +Document & set_version(const std::string & version) +``` + +## Parameters + + + +## Returns + +`Document &` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 60. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/document/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/document/to-json.mdx new file mode 100644 index 0000000000..c227696ea4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/document/to-json.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/document/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Document::to_json" + parent: "signalwire::swml::Document" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `to_json` + +Render to JSON. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 100. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/document/to-string.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/document/to-string.mdx new file mode 100644 index 0000000000..d6bbae45cf --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/document/to-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/document/to-string" +title: "to_string" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Document::to_string" + parent: "signalwire::swml::Document" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `to_string` + +Render to JSON string. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +std::string to_string(int indent = -1) const +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 124. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/get-embedded-schema.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/get-embedded-schema.mdx new file mode 100644 index 0000000000..f10f406768 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/get-embedded-schema.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/swml/get-embedded-schema" +title: "get_embedded_schema" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::swml::get_embedded_schema" + parent: "signalwire::swml" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/swml/schema.cpp" + visibility: "public" +--- +# `get_embedded_schema` + +Get the embedded schema JSON string. + +## Signature + +```cpp +const std::string & get_embedded_schema() +``` + +## Returns + +`const std::string &` + +## Source + +[`src/swml/schema.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/swml/schema.cpp) + +Line 52. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/index.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/index.mdx new file mode 100644 index 0000000000..a77bdd63c8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/cpp/signalwire/swml" +title: "swml" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::swml" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" +--- +# `swml` + +## Signature + +```cpp +namespace signalwire::swml +``` + +## Constants + + + +## Functions + + + + Get the embedded schema JSON string. + + + +## Type Aliases + + + + + +## Classes + + + + A complete SWML document with version and sections. + + + + Schema loader that extracts verb definitions from schema.json. + + + + A named section containing an ordered list of verbs. + + + + Base SWML service providing HTTP server, auth, and verb methods. Also hosts SWAIG functions: any Service (sidecar, non-agent verb host) can register tools and serve them on /swaig without subclassing AgentBase. + + + + Represents a single SWML verb instance, e.g. \{"answer": \{"max\_duration": 3600\}\}. + + + + Represents a verb definition extracted from the SWML schema. + + + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 10. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/json.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/json.mdx new file mode 100644 index 0000000000..1de7d52775 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/swml/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::swml::json" + parent: "signalwire::swml" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 12. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/schema/find-verb.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/schema/find-verb.mdx new file mode 100644 index 0000000000..cc7ea5b7a7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/schema/find-verb.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/schema/find-verb" +title: "find_verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Schema::find_verb" + parent: "signalwire::swml::Schema" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp" + visibility: "public" +--- +# `find_verb` + +Get a specific verb definition by verb name. + +**Modifiers:** `const` + +## Signature + +```cpp +const VerbDefinition * find_verb(const std::string & verb_name) const +``` + +## Parameters + + + +## Returns + +`const VerbDefinition *` + +## Source + +[`include/signalwire/swml/schema.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp) + +Line 39. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/schema/index.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/schema/index.mdx new file mode 100644 index 0000000000..bb605ebf08 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/schema/index.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/cpp/signalwire/swml/schema" +title: "Schema" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::swml::Schema" + parent: "signalwire::swml" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp" + visibility: "public" +--- +# `Schema` + +Schema loader that extracts verb definitions from schema.json. + +## Signature + +```cpp +class signalwire::swml::Schema +``` + +## Methods + + + + Get a specific verb definition by verb name. + + + + Load the embedded schema. + + + + Load schema from a file path. + + + + Load schema from a JSON string. + + + + Get the raw schema JSON. + + + + + + Get all verb definitions. + + + + Get all verb names. + + + +## Source + +[`include/signalwire/swml/schema.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/schema/load-embedded.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/schema/load-embedded.mdx new file mode 100644 index 0000000000..223cee3f3b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/schema/load-embedded.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/swml/schema/load-embedded" +title: "load_embedded" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Schema::load_embedded" + parent: "signalwire::swml::Schema" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp" + visibility: "public" +--- +# `load_embedded` + +Load the embedded schema. + +## Signature + +```cpp +bool load_embedded() +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/swml/schema.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp) + +Line 33. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/schema/load-from-file.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/schema/load-from-file.mdx new file mode 100644 index 0000000000..028c874f72 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/schema/load-from-file.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swml/schema/load-from-file" +title: "load_from_file" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Schema::load_from_file" + parent: "signalwire::swml::Schema" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp" + visibility: "public" +--- +# `load_from_file` + +Load schema from a file path. + +## Signature + +```cpp +bool load_from_file(const std::string & path) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/swml/schema.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp) + +Line 30. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/schema/load-from-string.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/schema/load-from-string.mdx new file mode 100644 index 0000000000..ea1a9b30d1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/schema/load-from-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swml/schema/load-from-string" +title: "load_from_string" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Schema::load_from_string" + parent: "signalwire::swml::Schema" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp" + visibility: "public" +--- +# `load_from_string` + +Load schema from a JSON string. + +## Signature + +```cpp +bool load_from_string(const std::string & schema_json) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/swml/schema.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp) + +Line 27. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/schema/raw.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/schema/raw.mdx new file mode 100644 index 0000000000..492a02bbd8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/schema/raw.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/schema/raw" +title: "raw" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Schema::raw" + parent: "signalwire::swml::Schema" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp" + visibility: "public" +--- +# `raw` + +Get the raw schema JSON. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const json & raw() const +``` + +## Returns + +`const json &` + +## Source + +[`include/signalwire/swml/schema.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp) + +Line 45. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/schema/schema.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/schema/schema.mdx new file mode 100644 index 0000000000..664e35cb16 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/schema/schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/swml/schema/schema" +title: "Schema" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Schema::Schema" + parent: "signalwire::swml::Schema" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp" + visibility: "public" +--- +# `Schema` + +## Signature + +```cpp +void Schema() +``` + +## Source + +[`include/signalwire/swml/schema.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp) + +Line 24. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/schema/verb-definitions.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/schema/verb-definitions.mdx new file mode 100644 index 0000000000..1481c846e6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/schema/verb-definitions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/schema/verb-definitions" +title: "verb_definitions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Schema::verb_definitions" + parent: "signalwire::swml::Schema" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp" + visibility: "public" +--- +# `verb_definitions` + +Get all verb definitions. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::vector< VerbDefinition > & verb_definitions() const +``` + +## Returns + +`const std::vector< VerbDefinition > &` + +## Source + +[`include/signalwire/swml/schema.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp) + +Line 36. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/schema/verb-names.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/schema/verb-names.mdx new file mode 100644 index 0000000000..157c300922 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/schema/verb-names.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/schema/verb-names" +title: "verb_names" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Schema::verb_names" + parent: "signalwire::swml::Schema" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp" + visibility: "public" +--- +# `verb_names` + +Get all verb names. + +**Modifiers:** `const` + +## Signature + +```cpp +std::vector< std::string > verb_names() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/swml/schema.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp) + +Line 42. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/section/add-verb.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/section/add-verb.mdx new file mode 100644 index 0000000000..45b5d533e1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/section/add-verb.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/swml/section/add-verb" +title: "add_verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Section::add_verb" + parent: "signalwire::swml::Section" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `add_verb` + +**Modifiers:** `inline` + +## Signature + + + + ```cpp + void add_verb(const Verb & verb) + ``` + + + + ```cpp + void add_verb(const std::string & verb_name, const json & params) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 35. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/section/index.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/section/index.mdx new file mode 100644 index 0000000000..ebd21376ae --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/section/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/swml/section" +title: "Section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::swml::Section" + parent: "signalwire::swml" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `Section` + +A named section containing an ordered list of verbs. + +## Signature + +```cpp +struct signalwire::swml::Section +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/section/section.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/section/section.mdx new file mode 100644 index 0000000000..23d10cd3c3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/section/section.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/swml/section/section" +title: "Section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Section::Section" + parent: "signalwire::swml::Section" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `Section` + +## Signature + + + + ```cpp + void Section() + ``` + + + + ```cpp + void Section(std::string n) + ``` + + + +## Parameters (Overload 2) + + + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 32. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/section/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/section/to-json.mdx new file mode 100644 index 0000000000..021b3eb666 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/section/to-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/swml/section/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Section::to_json" + parent: "signalwire::swml::Section" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `to_json` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 43. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/add-security-headers.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/add-security-headers.mdx new file mode 100644 index 0000000000..fe1d8516e4 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/add-security-headers.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/add-security-headers" +title: "add_security_headers" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::add_security_headers" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "protected" +--- +# `add_security_headers` + +Add security headers to response. + +**Modifiers:** `static` + +## Signature + +```cpp +void add_security_headers(httplib::Response & res) +``` + +## Parameters + + + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 275. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/add-verb.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/add-verb.mdx new file mode 100644 index 0000000000..5822197e58 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/add-verb.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/add-verb" +title: "add_verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::add_verb" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `add_verb` + +## Signature + +```cpp +Service & add_verb( + const std::string & section, + const std::string & verb_name, + const json & params +) +``` + +## Parameters + + + + + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 131. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/ai.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/ai.mdx new file mode 100644 index 0000000000..734e806fdb --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/ai.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/ai" +title: "ai" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::ai" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `ai` + +## Signature + +```cpp +Service & ai(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 89. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/amazon-bedrock.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/amazon-bedrock.mdx new file mode 100644 index 0000000000..b45d84bf50 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/amazon-bedrock.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/amazon-bedrock" +title: "amazon_bedrock" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::amazon_bedrock" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `amazon_bedrock` + +## Signature + +```cpp +Service & amazon_bedrock(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 90. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/answer.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/answer.mdx new file mode 100644 index 0000000000..d14f0a8a20 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/answer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/answer" +title: "answer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::answer" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `answer` + +## Signature + +```cpp +Service & answer(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 88. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/auth-password.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/auth-password.mdx new file mode 100644 index 0000000000..658ef67805 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/auth-password.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/auth-password" +title: "auth_password" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::auth_password" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `auth_password` + +Get the password for basic auth. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & auth_password() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 63. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/auth-username.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/auth-username.mdx new file mode 100644 index 0000000000..251e1b75d7 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/auth-username.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/auth-username" +title: "auth_username" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::auth_username" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `auth_username` + +Get the username for basic auth. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & auth_username() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 60. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/build-tool-registry-json.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/build-tool-registry-json.mdx new file mode 100644 index 0000000000..a4f1564811 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/build-tool-registry-json.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/build-tool-registry-json" +title: "build_tool_registry_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::build_tool_registry_json" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `build_tool_registry_json` + +Build the introspect payload for the registered tools as a JSON string shaped like \{"tools":\[\]\}. Iterates tool\_order\_ first, falling back to map order for entries registered only via register\_swaig\_function. Stable across SDKs so the swaig-test --example CLI can parse output uniformly. Used by the SWAIG\_LIST\_TOOLS env-var path; pulled out as a separate helper so tests can assert content without invoking exit(). + +**Modifiers:** `const` + +## Signature + +```cpp +std::string build_tool_registry_json() const +``` + +## Returns + +`std::string` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 204. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/cond.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/cond.mdx new file mode 100644 index 0000000000..f58a838f0c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/cond.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/cond" +title: "cond" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::cond" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `cond` + +## Signature + +```cpp +Service & cond(const json & params = json::array()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 91. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/connect.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/connect.mdx new file mode 100644 index 0000000000..98867c4077 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/connect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/connect" +title: "connect" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::connect" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `connect` + +## Signature + +```cpp +Service & connect(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 92. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/define-tool.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/define-tool.mdx new file mode 100644 index 0000000000..6285586e04 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/define-tool.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/define-tool" +title: "define_tool" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::define_tool" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `define_tool` + +Define a SWAIG function the AI can call. + +## Signature + + + + ```cpp + Service & define_tool( + const std::string & name, + const std::string & description, + const json & parameters, + swaig::ToolHandler handler, + bool secure = false + ) + ``` + + + + ```cpp + Service & define_tool(const swaig::ToolDefinition & tool) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Service &` + +## Returns (Overload 2) + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 156. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/denoise.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/denoise.mdx new file mode 100644 index 0000000000..33cb5c3cc8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/denoise.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/denoise" +title: "denoise" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::denoise" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `denoise` + +## Signature + +```cpp +Service & denoise(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 93. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/detect-machine.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/detect-machine.mdx new file mode 100644 index 0000000000..0bd02c285c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/detect-machine.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/detect-machine" +title: "detect_machine" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::detect_machine" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `detect_machine` + +## Signature + +```cpp +Service & detect_machine(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 94. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/document.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/document.mdx new file mode 100644 index 0000000000..6f69502c58 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/document.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/document" +title: "document" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::document" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `document` + +Get the underlying SWML document. + +**Modifiers:** `inline` + +## Signature + + + + ```cpp + Document & document() + ``` + + + + ```cpp + const Document & document() const + ``` + + + +## Returns (Overload 1) + +`Document &` + +## Returns (Overload 2) + +`const Document &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 138. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/enter-queue.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/enter-queue.mdx new file mode 100644 index 0000000000..bd34f909a6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/enter-queue.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/enter-queue" +title: "enter_queue" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::enter_queue" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `enter_queue` + +## Signature + +```cpp +Service & enter_queue(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 95. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/execute.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/execute.mdx new file mode 100644 index 0000000000..8639b00915 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/execute.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/execute" +title: "execute" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::execute" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `execute` + +## Signature + +```cpp +Service & execute(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 96. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/extract-introspect-payload.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/extract-introspect-payload.mdx new file mode 100644 index 0000000000..8693e6456a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/extract-introspect-payload.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/extract-introspect-payload" +title: "extract_introspect_payload" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::extract_introspect_payload" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `extract_introspect_payload` + +Pure-string extractor: slice the JSON payload between **SWAIG\_TOOLS\_BEGIN** and **SWAIG\_TOOLS\_END** sentinels in a captured stdout. Returns empty string if either marker is missing or the order is wrong. Static so the swaig-test CLI / tests can reuse it. + +**Modifiers:** `static` + +## Signature + +```cpp +std::string extract_introspect_payload(const std::string & stdout_capture) +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 209. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/generate-random-hex.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/generate-random-hex.mdx new file mode 100644 index 0000000000..7eaba6a4c9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/generate-random-hex.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/generate-random-hex" +title: "generate_random_hex" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::generate_random_hex" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `generate_random_hex` + +Generate a random hex string of given byte length. + +**Modifiers:** `static` + +## Signature + +```cpp +std::string generate_random_hex(size_t bytes) +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 228. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/get-all-functions.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/get-all-functions.mdx new file mode 100644 index 0000000000..78ba09ba5e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/get-all-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/get-all-functions" +title: "get_all_functions" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::get_all_functions" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `get_all_functions` + +Snapshot of all registered SWAIG functions keyed by name. Returned by value so subsequent registrations don't mutate the snapshot. Python parity: ToolRegistry.get\_all\_functions. + +**Modifiers:** `const` + +## Signature + +```cpp +std::map< std::string, swaig::ToolDefinition > get_all_functions() const +``` + +## Returns + +`std::map< std::string, swaig::ToolDefinition >` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 190. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/get-basic-auth-credentials-with-source.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/get-basic-auth-credentials-with-source.mdx new file mode 100644 index 0000000000..cc168255dd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/get-basic-auth-credentials-with-source.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/get-basic-auth-credentials-with-source" +title: "get_basic_auth_credentials_with_source" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::get_basic_auth_credentials_with_source" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `get_basic_auth_credentials_with_source` + +Get (user, password, source) where source is one of "provided", "environment", or "generated". Python parity: AuthMixin.get\_basic\_auth\_credentials(include\_source=True). + +**Modifiers:** `const` + +## Signature + +```cpp +std::tuple< std::string, std::string, std::string > get_basic_auth_credentials_with_source() const +``` + +## Returns + +`std::tuple< std::string, std::string, std::string >` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 82. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..c3c98fb9ed --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/get-basic-auth-credentials.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/get-basic-auth-credentials" +title: "get_basic_auth_credentials" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::get_basic_auth_credentials" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `get_basic_auth_credentials` + +Get (user, password) — Python-canonical name. Python parity: AuthMixin.get\_basic\_auth\_credentials. + +**Modifiers:** `const` + +## Signature + +```cpp +std::pair< std::string, std::string > get_basic_auth_credentials() const +``` + +## Returns + +`std::pair< std::string, std::string >` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 76. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/get-function.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/get-function.mdx new file mode 100644 index 0000000000..354aa4404d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/get-function.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/get-function" +title: "get_function" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::get_function" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `get_function` + +Get a registered SWAIG function definition by name. Returns nullptr when no such function is registered. Python parity: ToolRegistry.get\_function. + +**Modifiers:** `const` + +## Signature + +```cpp +const swaig::ToolDefinition * get_function(const std::string & name) const +``` + +## Parameters + + + +## Returns + +`const swaig::ToolDefinition *` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 185. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/goto-section.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/goto-section.mdx new file mode 100644 index 0000000000..17d8062482 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/goto-section.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/goto-section" +title: "goto_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::goto_section" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `goto_section` + +## Signature + +```cpp +Service & goto_section(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 97. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/handle-swaig-endpoint.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/handle-swaig-endpoint.mdx new file mode 100644 index 0000000000..81d4196f20 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/handle-swaig-endpoint.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/handle-swaig-endpoint" +title: "handle_swaig_endpoint" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::handle_swaig_endpoint" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "protected" +--- +# `handle_swaig_endpoint` + +Handle GET/POST /swaig (lifted from AgentBase). + +## Signature + +```cpp +void handle_swaig_endpoint( + const httplib::Request & req, + httplib::Response & res +) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 281. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/hangup.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/hangup.mdx new file mode 100644 index 0000000000..6c132e3f25 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/hangup.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/hangup" +title: "hangup" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::hangup" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `hangup` + +## Signature + +```cpp +Service & hangup(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 98. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/has-function.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/has-function.mdx new file mode 100644 index 0000000000..f01933b719 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/has-function.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/has-function" +title: "has_function" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::has_function" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `has_function` + +Whether a SWAIG function with the given name is registered. Python parity: ToolRegistry.has\_function. + +**Modifiers:** `const` + +## Signature + +```cpp +bool has_function(const std::string & name) const +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 180. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/has-tool.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/has-tool.mdx new file mode 100644 index 0000000000..55937b6e48 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/has-tool.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/has-tool" +title: "has_tool" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::has_tool" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `has_tool` + +**Modifiers:** `const` + +## Signature + +```cpp +bool has_tool(const std::string & name) const +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 171. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/index.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/index.mdx new file mode 100644 index 0000000000..38ff43cdb2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/index.mdx @@ -0,0 +1,270 @@ +--- +slug: "/reference/cpp/signalwire/swml/service" +title: "Service" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::swml::Service" + parent: "signalwire::swml" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `Service` + +Base SWML service providing HTTP server, auth, and verb methods. Also hosts SWAIG functions: any Service (sidecar, non-agent verb host) can register tools and serve them on /swaig without subclassing AgentBase. + +## Signature + +```cpp +class signalwire::swml::Service +``` + +## Methods + + + + + + Add security headers to response. + + + + + + + + + + + + Get the password for basic auth. + + + + Get the username for basic auth. + + + + Build the introspect payload for the registered tools as a JSON string shaped like \{"tools":\[\]\}. Iterates tool\_order\_ first, falling back to map order for entries registered only via register\_swaig\_function. Stable across SDKs so the swaig-test --example CLI can parse output uniformly. Used by the SWAIG\_LIST\_TOOLS env-var path; pulled out as a separate helper so tests can assert content without invoking exit(). + + + + + + + + Define a SWAIG function the AI can call. + + + + + + + + Get the underlying SWML document. + + + + + + + + Pure-string extractor: slice the JSON payload between **SWAIG\_TOOLS\_BEGIN** and **SWAIG\_TOOLS\_END** sentinels in a captured stdout. Returns empty string if either marker is missing or the order is wrong. Static so the swaig-test CLI / tests can reuse it. + + + + Generate a random hex string of given byte length. + + + + Snapshot of all registered SWAIG functions keyed by name. Returned by value so subsequent registrations don't mutate the snapshot. Python parity: ToolRegistry.get\_all\_functions. + + + + Get (user, password) — Python-canonical name. Python parity: AuthMixin.get\_basic\_auth\_credentials. + + + + Get (user, password, source) where source is one of "provided", "environment", or "generated". Python parity: AuthMixin.get\_basic\_auth\_credentials(include\_source=True). + + + + Get a registered SWAIG function definition by name. Returns nullptr when no such function is registered. Python parity: ToolRegistry.get\_function. + + + + + + Handle GET/POST /swaig (lifted from AgentBase). + + + + + + Whether a SWAIG function with the given name is registered. Python parity: ToolRegistry.has\_function. + + + + + + + + + + + + + + + + + + + + Dispatch a function call to the registered handler. Returns a FunctionResult; if the function isn't registered, returns a FunctionResult with a "Function not found" response. + + + + Override to customize SWML rendering. + + + + Customization hook called when SWML is requested. Default delegates to on\_swml\_request and returns its result. Subclasses typically override on\_swml\_request rather than this method. Returns std::nullopt to use the default SWML rendering, or a non-null JSON with modifications to merge into the rendered document. Python parity: WebMixin.on\_request(request\_data, callback\_path). The Python third request argument is FastAPI-specific and intentionally not mirrored on the cross-language API. + + + + Customization point for subclasses to modify SWML based on request data. Default returns std::nullopt (no modification). Python parity: WebMixin.on\_swml\_request(request\_data, callback\_path). + + + + + + + + Get the effective port. + + + + + + + + + + + + Extension point: register additional HTTP routes. AgentBase uses this to add /post\_prompt, /mcp, etc. + + + + Register a raw SWAIG function definition (e.g. DataMap tools). + + + + Remove a registered SWAIG function. Returns true when the function was found and removed; false when it wasn't registered. Python parity: ToolRegistry.remove\_function. + + + + Extension point: render the SWML document for the main path or for GET /swaig. Default returns the currently-built Document. AgentBase overrides to emit prompt + AI verb at request time. + + + + Render the SWML document to JSON. + + + + + + + + + + SchemaUtils helper bound to this Service. Mirrors Python's self.schema\_utils instance attribute on SWMLService. Built lazily on first access; the underlying schema is cached so the helper is cheap to build. + + + + + + + + + + Start the HTTP server (blocking). + + + + + + + + Set basic auth credentials (auto-generated if not set). + + + + Set the host to bind to. + + + + Set the service name (default: "service"). + + + + Set the port to listen on. + + + + Set the route path for this service (default: "/"). + + + + + + + + + + Stop the HTTP server. + + + + + + + + + + Extension point: invoked between argument parsing and function dispatch on POST /swaig. Returns a target Service\* (defaults to this) and an optional short-circuit JSON. If short\_circuit is non-null, it's returned as the SWAIG response without calling on\_function\_call. AgentBase overrides for token validation. + + + + + + + + Timing-safe string comparison using CRYPTO\_memcmp. + + + + + + + + + + Validate basic auth from a request; returns true if valid. + + + + Validate provided basic-auth credentials against the configured ones using a constant-time comparison. Python parity: AuthMixin.validate\_basic\_auth(username, password). + + + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 33. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/join-conference.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/join-conference.mdx new file mode 100644 index 0000000000..a6fa4ef9ee --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/join-conference.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/join-conference" +title: "join_conference" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::join_conference" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `join_conference` + +## Signature + +```cpp +Service & join_conference(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 99. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/join-room.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/join-room.mdx new file mode 100644 index 0000000000..ffb268de3b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/join-room.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/join-room" +title: "join_room" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::join_room" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `join_room` + +## Signature + +```cpp +Service & join_room(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 100. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/label.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/label.mdx new file mode 100644 index 0000000000..030b91127b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/label.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/label" +title: "label" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::label" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `label` + +## Signature + +```cpp +Service & label(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 101. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/list-tool-names.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/list-tool-names.mdx new file mode 100644 index 0000000000..2c4477d486 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/list-tool-names.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/list-tool-names" +title: "list_tool_names" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::list_tool_names" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `list_tool_names` + +**Modifiers:** `const` + +## Signature + +```cpp +std::vector< std::string > list_tool_names() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 172. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/live-transcribe.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/live-transcribe.mdx new file mode 100644 index 0000000000..ee40b1a9ac --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/live-transcribe.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/live-transcribe" +title: "live_transcribe" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::live_transcribe" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `live_transcribe` + +## Signature + +```cpp +Service & live_transcribe(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 102. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/live-translate.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/live-translate.mdx new file mode 100644 index 0000000000..2199c5bb20 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/live-translate.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/live-translate" +title: "live_translate" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::live_translate" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `live_translate` + +## Signature + +```cpp +Service & live_translate(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 103. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/name.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/name.mdx new file mode 100644 index 0000000000..6026e3c070 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/name" +title: "name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::name" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `name` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & name() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 44. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/on-function-call.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/on-function-call.mdx new file mode 100644 index 0000000000..6a1aa53b13 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/on-function-call.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/on-function-call" +title: "on_function_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::on_function_call" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `on_function_call` + +Dispatch a function call to the registered handler. Returns a FunctionResult; if the function isn't registered, returns a FunctionResult with a "Function not found" response. + +**Modifiers:** `virtual` + +## Signature + +```cpp +swaig::FunctionResult on_function_call( + const std::string & name, + const json & args, + const json & raw_data +) +``` + +## Parameters + + + + + + + +## Returns + +`swaig::FunctionResult` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 167. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/on-render-swml.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/on-render-swml.mdx new file mode 100644 index 0000000000..50ac227386 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/on-render-swml.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/on-render-swml" +title: "on_render_swml" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::on_render_swml" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "protected" +--- +# `on_render_swml` + +Override to customize SWML rendering. + +**Modifiers:** `const` `virtual` + +## Signature + +```cpp +json on_render_swml() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 255. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/on-request.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/on-request.mdx new file mode 100644 index 0000000000..f595d5b4d9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/on-request.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/on-request" +title: "on_request" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::on_request" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `on_request` + +Customization hook called when SWML is requested. Default delegates to on\_swml\_request and returns its result. Subclasses typically override on\_swml\_request rather than this method. +Returns std::nullopt to use the default SWML rendering, or a non-null JSON with modifications to merge into the rendered document. +Python parity: WebMixin.on\_request(request\_data, callback\_path). The Python third request argument is FastAPI-specific and intentionally not mirrored on the cross-language API. + +**Modifiers:** `virtual` + +## Signature + +```cpp +std::optional< json > on_request( + const std::optional< json > & request_data = std::nullopt, + const std::optional< std::string > & callback_path = std::nullopt +) +``` + +## Parameters + + + + + +## Returns + +`std::optional< json >` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 241. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/on-swml-request.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/on-swml-request.mdx new file mode 100644 index 0000000000..dd0db16773 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/on-swml-request.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/on-swml-request" +title: "on_swml_request" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::on_swml_request" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `on_swml_request` + +Customization point for subclasses to modify SWML based on request data. Default returns std::nullopt (no modification). +Python parity: WebMixin.on\_swml\_request(request\_data, callback\_path). + +**Modifiers:** `virtual` + +## Signature + +```cpp +std::optional< json > on_swml_request( + const std::optional< json > & request_data = std::nullopt, + const std::optional< std::string > & callback_path = std::nullopt +) +``` + +## Parameters + + + + + +## Returns + +`std::optional< json >` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 249. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/pay.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/pay.mdx new file mode 100644 index 0000000000..0d488ac854 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/pay.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/pay" +title: "pay" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::pay" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `pay` + +## Signature + +```cpp +Service & pay(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 104. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/play.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/play.mdx new file mode 100644 index 0000000000..c42f44b477 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/play.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/play" +title: "play" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::play" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `play` + +## Signature + +```cpp +Service & play(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 105. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/port.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/port.mdx new file mode 100644 index 0000000000..7205954fbd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/port.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/port" +title: "port" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::port" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `port` + +Get the effective port. + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +int port() const +``` + +## Returns + +`int` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 222. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/prompt.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/prompt.mdx new file mode 100644 index 0000000000..17065ccc19 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/prompt" +title: "prompt" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::prompt" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `prompt` + +## Signature + +```cpp +Service & prompt(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 106. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/receive-fax.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/receive-fax.mdx new file mode 100644 index 0000000000..b789b8b6ba --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/receive-fax.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/receive-fax" +title: "receive_fax" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::receive_fax" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `receive_fax` + +## Signature + +```cpp +Service & receive_fax(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 107. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/record-call.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/record-call.mdx new file mode 100644 index 0000000000..55357fb300 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/record-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/record-call" +title: "record_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::record_call" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `record_call` + +## Signature + +```cpp +Service & record_call(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 109. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/record.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/record.mdx new file mode 100644 index 0000000000..331cd15017 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/record.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/record" +title: "record" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::record" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `record` + +## Signature + +```cpp +Service & record(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 108. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/register-additional-routes.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/register-additional-routes.mdx new file mode 100644 index 0000000000..bcd698cfc5 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/register-additional-routes.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/register-additional-routes" +title: "register_additional_routes" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::register_additional_routes" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "protected" +--- +# `register_additional_routes` + +Extension point: register additional HTTP routes. AgentBase uses this to add /post\_prompt, /mcp, etc. + +**Modifiers:** `virtual` + +## Signature + +```cpp +void register_additional_routes(httplib::Server & server) +``` + +## Parameters + + + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 272. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/register-swaig-function.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/register-swaig-function.mdx new file mode 100644 index 0000000000..c7daf64daa --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/register-swaig-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/register-swaig-function" +title: "register_swaig_function" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::register_swaig_function" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `register_swaig_function` + +Register a raw SWAIG function definition (e.g. DataMap tools). + +## Signature + +```cpp +Service & register_swaig_function(const json & func_def) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 162. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/remove-function.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/remove-function.mdx new file mode 100644 index 0000000000..c73c66c600 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/remove-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/remove-function" +title: "remove_function" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::remove_function" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `remove_function` + +Remove a registered SWAIG function. Returns true when the function was found and removed; false when it wasn't registered. Python parity: ToolRegistry.remove\_function. + +## Signature + +```cpp +bool remove_function(const std::string & name) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 195. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/render-main-swml.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/render-main-swml.mdx new file mode 100644 index 0000000000..ad262c0598 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/render-main-swml.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/render-main-swml" +title: "render_main_swml" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::render_main_swml" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "protected" +--- +# `render_main_swml` + +Extension point: render the SWML document for the main path or for GET /swaig. Default returns the currently-built Document. AgentBase overrides to emit prompt + AI verb at request time. + +**Modifiers:** `const` `virtual` + +## Signature + +```cpp +json render_main_swml(const httplib::Request & req) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 260. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/render-swml.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/render-swml.mdx new file mode 100644 index 0000000000..7ddc41e026 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/render-swml.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/render-swml" +title: "render_swml" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::render_swml" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `render_swml` + +Render the SWML document to JSON. + +**Modifiers:** `const` + +## Signature + +```cpp +json render_swml() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 149. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/request.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/request.mdx new file mode 100644 index 0000000000..1786d6483e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/request.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/request" +title: "request" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::request" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `request` + +## Signature + +```cpp +Service & request(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 110. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/return-section.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/return-section.mdx new file mode 100644 index 0000000000..7051bb29dc --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/return-section.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/return-section" +title: "return_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::return_section" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `return_section` + +## Signature + +```cpp +Service & return_section(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 111. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/route.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/route.mdx new file mode 100644 index 0000000000..d1bb5a721a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/route.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/route" +title: "route" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::route" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `route` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & route() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 48. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/schema-utils.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/schema-utils.mdx new file mode 100644 index 0000000000..edcd1b2475 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/schema-utils.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/schema-utils" +title: "schema_utils" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::schema_utils" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `schema_utils` + +SchemaUtils helper bound to this Service. Mirrors Python's self.schema\_utils instance attribute on SWMLService. Built lazily on first access; the underlying schema is cached so the helper is cheap to build. + +## Signature + + + + ```cpp + signalwire::utils::SchemaUtils & schema_utils() + ``` + + + + ```cpp + const signalwire::utils::SchemaUtils & schema_utils() const + ``` + + + +## Returns (Overload 1) + +`signalwire::utils::SchemaUtils &` + +## Returns (Overload 2) + +`const signalwire::utils::SchemaUtils &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 145. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/send-digits.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/send-digits.mdx new file mode 100644 index 0000000000..1dedcd686e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/send-digits.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/send-digits" +title: "send_digits" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::send_digits" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `send_digits` + +## Signature + +```cpp +Service & send_digits(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 112. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/send-fax.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/send-fax.mdx new file mode 100644 index 0000000000..d2940d8106 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/send-fax.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/send-fax" +title: "send_fax" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::send_fax" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `send_fax` + +## Signature + +```cpp +Service & send_fax(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 113. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/send-sms.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/send-sms.mdx new file mode 100644 index 0000000000..43403ef2ae --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/send-sms.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/send-sms" +title: "send_sms" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::send_sms" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `send_sms` + +## Signature + +```cpp +Service & send_sms(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 114. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/serve.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/serve.mdx new file mode 100644 index 0000000000..cc7375d5e8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/serve.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/serve" +title: "serve" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::serve" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `serve` + +Start the HTTP server (blocking). + +## Signature + +```cpp +void serve() +``` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 216. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/service.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/service.mdx new file mode 100644 index 0000000000..ef1afe6f9c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/service.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/service" +title: "Service" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::Service" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `Service` + +## Signature + +```cpp +void Service() +``` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 35. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/service__2.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/service__2.mdx new file mode 100644 index 0000000000..f119977fd1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/service__2.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/service__2" +title: "~Service" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::~Service" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `~Service` + +**Modifiers:** `virtual` + +## Signature + +```cpp +void ~Service() +``` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 36. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/set-auth.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/set-auth.mdx new file mode 100644 index 0000000000..e99893d261 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/set-auth.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/set-auth" +title: "set_auth" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::set_auth" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `set_auth` + +Set basic auth credentials (auto-generated if not set). + +## Signature + +```cpp +Service & set_auth(const std::string & username, const std::string & password) +``` + +## Parameters + + + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 57. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/set-host.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/set-host.mdx new file mode 100644 index 0000000000..425c2c18cd --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/set-host.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/set-host" +title: "set_host" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::set_host" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `set_host` + +Set the host to bind to. + +## Signature + +```cpp +Service & set_host(const std::string & host) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 51. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/set-name.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/set-name.mdx new file mode 100644 index 0000000000..59a16936a8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/set-name.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/set-name" +title: "set_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::set_name" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `set_name` + +Set the service name (default: "service"). + +## Signature + +```cpp +Service & set_name(const std::string & name) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 43. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/set-port.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/set-port.mdx new file mode 100644 index 0000000000..9de6afa539 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/set-port.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/set-port" +title: "set_port" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::set_port" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `set_port` + +Set the port to listen on. + +## Signature + +```cpp +Service & set_port(int port) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 54. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/set-route.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/set-route.mdx new file mode 100644 index 0000000000..c0da7c4e02 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/set-route.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/set-route" +title: "set_route" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::set_route" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `set_route` + +Set the route path for this service (default: "/"). + +## Signature + +```cpp +Service & set_route(const std::string & route) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 47. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/set.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/set.mdx new file mode 100644 index 0000000000..835d94fd69 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/set.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/set" +title: "set" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::set" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `set` + +## Signature + +```cpp +Service & set(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 115. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/setup-routes.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/setup-routes.mdx new file mode 100644 index 0000000000..ffbe706cf1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/setup-routes.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/setup-routes" +title: "setup_routes" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::setup_routes" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "protected" +--- +# `setup_routes` + +## Signature + +```cpp +void setup_routes(httplib::Server & server) +``` + +## Parameters + + + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 304. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/sip-refer.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/sip-refer.mdx new file mode 100644 index 0000000000..2c883bb338 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/sip-refer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/sip-refer" +title: "sip_refer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::sip_refer" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `sip_refer` + +## Signature + +```cpp +Service & sip_refer(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 117. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/sleep.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/sleep.mdx new file mode 100644 index 0000000000..a67ae41154 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/sleep.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/sleep" +title: "sleep" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::sleep" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `sleep` + +## Signature + +```cpp +Service & sleep(int milliseconds) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 116. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/stop-denoise.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/stop-denoise.mdx new file mode 100644 index 0000000000..b189148d5e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/stop-denoise.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/stop-denoise" +title: "stop_denoise" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::stop_denoise" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `stop_denoise` + +## Signature + +```cpp +Service & stop_denoise(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 118. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/stop-record-call.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/stop-record-call.mdx new file mode 100644 index 0000000000..0daec3fb5d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/stop-record-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/stop-record-call" +title: "stop_record_call" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::stop_record_call" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `stop_record_call` + +## Signature + +```cpp +Service & stop_record_call(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 119. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/stop-tap.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/stop-tap.mdx new file mode 100644 index 0000000000..383d2b547f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/stop-tap.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/stop-tap" +title: "stop_tap" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::stop_tap" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `stop_tap` + +## Signature + +```cpp +Service & stop_tap(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 120. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/stop.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/stop.mdx new file mode 100644 index 0000000000..d6b8e41d06 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/stop" +title: "stop" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::stop" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `stop` + +Stop the HTTP server. + +## Signature + +```cpp +void stop() +``` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 219. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..b63f8423d3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/swaig-pre-dispatch.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/swaig-pre-dispatch" +title: "swaig_pre_dispatch" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::swaig_pre_dispatch" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "protected" +--- +# `swaig_pre_dispatch` + +Extension point: invoked between argument parsing and function dispatch on POST /swaig. Returns a target Service\* (defaults to this) and an optional short-circuit JSON. If short\_circuit is non-null, it's returned as the SWAIG response without calling on\_function\_call. AgentBase overrides for token validation. + +**Modifiers:** `virtual` + +## Signature + +```cpp +std::pair< Service *, std::optional< json > > swaig_pre_dispatch( + const json & request_data, + const std::string & func_name +) +``` + +## Parameters + + + + + +## Returns + +`std::pair< Service *, std::optional< json > >` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 268. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/switch-section.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/switch-section.mdx new file mode 100644 index 0000000000..137e13fcd6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/switch-section.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/switch-section" +title: "switch_section" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::switch_section" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `switch_section` + +## Signature + +```cpp +Service & switch_section(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 121. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/tap.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/tap.mdx new file mode 100644 index 0000000000..128c99ef39 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/tap.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/tap" +title: "tap" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::tap" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `tap` + +## Signature + +```cpp +Service & tap(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 122. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/timing-safe-compare.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/timing-safe-compare.mdx new file mode 100644 index 0000000000..4677ba8b86 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/timing-safe-compare.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/timing-safe-compare" +title: "timing_safe_compare" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::timing_safe_compare" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `timing_safe_compare` + +Timing-safe string comparison using CRYPTO\_memcmp. + +**Modifiers:** `static` + +## Signature + +```cpp +bool timing_safe_compare(const std::string & a, const std::string & b) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 225. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/transfer.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/transfer.mdx new file mode 100644 index 0000000000..94f1757e8d --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/transfer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/transfer" +title: "transfer" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::transfer" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `transfer` + +## Signature + +```cpp +Service & transfer(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 123. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/unset.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/unset.mdx new file mode 100644 index 0000000000..173b871ac9 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/unset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/unset" +title: "unset" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::unset" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `unset` + +## Signature + +```cpp +Service & unset(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 124. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/user-event.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/user-event.mdx new file mode 100644 index 0000000000..460c1d9a63 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/user-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/user-event" +title: "user_event" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::user_event" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `user_event` + +## Signature + +```cpp +Service & user_event(const json & params = json::object()) +``` + +## Parameters + + + +## Returns + +`Service &` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 125. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/validate-auth.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/validate-auth.mdx new file mode 100644 index 0000000000..2095724b0e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/validate-auth.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/validate-auth" +title: "validate_auth" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::validate_auth" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "protected" +--- +# `validate_auth` + +Validate basic auth from a request; returns true if valid. + +**Modifiers:** `const` + +## Signature + +```cpp +bool validate_auth(const httplib::Request & req, httplib::Response & res) const +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 278. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/service/validate-basic-auth.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/service/validate-basic-auth.mdx new file mode 100644 index 0000000000..859f948509 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/service/validate-basic-auth.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/swml/service/validate-basic-auth" +title: "validate_basic_auth" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Service::validate_basic_auth" + parent: "signalwire::swml::Service" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp" + visibility: "public" +--- +# `validate_basic_auth` + +Validate provided basic-auth credentials against the configured ones using a constant-time comparison. Python parity: AuthMixin.validate\_basic\_auth(username, password). + +**Modifiers:** `const` + +## Signature + +```cpp +bool validate_basic_auth( + const std::string & username, + const std::string & password +) const +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/swml/service.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/service.hpp) + +Line 72. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/verb-definition/index.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/verb-definition/index.mdx new file mode 100644 index 0000000000..830236649e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/verb-definition/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/swml/verb-definition" +title: "VerbDefinition" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::swml::VerbDefinition" + parent: "signalwire::swml" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp" + visibility: "public" +--- +# `VerbDefinition` + +Represents a verb definition extracted from the SWML schema. + +## Signature + +```cpp +struct signalwire::swml::VerbDefinition +``` + +## Properties + + + + + + + + + +## Source + +[`include/signalwire/swml/schema.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/schema.hpp) + +Line 14. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/verb/index.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/verb/index.mdx new file mode 100644 index 0000000000..dddac5d905 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/verb/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/swml/verb" +title: "Verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::swml::Verb" + parent: "signalwire::swml" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `Verb` + +Represents a single SWML verb instance, e.g. \{"answer": \{"max\_duration": 3600\}\}. + +## Signature + +```cpp +struct signalwire::swml::Verb +``` + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 15. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/verb/to-json.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/verb/to-json.mdx new file mode 100644 index 0000000000..ec221d4ee8 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/verb/to-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/swml/verb/to-json" +title: "to_json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Verb::to_json" + parent: "signalwire::swml::Verb" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `to_json` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +json to_json() const +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 22. diff --git a/fern/products/sdk-reference/cpp/signalwire/swml/verb/verb.mdx b/fern/products/sdk-reference/cpp/signalwire/swml/verb/verb.mdx new file mode 100644 index 0000000000..899dbfb12b --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/swml/verb/verb.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/swml/verb/verb" +title: "Verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::swml::Verb::Verb" + parent: "signalwire::swml::Verb" + module: "signalwire.swml" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp" + visibility: "public" +--- +# `Verb` + +## Signature + + + + ```cpp + void Verb() + ``` + + + + ```cpp + void Verb(std::string n, json p) + ``` + + + +## Parameters (Overload 2) + + + + + +## Source + +[`include/signalwire/swml/document.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/swml/document.hpp) + +Line 19. diff --git a/fern/products/sdk-reference/cpp/signalwire/timing-safe-compare.mdx b/fern/products/sdk-reference/cpp/signalwire/timing-safe-compare.mdx new file mode 100644 index 0000000000..6575eca0b1 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/timing-safe-compare.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/cpp/signalwire/timing-safe-compare" +title: "timing_safe_compare" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::timing_safe_compare" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp" + visibility: "public" +--- +# `timing_safe_compare` + +**Modifiers:** `inline` + +## Signature + +```cpp +bool timing_safe_compare(const std::string & a, const std::string & b) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`include/signalwire/common.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp) + +Line 87. diff --git a/fern/products/sdk-reference/cpp/signalwire/url-encode.mdx b/fern/products/sdk-reference/cpp/signalwire/url-encode.mdx new file mode 100644 index 0000000000..01697697e2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/url-encode.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/cpp/signalwire/url-encode" +title: "url_encode" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::url_encode" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp" + visibility: "public" +--- +# `url_encode` + +**Modifiers:** `inline` + +## Signature + +```cpp +std::string url_encode(const std::string & value) +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/common.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/common.hpp) + +Line 55. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/index.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/index.mdx new file mode 100644 index 0000000000..2af574092c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/cpp/signalwire/utils" +title: "utils" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::utils" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" +--- +# `utils` + +## Signature + +```cpp +namespace signalwire::utils +``` + +## Functions + + + + Cross-language SDK contract: signalwire.utils.is\_serverless\_mode returns true whenever the SDK is running inside any short-lived / event-driven invocation environment (anything other than "server"). Mirrors signalwire.utils.is\_serverless\_mode in the Python reference. true unless the detected mode is "server". + + + +## Type Aliases + + + + + +## Classes + + + + SchemaUtils — C++ port of signalwire.utils.schema\_utils.SchemaUtils. + + + + SchemaValidationError — C++ port of signalwire.utils.schema\_utils.SchemaValidationError. + + + + Verb metadata extracted from the schema. + + + +## Modules + + + + + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 28. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/is-serverless-mode.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/is-serverless-mode.mdx new file mode 100644 index 0000000000..dd8b828f4c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/is-serverless-mode.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/utils/is-serverless-mode" +title: "is_serverless_mode" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::utils::is_serverless_mode" + parent: "signalwire::utils" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/utils/serverless.cpp" + visibility: "public" +--- +# `is_serverless_mode` + +Cross-language SDK contract: signalwire.utils.is\_serverless\_mode returns true whenever the SDK is running inside any short-lived / event-driven invocation environment (anything other than "server"). +Mirrors signalwire.utils.is\_serverless\_mode in the Python reference. +true unless the detected mode is "server". + +## Signature + +```cpp +bool is_serverless_mode() +``` + +## Returns + +`bool` — true unless the detected mode is "server". + +## Source + +[`src/utils/serverless.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/utils/serverless.cpp) + +Line 13. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/json.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/json.mdx new file mode 100644 index 0000000000..b90d81cb15 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/cpp/signalwire/utils/json" +title: "json" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::utils::json" + parent: "signalwire::utils" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `json` + +## Signature + +```cpp +typedef nlohmann::json json +``` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 30. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/full-validation-available.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/full-validation-available.mdx new file mode 100644 index 0000000000..f0337c5527 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/full-validation-available.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils/full-validation-available" +title: "full_validation_available" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils::full_validation_available" + parent: "signalwire::utils::SchemaUtils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `full_validation_available` + +Whether full JSON Schema validation is wired up. Mirrors Python's full\_validation\_available property. + +**Modifiers:** `const` + +## Signature + +```cpp +bool full_validation_available() const +``` + +## Returns + +`bool` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 69. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/generate-method-body.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/generate-method-body.mdx new file mode 100644 index 0000000000..eb7f6a4668 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/generate-method-body.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils/generate-method-body" +title: "generate_method_body" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils::generate_method_body" + parent: "signalwire::utils::SchemaUtils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `generate_method_body` + +Generate a Python-style method body string for a verb. Mirrors Python's generate\_method\_body(verb\_name). + +**Modifiers:** `const` + +## Signature + +```cpp +std::string generate_method_body(const std::string & verb_name) const +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 109. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/generate-method-signature.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/generate-method-signature.mdx new file mode 100644 index 0000000000..9857028ad6 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/generate-method-signature.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils/generate-method-signature" +title: "generate_method_signature" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils::generate_method_signature" + parent: "signalwire::utils::SchemaUtils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `generate_method_signature` + +Generate a Python-style method signature string for a verb. Mirrors Python's generate\_method\_signature(verb\_name). + +**Modifiers:** `const` + +## Signature + +```cpp +std::string generate_method_signature(const std::string & verb_name) const +``` + +## Parameters + + + +## Returns + +`std::string` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 105. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-all-verb-names.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-all-verb-names.mdx new file mode 100644 index 0000000000..ca26df0c41 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-all-verb-names.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils/get-all-verb-names" +title: "get_all_verb_names" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils::get_all_verb_names" + parent: "signalwire::utils::SchemaUtils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `get_all_verb_names` + +Sorted list of all known verb names. Mirrors Python's get\_all\_verb\_names(). + +**Modifiers:** `const` + +## Signature + +```cpp +std::vector< std::string > get_all_verb_names() const +``` + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 76. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-verb-parameters.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-verb-parameters.mdx new file mode 100644 index 0000000000..45f2c82d17 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-verb-parameters.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils/get-verb-parameters" +title: "get_verb_parameters" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils::get_verb_parameters" + parent: "signalwire::utils::SchemaUtils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `get_verb_parameters` + +Parameter-definition block used by code-gen tooling. Mirrors Python's get\_verb\_parameters(verb\_name). + +**Modifiers:** `const` + +## Signature + +```cpp +json get_verb_parameters(const std::string & verb_name) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 88. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-verb-properties.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-verb-properties.mdx new file mode 100644 index 0000000000..520b54796f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-verb-properties.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils/get-verb-properties" +title: "get_verb_properties" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils::get_verb_properties" + parent: "signalwire::utils::SchemaUtils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `get_verb_properties` + +The properties\[verb\_name] block for a verb, or empty when unknown. Mirrors Python's get\_verb\_properties(verb\_name). + +**Modifiers:** `const` + +## Signature + +```cpp +json get_verb_properties(const std::string & verb_name) const +``` + +## Parameters + + + +## Returns + +`json` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 80. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-verb-required-properties.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-verb-required-properties.mdx new file mode 100644 index 0000000000..45b6097862 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/get-verb-required-properties.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils/get-verb-required-properties" +title: "get_verb_required_properties" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils::get_verb_required_properties" + parent: "signalwire::utils::SchemaUtils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `get_verb_required_properties` + +The required list for a verb, or empty when unknown / not specified. Mirrors Python's get\_verb\_required\_properties(verb\_name). + +**Modifiers:** `const` + +## Signature + +```cpp +std::vector< std::string > get_verb_required_properties( + const std::string & verb_name +) const +``` + +## Parameters + + + +## Returns + +`std::vector< std::string >` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 84. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/index.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/index.mdx new file mode 100644 index 0000000000..36eb23577a --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/index.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils" +title: "SchemaUtils" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils" + parent: "signalwire::utils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `SchemaUtils` + +SchemaUtils — C++ port of signalwire.utils.schema\_utils.SchemaUtils. + +## Signature + +```cpp +class signalwire::utils::SchemaUtils +``` + +## Methods + + + + Whether full JSON Schema validation is wired up. Mirrors Python's full\_validation\_available property. + + + + Generate a Python-style method body string for a verb. Mirrors Python's generate\_method\_body(verb\_name). + + + + Generate a Python-style method signature string for a verb. Mirrors Python's generate\_method\_signature(verb\_name). + + + + Sorted list of all known verb names. Mirrors Python's get\_all\_verb\_names(). + + + + Parameter-definition block used by code-gen tooling. Mirrors Python's get\_verb\_parameters(verb\_name). + + + + The properties\[verb\_name] block for a verb, or empty when unknown. Mirrors Python's get\_verb\_properties(verb\_name). + + + + The required list for a verb, or empty when unknown / not specified. Mirrors Python's get\_verb\_required\_properties(verb\_name). + + + + Read and parse the JSON Schema. Mirrors Python's load\_schema(). + + + + Construct a SchemaUtils. Mirrors Python's SchemaUtils(schema\_path=None, schema\_validation=True). Pass schema\_path = "" to use the embedded schema. + + + + Validate a complete SWML document. Mirrors Python's validate\_document(document). Returns (false, \["Schema validator not initialized"]) when no full validator is wired in. + + + + Validate a verb config against the schema. Mirrors Python's validate\_verb(verb\_name, verb\_config). Returns (valid, errors) — Python's Tuple\[bool, List\[str]]. + + + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 60. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/load-schema.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/load-schema.mdx new file mode 100644 index 0000000000..41b35e9c8f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/load-schema.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils/load-schema" +title: "load_schema" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils::load_schema" + parent: "signalwire::utils::SchemaUtils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `load_schema` + +Read and parse the JSON Schema. Mirrors Python's load\_schema(). + +## Signature + +```cpp +json load_schema() +``` + +## Returns + +`json` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 72. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/schema-utils.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/schema-utils.mdx new file mode 100644 index 0000000000..972c0feb6c --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/schema-utils.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils/schema-utils" +title: "SchemaUtils" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils::SchemaUtils" + parent: "signalwire::utils::SchemaUtils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `SchemaUtils` + +Construct a SchemaUtils. Mirrors Python's SchemaUtils(schema\_path=None, schema\_validation=True). Pass schema\_path = "" to use the embedded schema. + +## Signature + +```cpp +void SchemaUtils( + const std::string & schema_path = "", + bool schema_validation = true +) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 65. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/validate-document.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/validate-document.mdx new file mode 100644 index 0000000000..bda39131ea --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/validate-document.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils/validate-document" +title: "validate_document" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils::validate_document" + parent: "signalwire::utils::SchemaUtils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `validate_document` + +Validate a complete SWML document. Mirrors Python's validate\_document(document). Returns (false, \["Schema validator not initialized"]) when no full validator is wired in. + +**Modifiers:** `const` + +## Signature + +```cpp +std::pair< bool, std::vector< std::string > > validate_document( + const json & document +) const +``` + +## Parameters + + + +## Returns + +`std::pair< bool, std::vector< std::string > >` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 101. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/validate-verb.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/validate-verb.mdx new file mode 100644 index 0000000000..a7db41dc22 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-utils/validate-verb.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-utils/validate-verb" +title: "validate_verb" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaUtils::validate_verb" + parent: "signalwire::utils::SchemaUtils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `validate_verb` + +Validate a verb config against the schema. Mirrors Python's validate\_verb(verb\_name, verb\_config). Returns (valid, errors) — Python's Tuple\[bool, List\[str]]. + +**Modifiers:** `const` + +## Signature + +```cpp +std::pair< bool, std::vector< std::string > > validate_verb( + const std::string & verb_name, + const json & verb_config +) const +``` + +## Parameters + + + + + +## Returns + +`std::pair< bool, std::vector< std::string > >` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 94. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/errors.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/errors.mdx new file mode 100644 index 0000000000..694a43155e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/errors.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-validation-error/errors" +title: "errors" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaValidationError::errors" + parent: "signalwire::utils::SchemaValidationError" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `errors` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::vector< std::string > & errors() const +``` + +## Returns + +`const std::vector< std::string > &` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 42. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/index.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/index.mdx new file mode 100644 index 0000000000..bba45bf1b3 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-validation-error" +title: "SchemaValidationError" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::utils::SchemaValidationError" + parent: "signalwire::utils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `SchemaValidationError` + +SchemaValidationError — C++ port of signalwire.utils.schema\_utils.SchemaValidationError. + +## Signature + +```cpp +class signalwire::utils::SchemaValidationError : std::runtime_error +``` + +## Inheritance + +**Extends:** `std::runtime_error` + +## Methods + + + + + + + + + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 34. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/schema-validation-error.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/schema-validation-error.mdx new file mode 100644 index 0000000000..4369ef9c96 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/schema-validation-error.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-validation-error/schema-validation-error" +title: "SchemaValidationError" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaValidationError::SchemaValidationError" + parent: "signalwire::utils::SchemaValidationError" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `SchemaValidationError` + +**Modifiers:** `inline` + +## Signature + +```cpp +void SchemaValidationError( + std::string verb_name, + std::vector< std::string > errors +) +``` + +## Parameters + + + + + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 36. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/verb-name.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/verb-name.mdx new file mode 100644 index 0000000000..c2b98b707f --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/schema-validation-error/verb-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/utils/schema-validation-error/verb-name" +title: "verb_name" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "method" + language: "cpp" + qualified_name: "signalwire::utils::SchemaValidationError::verb_name" + parent: "signalwire::utils::SchemaValidationError" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `verb_name` + +**Modifiers:** `const` `inline` + +## Signature + +```cpp +const std::string & verb_name() const +``` + +## Returns + +`const std::string &` + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 41. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/index.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/index.mdx new file mode 100644 index 0000000000..b621382bb2 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/cpp/signalwire/utils/url-validator" +title: "url_validator" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "signalwire::utils::url_validator" + parent: "signalwire::utils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/url_validator.hpp" +--- +# `url_validator` + +## Signature + +```cpp +namespace signalwire::utils::url_validator +``` + +## Constants + + + Cross-port SSRF block list. Order matches the Python reference for ease of cross-language review. + + +## Functions + + + + Install a custom resolver (for tests). Pass nullptr to clear. + + + + Validate that a URL is safe to fetch. Mirrors Python's signalwire.utils.url\_validator.validate\_url(url, allow\_private=False) -> bool. + + + +## Type Aliases + + + + Pluggable resolver. Tests inject a callable to keep the suite hermetic; production resolves via getaddrinfo. Returns nullopt on resolution failure. The signature: function(hostname) -> optional\> of IP-string addresses. + + + +## Source + +[`include/signalwire/utils/url_validator.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/url_validator.hpp) + +Line 16. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/resolver-fn.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/resolver-fn.mdx new file mode 100644 index 0000000000..ea09990318 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/resolver-fn.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/cpp/signalwire/utils/url-validator/resolver-fn" +title: "ResolverFn" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "type_alias" + language: "cpp" + qualified_name: "signalwire::utils::url_validator::ResolverFn" + parent: "signalwire::utils::url_validator" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/url_validator.hpp" + visibility: "public" +--- +# `ResolverFn` + +Pluggable resolver. Tests inject a callable to keep the suite hermetic; production resolves via getaddrinfo. Returns nullopt on resolution failure. +The signature: function(hostname) -> optional\> of IP-string addresses. + +## Signature + +```cpp +typedef std::function< std::optional< std::vector< std::string > >(const std::string &)> ResolverFn +``` + +## Source + +[`include/signalwire/utils/url_validator.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/url_validator.hpp) + +Line 32. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/set-resolver.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/set-resolver.mdx new file mode 100644 index 0000000000..ec43a7b654 --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/set-resolver.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/cpp/signalwire/utils/url-validator/set-resolver" +title: "_set_resolver" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::utils::url_validator::_set_resolver" + parent: "signalwire::utils::url_validator" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/utils/url_validator.cpp" + visibility: "public" +--- +# `_set_resolver` + +Install a custom resolver (for tests). Pass nullptr to clear. + +## Signature + +```cpp +void _set_resolver(ResolverFn resolver) +``` + +## Parameters + + + +## Source + +[`src/utils/url_validator.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/utils/url_validator.cpp) + +Line 185. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/validate-url.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/validate-url.mdx new file mode 100644 index 0000000000..76906f9def --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/url-validator/validate-url.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/cpp/signalwire/utils/url-validator/validate-url" +title: "validate_url" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "function" + language: "cpp" + qualified_name: "signalwire::utils::url_validator::validate_url" + parent: "signalwire::utils::url_validator" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/utils/url_validator.cpp" + visibility: "public" +--- +# `validate_url` + +Validate that a URL is safe to fetch. +Mirrors Python's signalwire.utils.url\_validator.validate\_url(url, allow\_private=False) -> bool. + +url + +URL to validate. + +allow\_private + +When true, bypass the IP-blocklist check. + +True iff the URL is safe to fetch. + +## Signature + +```cpp +bool validate_url(const std::string & url, bool allow_private = false) +``` + +## Parameters + + + URL to validate. + + + + When true, bypass the IP-blocklist check. + + +## Returns + +`bool` — True iff the URL is safe to fetch. + +## Source + +[`src/utils/url_validator.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/utils/url_validator.cpp) + +Line 189. diff --git a/fern/products/sdk-reference/cpp/signalwire/utils/verb-info/index.mdx b/fern/products/sdk-reference/cpp/signalwire/utils/verb-info/index.mdx new file mode 100644 index 0000000000..e285cfb12e --- /dev/null +++ b/fern/products/sdk-reference/cpp/signalwire/utils/verb-info/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/cpp/signalwire/utils/verb-info" +title: "VerbInfo" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "class" + language: "cpp" + qualified_name: "signalwire::utils::VerbInfo" + parent: "signalwire::utils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp" + visibility: "public" +--- +# `VerbInfo` + +Verb metadata extracted from the schema. + +## Signature + +```cpp +struct signalwire::utils::VerbInfo +``` + +## Properties + + + + + + + +## Source + +[`include/signalwire/utils/schema_utils.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/utils/schema_utils.hpp) + +Line 52. diff --git a/fern/products/sdk-reference/cpp/std/index.mdx b/fern/products/sdk-reference/cpp/std/index.mdx new file mode 100644 index 0000000000..34b84a663c --- /dev/null +++ b/fern/products/sdk-reference/cpp/std/index.mdx @@ -0,0 +1,25 @@ +--- +slug: "/reference/cpp/std" +title: "std" +sdk_label: "C++ SDK" +icon: "cpp" +lustri: + auto_generated: true + kind: "module" + language: "cpp" + qualified_name: "std" + source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/[generated]" +--- +# `std` + +## Signature + +```cpp +namespace std +``` + +## Source + +[`[generated]`](https://github.com/signalwire/signalwire-cpp/blob/main/[generated]) + +Line 1. diff --git a/fern/products/sdk-reference/dotnet/_meta.json b/fern/products/sdk-reference/dotnet/_meta.json new file mode 100644 index 0000000000..e7189f19a5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/_meta.json @@ -0,0 +1,10 @@ +{ + "language": "dotnet", + "sdk_name": "dotnet-sdk", + "version": null, + "source_repo": "https://github.com/signalwire/signalwire-dotnet", + "format": "mdx", + "platform": "fern", + "base_slug": "/reference/dotnet", + "item_count": 1295 +} \ No newline at end of file diff --git a/fern/products/sdk-reference/dotnet/index.mdx b/fern/products/sdk-reference/dotnet/index.mdx new file mode 100644 index 0000000000..3a9b85240c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/index.mdx @@ -0,0 +1,30 @@ +--- +title: ".NET SDK" +slug: "/reference/dotnet" +lustri: + auto_generated: true + language: "dotnet" + kind: "sdk" +--- +# .NET SDK Reference + +## Modules + +- [`SignalWire.Agent`](/reference/dotnet/signal-wire.agent) +- [`SignalWire.Contexts`](/reference/dotnet/signal-wire.contexts) +- [`SignalWire.DataMap`](/reference/dotnet/signal-wire.data-map) +- [`SignalWire.Logging`](/reference/dotnet/signal-wire.logging) +- [`SignalWire.POM`](/reference/dotnet/signal-wire.pom) +- [`SignalWire.Prefabs`](/reference/dotnet/signal-wire.prefabs) +- [`SignalWire.Relay`](/reference/dotnet/signal-wire.relay) +- [`SignalWire.REST`](/reference/dotnet/signal-wire.rest) +- [`SignalWire.REST.Namespaces`](/reference/dotnet/signal-wire.rest.namespaces) +- [`SignalWire.Security`](/reference/dotnet/signal-wire.security) +- [`SignalWire.Server`](/reference/dotnet/signal-wire.server) +- [`SignalWire.Serverless`](/reference/dotnet/signal-wire.serverless) +- [`SignalWire.Skills`](/reference/dotnet/signal-wire.skills) +- [`SignalWire.Skills.Builtin`](/reference/dotnet/signal-wire.skills.builtin) +- [`SignalWire.SWAIG`](/reference/dotnet/signal-wire.swaig) +- [`SignalWire.SWML`](/reference/dotnet/signal-wire.swml) +- [`SignalWire.Utils`](/reference/dotnet/signal-wire.utils) + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-answer-verb.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-answer-verb.mdx new file mode 100644 index 0000000000..9fe0a44c54 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-answer-verb.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-answer-verb" +title: "AddAnswerVerb" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddAnswerVerb(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddAnswerVerb` + +Alias for <xref href="SignalWire.Agent.AgentBase.AddPostAnswerVerb(System.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d)" data-throw-if-not-resolved="false"></xref>. + +## Signature + + + + ```dotnet + public AgentBase AddAnswerVerb(string verb, Dictionary config) + ``` + + + + ```dotnet + public AgentBase AddAnswerVerb(Dictionary config) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`SignalWire.Agent.AgentBase` + +## Returns (Overload 2) + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 812. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-function-include-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-function-include-dictionary-string-object.mdx new file mode 100644 index 0000000000..e856255b00 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-function-include-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-function-include-dictionary-string-object" +title: "AddFunctionInclude(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddFunctionInclude(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddFunctionInclude(Dictionary)` + +## Signature + +```dotnet +public AgentBase AddFunctionInclude(Dictionary include) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 771. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-hint-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-hint-string.mdx new file mode 100644 index 0000000000..bc5e4c0eb0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-hint-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-hint-string" +title: "AddHint(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddHint(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddHint(string)` + +## Signature + +```dotnet +public AgentBase AddHint(string hint) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 480. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-hints-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-hints-list-string.mdx new file mode 100644 index 0000000000..02aa025a94 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-hints-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-hints-list-string" +title: "AddHints(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddHints(System.Collections.Generic.List)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddHints(List)` + +## Signature + +```dotnet +public AgentBase AddHints(List hints) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 486. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-internal-filler.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-internal-filler.mdx new file mode 100644 index 0000000000..c4b4e548b7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-internal-filler.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-internal-filler" +title: "AddInternalFiller" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddInternalFiller(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddInternalFiller` + +Add internal fillers for a single internal function and language. + +<p>See +<xref href="SignalWire.Agent.AgentBase.SetInternalFillers(System.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Collections.Generic.List%7bSystem.String%7d%7d%7d)" data-throw-if-not-resolved="false"></xref> +for the complete list of supported function names and what fillers +do. Names outside the supported set log a warning.</p> + +## Signature + + + + ```dotnet + public AgentBase AddInternalFiller(string filler) + ``` + + + + ```dotnet + public AgentBase AddInternalFiller(string functionName, string languageCode, List fillers) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + + + +## Returns (Overload 1) + +`SignalWire.Agent.AgentBase` + +## Returns (Overload 2) + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 730. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-language.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-language.mdx new file mode 100644 index 0000000000..5a55f4e7b6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-language.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-language" +title: "AddLanguage" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddLanguage(string, string, string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddLanguage` + +Add a language configuration with optional per-language engine-specific +params (e.g. voice stability/similarity for ElevenLabs, model knobs). +The <code>params</code> key is only emitted into SWML when non-empty, so +existing language entries stay byte-identical when no params are passed. +Mirrors signalwire-python's <code>AIConfigMixin.add\_language(params=...)</code>. + +## Signature + + + + ```dotnet + public AgentBase AddLanguage(string name, string code, string voice) + ``` + + + + ```dotnet + public AgentBase AddLanguage(string name, string code, string voice, Dictionary? languageParams) + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Parameters (Overload 2) + + + Language name (e.g. "English"). + + + + Language code (e.g. "en-US"). + + + + TTS voice name or combined "engine.voice:model". + + + + Optional engine-specific params dict. <code>null</code> or empty omits the SWML <code>params</code> key. + + +## Returns (Overload 1) + +`SignalWire.Agent.AgentBase` + +## Returns (Overload 2) + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 498. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-pattern-hint-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-pattern-hint-string.mdx new file mode 100644 index 0000000000..04fafb7698 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-pattern-hint-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-pattern-hint-string" +title: "AddPatternHint(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddPatternHint(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddPatternHint(string)` + +## Signature + +```dotnet +public AgentBase AddPatternHint(string pattern) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 492. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-post-ai-verb-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-post-ai-verb-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..efdc9e7f80 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-post-ai-verb-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-post-ai-verb-string-dictionary-string-object" +title: "AddPostAiVerb(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddPostAiVerb(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddPostAiVerb(string, Dictionary)` + +## Signature + +```dotnet +public AgentBase AddPostAiVerb(string verb, Dictionary config) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 825. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-post-answer-verb-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-post-answer-verb-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..ab4bb9ecc4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-post-answer-verb-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-post-answer-verb-string-dictionary-string-object" +title: "AddPostAnswerVerb(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddPostAnswerVerb(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddPostAnswerVerb(string, Dictionary)` + +## Signature + +```dotnet +public AgentBase AddPostAnswerVerb(string verb, Dictionary config) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 805. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-pre-answer-verb-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-pre-answer-verb-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..8aa11b7b31 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-pre-answer-verb-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-pre-answer-verb-string-dictionary-string-object" +title: "AddPreAnswerVerb(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddPreAnswerVerb(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddPreAnswerVerb(string, Dictionary)` + +## Signature + +```dotnet +public AgentBase AddPreAnswerVerb(string verb, Dictionary config) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 799. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-pronunciation-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-pronunciation-string-string-string.mdx new file mode 100644 index 0000000000..27eb9a10ba --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-pronunciation-string-string-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-pronunciation-string-string-string" +title: "AddPronunciation(string, string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddPronunciation(string, string, string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddPronunciation(string, string, string)` + +## Signature + +```dotnet +public AgentBase AddPronunciation(string replace, string with, string ignore = "") +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 594. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-skill-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-skill-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..156efca3c0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-skill-string-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-skill-string-dictionary-string-object" +title: "AddSkill(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddSkill(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddSkill(string, Dictionary?)` + +Load and activate a skill by name. Resolves through <xref href="SignalWire.Skills.SkillRegistry" data-throw-if-not-resolved="false"></xref>, +validates env vars, calls Setup/RegisterTools, and merges hints/globalData/prompts. + +## Signature + +```dotnet +public AgentBase AddSkill(string name, Dictionary? parameters = null) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 927. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-swaig-query-params-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-swaig-query-params-dictionary-string-string.mdx new file mode 100644 index 0000000000..f3a5daa1ac --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/add-swaig-query-params-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/add-swaig-query-params-dictionary-string-string" +title: "AddSwaigQueryParams(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AddSwaigQueryParams(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AddSwaigQueryParams(Dictionary)` + +## Signature + +```dotnet +public AgentBase AddSwaigQueryParams(Dictionary parameters) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1008. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/agent-base-agent-options.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/agent-base-agent-options.mdx new file mode 100644 index 0000000000..bf7e981c52 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/agent-base-agent-options.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/agent-base-agent-options" +title: "AgentBase(AgentOptions)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AgentBase(SignalWire.Agent.AgentOptions)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AgentBase(AgentOptions)` + +## Signature + +```dotnet +public AgentBase(AgentOptions options) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 145. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/auto-map-sip-usernames.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/auto-map-sip-usernames.mdx new file mode 100644 index 0000000000..c7868462df --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/auto-map-sip-usernames.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/auto-map-sip-usernames" +title: "AutoMapSipUsernames()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.AutoMapSipUsernames()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AutoMapSipUsernames()` + +Enable auto-mapping of SIP usernames to this agent's +route (Python parity: `agent.auto_map_sip_usernames()`). +Chainable. + +## Signature + +```dotnet +public AgentBase AutoMapSipUsernames() +``` + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 914. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/build-ai-verb-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/build-ai-verb-dictionary-string-string.mdx new file mode 100644 index 0000000000..de9a510b1c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/build-ai-verb-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/build-ai-verb-dictionary-string-string" +title: "BuildAiVerb(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.BuildAiVerb(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `BuildAiVerb(Dictionary?)` + +Build the AI verb configuration block. + +## Signature + +```dotnet +public Dictionary BuildAiVerb(Dictionary? headers = null) +``` + +## Parameters + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1146. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..2098199af9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-post-ai-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/clear-post-ai-verbs" +title: "ClearPostAiVerbs()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.ClearPostAiVerbs()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `ClearPostAiVerbs()` + +## Signature + +```dotnet +public AgentBase ClearPostAiVerbs() +``` + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 843. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..b434d56c1b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-post-answer-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/clear-post-answer-verbs" +title: "ClearPostAnswerVerbs()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.ClearPostAnswerVerbs()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `ClearPostAnswerVerbs()` + +## Signature + +```dotnet +public AgentBase ClearPostAnswerVerbs() +``` + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 837. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..7e8ec9ef62 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-pre-answer-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/clear-pre-answer-verbs" +title: "ClearPreAnswerVerbs()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.ClearPreAnswerVerbs()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `ClearPreAnswerVerbs()` + +## Signature + +```dotnet +public AgentBase ClearPreAnswerVerbs() +``` + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 831. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-swaig-query-params.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..5403b0a771 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clear-swaig-query-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/clear-swaig-query-params" +title: "ClearSwaigQueryParams()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.ClearSwaigQueryParams()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `ClearSwaigQueryParams()` + +## Signature + +```dotnet +public AgentBase ClearSwaigQueryParams() +``` + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1017. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clone-for-request.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clone-for-request.mdx new file mode 100644 index 0000000000..dd09445a59 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/clone-for-request.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/clone-for-request" +title: "CloneForRequest()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.CloneForRequest()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `CloneForRequest()` + +Create a deep copy of this agent for per-request customisation. +Collections are deeply copied; callbacks are preserved by reference. + +## Signature + +```dotnet +public AgentBase CloneForRequest() +``` + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1429. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/contexts.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/contexts.mdx new file mode 100644 index 0000000000..89efd2dc46 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/contexts.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/contexts" +title: "Contexts()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.Contexts()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `Contexts()` + +Alias for <xref href="SignalWire.Agent.AgentBase.DefineContexts" data-throw-if-not-resolved="false"></xref>. + +## Signature + +```dotnet +public ContextBuilder Contexts() +``` + +## Returns + +`SignalWire.Contexts.ContextBuilder` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 871. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/create-tool-token-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/create-tool-token-string-string.mdx new file mode 100644 index 0000000000..2f48c72ae0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/create-tool-token-string-string.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/create-tool-token-string-string" +title: "CreateToolToken(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.CreateToolToken(string, string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `CreateToolToken(string, string)` + +Create a per-call SWAIG-function token. Returns empty +string on failure. (Python parity: `StateMixin._create_tool_token`.) + +## Signature + +```dotnet +public string CreateToolToken(string toolName, string callId) +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 441. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/define-contexts.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/define-contexts.mdx new file mode 100644 index 0000000000..992bc56895 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/define-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/define-contexts" +title: "DefineContexts()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.DefineContexts()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `DefineContexts()` + +Return the ContextBuilder, creating it lazily on first access. +The builder is wired to report registered SWAIG tool names back +so its <xref href="SignalWire.Contexts.ContextBuilder.Validate" data-throw-if-not-resolved="false"></xref> can check for +collisions with reserved native tool names (<code>next\_step</code>, <code>change\_context</code>, <code>gather\_submit</code>). + +## Signature + +```dotnet +public ContextBuilder DefineContexts() +``` + +## Returns + +`SignalWire.Contexts.ContextBuilder` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 860. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/enable-debug-events-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/enable-debug-events-string.mdx new file mode 100644 index 0000000000..a4c5d9fdfe --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/enable-debug-events-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/enable-debug-events-string" +title: "EnableDebugEvents(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.EnableDebugEvents(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `EnableDebugEvents(string)` + +## Signature + +```dotnet +public AgentBase EnableDebugEvents(string level = "all") +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 765. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/enable-sip-routing-bool-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/enable-sip-routing-bool-string.mdx new file mode 100644 index 0000000000..59d0920d2d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/enable-sip-routing-bool-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/enable-sip-routing-bool-string" +title: "EnableSipRouting(bool, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.EnableSipRouting(bool, string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `EnableSipRouting(bool, string)` + +Enable SIP routing on this agent. `autoMap` opts into Python's +auto-mapping behaviour (sip\_username = agent name); `path` lets +the caller pin a specific SIP route prefix. + +## Signature + +```dotnet +public AgentBase EnableSipRouting(bool autoMap = false, string path = "") +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1046. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-contexts.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-contexts.mdx new file mode 100644 index 0000000000..16bef27078 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-contexts.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/get-contexts" +title: "GetContexts()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.GetContexts()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `GetContexts()` + +Return the contexts configuration if defined, else null. +(Python parity: `PromptManager.get_contexts`.) + +## Signature + +```dotnet +public Dictionary? GetContexts() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 392. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-language-params-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-language-params-string.mdx new file mode 100644 index 0000000000..e1f867f1f3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-language-params-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/get-language-params-string" +title: "GetLanguageParams(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.GetLanguageParams(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `GetLanguageParams(string)` + +Read the per-language <code>params</code> dict for a previously-added +language. Returns <code>null</code> when the params were never set or +when the code is unknown — no exception path, matching Python. + +## Signature + +```dotnet +public Dictionary? GetLanguageParams(string code) +``` + +## Parameters + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 571. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-name.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-name.mdx new file mode 100644 index 0000000000..92313f3095 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/get-name" +title: "GetName()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.GetName()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `GetName()` + +Return the agent name (Python parity: `agent.get_name()`). + +## Signature + +```dotnet +public string GetName() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 905. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-post-prompt.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-post-prompt.mdx new file mode 100644 index 0000000000..bda4311672 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-post-prompt.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/get-post-prompt" +title: "GetPostPrompt()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.GetPostPrompt()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `GetPostPrompt()` + +Return the post-prompt text if set, else null. +(Python parity: `PromptManager.get_post_prompt`.) + +## Signature + +```dotnet +public string? GetPostPrompt() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 388. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-prompt-sections.mdx new file mode 100644 index 0000000000..7c938e7d5f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-prompt-sections.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.GetPromptSections()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `GetPromptSections()` + +The raw POM section dicts. Mirrors how the dotnet +agent has historically stored its prompt-object data and how +SWML rendering consumes it. Read-only snapshot. + +## Signature + +```dotnet +public IReadOnlyList> GetPromptSections() +``` + +## Returns + +`IReadOnlyList>` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 437. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-prompt.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-prompt.mdx new file mode 100644 index 0000000000..827250baa0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-prompt.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/get-prompt" +title: "GetPrompt()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.GetPrompt()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `GetPrompt()` + +Return the prompt payload: POM array if enabled and populated, otherwise raw text. + +## Signature + +```dotnet +public object GetPrompt() +``` + +## Returns + +`object` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 373. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-raw-prompt.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-raw-prompt.mdx new file mode 100644 index 0000000000..db6092f0ab --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-raw-prompt.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/get-raw-prompt" +title: "GetRawPrompt()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.GetRawPrompt()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `GetRawPrompt()` + +Return the raw prompt text if set, else null. +(Python parity: `PromptManager.get_raw_prompt`.) + +## Signature + +```dotnet +public string? GetRawPrompt() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 384. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-skill-manager.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-skill-manager.mdx new file mode 100644 index 0000000000..bde9b51ee9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/get-skill-manager.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/get-skill-manager" +title: "GetSkillManager()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.GetSkillManager()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `GetSkillManager()` + +Return the skill manager, creating it lazily on first access. + +## Signature + +```dotnet +public SkillManager GetSkillManager() +``` + +## Returns + +`SignalWire.Skills.SkillManager` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 895. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/handle-post-prompt-dictionary-string-object-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/handle-post-prompt-dictionary-string-object-dictionary-string-string.mdx new file mode 100644 index 0000000000..1b2bcb172a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/handle-post-prompt-dictionary-string-object-dictionary-string-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/handle-post-prompt-dictionary-string-object-dictionary-string-string" +title: "HandlePostPrompt(Dictionary?, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.HandlePostPrompt(System.Collections.Generic.Dictionary?, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "protected" +--- +# `HandlePostPrompt(Dictionary?, Dictionary)` + +Handle the post-prompt callback. + +**Modifiers:** `override` + +## Signature + +```dotnet +protected override (int, Dictionary, string) HandlePostPrompt(Dictionary? requestData, Dictionary headers) +``` + +## Parameters + + + + + +## Returns + +`System.ValueTuple,string>` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1384. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/handle-request-string-string-dictionary-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/handle-request-string-string-dictionary-string-string-string.mdx new file mode 100644 index 0000000000..72d967e9e6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/handle-request-string-string-dictionary-string-string-string.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/handle-request-string-string-dictionary-string-string-string" +title: "HandleRequest(string, string, Dictionary, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.HandleRequest(string, string, System.Collections.Generic.Dictionary, string?)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `HandleRequest(string, string, Dictionary, string?)` + +Override the base dispatch to enforce webhook signature validation on +POST requests targeting the signed routes (<code>/</code>, <code>/swaig</code>, <code>/post\_prompt</code>) when <xref href="SignalWire.Agent.AgentBase.SigningKey" data-throw-if-not-resolved="false"></xref> is configured. + +<p>Validation is gated behind Basic Auth: callers must already +satisfy the SWMLService basic-auth check (it always runs first in +<xref href="SignalWire.SWML.Service.HandleRequest(System.String%2cSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.String%7d%2cSystem.String)" data-throw-if-not-resolved="false"></xref>) before we even look at +signatures, matching Python where <code>signing_key</code> is layered on +top of <code>basic_auth</code>.</p> + +<p>On invalid signature: returns 403 directly without dispatching +to the agent's POST handler. On valid signature (or non-POST, or +non-signed route): delegates to <xref href="SignalWire.SWML.Service.HandleRequest(System.String%2cSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.String%7d%2cSystem.String)" data-throw-if-not-resolved="false"></xref>. +</p> + +<p>(Python parity: <code>web_mixin._register_routes</code> wraps the +signed POST routes in a FastAPI <code>Depends(sig_dep)</code> dependency +when <code>signing_key</code> is set; this is the .NET equivalent.)</p> + +**Modifiers:** `override` + +## Signature + +```dotnet +public override (int Status, Dictionary Headers, string Body) HandleRequest(string method, string path, Dictionary headers, string? body) +``` + +## Parameters + + + + + + + + + +## Returns + +`System.ValueTuple,string>` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1275. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/handle-swml-request-string-dictionary-string-object-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/handle-swml-request-string-dictionary-string-object-dictionary-string-string.mdx new file mode 100644 index 0000000000..2acafa4364 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/handle-swml-request-string-dictionary-string-object-dictionary-string-string.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/handle-swml-request-string-dictionary-string-object-dictionary-string-string" +title: "HandleSwmlRequest(string, Dictionary?, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.HandleSwmlRequest(string, System.Collections.Generic.Dictionary?, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "protected" +--- +# `HandleSwmlRequest(string, Dictionary?, Dictionary)` + +Handle the SWML document request. If a dynamic-config callback is registered, +clone the agent, pass the clone to the callback, and render from the clone. + +**Modifiers:** `override` + +## Signature + +```dotnet +protected override (int, Dictionary, string) HandleSwmlRequest(string method, Dictionary? requestData, Dictionary headers) +``` + +## Parameters + + + + + + + +## Returns + +`System.ValueTuple,string>` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1350. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/has-skill-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/has-skill-string.mdx new file mode 100644 index 0000000000..e2f9fea692 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/has-skill-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/has-skill-string" +title: "HasSkill(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.HasSkill(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `HasSkill(string)` + +Check if a skill is loaded by instance key. + +## Signature + +```dotnet +public bool HasSkill(string name) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 969. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/index.mdx new file mode 100644 index 0000000000..0d26c72af5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/index.mdx @@ -0,0 +1,280 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base" +title: "AgentBase" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase" + parent: "SignalWire.Agent" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AgentBase` + +AI agent built on <xref href="SignalWire.SWML.Service" data-throw-if-not-resolved="false"></xref>. Provides prompt management, SWAIG tool dispatch, +context switching, skill stubs, and a 5-phase SWML rendering pipeline. +All configuration methods return <code>this</code> for fluent chaining. + +## Signature + +```dotnet +public class AgentBase : Service +``` + +## Inheritance + +**Extends:** [SignalWire.SWML.Service](/reference/dotnet/signal-wire.swml/service) + +## Properties + + + + + True iff signature validation is enabled — i.e. either the <code>SigningKey</code> option or <code>SIGNALWIRE\_SIGNING\_KEY</code> env var was set at construction time. (Python parity: <code>bool(agent.signing\_key)</code>.) + + + + The prompt as a <xref href="SignalWire.POM.PromptObjectModel" data-throw-if-not-resolved="false"></xref> instance (Python parity: `agent.pom`). Returns null when <code>UsePom</code> is false. Materialised on each access from the internal list-of-dicts so mutations stay round-trip-safe. To inspect raw section dicts, use <xref href="SignalWire.Agent.AgentBase.GetPromptSections" data-throw-if-not-resolved="false"></xref>. + + + + The configured Signing Key, or null when validation is disabled. Read-only — the resolution order (constructor arg → <code>SIGNALWIRE\_SIGNING\_KEY</code> env) is fixed at construction time. (Python parity: <code>agent.signing\_key</code>.) + + + + Skill manager (Python parity: `agent.skill_manager`). + + + + The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — <xref href="SignalWire.Agent.AgentBase.SetInternalFillers(System.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Collections.Generic.List%7bSystem.String%7d%7d%7d)" data-throw-if-not-resolved="false"></xref> and <xref href="SignalWire.Agent.AgentBase.AddInternalFiller(System.String%2cSystem.String%2cSystem.Collections.Generic.List%7bSystem.String%7d)" data-throw-if-not-resolved="false"></xref> warn if you pass an unknown name. Notable absences: <code>change\_step</code>, <code>gather\_submit</code>, or arbitrary user-defined SWAIG function names are NOT supported. + + +## Methods + + + + Alias for <xref href="SignalWire.Agent.AgentBase.AddPostAnswerVerb(System.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d)" data-throw-if-not-resolved="false"></xref>. + + + + + + + + + + Add internal fillers for a single internal function and language. <p>See <xref href="SignalWire.Agent.AgentBase.SetInternalFillers(System.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Collections.Generic.List%7bSystem.String%7d%7d%7d)" data-throw-if-not-resolved="false"></xref> for the complete list of supported function names and what fillers do. Names outside the supported set log a warning.</p> + + + + Add a language configuration with optional per-language engine-specific params (e.g. voice stability/similarity for ElevenLabs, model knobs). The <code>params</code> key is only emitted into SWML when non-empty, so existing language entries stay byte-identical when no params are passed. Mirrors signalwire-python's <code>AIConfigMixin.add\_language(params=...)</code>. + + + + + + + + + + + + + + Load and activate a skill by name. Resolves through <xref href="SignalWire.Skills.SkillRegistry" data-throw-if-not-resolved="false"></xref>, validates env vars, calls Setup/RegisterTools, and merges hints/globalData/prompts. + + + + + + + + Enable auto-mapping of SIP usernames to this agent's route (Python parity: `agent.auto_map_sip_usernames()`). Chainable. + + + + Build the AI verb configuration block. + + + + + + + + + + + + Create a deep copy of this agent for per-request customisation. Collections are deeply copied; callbacks are preserved by reference. + + + + Alias for <xref href="SignalWire.Agent.AgentBase.DefineContexts" data-throw-if-not-resolved="false"></xref>. + + + + Create a per-call SWAIG-function token. Returns empty string on failure. (Python parity: `StateMixin._create_tool_token`.) + + + + Return the ContextBuilder, creating it lazily on first access. The builder is wired to report registered SWAIG tool names back so its <xref href="SignalWire.Contexts.ContextBuilder.Validate" data-throw-if-not-resolved="false"></xref> can check for collisions with reserved native tool names (<code>next\_step</code>, <code>change\_context</code>, <code>gather\_submit</code>). + + + + + + Enable SIP routing on this agent. `autoMap` opts into Python's auto-mapping behaviour (sip\_username = agent name); `path` lets the caller pin a specific SIP route prefix. + + + + Return the contexts configuration if defined, else null. (Python parity: `PromptManager.get_contexts`.) + + + + Read the per-language <code>params</code> dict for a previously-added language. Returns <code>null</code> when the params were never set or when the code is unknown — no exception path, matching Python. + + + + Return the agent name (Python parity: `agent.get_name()`). + + + + Return the post-prompt text if set, else null. (Python parity: `PromptManager.get_post_prompt`.) + + + + Return the prompt payload: POM array if enabled and populated, otherwise raw text. + + + + The raw POM section dicts. Mirrors how the dotnet agent has historically stored its prompt-object data and how SWML rendering consumes it. Read-only snapshot. + + + + Return the raw prompt text if set, else null. (Python parity: `PromptManager.get_raw_prompt`.) + + + + Return the skill manager, creating it lazily on first access. + + + + Handle the post-prompt callback. + + + + Override the base dispatch to enforce webhook signature validation on POST requests targeting the signed routes (<code>/</code>, <code>/swaig</code>, <code>/post\_prompt</code>) when <xref href="SignalWire.Agent.AgentBase.SigningKey" data-throw-if-not-resolved="false"></xref> is configured. <p>Validation is gated behind Basic Auth: callers must already satisfy the SWMLService basic-auth check (it always runs first in <xref href="SignalWire.SWML.Service.HandleRequest(System.String%2cSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.String%7d%2cSystem.String)" data-throw-if-not-resolved="false"></xref>) before we even look at signatures, matching Python where <code>signing\_key</code> is layered on top of <code>basic\_auth</code>.</p> <p>On invalid signature: returns 403 directly without dispatching to the agent's POST handler. On valid signature (or non-POST, or non-signed route): delegates to <xref href="SignalWire.SWML.Service.HandleRequest(System.String%2cSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.String%7d%2cSystem.String)" data-throw-if-not-resolved="false"></xref>. </p> <p>(Python parity: <code>web\_mixin.\_register\_routes</code> wraps the signed POST routes in a FastAPI <code>Depends(sig\_dep)</code> dependency when <code>signing\_key</code> is set; this is the .NET equivalent.)</p> + + + + Handle the SWML document request. If a dynamic-config callback is registered, clone the agent, pass the clone to the callback, and render from the clone. + + + + Check if a skill is loaded by instance key. + + + + List all loaded skill instance keys. + + + + Manually override the proxy URL used for SWAIG webhook construction. + + + + + + + + Add a top-level POM section with an optional body, bullets, numbering, and subsections. (Python parity: `prompt_add_section`.) + + + + Add a subsection nested under an existing parent section. (Python parity: `prompt_add_subsection(parent_title, title, body, bullets)`.) + + + + Append body text, a single bullet, and/or bullets list to an existing section. (Python parity: `prompt_add_to_section(title, body, bullet, bullets)`.) + + + + Check whether a POM section with the given title exists. + + + + Register a SIP username under this agent's own route — Python equivalent of `register_sip_username(self, sip_username)`. + + + + Remove a loaded skill by its instance key. + + + + Build the complete SWML document. <p>Phases: 1) Pre-answer verbs 2) Answer 3) Record call 4) Post-answer verbs 5) AI verb 6) Post-AI verbs</p> + + + + Render with request body and headers context. + + + + Remove all contexts, returning the agent to a no-contexts state. This is a convenience wrapper around <code>DefineContexts().Reset()</code>. Use it in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + + + + + + + + + + Set internal fillers for native SWAIG functions. <p>Internal fillers are short phrases the AI agent speaks (via TTS) while an internal/native function is running, so the caller doesn't hear dead air during transitions or background work.</p> <p>Supported function names (match the SWAIGInternalFiller schema): <code>hangup</code>, <code>check\_time</code>, <code>wait\_for\_user</code>, <code>wait\_seconds</code>, <code>adjust\_response\_latency</code>, <code>next\_step</code>, <code>change\_context</code>, <code>get\_visual\_input</code>, <code>get\_ideal\_strategy</code>. See <xref href="SignalWire.Agent.AgentBase.SupportedInternalFillerNames" data-throw-if-not-resolved="false"></xref>.</p> <p>Notably NOT supported: <code>change\_step</code>, <code>gather\_submit</code>, or arbitrary user-defined SWAIG function names. The runtime only honors fillers for the names listed above; everything else is silently ignored at the SWML level. This method warns at registration time if you pass an unknown name so you catch the typo early.</p> + + + + Set (or replace) the per-language <code>params</code> dict on an already-added language. Useful when language entries are built up via <xref href="SignalWire.Agent.AgentBase.AddLanguage(System.String%2cSystem.String%2cSystem.String)" data-throw-if-not-resolved="false"></xref> first and engine-specific tuning is added later (e.g., from a config loader). Empty dict removes the key. No-op if <code class="paramref">code</code> isn't found — matches Python's silent-skip behavior. + + + + + + + + + + + + + + + + + + + + Set the prompt as a list-of-section dicts (POM form). Throws when `UsePom` is false. (Python parity: `PromptManager.set_prompt_pom`.) + + + + + + + + + + + + Validate a per-call SWAIG-function token. Rejects when the function is not registered, when the SessionManager rejects the token, or on any error. (Python parity: `StateMixin.validate_tool_token`.) + + + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 51. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/list-skills.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/list-skills.mdx new file mode 100644 index 0000000000..91bca45dbf --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/list-skills.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/list-skills" +title: "ListSkills()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.ListSkills()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `ListSkills()` + +List all loaded skill instance keys. + +## Signature + +```dotnet +public List ListSkills() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 959. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/manual-set-proxy-url-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/manual-set-proxy-url-string.mdx new file mode 100644 index 0000000000..ebdef37ff3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/manual-set-proxy-url-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/manual-set-proxy-url-string" +title: "ManualSetProxyUrl(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.ManualSetProxyUrl(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `ManualSetProxyUrl(string)` + +Manually override the proxy URL used for SWAIG webhook construction. + +## Signature + +```dotnet +public AgentBase ManualSetProxyUrl(string url) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1002. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/on-debug-event-action-dictionary-string-object-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/on-debug-event-action-dictionary-string-object-dictionary-string-string.mdx new file mode 100644 index 0000000000..fc1d0a3cd2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/on-debug-event-action-dictionary-string-object-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/on-debug-event-action-dictionary-string-object-dictionary-string-string" +title: "OnDebugEvent(Action?, Dictionary>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.OnDebugEvent(System.Action?, System.Collections.Generic.Dictionary>)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `OnDebugEvent(Action?, Dictionary>)` + +## Signature + +```dotnet +public AgentBase OnDebugEvent(Action?, Dictionary> callback) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1030. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/on-summary-action-string-dictionary-string-object-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/on-summary-action-string-dictionary-string-object-dictionary-string-string.mdx new file mode 100644 index 0000000000..afabfb0bb0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/on-summary-action-string-dictionary-string-object-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/on-summary-action-string-dictionary-string-object-dictionary-string-string" +title: "OnSummary(Action?, Dictionary>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.OnSummary(System.Action?, System.Collections.Generic.Dictionary>)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `OnSummary(Action?, Dictionary>)` + +## Signature + +```dotnet +public AgentBase OnSummary(Action?, Dictionary> callback) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1023. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-add-section-string-string-list-string-bool-bool-list-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-add-section-string-string-list-string-bool-bool-list-dictionary-string-object.mdx new file mode 100644 index 0000000000..70f0da5eb2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-add-section-string-string-list-string-bool-bool-list-dictionary-string-object.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/prompt-add-section-string-string-list-string-bool-bool-list-dictionary-string-object" +title: "PromptAddSection(string, string, List?, bool, bool, List>?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.PromptAddSection(string, string, System.Collections.Generic.List?, bool, bool, System.Collections.Generic.List>?)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `PromptAddSection(string, string, List?, bool, bool, List>?)` + +Add a top-level POM section with an optional body, bullets, +numbering, and subsections. (Python parity: `prompt_add_section`.) + +## Signature + +```dotnet +public AgentBase PromptAddSection(string title, string body = "", List? bullets = null, bool numbered = false, bool numberedBullets = false, List>? subsections = null) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 263. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-add-subsection-string-string-string-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-add-subsection-string-string-string-list-string.mdx new file mode 100644 index 0000000000..172ecdd2d4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-add-subsection-string-string-string-list-string.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/prompt-add-subsection-string-string-string-list-string" +title: "PromptAddSubsection(string, string, string, List?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.PromptAddSubsection(string, string, string, System.Collections.Generic.List?)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `PromptAddSubsection(string, string, string, List?)` + +Add a subsection nested under an existing parent section. +(Python parity: `prompt_add_subsection(parent_title, title, body, bullets)`.) + +## Signature + +```dotnet +public AgentBase PromptAddSubsection(string parentTitle, string title, string body = "", List? bullets = null) +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 293. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-add-to-section-string-string-string-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-add-to-section-string-string-string-list-string.mdx new file mode 100644 index 0000000000..2e99d18164 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-add-to-section-string-string-string-list-string.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/prompt-add-to-section-string-string-string-list-string" +title: "PromptAddToSection(string, string?, string?, List?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.PromptAddToSection(string, string?, string?, System.Collections.Generic.List?)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `PromptAddToSection(string, string?, string?, List?)` + +Append body text, a single bullet, and/or bullets list to an +existing section. (Python parity: +`prompt_add_to_section(title, body, bullet, bullets)`.) + +## Signature + +```dotnet +public AgentBase PromptAddToSection(string title, string? body = null, string? bullet = null, List? bullets = null) +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 327. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-has-section-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-has-section-string.mdx new file mode 100644 index 0000000000..9f80511edc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/prompt-has-section-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/prompt-has-section-string" +title: "PromptHasSection(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.PromptHasSection(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `PromptHasSection(string)` + +Check whether a POM section with the given title exists. + +## Signature + +```dotnet +public bool PromptHasSection(string title) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 365. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/register-sip-username.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/register-sip-username.mdx new file mode 100644 index 0000000000..05a03f8dee --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/register-sip-username.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/register-sip-username" +title: "RegisterSipUsername" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.RegisterSipUsername(string, string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `RegisterSipUsername` + +Register a SIP username under this agent's own route — Python +equivalent of `register_sip_username(self, sip_username)`. + +## Signature + + + + ```dotnet + public AgentBase RegisterSipUsername(string username, string route = "") + ``` + + + + ```dotnet + public AgentBase RegisterSipUsername(string username) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`SignalWire.Agent.AgentBase` + +## Returns (Overload 2) + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1054. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/remove-skill-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/remove-skill-string.mdx new file mode 100644 index 0000000000..70034b2c66 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/remove-skill-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/remove-skill-string" +title: "RemoveSkill(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.RemoveSkill(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `RemoveSkill(string)` + +Remove a loaded skill by its instance key. + +## Signature + +```dotnet +public AgentBase RemoveSkill(string name) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 949. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/render-swml-with-context-dictionary-string-object-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/render-swml-with-context-dictionary-string-object-dictionary-string-string.mdx new file mode 100644 index 0000000000..e64373c57a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/render-swml-with-context-dictionary-string-object-dictionary-string-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/render-swml-with-context-dictionary-string-object-dictionary-string-string" +title: "RenderSwmlWithContext(Dictionary?, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.RenderSwmlWithContext(System.Collections.Generic.Dictionary?, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `RenderSwmlWithContext(Dictionary?, Dictionary)` + +Render with request body and headers context. + +## Signature + +```dotnet +public Dictionary RenderSwmlWithContext(Dictionary? requestBody, Dictionary headers) +``` + +## Parameters + + + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1084. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/render-swml.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/render-swml.mdx new file mode 100644 index 0000000000..9de0073ad8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/render-swml.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/render-swml" +title: "RenderSwml()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.RenderSwml()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `RenderSwml()` + +Build the complete SWML document. + +<p>Phases: 1) Pre-answer verbs 2) Answer 3) Record call +4) Post-answer verbs 5) AI verb 6) Post-AI verbs</p> + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Dictionary RenderSwml() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 1078. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/reset-contexts.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/reset-contexts.mdx new file mode 100644 index 0000000000..702f9d65b6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/reset-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/reset-contexts" +title: "ResetContexts()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.ResetContexts()" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `ResetContexts()` + +Remove all contexts, returning the agent to a no-contexts state. +This is a convenience wrapper around <code>DefineContexts().Reset()</code>. +Use it in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```dotnet +public AgentBase ResetContexts() +``` + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 882. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-dynamic-config-callback-action-dictionary-string-object-dictionary-string-object-dictionary-string-string-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-dynamic-config-callback-action-dictionary-string-object-dictionary-string-object-dictionary-string-string-agent-base.mdx new file mode 100644 index 0000000000..cd7f74e968 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-dynamic-config-callback-action-dictionary-string-object-dictionary-string-object-dictionary-string-string-agent-base.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-dynamic-config-callback-action-dictionary-string-object-dictionary-string-object-dictionary-string-string-agent-base" +title: "SetDynamicConfigCallback(Action?, Dictionary?, Dictionary, AgentBase>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetDynamicConfigCallback(System.Action?, System.Collections.Generic.Dictionary?, System.Collections.Generic.Dictionary, SignalWire.Agent.AgentBase>)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetDynamicConfigCallback(Action?, Dictionary?, Dictionary, AgentBase>)` + +## Signature + +```dotnet +public AgentBase SetDynamicConfigCallback(Action?, Dictionary?, Dictionary, AgentBase> callback) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 982. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-function-includes-list-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-function-includes-list-dictionary-string-object.mdx new file mode 100644 index 0000000000..df757739d5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-function-includes-list-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-function-includes-list-dictionary-string-object" +title: "SetFunctionIncludes(List>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetFunctionIncludes(System.Collections.Generic.List>)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetFunctionIncludes(List>)` + +## Signature + +```dotnet +public AgentBase SetFunctionIncludes(List> includes) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 777. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-global-data-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-global-data-dictionary-string-object.mdx new file mode 100644 index 0000000000..d088a2a5ae --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-global-data-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-global-data-dictionary-string-object" +title: "SetGlobalData(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetGlobalData(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetGlobalData(Dictionary)` + +## Signature + +```dotnet +public AgentBase SetGlobalData(Dictionary data) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 627. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-internal-fillers.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-internal-fillers.mdx new file mode 100644 index 0000000000..119321a38d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-internal-fillers.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-internal-fillers" +title: "SetInternalFillers" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetInternalFillers(System.Collections.Generic.List)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetInternalFillers` + +Set internal fillers for native SWAIG functions. + +<p>Internal fillers are short phrases the AI agent speaks (via +TTS) while an internal/native function is running, so the caller +doesn't hear dead air during transitions or background work.</p> + +<p>Supported function names (match the SWAIGInternalFiller +schema): <code>hangup</code>, <code>check_time</code>, <code>wait_for_user</code>, +<code>wait_seconds</code>, <code>adjust_response_latency</code>, +<code>next_step</code>, <code>change_context</code>, <code>get_visual_input</code>, +<code>get_ideal_strategy</code>. See +<xref href="SignalWire.Agent.AgentBase.SupportedInternalFillerNames" data-throw-if-not-resolved="false"></xref>.</p> + +<p>Notably NOT supported: <code>change_step</code>, +<code>gather_submit</code>, or arbitrary user-defined SWAIG function +names. The runtime only honors fillers for the names listed above; +everything else is silently ignored at the SWML level. This method +warns at registration time if you pass an unknown name so you +catch the typo early.</p> + +## Signature + + + + ```dotnet + public AgentBase SetInternalFillers(List fillers) + ``` + + + + ```dotnet + public AgentBase SetInternalFillers(Dictionary>> fillers) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`SignalWire.Agent.AgentBase` + +## Returns (Overload 2) + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 672. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-language-params-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-language-params-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..776ce70edb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-language-params-string-dictionary-string-object.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-language-params-string-dictionary-string-object" +title: "SetLanguageParams(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetLanguageParams(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetLanguageParams(string, Dictionary)` + +Set (or replace) the per-language <code>params</code> dict on an +already-added language. Useful when language entries are built +up via <xref href="SignalWire.Agent.AgentBase.AddLanguage(System.String%2cSystem.String%2cSystem.String)" data-throw-if-not-resolved="false"></xref> first and +engine-specific tuning is added later (e.g., from a config loader). +Empty dict removes the key. No-op if <code class="paramref">code</code> isn't +found — matches Python's silent-skip behavior. + +## Signature + +```dotnet +public AgentBase SetLanguageParams(string code, Dictionary languageParams) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 546. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-languages-list-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-languages-list-dictionary-string-object.mdx new file mode 100644 index 0000000000..e372507227 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-languages-list-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-languages-list-dictionary-string-object" +title: "SetLanguages(List>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetLanguages(System.Collections.Generic.List>)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetLanguages(List>)` + +## Signature + +```dotnet +public AgentBase SetLanguages(List> languages) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 588. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-native-functions-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-native-functions-list-string.mdx new file mode 100644 index 0000000000..a93471255f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-native-functions-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-native-functions-list-string" +title: "SetNativeFunctions(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetNativeFunctions(System.Collections.Generic.List)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetNativeFunctions(List)` + +## Signature + +```dotnet +public AgentBase SetNativeFunctions(List functions) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 642. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-param-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-param-string-object.mdx new file mode 100644 index 0000000000..b19fc67ca7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-param-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-param-string-object" +title: "SetParam(string, object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetParam(string, object)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetParam(string, object)` + +## Signature + +```dotnet +public AgentBase SetParam(string key, object value) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 615. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-params-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-params-dictionary-string-object.mdx new file mode 100644 index 0000000000..9fe6076c11 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-params-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-params-dictionary-string-object" +title: "SetParams(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetParams(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetParams(Dictionary)` + +## Signature + +```dotnet +public AgentBase SetParams(Dictionary parameters) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 621. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-llm-params-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-llm-params-dictionary-string-object.mdx new file mode 100644 index 0000000000..24469db26e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-llm-params-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-llm-params-dictionary-string-object" +title: "SetPostPromptLlmParams(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetPostPromptLlmParams(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetPostPromptLlmParams(Dictionary)` + +## Signature + +```dotnet +public AgentBase SetPostPromptLlmParams(Dictionary parameters) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 789. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-string.mdx new file mode 100644 index 0000000000..5ea6874f69 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-string" +title: "SetPostPrompt(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetPostPrompt(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetPostPrompt(string)` + +## Signature + +```dotnet +public AgentBase SetPostPrompt(string text) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 255. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-url-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-url-string.mdx new file mode 100644 index 0000000000..511db922ee --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-url-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-post-prompt-url-string" +title: "SetPostPromptUrl(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetPostPromptUrl(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetPostPromptUrl(string)` + +## Signature + +```dotnet +public AgentBase SetPostPromptUrl(string url) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 995. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-prompt-llm-params-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-prompt-llm-params-dictionary-string-object.mdx new file mode 100644 index 0000000000..da82b1d92b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-prompt-llm-params-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-prompt-llm-params-dictionary-string-object" +title: "SetPromptLlmParams(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetPromptLlmParams(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetPromptLlmParams(Dictionary)` + +## Signature + +```dotnet +public AgentBase SetPromptLlmParams(Dictionary parameters) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 783. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-prompt-pom-list-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-prompt-pom-list-dictionary-string-object.mdx new file mode 100644 index 0000000000..3585200593 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-prompt-pom-list-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-prompt-pom-list-dictionary-string-object" +title: "SetPromptPom(List>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetPromptPom(System.Collections.Generic.List>)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetPromptPom(List>)` + +Set the prompt as a list-of-section dicts (POM form). +Throws when `UsePom` is false. (Python parity: +`PromptManager.set_prompt_pom`.) + +## Signature + +```dotnet +public AgentBase SetPromptPom(List> pom) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 398. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-prompt-text-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-prompt-text-string.mdx new file mode 100644 index 0000000000..2b12bd973a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-prompt-text-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-prompt-text-string" +title: "SetPromptText(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetPromptText(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetPromptText(string)` + +## Signature + +```dotnet +public AgentBase SetPromptText(string text) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 249. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-pronunciations-list-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-pronunciations-list-dictionary-string-object.mdx new file mode 100644 index 0000000000..ef64badf1f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-pronunciations-list-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-pronunciations-list-dictionary-string-object" +title: "SetPronunciations(List>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetPronunciations(System.Collections.Generic.List>)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetPronunciations(List>)` + +## Signature + +```dotnet +public AgentBase SetPronunciations(List> pronunciations) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 609. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-web-hook-url-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-web-hook-url-string.mdx new file mode 100644 index 0000000000..61add09054 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/set-web-hook-url-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/set-web-hook-url-string" +title: "SetWebHookUrl(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.SetWebHookUrl(string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `SetWebHookUrl(string)` + +## Signature + +```dotnet +public AgentBase SetWebHookUrl(string url) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 989. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/update-global-data-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/update-global-data-dictionary-string-object.mdx new file mode 100644 index 0000000000..4889c3b1e9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/update-global-data-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/update-global-data-dictionary-string-object" +title: "UpdateGlobalData(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.UpdateGlobalData(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `UpdateGlobalData(Dictionary)` + +## Signature + +```dotnet +public AgentBase UpdateGlobalData(Dictionary data) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 633. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/validate-tool-token-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/validate-tool-token-string-string-string.mdx new file mode 100644 index 0000000000..d1561e0587 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-base/validate-tool-token-string-string-string.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-base/validate-tool-token-string-string-string" +title: "ValidateToolToken(string, string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentBase.ValidateToolToken(string, string, string)" + parent: "SignalWire.Agent.AgentBase" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `ValidateToolToken(string, string, string)` + +Validate a per-call SWAIG-function token. Rejects +when the function is not registered, when the SessionManager +rejects the token, or on any error. (Python parity: +`StateMixin.validate_tool_token`.) + +## Signature + +```dotnet +public bool ValidateToolToken(string functionName, string token, string callId) +``` + +## Parameters + + + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 457. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-options/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-options/index.mdx new file mode 100644 index 0000000000..c69df5ffbf --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/agent-options/index.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/dotnet/signal-wire.agent/agent-options" +title: "AgentOptions" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Agent.AgentOptions" + parent: "SignalWire.Agent" + module: "SignalWire.Agent" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs" + visibility: "public" +--- +# `AgentOptions` + +Configuration options for an AI agent, extending the base SWML service options. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class AgentOptions +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + Optional SignalWire Signing Key (from Dashboard → API Credentials). When set, webhook signature validation is enforced on POST /, /swaig, /post\_prompt — unsigned or invalidly-signed requests get a 403. Falls back to the <code>SIGNALWIRE\_SIGNING\_KEY</code> env var if not passed. See <code>porting-sdk/webhooks.md</code> for the contract. (Python parity: <code>AgentBase.**init**(signing\_key=...)</code>.) + + + + If true, honor <code>X-Forwarded-Proto</code> / <code>X-Forwarded-Host</code> headers when reconstructing the URL for signature validation. Default false because proxy headers are spoofable; opt in only when you control the proxy chain. (Python parity: <code>AgentBase.**init**(trust\_proxy\_for\_signature=...)</code>.) + + + + +## Source + +[`src/SignalWire/Agent/AgentBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Agent/AgentBase.cs) + +Line 12. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.agent/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.agent/index.mdx new file mode 100644 index 0000000000..c20b527bf7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.agent/index.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/dotnet/signal-wire.agent" +title: "SignalWire.Agent" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.Agent" +--- +# `SignalWire.Agent` + +## Classes + + + + AI agent built on <xref href="SignalWire.SWML.Service" data-throw-if-not-resolved="false"></xref>. Provides prompt management, SWAIG tool dispatch, context switching, skill stubs, and a 5-phase SWML rendering pipeline. All configuration methods return <code>this</code> for fluent chaining. + + + + Configuration options for an AI agent, extending the base SWML service options. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/add-context-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/add-context-string.mdx new file mode 100644 index 0000000000..5bf312da03 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/add-context-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context-builder/add-context-string" +title: "AddContext(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.ContextBuilder.AddContext(string)" + parent: "SignalWire.Contexts.ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddContext(string)` + +## Signature + +```dotnet +public Context AddContext(string name) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 622. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/attach-tool-name-supplier-func-i-enumerable-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/attach-tool-name-supplier-func-i-enumerable-string.mdx new file mode 100644 index 0000000000..dbc5744942 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/attach-tool-name-supplier-func-i-enumerable-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context-builder/attach-tool-name-supplier-func-i-enumerable-string" +title: "AttachToolNameSupplier(Func>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.ContextBuilder.AttachToolNameSupplier(System.Func>)" + parent: "SignalWire.Contexts.ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AttachToolNameSupplier(Func>)` + +Attach a supplier that returns registered SWAIG tool names so <xref href="SignalWire.Contexts.ContextBuilder.Validate" data-throw-if-not-resolved="false"></xref> can check them against <xref href="SignalWire.Contexts.ReservedToolNames.Reserved" data-throw-if-not-resolved="false"></xref>. Called internally by <code>AgentBase.DefineContexts()</code>. + +## Signature + +```dotnet +public ContextBuilder AttachToolNameSupplier(Func> supplier) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.ContextBuilder` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 604. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/create-simple-context-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/create-simple-context-string.mdx new file mode 100644 index 0000000000..dc5b05e8c0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/create-simple-context-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context-builder/create-simple-context-string" +title: "CreateSimpleContext(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.ContextBuilder.CreateSimpleContext(string)" + parent: "SignalWire.Contexts.ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `CreateSimpleContext(string)` + +**Modifiers:** `static` + +## Signature + +```dotnet +public static ContextBuilder CreateSimpleContext(string name) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.ContextBuilder` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 807. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/get-context-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/get-context-string.mdx new file mode 100644 index 0000000000..2922d7613b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/get-context-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context-builder/get-context-string" +title: "GetContext(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.ContextBuilder.GetContext(string)" + parent: "SignalWire.Contexts.ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `GetContext(string)` + +## Signature + +```dotnet +public Context? GetContext(string name) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 635. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/has-contexts.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/has-contexts.mdx new file mode 100644 index 0000000000..3a0e4eabb1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/has-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context-builder/has-contexts" +title: "HasContexts()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.ContextBuilder.HasContexts()" + parent: "SignalWire.Contexts.ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `HasContexts()` + +## Signature + +```dotnet +public bool HasContexts() +``` + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 636. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/index.mdx new file mode 100644 index 0000000000..5ebbf8b7a8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/index.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context-builder" +title: "ContextBuilder" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Contexts.ContextBuilder" + parent: "SignalWire.Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `ContextBuilder` + +Builder for multi-step, multi-context AI agent workflows. + +<p>A ContextBuilder owns one or more <xref href="SignalWire.Contexts.Context" data-throw-if-not-resolved="false"></xref>s; each +context owns an ordered list of <xref href="SignalWire.Contexts.Step" data-throw-if-not-resolved="false"></xref>s. Only one context +and one step is active at a time. Per chat turn, the runtime injects +the current step's instructions as a system message, then asks the LLM +for a response.</p> + +<p><b>Native tools auto-injected by the runtime:</b> When a step +(or its enclosing context) declares valid_steps or valid_contexts, the +runtime auto-injects two native tools so the model can navigate the +flow: <code>next_step</code> and <code>change_context</code>. A third native tool, +<code>gather_submit</code>, is injected during gather_info questioning. +These three names are reserved: <xref href="SignalWire.Contexts.ContextBuilder.Validate" data-throw-if-not-resolved="false"></xref> rejects any +agent that defines a SWAIG tool with one of them. See +<xref href="SignalWire.Contexts.ReservedToolNames.Reserved" data-throw-if-not-resolved="false"></xref>.</p> + +<p><b>Function whitelisting (<xref href="SignalWire.Contexts.Step.SetFunctions(System.Object)" data-throw-if-not-resolved="false"></xref>):</b> +Each step may declare a functions whitelist. The whitelist is applied +in-memory at the start of each LLM turn. CRITICALLY: if a step does +NOT declare a functions field, it INHERITS the previous step's active +set. See <xref href="SignalWire.Contexts.Step.SetFunctions(System.Object)" data-throw-if-not-resolved="false"></xref> for details and examples.</p> + +## Signature + +```dotnet +public class ContextBuilder +``` + +## Methods + + + + + + Attach a supplier that returns registered SWAIG tool names so <xref href="SignalWire.Contexts.ContextBuilder.Validate" data-throw-if-not-resolved="false"></xref> can check them against <xref href="SignalWire.Contexts.ReservedToolNames.Reserved" data-throw-if-not-resolved="false"></xref>. Called internally by <code>AgentBase.DefineContexts()</code>. + + + + + + + + + + Remove all contexts, returning the builder to its initial state. Use this in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + + + + + + + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 591. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/reset.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/reset.mdx new file mode 100644 index 0000000000..cc31c8ea0e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/reset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context-builder/reset" +title: "Reset()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.ContextBuilder.Reset()" + parent: "SignalWire.Contexts.ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `Reset()` + +Remove all contexts, returning the builder to its initial state. +Use this in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```dotnet +public ContextBuilder Reset() +``` + +## Returns + +`SignalWire.Contexts.ContextBuilder` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 615. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/to-dict.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/to-dict.mdx new file mode 100644 index 0000000000..0c385e0b47 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/to-dict.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context-builder/to-dict" +title: "ToDict()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.ContextBuilder.ToDict()" + parent: "SignalWire.Contexts.ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `ToDict()` + +## Signature + +```dotnet +public Dictionary ToDict() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 793. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/validate.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/validate.mdx new file mode 100644 index 0000000000..6a46a15b93 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context-builder/validate.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context-builder/validate" +title: "Validate()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.ContextBuilder.Validate()" + parent: "SignalWire.Contexts.ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `Validate()` + +## Signature + +```dotnet +public List Validate() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 638. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-bullets-string-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-bullets-string-list-string.mdx new file mode 100644 index 0000000000..35f3ddf768 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-bullets-string-list-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/add-bullets-string-list-string" +title: "AddBullets(string, List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.AddBullets(string, System.Collections.Generic.List)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddBullets(string, List)` + +## Signature + +```dotnet +public Context AddBullets(string title, List bullets) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 413. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-enter-filler-string-params-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-enter-filler-string-params-string.mdx new file mode 100644 index 0000000000..dd9ee3864e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-enter-filler-string-params-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/add-enter-filler-string-params-string" +title: "AddEnterFiller(string, params string[])" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.AddEnterFiller(string, params string[])" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddEnterFiller(string, params string[])` + +## Signature + +```dotnet +public Context AddEnterFiller(string lang, params string[] fillers) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 495. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-exit-filler-string-params-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-exit-filler-string-params-string.mdx new file mode 100644 index 0000000000..42f22899f1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-exit-filler-string-params-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/add-exit-filler-string-params-string" +title: "AddExitFiller(string, params string[])" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.AddExitFiller(string, params string[])" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddExitFiller(string, params string[])` + +## Signature + +```dotnet +public Context AddExitFiller(string lang, params string[] fillers) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 503. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-section-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-section-string-string.mdx new file mode 100644 index 0000000000..14b12ca13f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-section-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/add-section-string-string" +title: "AddSection(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.AddSection(string, string)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddSection(string, string)` + +## Signature + +```dotnet +public Context AddSection(string title, string body) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 405. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-step-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-step-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..656a377b66 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-step-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/add-step-string-dictionary-string-object" +title: "AddStep(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.AddStep(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddStep(string, Dictionary?)` + +## Signature + +```dotnet +public Step AddStep(string name, Dictionary? opts = null) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 350. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-system-bullets-string-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-system-bullets-string-list-string.mdx new file mode 100644 index 0000000000..3f04524b9c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-system-bullets-string-list-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/add-system-bullets-string-list-string" +title: "AddSystemBullets(string, List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.AddSystemBullets(string, System.Collections.Generic.List)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddSystemBullets(string, List)` + +## Signature + +```dotnet +public Context AddSystemBullets(string title, List bullets) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 439. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-system-section-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-system-section-string-string.mdx new file mode 100644 index 0000000000..0d808487cc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/add-system-section-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/add-system-section-string-string" +title: "AddSystemSection(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.AddSystemSection(string, string)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddSystemSection(string, string)` + +## Signature + +```dotnet +public Context AddSystemSection(string title, string body) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 431. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/context-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/context-string.mdx new file mode 100644 index 0000000000..9a4a46d430 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/context-string.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/context-string" +title: "Context(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.Context(string)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `Context(string)` + +## Signature + +```dotnet +public Context(string name) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 345. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-initial-step.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-initial-step.mdx new file mode 100644 index 0000000000..7df047323a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-initial-step.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/get-initial-step" +title: "GetInitialStep()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.GetInitialStep()" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `GetInitialStep()` + +## Signature + +```dotnet +public string? GetInitialStep() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 459. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-step-order.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-step-order.mdx new file mode 100644 index 0000000000..eab46302b9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-step-order.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/get-step-order" +title: "GetStepOrder()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.GetStepOrder()" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `GetStepOrder()` + +## Signature + +```dotnet +public List GetStepOrder() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 393. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-step-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-step-string.mdx new file mode 100644 index 0000000000..1831973df8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-step-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/get-step-string" +title: "GetStep(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.GetStep(string)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `GetStep(string)` + +## Signature + +```dotnet +public Step? GetStep(string name) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 372. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-steps.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-steps.mdx new file mode 100644 index 0000000000..d95ea25faa --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-steps.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/get-steps" +title: "GetSteps()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.GetSteps()" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `GetSteps()` + +## Signature + +```dotnet +public Dictionary GetSteps() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 392. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-valid-contexts.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-valid-contexts.mdx new file mode 100644 index 0000000000..7c0ce8d0bd --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/get-valid-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/get-valid-contexts" +title: "GetValidContexts()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.GetValidContexts()" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `GetValidContexts()` + +## Signature + +```dotnet +public List? GetValidContexts() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 511. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/index.mdx new file mode 100644 index 0000000000..b5dff18082 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/index.mdx @@ -0,0 +1,96 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context" +title: "Context" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context" + parent: "SignalWire.Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `Context` + +## Signature + +```dotnet +public class Context +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Set which step the context starts on when entered. <p>By default, a context starts on its first step (index 0). Use this to skip a preamble step on re-entry via <code>change\_context</code>.</p> + + + + Mark this context as isolated — entering it wipes conversation history. <p>When <code class="paramref">isolated</code> = true and the context is entered via change\_context, the runtime wipes the conversation array. The model starts fresh with only the new context's system\_prompt + step instructions, with no memory of prior turns.</p> <p><b>EXCEPTION — reset overrides the wipe:</b> If the context also has a reset configuration (via <xref href="SignalWire.Contexts.Context.SetConsolidate(System.Boolean)" data-throw-if-not-resolved="false"></xref> or <xref href="SignalWire.Contexts.Context.SetFullReset(System.Boolean)" data-throw-if-not-resolved="false"></xref>), the wipe is skipped in favor of the reset behavior. Use reset with consolidate=true to summarize prior history into a single message instead of dropping it entirely.</p> <p>Use cases: switching to a sensitive billing flow that should not see prior small-talk; handing off to a different agent persona; resetting after a long off-topic detour.</p> + + + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 324. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/move-step-string-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/move-step-string-int.mdx new file mode 100644 index 0000000000..4892d12494 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/move-step-string-int.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/move-step-string-int" +title: "MoveStep(string, int)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.MoveStep(string, int)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `MoveStep(string, int)` + +## Signature + +```dotnet +public Context MoveStep(string name, int position) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 383. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/remove-step-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/remove-step-string.mdx new file mode 100644 index 0000000000..bcee069747 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/remove-step-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/remove-step-string" +title: "RemoveStep(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.RemoveStep(string)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `RemoveStep(string)` + +## Signature + +```dotnet +public Context RemoveStep(string name) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 374. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-consolidate-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-consolidate-bool.mdx new file mode 100644 index 0000000000..1cbf101388 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-consolidate-bool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-consolidate-bool" +title: "SetConsolidate(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetConsolidate(bool)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetConsolidate(bool)` + +## Signature + +```dotnet +public Context SetConsolidate(bool consolidate) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 464. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-enter-fillers-dictionary-string-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-enter-fillers-dictionary-string-list-string.mdx new file mode 100644 index 0000000000..4356dfa6ac --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-enter-fillers-dictionary-string-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-enter-fillers-dictionary-string-list-string" +title: "SetEnterFillers(Dictionary>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetEnterFillers(System.Collections.Generic.Dictionary>)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetEnterFillers(Dictionary>)` + +## Signature + +```dotnet +public Context SetEnterFillers(Dictionary> fillers) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 492. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-exit-fillers-dictionary-string-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-exit-fillers-dictionary-string-list-string.mdx new file mode 100644 index 0000000000..5f3f4da3de --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-exit-fillers-dictionary-string-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-exit-fillers-dictionary-string-list-string" +title: "SetExitFillers(Dictionary>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetExitFillers(System.Collections.Generic.Dictionary>)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetExitFillers(Dictionary>)` + +## Signature + +```dotnet +public Context SetExitFillers(Dictionary> fillers) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 493. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-full-reset-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-full-reset-bool.mdx new file mode 100644 index 0000000000..4c2320910c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-full-reset-bool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-full-reset-bool" +title: "SetFullReset(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetFullReset(bool)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetFullReset(bool)` + +## Signature + +```dotnet +public Context SetFullReset(bool fullReset) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 465. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-initial-step-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-initial-step-string.mdx new file mode 100644 index 0000000000..16855f04be --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-initial-step-string.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-initial-step-string" +title: "SetInitialStep(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetInitialStep(string)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetInitialStep(string)` + +Set which step the context starts on when entered. + +<p>By default, a context starts on its first step (index 0). Use +this to skip a preamble step on re-entry via +<code>change_context</code>.</p> + +## Signature + +```dotnet +public Context SetInitialStep(string stepName) +``` + +## Parameters + + + Name of the step to start on (must exist in this context). + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 457. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-isolated-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-isolated-bool.mdx new file mode 100644 index 0000000000..6d43eaa167 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-isolated-bool.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-isolated-bool" +title: "SetIsolated(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetIsolated(bool)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetIsolated(bool)` + +Mark this context as isolated — entering it wipes conversation +history. + +<p>When <code class="paramref">isolated</code> = true and the context is +entered via change_context, the runtime wipes the conversation +array. The model starts fresh with only the new context's +system_prompt + step instructions, with no memory of prior +turns.</p> + +<p><b>EXCEPTION — reset overrides the wipe:</b> If the context +also has a reset configuration (via <xref href="SignalWire.Contexts.Context.SetConsolidate(System.Boolean)" data-throw-if-not-resolved="false"></xref> +or <xref href="SignalWire.Contexts.Context.SetFullReset(System.Boolean)" data-throw-if-not-resolved="false"></xref>), the wipe is skipped in favor of +the reset behavior. Use reset with consolidate=true to summarize +prior history into a single message instead of dropping it +entirely.</p> + +<p>Use cases: switching to a sensitive billing flow that +should not see prior small-talk; handing off to a different agent +persona; resetting after a long off-topic detour.</p> + +## Signature + +```dotnet +public Context SetIsolated(bool isolated) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 488. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-post-prompt-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-post-prompt-string.mdx new file mode 100644 index 0000000000..2d7789a9e6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-post-prompt-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-post-prompt-string" +title: "SetPostPrompt(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetPostPrompt(string)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetPostPrompt(string)` + +## Signature + +```dotnet +public Context SetPostPrompt(string postPrompt) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 463. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-prompt-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-prompt-string.mdx new file mode 100644 index 0000000000..568471b764 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-prompt-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-prompt-string" +title: "SetPrompt(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetPrompt(string)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetPrompt(string)` + +## Signature + +```dotnet +public Context SetPrompt(string prompt) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 397. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-system-prompt-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-system-prompt-string.mdx new file mode 100644 index 0000000000..68e629dc5f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-system-prompt-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-system-prompt-string" +title: "SetSystemPrompt(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetSystemPrompt(string)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetSystemPrompt(string)` + +## Signature + +```dotnet +public Context SetSystemPrompt(string systemPrompt) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 423. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-user-prompt-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-user-prompt-string.mdx new file mode 100644 index 0000000000..2ad63c9c1a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-user-prompt-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-user-prompt-string" +title: "SetUserPrompt(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetUserPrompt(string)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetUserPrompt(string)` + +## Signature + +```dotnet +public Context SetUserPrompt(string userPrompt) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 466. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-valid-contexts-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-valid-contexts-list-string.mdx new file mode 100644 index 0000000000..10e5428af9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-valid-contexts-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-valid-contexts-list-string" +title: "SetValidContexts(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetValidContexts(System.Collections.Generic.List)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetValidContexts(List)` + +## Signature + +```dotnet +public Context SetValidContexts(List contexts) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 461. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-valid-steps-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-valid-steps-list-string.mdx new file mode 100644 index 0000000000..4652b42266 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/set-valid-steps-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/set-valid-steps-list-string" +title: "SetValidSteps(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.SetValidSteps(System.Collections.Generic.List)" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetValidSteps(List)` + +## Signature + +```dotnet +public Context SetValidSteps(List steps) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Context` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 462. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/to-dict.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/to-dict.mdx new file mode 100644 index 0000000000..06070896d5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/context/to-dict.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/context/to-dict" +title: "ToDict()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Context.ToDict()" + parent: "SignalWire.Contexts.Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `ToDict()` + +## Signature + +```dotnet +public Dictionary ToDict() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 535. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/add-question-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/add-question-dictionary-string-object.mdx new file mode 100644 index 0000000000..d8d024811c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/add-question-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/gather-info/add-question-dictionary-string-object" +title: "AddQuestion(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.GatherInfo.AddQuestion(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Contexts.GatherInfo" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddQuestion(Dictionary)` + +## Signature + +```dotnet +public GatherInfo AddQuestion(Dictionary opts) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.GatherInfo` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 81. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/gather-info-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/gather-info-string-string-string.mdx new file mode 100644 index 0000000000..1c6f1d5c2a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/gather-info-string-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/gather-info/gather-info-string-string-string" +title: "GatherInfo(string?, string?, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.GatherInfo.GatherInfo(string?, string?, string?)" + parent: "SignalWire.Contexts.GatherInfo" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `GatherInfo(string?, string?, string?)` + +## Signature + +```dotnet +public GatherInfo(string? outputKey = null, string? completionAction = null, string? prompt = null) +``` + +## Parameters + + + + + + + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 74. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/index.mdx new file mode 100644 index 0000000000..fbbd467327 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/gather-info" +title: "GatherInfo" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Contexts.GatherInfo" + parent: "SignalWire.Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `GatherInfo` + +## Signature + +```dotnet +public class GatherInfo +``` + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 67. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/to-dict.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/to-dict.mdx new file mode 100644 index 0000000000..bd91a8a020 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-info/to-dict.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/gather-info/to-dict" +title: "ToDict()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.GatherInfo.ToDict()" + parent: "SignalWire.Contexts.GatherInfo" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `ToDict()` + +## Signature + +```dotnet +public Dictionary ToDict() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 90. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-question/gather-question-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-question/gather-question-dictionary-string-object.mdx new file mode 100644 index 0000000000..9a090167fb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-question/gather-question-dictionary-string-object.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/gather-question/gather-question-dictionary-string-object" +title: "GatherQuestion(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.GatherQuestion.GatherQuestion(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Contexts.GatherQuestion" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `GatherQuestion(Dictionary)` + +## Signature + +```dotnet +public GatherQuestion(Dictionary opts) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 38. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-question/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-question/index.mdx new file mode 100644 index 0000000000..d79b143019 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-question/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/gather-question" +title: "GatherQuestion" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Contexts.GatherQuestion" + parent: "SignalWire.Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `GatherQuestion` + +## Signature + +```dotnet +public class GatherQuestion +``` + +## Properties + + + +## Methods + + + + + + + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 29. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-question/to-dict.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-question/to-dict.mdx new file mode 100644 index 0000000000..9d75d15e51 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/gather-question/to-dict.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/gather-question/to-dict" +title: "ToDict()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.GatherQuestion.ToDict()" + parent: "SignalWire.Contexts.GatherQuestion" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `ToDict()` + +## Signature + +```dotnet +public Dictionary ToDict() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 50. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/index.mdx new file mode 100644 index 0000000000..676e029762 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/index.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts" +title: "SignalWire.Contexts" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.Contexts" +--- +# `SignalWire.Contexts` + +## Classes + + + + + + Builder for multi-step, multi-context AI agent workflows. <p>A ContextBuilder owns one or more <xref href="SignalWire.Contexts.Context" data-throw-if-not-resolved="false"></xref>s; each context owns an ordered list of <xref href="SignalWire.Contexts.Step" data-throw-if-not-resolved="false"></xref>s. Only one context and one step is active at a time. Per chat turn, the runtime injects the current step's instructions as a system message, then asks the LLM for a response.</p> <p><b>Native tools auto-injected by the runtime:</b> When a step (or its enclosing context) declares valid\_steps or valid\_contexts, the runtime auto-injects two native tools so the model can navigate the flow: <code>next\_step</code> and <code>change\_context</code>. A third native tool, <code>gather\_submit</code>, is injected during gather\_info questioning. These three names are reserved: <xref href="SignalWire.Contexts.ContextBuilder.Validate" data-throw-if-not-resolved="false"></xref> rejects any agent that defines a SWAIG tool with one of them. See <xref href="SignalWire.Contexts.ReservedToolNames.Reserved" data-throw-if-not-resolved="false"></xref>.</p> <p><b>Function whitelisting (<xref href="SignalWire.Contexts.Step.SetFunctions(System.Object)" data-throw-if-not-resolved="false"></xref>):</b> Each step may declare a functions whitelist. The whitelist is applied in-memory at the start of each LLM turn. CRITICALLY: if a step does NOT declare a functions field, it INHERITS the previous step's active set. See <xref href="SignalWire.Contexts.Step.SetFunctions(System.Object)" data-throw-if-not-resolved="false"></xref> for details and examples.</p> + + + + + + + + Reserved tool names auto-injected by the runtime when contexts/steps are present. User-defined SWAIG tools must not collide with these names. <ul><li><code>next\_step</code> / <code>change\_context</code> are injected when valid\_steps or valid\_contexts is set so the model can navigate the flow.</li><li><code>gather\_submit</code> is injected while a step's gather\_info is collecting answers.</li></ul> <xref href="SignalWire.Contexts.ContextBuilder.Validate" data-throw-if-not-resolved="false"></xref> rejects any agent that registers a user tool sharing one of these names — the runtime would never call the user tool because the native one wins. + + + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/reserved-tool-names/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/reserved-tool-names/index.mdx new file mode 100644 index 0000000000..bf94e86685 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/reserved-tool-names/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/reserved-tool-names" +title: "ReservedToolNames" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Contexts.ReservedToolNames" + parent: "SignalWire.Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `ReservedToolNames` + +Reserved tool names auto-injected by the runtime when contexts/steps are +present. User-defined SWAIG tools must not collide with these names. + +<ul><li><code>next_step</code> / <code>change_context</code> are injected when +valid_steps or valid_contexts is set so the model can navigate the flow.</li><li><code>gather_submit</code> is injected while a step's gather_info is +collecting answers.</li></ul> + +<xref href="SignalWire.Contexts.ContextBuilder.Validate" data-throw-if-not-resolved="false"></xref> rejects any agent that registers a +user tool sharing one of these names — the runtime would never call the +user tool because the native one wins. + +**Modifiers:** `static` + +## Signature + +```dotnet +public static class ReservedToolNames +``` + +## Properties + + + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 17. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/add-bullets-string-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/add-bullets-string-list-string.mdx new file mode 100644 index 0000000000..49b015e259 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/add-bullets-string-list-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/add-bullets-string-list-string" +title: "AddBullets(string, List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.AddBullets(string, System.Collections.Generic.List)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddBullets(string, List)` + +## Signature + +```dotnet +public Step AddBullets(string title, List bullets) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 143. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/add-gather-question-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/add-gather-question-dictionary-string-object.mdx new file mode 100644 index 0000000000..83ab2e4102 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/add-gather-question-dictionary-string-object.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/add-gather-question-dictionary-string-object" +title: "AddGatherQuestion(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.AddGatherQuestion(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddGatherQuestion(Dictionary)` + +Add a question to this step's gather\_info. Initializes gather\_info +if not yet set. + +<p><b>IMPORTANT — gather mode locks function access:</b> While +the model is asking gather questions, the runtime forcibly +deactivates ALL of the step's other functions. The only callable +tools during a gather question are:</p> + +<ul><li><code>gather_submit</code> (the native answer-submission tool)</li><li>Whatever names you pass in this question's <code>"functions"</code> +option</li></ul> + +<p><code>next_step</code> and <code>change_context</code> are also filtered +out — the model cannot navigate away until the gather completes. +This is by design: it forces a tight ask → submit → next-question +loop.</p> + +<p>If a question needs to call out to a tool (e.g. validate an +email, geocode a ZIP), list that tool name in this question's +<code>"functions"</code> option. Functions listed here are active ONLY +for this question.</p> + +## Signature + +```dotnet +public Step AddGatherQuestion(Dictionary opts) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 255. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/add-section-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/add-section-string-string.mdx new file mode 100644 index 0000000000..8c2d3d9130 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/add-section-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/add-section-string-string" +title: "AddSection(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.AddSection(string, string)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `AddSection(string, string)` + +## Signature + +```dotnet +public Step AddSection(string title, string body) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 135. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/clear-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/clear-sections.mdx new file mode 100644 index 0000000000..aeb8d1bdb8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/clear-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/clear-sections" +title: "ClearSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.ClearSections()" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `ClearSections()` + +## Signature + +```dotnet +public Step ClearSections() +``` + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 151. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/index.mdx new file mode 100644 index 0000000000..20e7916d04 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/index.mdx @@ -0,0 +1,86 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step" +title: "Step" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step" + parent: "SignalWire.Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `Step` + +## Signature + +```dotnet +public class Step +``` + +## Properties + + + + + + + + + +## Methods + + + + + + Add a question to this step's gather\_info. Initializes gather\_info if not yet set. <p><b>IMPORTANT — gather mode locks function access:</b> While the model is asking gather questions, the runtime forcibly deactivates ALL of the step's other functions. The only callable tools during a gather question are:</p> <ul><li><code>gather\_submit</code> (the native answer-submission tool)</li><li>Whatever names you pass in this question's <code>"functions"</code> option</li></ul> <p><code>next\_step</code> and <code>change\_context</code> are also filtered out — the model cannot navigate away until the gather completes. This is by design: it forces a tight ask → submit → next-question loop.</p> <p>If a question needs to call out to a tool (e.g. validate an email, geocode a ZIP), list that tool name in this question's <code>"functions"</code> option. Functions listed here are active ONLY for this question.</p> + + + + + + + + Mark this step as terminal for the step flow. <p><b>IMPORTANT:</b> <code class="paramref">end</code> = true does NOT end the conversation or hang up the call. It exits step mode entirely after this step executes — clearing the steps list, current step index, valid\_steps, and valid\_contexts. The agent keeps running, but operates only under the base system prompt and the context-level prompt; no more step instructions are injected and no more <code>next\_step</code> tool is offered.</p> <p>To actually end the call, call a hangup tool or define a hangup hook.</p> + + + + Set which non-internal functions are callable while this step is active. <p><b>IMPORTANT — inheritance behavior:</b> If you do NOT call this method, the step inherits whichever function set was active on the previous step (or the previous context's last step). The server-side runtime only resets the active set when a step explicitly declares its <code>functions</code> field. This is the most common source of bugs in multi-step agents: forgetting <xref href="SignalWire.Contexts.Step.SetFunctions(System.Object)" data-throw-if-not-resolved="false"></xref> on a later step lets the previous step's tools leak through. Best practice is to call <xref href="SignalWire.Contexts.Step.SetFunctions(System.Object)" data-throw-if-not-resolved="false"></xref> explicitly on every step that should differ from the previous one.</p> <p>Keep the per-step active set small: LLM tool selection accuracy degrades noticeably past ~7-8 simultaneously-active tools per call. Use per-step whitelisting to partition large tool collections.</p> <p>Internal functions (e.g. <code>gather\_submit</code>, hangup hook) are ALWAYS protected and cannot be deactivated by this whitelist. The native navigation tools <code>next\_step</code> and <code>change\_context</code> are injected automatically when <xref href="SignalWire.Contexts.Step.SetValidSteps(System.Collections.Generic.List%7bSystem.String%7d)" data-throw-if-not-resolved="false"></xref> / <xref href="SignalWire.Contexts.Step.SetValidContexts(System.Collections.Generic.List%7bSystem.String%7d)" data-throw-if-not-resolved="false"></xref> is used; they are not affected by this list.</p> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 105. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-end-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-end-bool.mdx new file mode 100644 index 0000000000..eb546035c9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-end-bool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-end-bool" +title: "SetEnd(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetEnd(bool)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetEnd(bool)` + +Mark this step as terminal for the step flow. + +<p><b>IMPORTANT:</b> <code class="paramref">end</code> = true does NOT end +the conversation or hang up the call. It exits step mode entirely +after this step executes — clearing the steps list, current step +index, valid_steps, and valid_contexts. The agent keeps running, +but operates only under the base system prompt and the +context-level prompt; no more step instructions are injected and +no more <code>next_step</code> tool is offered.</p> + +<p>To actually end the call, call a hangup tool or define a +hangup hook.</p> + +## Signature + +```dotnet +public Step SetEnd(bool end) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 216. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-functions-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-functions-object.mdx new file mode 100644 index 0000000000..a55d6e68dc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-functions-object.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-functions-object" +title: "SetFunctions(object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetFunctions(object)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetFunctions(object)` + +Set which non-internal functions are callable while this step is +active. + +<p><b>IMPORTANT — inheritance behavior:</b> If you do NOT call +this method, the step inherits whichever function set was active on +the previous step (or the previous context's last step). The +server-side runtime only resets the active set when a step +explicitly declares its <code>functions</code> field. This is the most +common source of bugs in multi-step agents: forgetting +<xref href="SignalWire.Contexts.Step.SetFunctions(System.Object)" data-throw-if-not-resolved="false"></xref> on a later step lets the previous step's +tools leak through. Best practice is to call +<xref href="SignalWire.Contexts.Step.SetFunctions(System.Object)" data-throw-if-not-resolved="false"></xref> explicitly on every step that should +differ from the previous one.</p> + +<p>Keep the per-step active set small: LLM tool selection +accuracy degrades noticeably past ~7-8 simultaneously-active tools +per call. Use per-step whitelisting to partition large tool +collections.</p> + +<p>Internal functions (e.g. <code>gather_submit</code>, hangup hook) +are ALWAYS protected and cannot be deactivated by this whitelist. +The native navigation tools <code>next_step</code> and +<code>change_context</code> are injected automatically when +<xref href="SignalWire.Contexts.Step.SetValidSteps(System.Collections.Generic.List%7bSystem.String%7d)" data-throw-if-not-resolved="false"></xref> / <xref href="SignalWire.Contexts.Step.SetValidContexts(System.Collections.Generic.List%7bSystem.String%7d)" data-throw-if-not-resolved="false"></xref> is +used; they are not affected by this list.</p> + +## Signature + +```dotnet +public Step SetFunctions(object functions) +``` + +## Parameters + + + One of: \
    \
  • \List\\ — whitelist of function names allowed in this step.\
  • \
  • An empty list — explicit disable-all (no user functions callable).\
  • \
  • The string \"none"\ — synonym for the empty list.\
  • \
+
+ +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 197. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-gather-info-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-gather-info-dictionary-string-object.mdx new file mode 100644 index 0000000000..b8c1566cfa --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-gather-info-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-gather-info-dictionary-string-object" +title: "SetGatherInfo(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetGatherInfo(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetGatherInfo(Dictionary)` + +## Signature + +```dotnet +public Step SetGatherInfo(Dictionary opts) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 221. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-consolidate-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-consolidate-bool.mdx new file mode 100644 index 0000000000..d306e599a5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-consolidate-bool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-reset-consolidate-bool" +title: "SetResetConsolidate(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetResetConsolidate(bool)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetResetConsolidate(bool)` + +## Signature + +```dotnet +public Step SetResetConsolidate(bool consolidate) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 264. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-full-reset-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-full-reset-bool.mdx new file mode 100644 index 0000000000..4fc9325d54 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-full-reset-bool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-reset-full-reset-bool" +title: "SetResetFullReset(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetResetFullReset(bool)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetResetFullReset(bool)` + +## Signature + +```dotnet +public Step SetResetFullReset(bool fullReset) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 265. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-system-prompt-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-system-prompt-string.mdx new file mode 100644 index 0000000000..0e2fcb640e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-system-prompt-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-reset-system-prompt-string" +title: "SetResetSystemPrompt(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetResetSystemPrompt(string)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetResetSystemPrompt(string)` + +## Signature + +```dotnet +public Step SetResetSystemPrompt(string systemPrompt) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 262. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-user-prompt-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-user-prompt-string.mdx new file mode 100644 index 0000000000..509bcdf9f8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-reset-user-prompt-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-reset-user-prompt-string" +title: "SetResetUserPrompt(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetResetUserPrompt(string)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetResetUserPrompt(string)` + +## Signature + +```dotnet +public Step SetResetUserPrompt(string userPrompt) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 263. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-skip-to-next-step-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-skip-to-next-step-bool.mdx new file mode 100644 index 0000000000..646f855823 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-skip-to-next-step-bool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-skip-to-next-step-bool" +title: "SetSkipToNextStep(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetSkipToNextStep(bool)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetSkipToNextStep(bool)` + +## Signature + +```dotnet +public Step SetSkipToNextStep(bool skip) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 219. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-skip-user-turn-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-skip-user-turn-bool.mdx new file mode 100644 index 0000000000..51ade21e3d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-skip-user-turn-bool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-skip-user-turn-bool" +title: "SetSkipUserTurn(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetSkipUserTurn(bool)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetSkipUserTurn(bool)` + +## Signature + +```dotnet +public Step SetSkipUserTurn(bool skip) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 218. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-step-criteria-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-step-criteria-string.mdx new file mode 100644 index 0000000000..a3b1a6c073 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-step-criteria-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-step-criteria-string" +title: "SetStepCriteria(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetStepCriteria(string)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetStepCriteria(string)` + +## Signature + +```dotnet +public Step SetStepCriteria(string criteria) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 158. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-text-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-text-string.mdx new file mode 100644 index 0000000000..ef3d6e4ad2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-text-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-text-string" +title: "SetText(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetText(string)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetText(string)` + +## Signature + +```dotnet +public Step SetText(string text) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 127. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-valid-contexts-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-valid-contexts-list-string.mdx new file mode 100644 index 0000000000..910ed5e997 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-valid-contexts-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-valid-contexts-list-string" +title: "SetValidContexts(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetValidContexts(System.Collections.Generic.List)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetValidContexts(List)` + +## Signature + +```dotnet +public Step SetValidContexts(List contexts) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 200. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-valid-steps-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-valid-steps-list-string.mdx new file mode 100644 index 0000000000..d957b8f9c2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/set-valid-steps-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/set-valid-steps-list-string" +title: "SetValidSteps(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.SetValidSteps(System.Collections.Generic.List)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `SetValidSteps(List)` + +## Signature + +```dotnet +public Step SetValidSteps(List steps) +``` + +## Parameters + + + +## Returns + +`SignalWire.Contexts.Step` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 199. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/step-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/step-string.mdx new file mode 100644 index 0000000000..8a404b0358 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/step-string.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/step-string" +title: "Step(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.Step(string)" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `Step(string)` + +## Signature + +```dotnet +public Step(string name) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 123. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/to-dict.mdx b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/to-dict.mdx new file mode 100644 index 0000000000..2cc2b3b66b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.contexts/step/to-dict.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.contexts/step/to-dict" +title: "ToDict()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Contexts.Step.ToDict()" + parent: "SignalWire.Contexts.Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs" + visibility: "public" +--- +# `ToDict()` + +## Signature + +```dotnet +public Dictionary ToDict() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Contexts/ContextBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Contexts/ContextBuilder.cs) + +Line 295. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/body-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/body-dictionary-string-object.mdx new file mode 100644 index 0000000000..d50974918f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/body-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/body-dictionary-string-object" +title: "Body(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.Body(System.Collections.Generic.Dictionary)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `Body(Dictionary)` + +## Signature + +```dotnet +public DataMap Body(Dictionary data) +``` + +## Parameters + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 172. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/create-expression-tool-string-string-list-dictionary-string-object-list-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/create-expression-tool-string-string-list-dictionary-string-object-list-dictionary-string-object.mdx new file mode 100644 index 0000000000..fdf01569da --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/create-expression-tool-string-string-list-dictionary-string-object-list-dictionary-string-object.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/create-expression-tool-string-string-list-dictionary-string-object-list-dictionary-string-object" +title: "CreateExpressionTool(string, string, List>, List>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.CreateExpressionTool(string, string, System.Collections.Generic.List>, System.Collections.Generic.List>)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `CreateExpressionTool(string, string, List>, List>)` + +**Modifiers:** `static` + +## Signature + +```dotnet +public static Dictionary CreateExpressionTool(string name, string purpose, List> parameters, List> expressions) +``` + +## Parameters + + + + + + + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 263. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/create-simple-api-tool-string-string-list-dictionary-string-object-string-string-object-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/create-simple-api-tool-string-string-list-dictionary-string-object-string-string-object-dictionary-string-string.mdx new file mode 100644 index 0000000000..4158877e79 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/create-simple-api-tool-string-string-list-dictionary-string-object-string-string-object-dictionary-string-string.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/create-simple-api-tool-string-string-list-dictionary-string-object-string-string-object-dictionary-string-string" +title: "CreateSimpleApiTool(string, string, List>, string, string, object, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.CreateSimpleApiTool(string, string, System.Collections.Generic.List>, string, string, object, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `CreateSimpleApiTool(string, string, List>, string, string, object, Dictionary?)` + +**Modifiers:** `static` + +## Signature + +```dotnet +public static Dictionary CreateSimpleApiTool(string name, string purpose, List> parameters, string method, string url, object output, Dictionary? headers = null) +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 244. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/data-map-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/data-map-string.mdx new file mode 100644 index 0000000000..3f78d555cc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/data-map-string.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/data-map-string" +title: "DataMap(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.DataMap(string)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `DataMap(string)` + +## Signature + +```dotnet +public DataMap(string functionName) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 22. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/description-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/description-string.mdx new file mode 100644 index 0000000000..1e0d054ede --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/description-string.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/description-string" +title: "Description(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.Description(string)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `Description(string)` + +Alias for <xref href="SignalWire.DataMap.DataMap.Purpose(System.String)" data-throw-if-not-resolved="false"></xref>. Sets the LLM-facing tool +description. This string is read by the model to decide WHEN +to call this tool. See <xref href="SignalWire.DataMap.DataMap.Purpose(System.String)" data-throw-if-not-resolved="false"></xref> for bad-vs-good +examples. + +## Signature + +```dotnet +public DataMap Description(string desc) +``` + +## Parameters + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 59. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/error-keys-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/error-keys-list-string.mdx new file mode 100644 index 0000000000..4d327b9b58 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/error-keys-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/error-keys-list-string" +title: "ErrorKeys(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.ErrorKeys(System.Collections.Generic.List)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `ErrorKeys(List)` + +## Signature + +```dotnet +public DataMap ErrorKeys(List keys) +``` + +## Parameters + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 203. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/expression-string-string-object-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/expression-string-string-object-object.mdx new file mode 100644 index 0000000000..fb05a18656 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/expression-string-string-object-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/expression-string-string-object-object" +title: "Expression(string, string, object, object?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.Expression(string, string, object, object?)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `Expression(string, string, object, object?)` + +## Signature + +```dotnet +public DataMap Expression(string testValue, string pattern, object output, object? nomatchOutput = null) +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 109. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/fallback-output-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/fallback-output-object.mdx new file mode 100644 index 0000000000..423478dd57 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/fallback-output-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/fallback-output-object" +title: "FallbackOutput(object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.FallbackOutput(object)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `FallbackOutput(object)` + +## Signature + +```dotnet +public DataMap FallbackOutput(object result) +``` + +## Parameters + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 196. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/for-each-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/for-each-dictionary-string-object.mdx new file mode 100644 index 0000000000..d7e78fd836 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/for-each-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/for-each-dictionary-string-object" +title: "ForEach(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.ForEach(System.Collections.Generic.Dictionary)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `ForEach(Dictionary)` + +## Signature + +```dotnet +public DataMap ForEach(Dictionary config) +``` + +## Parameters + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 184. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/global-error-keys-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/global-error-keys-list-string.mdx new file mode 100644 index 0000000000..6db91d104f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/global-error-keys-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/global-error-keys-list-string" +title: "GlobalErrorKeys(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.GlobalErrorKeys(System.Collections.Generic.List)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `GlobalErrorKeys(List)` + +## Signature + +```dotnet +public DataMap GlobalErrorKeys(List keys) +``` + +## Parameters + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 209. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/index.mdx new file mode 100644 index 0000000000..2ec9f67348 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/index.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map" +title: "DataMap" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap" + parent: "SignalWire.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `DataMap` + +Builds a SWAIG data-map function definition with parameters, expressions, webhooks, +and output configuration. All builder methods return <code>this</code> for fluent chaining. + +## Signature + +```dotnet +public class DataMap +``` + +## Methods + + + + + + + + + + + + Alias for <xref href="SignalWire.DataMap.DataMap.Purpose(System.String)" data-throw-if-not-resolved="false"></xref>. Sets the LLM-facing tool description. This string is read by the model to decide WHEN to call this tool. See <xref href="SignalWire.DataMap.DataMap.Purpose(System.String)" data-throw-if-not-resolved="false"></xref> for bad-vs-good examples. + + + + + + + + + + + + + + + + Add a parameter to this data-map tool — the <code class="paramref">description</code> is LLM-FACING. <p>Each parameter description is rendered into the OpenAI tool schema under <code>parameters.properties.\.description</code> and sent to the model. The model uses it to decide HOW to fill in the argument from user speech. It is prompt engineering, not developer FYI.</p> <p><b>Bad vs good:</b></p> <pre><code class="lang-csharp">BAD : .Parameter("city", "string", "the city") GOOD: .Parameter("city", "string", "The name of the city to get weather for, e.g. " + "'San Francisco'. Ask the user if they did not " + "provide one. Include the state or country if the " + "city name is ambiguous.")</code></pre> + + + + + + Set the LLM-facing tool description (the "purpose"). PROMPT ENGINEERING, not developer documentation. <p>The description string is rendered into the OpenAI tool schema <code>description</code> field on every LLM turn. The model reads it to decide WHEN to call this tool. A vague <xref href="SignalWire.DataMap.DataMap.Purpose(System.String)" data-throw-if-not-resolved="false"></xref> is the #1 cause of "the model has the right tool but doesn't call it" failures with data-map tools.</p> <p><b>Bad vs good:</b></p> <pre><code class="lang-csharp">BAD : .Purpose("weather api") GOOD: .Purpose("Get the current weather conditions and " + "forecast for a specific city. Use this " + "whenever the user asks about weather, " + "temperature, rain, or similar conditions in a " + "named location.")</code></pre> + + + + + + + + + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 8. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/output-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/output-object.mdx new file mode 100644 index 0000000000..9c0e2d03d9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/output-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/output-object" +title: "Output(object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.Output(object)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `Output(object)` + +## Signature + +```dotnet +public DataMap Output(object result) +``` + +## Parameters + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 190. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/parameter-string-string-string-bool-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/parameter-string-string-string-bool-list-string.mdx new file mode 100644 index 0000000000..74976cf47a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/parameter-string-string-string-bool-list-string.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/parameter-string-string-string-bool-list-string" +title: "Parameter(string, string, string, bool, List?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.Parameter(string, string, string, bool, System.Collections.Generic.List?)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `Parameter(string, string, string, bool, List?)` + +Add a parameter to this data-map tool — the <code class="paramref">description</code> +is LLM-FACING. + +<p>Each parameter description is rendered into the OpenAI +tool schema under <code>parameters.properties.<name>.description</code> +and sent to the model. The model uses it to decide HOW to fill +in the argument from user speech. It is prompt engineering, not +developer FYI.</p> + +<p><b>Bad vs good:</b></p> +<pre><code class="lang-csharp">BAD : .Parameter("city", "string", "the city") +GOOD: .Parameter("city", "string", + "The name of the city to get weather for, e.g. " + + "'San Francisco'. Ask the user if they did not " + + "provide one. Include the state or country if the " + + "city name is ambiguous.")</code></pre> + +## Signature + +```dotnet +public DataMap Parameter(string name, string type, string description, bool required = false, List? enumValues = null) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 81. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/params-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/params-dictionary-string-object.mdx new file mode 100644 index 0000000000..8d075c3edc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/params-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/params-dictionary-string-object" +title: "Params(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.Params(System.Collections.Generic.Dictionary)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `Params(Dictionary)` + +## Signature + +```dotnet +public DataMap Params(Dictionary data) +``` + +## Parameters + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 178. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/purpose-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/purpose-string.mdx new file mode 100644 index 0000000000..c9c1a260f7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/purpose-string.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/purpose-string" +title: "Purpose(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.Purpose(string)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `Purpose(string)` + +Set the LLM-facing tool description (the "purpose"). PROMPT +ENGINEERING, not developer documentation. + +<p>The description string is rendered into the OpenAI tool +schema <code>description</code> field on every LLM turn. The model +reads it to decide WHEN to call this tool. A vague +<xref href="SignalWire.DataMap.DataMap.Purpose(System.String)" data-throw-if-not-resolved="false"></xref> is the #1 cause of "the model has the +right tool but doesn't call it" failures with data-map tools.</p> + +<p><b>Bad vs good:</b></p> +<pre><code class="lang-csharp">BAD : .Purpose("weather api") +GOOD: .Purpose("Get the current weather conditions and " + + "forecast for a specific city. Use this " + + "whenever the user asks about weather, " + + "temperature, rain, or similar conditions in a " + + "named location.")</code></pre> + +## Signature + +```dotnet +public DataMap Purpose(string desc) +``` + +## Parameters + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 47. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/to-swaig-function.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/to-swaig-function.mdx new file mode 100644 index 0000000000..b08945b4f0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/to-swaig-function.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/to-swaig-function" +title: "ToSwaigFunction()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.ToSwaigFunction()" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `ToSwaigFunction()` + +## Signature + +```dotnet +public Dictionary ToSwaigFunction() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 215. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/webhook-expressions-list-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/webhook-expressions-list-dictionary-string-object.mdx new file mode 100644 index 0000000000..1e2f58d1b8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/webhook-expressions-list-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/webhook-expressions-list-dictionary-string-object" +title: "WebhookExpressions(List>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.WebhookExpressions(System.Collections.Generic.List>)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `WebhookExpressions(List>)` + +## Signature + +```dotnet +public DataMap WebhookExpressions(List> expressions) +``` + +## Parameters + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 166. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/webhook-string-string-dictionary-string-string-string-bool-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/webhook-string-string-dictionary-string-string-string-bool-list-string.mdx new file mode 100644 index 0000000000..cf0b58a0ec --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/data-map/webhook-string-string-dictionary-string-string-string-bool-list-string.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map/data-map/webhook-string-string-dictionary-string-string-string-bool-list-string" +title: "Webhook(string, string, Dictionary?, string, bool, List?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.DataMap.DataMap.Webhook(string, string, System.Collections.Generic.Dictionary?, string, bool, System.Collections.Generic.List?)" + parent: "SignalWire.DataMap.DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs" + visibility: "public" +--- +# `Webhook(string, string, Dictionary?, string, bool, List?)` + +## Signature + +```dotnet +public DataMap Webhook(string method, string url, Dictionary? headers = null, string formParam = "", bool inputArgsAsParams = false, List? requireArgs = null) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`SignalWire.DataMap.DataMap` + +## Source + +[`src/SignalWire/DataMap/DataMap.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/DataMap/DataMap.cs) + +Line 131. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.data-map/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.data-map/index.mdx new file mode 100644 index 0000000000..4091cc96ea --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.data-map/index.mdx @@ -0,0 +1,20 @@ +--- +slug: "/reference/dotnet/signal-wire.data-map" +title: "SignalWire.DataMap" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.DataMap" +--- +# `SignalWire.DataMap` + +## Classes + + + + Builds a SWAIG data-map function definition with parameters, expressions, webhooks, and output configuration. All builder methods return <code>this</code> for fluent chaining. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.logging/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.logging/index.mdx new file mode 100644 index 0000000000..d3cd52a1f5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.logging/index.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/dotnet/signal-wire.logging" +title: "SignalWire.Logging" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.Logging" +--- +# `SignalWire.Logging` + +## Classes + + + + + +## Enums + + + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.logging/log-level/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.logging/log-level/index.mdx new file mode 100644 index 0000000000..c39f960464 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.logging/log-level/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.logging/log-level" +title: "LogLevel" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "enum" + language: "dotnet" + qualified_name: "SignalWire.Logging.LogLevel" + parent: "SignalWire.Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs" + visibility: "public" +--- +# `LogLevel` + +## Signature + +```dotnet +public enum LogLevel +``` + +## Properties + + + + + + + + + +## Source + +[`src/SignalWire/Logging/Logger.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs) + +Line 2. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/debug-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/debug-string.mdx new file mode 100644 index 0000000000..c34cb8aed6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/debug-string.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.logging/logger/debug-string" +title: "Debug(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Logging.Logger.Debug(string)" + parent: "SignalWire.Logging.Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs" + visibility: "public" +--- +# `Debug(string)` + +## Signature + +```dotnet +public void Debug(string message) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Logging/Logger.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs) + +Line 51. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/error-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/error-string.mdx new file mode 100644 index 0000000000..db05b0dfc3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/error-string.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.logging/logger/error-string" +title: "Error(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Logging.Logger.Error(string)" + parent: "SignalWire.Logging.Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs" + visibility: "public" +--- +# `Error(string)` + +## Signature + +```dotnet +public void Error(string message) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Logging/Logger.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs) + +Line 54. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/get-logger-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/get-logger-string.mdx new file mode 100644 index 0000000000..a1551c4444 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/get-logger-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.logging/logger/get-logger-string" +title: "GetLogger(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Logging.Logger.GetLogger(string)" + parent: "SignalWire.Logging.Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs" + visibility: "public" +--- +# `GetLogger(string)` + +**Modifiers:** `static` + +## Signature + +```dotnet +public static Logger GetLogger(string name = "signalwire") +``` + +## Parameters + + + +## Returns + +`SignalWire.Logging.Logger` + +## Source + +[`src/SignalWire/Logging/Logger.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs) + +Line 30. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/index.mdx new file mode 100644 index 0000000000..10ae2f3f9f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/dotnet/signal-wire.logging/logger" +title: "Logger" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Logging.Logger" + parent: "SignalWire.Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs" + visibility: "public" +--- +# `Logger` + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class Logger +``` + +## Properties + + + + + + + +## Methods + + + + + + + + + + + + Reset all logger instances (for testing). + + + + + + + +## Source + +[`src/SignalWire/Logging/Logger.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs) + +Line 10. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/info-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/info-string.mdx new file mode 100644 index 0000000000..770529ce17 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/info-string.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.logging/logger/info-string" +title: "Info(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Logging.Logger.Info(string)" + parent: "SignalWire.Logging.Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs" + visibility: "public" +--- +# `Info(string)` + +## Signature + +```dotnet +public void Info(string message) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Logging/Logger.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs) + +Line 52. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/reset.mdx b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/reset.mdx new file mode 100644 index 0000000000..dc377a2aef --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.logging/logger/reset" +title: "Reset()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Logging.Logger.Reset()" + parent: "SignalWire.Logging.Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs" + visibility: "public" +--- +# `Reset()` + +Reset all logger instances (for testing). + +**Modifiers:** `static` + +## Signature + +```dotnet +public static void Reset() +``` + +## Source + +[`src/SignalWire/Logging/Logger.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs) + +Line 44. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/should-log-log-level.mdx b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/should-log-log-level.mdx new file mode 100644 index 0000000000..501d1ad51d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/should-log-log-level.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.logging/logger/should-log-log-level" +title: "ShouldLog(LogLevel)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Logging.Logger.ShouldLog(SignalWire.Logging.LogLevel)" + parent: "SignalWire.Logging.Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs" + visibility: "public" +--- +# `ShouldLog(LogLevel)` + +## Signature + +```dotnet +public bool ShouldLog(LogLevel level) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Logging/Logger.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs) + +Line 49. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/warn-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/warn-string.mdx new file mode 100644 index 0000000000..663a85b832 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.logging/logger/warn-string.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.logging/logger/warn-string" +title: "Warn(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Logging.Logger.Warn(string)" + parent: "SignalWire.Logging.Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs" + visibility: "public" +--- +# `Warn(string)` + +## Signature + +```dotnet +public void Warn(string message) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Logging/Logger.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Logging/Logger.cs) + +Line 53. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/index.mdx new file mode 100644 index 0000000000..44cfc1e36a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/index.mdx @@ -0,0 +1,22 @@ +--- +slug: "/reference/dotnet/signal-wire.pom" +title: "SignalWire.POM" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.POM" +--- +# `SignalWire.POM` + +## Classes + + + + + + + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/add-section-string-string-list-string-bool-bool-list-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/add-section-string-string-list-string-bool-bool-list-dictionary-string-object.mdx new file mode 100644 index 0000000000..d167a348aa --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/add-section-string-string-list-string-bool-bool-list-dictionary-string-object.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder/add-section-string-string-list-string-bool-bool-list-dictionary-string-object" +title: "AddSection(string, string, List?, bool, bool, List>?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder.AddSection(string, string, System.Collections.Generic.List?, bool, bool, System.Collections.Generic.List>?)" + parent: "SignalWire.POM.PomBuilder" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `AddSection(string, string, List?, bool, bool, List>?)` + +Add a new section. (Python parity: +`PomBuilder.add_section`.) + +## Signature + +```dotnet +public PomBuilder AddSection(string title, string body = "", List? bullets = null, bool numbered = false, bool numberedBullets = false, List>? subsections = null) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`SignalWire.POM.PomBuilder` + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 25. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/add-subsection-string-string-string-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/add-subsection-string-string-string-list-string.mdx new file mode 100644 index 0000000000..347268fd44 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/add-subsection-string-string-string-list-string.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder/add-subsection-string-string-string-list-string" +title: "AddSubsection(string, string, string, List?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder.AddSubsection(string, string, string, System.Collections.Generic.List?)" + parent: "SignalWire.POM.PomBuilder" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `AddSubsection(string, string, string, List?)` + +Add a subsection under an existing section +(auto-vivifies parent if missing). (Python parity: +`PomBuilder.add_subsection`.) + +## Signature + +```dotnet +public PomBuilder AddSubsection(string parentTitle, string title, string body = "", List? bullets = null) +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire.POM.PomBuilder` + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 83. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/add-to-section-string-string-string-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/add-to-section-string-string-string-list-string.mdx new file mode 100644 index 0000000000..cbbba77d0d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/add-to-section-string-string-string-list-string.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder/add-to-section-string-string-string-list-string" +title: "AddToSection(string, string?, string?, List?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder.AddToSection(string, string?, string?, System.Collections.Generic.List?)" + parent: "SignalWire.POM.PomBuilder" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `AddToSection(string, string?, string?, List?)` + +Add content to an existing section (auto-vivifies if +missing). (Python parity: `PomBuilder.add_to_section`.) + +## Signature + +```dotnet +public PomBuilder AddToSection(string title, string? body = null, string? bullet = null, List? bullets = null) +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire.POM.PomBuilder` + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 52. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/from-sections-list-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/from-sections-list-dictionary-string-object.mdx new file mode 100644 index 0000000000..d7a232b8d4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/from-sections-list-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder/from-sections-list-dictionary-string-object" +title: "FromSections(List>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder.FromSections(System.Collections.Generic.List>)" + parent: "SignalWire.POM.PomBuilder" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `FromSections(List>)` + +Build a PomBuilder from a list of section dicts. +(Python parity: `PomBuilder.from_sections` classmethod.) + +**Modifiers:** `static` + +## Signature + +```dotnet +public static PomBuilder FromSections(List> sections) +``` + +## Parameters + + + +## Returns + +`SignalWire.POM.PomBuilder` + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 120. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/get-section-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/get-section-string.mdx new file mode 100644 index 0000000000..d9dd0915e7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/get-section-string.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder/get-section-string" +title: "GetSection(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder.GetSection(string)" + parent: "SignalWire.POM.PomBuilder" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `GetSection(string)` + +Get a section by title, or null if absent. +(Python parity: `PomBuilder.get_section`.) + +## Signature + +```dotnet +public Section? GetSection(string title) +``` + +## Parameters + + + +## Returns + +`SignalWire.POM.Section` + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 103. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/has-section-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/has-section-string.mdx new file mode 100644 index 0000000000..f70c07397d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/has-section-string.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder/has-section-string" +title: "HasSection(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder.HasSection(string)" + parent: "SignalWire.POM.PomBuilder" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `HasSection(string)` + +Check if a section with the given title exists. +(Python parity: `PomBuilder.has_section`.) + +## Signature + +```dotnet +public bool HasSection(string title) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 99. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/index.mdx new file mode 100644 index 0000000000..d47878f1d0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/index.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder" +title: "PomBuilder" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder" + parent: "SignalWire.POM" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `PomBuilder` + +## Signature + +```dotnet +public class PomBuilder +``` + +## Properties + + + +## Methods + + + + Add a new section. (Python parity: `PomBuilder.add_section`.) + + + + Add a subsection under an existing section (auto-vivifies parent if missing). (Python parity: `PomBuilder.add_subsection`.) + + + + Add content to an existing section (auto-vivifies if missing). (Python parity: `PomBuilder.add_to_section`.) + + + + Build a PomBuilder from a list of section dicts. (Python parity: `PomBuilder.from_sections` classmethod.) + + + + Get a section by title, or null if absent. (Python parity: `PomBuilder.get_section`.) + + + + Check if a section with the given title exists. (Python parity: `PomBuilder.has_section`.) + + + + + + Render the POM as markdown. + + + + Render the POM as XML. + + + + Serialize the POM to a list of section dicts. + + + + Serialize the POM to a JSON string. + + + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 12. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/pom-builder.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/pom-builder.mdx new file mode 100644 index 0000000000..61753a0cc2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/pom-builder.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder/pom-builder" +title: "PomBuilder()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder.PomBuilder()" + parent: "SignalWire.POM.PomBuilder" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `PomBuilder()` + +## Signature + +```dotnet +public PomBuilder() +``` + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 17. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/render-markdown.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/render-markdown.mdx new file mode 100644 index 0000000000..3df0dcfd13 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/render-markdown.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder/render-markdown" +title: "RenderMarkdown()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder.RenderMarkdown()" + parent: "SignalWire.POM.PomBuilder" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `RenderMarkdown()` + +Render the POM as markdown. + +## Signature + +```dotnet +public string RenderMarkdown() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 107. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/render-xml.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/render-xml.mdx new file mode 100644 index 0000000000..2f8579bc0e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/render-xml.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder/render-xml" +title: "RenderXml()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder.RenderXml()" + parent: "SignalWire.POM.PomBuilder" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `RenderXml()` + +Render the POM as XML. + +## Signature + +```dotnet +public string RenderXml() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 110. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/to-dict.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/to-dict.mdx new file mode 100644 index 0000000000..164f27a5b1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/to-dict.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder/to-dict" +title: "ToDict()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder.ToDict()" + parent: "SignalWire.POM.PomBuilder" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `ToDict()` + +Serialize the POM to a list of section dicts. + +## Signature + +```dotnet +public List> ToDict() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 113. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/to-json.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/to-json.mdx new file mode 100644 index 0000000000..07744834a5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/pom-builder/to-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/pom-builder/to-json" +title: "ToJson()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PomBuilder.ToJson()" + parent: "SignalWire.POM.PomBuilder" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs" + visibility: "public" +--- +# `ToJson()` + +Serialize the POM to a JSON string. + +## Signature + +```dotnet +public string ToJson() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/POM/PomBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PomBuilder.cs) + +Line 116. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/add-pom-as-subsection.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/add-pom-as-subsection.mdx new file mode 100644 index 0000000000..14546c1913 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/add-pom-as-subsection.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model/add-pom-as-subsection" +title: "AddPomAsSubsection" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel.AddPomAsSubsection(string, SignalWire.POM.PromptObjectModel)" + parent: "SignalWire.POM.PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `AddPomAsSubsection` + +Add a PromptObjectModel as a subsection of an existing +section in this model, identified by title. +(Python parity: `PromptObjectModel.add_pom_as_subsection`.) + +## Signature + + + + ```dotnet + public void AddPomAsSubsection(string targetTitle, PromptObjectModel pomToAdd) + ``` + + + + ```dotnet + public void AddPomAsSubsection(Section target, PromptObjectModel pomToAdd) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + + + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 514. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/add-section-string-string-list-string-bool-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/add-section-string-string-list-string-bool-bool.mdx new file mode 100644 index 0000000000..dba84a53bc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/add-section-string-string-list-string-bool-bool.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model/add-section-string-string-list-string-bool-bool" +title: "AddSection(string?, string, List?, bool?, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel.AddSection(string?, string, System.Collections.Generic.List?, bool?, bool)" + parent: "SignalWire.POM.PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `AddSection(string?, string, List?, bool?, bool)` + +Add a top-level section to the model, returning the new +Section. Only the first added section may have a null title. +(Python parity: `PromptObjectModel.add_section`.) + +## Signature + +```dotnet +public Section AddSection(string? title = null, string body = "", List? bullets = null, bool? numbered = null, bool numberedBullets = false) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SignalWire.POM.Section` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 266. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/find-section-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/find-section-string.mdx new file mode 100644 index 0000000000..e4c1947c41 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/find-section-string.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model/find-section-string" +title: "FindSection(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel.FindSection(string)" + parent: "SignalWire.POM.PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `FindSection(string)` + +Recursively find a section by title. Returns null if not +found. (Python parity: `PromptObjectModel.find_section`.) + +## Signature + +```dotnet +public Section? FindSection(string title) +``` + +## Parameters + + + +## Returns + +`SignalWire.POM.Section` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 283. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/from-json-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/from-json-string.mdx new file mode 100644 index 0000000000..7fee10ed57 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/from-json-string.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model/from-json-string" +title: "FromJson(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel.FromJson(string)" + parent: "SignalWire.POM.PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `FromJson(string)` + +Construct a PromptObjectModel from JSON. +(Python parity: `PromptObjectModel.from_json`.) + +**Modifiers:** `static` + +## Signature + +```dotnet +public static PromptObjectModel FromJson(string json) +``` + +## Parameters + + + +## Returns + +`SignalWire.POM.PromptObjectModel` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 439. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/from-yaml-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/from-yaml-string.mdx new file mode 100644 index 0000000000..406c258170 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/from-yaml-string.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model/from-yaml-string" +title: "FromYaml(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel.FromYaml(string)" + parent: "SignalWire.POM.PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `FromYaml(string)` + +Construct a PromptObjectModel from YAML string. +(Python parity: `PromptObjectModel.from_yaml`.) + +**Modifiers:** `static` + +## Signature + +```dotnet +public static PromptObjectModel FromYaml(string yaml) +``` + +## Parameters + + + +## Returns + +`SignalWire.POM.PromptObjectModel` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 406. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/index.mdx new file mode 100644 index 0000000000..cc102f5b21 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/index.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model" +title: "PromptObjectModel" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel" + parent: "SignalWire.POM" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `PromptObjectModel` + +## Signature + +```dotnet +public class PromptObjectModel +``` + +## Properties + + + + + +## Methods + + + + Add a PromptObjectModel as a subsection of an existing section in this model, identified by title. (Python parity: `PromptObjectModel.add_pom_as_subsection`.) + + + + Add a top-level section to the model, returning the new Section. Only the first added section may have a null title. (Python parity: `PromptObjectModel.add_section`.) + + + + Recursively find a section by title. Returns null if not found. (Python parity: `PromptObjectModel.find_section`.) + + + + Construct a PromptObjectModel from JSON. (Python parity: `PromptObjectModel.from_json`.) + + + + Construct a PromptObjectModel from YAML string. (Python parity: `PromptObjectModel.from_yaml`.) + + + + + + Render the model as markdown. Mirrors Python's `PromptObjectModel.render_markdown` exactly. + + + + + + Serialize to a list of dicts (matches Python's to\_dict which returns a List rather than a Dict). + + + + Serialize to JSON string with 2-space indent and Python dict-style formatting. Empty model emits `"[]"`. + + + + Serialize to YAML string. Matches PyYAML's `yaml.dump(data, default_flow_style=False, sort_keys=False)` exactly. Empty model emits `"[]\n"`. + + + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 250. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/prompt-object-model-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/prompt-object-model-bool.mdx new file mode 100644 index 0000000000..da88f17109 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/prompt-object-model-bool.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model/prompt-object-model-bool" +title: "PromptObjectModel(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel.PromptObjectModel(bool)" + parent: "SignalWire.POM.PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `PromptObjectModel(bool)` + +## Signature + +```dotnet +public PromptObjectModel(bool debug = false) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 257. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/render-markdown.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/render-markdown.mdx new file mode 100644 index 0000000000..86b9ed152a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/render-markdown.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model/render-markdown" +title: "RenderMarkdown()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel.RenderMarkdown()" + parent: "SignalWire.POM.PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `RenderMarkdown()` + +Render the model as markdown. Mirrors Python's +`PromptObjectModel.render_markdown` exactly. + +## Signature + +```dotnet +public string RenderMarkdown() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 306. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/render-xml.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/render-xml.mdx new file mode 100644 index 0000000000..283d3d515b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/render-xml.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model/render-xml" +title: "RenderXml()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel.RenderXml()" + parent: "SignalWire.POM.PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `RenderXml()` + +## Signature + +```dotnet +public string RenderXml() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 337. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/to-dict.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/to-dict.mdx new file mode 100644 index 0000000000..52c2017416 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/to-dict.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model/to-dict" +title: "ToDict()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel.ToDict()" + parent: "SignalWire.POM.PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `ToDict()` + +Serialize to a list of dicts (matches Python's to\_dict +which returns a List rather than a Dict). + +## Signature + +```dotnet +public List> ToDict() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 372. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/to-json.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/to-json.mdx new file mode 100644 index 0000000000..bf04c41dc7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/to-json.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model/to-json" +title: "ToJson()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel.ToJson()" + parent: "SignalWire.POM.PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `ToJson()` + +Serialize to JSON string with 2-space indent and Python +dict-style formatting. Empty model emits `"[]"`. + +## Signature + +```dotnet +public string ToJson() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 377. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/to-yaml.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/to-yaml.mdx new file mode 100644 index 0000000000..49e94f5253 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/prompt-object-model/to-yaml.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/prompt-object-model/to-yaml" +title: "ToYaml()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.PromptObjectModel.ToYaml()" + parent: "SignalWire.POM.PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `ToYaml()` + +Serialize to YAML string. Matches PyYAML's +`yaml.dump(data, default_flow_style=False, sort_keys=False)` +exactly. Empty model emits `"[]\n"`. + +## Signature + +```dotnet +public string ToYaml() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 393. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/section/add-body-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/add-body-string.mdx new file mode 100644 index 0000000000..a60e4504fd --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/add-body-string.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/section/add-body-string" +title: "AddBody(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.Section.AddBody(string)" + parent: "SignalWire.POM.Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `AddBody(string)` + +Set or replace this section's body text. +(Python parity: `Section.add_body`.) + +## Signature + +```dotnet +public Section AddBody(string body) +``` + +## Parameters + + + +## Returns + +`SignalWire.POM.Section` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 66. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/section/add-bullets-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/add-bullets-list-string.mdx new file mode 100644 index 0000000000..3f7969210c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/add-bullets-list-string.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/section/add-bullets-list-string" +title: "AddBullets(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.Section.AddBullets(System.Collections.Generic.List)" + parent: "SignalWire.POM.Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `AddBullets(List)` + +Append bullets to this section. +(Python parity: `Section.add_bullets`.) + +## Signature + +```dotnet +public Section AddBullets(List bullets) +``` + +## Parameters + + + +## Returns + +`SignalWire.POM.Section` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 74. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/section/add-subsection-string-string-list-string-bool-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/add-subsection-string-string-list-string-bool-bool.mdx new file mode 100644 index 0000000000..e3e290ba45 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/add-subsection-string-string-list-string-bool-bool.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/section/add-subsection-string-string-list-string-bool-bool" +title: "AddSubsection(string?, string, List?, bool?, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.Section.AddSubsection(string?, string, System.Collections.Generic.List?, bool?, bool)" + parent: "SignalWire.POM.Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `AddSubsection(string?, string, List?, bool?, bool)` + +Add a subsection under this section, returning the new +Section. (Python parity: `Section.add_subsection`.) + +## Signature + +```dotnet +public Section AddSubsection(string? title = null, string body = "", List? bullets = null, bool? numbered = null, bool numberedBullets = false) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SignalWire.POM.Section` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 82. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/section/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/index.mdx new file mode 100644 index 0000000000..58ed0efa73 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/section" +title: "Section" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.POM.Section" + parent: "SignalWire.POM" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `Section` + +## Signature + +```dotnet +public class Section +``` + +## Properties + + + + + + + Three-state numbering: null = inherit, true = force on, false = force off. (Python parity: `numbered` is `Optional[bool]`.) Sibling propagation: if any sibling at the same level has Numbered==true, all siblings get numbered unless they have Numbered==false. + + + + + + + + Section title. Null for the (allowed) first untitled top-level section. (Python parity: `Section.title` is `Optional[str]`.) + + +## Methods + + + + Set or replace this section's body text. (Python parity: `Section.add_body`.) + + + + Append bullets to this section. (Python parity: `Section.add_bullets`.) + + + + Add a subsection under this section, returning the new Section. (Python parity: `Section.add_subsection`.) + + + + Render this section as a markdown fragment, indented at the given header level (default 2). Mirrors Python's `Section.render_markdown` exactly. + + + + + + + + Serialize to a Dictionary suitable for JSON. Emits keys in this exact order: title, body, bullets, subsections, numbered, numberedBullets — and only when non-empty / non-null / non-default. Mirrors Python's `Section.to_dict`. + + + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 27. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/section/render-markdown-int-list-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/render-markdown-int-list-int.mdx new file mode 100644 index 0000000000..9095b367ce --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/render-markdown-int-list-int.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/section/render-markdown-int-list-int" +title: "RenderMarkdown(int, List?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.Section.RenderMarkdown(int, System.Collections.Generic.List?)" + parent: "SignalWire.POM.Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `RenderMarkdown(int, List?)` + +Render this section as a markdown fragment, indented at +the given header level (default 2). Mirrors Python's +`Section.render_markdown` exactly. + +## Signature + +```dotnet +public string RenderMarkdown(int level = 2, List? sectionNumber = null) +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 99. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/section/render-xml-int-list-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/render-xml-int-list-int.mdx new file mode 100644 index 0000000000..76426760f2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/render-xml-int-list-int.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/section/render-xml-int-list-int" +title: "RenderXml(int, List?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.Section.RenderXml(int, System.Collections.Generic.List?)" + parent: "SignalWire.POM.Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `RenderXml(int, List?)` + +## Signature + +```dotnet +public string RenderXml(int indent = 0, List? sectionNumber = null) +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 164. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/section/section-string-string-list-string-bool-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/section-string-string-list-string-bool-bool.mdx new file mode 100644 index 0000000000..a54720b420 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/section-string-string-list-string-bool-bool.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/section/section-string-string-list-string-bool-bool" +title: "Section(string?, string, List?, bool?, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.Section.Section(string?, string, System.Collections.Generic.List?, bool?, bool)" + parent: "SignalWire.POM.Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `Section(string?, string, List?, bool?, bool)` + +## Signature + +```dotnet +public Section(string? title = null, string body = "", List? bullets = null, bool? numbered = null, bool numberedBullets = false) +``` + +## Parameters + + + + + + + + + + + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 49. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.pom/section/to-dict.mdx b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/to-dict.mdx new file mode 100644 index 0000000000..85eafdbf8f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.pom/section/to-dict.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.pom/section/to-dict" +title: "ToDict()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.POM.Section.ToDict()" + parent: "SignalWire.POM.Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs" + visibility: "public" +--- +# `ToDict()` + +Serialize to a Dictionary suitable for JSON. Emits +keys in this exact order: title, body, bullets, subsections, +numbered, numberedBullets — and only when non-empty / non-null / +non-default. Mirrors Python's `Section.to_dict`. + +## Signature + +```dotnet +public Dictionary ToDict() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/POM/PromptObjectModel.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/POM/PromptObjectModel.cs) + +Line 229. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/check-availability-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/check-availability-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..31e205a19c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/check-availability-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/concierge-agent/check-availability-dictionary-string-object-dictionary-string-object" +title: "CheckAvailability(Dictionary, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.ConciergeAgent.CheckAvailability(System.Collections.Generic.Dictionary, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Prefabs.ConciergeAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs" + visibility: "public" +--- +# `CheckAvailability(Dictionary, Dictionary)` + +SWAIG tool handler for the `check_availability` tool. +(Python parity: `ConciergeAgent.check_availability(args, raw_data)`.) + +## Signature + +```dotnet +public FunctionResult CheckAvailability(Dictionary args, Dictionary rawData) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/Prefabs/ConciergeAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs) + +Line 91. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/concierge-agent-string-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/concierge-agent-string-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..b9da4036b2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/concierge-agent-string-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/concierge-agent/concierge-agent-string-dictionary-string-object-dictionary-string-object" +title: "ConciergeAgent(string, Dictionary, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.ConciergeAgent.ConciergeAgent(string, System.Collections.Generic.Dictionary, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Prefabs.ConciergeAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs" + visibility: "public" +--- +# `ConciergeAgent(string, Dictionary, Dictionary?)` + +## Signature + +```dotnet +public ConciergeAgent(string name, Dictionary venueInfo, Dictionary? options = null) +``` + +## Parameters + + + + + + + +## Source + +[`src/SignalWire/Prefabs/ConciergeAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs) + +Line 15. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-amenities.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-amenities.mdx new file mode 100644 index 0000000000..b70b675723 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-amenities.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/concierge-agent/get-amenities" +title: "GetAmenities()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.ConciergeAgent.GetAmenities()" + parent: "SignalWire.Prefabs.ConciergeAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs" + visibility: "public" +--- +# `GetAmenities()` + +## Signature + +```dotnet +public Dictionary> GetAmenities() +``` + +## Returns + +`Dictionary>` + +## Source + +[`src/SignalWire/Prefabs/ConciergeAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs) + +Line 121. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-directions-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-directions-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..602d52a521 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-directions-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/concierge-agent/get-directions-dictionary-string-object-dictionary-string-object" +title: "GetDirections(Dictionary, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.ConciergeAgent.GetDirections(System.Collections.Generic.Dictionary, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Prefabs.ConciergeAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs" + visibility: "public" +--- +# `GetDirections(Dictionary, Dictionary)` + +SWAIG tool handler for the `get_directions` tool. +(Python parity: `ConciergeAgent.get_directions(args, raw_data)`.) + +## Signature + +```dotnet +public FunctionResult GetDirections(Dictionary args, Dictionary rawData) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/Prefabs/ConciergeAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs) + +Line 102. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-services.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-services.mdx new file mode 100644 index 0000000000..3070dd716e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-services.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/concierge-agent/get-services" +title: "GetServices()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.ConciergeAgent.GetServices()" + parent: "SignalWire.Prefabs.ConciergeAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs" + visibility: "public" +--- +# `GetServices()` + +## Signature + +```dotnet +public List GetServices() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Prefabs/ConciergeAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs) + +Line 120. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-venue-name.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-venue-name.mdx new file mode 100644 index 0000000000..36ead12d10 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/get-venue-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/concierge-agent/get-venue-name" +title: "GetVenueName()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.ConciergeAgent.GetVenueName()" + parent: "SignalWire.Prefabs.ConciergeAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs" + visibility: "public" +--- +# `GetVenueName()` + +## Signature + +```dotnet +public string GetVenueName() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Prefabs/ConciergeAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs) + +Line 119. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/index.mdx new file mode 100644 index 0000000000..3d30a74ad2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/concierge-agent/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/concierge-agent" +title: "ConciergeAgent" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.ConciergeAgent" + parent: "SignalWire.Prefabs" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs" + visibility: "public" +--- +# `ConciergeAgent` + +Prefab concierge agent for venue/hotel style interactions. +Registers <code>check\_availability</code> and <code>get\_directions</code> tools. + +## Signature + +```dotnet +public class ConciergeAgent : AgentBase +``` + +## Inheritance + +**Extends:** [SignalWire.SWML.Service](/reference/dotnet/signal-wire.swml/service) + +## Methods + + + + SWAIG tool handler for the `check_availability` tool. (Python parity: `ConciergeAgent.check_availability(args, raw_data)`.) + + + + + + + + SWAIG tool handler for the `get_directions` tool. (Python parity: `ConciergeAgent.get_directions(args, raw_data)`.) + + + + + + + +## Source + +[`src/SignalWire/Prefabs/ConciergeAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ConciergeAgent.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/faq-bot-agent-string-list-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/faq-bot-agent-string-list-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..f6da3910f9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/faq-bot-agent-string-list-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/faq-bot-agent/faq-bot-agent-string-list-dictionary-string-object-dictionary-string-object" +title: "FAQBotAgent(string, List>, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.FAQBotAgent.FAQBotAgent(string, System.Collections.Generic.List>, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Prefabs.FAQBotAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/FAQBotAgent.cs" + visibility: "public" +--- +# `FAQBotAgent(string, List>, Dictionary?)` + +## Signature + +```dotnet +public FAQBotAgent(string name, List> faqs, Dictionary? options = null) +``` + +## Parameters + + + + + + + +## Source + +[`src/SignalWire/Prefabs/FAQBotAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/FAQBotAgent.cs) + +Line 14. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/get-faqs.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/get-faqs.mdx new file mode 100644 index 0000000000..6647518700 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/get-faqs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/faq-bot-agent/get-faqs" +title: "GetFaqs()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.FAQBotAgent.GetFaqs()" + parent: "SignalWire.Prefabs.FAQBotAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/FAQBotAgent.cs" + visibility: "public" +--- +# `GetFaqs()` + +## Signature + +```dotnet +public List> GetFaqs() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Prefabs/FAQBotAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/FAQBotAgent.cs) + +Line 98. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/get-suggest-related.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/get-suggest-related.mdx new file mode 100644 index 0000000000..3557880d32 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/get-suggest-related.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/faq-bot-agent/get-suggest-related" +title: "GetSuggestRelated()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.FAQBotAgent.GetSuggestRelated()" + parent: "SignalWire.Prefabs.FAQBotAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/FAQBotAgent.cs" + visibility: "public" +--- +# `GetSuggestRelated()` + +## Signature + +```dotnet +public bool GetSuggestRelated() +``` + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Prefabs/FAQBotAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/FAQBotAgent.cs) + +Line 99. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/index.mdx new file mode 100644 index 0000000000..eb3d76ed16 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/faq-bot-agent" +title: "FAQBotAgent" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.FAQBotAgent" + parent: "SignalWire.Prefabs" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/FAQBotAgent.cs" + visibility: "public" +--- +# `FAQBotAgent` + +Prefab FAQ bot agent with keyword-scored search. +Registers a <code>search\_faqs</code> tool. + +## Signature + +```dotnet +public class FAQBotAgent : AgentBase +``` + +## Inheritance + +**Extends:** [SignalWire.SWML.Service](/reference/dotnet/signal-wire.swml/service) + +## Methods + + + + + + + + + + SWAIG tool handler that searches the configured FAQ knowledge base for the best keyword-scored answer. (Python parity: `FAQBotAgent.search_faqs(args, raw_data)`.) + + + +## Source + +[`src/SignalWire/Prefabs/FAQBotAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/FAQBotAgent.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/search-faqs-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/search-faqs-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..374d8475b9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/faq-bot-agent/search-faqs-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/faq-bot-agent/search-faqs-dictionary-string-object-dictionary-string-object" +title: "SearchFaqs(Dictionary, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.FAQBotAgent.SearchFaqs(System.Collections.Generic.Dictionary, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Prefabs.FAQBotAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/FAQBotAgent.cs" + visibility: "public" +--- +# `SearchFaqs(Dictionary, Dictionary)` + +SWAIG tool handler that searches the configured FAQ +knowledge base for the best keyword-scored answer. +(Python parity: `FAQBotAgent.search_faqs(args, raw_data)`.) + +## Signature + +```dotnet +public FunctionResult SearchFaqs(Dictionary args, Dictionary rawData) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/Prefabs/FAQBotAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/FAQBotAgent.cs) + +Line 63. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/index.mdx new file mode 100644 index 0000000000..a210ad5f18 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs" +title: "SignalWire.Prefabs" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.Prefabs" +--- +# `SignalWire.Prefabs` + +## Classes + + + + Prefab concierge agent for venue/hotel style interactions. Registers <code>check\_availability</code> and <code>get\_directions</code> tools. + + + + Prefab FAQ bot agent with keyword-scored search. Registers a <code>search\_faqs</code> tool. + + + + Prefab agent that gathers information by asking a series of questions. Registers <code>start\_questions</code> and <code>submit\_answer</code> tools. + + + + Prefab agent that greets callers and transfers them to departments. Registers <code>collect\_caller\_info</code> and <code>transfer\_call</code> tools. + + + + Prefab agent that conducts surveys with typed question validation. Registers <code>validate\_response</code> and <code>log\_response</code> tools. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/get-questions.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/get-questions.mdx new file mode 100644 index 0000000000..7796d52740 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/get-questions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/info-gatherer-agent/get-questions" +title: "GetQuestions()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.InfoGathererAgent.GetQuestions()" + parent: "SignalWire.Prefabs.InfoGathererAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/InfoGathererAgent.cs" + visibility: "public" +--- +# `GetQuestions()` + +## Signature + +```dotnet +public List> GetQuestions() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Prefabs/InfoGathererAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/InfoGathererAgent.cs) + +Line 77. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/index.mdx new file mode 100644 index 0000000000..ca68b1d546 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/info-gatherer-agent" +title: "InfoGathererAgent" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.InfoGathererAgent" + parent: "SignalWire.Prefabs" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/InfoGathererAgent.cs" + visibility: "public" +--- +# `InfoGathererAgent` + +Prefab agent that gathers information by asking a series of questions. +Registers <code>start\_questions</code> and <code>submit\_answer</code> tools. + +## Signature + +```dotnet +public class InfoGathererAgent : AgentBase +``` + +## Inheritance + +**Extends:** [SignalWire.SWML.Service](/reference/dotnet/signal-wire.swml/service) + +## Methods + + + + + + + + SWAIG tool handler for the `start_questions` tool. (Python parity: `InfoGathererAgent.start_questions`.) + + + + SWAIG tool handler for the `submit_answer` tool. (Python parity: `InfoGathererAgent.submit_answer`.) + + + +## Source + +[`src/SignalWire/Prefabs/InfoGathererAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/InfoGathererAgent.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/info-gatherer-agent-string-list-dictionary-string-object-agent-options.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/info-gatherer-agent-string-list-dictionary-string-object-agent-options.mdx new file mode 100644 index 0000000000..2a57dd3731 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/info-gatherer-agent-string-list-dictionary-string-object-agent-options.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/info-gatherer-agent/info-gatherer-agent-string-list-dictionary-string-object-agent-options" +title: "InfoGathererAgent(string, List>, AgentOptions?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.InfoGathererAgent.InfoGathererAgent(string, System.Collections.Generic.List>, SignalWire.Agent.AgentOptions?)" + parent: "SignalWire.Prefabs.InfoGathererAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/InfoGathererAgent.cs" + visibility: "public" +--- +# `InfoGathererAgent(string, List>, AgentOptions?)` + +## Signature + +```dotnet +public InfoGathererAgent(string name, List> questions, AgentOptions? options = null) +``` + +## Parameters + + + Agent name (defaults to "info\_gatherer"). + + + + List of question dicts with key\_name, question\_text, and optional confirm. + + + + Additional <xref href="SignalWire.Agent.AgentOptions" data-throw-if-not-resolved="false"></xref> overrides. + + +## Source + +[`src/SignalWire/Prefabs/InfoGathererAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/InfoGathererAgent.cs) + +Line 16. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/start-questions-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/start-questions-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..0902cb5859 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/start-questions-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/info-gatherer-agent/start-questions-dictionary-string-object-dictionary-string-object" +title: "StartQuestions(Dictionary, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.InfoGathererAgent.StartQuestions(System.Collections.Generic.Dictionary, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Prefabs.InfoGathererAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/InfoGathererAgent.cs" + visibility: "public" +--- +# `StartQuestions(Dictionary, Dictionary)` + +SWAIG tool handler for the `start_questions` tool. +(Python parity: `InfoGathererAgent.start_questions`.) + +## Signature + +```dotnet +public FunctionResult StartQuestions(Dictionary args, Dictionary rawData) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/Prefabs/InfoGathererAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/InfoGathererAgent.cs) + +Line 60. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/submit-answer-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/submit-answer-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..aa1bdf33ab --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/info-gatherer-agent/submit-answer-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/info-gatherer-agent/submit-answer-dictionary-string-object-dictionary-string-object" +title: "SubmitAnswer(Dictionary, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.InfoGathererAgent.SubmitAnswer(System.Collections.Generic.Dictionary, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Prefabs.InfoGathererAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/InfoGathererAgent.cs" + visibility: "public" +--- +# `SubmitAnswer(Dictionary, Dictionary)` + +SWAIG tool handler for the `submit_answer` tool. +(Python parity: `InfoGathererAgent.submit_answer`.) + +## Signature + +```dotnet +public FunctionResult SubmitAnswer(Dictionary args, Dictionary rawData) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/Prefabs/InfoGathererAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/InfoGathererAgent.cs) + +Line 71. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/get-departments.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/get-departments.mdx new file mode 100644 index 0000000000..876452002c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/get-departments.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/receptionist-agent/get-departments" +title: "GetDepartments()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.ReceptionistAgent.GetDepartments()" + parent: "SignalWire.Prefabs.ReceptionistAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ReceptionistAgent.cs" + visibility: "public" +--- +# `GetDepartments()` + +## Signature + +```dotnet +public List> GetDepartments() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Prefabs/ReceptionistAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ReceptionistAgent.cs) + +Line 94. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/get-greeting.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/get-greeting.mdx new file mode 100644 index 0000000000..3f998e1275 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/get-greeting.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/receptionist-agent/get-greeting" +title: "GetGreeting()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.ReceptionistAgent.GetGreeting()" + parent: "SignalWire.Prefabs.ReceptionistAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ReceptionistAgent.cs" + visibility: "public" +--- +# `GetGreeting()` + +## Signature + +```dotnet +public string GetGreeting() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Prefabs/ReceptionistAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ReceptionistAgent.cs) + +Line 95. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/index.mdx new file mode 100644 index 0000000000..791f8b734b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/receptionist-agent" +title: "ReceptionistAgent" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.ReceptionistAgent" + parent: "SignalWire.Prefabs" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ReceptionistAgent.cs" + visibility: "public" +--- +# `ReceptionistAgent` + +Prefab agent that greets callers and transfers them to departments. +Registers <code>collect\_caller\_info</code> and <code>transfer\_call</code> tools. + +## Signature + +```dotnet +public class ReceptionistAgent : AgentBase +``` + +## Inheritance + +**Extends:** [SignalWire.SWML.Service](/reference/dotnet/signal-wire.swml/service) + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/Prefabs/ReceptionistAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ReceptionistAgent.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/receptionist-agent-string-list-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/receptionist-agent-string-list-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..9adc34fc63 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/receptionist-agent/receptionist-agent-string-list-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/receptionist-agent/receptionist-agent-string-list-dictionary-string-object-dictionary-string-object" +title: "ReceptionistAgent(string, List>, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.ReceptionistAgent.ReceptionistAgent(string, System.Collections.Generic.List>, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Prefabs.ReceptionistAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ReceptionistAgent.cs" + visibility: "public" +--- +# `ReceptionistAgent(string, List>, Dictionary?)` + +## Signature + +```dotnet +public ReceptionistAgent(string name, List> departments, Dictionary? options = null) +``` + +## Parameters + + + + + + + +## Source + +[`src/SignalWire/Prefabs/ReceptionistAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/ReceptionistAgent.cs) + +Line 14. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/get-survey-name.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/get-survey-name.mdx new file mode 100644 index 0000000000..3b6b239a8e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/get-survey-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/survey-agent/get-survey-name" +title: "GetSurveyName()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.SurveyAgent.GetSurveyName()" + parent: "SignalWire.Prefabs.SurveyAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs" + visibility: "public" +--- +# `GetSurveyName()` + +## Signature + +```dotnet +public string GetSurveyName() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Prefabs/SurveyAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs) + +Line 141. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/get-survey-questions.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/get-survey-questions.mdx new file mode 100644 index 0000000000..2435934b07 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/get-survey-questions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/survey-agent/get-survey-questions" +title: "GetSurveyQuestions()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.SurveyAgent.GetSurveyQuestions()" + parent: "SignalWire.Prefabs.SurveyAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs" + visibility: "public" +--- +# `GetSurveyQuestions()` + +## Signature + +```dotnet +public List> GetSurveyQuestions() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Prefabs/SurveyAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs) + +Line 140. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/index.mdx new file mode 100644 index 0000000000..f9add02cf9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/survey-agent" +title: "SurveyAgent" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.SurveyAgent" + parent: "SignalWire.Prefabs" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs" + visibility: "public" +--- +# `SurveyAgent` + +Prefab agent that conducts surveys with typed question validation. +Registers <code>validate\_response</code> and <code>log\_response</code> tools. + +## Signature + +```dotnet +public class SurveyAgent : AgentBase +``` + +## Inheritance + +**Extends:** [SignalWire.SWML.Service](/reference/dotnet/signal-wire.swml/service) + +## Methods + + + + + + + + SWAIG tool handler for the `log_response` tool. (Python parity: `SurveyAgent.log_response`.) + + + + + + SWAIG tool handler for the `validate_response` tool. (Python parity: `SurveyAgent.validate_response`.) + + + +## Source + +[`src/SignalWire/Prefabs/SurveyAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/log-response-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/log-response-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..ee61820ee4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/log-response-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/survey-agent/log-response-dictionary-string-object-dictionary-string-object" +title: "LogResponse(Dictionary, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.SurveyAgent.LogResponse(System.Collections.Generic.Dictionary, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Prefabs.SurveyAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs" + visibility: "public" +--- +# `LogResponse(Dictionary, Dictionary)` + +SWAIG tool handler for the `log_response` tool. +(Python parity: `SurveyAgent.log_response`.) + +## Signature + +```dotnet +public FunctionResult LogResponse(Dictionary args, Dictionary rawData) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/Prefabs/SurveyAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs) + +Line 133. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/survey-agent-string-list-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/survey-agent-string-list-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..0de1b7d9d3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/survey-agent-string-list-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/survey-agent/survey-agent-string-list-dictionary-string-object-dictionary-string-object" +title: "SurveyAgent(string, List>, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.SurveyAgent.SurveyAgent(string, System.Collections.Generic.List>, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Prefabs.SurveyAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs" + visibility: "public" +--- +# `SurveyAgent(string, List>, Dictionary?)` + +## Signature + +```dotnet +public SurveyAgent(string name, List> questions, Dictionary? options = null) +``` + +## Parameters + + + + + + + +## Source + +[`src/SignalWire/Prefabs/SurveyAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs) + +Line 16. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/validate-response-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/validate-response-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..96a3064eb2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.prefabs/survey-agent/validate-response-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.prefabs/survey-agent/validate-response-dictionary-string-object-dictionary-string-object" +title: "ValidateResponse(Dictionary, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Prefabs.SurveyAgent.ValidateResponse(System.Collections.Generic.Dictionary, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Prefabs.SurveyAgent" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs" + visibility: "public" +--- +# `ValidateResponse(Dictionary, Dictionary)` + +SWAIG tool handler for the `validate_response` tool. +(Python parity: `SurveyAgent.validate_response`.) + +## Signature + +```dotnet +public FunctionResult ValidateResponse(Dictionary args, Dictionary rawData) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/Prefabs/SurveyAgent.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Prefabs/SurveyAgent.cs) + +Line 81. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/accepts-terminal-event-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/accepts-terminal-event-string.mdx new file mode 100644 index 0000000000..8d5a2a5835 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/accepts-terminal-event-string.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/accepts-terminal-event-string" +title: "AcceptsTerminalEvent(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.AcceptsTerminalEvent(string)" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `AcceptsTerminalEvent(string)` + +Subclasses may filter which event types can resolve this action via +the standard terminal-state path. Default: any event type registered +in <xref href="SignalWire.Relay.Constants.ActionTerminalStates" data-throw-if-not-resolved="false"></xref> may resolve. + +Override returns false to block resolution for a specific event type +(e.g. CollectAction blocks <code>calling.call.play</code> so the play +phase of <code>play\_and\_collect</code> doesn't resolve the collect side). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual bool AcceptsTerminalEvent(string eventType) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 126. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/action-string-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/action-string-string-string-object.mdx new file mode 100644 index 0000000000..21d5113efb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/action-string-string-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/action-string-string-string-object" +title: "Action(string, string, string, object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.Action(string, string, string, object)" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `Action(string, string, string, object)` + +## Signature + +```dotnet +public Action(string controlId, string callId, string nodeId, object client) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 30. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/execute-subcommand-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/execute-subcommand-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..8b54d54c6a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/execute-subcommand-string-dictionary-string-object.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/execute-subcommand-string-dictionary-string-object" +title: "ExecuteSubcommand(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.ExecuteSubcommand(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `ExecuteSubcommand(string, Dictionary?)` + +Send a sub-command RPC through the client. +The payload always includes control\_id, call\_id, and node\_id. + +## Signature + +```dotnet +public void ExecuteSubcommand(string method, Dictionary? extraParams = null) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 171. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-call-id.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-call-id.mdx new file mode 100644 index 0000000000..83aebfb7b6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/get-call-id" +title: "GetCallId()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.GetCallId()" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetCallId()` + +## Signature + +```dotnet +public string GetCallId() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 66. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-control-id.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-control-id.mdx new file mode 100644 index 0000000000..124a192e96 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/get-control-id" +title: "GetControlId()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.GetControlId()" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetControlId()` + +## Signature + +```dotnet +public string GetControlId() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 65. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-node-id.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-node-id.mdx new file mode 100644 index 0000000000..1293cad949 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/get-node-id" +title: "GetNodeId()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.GetNodeId()" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetNodeId()` + +## Signature + +```dotnet +public string GetNodeId() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 67. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-stop-method.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-stop-method.mdx new file mode 100644 index 0000000000..b315d8fdf6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/get-stop-method" +title: "GetStopMethod()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.GetStopMethod()" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetStopMethod()` + +Return the RELAY RPC method that stops this action. +Subclasses MUST override to return the correct method name. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual string GetStopMethod() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 165. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/handle-event-event.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/handle-event-event.mdx new file mode 100644 index 0000000000..dc77c965cd --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/handle-event-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/handle-event-event" +title: "HandleEvent(Event)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.HandleEvent(SignalWire.Relay.Event)" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `HandleEvent(Event)` + +Append an incoming event and update local state / payload. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual void HandleEvent(Event evt) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 102. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/index.mdx new file mode 100644 index 0000000000..64b5fd8112 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/index.mdx @@ -0,0 +1,102 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action" +title: "Action" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `Action` + +Base class for all RELAY call actions (play, record, collect, etc.). + +An Action is the client-side handle returned when you start an +asynchronous operation on a call. It accumulates events, tracks +state, and resolves once the operation reaches a terminal state. + +Uses <xref href="System.Threading.Tasks.TaskCompletionSource" data-throw-if-not-resolved="false"></xref> for native async/await support. + +## Signature + +```dotnet +public class Action +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + Subclasses may filter which event types can resolve this action via the standard terminal-state path. Default: any event type registered in <xref href="SignalWire.Relay.Constants.ActionTerminalStates" data-throw-if-not-resolved="false"></xref> may resolve. Override returns false to block resolution for a specific event type (e.g. CollectAction blocks <code>calling.call.play</code> so the play phase of <code>play\_and\_collect</code> doesn't resolve the collect side). + + + + + + Send a sub-command RPC through the client. The payload always includes control\_id, call\_id, and node\_id. + + + + + + + + + + Return the RELAY RPC method that stops this action. Subclasses MUST override to return the correct method name. + + + + Append an incoming event and update local state / payload. + + + + Register a callback to fire when the action completes. If the action is already done the callback fires immediately. + + + + Mark this action as completed. The optional result is stored and the onCompleted callback fires exactly once. + + + + Stop the running action by sending its stop sub-command. + + + + Await until the action completes or the timeout elapses. Returns the resolved result, or null on timeout. + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 13. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/on-completed.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/on-completed.mdx new file mode 100644 index 0000000000..a6a3ef94d9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/on-completed.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/on-completed" +title: "OnCompleted" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.OnCompleted(System.Func)" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `OnCompleted` + +Register a callback to fire when the action completes. +If the action is already done the callback fires immediately. + +## Signature + + + + ```dotnet + public Action OnCompleted(Func callback) + ``` + + + + ```dotnet + public Action OnCompleted(Action callback) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`SignalWire.Relay.Action` + +## Returns (Overload 2) + +`SignalWire.Relay.Action` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 77. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/resolve-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/resolve-object.mdx new file mode 100644 index 0000000000..94a5ca0476 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/resolve-object.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/resolve-object" +title: "Resolve(object?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.Resolve(object?)" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `Resolve(object?)` + +Mark this action as completed. The optional result is stored and the +onCompleted callback fires exactly once. + +## Signature + +```dotnet +public void Resolve(object? result = null) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 136. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/stop.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/stop.mdx new file mode 100644 index 0000000000..8ce50c0971 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/stop.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/stop" +title: "Stop()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.Stop()" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `Stop()` + +Stop the running action by sending its stop sub-command. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual void Stop() +``` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 152. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/action/wait-async-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/wait-async-int.mdx new file mode 100644 index 0000000000..bc963449db --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/action/wait-async-int.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/action/wait-async-int" +title: "WaitAsync(int)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Action.WaitAsync(int)" + parent: "SignalWire.Relay.Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `WaitAsync(int)` + +Await until the action completes or the timeout elapses. +Returns the resolved result, or null on timeout. + +## Signature + +```dotnet +public Task WaitAsync(int timeoutSeconds = 30) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 46. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/ai-action/ai-action-string-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/ai-action/ai-action-string-string-string-object.mdx new file mode 100644 index 0000000000..58fe404066 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/ai-action/ai-action-string-string-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/ai-action/ai-action-string-string-string-object" +title: "AIAction(string, string, string, object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.AIAction.AIAction(string, string, string, object)" + parent: "SignalWire.Relay.AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `AIAction(string, string, string, object)` + +## Signature + +```dotnet +public AIAction(string controlId, string callId, string nodeId, object client) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 402. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/ai-action/get-stop-method.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/ai-action/get-stop-method.mdx new file mode 100644 index 0000000000..e86b9b9ec9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/ai-action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/ai-action/get-stop-method" +title: "GetStopMethod()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.AIAction.GetStopMethod()" + parent: "SignalWire.Relay.AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetStopMethod()` + +Return the RELAY RPC method that stops this action. +Subclasses MUST override to return the correct method name. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string GetStopMethod() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 405. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/ai-action/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/ai-action/index.mdx new file mode 100644 index 0000000000..842bfc63af --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/ai-action/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/ai-action" +title: "AIAction" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.AIAction" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `AIAction` + +Handle for calling.ai operations. + +## Signature + +```dotnet +public class AIAction : Action +``` + +## Inheritance + +**Extends:** [SignalWire.Relay.Action](/reference/dotnet/signal-wire.relay/action) + +## Methods + + + + + + Return the RELAY RPC method that stops this action. Subclasses MUST override to return the correct method name. + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 400. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-dictionary-string-object.mdx new file mode 100644 index 0000000000..36c7db54eb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/ai-dictionary-string-object" +title: "AI(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.AI(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `AI(Dictionary?)` + +## Signature + +```dotnet +public AIAction AI(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.AIAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 317. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-hold-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-hold-async.mdx new file mode 100644 index 0000000000..9b72fdb07a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-hold-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/ai-hold-async" +title: "AiHoldAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.AiHoldAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `AiHoldAsync()` + +## Signature + +```dotnet +public Task> AiHoldAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 259. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-message-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-message-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..98c16e89c6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-message-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/ai-message-async-dictionary-string-object" +title: "AiMessageAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.AiMessageAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `AiMessageAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> AiMessageAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 256. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-unhold-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-unhold-async.mdx new file mode 100644 index 0000000000..742cca8c19 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/ai-unhold-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/ai-unhold-async" +title: "AiUnholdAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.AiUnholdAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `AiUnholdAsync()` + +## Signature + +```dotnet +public Task> AiUnholdAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 262. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/amazon-bedrock-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/amazon-bedrock-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..824746a32c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/amazon-bedrock-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/amazon-bedrock-async-dictionary-string-object" +title: "AmazonBedrockAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.AmazonBedrockAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `AmazonBedrockAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> AmazonBedrockAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 253. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/answer-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/answer-async.mdx new file mode 100644 index 0000000000..b2a5c34108 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/answer-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/answer-async" +title: "AnswerAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.AnswerAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `AnswerAsync()` + +## Signature + +```dotnet +public Task> AnswerAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 196. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/bind-digit-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/bind-digit-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..90abe3dad9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/bind-digit-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/bind-digit-async-dictionary-string-object" +title: "BindDigitAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.BindDigitAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `BindDigitAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> BindDigitAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 235. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/call-dictionary-string-object-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/call-dictionary-string-object-client.mdx new file mode 100644 index 0000000000..500efb3965 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/call-dictionary-string-object-client.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/call-dictionary-string-object-client" +title: "Call(Dictionary, Client)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.Call(System.Collections.Generic.Dictionary, SignalWire.Relay.Client)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `Call(Dictionary, Client)` + +## Signature + +```dotnet +public Call(Dictionary params_, Client client) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 45. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/clear-digit-bindings-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/clear-digit-bindings-async.mdx new file mode 100644 index 0000000000..0b1aab77dc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/clear-digit-bindings-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/clear-digit-bindings-async" +title: "ClearDigitBindingsAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.ClearDigitBindingsAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `ClearDigitBindingsAsync()` + +## Signature + +```dotnet +public Task> ClearDigitBindingsAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 238. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/collect-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/collect-dictionary-string-object.mdx new file mode 100644 index 0000000000..fdb20e4ff9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/collect-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/collect-dictionary-string-object" +title: "Collect(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.Collect(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `Collect(Dictionary?)` + +## Signature + +```dotnet +public CollectAction Collect(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.CollectAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 290. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/connect-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/connect-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..f3d27e2a99 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/connect-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/connect-async-dictionary-string-object" +title: "ConnectAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.ConnectAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `ConnectAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ConnectAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 205. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/denoise-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/denoise-async.mdx new file mode 100644 index 0000000000..cda827984f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/denoise-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/denoise-async" +title: "DenoiseAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.DenoiseAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `DenoiseAsync()` + +## Signature + +```dotnet +public Task> DenoiseAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 217. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/denoise-stop-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/denoise-stop-async.mdx new file mode 100644 index 0000000000..13168eaf15 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/denoise-stop-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/denoise-stop-async" +title: "DenoiseStopAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.DenoiseStopAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `DenoiseStopAsync()` + +## Signature + +```dotnet +public Task> DenoiseStopAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 220. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/detect-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/detect-dictionary-string-object.mdx new file mode 100644 index 0000000000..b1ca9a2c64 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/detect-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/detect-dictionary-string-object" +title: "Detect(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.Detect(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `Detect(Dictionary?)` + +## Signature + +```dotnet +public DetectAction Detect(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.DetectAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 296. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/disconnect-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/disconnect-async.mdx new file mode 100644 index 0000000000..e1354c5b3d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/disconnect-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/disconnect-async" +title: "DisconnectAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.DisconnectAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `DisconnectAsync()` + +## Signature + +```dotnet +public Task> DisconnectAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 208. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/dispatch-event-event.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/dispatch-event-event.mdx new file mode 100644 index 0000000000..0e7cfc8e98 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/dispatch-event-event.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/dispatch-event-event" +title: "DispatchEvent(Event)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.DispatchEvent(SignalWire.Relay.Event)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `DispatchEvent(Event)` + +Central event router invoked by the Client whenever a server event +targets this call. + +## Signature + +```dotnet +public void DispatchEvent(Event evt) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 72. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/echo-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/echo-async.mdx new file mode 100644 index 0000000000..7fc138b44d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/echo-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/echo-async" +title: "EchoAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.EchoAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `EchoAsync()` + +## Signature + +```dotnet +public Task> EchoAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 232. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/hangup-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/hangup-async-string.mdx new file mode 100644 index 0000000000..604f43d4a6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/hangup-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/hangup-async-string" +title: "HangupAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.HangupAsync(string)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `HangupAsync(string)` + +## Signature + +```dotnet +public Task> HangupAsync(string reason = "hangup") +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 199. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/hold-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/hold-async.mdx new file mode 100644 index 0000000000..85cef5fbb6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/hold-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/hold-async" +title: "HoldAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.HoldAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `HoldAsync()` + +## Signature + +```dotnet +public Task> HoldAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 211. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/index.mdx new file mode 100644 index 0000000000..179418e992 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/index.mdx @@ -0,0 +1,168 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call" +title: "Call" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `Call` + +Represents a RELAY voice call. + +Holds call-level state, dispatches server events to registered listeners +and to in-flight Action objects, and exposes every calling.\* RPC method +as a first-class C# method. + +## Signature + +```dotnet +public class Call +``` + +## Properties + + + controlId => Action + + + + + + + + + + + + + + + + + + + + User-registered event callbacks (catch-all). + + + + + + + + + + Per-event-type listeners registered via <xref href="SignalWire.Relay.Call.On(System.String%2cSystem.Action%7bSignalWire.Relay.Event%7d)" data-throw-if-not-resolved="false"></xref>. + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Central event router invoked by the Client whenever a server event targets this call. + + + + + + + + + + + + + + + + + + + + + + Register a generic event listener on this call. + + + + + + + + + + + + + + + + + + + + + + Mark every outstanding action as completed. Called when the call enters a terminal state (ended). + + + + + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 11. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/join-conference-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/join-conference-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..1f268dacf2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/join-conference-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/join-conference-async-dictionary-string-object" +title: "JoinConferenceAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.JoinConferenceAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `JoinConferenceAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> JoinConferenceAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 226. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/join-room-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/join-room-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..91bdf9a3f1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/join-room-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/join-room-async-dictionary-string-object" +title: "JoinRoomAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.JoinRoomAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `JoinRoomAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> JoinRoomAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 247. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/leave-conference-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/leave-conference-async.mdx new file mode 100644 index 0000000000..399dd0d481 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/leave-conference-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/leave-conference-async" +title: "LeaveConferenceAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.LeaveConferenceAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `LeaveConferenceAsync()` + +## Signature + +```dotnet +public Task> LeaveConferenceAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 229. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/leave-room-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/leave-room-async.mdx new file mode 100644 index 0000000000..f1b2cc5016 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/leave-room-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/leave-room-async" +title: "LeaveRoomAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.LeaveRoomAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `LeaveRoomAsync()` + +## Signature + +```dotnet +public Task> LeaveRoomAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 250. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/live-transcribe-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/live-transcribe-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..c8a1902c2b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/live-transcribe-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/live-transcribe-async-dictionary-string-object" +title: "LiveTranscribeAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.LiveTranscribeAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `LiveTranscribeAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> LiveTranscribeAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 241. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/live-translate-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/live-translate-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..842c925ef4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/live-translate-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/live-translate-async-dictionary-string-object" +title: "LiveTranslateAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.LiveTranslateAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `LiveTranslateAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> LiveTranslateAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 244. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/on.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/on.mdx new file mode 100644 index 0000000000..6c2c86eb25 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/on.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/on" +title: "On" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.On(System.Action)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `On` + +Register a generic event listener on this call. + +## Signature + + + + ```dotnet + public Call On(Action callback) + ``` + + + + ```dotnet + public Call On(string eventType, Action callback) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`SignalWire.Relay.Call` + +## Returns (Overload 2) + +`SignalWire.Relay.Call` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 161. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/pass-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/pass-async.mdx new file mode 100644 index 0000000000..dfa6453c03 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/pass-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/pass-async" +title: "PassAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.PassAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `PassAsync()` + +## Signature + +```dotnet +public Task> PassAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 202. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/pay-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/pay-dictionary-string-object.mdx new file mode 100644 index 0000000000..205fe3e9c4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/pay-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/pay-dictionary-string-object" +title: "Pay(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.Pay(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `Pay(Dictionary?)` + +## Signature + +```dotnet +public PayAction Pay(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.PayAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 311. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/play-and-collect-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/play-and-collect-dictionary-string-object.mdx new file mode 100644 index 0000000000..3b59a18187 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/play-and-collect-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/play-and-collect-dictionary-string-object" +title: "PlayAndCollect(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.PlayAndCollect(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `PlayAndCollect(Dictionary?)` + +## Signature + +```dotnet +public CollectAction PlayAndCollect(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.CollectAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 293. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/play-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/play-dictionary-string-object.mdx new file mode 100644 index 0000000000..74da5c3e1b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/play-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/play-dictionary-string-object" +title: "Play(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.Play(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `Play(Dictionary?)` + +## Signature + +```dotnet +public PlayAction Play(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.PlayAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 284. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/queue-enter-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/queue-enter-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..22e2f57c50 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/queue-enter-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/queue-enter-async-dictionary-string-object" +title: "QueueEnterAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.QueueEnterAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `QueueEnterAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> QueueEnterAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 268. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/queue-leave-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/queue-leave-async.mdx new file mode 100644 index 0000000000..2bfd25d029 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/queue-leave-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/queue-leave-async" +title: "QueueLeaveAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.QueueLeaveAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `QueueLeaveAsync()` + +## Signature + +```dotnet +public Task> QueueLeaveAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 271. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/receive-fax-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/receive-fax-dictionary-string-object.mdx new file mode 100644 index 0000000000..aac34c53bd --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/receive-fax-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/receive-fax-dictionary-string-object" +title: "ReceiveFax(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.ReceiveFax(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `ReceiveFax(Dictionary?)` + +## Signature + +```dotnet +public FaxAction ReceiveFax(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.FaxAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 302. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/record-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/record-dictionary-string-object.mdx new file mode 100644 index 0000000000..dc9ec369c9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/record-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/record-dictionary-string-object" +title: "Record(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.Record(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `Record(Dictionary?)` + +## Signature + +```dotnet +public RecordAction Record(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.RecordAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 287. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/refer-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/refer-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..5090f096d2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/refer-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/refer-async-dictionary-string-object" +title: "ReferAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.ReferAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `ReferAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ReferAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 274. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/resolve-all-actions.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/resolve-all-actions.mdx new file mode 100644 index 0000000000..3061db3cdf --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/resolve-all-actions.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/resolve-all-actions" +title: "ResolveAllActions()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.ResolveAllActions()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `ResolveAllActions()` + +Mark every outstanding action as completed. +Called when the call enters a terminal state (ended). + +## Signature + +```dotnet +public void ResolveAllActions() +``` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 183. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/send-digits-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/send-digits-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..c6702ecd9d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/send-digits-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/send-digits-async-dictionary-string-object" +title: "SendDigitsAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.SendDigitsAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `SendDigitsAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> SendDigitsAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 277. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/send-fax-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/send-fax-dictionary-string-object.mdx new file mode 100644 index 0000000000..0117fd4163 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/send-fax-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/send-fax-dictionary-string-object" +title: "SendFax(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.SendFax(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `SendFax(Dictionary?)` + +## Signature + +```dotnet +public FaxAction SendFax(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.FaxAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 299. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/stream-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/stream-dictionary-string-object.mdx new file mode 100644 index 0000000000..470c9a2db7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/stream-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/stream-dictionary-string-object" +title: "Stream(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.Stream(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `Stream(Dictionary?)` + +## Signature + +```dotnet +public StreamAction Stream(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.StreamAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 308. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/tap-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/tap-dictionary-string-object.mdx new file mode 100644 index 0000000000..8114624b6d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/tap-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/tap-dictionary-string-object" +title: "Tap(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.Tap(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `Tap(Dictionary?)` + +## Signature + +```dotnet +public TapAction Tap(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.TapAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 305. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/transcribe-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/transcribe-dictionary-string-object.mdx new file mode 100644 index 0000000000..90ee5eb954 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/transcribe-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/transcribe-dictionary-string-object" +title: "Transcribe(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.Transcribe(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `Transcribe(Dictionary?)` + +## Signature + +```dotnet +public TranscribeAction Transcribe(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.TranscribeAction` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 314. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/transfer-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/transfer-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..2a71aedfe7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/transfer-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/transfer-async-dictionary-string-object" +title: "TransferAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.TransferAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `TransferAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> TransferAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 223. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/unhold-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/unhold-async.mdx new file mode 100644 index 0000000000..487a354ee0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/unhold-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/unhold-async" +title: "UnholdAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.UnholdAsync()" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `UnholdAsync()` + +## Signature + +```dotnet +public Task> UnholdAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 214. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/call/user-event-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/user-event-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..54fb11bd75 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/call/user-event-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/call/user-event-async-dictionary-string-object" +title: "UserEventAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Call.UserEventAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs" + visibility: "public" +--- +# `UserEventAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> UserEventAsync(Dictionary? extra = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Call.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Call.cs) + +Line 265. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/authenticate-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/authenticate-async.mdx new file mode 100644 index 0000000000..d899a87b75 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/authenticate-async.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/authenticate-async" +title: "AuthenticateAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.AuthenticateAsync()" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `AuthenticateAsync()` + +Send the signalwire.connect RPC to authenticate. + +## Signature + +```dotnet +public Task AuthenticateAsync() +``` + +## Returns + +`System.Threading.Tasks.Task` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 152. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/build-web-socket-uri.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/build-web-socket-uri.mdx new file mode 100644 index 0000000000..34e25c4c4b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/build-web-socket-uri.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/build-web-socket-uri" +title: "BuildWebSocketUri()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.BuildWebSocketUri()" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `BuildWebSocketUri()` + +Build the full WebSocket URL: <xref href="SignalWire.Relay.Client.Scheme" data-throw-if-not-resolved="false"></xref>://<xref href="SignalWire.Relay.Client.Host" data-throw-if-not-resolved="false"></xref>/api/relay/ws. + +## Signature + +```dotnet +public Uri BuildWebSocketUri() +``` + +## Returns + +`System.Uri` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 109. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/client-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/client-dictionary-string-string.mdx new file mode 100644 index 0000000000..9ea0d1795b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/client-dictionary-string-string.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/client-dictionary-string-string" +title: "Client(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.Client(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `Client(Dictionary?)` + +## Signature + +```dotnet +public Client(Dictionary? options = null) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 78. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/connect-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/connect-async.mdx new file mode 100644 index 0000000000..8f1c52bbd0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/connect-async.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/connect-async" +title: "ConnectAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.ConnectAsync()" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `ConnectAsync()` + +Establish the WebSocket connection and authenticate. Opens a real +WSS connection to the configured host, runs the JSON-RPC <code>signalwire.connect</code> handshake, and starts the reader loop +that pumps inbound frames into <xref href="SignalWire.Relay.Client.HandleMessage(System.String)" data-throw-if-not-resolved="false"></xref>. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task ConnectAsync() +``` + +## Returns + +`System.Threading.Tasks.Task` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 125. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/dial-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/dial-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..242fc02082 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/dial-async-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/dial-async-dictionary-string-object" +title: "DialAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.DialAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `DialAsync(Dictionary)` + +Originate an outbound call, awaiting until the dial resolves. +Honours <code>params\_\["tag"]</code> when provided; otherwise a UUID is +generated. Honours <code>params\_\["dial\_timeout"]</code> (seconds) for the +resolve-or-throw deadline. + +## Signature + +```dotnet +public Task DialAsync(Dictionary params_) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 663. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/disconnect.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/disconnect.mdx new file mode 100644 index 0000000000..c891882c72 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/disconnect.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/disconnect" +title: "Disconnect()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.Disconnect()" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `Disconnect()` + +Gracefully close the connection. + +## Signature + +```dotnet +public void Disconnect() +``` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 207. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/execute-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/execute-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..e62467d9b0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/execute-async-string-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/execute-async-string-dictionary-string-object" +title: "ExecuteAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.ExecuteAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `ExecuteAsync(string, Dictionary?)` + +Send a JSON-RPC request and await the matching response. +Returns the "result" portion of the response. + +## Signature + +```dotnet +public Task> ExecuteAsync(string method, Dictionary? params_ = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 380. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/get-call-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/get-call-string.mdx new file mode 100644 index 0000000000..bf1022ae6c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/get-call-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/get-call-string" +title: "GetCall(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.GetCall(string)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `GetCall(string)` + +## Signature + +```dotnet +public Call? GetCall(string callId) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.Call` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 793. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/handle-event-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/handle-event-dictionary-string-object.mdx new file mode 100644 index 0000000000..d2c139bf67 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/handle-event-dictionary-string-object.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/handle-event-dictionary-string-object" +title: "HandleEvent(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.HandleEvent(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `HandleEvent(Dictionary)` + +Route a signalwire.event payload to the appropriate handler. + +## Signature + +```dotnet +public void HandleEvent(Dictionary outerParams) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 538. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/handle-message-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/handle-message-string.mdx new file mode 100644 index 0000000000..68e6fa0903 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/handle-message-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/handle-message-string" +title: "HandleMessage(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.HandleMessage(string)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `HandleMessage(string)` + +Parse a raw JSON string from the server and route it. + +## Signature + +```dotnet +public void HandleMessage(string raw) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 476. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/index.mdx new file mode 100644 index 0000000000..fcfdf7cb2b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/index.mdx @@ -0,0 +1,169 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client" +title: "Client" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `Client` + +RELAY Client -- manages the WebSocket connection to SignalWire, sends +JSON-RPC 2.0 requests, and dispatches inbound events to the correct +Call or Message objects. + +Uses async/await with <xref href="System.Threading.Tasks.TaskCompletionSource" data-throw-if-not-resolved="false"></xref> for the +native C# async pattern instead of polling loops. + +## Signature + +```dotnet +public class Client +``` + +## Properties + + + + + + + callId => Call. + + + + + + + + + + Messages received from the transport layer. Test code can enqueue here. + + + + messageId => Message. + + + + + + + + Inbound message handler. Mirrors Python's <code>@client.on\_message</code>: fires with a fully-formed <xref href="SignalWire.Relay.Message" data-throw-if-not-resolved="false"></xref> for every <code>messaging.receive</code> event. + + + + JSON-RPC id => pending request TCS. + + + + tag => pending dial TCS. + + + + + + + + + + + + +## Methods + + + + Send the signalwire.connect RPC to authenticate. + + + + Build the full WebSocket URL: <xref href="SignalWire.Relay.Client.Scheme" data-throw-if-not-resolved="false"></xref>://<xref href="SignalWire.Relay.Client.Host" data-throw-if-not-resolved="false"></xref>/api/relay/ws. + + + + + + Establish the WebSocket connection and authenticate. Opens a real WSS connection to the configured host, runs the JSON-RPC <code>signalwire.connect</code> handshake, and starts the reader loop that pumps inbound frames into <xref href="SignalWire.Relay.Client.HandleMessage(System.String)" data-throw-if-not-resolved="false"></xref>. + + + + Originate an outbound call, awaiting until the dial resolves. Honours <code>params\_\["tag"]</code> when provided; otherwise a UUID is generated. Honours <code>params\_\["dial\_timeout"]</code> (seconds) for the resolve-or-throw deadline. + + + + Gracefully close the connection. + + + + Send a JSON-RPC request and await the matching response. Returns the "result" portion of the response. + + + + + + Route a signalwire.event payload to the appropriate handler. + + + + Parse a raw JSON string from the server and route it. + + + + Register a handler for inbound calls. + + + + Register a handler for inbound messages. + + + + Reader loop that pulls UTF-8 text frames off the socket and routes each completed message into <xref href="SignalWire.Relay.Client.HandleMessage(System.String)" data-throw-if-not-resolved="false"></xref>. Handles fragmented frames by accumulating them until <xref href="System.Net.WebSockets.ValueWebSocketReceiveResult.EndOfMessage" data-throw-if-not-resolved="false"></xref>. + + + + Read one queued message synchronously (test helper for harness use). + + + + Subscribe to one or more inbound contexts. + + + + Reconnect with exponential back-off (1s to 30s cap). + + + + Main event loop -- drains the inbound queue and processes messages until disconnect. Used by the test path that pushes JSON strings into <xref href="SignalWire.Relay.Client.InboundQueue" data-throw-if-not-resolved="false"></xref>; production reads come from the WebSocket reader started in <xref href="SignalWire.Relay.Client.ConnectAsync" data-throw-if-not-resolved="false"></xref>. + + + + Encode and send a JSON message. Real production path writes to the WebSocket; tests override this to capture payloads in memory. + + + + Send an acknowledgement (empty result) for a server-initiated request. + + + + Send an outbound message. + + + + Unsubscribe from one or more contexts. + + + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 16. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/on-call-func-call-event-task.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/on-call-func-call-event-task.mdx new file mode 100644 index 0000000000..c02239a049 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/on-call-func-call-event-task.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/on-call-func-call-event-task" +title: "OnCall(Func)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.OnCall(System.Func)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `OnCall(Func)` + +Register a handler for inbound calls. + +## Signature + +```dotnet +public Client OnCall(Func callback) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.Client` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 778. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/on-message-func-message-event-task.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/on-message-func-message-event-task.mdx new file mode 100644 index 0000000000..793ba7dca3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/on-message-func-message-event-task.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/on-message-func-message-event-task" +title: "OnMessage(Func)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.OnMessage(System.Func)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `OnMessage(Func)` + +Register a handler for inbound messages. + +## Signature + +```dotnet +public Client OnMessage(Func callback) +``` + +## Parameters + + + +## Returns + +`SignalWire.Relay.Client` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 785. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/read-loop-async-cancellation-token.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/read-loop-async-cancellation-token.mdx new file mode 100644 index 0000000000..50fe328350 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/read-loop-async-cancellation-token.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/read-loop-async-cancellation-token" +title: "ReadLoopAsync(CancellationToken)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.ReadLoopAsync(System.Threading.CancellationToken)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `ReadLoopAsync(CancellationToken)` + +Reader loop that pulls UTF-8 text frames off the socket and routes +each completed message into <xref href="SignalWire.Relay.Client.HandleMessage(System.String)" data-throw-if-not-resolved="false"></xref>. Handles +fragmented frames by accumulating them until <xref href="System.Net.WebSockets.ValueWebSocketReceiveResult.EndOfMessage" data-throw-if-not-resolved="false"></xref>. + +## Signature + +```dotnet +public Task ReadLoopAsync(CancellationToken cancellation) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 306. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/read-once.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/read-once.mdx new file mode 100644 index 0000000000..027c886024 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/read-once.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/read-once" +title: "ReadOnce()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.ReadOnce()" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `ReadOnce()` + +Read one queued message synchronously (test helper for harness use). + +## Signature + +```dotnet +public void ReadOnce() +``` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 364. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/receive-async-i-enumerable-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/receive-async-i-enumerable-string.mdx new file mode 100644 index 0000000000..a147672380 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/receive-async-i-enumerable-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/receive-async-i-enumerable-string" +title: "ReceiveAsync(IEnumerable)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.ReceiveAsync(System.Collections.Generic.IEnumerable)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `ReceiveAsync(IEnumerable)` + +Subscribe to one or more inbound contexts. + +## Signature + +```dotnet +public Task ReceiveAsync(IEnumerable contexts) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 744. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/reconnect-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/reconnect-async.mdx new file mode 100644 index 0000000000..f6822083af --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/reconnect-async.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/reconnect-async" +title: "ReconnectAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.ReconnectAsync()" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `ReconnectAsync()` + +Reconnect with exponential back-off (1s to 30s cap). + +## Signature + +```dotnet +public Task ReconnectAsync() +``` + +## Returns + +`System.Threading.Tasks.Task` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 243. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/run-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/run-async.mdx new file mode 100644 index 0000000000..5241aa8ba9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/run-async.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/run-async" +title: "RunAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.RunAsync()" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `RunAsync()` + +Main event loop -- drains the inbound queue and processes messages +until disconnect. Used by the test path that pushes JSON strings +into <xref href="SignalWire.Relay.Client.InboundQueue" data-throw-if-not-resolved="false"></xref>; production reads come from the +WebSocket reader started in <xref href="SignalWire.Relay.Client.ConnectAsync" data-throw-if-not-resolved="false"></xref>. + +## Signature + +```dotnet +public Task RunAsync() +``` + +## Returns + +`System.Threading.Tasks.Task` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 268. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/send-ack-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/send-ack-string.mdx new file mode 100644 index 0000000000..8452f98b66 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/send-ack-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/send-ack-string" +title: "SendAck(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.SendAck(string)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `SendAck(string)` + +Send an acknowledgement (empty result) for a server-initiated request. + +## Signature + +```dotnet +public void SendAck(string id) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 461. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/send-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/send-dictionary-string-object.mdx new file mode 100644 index 0000000000..a9f7ee0f7a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/send-dictionary-string-object.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/send-dictionary-string-object" +title: "Send(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.Send(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `Send(Dictionary)` + +Encode and send a JSON message. Real production path writes to the +WebSocket; tests override this to capture payloads in memory. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual void Send(Dictionary msg) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 422. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/send-message-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/send-message-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..1c0c4ca9d5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/send-message-async-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/send-message-async-dictionary-string-object" +title: "SendMessageAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.SendMessageAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `SendMessageAsync(Dictionary)` + +Send an outbound message. + +## Signature + +```dotnet +public Task SendMessageAsync(Dictionary params_) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 715. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/client/unreceive-async-i-enumerable-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/unreceive-async-i-enumerable-string.mdx new file mode 100644 index 0000000000..be6f09be64 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/client/unreceive-async-i-enumerable-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/client/unreceive-async-i-enumerable-string" +title: "UnreceiveAsync(IEnumerable)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Client.UnreceiveAsync(System.Collections.Generic.IEnumerable)" + parent: "SignalWire.Relay.Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs" + visibility: "public" +--- +# `UnreceiveAsync(IEnumerable)` + +Unsubscribe from one or more contexts. + +## Signature + +```dotnet +public Task UnreceiveAsync(IEnumerable contexts) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task` + +## Source + +[`src/SignalWire/Relay/Client.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Client.cs) + +Line 764. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/accepts-terminal-event-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/accepts-terminal-event-string.mdx new file mode 100644 index 0000000000..8ee645fe73 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/accepts-terminal-event-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/collect-action/accepts-terminal-event-string" +title: "AcceptsTerminalEvent(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.CollectAction.AcceptsTerminalEvent(string)" + parent: "SignalWire.Relay.CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `AcceptsTerminalEvent(string)` + +Block <code>calling.call.play</code> events from triggering the standard +terminal-state resolution path: only <code>calling.call.collect</code> +may resolve a CollectAction. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool AcceptsTerminalEvent(string eventType) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 315. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/collect-action-string-string-string-object-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/collect-action-string-string-string-object-bool.mdx new file mode 100644 index 0000000000..b817250b9f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/collect-action-string-string-string-object-bool.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/collect-action/collect-action-string-string-string-object-bool" +title: "CollectAction(string, string, string, object, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.CollectAction.CollectAction(string, string, string, object, bool)" + parent: "SignalWire.Relay.CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `CollectAction(string, string, string, object, bool)` + +## Signature + +```dotnet +public CollectAction(string controlId, string callId, string nodeId, object client, bool isPlayAndCollect = false) +``` + +## Parameters + + + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 272. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/get-stop-method.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/get-stop-method.mdx new file mode 100644 index 0000000000..e9073f58d7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/collect-action/get-stop-method" +title: "GetStopMethod()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.CollectAction.GetStopMethod()" + parent: "SignalWire.Relay.CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetStopMethod()` + +Return the RELAY RPC method that stops this action. +Subclasses MUST override to return the correct method name. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string GetStopMethod() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 279. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/handle-event-event.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/handle-event-event.mdx new file mode 100644 index 0000000000..3d61587804 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/handle-event-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/collect-action/handle-event-event" +title: "HandleEvent(Event)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.CollectAction.HandleEvent(SignalWire.Relay.Event)" + parent: "SignalWire.Relay.CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `HandleEvent(Event)` + +Override: silently ignore intermediate play events that arrive +during a play\_and\_collect operation. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void HandleEvent(Event evt) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 304. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/index.mdx new file mode 100644 index 0000000000..179b578b60 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/index.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/collect-action" +title: "CollectAction" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.CollectAction" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `CollectAction` + +Handle for calling.collect (and play\_and\_collect) operations. + +Note: play\_and\_collect emits intermediate calling.call.play events +that must be silently ignored so they do not pollute the collect +action's state. + +## Signature + +```dotnet +public class CollectAction : Action +``` + +## Inheritance + +**Extends:** [SignalWire.Relay.Action](/reference/dotnet/signal-wire.relay/action) + +## Properties + + + Return the structured collect result from the payload. + + +## Methods + + + + Block <code>calling.call.play</code> events from triggering the standard terminal-state resolution path: only <code>calling.call.collect</code> may resolve a CollectAction. + + + + + + Return the RELAY RPC method that stops this action. Subclasses MUST override to return the correct method name. + + + + Override: silently ignore intermediate play events that arrive during a play\_and\_collect operation. + + + + Notify the server to start input timers now rather than waiting for the initial-timeout to expire naturally. + + + + play\_and\_collect-only: change playback volume mid-prompt. + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 268. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/start-input-timers.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..89b782baf4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/start-input-timers.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/collect-action/start-input-timers" +title: "StartInputTimers()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.CollectAction.StartInputTimers()" + parent: "SignalWire.Relay.CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `StartInputTimers()` + +Notify the server to start input timers now rather than waiting +for the initial-timeout to expire naturally. + +## Signature + +```dotnet +public void StartInputTimers() +``` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 286. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/volume-double.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/volume-double.mdx new file mode 100644 index 0000000000..3df2d6376f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/collect-action/volume-double.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/collect-action/volume-double" +title: "Volume(double)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.CollectAction.Volume(double)" + parent: "SignalWire.Relay.CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `Volume(double)` + +play\_and\_collect-only: change playback volume mid-prompt. + +## Signature + +```dotnet +public void Volume(double db) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 292. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/constants/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/constants/index.mdx new file mode 100644 index 0000000000..4aa5f3d935 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/constants/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/constants" +title: "Constants" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.Constants" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Constants.cs" + visibility: "public" +--- +# `Constants` + +Protocol constants for the RELAY WebSocket interface. +Defines protocol version, call/dial/message states, terminal states, +and per-event-type action terminal states. + +**Modifiers:** `static` + +## Signature + +```dotnet +public static class Constants +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Constants.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Constants.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/detect-action-string-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/detect-action-string-string-string-object.mdx new file mode 100644 index 0000000000..7e7af17e48 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/detect-action-string-string-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/detect-action/detect-action-string-string-string-object" +title: "DetectAction(string, string, string, object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.DetectAction.DetectAction(string, string, string, object)" + parent: "SignalWire.Relay.DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `DetectAction(string, string, string, object)` + +## Signature + +```dotnet +public DetectAction(string controlId, string callId, string nodeId, object client) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 322. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/get-stop-method.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/get-stop-method.mdx new file mode 100644 index 0000000000..cd32d30715 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/detect-action/get-stop-method" +title: "GetStopMethod()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.DetectAction.GetStopMethod()" + parent: "SignalWire.Relay.DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetStopMethod()` + +Return the RELAY RPC method that stops this action. +Subclasses MUST override to return the correct method name. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string GetStopMethod() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 325. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/handle-event-event.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/handle-event-event.mdx new file mode 100644 index 0000000000..eff06294b5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/handle-event-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/detect-action/handle-event-event" +title: "HandleEvent(Event)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.DetectAction.HandleEvent(SignalWire.Relay.Event)" + parent: "SignalWire.Relay.DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `HandleEvent(Event)` + +Per RELAY\_IMPLEMENTATION\_GUIDE.md "detect gotcha": detect events +continuously stream a <code>detect</code> object — resolve on the FIRST +meaningful detect payload (or on terminal state if it arrives first +with no detect data). + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void HandleEvent(Event evt) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 337. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/index.mdx new file mode 100644 index 0000000000..a96153a8b6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/detect-action/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/detect-action" +title: "DetectAction" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.DetectAction" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `DetectAction` + +Handle for calling.detect operations. + +## Signature + +```dotnet +public class DetectAction : Action +``` + +## Inheritance + +**Extends:** [SignalWire.Relay.Action](/reference/dotnet/signal-wire.relay/action) + +## Properties + + + +## Methods + + + + + + Return the RELAY RPC method that stops this action. Subclasses MUST override to return the correct method name. + + + + Per RELAY\_IMPLEMENTATION\_GUIDE.md "detect gotcha": detect events continuously stream a <code>detect</code> object — resolve on the FIRST meaningful detect payload (or on terminal state if it arrives first with no detect data). + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 320. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/event/event-string-dictionary-string-object-double.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/event/event-string-dictionary-string-object-double.mdx new file mode 100644 index 0000000000..fbef3e6581 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/event/event-string-dictionary-string-object-double.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/event/event-string-dictionary-string-object-double" +title: "Event(string, Dictionary, double)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Event.Event(string, System.Collections.Generic.Dictionary, double)" + parent: "SignalWire.Relay.Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Event.cs" + visibility: "public" +--- +# `Event(string, Dictionary, double)` + +## Signature + +```dotnet +public Event(string eventType, Dictionary params_, double timestamp = 0) +``` + +## Parameters + + + + + + + +## Source + +[`src/SignalWire/Relay/Event.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Event.cs) + +Line 13. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/event/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/event/index.mdx new file mode 100644 index 0000000000..3abf5b5b18 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/event/index.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/event" +title: "Event" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.Event" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Event.cs" + visibility: "public" +--- +# `Event` + +Represents a single RELAY event received from the server. +Carries the event type, a timestamp, and the params dictionary +from which call\_id, node\_id, control\_id, tag, and state are extracted. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class Event +``` + +## Properties + + + + + + + + + + + + + + + + + +## Methods + + + + + + Factory: parse an event from its type and params. + + + + + +## Source + +[`src/SignalWire/Relay/Event.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Event.cs) + +Line 7. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/event/parse-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/event/parse-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..626669233a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/event/parse-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/event/parse-string-dictionary-string-object" +title: "Parse(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Event.Parse(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Relay.Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Event.cs" + visibility: "public" +--- +# `Parse(string, Dictionary)` + +Factory: parse an event from its type and params. + +**Modifiers:** `static` + +## Signature + +```dotnet +public static Event Parse(string eventType, Dictionary params_) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Relay.Event` + +## Source + +[`src/SignalWire/Relay/Event.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Event.cs) + +Line 42. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/event/to-dict.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/event/to-dict.mdx new file mode 100644 index 0000000000..35d3a0a5a5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/event/to-dict.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/event/to-dict" +title: "ToDict()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Event.ToDict()" + parent: "SignalWire.Relay.Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Event.cs" + visibility: "public" +--- +# `ToDict()` + +## Signature + +```dotnet +public Dictionary ToDict() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Relay/Event.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Event.cs) + +Line 34. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/fax-action/fax-action-string-string-string-object-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/fax-action/fax-action-string-string-string-object-string.mdx new file mode 100644 index 0000000000..cdd01070b4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/fax-action/fax-action-string-string-string-object-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/fax-action/fax-action-string-string-string-object-string" +title: "FaxAction(string, string, string, object, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.FaxAction.FaxAction(string, string, string, object, string)" + parent: "SignalWire.Relay.FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `FaxAction(string, string, string, object, string)` + +## Signature + +```dotnet +public FaxAction(string controlId, string callId, string nodeId, object client, string faxType = "send") +``` + +## Parameters + + + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 353. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/fax-action/get-stop-method.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/fax-action/get-stop-method.mdx new file mode 100644 index 0000000000..cb40929f40 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/fax-action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/fax-action/get-stop-method" +title: "GetStopMethod()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.FaxAction.GetStopMethod()" + parent: "SignalWire.Relay.FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetStopMethod()` + +Return the RELAY RPC method that stops this action. +Subclasses MUST override to return the correct method name. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string GetStopMethod() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 359. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/fax-action/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/fax-action/index.mdx new file mode 100644 index 0000000000..678fbe9dce --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/fax-action/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/fax-action" +title: "FaxAction" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.FaxAction" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `FaxAction` + +Handle for calling.fax operations (send or receive). + +## Signature + +```dotnet +public class FaxAction : Action +``` + +## Inheritance + +**Extends:** [SignalWire.Relay.Action](/reference/dotnet/signal-wire.relay/action) + +## Properties + + + +## Methods + + + + + + Return the RELAY RPC method that stops this action. Subclasses MUST override to return the correct method name. + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 349. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/index.mdx new file mode 100644 index 0000000000..5934e7ef48 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/index.mdx @@ -0,0 +1,80 @@ +--- +slug: "/reference/dotnet/signal-wire.relay" +title: "SignalWire.Relay" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.Relay" +--- +# `SignalWire.Relay` + +## Classes + + + + Base class for all RELAY call actions (play, record, collect, etc.). An Action is the client-side handle returned when you start an asynchronous operation on a call. It accumulates events, tracks state, and resolves once the operation reaches a terminal state. Uses <xref href="System.Threading.Tasks.TaskCompletionSource" data-throw-if-not-resolved="false"></xref> for native async/await support. + + + + Handle for calling.ai operations. + + + + Represents a RELAY voice call. Holds call-level state, dispatches server events to registered listeners and to in-flight Action objects, and exposes every calling.\* RPC method as a first-class C# method. + + + + RELAY Client -- manages the WebSocket connection to SignalWire, sends JSON-RPC 2.0 requests, and dispatches inbound events to the correct Call or Message objects. Uses async/await with <xref href="System.Threading.Tasks.TaskCompletionSource" data-throw-if-not-resolved="false"></xref> for the native C# async pattern instead of polling loops. + + + + Handle for calling.collect (and play\_and\_collect) operations. Note: play\_and\_collect emits intermediate calling.call.play events that must be silently ignored so they do not pollute the collect action's state. + + + + Protocol constants for the RELAY WebSocket interface. Defines protocol version, call/dial/message states, terminal states, and per-event-type action terminal states. + + + + Handle for calling.detect operations. + + + + Represents a single RELAY event received from the server. Carries the event type, a timestamp, and the params dictionary from which call\_id, node\_id, control\_id, tag, and state are extracted. + + + + Handle for calling.fax operations (send or receive). + + + + Represents a RELAY messaging message (SMS / MMS). A Message is created when you send or receive a message through the RELAY messaging namespace. It accumulates state-change events and resolves once the message reaches a terminal state (delivered, undelivered, or failed). Uses <xref href="System.Threading.Tasks.TaskCompletionSource" data-throw-if-not-resolved="false"></xref> for native async/await support. + + + + Handle for calling.pay operations. + + + + Handle for calling.play operations. + + + + Handle for calling.record operations. + + + + Handle for calling.stream operations. + + + + Handle for calling.tap operations. + + + + Handle for calling.transcribe operations. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/message/dispatch-event-event.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/dispatch-event-event.mdx new file mode 100644 index 0000000000..20e786dc01 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/dispatch-event-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/message/dispatch-event-event" +title: "DispatchEvent(Event)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Message.DispatchEvent(SignalWire.Relay.Event)" + parent: "SignalWire.Relay.Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs" + visibility: "public" +--- +# `DispatchEvent(Event)` + +Process an inbound event for this message. +Updates state/reason, fires registered event listeners, and +auto-resolves when a terminal state is reached. + +## Signature + +```dotnet +public void DispatchEvent(Event evt) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Message.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs) + +Line 61. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/message/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/index.mdx new file mode 100644 index 0000000000..666fb150e9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/index.mdx @@ -0,0 +1,95 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/message" +title: "Message" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.Message" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs" + visibility: "public" +--- +# `Message` + +Represents a RELAY messaging message (SMS / MMS). + +A Message is created when you send or receive a message through the +RELAY messaging namespace. It accumulates state-change events and +resolves once the message reaches a terminal state (delivered, +undelivered, or failed). + +Uses <xref href="System.Threading.Tasks.TaskCompletionSource" data-throw-if-not-resolved="false"></xref> for native async/await support. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class Message +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + Process an inbound event for this message. Updates state/reason, fires registered event listeners, and auto-resolves when a terminal state is reached. + + + + Build a Message from a params dictionary (as returned by the server). + + + + Register a listener that fires on every state-change event. + + + + Register a callback to fire when the message reaches a terminal state. If the message is already complete the callback fires immediately. + + + + Mark this message as completed. The optional result is stored and the onCompleted callback fires exactly once. + + + + Await until the message completes or the timeout elapses. Returns the resolved result, or null on timeout. + + + +## Source + +[`src/SignalWire/Relay/Message.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs) + +Line 12. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/message/message-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/message-dictionary-string-object.mdx new file mode 100644 index 0000000000..90253450f9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/message-dictionary-string-object.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/message/message-dictionary-string-object" +title: "Message(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Message.Message(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Relay.Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs" + visibility: "public" +--- +# `Message(Dictionary?)` + +Build a Message from a params dictionary (as returned by the server). + +## Signature + +```dotnet +public Message(Dictionary? params_ = null) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Message.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs) + +Line 35. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/message/on-completed.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/on-completed.mdx new file mode 100644 index 0000000000..b1a3742288 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/on-completed.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/message/on-completed" +title: "OnCompleted" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Message.OnCompleted(System.Func)" + parent: "SignalWire.Relay.Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs" + visibility: "public" +--- +# `OnCompleted` + +Register a callback to fire when the message reaches a terminal state. +If the message is already complete the callback fires immediately. + +## Signature + + + + ```dotnet + public Message OnCompleted(Func callback) + ``` + + + + ```dotnet + public Message OnCompleted(Action callback) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`SignalWire.Relay.Message` + +## Returns (Overload 2) + +`SignalWire.Relay.Message` + +## Source + +[`src/SignalWire/Relay/Message.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs) + +Line 136. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/message/on.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/on.mdx new file mode 100644 index 0000000000..ff51098be2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/on.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/message/on" +title: "On" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Message.On(System.Func)" + parent: "SignalWire.Relay.Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs" + visibility: "public" +--- +# `On` + +Register a listener that fires on every state-change event. + +## Signature + + + + ```dotnet + public Message On(Func callback) + ``` + + + + ```dotnet + public Message On(Action callback) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`SignalWire.Relay.Message` + +## Returns (Overload 2) + +`SignalWire.Relay.Message` + +## Source + +[`src/SignalWire/Relay/Message.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs) + +Line 120. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/message/resolve-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/resolve-string.mdx new file mode 100644 index 0000000000..b0e4a9eaad --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/resolve-string.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/message/resolve-string" +title: "Resolve(string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Message.Resolve(string?)" + parent: "SignalWire.Relay.Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs" + visibility: "public" +--- +# `Resolve(string?)` + +Mark this message as completed. The optional result is stored and +the onCompleted callback fires exactly once. + +## Signature + +```dotnet +public void Resolve(string? result = null) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Message.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs) + +Line 168. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/message/wait-async-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/wait-async-int.mdx new file mode 100644 index 0000000000..3ffad8f51b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/message/wait-async-int.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/message/wait-async-int" +title: "WaitAsync(int)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.Message.WaitAsync(int)" + parent: "SignalWire.Relay.Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs" + visibility: "public" +--- +# `WaitAsync(int)` + +Await until the message completes or the timeout elapses. +Returns the resolved result, or null on timeout. + +## Signature + +```dotnet +public Task WaitAsync(int timeoutSeconds = 30) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task` + +## Source + +[`src/SignalWire/Relay/Message.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Message.cs) + +Line 101. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/pay-action/get-stop-method.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/pay-action/get-stop-method.mdx new file mode 100644 index 0000000000..c8b543e617 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/pay-action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/pay-action/get-stop-method" +title: "GetStopMethod()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.PayAction.GetStopMethod()" + parent: "SignalWire.Relay.PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetStopMethod()` + +Return the RELAY RPC method that stops this action. +Subclasses MUST override to return the correct method name. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string GetStopMethod() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 387. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/pay-action/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/pay-action/index.mdx new file mode 100644 index 0000000000..f849409b3f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/pay-action/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/pay-action" +title: "PayAction" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.PayAction" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `PayAction` + +Handle for calling.pay operations. + +## Signature + +```dotnet +public class PayAction : Action +``` + +## Inheritance + +**Extends:** [SignalWire.Relay.Action](/reference/dotnet/signal-wire.relay/action) + +## Methods + + + + Return the RELAY RPC method that stops this action. Subclasses MUST override to return the correct method name. + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 382. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/pay-action/pay-action-string-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/pay-action/pay-action-string-string-string-object.mdx new file mode 100644 index 0000000000..d17b0ba2ee --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/pay-action/pay-action-string-string-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/pay-action/pay-action-string-string-string-object" +title: "PayAction(string, string, string, object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.PayAction.PayAction(string, string, string, object)" + parent: "SignalWire.Relay.PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `PayAction(string, string, string, object)` + +## Signature + +```dotnet +public PayAction(string controlId, string callId, string nodeId, object client) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 384. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/get-stop-method.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/get-stop-method.mdx new file mode 100644 index 0000000000..30e12162a4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/play-action/get-stop-method" +title: "GetStopMethod()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.PlayAction.GetStopMethod()" + parent: "SignalWire.Relay.PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetStopMethod()` + +Return the RELAY RPC method that stops this action. +Subclasses MUST override to return the correct method name. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string GetStopMethod() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 221. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/index.mdx new file mode 100644 index 0000000000..1e06ffefb2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/play-action" +title: "PlayAction" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.PlayAction" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `PlayAction` + +Handle for calling.play operations. + +## Signature + +```dotnet +public class PlayAction : Action +``` + +## Inheritance + +**Extends:** [SignalWire.Relay.Action](/reference/dotnet/signal-wire.relay/action) + +## Methods + + + + Return the RELAY RPC method that stops this action. Subclasses MUST override to return the correct method name. + + + + + + + + + + Adjust playback volume in dB. + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 216. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/pause.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/pause.mdx new file mode 100644 index 0000000000..c7278ee142 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/pause.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/play-action/pause" +title: "Pause()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.PlayAction.Pause()" + parent: "SignalWire.Relay.PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `Pause()` + +## Signature + +```dotnet +public void Pause() +``` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 223. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/play-action-string-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/play-action-string-string-string-object.mdx new file mode 100644 index 0000000000..7d1da30b30 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/play-action-string-string-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/play-action/play-action-string-string-string-object" +title: "PlayAction(string, string, string, object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.PlayAction.PlayAction(string, string, string, object)" + parent: "SignalWire.Relay.PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `PlayAction(string, string, string, object)` + +## Signature + +```dotnet +public PlayAction(string controlId, string callId, string nodeId, object client) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 218. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/resume.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/resume.mdx new file mode 100644 index 0000000000..f86d39f0a4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/resume.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/play-action/resume" +title: "Resume()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.PlayAction.Resume()" + parent: "SignalWire.Relay.PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `Resume()` + +## Signature + +```dotnet +public void Resume() +``` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 225. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/volume-double.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/volume-double.mdx new file mode 100644 index 0000000000..f8b867e5a7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/play-action/volume-double.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/play-action/volume-double" +title: "Volume(double)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.PlayAction.Volume(double)" + parent: "SignalWire.Relay.PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `Volume(double)` + +Adjust playback volume in dB. + +## Signature + +```dotnet +public void Volume(double db) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 228. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/get-stop-method.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/get-stop-method.mdx new file mode 100644 index 0000000000..6212ee1ec5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/record-action/get-stop-method" +title: "GetStopMethod()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.RecordAction.GetStopMethod()" + parent: "SignalWire.Relay.RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetStopMethod()` + +Return the RELAY RPC method that stops this action. +Subclasses MUST override to return the correct method name. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string GetStopMethod() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 238. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/index.mdx new file mode 100644 index 0000000000..e8a858da17 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/record-action" +title: "RecordAction" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.RecordAction" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `RecordAction` + +Handle for calling.record operations. + +## Signature + +```dotnet +public class RecordAction : Action +``` + +## Inheritance + +**Extends:** [SignalWire.Relay.Action](/reference/dotnet/signal-wire.relay/action) + +## Properties + + + + + + + +## Methods + + + + Return the RELAY RPC method that stops this action. Subclasses MUST override to return the correct method name. + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 233. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/pause-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/pause-string.mdx new file mode 100644 index 0000000000..34ceb54b09 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/pause-string.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/record-action/pause-string" +title: "Pause(string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.RecordAction.Pause(string?)" + parent: "SignalWire.Relay.RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `Pause(string?)` + +## Signature + +```dotnet +public void Pause(string? behavior = null) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 240. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/record-action-string-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/record-action-string-string-string-object.mdx new file mode 100644 index 0000000000..b4342a07b7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/record-action-string-string-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/record-action/record-action-string-string-string-object" +title: "RecordAction(string, string, string, object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.RecordAction.RecordAction(string, string, string, object)" + parent: "SignalWire.Relay.RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `RecordAction(string, string, string, object)` + +## Signature + +```dotnet +public RecordAction(string controlId, string callId, string nodeId, object client) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 235. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/resume.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/resume.mdx new file mode 100644 index 0000000000..e0dccb3de7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/record-action/resume.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/record-action/resume" +title: "Resume()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.RecordAction.Resume()" + parent: "SignalWire.Relay.RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `Resume()` + +## Signature + +```dotnet +public void Resume() +``` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 248. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/stream-action/get-stop-method.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/stream-action/get-stop-method.mdx new file mode 100644 index 0000000000..08831aebfc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/stream-action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/stream-action/get-stop-method" +title: "GetStopMethod()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.StreamAction.GetStopMethod()" + parent: "SignalWire.Relay.StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetStopMethod()` + +Return the RELAY RPC method that stops this action. +Subclasses MUST override to return the correct method name. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string GetStopMethod() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 378. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/stream-action/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/stream-action/index.mdx new file mode 100644 index 0000000000..8c96258f29 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/stream-action/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/stream-action" +title: "StreamAction" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.StreamAction" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `StreamAction` + +Handle for calling.stream operations. + +## Signature + +```dotnet +public class StreamAction : Action +``` + +## Inheritance + +**Extends:** [SignalWire.Relay.Action](/reference/dotnet/signal-wire.relay/action) + +## Methods + + + + Return the RELAY RPC method that stops this action. Subclasses MUST override to return the correct method name. + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 373. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/stream-action/stream-action-string-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/stream-action/stream-action-string-string-string-object.mdx new file mode 100644 index 0000000000..2411ab01bd --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/stream-action/stream-action-string-string-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/stream-action/stream-action-string-string-string-object" +title: "StreamAction(string, string, string, object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.StreamAction.StreamAction(string, string, string, object)" + parent: "SignalWire.Relay.StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `StreamAction(string, string, string, object)` + +## Signature + +```dotnet +public StreamAction(string controlId, string callId, string nodeId, object client) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 375. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/tap-action/get-stop-method.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/tap-action/get-stop-method.mdx new file mode 100644 index 0000000000..ae0e70b4c2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/tap-action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/tap-action/get-stop-method" +title: "GetStopMethod()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.TapAction.GetStopMethod()" + parent: "SignalWire.Relay.TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetStopMethod()` + +Return the RELAY RPC method that stops this action. +Subclasses MUST override to return the correct method name. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string GetStopMethod() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 369. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/tap-action/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/tap-action/index.mdx new file mode 100644 index 0000000000..cfb1c7657b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/tap-action/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/tap-action" +title: "TapAction" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.TapAction" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `TapAction` + +Handle for calling.tap operations. + +## Signature + +```dotnet +public class TapAction : Action +``` + +## Inheritance + +**Extends:** [SignalWire.Relay.Action](/reference/dotnet/signal-wire.relay/action) + +## Methods + + + + Return the RELAY RPC method that stops this action. Subclasses MUST override to return the correct method name. + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 364. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/tap-action/tap-action-string-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/tap-action/tap-action-string-string-string-object.mdx new file mode 100644 index 0000000000..2f7e03d715 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/tap-action/tap-action-string-string-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/tap-action/tap-action-string-string-string-object" +title: "TapAction(string, string, string, object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.TapAction.TapAction(string, string, string, object)" + parent: "SignalWire.Relay.TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `TapAction(string, string, string, object)` + +## Signature + +```dotnet +public TapAction(string controlId, string callId, string nodeId, object client) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 366. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/transcribe-action/get-stop-method.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/transcribe-action/get-stop-method.mdx new file mode 100644 index 0000000000..169956e3d0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/transcribe-action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/transcribe-action/get-stop-method" +title: "GetStopMethod()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.TranscribeAction.GetStopMethod()" + parent: "SignalWire.Relay.TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `GetStopMethod()` + +Return the RELAY RPC method that stops this action. +Subclasses MUST override to return the correct method name. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string GetStopMethod() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 396. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/transcribe-action/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/transcribe-action/index.mdx new file mode 100644 index 0000000000..998e5e1223 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/transcribe-action/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/transcribe-action" +title: "TranscribeAction" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Relay.TranscribeAction" + parent: "SignalWire.Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `TranscribeAction` + +Handle for calling.transcribe operations. + +## Signature + +```dotnet +public class TranscribeAction : Action +``` + +## Inheritance + +**Extends:** [SignalWire.Relay.Action](/reference/dotnet/signal-wire.relay/action) + +## Methods + + + + Return the RELAY RPC method that stops this action. Subclasses MUST override to return the correct method name. + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 391. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.relay/transcribe-action/transcribe-action-string-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.relay/transcribe-action/transcribe-action-string-string-string-object.mdx new file mode 100644 index 0000000000..5135c36165 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.relay/transcribe-action/transcribe-action-string-string-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.relay/transcribe-action/transcribe-action-string-string-string-object" +title: "TranscribeAction(string, string, string, object)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Relay.TranscribeAction.TranscribeAction(string, string, string, object)" + parent: "SignalWire.Relay.TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs" + visibility: "public" +--- +# `TranscribeAction(string, string, string, object)` + +## Signature + +```dotnet +public TranscribeAction(string controlId, string callId, string nodeId, object client) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/SignalWire/Relay/Action.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Relay/Action.cs) + +Line 393. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/addresses/addresses-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/addresses/addresses-http-client.mdx new file mode 100644 index 0000000000..0292ed8d46 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/addresses/addresses-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/addresses/addresses-http-client" +title: "Addresses(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Addresses.Addresses(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.Addresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `Addresses(HttpClient)` + +## Signature + +```dotnet +public Addresses(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 188. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/addresses/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/addresses/index.mdx new file mode 100644 index 0000000000..d7b0108aa7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/addresses/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/addresses" +title: "Addresses" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Addresses" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `Addresses` + +Addresses namespace (Relay top-level addresses, no update). + +Mirrors Python `signalwire.rest.namespaces.addresses.AddressesResource`. +Inherits CrudResource for the standard list/create/get/delete surface. + +## Signature + +```dotnet +public class Addresses : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 186. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/call-flows-helper-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/call-flows-helper-http-client-string.mdx new file mode 100644 index 0000000000..c08aa1341e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/call-flows-helper-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/call-flows-helper-http-client-string" +title: "CallFlowsHelper(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CallFlowsHelper.CallFlowsHelper(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CallFlowsHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `CallFlowsHelper(HttpClient, string)` + +## Signature + +```dotnet +public CallFlowsHelper(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 153. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/deploy-version-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/deploy-version-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..f5d6c10b00 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/deploy-version-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/deploy-version-async-string-dictionary-string-object" +title: "DeployVersionAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CallFlowsHelper.DeployVersionAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CallFlowsHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `DeployVersionAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> DeployVersionAsync(string resourceId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 169. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/index.mdx new file mode 100644 index 0000000000..18c9a8604e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/call-flows-helper" +title: "CallFlowsHelper" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CallFlowsHelper" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `CallFlowsHelper` + +CallFlows helper providing the singular-path variants +(`/api/fabric/resources/call_flow/{id}/{addresses,versions}`). + +## Signature + +```dotnet +public class CallFlowsHelper +``` + +## Properties + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 147. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/list-addresses-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/list-addresses-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..d14a553968 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/list-addresses-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/list-addresses-async-string-dictionary-string-string" +title: "ListAddressesAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CallFlowsHelper.ListAddressesAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CallFlowsHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `ListAddressesAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListAddressesAsync(string resourceId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 163. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/list-versions-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/list-versions-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..292cf3c220 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/list-versions-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/call-flows-helper/list-versions-async-string-dictionary-string-string" +title: "ListVersionsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CallFlowsHelper.ListVersionsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CallFlowsHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `ListVersionsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListVersionsAsync(string resourceId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 166. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-hold-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-hold-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..440dfd3cd7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-hold-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/ai-hold-async-string-dictionary-string-object" +title: "AiHoldAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.AiHoldAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `AiHoldAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> AiHoldAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 176. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-message-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-message-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..6ae888caad --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-message-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/ai-message-async-string-dictionary-string-object" +title: "AiMessageAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.AiMessageAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `AiMessageAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> AiMessageAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 173. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-stop-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-stop-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..eea49f5c95 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-stop-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/ai-stop-async-string-dictionary-string-object" +title: "AiStopAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.AiStopAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `AiStopAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> AiStopAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 182. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-unhold-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-unhold-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..c81094aafa --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/ai-unhold-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/ai-unhold-async-string-dictionary-string-object" +title: "AiUnholdAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.AiUnholdAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `AiUnholdAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> AiUnholdAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 179. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/calling-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/calling-http-client-string.mdx new file mode 100644 index 0000000000..702b64920d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/calling-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/calling-http-client-string" +title: "Calling(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.Calling(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `Calling(HttpClient, string)` + +## Signature + +```dotnet +public Calling(HttpClient client, string projectId) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 16. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/collect-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/collect-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..a0319ed2a7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/collect-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/collect-async-string-dictionary-string-object" +title: "CollectAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.CollectAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `CollectAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> CollectAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 110. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/collect-start-input-timers-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/collect-start-input-timers-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..60593e3b89 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/collect-start-input-timers-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/collect-start-input-timers-async-string-dictionary-string-object" +title: "CollectStartInputTimersAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.CollectStartInputTimersAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `CollectStartInputTimersAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> CollectStartInputTimersAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 116. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/collect-stop-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/collect-stop-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..22be0da949 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/collect-stop-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/collect-stop-async-string-dictionary-string-object" +title: "CollectStopAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.CollectStopAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `CollectStopAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> CollectStopAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 113. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/denoise-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/denoise-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..48c3d8ad0d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/denoise-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/denoise-async-string-dictionary-string-object" +title: "DenoiseAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.DenoiseAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `DenoiseAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> DenoiseAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 153. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/denoise-stop-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/denoise-stop-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..9214129cdc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/denoise-stop-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/denoise-stop-async-string-dictionary-string-object" +title: "DenoiseStopAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.DenoiseStopAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `DenoiseStopAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> DenoiseStopAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 156. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/detect-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/detect-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..5977067071 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/detect-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/detect-async-string-dictionary-string-object" +title: "DetectAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.DetectAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `DetectAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> DetectAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 123. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/detect-stop-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/detect-stop-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..be222dc627 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/detect-stop-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/detect-stop-async-string-dictionary-string-object" +title: "DetectStopAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.DetectStopAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `DetectStopAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> DetectStopAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 126. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/dial-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/dial-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..42dcfdfdbd --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/dial-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/dial-async-dictionary-string-object" +title: "DialAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.DialAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `DialAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> DialAsync(Dictionary? parms = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 51. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/disconnect-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/disconnect-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..9868e8c2c3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/disconnect-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/disconnect-async-string-dictionary-string-object" +title: "DisconnectAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.DisconnectAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `DisconnectAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> DisconnectAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 68. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/end-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/end-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..309848ada2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/end-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/end-async-string-dictionary-string-object" +title: "EndAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.EndAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `EndAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> EndAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 62. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/get-base-path.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/get-base-path.mdx new file mode 100644 index 0000000000..9034e00ce6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/get-base-path" +title: "GetBasePath()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.GetBasePath()" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `GetBasePath()` + +## Signature + +```dotnet +public string GetBasePath() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 24. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/index.mdx new file mode 100644 index 0000000000..48319830ee --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/index.mdx @@ -0,0 +1,126 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling" +title: "Calling" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `Calling` + +Calling API namespace. + +Provides 37 call-control command methods that each POST to +/api/calling/calls with a JSON body containing the command name, +an optional call ID, and parameters. + +## Signature + +```dotnet +public class Calling +``` + +## Properties + + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Python-parity alias for <xref href="SignalWire.REST.Namespaces.Calling.UpdateCallAsync(System.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d)" data-throw-if-not-resolved="false"></xref>. Mirrors `CallingNamespace.update`. + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/live-transcribe-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/live-transcribe-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..1c713c63ab --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/live-transcribe-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/live-transcribe-async-string-dictionary-string-object" +title: "LiveTranscribeAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.LiveTranscribeAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `LiveTranscribeAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> LiveTranscribeAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 189. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/live-translate-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/live-translate-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..903d447c9b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/live-translate-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/live-translate-async-string-dictionary-string-object" +title: "LiveTranslateAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.LiveTranslateAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `LiveTranslateAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> LiveTranslateAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 192. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..a2148e4cde --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/play-async-string-dictionary-string-object" +title: "PlayAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.PlayAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `PlayAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> PlayAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 75. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-pause-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-pause-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..b590a07120 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-pause-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/play-pause-async-string-dictionary-string-object" +title: "PlayPauseAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.PlayPauseAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `PlayPauseAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> PlayPauseAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 78. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-resume-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-resume-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..9897eb7ffb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-resume-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/play-resume-async-string-dictionary-string-object" +title: "PlayResumeAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.PlayResumeAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `PlayResumeAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> PlayResumeAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 81. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-stop-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-stop-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..e93dc56f04 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-stop-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/play-stop-async-string-dictionary-string-object" +title: "PlayStopAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.PlayStopAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `PlayStopAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> PlayStopAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 84. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-volume-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-volume-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..bec89fca4c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/play-volume-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/play-volume-async-string-dictionary-string-object" +title: "PlayVolumeAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.PlayVolumeAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `PlayVolumeAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> PlayVolumeAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 87. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/receive-fax-stop-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/receive-fax-stop-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..a5a3a16214 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/receive-fax-stop-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/receive-fax-stop-async-string-dictionary-string-object" +title: "ReceiveFaxStopAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.ReceiveFaxStopAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `ReceiveFaxStopAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ReceiveFaxStopAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 202. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..b4dd8201c7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/record-async-string-dictionary-string-object" +title: "RecordAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.RecordAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `RecordAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> RecordAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 94. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-pause-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-pause-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..65dab7b9c4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-pause-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/record-pause-async-string-dictionary-string-object" +title: "RecordPauseAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.RecordPauseAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `RecordPauseAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> RecordPauseAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 97. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-resume-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-resume-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..0deaee6e5f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-resume-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/record-resume-async-string-dictionary-string-object" +title: "RecordResumeAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.RecordResumeAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `RecordResumeAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> RecordResumeAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 100. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-stop-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-stop-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..5adda73205 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/record-stop-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/record-stop-async-string-dictionary-string-object" +title: "RecordStopAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.RecordStopAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `RecordStopAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> RecordStopAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 103. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/refer-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/refer-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..f73fd8e9cd --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/refer-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/refer-async-string-dictionary-string-object" +title: "ReferAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.ReferAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `ReferAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ReferAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 209. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/send-fax-stop-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/send-fax-stop-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..ebec15fecc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/send-fax-stop-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/send-fax-stop-async-string-dictionary-string-object" +title: "SendFaxStopAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.SendFaxStopAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `SendFaxStopAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> SendFaxStopAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 199. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/stream-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/stream-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..cee0de75dc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/stream-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/stream-async-string-dictionary-string-object" +title: "StreamAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.StreamAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `StreamAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> StreamAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 143. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/stream-stop-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/stream-stop-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..811bfd6509 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/stream-stop-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/stream-stop-async-string-dictionary-string-object" +title: "StreamStopAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.StreamStopAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `StreamStopAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> StreamStopAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 146. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/tap-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/tap-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..8eebb71ee9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/tap-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/tap-async-string-dictionary-string-object" +title: "TapAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.TapAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `TapAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> TapAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 133. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/tap-stop-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/tap-stop-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..91d22b378d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/tap-stop-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/tap-stop-async-string-dictionary-string-object" +title: "TapStopAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.TapStopAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `TapStopAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> TapStopAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 136. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/transcribe-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/transcribe-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..6011b87def --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/transcribe-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/transcribe-async-string-dictionary-string-object" +title: "TranscribeAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.TranscribeAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `TranscribeAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> TranscribeAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 163. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/transcribe-stop-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/transcribe-stop-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..a71ebd1cd8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/transcribe-stop-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/transcribe-stop-async-string-dictionary-string-object" +title: "TranscribeStopAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.TranscribeStopAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `TranscribeStopAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> TranscribeStopAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 166. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/transfer-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/transfer-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..5b3c2f7229 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/transfer-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/transfer-async-string-dictionary-string-object" +title: "TransferAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.TransferAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `TransferAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> TransferAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 65. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/update-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/update-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..ec28697f3a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/update-async-dictionary-string-object.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/update-async-dictionary-string-object" +title: "UpdateAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.UpdateAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `UpdateAsync(Dictionary?)` + +Python-parity alias for <xref href="SignalWire.REST.Namespaces.Calling.UpdateCallAsync(System.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d)" data-throw-if-not-resolved="false"></xref>. +Mirrors `CallingNamespace.update`. + +## Signature + +```dotnet +public Task> UpdateAsync(Dictionary? parms = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 59. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/update-call-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/update-call-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..2499f5c810 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/update-call-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/update-call-async-dictionary-string-object" +title: "UpdateCallAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.UpdateCallAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `UpdateCallAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> UpdateCallAsync(Dictionary? parms = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 54. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/user-event-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/user-event-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..87eba34cac --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/calling/user-event-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/calling/user-event-async-string-dictionary-string-object" +title: "UserEventAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Calling.UserEventAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs" + visibility: "public" +--- +# `UserEventAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> UserEventAsync(string callId, Dictionary? parms = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Calling.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Calling.cs) + +Line 216. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/compat-accounts-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/compat-accounts-http-client.mdx new file mode 100644 index 0000000000..bb73e144a1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/compat-accounts-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-accounts/compat-accounts-http-client" +title: "CompatAccounts(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatAccounts.CompatAccounts(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.CompatAccounts" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatAccounts(HttpClient)` + +## Signature + +```dotnet +public CompatAccounts(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 69. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/create-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/create-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..cd1c386d94 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/create-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-accounts/create-async-dictionary-string-object" +title: "CreateAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatAccounts.CreateAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatAccounts" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CreateAsync(Dictionary)` + +## Signature + +```dotnet +public Task> CreateAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 74. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/get-async-string.mdx new file mode 100644 index 0000000000..545a2b9a85 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-accounts/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatAccounts.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.CompatAccounts" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string sid) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 77. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/index.mdx new file mode 100644 index 0000000000..5f04073d4e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-accounts" +title: "CompatAccounts" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatAccounts" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatAccounts` + +Compat account/subproject management. Lives at the top-level +/api/laml/2010-04-01/Accounts collection (no AccountSid prefix). + +## Signature + +```dotnet +public class CompatAccounts +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 65. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..d5a666b2ea --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-accounts/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatAccounts.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatAccounts" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 71. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..9d9879a9c5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-accounts/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-accounts/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatAccounts.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatAccounts" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> UpdateAsync(string sid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 80. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-applications/compat-applications-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-applications/compat-applications-http-client-string.mdx new file mode 100644 index 0000000000..4428e2c044 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-applications/compat-applications-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-applications/compat-applications-http-client-string" +title: "CompatApplications(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatApplications.CompatApplications(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CompatApplications" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatApplications(HttpClient, string)` + +## Signature + +```dotnet +public CompatApplications(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 252. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-applications/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-applications/index.mdx new file mode 100644 index 0000000000..eacd4e845a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-applications/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-applications" +title: "CompatApplications" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatApplications" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatApplications` + +Compat applications (Twilio LaML voice/SMS apps). + +## Signature + +```dotnet +public class CompatApplications : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 250. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-applications/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-applications/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..2d2db24917 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-applications/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-applications/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatApplications.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatApplications" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +Update a resource by ID (PUT basePath/\{id\}). + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Task> UpdateAsync(string sid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 254. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/compat-calls-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/compat-calls-http-client-string.mdx new file mode 100644 index 0000000000..c231aa4064 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/compat-calls-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-calls/compat-calls-http-client-string" +title: "CompatCalls(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatCalls.CompatCalls(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CompatCalls" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatCalls(HttpClient, string)` + +## Signature + +```dotnet +public CompatCalls(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 88. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/index.mdx new file mode 100644 index 0000000000..84808e2407 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-calls" +title: "CompatCalls" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatCalls" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatCalls` + +Compat calls with recording + stream sub-resources. +Inherits standard CRUD; adds Twilio-style compat extensions. + +## Signature + +```dotnet +public class CompatCalls : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + + + + + + + UPDATE uses POST (Twilio compat) — overrides the generic CrudResource PUT. + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 86. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/start-recording-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/start-recording-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..49de7af3c3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/start-recording-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-calls/start-recording-async-string-dictionary-string-object" +title: "StartRecordingAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatCalls.StartRecordingAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatCalls" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `StartRecordingAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> StartRecordingAsync(string callSid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 94. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/start-stream-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/start-stream-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..938d064c35 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/start-stream-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-calls/start-stream-async-string-dictionary-string-object" +title: "StartStreamAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatCalls.StartStreamAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatCalls" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `StartStreamAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> StartStreamAsync(string callSid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 100. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/stop-stream-async-string-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/stop-stream-async-string-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..ea14872579 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/stop-stream-async-string-string-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-calls/stop-stream-async-string-string-dictionary-string-object" +title: "StopStreamAsync(string, string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatCalls.StopStreamAsync(string, string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatCalls" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `StopStreamAsync(string, string, Dictionary)` + +## Signature + +```dotnet +public Task> StopStreamAsync(string callSid, string streamSid, Dictionary kwargs) +``` + +## Parameters + + + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 103. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..85ea3d8b3c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-calls/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatCalls.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatCalls" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +UPDATE uses POST (Twilio compat) — overrides the generic CrudResource PUT. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Task> UpdateAsync(string sid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 91. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/update-recording-async-string-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/update-recording-async-string-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..ed50397c34 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-calls/update-recording-async-string-string-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-calls/update-recording-async-string-string-dictionary-string-object" +title: "UpdateRecordingAsync(string, string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatCalls.UpdateRecordingAsync(string, string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatCalls" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateRecordingAsync(string, string, Dictionary)` + +## Signature + +```dotnet +public Task> UpdateRecordingAsync(string callSid, string recordingSid, Dictionary kwargs) +``` + +## Parameters + + + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 97. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/compat-conferences-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/compat-conferences-http-client-string.mdx new file mode 100644 index 0000000000..3b85653030 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/compat-conferences-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/compat-conferences-http-client-string" +title: "CompatConferences(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.CompatConferences(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatConferences(HttpClient, string)` + +## Signature + +```dotnet +public CompatConferences(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 149. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/delete-recording-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/delete-recording-async-string-string.mdx new file mode 100644 index 0000000000..d3086c7003 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/delete-recording-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/delete-recording-async-string-string" +title: "DeleteRecordingAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.DeleteRecordingAsync(string, string)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `DeleteRecordingAsync(string, string)` + +## Signature + +```dotnet +public Task> DeleteRecordingAsync(string conferenceSid, string recordingSid) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 190. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-async-string.mdx new file mode 100644 index 0000000000..a5b224b9a9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string sid) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 163. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-participant-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-participant-async-string-string.mdx new file mode 100644 index 0000000000..6f660a1b09 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-participant-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-participant-async-string-string" +title: "GetParticipantAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.GetParticipantAsync(string, string)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `GetParticipantAsync(string, string)` + +## Signature + +```dotnet +public Task> GetParticipantAsync(string conferenceSid, string callSid) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 172. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-recording-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-recording-async-string-string.mdx new file mode 100644 index 0000000000..2349c04101 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-recording-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/get-recording-async-string-string" +title: "GetRecordingAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.GetRecordingAsync(string, string)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `GetRecordingAsync(string, string)` + +## Signature + +```dotnet +public Task> GetRecordingAsync(string conferenceSid, string recordingSid) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 184. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/index.mdx new file mode 100644 index 0000000000..d43ad1f911 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences" +title: "CompatConferences" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatConferences` + +Compat conferences with participant, recording, and stream sub-resources. + +## Signature + +```dotnet +public class CompatConferences +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 144. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..2b183479e6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 160. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-participants-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-participants-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..1dbf16ce7d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-participants-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-participants-async-string-dictionary-string-string" +title: "ListParticipantsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.ListParticipantsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ListParticipantsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListParticipantsAsync(string conferenceSid, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 169. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-recordings-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-recordings-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..a0c5ca92c5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-recordings-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/list-recordings-async-string-dictionary-string-string" +title: "ListRecordingsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.ListRecordingsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ListRecordingsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListRecordingsAsync(string conferenceSid, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 181. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/remove-participant-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/remove-participant-async-string-string.mdx new file mode 100644 index 0000000000..31a0c933ba --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/remove-participant-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/remove-participant-async-string-string" +title: "RemoveParticipantAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.RemoveParticipantAsync(string, string)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `RemoveParticipantAsync(string, string)` + +## Signature + +```dotnet +public Task> RemoveParticipantAsync(string conferenceSid, string callSid) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 178. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/start-stream-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/start-stream-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..6b3f751be0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/start-stream-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/start-stream-async-string-dictionary-string-object" +title: "StartStreamAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.StartStreamAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `StartStreamAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> StartStreamAsync(string conferenceSid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 193. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/stop-stream-async-string-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/stop-stream-async-string-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..cec5c87f7c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/stop-stream-async-string-string-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/stop-stream-async-string-string-dictionary-string-object" +title: "StopStreamAsync(string, string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.StopStreamAsync(string, string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `StopStreamAsync(string, string, Dictionary)` + +## Signature + +```dotnet +public Task> StopStreamAsync(string conferenceSid, string streamSid, Dictionary kwargs) +``` + +## Parameters + + + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 196. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..f59cb88838 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> UpdateAsync(string sid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 166. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-participant-async-string-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-participant-async-string-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..042bcfc4ee --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-participant-async-string-string-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-participant-async-string-string-dictionary-string-object" +title: "UpdateParticipantAsync(string, string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.UpdateParticipantAsync(string, string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateParticipantAsync(string, string, Dictionary)` + +## Signature + +```dotnet +public Task> UpdateParticipantAsync(string conferenceSid, string callSid, Dictionary kwargs) +``` + +## Parameters + + + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 175. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-recording-async-string-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-recording-async-string-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..6b766c6a5e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-recording-async-string-string-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-conferences/update-recording-async-string-string-dictionary-string-object" +title: "UpdateRecordingAsync(string, string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatConferences.UpdateRecordingAsync(string, string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateRecordingAsync(string, string, Dictionary)` + +## Signature + +```dotnet +public Task> UpdateRecordingAsync(string conferenceSid, string recordingSid, Dictionary kwargs) +``` + +## Parameters + + + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 187. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/compat-faxes-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/compat-faxes-http-client-string.mdx new file mode 100644 index 0000000000..d961d214ac --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/compat-faxes-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-faxes/compat-faxes-http-client-string" +title: "CompatFaxes(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatFaxes.CompatFaxes(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CompatFaxes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatFaxes(HttpClient, string)` + +## Signature + +```dotnet +public CompatFaxes(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 128. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/delete-media-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/delete-media-async-string-string.mdx new file mode 100644 index 0000000000..6b8207078a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/delete-media-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-faxes/delete-media-async-string-string" +title: "DeleteMediaAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatFaxes.DeleteMediaAsync(string, string)" + parent: "SignalWire.REST.Namespaces.CompatFaxes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `DeleteMediaAsync(string, string)` + +## Signature + +```dotnet +public Task> DeleteMediaAsync(string faxSid, string mediaSid) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 139. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/get-media-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/get-media-async-string-string.mdx new file mode 100644 index 0000000000..3ab4259504 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/get-media-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-faxes/get-media-async-string-string" +title: "GetMediaAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatFaxes.GetMediaAsync(string, string)" + parent: "SignalWire.REST.Namespaces.CompatFaxes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `GetMediaAsync(string, string)` + +## Signature + +```dotnet +public Task> GetMediaAsync(string faxSid, string mediaSid) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 136. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/index.mdx new file mode 100644 index 0000000000..3ac0c68563 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-faxes" +title: "CompatFaxes" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatFaxes" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatFaxes` + +Compat faxes with media sub-resources. + +## Signature + +```dotnet +public class CompatFaxes : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + + + + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 126. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/list-media-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/list-media-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..0097d75201 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/list-media-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-faxes/list-media-async-string-dictionary-string-string" +title: "ListMediaAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatFaxes.ListMediaAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatFaxes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ListMediaAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListMediaAsync(string faxSid, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 133. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..05863bf05b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-faxes/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-faxes/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatFaxes.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatFaxes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +Update a resource by ID (PUT basePath/\{id\}). + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Task> UpdateAsync(string sid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 130. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins/compat-laml-bins-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins/compat-laml-bins-http-client-string.mdx new file mode 100644 index 0000000000..bf18dbbc50 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins/compat-laml-bins-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins/compat-laml-bins-http-client-string" +title: "CompatLamlBins(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatLamlBins.CompatLamlBins(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CompatLamlBins" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatLamlBins(HttpClient, string)` + +## Signature + +```dotnet +public CompatLamlBins(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 261. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins/index.mdx new file mode 100644 index 0000000000..ab7cfe7283 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins" +title: "CompatLamlBins" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatLamlBins" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatLamlBins` + +Compat cXML / LaML script bins. + +## Signature + +```dotnet +public class CompatLamlBins : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 259. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..01e8e2606d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-laml-bins/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatLamlBins.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatLamlBins" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +Update a resource by ID (PUT basePath/\{id\}). + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Task> UpdateAsync(string sid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 263. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/compat-messages-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/compat-messages-http-client-string.mdx new file mode 100644 index 0000000000..e95f10f7d9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/compat-messages-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-messages/compat-messages-http-client-string" +title: "CompatMessages(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatMessages.CompatMessages(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CompatMessages" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatMessages(HttpClient, string)` + +## Signature + +```dotnet +public CompatMessages(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 110. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/delete-media-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/delete-media-async-string-string.mdx new file mode 100644 index 0000000000..2fa74f0560 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/delete-media-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-messages/delete-media-async-string-string" +title: "DeleteMediaAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatMessages.DeleteMediaAsync(string, string)" + parent: "SignalWire.REST.Namespaces.CompatMessages" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `DeleteMediaAsync(string, string)` + +## Signature + +```dotnet +public Task> DeleteMediaAsync(string messageSid, string mediaSid) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 121. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/get-media-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/get-media-async-string-string.mdx new file mode 100644 index 0000000000..df88a229f2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/get-media-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-messages/get-media-async-string-string" +title: "GetMediaAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatMessages.GetMediaAsync(string, string)" + parent: "SignalWire.REST.Namespaces.CompatMessages" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `GetMediaAsync(string, string)` + +## Signature + +```dotnet +public Task> GetMediaAsync(string messageSid, string mediaSid) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 118. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/index.mdx new file mode 100644 index 0000000000..e8a223d66a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-messages" +title: "CompatMessages" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatMessages" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatMessages` + +Compat messages with media sub-resources. + +## Signature + +```dotnet +public class CompatMessages : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + + + + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 108. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/list-media-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/list-media-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..20c4e7c6c3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/list-media-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-messages/list-media-async-string-dictionary-string-string" +title: "ListMediaAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatMessages.ListMediaAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatMessages" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ListMediaAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListMediaAsync(string messageSid, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 115. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..07f511dd6f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-messages/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-messages/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatMessages.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatMessages" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +Update a resource by ID (PUT basePath/\{id\}). + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Task> UpdateAsync(string sid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 112. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/compat-phone-numbers-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/compat-phone-numbers-http-client-string.mdx new file mode 100644 index 0000000000..e6394fee24 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/compat-phone-numbers-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/compat-phone-numbers-http-client-string" +title: "CompatPhoneNumbers(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatPhoneNumbers.CompatPhoneNumbers(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatPhoneNumbers(HttpClient, string)` + +## Signature + +```dotnet +public CompatPhoneNumbers(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 208. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/delete-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/delete-async-string.mdx new file mode 100644 index 0000000000..4b58014f8c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/delete-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/delete-async-string" +title: "DeleteAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatPhoneNumbers.DeleteAsync(string)" + parent: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `DeleteAsync(string)` + +## Signature + +```dotnet +public Task> DeleteAsync(string sid) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 233. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/get-async-string.mdx new file mode 100644 index 0000000000..27f96c3214 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatPhoneNumbers.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string sid) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 227. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/import-number-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/import-number-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..64aa0dad62 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/import-number-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/import-number-async-dictionary-string-object" +title: "ImportNumberAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatPhoneNumbers.ImportNumberAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ImportNumberAsync(Dictionary)` + +## Signature + +```dotnet +public Task> ImportNumberAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 236. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/index.mdx new file mode 100644 index 0000000000..66ec5fa87a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers" +title: "CompatPhoneNumbers" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatPhoneNumbers` + +Compat phone-number management with purchase, import, and search. + +## Signature + +```dotnet +public class CompatPhoneNumbers +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 201. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..3d9131f8e4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatPhoneNumbers.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 221. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/list-available-countries-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/list-available-countries-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..19fd24c098 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/list-available-countries-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/list-available-countries-async-dictionary-string-string" +title: "ListAvailableCountriesAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatPhoneNumbers.ListAvailableCountriesAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ListAvailableCountriesAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAvailableCountriesAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 239. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/purchase-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/purchase-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..00aa179af2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/purchase-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/purchase-async-dictionary-string-object" +title: "PurchaseAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatPhoneNumbers.PurchaseAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `PurchaseAsync(Dictionary)` + +## Signature + +```dotnet +public Task> PurchaseAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 224. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/search-local-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/search-local-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..9f8706ac2d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/search-local-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/search-local-async-string-dictionary-string-string" +title: "SearchLocalAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatPhoneNumbers.SearchLocalAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `SearchLocalAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> SearchLocalAsync(string country, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 242. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/search-toll-free-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/search-toll-free-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..e390aed286 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/search-toll-free-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/search-toll-free-async-string-dictionary-string-string" +title: "SearchTollFreeAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatPhoneNumbers.SearchTollFreeAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `SearchTollFreeAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> SearchTollFreeAsync(string country, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 245. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..dcd767d025 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-phone-numbers/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatPhoneNumbers.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> UpdateAsync(string sid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 230. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/compat-queues-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/compat-queues-http-client-string.mdx new file mode 100644 index 0000000000..3bfb437727 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/compat-queues-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-queues/compat-queues-http-client-string" +title: "CompatQueues(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatQueues.CompatQueues(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CompatQueues" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatQueues(HttpClient, string)` + +## Signature + +```dotnet +public CompatQueues(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 270. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/dequeue-member-async-string-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/dequeue-member-async-string-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..106c35859d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/dequeue-member-async-string-string-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-queues/dequeue-member-async-string-string-dictionary-string-object" +title: "DequeueMemberAsync(string, string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatQueues.DequeueMemberAsync(string, string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatQueues" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `DequeueMemberAsync(string, string, Dictionary)` + +## Signature + +```dotnet +public Task> DequeueMemberAsync(string queueSid, string callSid, Dictionary kwargs) +``` + +## Parameters + + + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 281. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/get-member-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/get-member-async-string-string.mdx new file mode 100644 index 0000000000..0210412fab --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/get-member-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-queues/get-member-async-string-string" +title: "GetMemberAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatQueues.GetMemberAsync(string, string)" + parent: "SignalWire.REST.Namespaces.CompatQueues" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `GetMemberAsync(string, string)` + +## Signature + +```dotnet +public Task> GetMemberAsync(string queueSid, string callSid) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 278. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/index.mdx new file mode 100644 index 0000000000..253fc1202e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-queues" +title: "CompatQueues" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatQueues" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatQueues` + +Compat queues with member management. + +## Signature + +```dotnet +public class CompatQueues : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + + + + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 268. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/list-members-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/list-members-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..f7486adfee --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/list-members-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-queues/list-members-async-string-dictionary-string-string" +title: "ListMembersAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatQueues.ListMembersAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatQueues" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ListMembersAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListMembersAsync(string queueSid, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 275. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..efbeab5484 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-queues/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-queues/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatQueues.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatQueues" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +Update a resource by ID (PUT basePath/\{id\}). + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Task> UpdateAsync(string sid, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 272. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/compat-recordings-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/compat-recordings-http-client-string.mdx new file mode 100644 index 0000000000..3cb8807dd4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/compat-recordings-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-recordings/compat-recordings-http-client-string" +title: "CompatRecordings(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatRecordings.CompatRecordings(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CompatRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatRecordings(HttpClient, string)` + +## Signature + +```dotnet +public CompatRecordings(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 291. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/delete-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/delete-async-string.mdx new file mode 100644 index 0000000000..2f4ce92c6e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/delete-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-recordings/delete-async-string" +title: "DeleteAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatRecordings.DeleteAsync(string)" + parent: "SignalWire.REST.Namespaces.CompatRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `DeleteAsync(string)` + +## Signature + +```dotnet +public Task> DeleteAsync(string sid) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 307. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/get-async-string.mdx new file mode 100644 index 0000000000..3802c3df58 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-recordings/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatRecordings.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.CompatRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string sid) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 304. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/index.mdx new file mode 100644 index 0000000000..eb61b553d4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-recordings" +title: "CompatRecordings" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatRecordings" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatRecordings` + +Compat recordings (read-only top-level resource). + +## Signature + +```dotnet +public class CompatRecordings +``` + +## Properties + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 286. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..b637c1cf36 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-recordings/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-recordings/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatRecordings.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 301. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/compat-tokens-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/compat-tokens-http-client-string.mdx new file mode 100644 index 0000000000..6ae77064d0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/compat-tokens-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-tokens/compat-tokens-http-client-string" +title: "CompatTokens(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatTokens.CompatTokens(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CompatTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatTokens(HttpClient, string)` + +## Signature + +```dotnet +public CompatTokens(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 343. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/create-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/create-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..f816deaac9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/create-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-tokens/create-async-dictionary-string-object" +title: "CreateAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatTokens.CreateAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CreateAsync(Dictionary)` + +## Signature + +```dotnet +public Task> CreateAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 353. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/delete-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/delete-async-string.mdx new file mode 100644 index 0000000000..7cc3322d7b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/delete-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-tokens/delete-async-string" +title: "DeleteAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatTokens.DeleteAsync(string)" + parent: "SignalWire.REST.Namespaces.CompatTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `DeleteAsync(string)` + +## Signature + +```dotnet +public Task> DeleteAsync(string tokenId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 359. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/index.mdx new file mode 100644 index 0000000000..7009013c4b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-tokens" +title: "CompatTokens" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatTokens" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatTokens` + +Compat API tokens — UPDATE uses PATCH (BaseResource style). + +## Signature + +```dotnet +public class CompatTokens +``` + +## Properties + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 338. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..1c99eb941a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-tokens/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-tokens/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatTokens.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.CompatTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> UpdateAsync(string tokenId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 356. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/compat-transcriptions-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/compat-transcriptions-http-client-string.mdx new file mode 100644 index 0000000000..3732834904 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/compat-transcriptions-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/compat-transcriptions-http-client-string" +title: "CompatTranscriptions(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatTranscriptions.CompatTranscriptions(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.CompatTranscriptions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatTranscriptions(HttpClient, string)` + +## Signature + +```dotnet +public CompatTranscriptions(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 317. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/delete-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/delete-async-string.mdx new file mode 100644 index 0000000000..44221d81d2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/delete-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/delete-async-string" +title: "DeleteAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatTranscriptions.DeleteAsync(string)" + parent: "SignalWire.REST.Namespaces.CompatTranscriptions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `DeleteAsync(string)` + +## Signature + +```dotnet +public Task> DeleteAsync(string sid) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 333. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/get-async-string.mdx new file mode 100644 index 0000000000..43be05c33b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatTranscriptions.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.CompatTranscriptions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string sid) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 330. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/index.mdx new file mode 100644 index 0000000000..c9450d0da9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions" +title: "CompatTranscriptions" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatTranscriptions" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `CompatTranscriptions` + +Compat transcriptions (read-only top-level resource). + +## Signature + +```dotnet +public class CompatTranscriptions +``` + +## Properties + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 312. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..2e59973e46 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat-transcriptions/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CompatTranscriptions.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CompatTranscriptions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 327. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat/compat-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat/compat-http-client-string.mdx new file mode 100644 index 0000000000..c758260002 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat/compat-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat/compat-http-client-string" +title: "Compat(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Compat.Compat(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `Compat(HttpClient, string)` + +## Signature + +```dotnet +public Compat(HttpClient client, string accountSid) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 40. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat/index.mdx new file mode 100644 index 0000000000..82ea00e3f2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/compat/index.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/compat" +title: "Compat" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Compat" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs" + visibility: "public" +--- +# `Compat` + +Twilio-compatible (LaML) API namespace with AccountSid scoping. + +Mirrors Python `signalwire.rest.namespaces.compat.CompatNamespace`: +the entry-point exposes 12 sub-resources (accounts, calls, messages, +faxes, conferences, phone\_numbers, applications, laml\_bins, queues, +recordings, transcriptions, tokens) under a shared per-account prefix. + +<p>Inherits from <xref href="SignalWire.REST.CrudResource" data-throw-if-not-resolved="false"></xref> so the historical +``client.Compat.List()`` / ``Create`` / ``Get`` / ``Update`` / ``Delete`` +surface continues to work; the per-account collection accessors are +added on top.</p> + +## Signature + +```dotnet +public class Compat : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Compat.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Compat.cs) + +Line 22. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-logs/conference-logs-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-logs/conference-logs-http-client-string.mdx new file mode 100644 index 0000000000..cac795ec08 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-logs/conference-logs-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/conference-logs/conference-logs-http-client-string" +title: "ConferenceLogs(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ConferenceLogs.ConferenceLogs(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.ConferenceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `ConferenceLogs(HttpClient, string)` + +## Signature + +```dotnet +public ConferenceLogs(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 114. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-logs/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-logs/index.mdx new file mode 100644 index 0000000000..f7f2e14846 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-logs/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/conference-logs" +title: "ConferenceLogs" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ConferenceLogs" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `ConferenceLogs` + +Conference log queries (list-only). + +## Signature + +```dotnet +public class ConferenceLogs +``` + +## Properties + + + +## Methods + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 109. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-logs/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-logs/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..4217834508 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-logs/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/conference-logs/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ConferenceLogs.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.ConferenceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 122. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper/conference-rooms-helper-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper/conference-rooms-helper-http-client-string.mdx new file mode 100644 index 0000000000..e76a6c2d99 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper/conference-rooms-helper-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper/conference-rooms-helper-http-client-string" +title: "ConferenceRoomsHelper(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ConferenceRoomsHelper.ConferenceRoomsHelper(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.ConferenceRoomsHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `ConferenceRoomsHelper(HttpClient, string)` + +## Signature + +```dotnet +public ConferenceRoomsHelper(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 183. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper/index.mdx new file mode 100644 index 0000000000..97679f14ad --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper" +title: "ConferenceRoomsHelper" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ConferenceRoomsHelper" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `ConferenceRoomsHelper` + +ConferenceRooms helper providing the singular-path variant +(`/api/fabric/resources/conference_room/{id}/addresses`). + +## Signature + +```dotnet +public class ConferenceRoomsHelper +``` + +## Properties + + + +## Methods + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 177. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper/list-addresses-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper/list-addresses-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..c2c5005bec --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper/list-addresses-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/conference-rooms-helper/list-addresses-async-string-dictionary-string-string" +title: "ListAddressesAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ConferenceRoomsHelper.ListAddressesAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.ConferenceRoomsHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `ListAddressesAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListAddressesAsync(string resourceId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 192. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/cxml-applications-helper/create-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/cxml-applications-helper/create-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..14ebc8dd8f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/cxml-applications-helper/create-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/cxml-applications-helper/create-async-dictionary-string-object" +title: "CreateAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CxmlApplicationsHelper.CreateAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.CxmlApplicationsHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `CreateAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> CreateAsync(Dictionary? kwargs = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 203. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/cxml-applications-helper/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/cxml-applications-helper/index.mdx new file mode 100644 index 0000000000..22fac97b63 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/cxml-applications-helper/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/cxml-applications-helper" +title: "CxmlApplicationsHelper" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.CxmlApplicationsHelper" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `CxmlApplicationsHelper` + +cXML applications helper. The API has no CREATE endpoint for cXML +applications (POST is rejected); calling Create here throws +NotImplementedException to mirror Python's deliberate behaviour. + +## Signature + +```dotnet +public class CxmlApplicationsHelper +``` + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 201. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/datasphere-documents-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/datasphere-documents-http-client.mdx new file mode 100644 index 0000000000..91f232d56b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/datasphere-documents-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/datasphere-documents-http-client" +title: "DatasphereDocuments(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.DatasphereDocuments.DatasphereDocuments(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.DatasphereDocuments" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `DatasphereDocuments(HttpClient)` + +## Signature + +```dotnet +public DatasphereDocuments(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 164. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/delete-chunk-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/delete-chunk-async-string-string.mdx new file mode 100644 index 0000000000..f75ab7f3eb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/delete-chunk-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/delete-chunk-async-string-string" +title: "DeleteChunkAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.DatasphereDocuments.DeleteChunkAsync(string, string)" + parent: "SignalWire.REST.Namespaces.DatasphereDocuments" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `DeleteChunkAsync(string, string)` + +## Signature + +```dotnet +public Task> DeleteChunkAsync(string documentId, string chunkId) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 176. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/get-chunk-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/get-chunk-async-string-string.mdx new file mode 100644 index 0000000000..5ae479d465 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/get-chunk-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/get-chunk-async-string-string" +title: "GetChunkAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.DatasphereDocuments.GetChunkAsync(string, string)" + parent: "SignalWire.REST.Namespaces.DatasphereDocuments" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `GetChunkAsync(string, string)` + +## Signature + +```dotnet +public Task> GetChunkAsync(string documentId, string chunkId) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 173. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/index.mdx new file mode 100644 index 0000000000..4192953584 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/datasphere-documents" +title: "DatasphereDocuments" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.DatasphereDocuments" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `DatasphereDocuments` + +Datasphere documents (CRUD + search + chunk methods). + +## Signature + +```dotnet +public class DatasphereDocuments : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 162. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/list-chunks-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/list-chunks-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..41ad81b795 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/list-chunks-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/list-chunks-async-string-dictionary-string-string" +title: "ListChunksAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.DatasphereDocuments.ListChunksAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.DatasphereDocuments" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `ListChunksAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListChunksAsync(string documentId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 170. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/search-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/search-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..9d92a0ead3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/search-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/datasphere-documents/search-async-dictionary-string-object" +title: "SearchAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.DatasphereDocuments.SearchAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.DatasphereDocuments" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `SearchAsync(Dictionary)` + +## Signature + +```dotnet +public Task> SearchAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 167. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-ns/datasphere-ns-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-ns/datasphere-ns-http-client.mdx new file mode 100644 index 0000000000..34cd79f82e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-ns/datasphere-ns-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/datasphere-ns/datasphere-ns-http-client" +title: "DatasphereNs(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.DatasphereNs.DatasphereNs(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.DatasphereNs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `DatasphereNs(HttpClient)` + +## Signature + +```dotnet +public DatasphereNs(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 156. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-ns/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-ns/index.mdx new file mode 100644 index 0000000000..98af516a62 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/datasphere-ns/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/datasphere-ns" +title: "DatasphereNs" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.DatasphereNs" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `DatasphereNs` + +Datasphere namespace — documents with chunks/search. + +Mirrors Python `signalwire.rest.namespaces.datasphere.DatasphereNamespace`. +Extends CrudResource — the legacy `client.Datasphere.List` etc went +to /api/datasphere/documents directly; we preserve that surface and +add `Documents` accessor for chunk/search per Python parity. + +## Signature + +```dotnet +public class DatasphereNs : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Properties + + + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 152. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/fabric-addresses-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/fabric-addresses-http-client-string.mdx new file mode 100644 index 0000000000..772747672b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/fabric-addresses-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/fabric-addresses-http-client-string" +title: "FabricAddresses(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricAddresses.FabricAddresses(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.FabricAddresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `FabricAddresses(HttpClient, string)` + +## Signature + +```dotnet +public FabricAddresses(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 20. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/get-async-string.mdx new file mode 100644 index 0000000000..4d6ea92f96 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricAddresses.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.FabricAddresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string addressId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 33. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/index.mdx new file mode 100644 index 0000000000..f5d7050864 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-addresses" +title: "FabricAddresses" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricAddresses" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `FabricAddresses` + +Read-only top-level Fabric addresses resource (lives at +/api/fabric/addresses, NOT under /api/fabric/resources). + +Mirrors Python `signalwire.rest.namespaces.fabric.FabricAddresses`. + +## Signature + +```dotnet +public class FabricAddresses +``` + +## Properties + + + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 15. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..34bcbe4c34 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-addresses/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricAddresses.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.FabricAddresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 30. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/assign-domain-application-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/assign-domain-application-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..55205519cb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/assign-domain-application-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-resources/assign-domain-application-async-string-dictionary-string-object" +title: "AssignDomainApplicationAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricResources.AssignDomainApplicationAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.FabricResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `AssignDomainApplicationAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> AssignDomainApplicationAsync(string resourceId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 72. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/delete-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/delete-async-string.mdx new file mode 100644 index 0000000000..996907a3b7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/delete-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-resources/delete-async-string" +title: "DeleteAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricResources.DeleteAsync(string)" + parent: "SignalWire.REST.Namespaces.FabricResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `DeleteAsync(string)` + +## Signature + +```dotnet +public Task> DeleteAsync(string resourceId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 66. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/fabric-resources-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/fabric-resources-http-client-string.mdx new file mode 100644 index 0000000000..2c5629f3f1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/fabric-resources-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-resources/fabric-resources-http-client-string" +title: "FabricResources(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricResources.FabricResources(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.FabricResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `FabricResources(HttpClient, string)` + +## Signature + +```dotnet +public FabricResources(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 49. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/get-async-string.mdx new file mode 100644 index 0000000000..10640f4ac9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-resources/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricResources.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.FabricResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string resourceId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 63. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/index.mdx new file mode 100644 index 0000000000..0997383154 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-resources" +title: "FabricResources" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricResources" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `FabricResources` + +Generic resource operations across all Fabric resource types. + +Lives at /api/fabric/resources (the base) and dispatches to per-type +sub-paths. Mirrors Python's +`signalwire.rest.namespaces.fabric.GenericResources`. + +## Signature + +```dotnet +public class FabricResources +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 44. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/list-addresses-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/list-addresses-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..1d50ebace8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/list-addresses-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-resources/list-addresses-async-string-dictionary-string-string" +title: "ListAddressesAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricResources.ListAddressesAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.FabricResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `ListAddressesAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListAddressesAsync(string resourceId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 69. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..ba151a3ae9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-resources/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-resources/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricResources.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.FabricResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 60. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-embed-token-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-embed-token-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..cf772b3463 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-embed-token-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-embed-token-async-dictionary-string-object" +title: "CreateEmbedTokenAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricTokens.CreateEmbedTokenAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `CreateEmbedTokenAsync(Dictionary)` + +## Signature + +```dotnet +public Task> CreateEmbedTokenAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 102. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-guest-token-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-guest-token-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..de0e95862a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-guest-token-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-guest-token-async-dictionary-string-object" +title: "CreateGuestTokenAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricTokens.CreateGuestTokenAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `CreateGuestTokenAsync(Dictionary)` + +## Signature + +```dotnet +public Task> CreateGuestTokenAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 99. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-invite-token-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-invite-token-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..7c52a4747c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-invite-token-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-invite-token-async-dictionary-string-object" +title: "CreateInviteTokenAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricTokens.CreateInviteTokenAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `CreateInviteTokenAsync(Dictionary)` + +## Signature + +```dotnet +public Task> CreateInviteTokenAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 96. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-subscriber-token-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-subscriber-token-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..3cfa0a69a6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-subscriber-token-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/create-subscriber-token-async-dictionary-string-object" +title: "CreateSubscriberTokenAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricTokens.CreateSubscriberTokenAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `CreateSubscriberTokenAsync(Dictionary)` + +## Signature + +```dotnet +public Task> CreateSubscriberTokenAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 90. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/fabric-tokens-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/fabric-tokens-http-client.mdx new file mode 100644 index 0000000000..b3eb7a56a4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/fabric-tokens-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/fabric-tokens-http-client" +title: "FabricTokens(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricTokens.FabricTokens(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `FabricTokens(HttpClient)` + +## Signature + +```dotnet +public FabricTokens(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 88. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/index.mdx new file mode 100644 index 0000000000..224d534fb3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-tokens" +title: "FabricTokens" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricTokens" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `FabricTokens` + +Fabric tokens — subscriber/guest/invite/embed token creation. + +All endpoints sit under /api/fabric (NOT /api/fabric/resources or +/api/fabric/tokens). Mirrors Python's +`signalwire.rest.namespaces.fabric.FabricTokens`. + +## Signature + +```dotnet +public class FabricTokens +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 83. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/refresh-subscriber-token-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/refresh-subscriber-token-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..3c8ed47ffe --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/refresh-subscriber-token-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric-tokens/refresh-subscriber-token-async-dictionary-string-object" +title: "RefreshSubscriberTokenAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FabricTokens.RefreshSubscriberTokenAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `RefreshSubscriberTokenAsync(Dictionary)` + +## Signature + +```dotnet +public Task> RefreshSubscriberTokenAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 93. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric/fabric-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric/fabric-http-client.mdx new file mode 100644 index 0000000000..cf73173e2e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric/fabric-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric/fabric-http-client" +title: "Fabric(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Fabric.Fabric(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Fabric.cs" + visibility: "public" +--- +# `Fabric(HttpClient)` + +## Signature + +```dotnet +public Fabric(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/Fabric.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Fabric.cs) + +Line 50. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric/index.mdx new file mode 100644 index 0000000000..ff029d7100 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fabric/index.mdx @@ -0,0 +1,119 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fabric" +title: "Fabric" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Fabric" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Fabric.cs" + visibility: "public" +--- +# `Fabric` + +Fabric API namespace. + +Groups all Fabric sub-resources (subscribers, SIP endpoints, call flows, +SWML scripts, conference rooms, AI agents, etc.) under a single object. +Each sub-resource is lazily initialised as a <xref href="SignalWire.REST.CrudResource" data-throw-if-not-resolved="false"></xref> +pointing at the correct API path under /api/fabric/resources. + +## Signature + +```dotnet +public class Fabric +``` + +## Properties + + + + + Top-level Fabric addresses (read-only — list/get) that lives at /api/fabric/addresses (NOT under /api/fabric/resources). + + + + + + + + CallFlows singular-path operations (list\_addresses, list\_versions, deploy\_version). + + + + + + + + + + ConferenceRooms singular-path operations (list\_addresses). + + + + + + + + cXML applications helper that exposes the deliberate NotImplementedException on Create (matching Python's `CxmlApplicationsResource.create`). + + + + + + + + + + + + + + + + + + + + Generic resources operations (list/get/delete/list\_addresses/ assign\_domain\_application) at /api/fabric/resources. + + + + + + + + + + + + Subscriber-scoped SIP-endpoint operations (get/update/delete) under /api/fabric/resources/subscribers. + + + + + + + + Fabric tokens resource — note this lives at the top-level `/api/fabric/tokens` path, NOT under `/api/fabric/resources`. + + + + Subscriber/guest/invite/embed token endpoints under /api/fabric. Distinct from the per-account `Tokens` accessor which hits /api/fabric/tokens. + + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Fabric.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Fabric.cs) + +Line 10. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/fax-logs-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/fax-logs-http-client-string.mdx new file mode 100644 index 0000000000..3de448e084 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/fax-logs-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fax-logs/fax-logs-http-client-string" +title: "FaxLogs(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FaxLogs.FaxLogs(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.FaxLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `FaxLogs(HttpClient, string)` + +## Signature + +```dotnet +public FaxLogs(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 91. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/get-async-string.mdx new file mode 100644 index 0000000000..d8efa5ad3f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fax-logs/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FaxLogs.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.FaxLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string logId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 104. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/index.mdx new file mode 100644 index 0000000000..4355eca716 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fax-logs" +title: "FaxLogs" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FaxLogs" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `FaxLogs` + +Fax log queries. + +## Signature + +```dotnet +public class FaxLogs +``` + +## Properties + + + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 86. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..79cb49934f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/fax-logs/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/fax-logs/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.FaxLogs.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.FaxLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 101. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/imported-numbers/imported-numbers-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/imported-numbers/imported-numbers-http-client.mdx new file mode 100644 index 0000000000..abf2a8e8d2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/imported-numbers/imported-numbers-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/imported-numbers/imported-numbers-http-client" +title: "ImportedNumbers(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ImportedNumbers.ImportedNumbers(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.ImportedNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `ImportedNumbers(HttpClient)` + +## Signature + +```dotnet +public ImportedNumbers(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 108. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/imported-numbers/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/imported-numbers/index.mdx new file mode 100644 index 0000000000..e243e4d964 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/imported-numbers/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/imported-numbers" +title: "ImportedNumbers" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ImportedNumbers" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `ImportedNumbers` + +Imported phone numbers (create only). + +Mirrors Python `signalwire.rest.namespaces.imported_numbers.ImportedNumbersResource`. +Extends CrudResource so the legacy `client.ImportedNumbers.BasePath` +surface keeps working; `CreateAsync` is the only method Python +exposes. + +## Signature + +```dotnet +public class ImportedNumbers : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 106. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/index.mdx new file mode 100644 index 0000000000..feffefa128 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/index.mdx @@ -0,0 +1,224 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces" +title: "SignalWire.REST.Namespaces" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces" +--- +# `SignalWire.REST.Namespaces` + +## Classes + + + + Addresses namespace (Relay top-level addresses, no update). Mirrors Python `signalwire.rest.namespaces.addresses.AddressesResource`. Inherits CrudResource for the standard list/create/get/delete surface. + + + + CallFlows helper providing the singular-path variants (`/api/fabric/resources/call_flow/{id}/{addresses,versions}`). + + + + Calling API namespace. Provides 37 call-control command methods that each POST to /api/calling/calls with a JSON body containing the command name, an optional call ID, and parameters. + + + + Twilio-compatible (LaML) API namespace with AccountSid scoping. Mirrors Python `signalwire.rest.namespaces.compat.CompatNamespace`: the entry-point exposes 12 sub-resources (accounts, calls, messages, faxes, conferences, phone\_numbers, applications, laml\_bins, queues, recordings, transcriptions, tokens) under a shared per-account prefix. <p>Inherits from <xref href="SignalWire.REST.CrudResource" data-throw-if-not-resolved="false"></xref> so the historical `client.Compat.List()` / `Create` / `Get` / `Update` / `Delete` surface continues to work; the per-account collection accessors are added on top.</p> + + + + Compat account/subproject management. Lives at the top-level /api/laml/2010-04-01/Accounts collection (no AccountSid prefix). + + + + Compat applications (Twilio LaML voice/SMS apps). + + + + Compat calls with recording + stream sub-resources. Inherits standard CRUD; adds Twilio-style compat extensions. + + + + Compat conferences with participant, recording, and stream sub-resources. + + + + Compat faxes with media sub-resources. + + + + Compat cXML / LaML script bins. + + + + Compat messages with media sub-resources. + + + + Compat phone-number management with purchase, import, and search. + + + + Compat queues with member management. + + + + Compat recordings (read-only top-level resource). + + + + Compat API tokens — UPDATE uses PATCH (BaseResource style). + + + + Compat transcriptions (read-only top-level resource). + + + + Conference log queries (list-only). + + + + ConferenceRooms helper providing the singular-path variant (`/api/fabric/resources/conference_room/{id}/addresses`). + + + + cXML applications helper. The API has no CREATE endpoint for cXML applications (POST is rejected); calling Create here throws NotImplementedException to mirror Python's deliberate behaviour. + + + + Datasphere documents (CRUD + search + chunk methods). + + + + Datasphere namespace — documents with chunks/search. Mirrors Python `signalwire.rest.namespaces.datasphere.DatasphereNamespace`. Extends CrudResource — the legacy `client.Datasphere.List` etc went to /api/datasphere/documents directly; we preserve that surface and add `Documents` accessor for chunk/search per Python parity. + + + + Fabric API namespace. Groups all Fabric sub-resources (subscribers, SIP endpoints, call flows, SWML scripts, conference rooms, AI agents, etc.) under a single object. Each sub-resource is lazily initialised as a <xref href="SignalWire.REST.CrudResource" data-throw-if-not-resolved="false"></xref> pointing at the correct API path under /api/fabric/resources. + + + + Read-only top-level Fabric addresses resource (lives at /api/fabric/addresses, NOT under /api/fabric/resources). Mirrors Python `signalwire.rest.namespaces.fabric.FabricAddresses`. + + + + Generic resource operations across all Fabric resource types. Lives at /api/fabric/resources (the base) and dispatches to per-type sub-paths. Mirrors Python's `signalwire.rest.namespaces.fabric.GenericResources`. + + + + Fabric tokens — subscriber/guest/invite/embed token creation. All endpoints sit under /api/fabric (NOT /api/fabric/resources or /api/fabric/tokens). Mirrors Python's `signalwire.rest.namespaces.fabric.FabricTokens`. + + + + Fax log queries. + + + + Imported phone numbers (create only). Mirrors Python `signalwire.rest.namespaces.imported_numbers.ImportedNumbersResource`. Extends CrudResource so the legacy `client.ImportedNumbers.BasePath` surface keeps working; `CreateAsync` is the only method Python exposes. + + + + Logs API namespace — message, voice, fax, and conference logs (read-only). Mirrors Python `signalwire.rest.namespaces.logs.LogsNamespace`. Each kind of log lives at a different sub-API path. <p>Inherits from <xref href="SignalWire.REST.CrudResource" data-throw-if-not-resolved="false"></xref> so the legacy `client.Logs.BasePath` accessor still resolves; the new Messages/Voice/Fax/Conferences accessors point at the actual per-API log endpoints.</p> + + + + Message log queries. + + + + Multi-Factor Authentication namespace (sms / call / verify dispatch). Mirrors Python `signalwire.rest.namespaces.mfa.MfaResource`. Extends CrudResource so the legacy `client.Mfa.BasePath` / `client.Mfa.Create` surface keeps working. + + + + Number Groups (CRUD + membership operations; update via PUT). Mirrors Python `signalwire.rest.namespaces.number_groups.NumberGroupsResource`. Note delete\_membership / get\_membership target the top-level `/api/relay/rest/number_group_memberships/{id}` path, NOT the nested per-group sub-collection. + + + + Project namespace — exposes ProjectTokens (PATCH update). Mirrors Python `signalwire.rest.namespaces.project.ProjectNamespace`. Extends CrudResource for the legacy `client.Project.BasePath` test. + + + + Project API tokens — PATCH for update. + + + + Queues namespace (Relay queues with member operations). Mirrors Python `signalwire.rest.namespaces.queues.QueuesResource`. Note: per-port adapter mismatches with the legacy CrudResource at /api/fabric/resources/queues — this lives at /api/relay/rest/queues. + + + + Recordings namespace (Relay top-level recordings, list/get/delete). Mirrors Python `signalwire.rest.namespaces.recordings.RecordingsResource`. Inherits CrudResource for the standard list/get/delete surface. + + + + 10DLC Campaign Registry namespace — brands, campaigns, orders, numbers. Mirrors Python `signalwire.rest.namespaces.registry.RegistryNamespace` (everything under /api/relay/rest/registry/beta). <p>Inherits from <xref href="SignalWire.REST.CrudResource" data-throw-if-not-resolved="false"></xref> so the legacy `client.Registry.BasePath` accessor still resolves; the new Brands/Campaigns/Orders/Numbers accessors target the per-resource endpoints under /api/relay/rest/registry/beta.</p> + + + + 10DLC brand management. + + + + 10DLC campaign management — update via PUT. + + + + 10DLC number assignment management. + + + + 10DLC assignment order management (read-only). + + + + Short codes (list/get/update — no create/delete; update via PUT). Mirrors Python `signalwire.rest.namespaces.short_codes.ShortCodesResource`. Extends CrudResource — overrides UpdateAsync to use PUT (matching Python's \_update\_method = "PUT" on this resource). + + + + Project SIP profile (singleton resource — get/update only, update via PUT). Mirrors Python `signalwire.rest.namespaces.sip_profile.SipProfileResource`. Extends CrudResource for the legacy `client.SipProfile.BasePath` test — the Python-parity singleton path is /api/relay/rest/sip\_profile; the legacy .NET path was /api/relay/rest/sip\_profiles. The legacy accessor target is preserved while `GetAsync()/UpdateAsync(kwargs)` hit the singleton path. + + + + Subscribers helper exposing per-subscriber SIP-endpoint operations. Mirrors Python's `SubscribersResource` SIP endpoint methods. + + + + Video API namespace. Mirrors Python `signalwire.rest.namespaces.video.VideoNamespace` — rooms, room sessions, room recordings, conferences, conference tokens, streams. <p>The legacy `client.Video.List() / Create / Get / Delete` surface (which targeted `/api/video/rooms`) is preserved by inheriting from <xref href="SignalWire.REST.CrudResource" data-throw-if-not-resolved="false"></xref>.</p> + + + + Video conferences (CRUD with PUT update + tokens/streams subresources). + + + + Video conference tokens: get + reset. + + + + Video room recordings: list, get, delete, list\_events. + + + + Video rooms (CRUD + streams sub-resource). + + + + Video room sessions: list, get, list\_events/\_members/\_recordings. + + + + Video room tokens (create-only). + + + + Video streams: get, update (PUT), delete. + + + + Voice log queries with events sub-collection. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/logs/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/logs/index.mdx new file mode 100644 index 0000000000..b29c59e2e0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/logs/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/logs" +title: "Logs" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Logs" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `Logs` + +Logs API namespace — message, voice, fax, and conference logs (read-only). + +Mirrors Python `signalwire.rest.namespaces.logs.LogsNamespace`. +Each kind of log lives at a different sub-API path. + +<p>Inherits from <xref href="SignalWire.REST.CrudResource" data-throw-if-not-resolved="false"></xref> so the legacy +``client.Logs.BasePath`` accessor still resolves; the new +Messages/Voice/Fax/Conferences accessors point at the actual per-API +log endpoints.</p> + +## Signature + +```dotnet +public class Logs : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Properties + + + + + + + + + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 20. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/logs/logs-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/logs/logs-http-client.mdx new file mode 100644 index 0000000000..66d52696e3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/logs/logs-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/logs/logs-http-client" +title: "Logs(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Logs.Logs(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.Logs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `Logs(HttpClient)` + +## Signature + +```dotnet +public Logs(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 27. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/get-async-string.mdx new file mode 100644 index 0000000000..d94d3c3d3a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/message-logs/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.MessageLogs.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.MessageLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string logId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 54. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/index.mdx new file mode 100644 index 0000000000..c044a73ae9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/message-logs" +title: "MessageLogs" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.MessageLogs" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `MessageLogs` + +Message log queries. + +## Signature + +```dotnet +public class MessageLogs +``` + +## Properties + + + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 36. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..cf3324596d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/message-logs/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.MessageLogs.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.MessageLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 51. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/message-logs-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/message-logs-http-client-string.mdx new file mode 100644 index 0000000000..40826c89c2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/message-logs/message-logs-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/message-logs/message-logs-http-client-string" +title: "MessageLogs(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.MessageLogs.MessageLogs(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.MessageLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `MessageLogs(HttpClient, string)` + +## Signature + +```dotnet +public MessageLogs(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 41. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/call-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/call-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..2a2493e61f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/call-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/mfa/call-async-dictionary-string-object" +title: "CallAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Mfa.CallAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.Mfa" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `CallAsync(Dictionary)` + +## Signature + +```dotnet +public Task> CallAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 23. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/index.mdx new file mode 100644 index 0000000000..7a812c785b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/mfa" +title: "Mfa" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Mfa" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `Mfa` + +Multi-Factor Authentication namespace (sms / call / verify dispatch). + +Mirrors Python `signalwire.rest.namespaces.mfa.MfaResource`. +Extends CrudResource so the legacy `client.Mfa.BasePath` / +`client.Mfa.Create` surface keeps working. + +## Signature + +```dotnet +public class Mfa : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 16. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/mfa-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/mfa-http-client.mdx new file mode 100644 index 0000000000..9c77f17c1e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/mfa-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/mfa/mfa-http-client" +title: "Mfa(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Mfa.Mfa(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.Mfa" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `Mfa(HttpClient)` + +## Signature + +```dotnet +public Mfa(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 18. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/sms-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/sms-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..308477533c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/sms-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/mfa/sms-async-dictionary-string-object" +title: "SmsAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Mfa.SmsAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.Mfa" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `SmsAsync(Dictionary)` + +## Signature + +```dotnet +public Task> SmsAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 20. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/verify-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/verify-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..5d62ccf4ad --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/mfa/verify-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/mfa/verify-async-string-dictionary-string-object" +title: "VerifyAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Mfa.VerifyAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.Mfa" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `VerifyAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> VerifyAsync(string requestId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 26. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/add-membership-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/add-membership-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..852e0fb0b9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/add-membership-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/number-groups/add-membership-async-string-dictionary-string-object" +title: "AddMembershipAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.NumberGroups.AddMembershipAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.NumberGroups" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `AddMembershipAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> AddMembershipAsync(string groupId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 88. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/delete-membership-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/delete-membership-async-string.mdx new file mode 100644 index 0000000000..809f281c24 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/delete-membership-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/number-groups/delete-membership-async-string" +title: "DeleteMembershipAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.NumberGroups.DeleteMembershipAsync(string)" + parent: "SignalWire.REST.Namespaces.NumberGroups" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `DeleteMembershipAsync(string)` + +## Signature + +```dotnet +public Task> DeleteMembershipAsync(string membershipId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 94. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/get-membership-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/get-membership-async-string.mdx new file mode 100644 index 0000000000..17bac4f08c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/get-membership-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/number-groups/get-membership-async-string" +title: "GetMembershipAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.NumberGroups.GetMembershipAsync(string)" + parent: "SignalWire.REST.Namespaces.NumberGroups" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `GetMembershipAsync(string)` + +## Signature + +```dotnet +public Task> GetMembershipAsync(string membershipId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 91. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/index.mdx new file mode 100644 index 0000000000..0ee31076f3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/number-groups" +title: "NumberGroups" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.NumberGroups" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `NumberGroups` + +Number Groups (CRUD + membership operations; update via PUT). + +Mirrors Python `signalwire.rest.namespaces.number_groups.NumberGroupsResource`. +Note delete\_membership / get\_membership target the top-level +`/api/relay/rest/number_group_memberships/{id}` path, NOT the +nested per-group sub-collection. + +## Signature + +```dotnet +public class NumberGroups : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + + + + + + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 77. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/list-memberships-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/list-memberships-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..4fb9e72528 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/list-memberships-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/number-groups/list-memberships-async-string-dictionary-string-string" +title: "ListMembershipsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.NumberGroups.ListMembershipsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.NumberGroups" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `ListMembershipsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListMembershipsAsync(string groupId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 85. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/number-groups-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/number-groups-http-client.mdx new file mode 100644 index 0000000000..62d1da8a69 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/number-groups-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/number-groups/number-groups-http-client" +title: "NumberGroups(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.NumberGroups.NumberGroups(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.NumberGroups" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `NumberGroups(HttpClient)` + +## Signature + +```dotnet +public NumberGroups(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 79. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..372b42af63 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/number-groups/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/number-groups/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.NumberGroups.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.NumberGroups" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +Update a resource by ID (PUT basePath/\{id\}). + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Task> UpdateAsync(string id, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 82. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/create-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/create-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..811e8853e8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/create-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/project-tokens/create-async-dictionary-string-object" +title: "CreateAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ProjectTokens.CreateAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.ProjectTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `CreateAsync(Dictionary)` + +## Signature + +```dotnet +public Task> CreateAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 134. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/delete-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/delete-async-string.mdx new file mode 100644 index 0000000000..c3639aa578 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/delete-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/project-tokens/delete-async-string" +title: "DeleteAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ProjectTokens.DeleteAsync(string)" + parent: "SignalWire.REST.Namespaces.ProjectTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `DeleteAsync(string)` + +## Signature + +```dotnet +public Task> DeleteAsync(string tokenId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 140. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/index.mdx new file mode 100644 index 0000000000..9aaae2b95b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/project-tokens" +title: "ProjectTokens" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ProjectTokens" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `ProjectTokens` + +Project API tokens — PATCH for update. + +## Signature + +```dotnet +public class ProjectTokens +``` + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 128. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/project-tokens-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/project-tokens-http-client.mdx new file mode 100644 index 0000000000..1b1e88a67f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/project-tokens-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/project-tokens/project-tokens-http-client" +title: "ProjectTokens(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ProjectTokens.ProjectTokens(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.ProjectTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `ProjectTokens(HttpClient)` + +## Signature + +```dotnet +public ProjectTokens(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 132. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..34591015d6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project-tokens/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/project-tokens/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ProjectTokens.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.ProjectTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> UpdateAsync(string tokenId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 137. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project/index.mdx new file mode 100644 index 0000000000..d49ae7dfb5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/project" +title: "Project" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Project" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `Project` + +Project namespace — exposes ProjectTokens (PATCH update). + +Mirrors Python `signalwire.rest.namespaces.project.ProjectNamespace`. +Extends CrudResource for the legacy `client.Project.BasePath` test. + +## Signature + +```dotnet +public class Project : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Properties + + + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 118. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project/project-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project/project-http-client.mdx new file mode 100644 index 0000000000..2c5ca9d549 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/project/project-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/project/project-http-client" +title: "Project(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Project.Project(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.Project" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `Project(HttpClient)` + +## Signature + +```dotnet +public Project(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 122. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/get-member-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/get-member-async-string-string.mdx new file mode 100644 index 0000000000..341c4f6654 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/get-member-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/queues/get-member-async-string-string" +title: "GetMemberAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Queues.GetMemberAsync(string, string)" + parent: "SignalWire.REST.Namespaces.Queues" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `GetMemberAsync(string, string)` + +## Signature + +```dotnet +public Task> GetMemberAsync(string queueId, string memberId) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 225. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/get-next-member-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/get-next-member-async-string.mdx new file mode 100644 index 0000000000..9d2409b4d4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/get-next-member-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/queues/get-next-member-async-string" +title: "GetNextMemberAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Queues.GetNextMemberAsync(string)" + parent: "SignalWire.REST.Namespaces.Queues" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `GetNextMemberAsync(string)` + +## Signature + +```dotnet +public Task> GetNextMemberAsync(string queueId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 222. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/index.mdx new file mode 100644 index 0000000000..da490faa5a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/queues" +title: "Queues" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Queues" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `Queues` + +Queues namespace (Relay queues with member operations). + +Mirrors Python `signalwire.rest.namespaces.queues.QueuesResource`. +Note: per-port adapter mismatches with the legacy CrudResource at +/api/fabric/resources/queues — this lives at /api/relay/rest/queues. + +## Signature + +```dotnet +public class Queues : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + + + + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 211. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/list-members-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/list-members-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..0fc563c39d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/list-members-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/queues/list-members-async-string-dictionary-string-string" +title: "ListMembersAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Queues.ListMembersAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.Queues" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `ListMembersAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListMembersAsync(string queueId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 219. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/queues-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/queues-http-client.mdx new file mode 100644 index 0000000000..b7eab635b8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/queues-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/queues/queues-http-client" +title: "Queues(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Queues.Queues(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.Queues" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `Queues(HttpClient)` + +## Signature + +```dotnet +public Queues(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 213. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..7e7938cc50 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/queues/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/queues/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Queues.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.Queues" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +Update a resource by ID (PUT basePath/\{id\}). + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Task> UpdateAsync(string id, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 216. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/recordings/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/recordings/index.mdx new file mode 100644 index 0000000000..63ad544089 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/recordings/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/recordings" +title: "Recordings" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Recordings" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `Recordings` + +Recordings namespace (Relay top-level recordings, list/get/delete). + +Mirrors Python `signalwire.rest.namespaces.recordings.RecordingsResource`. +Inherits CrudResource for the standard list/get/delete surface. + +## Signature + +```dotnet +public class Recordings : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 198. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/recordings/recordings-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/recordings/recordings-http-client.mdx new file mode 100644 index 0000000000..c0653fc52b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/recordings/recordings-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/recordings/recordings-http-client" +title: "Recordings(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Recordings.Recordings(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.Recordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `Recordings(HttpClient)` + +## Signature + +```dotnet +public Recordings(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 200. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/create-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/create-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..2b964575ac --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/create-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-brands/create-async-dictionary-string-object" +title: "CreateAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryBrands.CreateAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `CreateAsync(Dictionary)` + +## Signature + +```dotnet +public Task> CreateAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 57. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/create-campaign-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/create-campaign-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..7629c2c537 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/create-campaign-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-brands/create-campaign-async-string-dictionary-string-object" +title: "CreateCampaignAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryBrands.CreateCampaignAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `CreateCampaignAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> CreateCampaignAsync(string brandId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 66. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/get-async-string.mdx new file mode 100644 index 0000000000..93ec071171 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-brands/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryBrands.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string brandId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 60. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/index.mdx new file mode 100644 index 0000000000..fb829ef5d8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-brands" +title: "RegistryBrands" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryBrands" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `RegistryBrands` + +10DLC brand management. + +## Signature + +```dotnet +public class RegistryBrands +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 38. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..42200e2a21 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-brands/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryBrands.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 54. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/list-campaigns-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/list-campaigns-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..00ed344d14 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/list-campaigns-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-brands/list-campaigns-async-string-dictionary-string-string" +title: "ListCampaignsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryBrands.ListCampaignsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `ListCampaignsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListCampaignsAsync(string brandId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 63. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/registry-brands-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/registry-brands-http-client-string.mdx new file mode 100644 index 0000000000..40a077107e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-brands/registry-brands-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-brands/registry-brands-http-client-string" +title: "RegistryBrands(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryBrands.RegistryBrands(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `RegistryBrands(HttpClient, string)` + +## Signature + +```dotnet +public RegistryBrands(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 43. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/create-order-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/create-order-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..3795854f0d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/create-order-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/create-order-async-string-dictionary-string-object" +title: "CreateOrderAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryCampaigns.CreateOrderAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `CreateOrderAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> CreateOrderAsync(string campaignId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 99. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/get-async-string.mdx new file mode 100644 index 0000000000..963c24e9fe --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryCampaigns.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string campaignId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 87. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/index.mdx new file mode 100644 index 0000000000..4cecf5c7fa --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-campaigns" +title: "RegistryCampaigns" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryCampaigns" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `RegistryCampaigns` + +10DLC campaign management — update via PUT. + +## Signature + +```dotnet +public class RegistryCampaigns +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 71. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/list-numbers-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/list-numbers-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..21f7584128 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/list-numbers-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/list-numbers-async-string-dictionary-string-string" +title: "ListNumbersAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryCampaigns.ListNumbersAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `ListNumbersAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListNumbersAsync(string campaignId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 93. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/list-orders-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/list-orders-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..39e54c0fa3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/list-orders-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/list-orders-async-string-dictionary-string-string" +title: "ListOrdersAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryCampaigns.ListOrdersAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `ListOrdersAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListOrdersAsync(string campaignId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 96. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/registry-campaigns-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/registry-campaigns-http-client-string.mdx new file mode 100644 index 0000000000..e367dd92e8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/registry-campaigns-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/registry-campaigns-http-client-string" +title: "RegistryCampaigns(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryCampaigns.RegistryCampaigns(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `RegistryCampaigns(HttpClient, string)` + +## Signature + +```dotnet +public RegistryCampaigns(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 76. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..b679813496 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-campaigns/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryCampaigns.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> UpdateAsync(string campaignId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 90. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-numbers/delete-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-numbers/delete-async-string.mdx new file mode 100644 index 0000000000..be844e634e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-numbers/delete-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-numbers/delete-async-string" +title: "DeleteAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryNumbers.DeleteAsync(string)" + parent: "SignalWire.REST.Namespaces.RegistryNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `DeleteAsync(string)` + +## Signature + +```dotnet +public Task> DeleteAsync(string numberId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 139. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-numbers/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-numbers/index.mdx new file mode 100644 index 0000000000..6844bdd847 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-numbers/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-numbers" +title: "RegistryNumbers" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryNumbers" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `RegistryNumbers` + +10DLC number assignment management. + +## Signature + +```dotnet +public class RegistryNumbers +``` + +## Properties + + + +## Methods + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 124. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-numbers/registry-numbers-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-numbers/registry-numbers-http-client-string.mdx new file mode 100644 index 0000000000..244ce031df --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-numbers/registry-numbers-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-numbers/registry-numbers-http-client-string" +title: "RegistryNumbers(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryNumbers.RegistryNumbers(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.RegistryNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `RegistryNumbers(HttpClient, string)` + +## Signature + +```dotnet +public RegistryNumbers(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 129. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-orders/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-orders/get-async-string.mdx new file mode 100644 index 0000000000..712bbac3ec --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-orders/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-orders/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryOrders.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.RegistryOrders" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string orderId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 119. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-orders/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-orders/index.mdx new file mode 100644 index 0000000000..996069239c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-orders/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-orders" +title: "RegistryOrders" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryOrders" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `RegistryOrders` + +10DLC assignment order management (read-only). + +## Signature + +```dotnet +public class RegistryOrders +``` + +## Properties + + + +## Methods + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 104. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-orders/registry-orders-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-orders/registry-orders-http-client-string.mdx new file mode 100644 index 0000000000..6bc0ac2d76 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry-orders/registry-orders-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry-orders/registry-orders-http-client-string" +title: "RegistryOrders(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.RegistryOrders.RegistryOrders(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.RegistryOrders" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `RegistryOrders(HttpClient, string)` + +## Signature + +```dotnet +public RegistryOrders(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 109. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry/index.mdx new file mode 100644 index 0000000000..305717130a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry" +title: "Registry" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Registry" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `Registry` + +10DLC Campaign Registry namespace — brands, campaigns, orders, numbers. + +Mirrors Python `signalwire.rest.namespaces.registry.RegistryNamespace` +(everything under /api/relay/rest/registry/beta). + +<p>Inherits from <xref href="SignalWire.REST.CrudResource" data-throw-if-not-resolved="false"></xref> so the legacy +``client.Registry.BasePath`` accessor still resolves; the new +Brands/Campaigns/Orders/Numbers accessors target the per-resource +endpoints under /api/relay/rest/registry/beta.</p> + +## Signature + +```dotnet +public class Registry : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Properties + + + + + + + + + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 20. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry/registry-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry/registry-http-client.mdx new file mode 100644 index 0000000000..1df2c22cad --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/registry/registry-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/registry/registry-http-client" +title: "Registry(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Registry.Registry(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.Registry" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs" + visibility: "public" +--- +# `Registry(HttpClient)` + +## Signature + +```dotnet +public Registry(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/Registry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Registry.cs) + +Line 29. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/short-codes/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/short-codes/index.mdx new file mode 100644 index 0000000000..432bcdffbb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/short-codes/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/short-codes" +title: "ShortCodes" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ShortCodes" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `ShortCodes` + +Short codes (list/get/update — no create/delete; update via PUT). + +Mirrors Python `signalwire.rest.namespaces.short_codes.ShortCodesResource`. +Extends CrudResource — overrides UpdateAsync to use PUT (matching +Python's \_update\_method = "PUT" on this resource). + +## Signature + +```dotnet +public class ShortCodes : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 61. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/short-codes/short-codes-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/short-codes/short-codes-http-client.mdx new file mode 100644 index 0000000000..5796785aa0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/short-codes/short-codes-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/short-codes/short-codes-http-client" +title: "ShortCodes(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ShortCodes.ShortCodes(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.ShortCodes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `ShortCodes(HttpClient)` + +## Signature + +```dotnet +public ShortCodes(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 63. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/short-codes/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/short-codes/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..fe878e0d6f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/short-codes/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/short-codes/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.ShortCodes.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.ShortCodes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +Update a resource by ID (PUT basePath/\{id\}). + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Task> UpdateAsync(string id, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 65. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/get-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/get-async.mdx new file mode 100644 index 0000000000..c62cec9f5a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/get-async.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/sip-profile/get-async" +title: "GetAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.SipProfile.GetAsync()" + parent: "SignalWire.REST.Namespaces.SipProfile" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `GetAsync()` + +## Signature + +```dotnet +public Task> GetAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 47. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/index.mdx new file mode 100644 index 0000000000..cdddf44b70 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/sip-profile" +title: "SipProfile" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.SipProfile" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `SipProfile` + +Project SIP profile (singleton resource — get/update only, update via PUT). + +Mirrors Python `signalwire.rest.namespaces.sip_profile.SipProfileResource`. +Extends CrudResource for the legacy `client.SipProfile.BasePath` test +— the Python-parity singleton path is /api/relay/rest/sip\_profile; +the legacy .NET path was /api/relay/rest/sip\_profiles. The legacy +accessor target is preserved while `GetAsync()/UpdateAsync(kwargs)` +hit the singleton path. + +## Signature + +```dotnet +public class SipProfile : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Properties + + + Singleton resource path (Python parity). + + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 40. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/sip-profile-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/sip-profile-http-client.mdx new file mode 100644 index 0000000000..bf6224c52a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/sip-profile-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/sip-profile/sip-profile-http-client" +title: "SipProfile(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.SipProfile.SipProfile(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.SipProfile" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `SipProfile(HttpClient)` + +## Signature + +```dotnet +public SipProfile(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 45. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/update-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/update-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..818e4d6618 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/sip-profile/update-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/sip-profile/update-async-dictionary-string-object" +title: "UpdateAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.SipProfile.UpdateAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.SipProfile" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs" + visibility: "public" +--- +# `UpdateAsync(Dictionary)` + +## Signature + +```dotnet +public Task> UpdateAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/SmallNamespaces.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/SmallNamespaces.cs) + +Line 50. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/create-sip-endpoint-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/create-sip-endpoint-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..8a774cf85b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/create-sip-endpoint-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/create-sip-endpoint-async-string-dictionary-string-object" +title: "CreateSipEndpointAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.SubscribersHelper.CreateSipEndpointAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.SubscribersHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `CreateSipEndpointAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> CreateSipEndpointAsync(string subscriberId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 130. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/delete-sip-endpoint-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/delete-sip-endpoint-async-string-string.mdx new file mode 100644 index 0000000000..c0b47cc5bf --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/delete-sip-endpoint-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/delete-sip-endpoint-async-string-string" +title: "DeleteSipEndpointAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.SubscribersHelper.DeleteSipEndpointAsync(string, string)" + parent: "SignalWire.REST.Namespaces.SubscribersHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `DeleteSipEndpointAsync(string, string)` + +## Signature + +```dotnet +public Task> DeleteSipEndpointAsync(string subscriberId, string endpointId) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 139. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/get-sip-endpoint-async-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/get-sip-endpoint-async-string-string.mdx new file mode 100644 index 0000000000..e9d3748dd1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/get-sip-endpoint-async-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/get-sip-endpoint-async-string-string" +title: "GetSipEndpointAsync(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.SubscribersHelper.GetSipEndpointAsync(string, string)" + parent: "SignalWire.REST.Namespaces.SubscribersHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `GetSipEndpointAsync(string, string)` + +## Signature + +```dotnet +public Task> GetSipEndpointAsync(string subscriberId, string endpointId) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 133. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/index.mdx new file mode 100644 index 0000000000..daf0867f62 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/subscribers-helper" +title: "SubscribersHelper" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.SubscribersHelper" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `SubscribersHelper` + +Subscribers helper exposing per-subscriber SIP-endpoint operations. + +Mirrors Python's `SubscribersResource` SIP endpoint methods. + +## Signature + +```dotnet +public class SubscribersHelper +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 111. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/list-sip-endpoints-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/list-sip-endpoints-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..affdfb3738 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/list-sip-endpoints-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/list-sip-endpoints-async-string-dictionary-string-string" +title: "ListSipEndpointsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.SubscribersHelper.ListSipEndpointsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.SubscribersHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `ListSipEndpointsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListSipEndpointsAsync(string subscriberId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 127. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/subscribers-helper-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/subscribers-helper-http-client-string.mdx new file mode 100644 index 0000000000..ea92f302ea --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/subscribers-helper-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/subscribers-helper-http-client-string" +title: "SubscribersHelper(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.SubscribersHelper.SubscribersHelper(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.SubscribersHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `SubscribersHelper(HttpClient, string)` + +## Signature + +```dotnet +public SubscribersHelper(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 116. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/update-sip-endpoint-async-string-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/update-sip-endpoint-async-string-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..44f91a7f3b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/update-sip-endpoint-async-string-string-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/subscribers-helper/update-sip-endpoint-async-string-string-dictionary-string-object" +title: "UpdateSipEndpointAsync(string, string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.SubscribersHelper.UpdateSipEndpointAsync(string, string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.SubscribersHelper" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs" + visibility: "public" +--- +# `UpdateSipEndpointAsync(string, string, Dictionary)` + +## Signature + +```dotnet +public Task> UpdateSipEndpointAsync(string subscriberId, string endpointId, Dictionary kwargs) +``` + +## Parameters + + + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/FabricExtras.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/FabricExtras.cs) + +Line 136. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/get-async-string.mdx new file mode 100644 index 0000000000..8319252a18 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoConferenceTokens.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.VideoConferenceTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string tokenId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 175. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/index.mdx new file mode 100644 index 0000000000..fc185c944e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens" +title: "VideoConferenceTokens" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoConferenceTokens" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoConferenceTokens` + +Video conference tokens: get + reset. + +## Signature + +```dotnet +public class VideoConferenceTokens +``` + +## Properties + + + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 159. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/reset-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/reset-async-string.mdx new file mode 100644 index 0000000000..5e3a8cc6ce --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/reset-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/reset-async-string" +title: "ResetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoConferenceTokens.ResetAsync(string)" + parent: "SignalWire.REST.Namespaces.VideoConferenceTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `ResetAsync(string)` + +## Signature + +```dotnet +public Task> ResetAsync(string tokenId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 178. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/video-conference-tokens-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/video-conference-tokens-http-client-string.mdx new file mode 100644 index 0000000000..d7d9988f57 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/video-conference-tokens-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-conference-tokens/video-conference-tokens-http-client-string" +title: "VideoConferenceTokens(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoConferenceTokens.VideoConferenceTokens(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.VideoConferenceTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoConferenceTokens(HttpClient, string)` + +## Signature + +```dotnet +public VideoConferenceTokens(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 164. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/create-stream-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/create-stream-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..d7ade5ca6b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/create-stream-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-conferences/create-stream-async-string-dictionary-string-object" +title: "CreateStreamAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoConferences.CreateStreamAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.VideoConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `CreateStreamAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> CreateStreamAsync(string conferenceId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 154. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/index.mdx new file mode 100644 index 0000000000..7fbb332ccb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-conferences" +title: "VideoConferences" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoConferences" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoConferences` + +Video conferences (CRUD with PUT update + tokens/streams subresources). + +## Signature + +```dotnet +public class VideoConferences : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + + + + + Update a resource by ID (PUT basePath/\{id\}). + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 141. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/list-conference-tokens-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/list-conference-tokens-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..aeac4805e1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/list-conference-tokens-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-conferences/list-conference-tokens-async-string-dictionary-string-string" +title: "ListConferenceTokensAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoConferences.ListConferenceTokensAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.VideoConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `ListConferenceTokensAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListConferenceTokensAsync(string conferenceId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 148. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/list-streams-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/list-streams-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..45e55f8c6d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/list-streams-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-conferences/list-streams-async-string-dictionary-string-string" +title: "ListStreamsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoConferences.ListStreamsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.VideoConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `ListStreamsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListStreamsAsync(string conferenceId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 151. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..099e1805fe --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-conferences/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoConferences.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.VideoConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +Update a resource by ID (PUT basePath/\{id\}). + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Task> UpdateAsync(string id, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 145. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/video-conferences-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/video-conferences-http-client-string.mdx new file mode 100644 index 0000000000..74e51dadb1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-conferences/video-conferences-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-conferences/video-conferences-http-client-string" +title: "VideoConferences(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoConferences.VideoConferences(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.VideoConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoConferences(HttpClient, string)` + +## Signature + +```dotnet +public VideoConferences(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 143. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/delete-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/delete-async-string.mdx new file mode 100644 index 0000000000..dfbef4244c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/delete-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/delete-async-string" +title: "DeleteAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomRecordings.DeleteAsync(string)" + parent: "SignalWire.REST.Namespaces.VideoRoomRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `DeleteAsync(string)` + +## Signature + +```dotnet +public Task> DeleteAsync(string recordingId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 133. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/get-async-string.mdx new file mode 100644 index 0000000000..3e17f62c46 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomRecordings.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.VideoRoomRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string recordingId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 130. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/index.mdx new file mode 100644 index 0000000000..b8f45e2400 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-recordings" +title: "VideoRoomRecordings" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomRecordings" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoRoomRecordings` + +Video room recordings: list, get, delete, list\_events. + +## Signature + +```dotnet +public class VideoRoomRecordings +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 111. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..5e8699b99b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomRecordings.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.VideoRoomRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 127. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/list-events-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/list-events-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..289a23009f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/list-events-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/list-events-async-string-dictionary-string-string" +title: "ListEventsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomRecordings.ListEventsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.VideoRoomRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `ListEventsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListEventsAsync(string recordingId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 136. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/video-room-recordings-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/video-room-recordings-http-client-string.mdx new file mode 100644 index 0000000000..f7d72013d6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/video-room-recordings-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-recordings/video-room-recordings-http-client-string" +title: "VideoRoomRecordings(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomRecordings.VideoRoomRecordings(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.VideoRoomRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoRoomRecordings(HttpClient, string)` + +## Signature + +```dotnet +public VideoRoomRecordings(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 116. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/get-async-string.mdx new file mode 100644 index 0000000000..08815a3f37 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomSessions.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string sessionId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 97. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/index.mdx new file mode 100644 index 0000000000..bc0182e5c5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-sessions" +title: "VideoRoomSessions" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomSessions" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoRoomSessions` + +Video room sessions: list, get, list\_events/\_members/\_recordings. + +## Signature + +```dotnet +public class VideoRoomSessions +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 78. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..8a533ca03f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomSessions.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 94. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-events-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-events-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..dc58f858e7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-events-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-events-async-string-dictionary-string-string" +title: "ListEventsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomSessions.ListEventsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `ListEventsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListEventsAsync(string sessionId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 100. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-members-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-members-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..210ee66308 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-members-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-members-async-string-dictionary-string-string" +title: "ListMembersAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomSessions.ListMembersAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `ListMembersAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListMembersAsync(string sessionId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 103. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-recordings-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-recordings-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..022281be43 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-recordings-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/list-recordings-async-string-dictionary-string-string" +title: "ListRecordingsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomSessions.ListRecordingsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `ListRecordingsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListRecordingsAsync(string sessionId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 106. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/video-room-sessions-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/video-room-sessions-http-client-string.mdx new file mode 100644 index 0000000000..5889fc49a7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/video-room-sessions-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-sessions/video-room-sessions-http-client-string" +title: "VideoRoomSessions(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomSessions.VideoRoomSessions(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoRoomSessions(HttpClient, string)` + +## Signature + +```dotnet +public VideoRoomSessions(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 83. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-tokens/create-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-tokens/create-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..6ea6af437f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-tokens/create-async-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-tokens/create-async-dictionary-string-object" +title: "CreateAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomTokens.CreateAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.VideoRoomTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `CreateAsync(Dictionary)` + +## Signature + +```dotnet +public Task> CreateAsync(Dictionary kwargs) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 73. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-tokens/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-tokens/index.mdx new file mode 100644 index 0000000000..10d000d34b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-tokens/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-tokens" +title: "VideoRoomTokens" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomTokens" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoRoomTokens` + +Video room tokens (create-only). + +## Signature + +```dotnet +public class VideoRoomTokens +``` + +## Properties + + + +## Methods + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 60. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-tokens/video-room-tokens-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-tokens/video-room-tokens-http-client-string.mdx new file mode 100644 index 0000000000..ad503b985e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-room-tokens/video-room-tokens-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-room-tokens/video-room-tokens-http-client-string" +title: "VideoRoomTokens(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRoomTokens.VideoRoomTokens(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.VideoRoomTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoRoomTokens(HttpClient, string)` + +## Signature + +```dotnet +public VideoRoomTokens(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 65. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/create-stream-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/create-stream-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..b44afc52a5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/create-stream-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-rooms/create-stream-async-string-dictionary-string-object" +title: "CreateStreamAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRooms.CreateStreamAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.VideoRooms" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `CreateStreamAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> CreateStreamAsync(string roomId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 55. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/index.mdx new file mode 100644 index 0000000000..21cbd1e384 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-rooms" +title: "VideoRooms" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRooms" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoRooms` + +Video rooms (CRUD + streams sub-resource). + +## Signature + +```dotnet +public class VideoRooms : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + + + Update via PUT (matching Python's \_update\_method = "PUT"). + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 44. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/list-streams-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/list-streams-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..a26716dc92 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/list-streams-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-rooms/list-streams-async-string-dictionary-string-string" +title: "ListStreamsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRooms.ListStreamsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.VideoRooms" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `ListStreamsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListStreamsAsync(string roomId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 52. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..1b93987f68 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-rooms/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRooms.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.VideoRooms" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +Update via PUT (matching Python's \_update\_method = "PUT"). + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Task> UpdateAsync(string id, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 49. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/video-rooms-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/video-rooms-http-client-string.mdx new file mode 100644 index 0000000000..faea66e814 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-rooms/video-rooms-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-rooms/video-rooms-http-client-string" +title: "VideoRooms(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoRooms.VideoRooms(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.VideoRooms" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoRooms(HttpClient, string)` + +## Signature + +```dotnet +public VideoRooms(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 46. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/delete-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/delete-async-string.mdx new file mode 100644 index 0000000000..85fecae2ff --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/delete-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-streams/delete-async-string" +title: "DeleteAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoStreams.DeleteAsync(string)" + parent: "SignalWire.REST.Namespaces.VideoStreams" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `DeleteAsync(string)` + +## Signature + +```dotnet +public Task> DeleteAsync(string streamId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 204. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/get-async-string.mdx new file mode 100644 index 0000000000..8216e343fa --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-streams/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoStreams.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.VideoStreams" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string streamId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 198. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/index.mdx new file mode 100644 index 0000000000..e83090000f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-streams" +title: "VideoStreams" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoStreams" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoStreams` + +Video streams: get, update (PUT), delete. + +## Signature + +```dotnet +public class VideoStreams +``` + +## Properties + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 183. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..337bd1fc2d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-streams/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoStreams.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.Namespaces.VideoStreams" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +## Signature + +```dotnet +public Task> UpdateAsync(string streamId, Dictionary kwargs) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 201. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/video-streams-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/video-streams-http-client-string.mdx new file mode 100644 index 0000000000..64b3c2a585 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video-streams/video-streams-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video-streams/video-streams-http-client-string" +title: "VideoStreams(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VideoStreams.VideoStreams(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.VideoStreams" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `VideoStreams(HttpClient, string)` + +## Signature + +```dotnet +public VideoStreams(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 188. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video/index.mdx new file mode 100644 index 0000000000..c2fb5e307d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video/index.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video" +title: "Video" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Video" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `Video` + +Video API namespace. + +Mirrors Python `signalwire.rest.namespaces.video.VideoNamespace` — +rooms, room sessions, room recordings, conferences, conference tokens, +streams. + +<p>The legacy ``client.Video.List() / Create / Get / Delete`` surface +(which targeted ``/api/video/rooms``) is preserved by inheriting from +<xref href="SignalWire.REST.CrudResource" data-throw-if-not-resolved="false"></xref>.</p> + +## Signature + +```dotnet +public class Video : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Properties + + + + + + + + + + + + + + + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 20. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video/video-http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video/video-http-client.mdx new file mode 100644 index 0000000000..c128d462a9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/video/video-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/video/video-http-client" +title: "Video(HttpClient)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.Video.Video(SignalWire.REST.HttpClient)" + parent: "SignalWire.REST.Namespaces.Video" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs" + visibility: "public" +--- +# `Video(HttpClient)` + +## Signature + +```dotnet +public Video(HttpClient client) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/REST/Namespaces/Video.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Video.cs) + +Line 32. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/get-async-string.mdx new file mode 100644 index 0000000000..d711a6bbeb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/get-async-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/voice-logs/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VoiceLogs.GetAsync(string)" + parent: "SignalWire.REST.Namespaces.VoiceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `GetAsync(string)` + +## Signature + +```dotnet +public Task> GetAsync(string logId) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 78. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/index.mdx new file mode 100644 index 0000000000..310c0ff49e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/voice-logs" +title: "VoiceLogs" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VoiceLogs" + parent: "SignalWire.REST.Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `VoiceLogs` + +Voice log queries with events sub-collection. + +## Signature + +```dotnet +public class VoiceLogs +``` + +## Properties + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 59. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..b214112c9d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/list-async-dictionary-string-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/voice-logs/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VoiceLogs.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.VoiceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +## Signature + +```dotnet +public Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 75. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/list-events-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/list-events-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..185fcd781a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/list-events-async-string-dictionary-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/voice-logs/list-events-async-string-dictionary-string-string" +title: "ListEventsAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VoiceLogs.ListEventsAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.Namespaces.VoiceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `ListEventsAsync(string, Dictionary?)` + +## Signature + +```dotnet +public Task> ListEventsAsync(string logId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 81. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/voice-logs-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/voice-logs-http-client-string.mdx new file mode 100644 index 0000000000..1117f37e05 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest.namespaces/voice-logs/voice-logs-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest.namespaces/voice-logs/voice-logs-http-client-string" +title: "VoiceLogs(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.Namespaces.VoiceLogs.VoiceLogs(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.Namespaces.VoiceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs" + visibility: "public" +--- +# `VoiceLogs(HttpClient, string)` + +## Signature + +```dotnet +public VoiceLogs(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/Namespaces/Logs.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/Namespaces/Logs.cs) + +Line 64. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/create-async-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/create-async-dictionary-string-object.mdx new file mode 100644 index 0000000000..f18d06a305 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/create-async-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/crud-resource/create-async-dictionary-string-object" +title: "CreateAsync(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.CrudResource.CreateAsync(System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs" + visibility: "public" +--- +# `CreateAsync(Dictionary)` + +Create a new resource (POST basePath). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task> CreateAsync(Dictionary data) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/CrudResource.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs) + +Line 34. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/crud-resource-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/crud-resource-http-client-string.mdx new file mode 100644 index 0000000000..bbb6d9954c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/crud-resource-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/crud-resource/crud-resource-http-client-string" +title: "CrudResource(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.CrudResource.CrudResource(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs" + visibility: "public" +--- +# `CrudResource(HttpClient, string)` + +## Signature + +```dotnet +public CrudResource(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/CrudResource.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs) + +Line 13. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/delete-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/delete-async-string.mdx new file mode 100644 index 0000000000..11c770511c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/delete-async-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/crud-resource/delete-async-string" +title: "DeleteAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.CrudResource.DeleteAsync(string)" + parent: "SignalWire.REST.CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs" + visibility: "public" +--- +# `DeleteAsync(string)` + +Delete a resource by ID (DELETE basePath/\{id\}). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task> DeleteAsync(string id) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/CrudResource.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs) + +Line 54. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/get-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/get-async-string.mdx new file mode 100644 index 0000000000..6c32c17749 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/get-async-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/crud-resource/get-async-string" +title: "GetAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.CrudResource.GetAsync(string)" + parent: "SignalWire.REST.CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs" + visibility: "public" +--- +# `GetAsync(string)` + +Retrieve a single resource by ID (GET basePath/\{id\}). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task> GetAsync(string id) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/CrudResource.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs) + +Line 41. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/index.mdx new file mode 100644 index 0000000000..aa350bc66d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/crud-resource" +title: "CrudResource" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.CrudResource" + parent: "SignalWire.REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs" + visibility: "public" +--- +# `CrudResource` + +Generic CRUD wrapper around an <xref href="SignalWire.REST.HttpClient" data-throw-if-not-resolved="false"></xref> and a base API path. + +Provides List / Create / Get / Update / Delete for any REST resource that +follows the standard SignalWire collection+item URL pattern. + +## Signature + +```dotnet +public class CrudResource +``` + +## Properties + + + + + +## Methods + + + + Create a new resource (POST basePath). + + + + + + Delete a resource by ID (DELETE basePath/\{id\}). + + + + Retrieve a single resource by ID (GET basePath/\{id\}). + + + + List resources (GET basePath). + + + + Build a full path by appending segments to the base path. + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`src/SignalWire/REST/CrudResource.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs) + +Line 8. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/list-async-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/list-async-dictionary-string-string.mdx new file mode 100644 index 0000000000..1611494a00 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/list-async-dictionary-string-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/crud-resource/list-async-dictionary-string-string" +title: "ListAsync(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.CrudResource.ListAsync(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs" + visibility: "public" +--- +# `ListAsync(Dictionary?)` + +List resources (GET basePath). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task> ListAsync(Dictionary? queryParams = null) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/CrudResource.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs) + +Line 27. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/path-params-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/path-params-string.mdx new file mode 100644 index 0000000000..0848674e7e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/path-params-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/crud-resource/path-params-string" +title: "Path(params string[])" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.CrudResource.Path(params string[])" + parent: "SignalWire.REST.CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs" + visibility: "protected" +--- +# `Path(params string[])` + +Build a full path by appending segments to the base path. + +## Signature + +```dotnet +protected string Path(params string[] parts) +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/REST/CrudResource.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs) + +Line 20. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/update-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/update-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..8c03c1fbd5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-resource/update-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/crud-resource/update-async-string-dictionary-string-object" +title: "UpdateAsync(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.CrudResource.UpdateAsync(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.REST.CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs" + visibility: "public" +--- +# `UpdateAsync(string, Dictionary)` + +Update a resource by ID (PUT basePath/\{id\}). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task> UpdateAsync(string id, Dictionary data) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/CrudResource.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudResource.cs) + +Line 47. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-with-addresses/crud-with-addresses-http-client-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-with-addresses/crud-with-addresses-http-client-string.mdx new file mode 100644 index 0000000000..860cbd4bb7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-with-addresses/crud-with-addresses-http-client-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/crud-with-addresses/crud-with-addresses-http-client-string" +title: "CrudWithAddresses(HttpClient, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.CrudWithAddresses.CrudWithAddresses(SignalWire.REST.HttpClient, string)" + parent: "SignalWire.REST.CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudWithAddresses.cs" + visibility: "public" +--- +# `CrudWithAddresses(HttpClient, string)` + +## Signature + +```dotnet +public CrudWithAddresses(HttpClient client, string basePath) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/REST/CrudWithAddresses.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudWithAddresses.cs) + +Line 13. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-with-addresses/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-with-addresses/index.mdx new file mode 100644 index 0000000000..93342fed26 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-with-addresses/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/crud-with-addresses" +title: "CrudWithAddresses" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.CrudWithAddresses" + parent: "SignalWire.REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudWithAddresses.cs" + visibility: "public" +--- +# `CrudWithAddresses` + +## Signature + +```dotnet +public class CrudWithAddresses : CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire.REST.CrudResource](/reference/dotnet/signal-wire.rest/crud-resource) + +## Methods + + + + + + List the addresses sub-collection for a given resource. (Python parity: `CrudWithAddresses.list_addresses(resource_id, **params)`.) + + + +## Source + +[`src/SignalWire/REST/CrudWithAddresses.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudWithAddresses.cs) + +Line 11. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-with-addresses/list-addresses-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-with-addresses/list-addresses-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..57ccb2051d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/crud-with-addresses/list-addresses-async-string-dictionary-string-string.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/crud-with-addresses/list-addresses-async-string-dictionary-string-string" +title: "ListAddressesAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.CrudWithAddresses.ListAddressesAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudWithAddresses.cs" + visibility: "public" +--- +# `ListAddressesAsync(string, Dictionary?)` + +List the addresses sub-collection for a given resource. +(Python parity: +`CrudWithAddresses.list_addresses(resource_id, **params)`.) + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task> ListAddressesAsync(string resourceId, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/CrudWithAddresses.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/CrudWithAddresses.cs) + +Line 19. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/delete-async-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/delete-async-string.mdx new file mode 100644 index 0000000000..3ce5b3bdd8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/delete-async-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/http-client/delete-async-string" +title: "DeleteAsync(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.HttpClient.DeleteAsync(string)" + parent: "SignalWire.REST.HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs" + visibility: "public" +--- +# `DeleteAsync(string)` + +DELETE. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task> DeleteAsync(string path) +``` + +## Parameters + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/HttpClient.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs) + +Line 76. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/get-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/get-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..6e49b621e4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/get-async-string-dictionary-string-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/http-client/get-async-string-dictionary-string-string" +title: "GetAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.HttpClient.GetAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs" + visibility: "public" +--- +# `GetAsync(string, Dictionary?)` + +GET with optional query-string parameters. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task> GetAsync(string path, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/HttpClient.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs) + +Line 48. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/http-client.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/http-client.mdx new file mode 100644 index 0000000000..e92b4efd2c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/http-client.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/http-client/http-client" +title: "HttpClient" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.HttpClient.HttpClient(string, string, string)" + parent: "SignalWire.REST.HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs" + visibility: "public" +--- +# `HttpClient` + +## Signature + + + + ```dotnet + public HttpClient(string projectId, string token, string baseUrl) + ``` + + + + ```dotnet + public HttpClient(string projectId, string token, string baseUrl, HttpClient? httpClient) + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Parameters (Overload 2) + + + + + + + + + +## Source + +[`src/SignalWire/REST/HttpClient.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs) + +Line 21. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/index.mdx new file mode 100644 index 0000000000..8222942b07 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/http-client" +title: "HttpClient" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.HttpClient" + parent: "SignalWire.REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs" + visibility: "public" +--- +# `HttpClient` + +Low-level HTTP client for SignalWire REST APIs. + +Uses <xref href="System.Net.Http.HttpClient" data-throw-if-not-resolved="false"></xref> with Basic Auth, +and returns parsed JSON responses as dictionaries. + +## Signature + +```dotnet +public class HttpClient +``` + +## Properties + + + + + + + + + +## Methods + + + + DELETE. + + + + GET with optional query-string parameters. + + + + + + Return pages by following "next" links automatically. Expects \{ "data": \[...], "links": \{ "next": "..." \} \}. + + + + PATCH with JSON body. + + + + POST with JSON body. + + + + PUT with JSON body. + + + +## Source + +[`src/SignalWire/REST/HttpClient.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs) + +Line 12. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/list-all-async-string-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/list-all-async-string-dictionary-string-string.mdx new file mode 100644 index 0000000000..2d1b02eddf --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/list-all-async-string-dictionary-string-string.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/http-client/list-all-async-string-dictionary-string-string" +title: "ListAllAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.HttpClient.ListAllAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs" + visibility: "public" +--- +# `ListAllAsync(string, Dictionary?)` + +Return pages by following "next" links automatically. +Expects \{ "data": \[...], "links": \{ "next": "..." \} \}. + +## Signature + +```dotnet +public IAsyncEnumerable>> ListAllAsync(string path, Dictionary? queryParams = null) +``` + +## Parameters + + + + + +## Returns + +`IAsyncEnumerable>>` + +## Source + +[`src/SignalWire/REST/HttpClient.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs) + +Line 89. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/patch-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/patch-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..f6f7599e94 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/patch-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/http-client/patch-async-string-dictionary-string-object" +title: "PatchAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.HttpClient.PatchAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs" + visibility: "public" +--- +# `PatchAsync(string, Dictionary?)` + +PATCH with JSON body. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task> PatchAsync(string path, Dictionary? data = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/HttpClient.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs) + +Line 69. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/post-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/post-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..bc1a5ea98f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/post-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/http-client/post-async-string-dictionary-string-object" +title: "PostAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.HttpClient.PostAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs" + visibility: "public" +--- +# `PostAsync(string, Dictionary?)` + +POST with JSON body. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task> PostAsync(string path, Dictionary? data = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/HttpClient.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs) + +Line 55. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/put-async-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/put-async-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..3fa6d54260 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/http-client/put-async-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/http-client/put-async-string-dictionary-string-object" +title: "PutAsync(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.HttpClient.PutAsync(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.REST.HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs" + visibility: "public" +--- +# `PutAsync(string, Dictionary?)` + +PUT with JSON body. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Task> PutAsync(string path, Dictionary? data = null) +``` + +## Parameters + + + + + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/HttpClient.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/HttpClient.cs) + +Line 62. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/index.mdx new file mode 100644 index 0000000000..3782034a23 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest" +title: "SignalWire.REST" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.REST" +--- +# `SignalWire.REST` + +## Classes + + + + Generic CRUD wrapper around an <xref href="SignalWire.REST.HttpClient" data-throw-if-not-resolved="false"></xref> and a base API path. Provides List / Create / Get / Update / Delete for any REST resource that follows the standard SignalWire collection+item URL pattern. + + + + + + Low-level HTTP client for SignalWire REST APIs. Uses <xref href="System.Net.Http.HttpClient" data-throw-if-not-resolved="false"></xref> with Basic Auth, and returns parsed JSON responses as dictionaries. + + + + Walks paged HTTP responses by following `links.next` cursors. Mirrors Python `signalwire.rest._pagination.PaginatedIterator` — constructor records inputs without fetching; iteration triggers the first fetch and continues until a page is returned without a `links.next` cursor. + + + + Top-level SignalWire REST client. Provides lazy access to every API namespace (fabric, calling, phone\_numbers, datasphere, video, compat, etc.). Credentials can be supplied explicitly or pulled from environment variables. + + + + Exception thrown when a SignalWire REST API call returns a non-2xx status or encounters a transport-level error. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/get-async-enumerator-cancellation-token.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/get-async-enumerator-cancellation-token.mdx new file mode 100644 index 0000000000..2c386e37dc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/get-async-enumerator-cancellation-token.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/paginated-iterator/get-async-enumerator-cancellation-token" +title: "GetAsyncEnumerator(CancellationToken)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.PaginatedIterator.GetAsyncEnumerator(System.Threading.CancellationToken)" + parent: "SignalWire.REST.PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/PaginatedIterator.cs" + visibility: "public" +--- +# `GetAsyncEnumerator(CancellationToken)` + +Async-enumerable adapter so callers can write +`await foreach (var item in iterator)`. + +## Signature + +```dotnet +public IAsyncEnumerator> GetAsyncEnumerator(CancellationToken cancellationToken = default) +``` + +## Parameters + + + +## Returns + +`IAsyncEnumerator>` + +## Source + +[`src/SignalWire/REST/PaginatedIterator.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/PaginatedIterator.cs) + +Line 131. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/index.mdx new file mode 100644 index 0000000000..58606239d3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/paginated-iterator" +title: "PaginatedIterator" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.PaginatedIterator" + parent: "SignalWire.REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/PaginatedIterator.cs" + visibility: "public" +--- +# `PaginatedIterator` + +Walks paged HTTP responses by following `links.next` cursors. + +Mirrors Python `signalwire.rest._pagination.PaginatedIterator` — +constructor records inputs without fetching; iteration triggers +the first fetch and continues until a page is returned without a +`links.next` cursor. + +## Signature + +```dotnet +public class PaginatedIterator : IAsyncEnumerable> +``` + +## Inheritance + +**Implements:** `IAsyncEnumerable>` + +## Properties + + + + + + + + + + + + + + + +## Methods + + + + Async-enumerable adapter so callers can write `await foreach (var item in iterator)`. + + + + Returns the next item, or throws InvalidOperationException when exhausted (mirroring Python's StopIteration). + + + + + +## Source + +[`src/SignalWire/REST/PaginatedIterator.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/PaginatedIterator.cs) + +Line 17. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/next-async.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/next-async.mdx new file mode 100644 index 0000000000..8700240fdb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/next-async.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/paginated-iterator/next-async" +title: "NextAsync()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.PaginatedIterator.NextAsync()" + parent: "SignalWire.REST.PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/PaginatedIterator.cs" + visibility: "public" +--- +# `NextAsync()` + +Returns the next item, or throws InvalidOperationException +when exhausted (mirroring Python's StopIteration). + +## Signature + +```dotnet +public Task> NextAsync() +``` + +## Returns + +`System.Threading.Tasks.Task>` + +## Source + +[`src/SignalWire/REST/PaginatedIterator.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/PaginatedIterator.cs) + +Line 55. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/paginated-iterator-http-client-string-dictionary-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/paginated-iterator-http-client-string-dictionary-string-string-string.mdx new file mode 100644 index 0000000000..e04c02854d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/paginated-iterator/paginated-iterator-http-client-string-dictionary-string-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/paginated-iterator/paginated-iterator-http-client-string-dictionary-string-string-string" +title: "PaginatedIterator(HttpClient, string, Dictionary?, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.PaginatedIterator.PaginatedIterator(SignalWire.REST.HttpClient, string, System.Collections.Generic.Dictionary?, string)" + parent: "SignalWire.REST.PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/PaginatedIterator.cs" + visibility: "public" +--- +# `PaginatedIterator(HttpClient, string, Dictionary?, string)` + +## Signature + +```dotnet +public PaginatedIterator(HttpClient http, string path, Dictionary? @params = null, string dataKey = "data") +``` + +## Parameters + + + + + + + + + +## Source + +[`src/SignalWire/REST/PaginatedIterator.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/PaginatedIterator.cs) + +Line 33. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/rest-client/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/rest-client/index.mdx new file mode 100644 index 0000000000..25f608bdc9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/rest-client/index.mdx @@ -0,0 +1,136 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/rest-client" +title: "RestClient" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.RestClient" + parent: "SignalWire.REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/RestClient.cs" + visibility: "public" +--- +# `RestClient` + +Top-level SignalWire REST client. + +Provides lazy access to every API namespace (fabric, calling, +phone\_numbers, datasphere, video, compat, etc.). Credentials can be +supplied explicitly or pulled from environment variables. + +## Signature + +```dotnet +public class RestClient +``` + +## Properties + + + Addresses. + + + + + + Calling API (37 call-control commands). + + + + Chat tokens. + + + + Compatibility (Twilio-compatible LaML) API. + + + + Datasphere documents. + + + + Fabric API (sub-resources: subscribers, sip\_endpoints, call\_flows, ...). + + + + + + Imported phone numbers (create only). + + + + Logs (messages, voice, fax, conferences). + + + + Phone number lookup. + + + + Multi-factor authentication (sms/call/verify dispatch). + + + + Number groups (with membership operations). + + + + Phone numbers. + + + + Project management. + + + + + + PubSub tokens. + + + + Queues (Relay queues at /api/relay/rest/queues with member ops). + + + + Recordings (Relay recordings at /api/relay/rest/recordings). + + + + Registry (10DLC brands, campaigns, orders, numbers). + + + + Short codes (PUT for update). + + + + SIP profile (singleton at /api/relay/rest/sip\_profile; legacy plural-path /api/relay/rest/sip\_profiles preserved for existing tests via BasePath). + + + + + + + + Verified callers. + + + + Video rooms (Python-parity entry-point with sub-namespaces). + + +## Methods + + + + + +## Source + +[`src/SignalWire/REST/RestClient.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/RestClient.cs) + +Line 11. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/rest-client/rest-client-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/rest-client/rest-client-string-string-string.mdx new file mode 100644 index 0000000000..37025c7a2b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/rest-client/rest-client-string-string-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/rest-client/rest-client-string-string-string" +title: "RestClient(string, string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.RestClient.RestClient(string, string, string)" + parent: "SignalWire.REST.RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/RestClient.cs" + visibility: "public" +--- +# `RestClient(string, string, string)` + +## Signature + +```dotnet +public RestClient(string projectId = "", string token = "", string space = "") +``` + +## Parameters + + + Project ID (falls back to SIGNALWIRE\_PROJECT\_ID env var). + + + + API token (falls back to SIGNALWIRE\_API\_TOKEN env var). + + + + Space host (falls back to SIGNALWIRE\_SPACE env var). + + +## Source + +[`src/SignalWire/REST/RestClient.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/RestClient.cs) + +Line 47. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/signal-wire-rest-error/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/signal-wire-rest-error/index.mdx new file mode 100644 index 0000000000..44caf04011 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/signal-wire-rest-error/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/signal-wire-rest-error" +title: "SignalWireRestError" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.REST.SignalWireRestError" + parent: "SignalWire.REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/SignalWireRestError.cs" + visibility: "public" +--- +# `SignalWireRestError` + +Exception thrown when a SignalWire REST API call returns a non-2xx status +or encounters a transport-level error. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class SignalWireRestError : Exception, ISerializable +``` + +## Inheritance + +**Extends:** `System.Exception` + +**Implements:** `System.Runtime.Serialization.ISerializable` + +## Properties + + + Raw response body from the server. + + + + HTTP status code from the response (0 for transport errors). + + +## Methods + + + + + + Creates and returns a string representation of the current exception. + + + +## Source + +[`src/SignalWire/REST/SignalWireRestError.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/SignalWireRestError.cs) + +Line 6. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/signal-wire-rest-error/signal-wire-rest-error.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/signal-wire-rest-error/signal-wire-rest-error.mdx new file mode 100644 index 0000000000..2f86a8c37a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/signal-wire-rest-error/signal-wire-rest-error.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/signal-wire-rest-error/signal-wire-rest-error" +title: "SignalWireRestError" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.SignalWireRestError.SignalWireRestError(string, int, string)" + parent: "SignalWire.REST.SignalWireRestError" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/SignalWireRestError.cs" + visibility: "public" +--- +# `SignalWireRestError` + +## Signature + + + + ```dotnet + public SignalWireRestError(string message, int statusCode, string responseBody) + ``` + + + + ```dotnet + public SignalWireRestError(string message, int statusCode, string responseBody, Exception innerException) + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Parameters (Overload 2) + + + + + + + + + +## Source + +[`src/SignalWire/REST/SignalWireRestError.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/SignalWireRestError.cs) + +Line 14. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.rest/signal-wire-rest-error/to-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.rest/signal-wire-rest-error/to-string.mdx new file mode 100644 index 0000000000..b5879a0fcf --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.rest/signal-wire-rest-error/to-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.rest/signal-wire-rest-error/to-string" +title: "ToString()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.REST.SignalWireRestError.ToString()" + parent: "SignalWire.REST.SignalWireRestError" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/SignalWireRestError.cs" + visibility: "public" +--- +# `ToString()` + +Creates and returns a string representation of the current exception. + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string ToString() +``` + +## Returns + +`string` — A string representation of the current exception. + +## Source + +[`src/SignalWire/REST/SignalWireRestError.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/REST/SignalWireRestError.cs) + +Line 28. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/index.mdx new file mode 100644 index 0000000000..81ecb3526f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/dotnet/signal-wire.security" +title: "SignalWire.Security" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.Security" +--- +# `SignalWire.Security` + +## Classes + + + + Generates and validates HMAC-SHA256 signed session tokens for SWAIG function calls. Each instance holds an independent 32-byte random secret. + + + + HTTP middleware that validates the <code>X-SignalWire-Signature</code> header on incoming requests using <xref href="SignalWire.Security.WebhookValidator" data-throw-if-not-resolved="false"></xref>. Designed for the .NET port's HttpListener-based dispatch surface; adapts the same contract Python's FastAPI dependency provides. <p>Use <xref href="SignalWire.Security.WebhookValidationMiddleware.Validate(System.String%2cSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.String%7d%2cSystem.String%2cSystem.String%2cSystem.Int32)" data-throw-if-not-resolved="false"></xref> to short-circuit invalid requests with 403 before they reach an agent's POST handler. Returns null on success so the caller continues to dispatch.</p> <p>This is intentionally a non-async type: the underlying validator is pure CPU work and the dispatch surface uses synchronous strings.</p> + + + + Validates SignalWire webhook signatures for both Scheme A (RELAY/JSON, hex HMAC-SHA1 over <code>url + rawBody</code>) and Scheme B (Compat/cXML form, base64 HMAC-SHA1 over <code>url + sortedFormParams</code>) per <code>porting-sdk/webhooks.md</code>. The contract is byte-identical across all SignalWire SDK ports — see the cross-port test vectors in the spec. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/create-session-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/create-session-string.mdx new file mode 100644 index 0000000000..e41254052f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/create-session-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.security/session-manager/create-session-string" +title: "CreateSession(string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Security.SessionManager.CreateSession(string?)" + parent: "SignalWire.Security.SessionManager" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/SessionManager.cs" + visibility: "public" +--- +# `CreateSession(string?)` + +Create or confirm a session, returning the call ID. + +## Signature + +```dotnet +public string CreateSession(string? callId = null) +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/Security/SessionManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/SessionManager.cs) + +Line 30. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/create-token-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/create-token-string-string.mdx new file mode 100644 index 0000000000..0a28f591b0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/create-token-string-string.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.security/session-manager/create-token-string-string" +title: "CreateToken(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Security.SessionManager.CreateToken(string, string)" + parent: "SignalWire.Security.SessionManager" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/SessionManager.cs" + visibility: "public" +--- +# `CreateToken(string, string)` + +Generate an HMAC-SHA256 signed token bound to a function name and call ID. + +## Signature + +```dotnet +public string CreateToken(string functionName, string callId) +``` + +## Parameters + + + The function name to bind into the token. + + + + The call ID to bind into the token. + + +## Returns + +`string` — A base64url-encoded token string. + +## Source + +[`src/SignalWire/Security/SessionManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/SessionManager.cs) + +Line 41. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/index.mdx new file mode 100644 index 0000000000..22c4b26c84 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/dotnet/signal-wire.security/session-manager" +title: "SessionManager" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Security.SessionManager" + parent: "SignalWire.Security" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/SessionManager.cs" + visibility: "public" +--- +# `SessionManager` + +Generates and validates HMAC-SHA256 signed session tokens for SWAIG function calls. +Each instance holds an independent 32-byte random secret. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class SessionManager +``` + +## Properties + + + Default token lifetime in seconds. + + + + Get the configured token expiry duration in seconds. + + +## Methods + + + + Create or confirm a session, returning the call ID. + + + + Generate an HMAC-SHA256 signed token bound to a function name and call ID. + + + + + + Validate a token against the expected function name and call ID. All comparisons use timing-safe equality checks to prevent side-channel attacks. + + + +## Source + +[`src/SignalWire/Security/SessionManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/SessionManager.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/session-manager-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/session-manager-int.mdx new file mode 100644 index 0000000000..1528eca114 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/session-manager-int.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.security/session-manager/session-manager-int" +title: "SessionManager(int)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Security.SessionManager.SessionManager(int)" + parent: "SignalWire.Security.SessionManager" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/SessionManager.cs" + visibility: "public" +--- +# `SessionManager(int)` + +## Signature + +```dotnet +public SessionManager(int tokenExpirySecs = 3600) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Security/SessionManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/SessionManager.cs) + +Line 17. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/validate-token-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/validate-token-string-string-string.mdx new file mode 100644 index 0000000000..33356be142 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/session-manager/validate-token-string-string-string.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/dotnet/signal-wire.security/session-manager/validate-token-string-string-string" +title: "ValidateToken(string, string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Security.SessionManager.ValidateToken(string, string, string)" + parent: "SignalWire.Security.SessionManager" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/SessionManager.cs" + visibility: "public" +--- +# `ValidateToken(string, string, string)` + +Validate a token against the expected function name and call ID. +All comparisons use timing-safe equality checks to prevent side-channel attacks. + +## Signature + +```dotnet +public bool ValidateToken(string functionName, string callId, string token) +``` + +## Parameters + + + The expected function name. + + + + The expected call ID. + + + + The base64url-encoded token to validate. + + +## Returns + +`bool` — <code>true</code> if the token is valid and not expired. + +## Source + +[`src/SignalWire/Security/SessionManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/SessionManager.cs) + +Line 61. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/extract-signature-header-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/extract-signature-header-dictionary-string-string.mdx new file mode 100644 index 0000000000..37d0d5baf3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/extract-signature-header-dictionary-string-string.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.security/webhook-validation-middleware/extract-signature-header-dictionary-string-string" +title: "ExtractSignatureHeader(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Security.WebhookValidationMiddleware.ExtractSignatureHeader(System.Collections.Generic.Dictionary)" + parent: "SignalWire.Security.WebhookValidationMiddleware" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidationMiddleware.cs" + visibility: "public" +--- +# `ExtractSignatureHeader(Dictionary)` + +Pull <code>X-SignalWire-Signature</code> from request headers, or the <code>X-Twilio-Signature</code> alias for cXML/Compat callers. Header +lookups are case-insensitive (proxies / browsers vary). + +**Modifiers:** `static` + +## Signature + +```dotnet +public static string? ExtractSignatureHeader(Dictionary headers) +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/Security/WebhookValidationMiddleware.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidationMiddleware.cs) + +Line 134. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/index.mdx new file mode 100644 index 0000000000..1585e63122 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/dotnet/signal-wire.security/webhook-validation-middleware" +title: "WebhookValidationMiddleware" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Security.WebhookValidationMiddleware" + parent: "SignalWire.Security" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidationMiddleware.cs" + visibility: "public" +--- +# `WebhookValidationMiddleware` + +HTTP middleware that validates the <code>X-SignalWire-Signature</code> header +on incoming requests using <xref href="SignalWire.Security.WebhookValidator" data-throw-if-not-resolved="false"></xref>. Designed for +the .NET port's HttpListener-based dispatch surface; adapts the same +contract Python's FastAPI dependency provides. + +<p>Use <xref href="SignalWire.Security.WebhookValidationMiddleware.Validate(System.String%2cSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.String%7d%2cSystem.String%2cSystem.String%2cSystem.Int32)" data-throw-if-not-resolved="false"></xref> to short-circuit invalid requests with +403 before they reach an agent's POST handler. Returns null on success +so the caller continues to dispatch.</p> + +<p>This is intentionally a non-async type: the underlying validator +is pure CPU work and the dispatch surface uses synchronous strings.</p> + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class WebhookValidationMiddleware +``` + +## Properties + + + The canonical SignalWire signature header name. + + + + Legacy alias for cXML/Twilio-compat callers. + + +## Methods + + + + Pull <code>X-SignalWire-Signature</code> from request headers, or the <code>X-Twilio-Signature</code> alias for cXML/Compat callers. Header lookups are case-insensitive (proxies / browsers vary). + + + + Reconstruct the public URL SignalWire POSTed to. Resolution order: <ol><li><code>SWML\_PROXY\_URL\_BASE</code> env var (joined with path + query).</li><li><code>X-Forwarded-Proto</code> / <code>X-Forwarded-Host</code> headers when <code>trustProxy=true</code>.</li><li><code>http://hostFallback:portFallback\{path\}</code> as a last-resort local construction.</li></ol> + + + + Validate the incoming request and return a 403 short-circuit response if the signature is missing / invalid. Returns null when the request passed validation — caller proceeds to the real handler. + + + + Construct a middleware bound to a single signing key. + + + +## Source + +[`src/SignalWire/Security/WebhookValidationMiddleware.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidationMiddleware.cs) + +Line 47. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/reconstruct-url-dictionary-string-string-string-string-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/reconstruct-url-dictionary-string-string-string-string-int.mdx new file mode 100644 index 0000000000..c024d6ed99 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/reconstruct-url-dictionary-string-string-string-string-int.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/dotnet/signal-wire.security/webhook-validation-middleware/reconstruct-url-dictionary-string-string-string-string-int" +title: "ReconstructUrl(Dictionary, string, string?, int)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Security.WebhookValidationMiddleware.ReconstructUrl(System.Collections.Generic.Dictionary, string, string?, int)" + parent: "SignalWire.Security.WebhookValidationMiddleware" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidationMiddleware.cs" + visibility: "public" +--- +# `ReconstructUrl(Dictionary, string, string?, int)` + +Reconstruct the public URL SignalWire POSTed to. Resolution order: + +<ol><li><code>SWML_PROXY_URL_BASE</code> env var (joined with path + query).</li><li><code>X-Forwarded-Proto</code> / <code>X-Forwarded-Host</code> headers + when <code>trustProxy=true</code>.</li><li><code>http://hostFallback:portFallback{path}</code> as a last-resort + local construction.</li></ol> + +## Signature + +```dotnet +public string ReconstructUrl(Dictionary headers, string path, string? hostFallback = null, int portFallback = 0) +``` + +## Parameters + + + + + + + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/Security/WebhookValidationMiddleware.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidationMiddleware.cs) + +Line 154. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/validate-string-string-dictionary-string-string-string-string-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/validate-string-string-dictionary-string-string-string-string-int.mdx new file mode 100644 index 0000000000..c982cc5c47 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/validate-string-string-dictionary-string-string-string-string-int.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/dotnet/signal-wire.security/webhook-validation-middleware/validate-string-string-dictionary-string-string-string-string-int" +title: "Validate(string, string, Dictionary, string?, string?, int)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Security.WebhookValidationMiddleware.Validate(string, string, System.Collections.Generic.Dictionary, string?, string?, int)" + parent: "SignalWire.Security.WebhookValidationMiddleware" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidationMiddleware.cs" + visibility: "public" +--- +# `Validate(string, string, Dictionary, string?, string?, int)` + +Validate the incoming request and return a 403 short-circuit +response if the signature is missing / invalid. Returns null when +the request passed validation — caller proceeds to the real handler. + +**Remarks:** The raw body is the caller's <code class="paramref">body</code> string verbatim; +the caller is expected to capture the body once (before any JSON / +form parser consumes the stream) and pass it here. The +HttpListenerContext dispatcher in <code>SignalWire.SWML.Service.Run</code> already does this, so AgentBase +and standalone HttpListener integrations can wire it in directly. + +## Signature + +```dotnet +public (int Status, Dictionary Headers, string Body)? Validate(string method, string path, Dictionary headers, string? body, string? hostFallback = null, int portFallback = 0) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`System.Nullable,string>>` + +## Source + +[`src/SignalWire/Security/WebhookValidationMiddleware.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidationMiddleware.cs) + +Line 96. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/webhook-validation-middleware-string-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/webhook-validation-middleware-string-bool.mdx new file mode 100644 index 0000000000..83450815a5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validation-middleware/webhook-validation-middleware-string-bool.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.security/webhook-validation-middleware/webhook-validation-middleware-string-bool" +title: "WebhookValidationMiddleware(string, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Security.WebhookValidationMiddleware.WebhookValidationMiddleware(string, bool)" + parent: "SignalWire.Security.WebhookValidationMiddleware" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidationMiddleware.cs" + visibility: "public" +--- +# `WebhookValidationMiddleware(string, bool)` + +Construct a middleware bound to a single signing key. + +## Signature + +```dotnet +public WebhookValidationMiddleware(string signingKey, bool trustProxy = false) +``` + +## Parameters + + + The customer's Signing Key from the SignalWire Dashboard. Required, non-empty. Treated as a secret — never logged or echoed. + + + + When true, honor <code>X-Forwarded-Proto</code> / <code>X-Forwarded-Host</code> when reconstructing the URL. Default false because proxy headers are spoofable; opt in only when you control the proxy chain. + + +## Throws + +- `System.ArgumentException` — Thrown when <code class="paramref">signingKey</code> is null or empty. + +## Source + +[`src/SignalWire/Security/WebhookValidationMiddleware.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidationMiddleware.cs) + +Line 73. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validator/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validator/index.mdx new file mode 100644 index 0000000000..04900124dc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validator/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/dotnet/signal-wire.security/webhook-validator" +title: "WebhookValidator" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Security.WebhookValidator" + parent: "SignalWire.Security" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidator.cs" + visibility: "public" +--- +# `WebhookValidator` + +Validates SignalWire webhook signatures for both Scheme A (RELAY/JSON, +hex HMAC-SHA1 over <code>url + rawBody</code>) and Scheme B (Compat/cXML form, +base64 HMAC-SHA1 over <code>url + sortedFormParams</code>) per <code>porting-sdk/webhooks.md</code>. The contract is byte-identical across all +SignalWire SDK ports — see the cross-port test vectors in the spec. + +**Modifiers:** `static` + +## Signature + +```dotnet +public static class WebhookValidator +``` + +## Methods + + + + Legacy <code>@signalwire/compatibility-api</code> drop-in entry point. <p>If <code class="paramref">paramsOrRawBody</code> is a <xref href="System.String" data-throw-if-not-resolved="false"></xref>, delegates to <xref href="SignalWire.Security.WebhookValidator.ValidateWebhookSignature(System.String%2cSystem.String%2cSystem.String%2cSystem.String)" data-throw-if-not-resolved="false"></xref> (Scheme A then Scheme B with parsed form).</p> <p>If it's an <xref href="System.Collections.IDictionary" data-throw-if-not-resolved="false"></xref> or list of key/value pairs, treats it as pre-parsed form params and runs Scheme B directly (with URL port normalization).</p> + + + + Validate a SignalWire webhook signature against both schemes. + + + +## Source + +[`src/SignalWire/Security/WebhookValidator.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidator.cs) + +Line 34. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validator/validate-request-string-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validator/validate-request-string-string-string-object.mdx new file mode 100644 index 0000000000..0432dac313 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validator/validate-request-string-string-string-object.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/dotnet/signal-wire.security/webhook-validator/validate-request-string-string-string-object" +title: "ValidateRequest(string, string?, string, object?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Security.WebhookValidator.ValidateRequest(string, string?, string, object?)" + parent: "SignalWire.Security.WebhookValidator" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidator.cs" + visibility: "public" +--- +# `ValidateRequest(string, string?, string, object?)` + +Legacy <code>@signalwire/compatibility-api</code> drop-in entry point. + +<p>If <code class="paramref">paramsOrRawBody</code> is a <xref href="System.String" data-throw-if-not-resolved="false"></xref>, +delegates to <xref href="SignalWire.Security.WebhookValidator.ValidateWebhookSignature(System.String%2cSystem.String%2cSystem.String%2cSystem.String)" data-throw-if-not-resolved="false"></xref> (Scheme A then +Scheme B with parsed form).</p> + +<p>If it's an <xref href="System.Collections.IDictionary" data-throw-if-not-resolved="false"></xref> or list of key/value pairs, +treats it as pre-parsed form params and runs Scheme B directly (with +URL port normalization).</p> + +**Modifiers:** `static` + +## Signature + +```dotnet +public static bool ValidateRequest(string signingKey, string? signature, string url, object? paramsOrRawBody) +``` + +## Parameters + + + + + + + + + +## Returns + +`bool` + +## Throws + +- `System.ArgumentException` — Thrown when <code class="paramref">signingKey</code> is null or empty, or when <code class="paramref">paramsOrRawBody</code> is neither a string nor a dictionary/list of params. + +## Source + +[`src/SignalWire/Security/WebhookValidator.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidator.cs) + +Line 147. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validator/validate-webhook-signature-string-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validator/validate-webhook-signature-string-string-string-string.mdx new file mode 100644 index 0000000000..e9f90319aa --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.security/webhook-validator/validate-webhook-signature-string-string-string-string.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/dotnet/signal-wire.security/webhook-validator/validate-webhook-signature-string-string-string-string" +title: "ValidateWebhookSignature(string, string?, string, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Security.WebhookValidator.ValidateWebhookSignature(string, string?, string, string?)" + parent: "SignalWire.Security.WebhookValidator" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidator.cs" + visibility: "public" +--- +# `ValidateWebhookSignature(string, string?, string, string?)` + +Validate a SignalWire webhook signature against both schemes. + +**Modifiers:** `static` + +## Signature + +```dotnet +public static bool ValidateWebhookSignature(string signingKey, string? signature, string url, string? rawBody) +``` + +## Parameters + + + Customer's Signing Key from the Dashboard. UTF-8 string, secret. Empty or null raises <xref href="System.ArgumentException" data-throw-if-not-resolved="false"></xref> — that's a programming error, not a validation failure. + + + + The <code>X-SignalWire-Signature</code> header value (or <code>X-Twilio-Signature</code> for cXML compat). Missing / empty returns <code>false</code> without throwing. + + + + The full URL SignalWire POSTed to (scheme, host, optional port, path, query). Must match what the platform saw — see the <code>URL reconstruction</code> section of <code>porting-sdk/webhooks.md</code>. + + + + The raw request body bytes as a UTF-8 string, BEFORE any JSON / form parsing. Re-serialization breaks the Scheme A digest. + + +## Returns + +`bool` — <code>true</code> if the signature matches either Scheme A (hex JSON) or Scheme B (base64 form, with port-normalization variants and optional bodySHA256 fallback). <code>false</code> otherwise. + +## Throws + +- `System.ArgumentException` — Thrown when <code class="paramref">signingKey</code> is null or empty. + +## Source + +[`src/SignalWire/Security/WebhookValidator.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Security/WebhookValidator.cs) + +Line 69. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/agent-server-string-int-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/agent-server-string-int-string.mdx new file mode 100644 index 0000000000..239e86b107 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/agent-server-string-int-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.server/agent-server/agent-server-string-int-string" +title: "AgentServer(string, int?, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Server.AgentServer.AgentServer(string, int?, string)" + parent: "SignalWire.Server.AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs" + visibility: "public" +--- +# `AgentServer(string, int?, string)` + +## Signature + +```dotnet +public AgentServer(string host = "0.0.0.0", int? port = null, string logLevel = "info") +``` + +## Parameters + + + + + + + +## Source + +[`src/SignalWire/Server/AgentServer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs) + +Line 46. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/get-agent-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/get-agent-string.mdx new file mode 100644 index 0000000000..1bdf722e44 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/get-agent-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.server/agent-server/get-agent-string" +title: "GetAgent(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Server.AgentServer.GetAgent(string)" + parent: "SignalWire.Server.AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs" + visibility: "public" +--- +# `GetAgent(string)` + +## Signature + +```dotnet +public AgentBase? GetAgent(string route) +``` + +## Parameters + + + +## Returns + +`SignalWire.Agent.AgentBase` + +## Source + +[`src/SignalWire/Server/AgentServer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs) + +Line 88. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/get-agents.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/get-agents.mdx new file mode 100644 index 0000000000..6e0c345e38 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/get-agents.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.server/agent-server/get-agents" +title: "GetAgents()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Server.AgentServer.GetAgents()" + parent: "SignalWire.Server.AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs" + visibility: "public" +--- +# `GetAgents()` + +Return all registered routes (sorted). + +## Signature + +```dotnet +public List GetAgents() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Server/AgentServer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs) + +Line 81. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/get-sip-username-mapping.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/get-sip-username-mapping.mdx new file mode 100644 index 0000000000..7507ec8dc6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/get-sip-username-mapping.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.server/agent-server/get-sip-username-mapping" +title: "GetSipUsernameMapping()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Server.AgentServer.GetSipUsernameMapping()" + parent: "SignalWire.Server.AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs" + visibility: "public" +--- +# `GetSipUsernameMapping()` + +## Signature + +```dotnet +public Dictionary GetSipUsernameMapping() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Server/AgentServer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs) + +Line 120. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/handle-request-string-string-dictionary-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/handle-request-string-string-dictionary-string-string-string.mdx new file mode 100644 index 0000000000..121db725b1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/handle-request-string-string-dictionary-string-string-string.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.server/agent-server/handle-request-string-string-dictionary-string-string-string" +title: "HandleRequest(string, string, Dictionary?, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Server.AgentServer.HandleRequest(string, string, System.Collections.Generic.Dictionary?, string?)" + parent: "SignalWire.Server.AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs" + visibility: "public" +--- +# `HandleRequest(string, string, Dictionary?, string?)` + +Handle an HTTP request. Returns (status, headers, body). + +## Signature + +```dotnet +public (int Status, Dictionary Headers, string Body) HandleRequest(string method, string path, Dictionary? headers = null, string? body = null) +``` + +## Parameters + + + + + + + + + +## Returns + +`System.ValueTuple,string>` + +## Source + +[`src/SignalWire/Server/AgentServer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs) + +Line 146. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/index.mdx new file mode 100644 index 0000000000..0709ea3e8c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/index.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/dotnet/signal-wire.server/agent-server" +title: "AgentServer" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Server.AgentServer" + parent: "SignalWire.Server" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/obj/Release/net8.0/System.Text.RegularExpressions.Generator/System.Text.RegularExpressions.Generator.RegexGenerator/RegexGenerator.g.cs" + visibility: "public" +--- +# `AgentServer` + +Multi-agent HTTP server. Registers agents at routes, dispatches requests by +longest prefix match, serves static files with path-traversal protection, +handles health/ready/root-index, and supports SIP routing. + +## Signature + +```dotnet +public class AgentServer +``` + +## Properties + + + + + + + The agent\_server logger. (Python parity: `AgentServer.logger` instance attribute.) + + + + +## Methods + + + + + + + + Return all registered routes (sorted). + + + + + + Handle an HTTP request. Returns (status, headers, body). + + + + Register an agent at a route. Throws if the route is already taken. + + + + + + Serve static files from <code class="paramref">directory</code> under <code class="paramref">urlPrefix</code>. Throws if the directory does not exist. + + + + Enable SIP routing on this server. `route` lets the caller pin a non-default SIP route prefix; `autoMap` opts agents into auto-mapped sip\_username = agent name. Matches Python's `setup_sip_routing(self, route='/sip', auto_map=True)`. + + + + + +## Source + +[`src/SignalWire/obj/Release/net8.0/System.Text.RegularExpressions.Generator/System.Text.RegularExpressions.Generator.RegexGenerator/RegexGenerator.g.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/obj/Release/net8.0/System.Text.RegularExpressions.Generator/System.Text.RegularExpressions.Generator.RegexGenerator/RegexGenerator.g.cs) + +Line 8. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/register-agent-base-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/register-agent-base-string.mdx new file mode 100644 index 0000000000..aa1080118f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/register-agent-base-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.server/agent-server/register-agent-base-string" +title: "Register(AgentBase, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Server.AgentServer.Register(SignalWire.Agent.AgentBase, string?)" + parent: "SignalWire.Server.AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs" + visibility: "public" +--- +# `Register(AgentBase, string?)` + +Register an agent at a route. Throws if the route is already taken. + +## Signature + +```dotnet +public AgentServer Register(AgentBase agent, string? route = null) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Server.AgentServer` + +## Source + +[`src/SignalWire/Server/AgentServer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs) + +Line 62. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/register-sip-username-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/register-sip-username-string-string.mdx new file mode 100644 index 0000000000..b0e2bfbb9b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/register-sip-username-string-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.server/agent-server/register-sip-username-string-string" +title: "RegisterSipUsername(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Server.AgentServer.RegisterSipUsername(string, string)" + parent: "SignalWire.Server.AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs" + visibility: "public" +--- +# `RegisterSipUsername(string, string)` + +## Signature + +```dotnet +public AgentServer RegisterSipUsername(string username, string route) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Server.AgentServer` + +## Source + +[`src/SignalWire/Server/AgentServer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs) + +Line 112. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/serve-static-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/serve-static-string-string.mdx new file mode 100644 index 0000000000..09064a51ab --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/serve-static-string-string.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.server/agent-server/serve-static-string-string" +title: "ServeStatic(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Server.AgentServer.ServeStatic(string, string)" + parent: "SignalWire.Server.AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs" + visibility: "public" +--- +# `ServeStatic(string, string)` + +Serve static files from <code class="paramref">directory</code> under <code class="paramref">urlPrefix</code>. +Throws if the directory does not exist. + +## Signature + +```dotnet +public AgentServer ServeStatic(string directory, string urlPrefix) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Server.AgentServer` + +## Source + +[`src/SignalWire/Server/AgentServer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs) + +Line 130. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/setup-sip-routing-string-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/setup-sip-routing-string-bool.mdx new file mode 100644 index 0000000000..7c3d350997 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/setup-sip-routing-string-bool.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/dotnet/signal-wire.server/agent-server/setup-sip-routing-string-bool" +title: "SetupSipRouting(string, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Server.AgentServer.SetupSipRouting(string, bool)" + parent: "SignalWire.Server.AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs" + visibility: "public" +--- +# `SetupSipRouting(string, bool)` + +Enable SIP routing on this server. `route` lets the caller pin +a non-default SIP route prefix; `autoMap` opts agents into +auto-mapped sip\_username = agent name. Matches Python's +`setup_sip_routing(self, route='/sip', auto_map=True)`. + +## Signature + +```dotnet +public AgentServer SetupSipRouting(string route = "/sip", bool autoMap = true) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.Server.AgentServer` + +## Source + +[`src/SignalWire/Server/AgentServer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs) + +Line 104. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/unregister-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/unregister-string.mdx new file mode 100644 index 0000000000..6c1aab9a76 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/agent-server/unregister-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.server/agent-server/unregister-string" +title: "Unregister(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Server.AgentServer.Unregister(string)" + parent: "SignalWire.Server.AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs" + visibility: "public" +--- +# `Unregister(string)` + +## Signature + +```dotnet +public AgentServer Unregister(string route) +``` + +## Parameters + + + +## Returns + +`SignalWire.Server.AgentServer` + +## Source + +[`src/SignalWire/Server/AgentServer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Server/AgentServer.cs) + +Line 73. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.server/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.server/index.mdx new file mode 100644 index 0000000000..45ee19e406 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.server/index.mdx @@ -0,0 +1,20 @@ +--- +slug: "/reference/dotnet/signal-wire.server" +title: "SignalWire.Server" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.Server" +--- +# `SignalWire.Server` + +## Classes + + + + Multi-agent HTTP server. Registers agents at routes, dispatches requests by longest prefix match, serves static files with path-traversal protection, handles health/ready/root-index, and supports SIP routing. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/detect.mdx b/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/detect.mdx new file mode 100644 index 0000000000..bf0788a366 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/detect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.serverless/adapter/detect" +title: "Detect()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Serverless.Adapter.Detect()" + parent: "SignalWire.Serverless.Adapter" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Serverless/Adapter.cs" + visibility: "public" +--- +# `Detect()` + +Detect the current runtime environment. + +**Modifiers:** `static` + +## Signature + +```dotnet +public static string Detect() +``` + +## Returns + +`string` — One of "lambda", "gcf", "azure", "cgi", or "server". + +## Source + +[`src/SignalWire/Serverless/Adapter.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Serverless/Adapter.cs) + +Line 21. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/handle-azure-service-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/handle-azure-service-dictionary-string-object.mdx new file mode 100644 index 0000000000..75d2362d08 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/handle-azure-service-dictionary-string-object.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.serverless/adapter/handle-azure-service-dictionary-string-object" +title: "HandleAzure(Service, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Serverless.Adapter.HandleAzure(SignalWire.SWML.Service, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Serverless.Adapter" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Serverless/Adapter.cs" + visibility: "public" +--- +# `HandleAzure(Service, Dictionary)` + +Handle an Azure Functions invocation. + +Extracts method, path, headers, and body from the Azure request +dictionary, calls agent.HandleRequest(), and returns an Azure-compatible +response dictionary. + +**Modifiers:** `static` + +## Signature + +```dotnet +public static Dictionary HandleAzure(Service agent, Dictionary request) +``` + +## Parameters + + + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Serverless/Adapter.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Serverless/Adapter.cs) + +Line 104. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/handle-lambda-service-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/handle-lambda-service-dictionary-string-object.mdx new file mode 100644 index 0000000000..36633c31fd --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/handle-lambda-service-dictionary-string-object.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.serverless/adapter/handle-lambda-service-dictionary-string-object" +title: "HandleLambda(Service, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Serverless.Adapter.HandleLambda(SignalWire.SWML.Service, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Serverless.Adapter" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Serverless/Adapter.cs" + visibility: "public" +--- +# `HandleLambda(Service, Dictionary)` + +Handle an AWS Lambda (API Gateway) invocation. + +Extracts method, path, headers, and body from the API Gateway event +format, calls agent.HandleRequest(), and returns an API Gateway +compatible response. + +**Modifiers:** `static` + +## Signature + +```dotnet +public static Dictionary HandleLambda(Service agent, Dictionary lambdaEvent) +``` + +## Parameters + + + An object with a HandleRequest method (AgentBase or Service). + + + + The API Gateway event payload as a dictionary. + + +## Returns + +`Dictionary` — API Gateway response: statusCode, headers, body. + +## Source + +[`src/SignalWire/Serverless/Adapter.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Serverless/Adapter.cs) + +Line 53. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/index.mdx new file mode 100644 index 0000000000..fa70b12def --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/dotnet/signal-wire.serverless/adapter" +title: "Adapter" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Serverless.Adapter" + parent: "SignalWire.Serverless" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Serverless/Adapter.cs" + visibility: "public" +--- +# `Adapter` + +Auto-detect and handle serverless environments (Lambda, Azure, GCF, CGI) +or fall back to the built-in ASP.NET server. + +**Modifiers:** `static` + +## Signature + +```dotnet +public static class Adapter +``` + +## Methods + + + + Detect the current runtime environment. + + + + Handle an Azure Functions invocation. Extracts method, path, headers, and body from the Azure request dictionary, calls agent.HandleRequest(), and returns an Azure-compatible response dictionary. + + + + Handle an AWS Lambda (API Gateway) invocation. Extracts method, path, headers, and body from the API Gateway event format, calls agent.HandleRequest(), and returns an API Gateway compatible response. + + + + Auto-detect the runtime environment and serve the agent. For serverless environments, reads from stdin and dispatches to the appropriate handler. For "server", calls agent.Run(). + + + +## Source + +[`src/SignalWire/Serverless/Adapter.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Serverless/Adapter.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/serve-dynamic.mdx b/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/serve-dynamic.mdx new file mode 100644 index 0000000000..4b801d0bb8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.serverless/adapter/serve-dynamic.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.serverless/adapter/serve-dynamic" +title: "Serve(dynamic)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Serverless.Adapter.Serve(dynamic)" + parent: "SignalWire.Serverless.Adapter" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Serverless/Adapter.cs" + visibility: "public" +--- +# `Serve(dynamic)` + +Auto-detect the runtime environment and serve the agent. + +For serverless environments, reads from stdin and dispatches +to the appropriate handler. For "server", calls agent.Run(). + +**Modifiers:** `static` + +## Signature + +```dotnet +public static void Serve(dynamic agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Serverless/Adapter.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Serverless/Adapter.cs) + +Line 160. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.serverless/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.serverless/index.mdx new file mode 100644 index 0000000000..639f3c1cb4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.serverless/index.mdx @@ -0,0 +1,20 @@ +--- +slug: "/reference/dotnet/signal-wire.serverless" +title: "SignalWire.Serverless" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.Serverless" +--- +# `SignalWire.Serverless` + +## Classes + + + + Auto-detect and handle serverless environments (Lambda, Azure, GCF, CGI) or fall back to the built-in ASP.NET server. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill/index.mdx new file mode 100644 index 0000000000..e2ed6b0551 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill" +title: "ApiNinjasTriviaSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ApiNinjasTriviaSkill.cs" + visibility: "public" +--- +# `ApiNinjasTriviaSkill` + +Get trivia questions from API Ninjas (DataMap). + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class ApiNinjasTriviaSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + + + +## Methods + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/ApiNinjasTriviaSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ApiNinjasTriviaSkill.cs) + +Line 6. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..7d96bf5d1f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ApiNinjasTriviaSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/ApiNinjasTriviaSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ApiNinjasTriviaSkill.cs) + +Line 24. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..191e8e0255 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/api-ninjas-trivia-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ApiNinjasTriviaSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/ApiNinjasTriviaSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ApiNinjasTriviaSkill.cs) + +Line 19. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-hints.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-hints.mdx new file mode 100644 index 0000000000..8e3f56c00d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-hints" +title: "GetHints()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.ClaudeSkillsSkill.GetHints()" + parent: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs" + visibility: "public" +--- +# `GetHints()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List GetHints() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs) + +Line 318. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-instance-key.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-instance-key.mdx new file mode 100644 index 0000000000..5ae79e3908 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-instance-key.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-instance-key" +title: "GetInstanceKey()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.ClaudeSkillsSkill.GetInstanceKey()" + parent: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs" + visibility: "public" +--- +# `GetInstanceKey()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override string GetInstanceKey() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs) + +Line 355. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..c648260eb7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.ClaudeSkillsSkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs) + +Line 332. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/index.mdx new file mode 100644 index 0000000000..6ef0ed8c54 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/claude-skills-skill" +title: "ClaudeSkillsSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs" + visibility: "public" +--- +# `ClaudeSkillsSkill` + +Load Claude SKILL.md files as agent tools. + +Mirrors signalwire-python's <code>signalwire.skills.claude\_skills.skill</code>. +At setup time, the skill walks <code>skills\_path</code> for child directories +containing <code>SKILL.md</code>; each such file is parsed for YAML +frontmatter (the bit between two <code>---</code> lines) plus a markdown +body. Each loaded skill becomes one SWAIG tool whose handler returns +the body with three substitutions: + +<ul><li><code>$ARGUMENTS</code> / <code>$ARGUMENTS[N]</code> / <code>$N</code> — the + <code>arguments</code> string passed to the tool, optionally split into + positional pieces by whitespace.</li><li><code>${CLAUDE_SKILL_DIR}</code> — absolute path to the skill's + directory.</li><li><code>${CLAUDE_SESSION_ID}</code> — call id from raw_data.</li></ul> + +The full Python implementation also runs a frontmatter-driven invocation +gate (skip-tool / skip-prompt), tolerates supporting reference sections, +and offers an opt-in shell-injection preprocessor (<code>!`cmd`</code>). The +.NET port ships the discovery/parse/handler core; the optional shell +preprocessor is left out by design (set <code>allow\_shell\_injection</code> +to a no-op — the surface is preserved for future expansion). + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class ClaudeSkillsSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + + + +## Methods + + + + + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs) + +Line 33. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..a3928831ba --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.ClaudeSkillsSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs) + +Line 82. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..dcee59fba6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/claude-skills-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.ClaudeSkillsSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/ClaudeSkillsSkill.cs) + +Line 51. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/custom-skills-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/custom-skills-skill/index.mdx new file mode 100644 index 0000000000..731df40d51 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/custom-skills-skill/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/custom-skills-skill" +title: "CustomSkillsSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.CustomSkillsSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/CustomSkillsSkill.cs" + visibility: "public" +--- +# `CustomSkillsSkill` + +Register user-defined custom tools. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class CustomSkillsSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + + + +## Methods + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/CustomSkillsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/CustomSkillsSkill.cs) + +Line 6. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/custom-skills-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/custom-skills-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..d18427b39c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/custom-skills-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/custom-skills-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.CustomSkillsSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.CustomSkillsSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/CustomSkillsSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/CustomSkillsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/CustomSkillsSkill.cs) + +Line 14. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/custom-skills-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/custom-skills-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..7ac6d0fdf6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/custom-skills-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/custom-skills-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.CustomSkillsSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.CustomSkillsSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/CustomSkillsSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/CustomSkillsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/CustomSkillsSkill.cs) + +Line 12. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/get-global-data.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/get-global-data.mdx new file mode 100644 index 0000000000..858483ec87 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/get-global-data" +title: "GetGlobalData()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatasphereServerlessSkill.GetGlobalData()" + parent: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs" + visibility: "public" +--- +# `GetGlobalData()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Dictionary GetGlobalData() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs) + +Line 105. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..1f33ff5f69 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatasphereServerlessSkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs) + +Line 112. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/index.mdx new file mode 100644 index 0000000000..0278e118ac --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill" +title: "DatasphereServerlessSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs" + visibility: "public" +--- +# `DatasphereServerlessSkill` + +Search knowledge using SignalWire DataSphere with serverless DataMap execution. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class DatasphereServerlessSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs) + +Line 7. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..a8022714bc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatasphereServerlessSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs) + +Line 24. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..cccf3f2d33 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datasphere-serverless-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatasphereServerlessSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereServerlessSkill.cs) + +Line 13. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/get-global-data.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/get-global-data.mdx new file mode 100644 index 0000000000..3494c0b5e0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datasphere-skill/get-global-data" +title: "GetGlobalData()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatasphereSkill.GetGlobalData()" + parent: "SignalWire.Skills.Builtin.DatasphereSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereSkill.cs" + visibility: "public" +--- +# `GetGlobalData()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Dictionary GetGlobalData() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Skills/Builtin/DatasphereSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereSkill.cs) + +Line 174. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..f8012a4e7b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datasphere-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatasphereSkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.DatasphereSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereSkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/DatasphereSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereSkill.cs) + +Line 181. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/index.mdx new file mode 100644 index 0000000000..4cad43f9bb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datasphere-skill" +title: "DatasphereSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatasphereSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereSkill.cs" + visibility: "public" +--- +# `DatasphereSkill` + +SignalWire DataSphere knowledge-base search skill. + +Mirrors signalwire-python's <code>signalwire.skills.datasphere.skill</code>. +POSTs a JSON body to <code>https://\.signalwire.com +/api/datasphere/documents/search</code> with HTTP Basic auth +(project\_id : token). Real DataSphere returns matches under <code>chunks</code>; the porting-sdk audit fixture uses <code>results</code>; +accept either so the skill round-trips against the live API and the +offline audit alike (matching the precedent already in Java/PHP/Perl/ +Rust). + +Upstream URL override: <code>DATASPHERE\_BASE\_URL</code>. Path <code>/api/datasphere/documents/search</code> is preserved. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class DatasphereSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/DatasphereSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereSkill.cs) + +Line 22. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..cf404cb294 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datasphere-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatasphereSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.DatasphereSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/DatasphereSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereSkill.cs) + +Line 41. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..a0e9cf974b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datasphere-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datasphere-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatasphereSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.DatasphereSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/DatasphereSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatasphereSkill.cs) + +Line 30. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..29d41daa70 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datetime-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatetimeSkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.DatetimeSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatetimeSkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/DatetimeSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatetimeSkill.cs) + +Line 76. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/index.mdx new file mode 100644 index 0000000000..16fa513925 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datetime-skill" +title: "DatetimeSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatetimeSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatetimeSkill.cs" + visibility: "public" +--- +# `DatetimeSkill` + +Get current date, time, and timezone information. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class DatetimeSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/DatetimeSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatetimeSkill.cs) + +Line 6. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..dda2c422b0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datetime-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatetimeSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.DatetimeSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatetimeSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/DatetimeSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatetimeSkill.cs) + +Line 13. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..27057f25d6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/datetime-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/datetime-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.DatetimeSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.DatetimeSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatetimeSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/DatetimeSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/DatetimeSkill.cs) + +Line 11. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/get-hints.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/get-hints.mdx new file mode 100644 index 0000000000..59228a5797 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/google-maps-skill/get-hints" +title: "GetHints()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.GoogleMapsSkill.GetHints()" + parent: "SignalWire.Skills.Builtin.GoogleMapsSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs" + visibility: "public" +--- +# `GetHints()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List GetHints() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs) + +Line 115. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..1203e58722 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/google-maps-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.GoogleMapsSkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.GoogleMapsSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs) + +Line 118. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/index.mdx new file mode 100644 index 0000000000..546cd43a3c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/google-maps-skill" +title: "GoogleMapsSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.GoogleMapsSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs" + visibility: "public" +--- +# `GoogleMapsSkill` + +Validate addresses and compute driving routes using Google Maps (DataMap). + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class GoogleMapsSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs) + +Line 6. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..1ac6a68ef6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/google-maps-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.GoogleMapsSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.GoogleMapsSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs) + +Line 16. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..5fabb379b2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/google-maps-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/google-maps-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.GoogleMapsSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.GoogleMapsSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/GoogleMapsSkill.cs) + +Line 11. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/index.mdx new file mode 100644 index 0000000000..f831d05014 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/index.mdx @@ -0,0 +1,88 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin" +title: "SignalWire.Skills.Builtin" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin" +--- +# `SignalWire.Skills.Builtin` + +## Classes + + + + Get trivia questions from API Ninjas (DataMap). + + + + Load Claude SKILL.md files as agent tools. Mirrors signalwire-python's <code>signalwire.skills.claude\_skills.skill</code>. At setup time, the skill walks <code>skills\_path</code> for child directories containing <code>SKILL.md</code>; each such file is parsed for YAML frontmatter (the bit between two <code>---</code> lines) plus a markdown body. Each loaded skill becomes one SWAIG tool whose handler returns the body with three substitutions: <ul><li><code>$ARGUMENTS</code> / <code>$ARGUMENTS\[N]</code> / <code>$N</code> — the <code>arguments</code> string passed to the tool, optionally split into positional pieces by whitespace.</li><li><code>$\{CLAUDE\_SKILL\_DIR\}</code> — absolute path to the skill's directory.</li><li><code>$\{CLAUDE\_SESSION\_ID\}</code> — call id from raw\_data.</li></ul> The full Python implementation also runs a frontmatter-driven invocation gate (skip-tool / skip-prompt), tolerates supporting reference sections, and offers an opt-in shell-injection preprocessor (<code>!`cmd`</code>). The .NET port ships the discovery/parse/handler core; the optional shell preprocessor is left out by design (set <code>allow\_shell\_injection</code> to a no-op — the surface is preserved for future expansion). + + + + Register user-defined custom tools. + + + + Search knowledge using SignalWire DataSphere with serverless DataMap execution. + + + + SignalWire DataSphere knowledge-base search skill. Mirrors signalwire-python's <code>signalwire.skills.datasphere.skill</code>. POSTs a JSON body to <code>https://\.signalwire.com /api/datasphere/documents/search</code> with HTTP Basic auth (project\_id : token). Real DataSphere returns matches under <code>chunks</code>; the porting-sdk audit fixture uses <code>results</code>; accept either so the skill round-trips against the live API and the offline audit alike (matching the precedent already in Java/PHP/Perl/ Rust). Upstream URL override: <code>DATASPHERE\_BASE\_URL</code>. Path <code>/api/datasphere/documents/search</code> is preserved. + + + + Get current date, time, and timezone information. + + + + Validate addresses and compute driving routes using Google Maps (DataMap). + + + + Gather answers to a configurable list of questions. + + + + Tell jokes using the API Ninjas joke API (DataMap). + + + + Perform basic mathematical calculations. + + + + Bridge MCP (Model Context Protocol) servers with SWAIG functions. Mirrors signalwire-python's <code>signalwire.skills.mcp\_gateway.skill</code>. Each configured service gets one or more SWAIG tools whose handler POSTs to the gateway with the tool name, arguments, and per-call session id (derived from <code>raw\_data.global\_data.mcp\_call\_id</code> if present, else <code>raw\_data.call\_id</code>). Auth: <code>auth\_token</code> (Bearer) or <code>auth\_user</code>/<code>auth\_password</code> (Basic). The skill prefers Bearer when both are configured. Endpoint shape: <code>POST \/services/\/call</code> per the Python implementation. Audit fixtures point <code>gateway\_url</code> at a loopback URL via the per-skill convention. + + + + Vector / keyword similarity search. Mirrors signalwire-python's <code>signalwire.skills.native\_vector\_search.skill</code> in <strong>remote mode only</strong>. Local-mode SQLite/pgvector indexing relies on Python-only deps (sentence-transformers, FAISS, pgvector) and is not portable to the .NET BCL — recorded in <code>PORT\_OMISSIONS.md</code>. The remote mode POSTs the query to the configured search server, which returns a real-shape response the audit verifies on the wire. The handler reads <code>remote\_url</code> from skill params; the audit fixture sets it to a loopback URL so the SDK exercises the real transport against canned bytes. + + + + Control background file playback (DataMap). + + + + Web scraping / crawling skill. Mirrors signalwire-python's <code>signalwire.skills.spider.skill</code>. The Python implementation uses lxml + BeautifulSoup for selector-based extraction; the .NET port ships a faithful HTTP fetch + regex-based HTML stripping (script/style removal, tag removal, whitespace collapse, smart truncation). That covers the canonical <code>fast\_text</code> / <code>clean\_text</code> path the audit exercises; selector-driven structured extraction can be layered on later. Upstream URL override: <code>SPIDER\_BASE\_URL</code>. The skill rewrites the fetch host while preserving the requested URL's path + query so the audit fixture sees the documented page on the wire. + + + + Transfer calls between agents based on pattern matching (DataMap). + + + + Get current weather information from WeatherAPI.com (DataMap). + + + + Web search skill backed by Google Custom Search. Mirrors signalwire-python's <code>signalwire.skills.web\_search.skill</code> (the <code>WebSearchSkill.search\_and\_scrape\_best</code> path). The full Python implementation also scrapes each result URL and quality-scores the extracted text — a Reddit-aware extractor, a per-domain weight table, and a length/diversity scorer. The .NET port ships the search call faithfully and falls back to formatted titles+snippets when the per-result scrape isn't requested. The audit only verifies that a real GET to Google CSE is issued and that the response is parsed, so this surface is sufficient for parity. Per-result scraping can be layered on top without breaking the audit contract. Upstream URL override: <code>WEB\_SEARCH\_BASE\_URL</code> (used by audit\_skills\_dispatch.py to point at a local fixture). When set, the URL is rewritten to the override host while the path <code>/customsearch/v1</code> is preserved. + + + + Wikipedia search skill backed by the public Wikipedia REST API. Mirrors signalwire-python's <code>signalwire.skills.wikipedia\_search.skill</code>. The Python skill makes two API calls per query — first <code>action=query\&list=search</code> to find article titles, then <code>action=query\&prop=extracts</code> to fetch each article's intro extract. Returns the article(s) as <code>**Title**\n\nExtract</code> joined by separators. Upstream URL override: <code>WIKIPEDIA\_BASE\_URL</code>. Path <code>/w/api.php</code> is preserved when the env var is set so the audit fixture sees the documented Wikipedia API path on the wire. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/get-global-data.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/get-global-data.mdx new file mode 100644 index 0000000000..a987642c6b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/get-global-data" +title: "GetGlobalData()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.InfoGathererSkill.GetGlobalData()" + parent: "SignalWire.Skills.Builtin.InfoGathererSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/InfoGathererSkill.cs" + visibility: "public" +--- +# `GetGlobalData()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Dictionary GetGlobalData() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Skills/Builtin/InfoGathererSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/InfoGathererSkill.cs) + +Line 101. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..d81905b083 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.InfoGathererSkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.InfoGathererSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/InfoGathererSkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/InfoGathererSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/InfoGathererSkill.cs) + +Line 117. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/index.mdx new file mode 100644 index 0000000000..524a3e6808 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill" +title: "InfoGathererSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.InfoGathererSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/InfoGathererSkill.cs" + visibility: "public" +--- +# `InfoGathererSkill` + +Gather answers to a configurable list of questions. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class InfoGathererSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/InfoGathererSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/InfoGathererSkill.cs) + +Line 6. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..d0b1b03b65 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.InfoGathererSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.InfoGathererSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/InfoGathererSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/InfoGathererSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/InfoGathererSkill.cs) + +Line 17. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..65ca420496 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/info-gatherer-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.InfoGathererSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.InfoGathererSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/InfoGathererSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/InfoGathererSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/InfoGathererSkill.cs) + +Line 12. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/get-global-data.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/get-global-data.mdx new file mode 100644 index 0000000000..2f9747294c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/joke-skill/get-global-data" +title: "GetGlobalData()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.JokeSkill.GetGlobalData()" + parent: "SignalWire.Skills.Builtin.JokeSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/JokeSkill.cs" + visibility: "public" +--- +# `GetGlobalData()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Dictionary GetGlobalData() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Skills/Builtin/JokeSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/JokeSkill.cs) + +Line 66. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..57fef837dc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/joke-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.JokeSkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.JokeSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/JokeSkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/JokeSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/JokeSkill.cs) + +Line 69. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/index.mdx new file mode 100644 index 0000000000..693b781fa5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/joke-skill" +title: "JokeSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.JokeSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/JokeSkill.cs" + visibility: "public" +--- +# `JokeSkill` + +Tell jokes using the API Ninjas joke API (DataMap). + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class JokeSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/JokeSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/JokeSkill.cs) + +Line 6. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..f8258540d0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/joke-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.JokeSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.JokeSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/JokeSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/JokeSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/JokeSkill.cs) + +Line 16. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..8fa346dfd3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/joke-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/joke-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.JokeSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.JokeSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/JokeSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/JokeSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/JokeSkill.cs) + +Line 11. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..edd7ab073d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/math-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.MathSkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.MathSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/MathSkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/MathSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/MathSkill.cs) + +Line 86. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/index.mdx new file mode 100644 index 0000000000..188a8ac166 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/math-skill" +title: "MathSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.MathSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/obj/Release/net8.0/System.Text.RegularExpressions.Generator/System.Text.RegularExpressions.Generator.RegexGenerator/RegexGenerator.g.cs" + visibility: "public" +--- +# `MathSkill` + +Perform basic mathematical calculations. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class MathSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/obj/Release/net8.0/System.Text.RegularExpressions.Generator/System.Text.RegularExpressions.Generator.RegexGenerator/RegexGenerator.g.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/obj/Release/net8.0/System.Text.RegularExpressions.Generator/System.Text.RegularExpressions.Generator.RegexGenerator/RegexGenerator.g.cs) + +Line 31. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..f83454e63a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/math-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.MathSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.MathSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/MathSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/MathSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/MathSkill.cs) + +Line 17. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..25d622cb74 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/math-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/math-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.MathSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.MathSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/MathSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/MathSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/MathSkill.cs) + +Line 15. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-global-data.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-global-data.mdx new file mode 100644 index 0000000000..a6e3092667 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-global-data" +title: "GetGlobalData()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.McpGatewaySkill.GetGlobalData()" + parent: "SignalWire.Skills.Builtin.McpGatewaySkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs" + visibility: "public" +--- +# `GetGlobalData()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Dictionary GetGlobalData() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Skills/Builtin/McpGatewaySkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs) + +Line 249. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-hints.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-hints.mdx new file mode 100644 index 0000000000..9b2e07b714 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-hints" +title: "GetHints()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.McpGatewaySkill.GetHints()" + parent: "SignalWire.Skills.Builtin.McpGatewaySkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs" + visibility: "public" +--- +# `GetHints()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List GetHints() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Skills/Builtin/McpGatewaySkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs) + +Line 234. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..e7413dc0fb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.McpGatewaySkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.McpGatewaySkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/McpGatewaySkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs) + +Line 268. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/index.mdx new file mode 100644 index 0000000000..b8952d98c5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill" +title: "McpGatewaySkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.McpGatewaySkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs" + visibility: "public" +--- +# `McpGatewaySkill` + +Bridge MCP (Model Context Protocol) servers with SWAIG functions. + +Mirrors signalwire-python's <code>signalwire.skills.mcp\_gateway.skill</code>. +Each configured service gets one or more SWAIG tools whose handler +POSTs to the gateway with the tool name, arguments, and per-call +session id (derived from <code>raw\_data.global\_data.mcp\_call\_id</code> if +present, else <code>raw\_data.call\_id</code>). + +Auth: <code>auth\_token</code> (Bearer) or <code>auth\_user</code>/<code>auth\_password</code> +(Basic). The skill prefers Bearer when both are configured. + +Endpoint shape: <code>POST \/services/\/call</code> +per the Python implementation. Audit fixtures point <code>gateway\_url</code> +at a loopback URL via the per-skill convention. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class McpGatewaySkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + +## Methods + + + + + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/McpGatewaySkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs) + +Line 22. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..eafcf55a2e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.McpGatewaySkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.McpGatewaySkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/McpGatewaySkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs) + +Line 32. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..f70c46b1d6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/mcp-gateway-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.McpGatewaySkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.McpGatewaySkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/McpGatewaySkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/McpGatewaySkill.cs) + +Line 27. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/get-hints.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/get-hints.mdx new file mode 100644 index 0000000000..520edbf1ba --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/get-hints" +title: "GetHints()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.NativeVectorSearchSkill.GetHints()" + parent: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs" + visibility: "public" +--- +# `GetHints()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List GetHints() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs) + +Line 194. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/index.mdx new file mode 100644 index 0000000000..6d1516675e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill" +title: "NativeVectorSearchSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs" + visibility: "public" +--- +# `NativeVectorSearchSkill` + +Vector / keyword similarity search. + +Mirrors signalwire-python's <code>signalwire.skills.native\_vector\_search.skill</code> +in <strong>remote mode only</strong>. Local-mode SQLite/pgvector +indexing relies on Python-only deps (sentence-transformers, FAISS, +pgvector) and is not portable to the .NET BCL — recorded in <code>PORT\_OMISSIONS.md</code>. The remote mode POSTs the query to the +configured search server, which returns a real-shape response the +audit verifies on the wire. + +The handler reads <code>remote\_url</code> from skill params; the audit +fixture sets it to a loopback URL so the SDK exercises the real +transport against canned bytes. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class NativeVectorSearchSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + + + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs) + +Line 22. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..c05d731125 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.NativeVectorSearchSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs) + +Line 30. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..5964b4342a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/native-vector-search-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.NativeVectorSearchSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/NativeVectorSearchSkill.cs) + +Line 28. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/play-background-file-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/play-background-file-skill/index.mdx new file mode 100644 index 0000000000..dd571297a9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/play-background-file-skill/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/play-background-file-skill" +title: "PlayBackgroundFileSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/PlayBackgroundFileSkill.cs" + visibility: "public" +--- +# `PlayBackgroundFileSkill` + +Control background file playback (DataMap). + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class PlayBackgroundFileSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + + + +## Methods + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/PlayBackgroundFileSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/PlayBackgroundFileSkill.cs) + +Line 6. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/play-background-file-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/play-background-file-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..7e36686541 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/play-background-file-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/play-background-file-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/PlayBackgroundFileSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/PlayBackgroundFileSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/PlayBackgroundFileSkill.cs) + +Line 17. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/play-background-file-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/play-background-file-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..64dfbe256b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/play-background-file-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/play-background-file-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/PlayBackgroundFileSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/PlayBackgroundFileSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/PlayBackgroundFileSkill.cs) + +Line 12. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/get-hints.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/get-hints.mdx new file mode 100644 index 0000000000..d734fa042b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/spider-skill/get-hints" +title: "GetHints()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.SpiderSkill.GetHints()" + parent: "SignalWire.Skills.Builtin.SpiderSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SpiderSkill.cs" + visibility: "public" +--- +# `GetHints()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List GetHints() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Skills/Builtin/SpiderSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SpiderSkill.cs) + +Line 245. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/index.mdx new file mode 100644 index 0000000000..c04a754cb5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/spider-skill" +title: "SpiderSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.SpiderSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SpiderSkill.cs" + visibility: "public" +--- +# `SpiderSkill` + +Web scraping / crawling skill. + +Mirrors signalwire-python's <code>signalwire.skills.spider.skill</code>. The +Python implementation uses lxml + BeautifulSoup for selector-based +extraction; the .NET port ships a faithful HTTP fetch + regex-based +HTML stripping (script/style removal, tag removal, whitespace +collapse, smart truncation). That covers the canonical <code>fast\_text</code> / <code>clean\_text</code> path the audit exercises; +selector-driven structured extraction can be layered on later. + +Upstream URL override: <code>SPIDER\_BASE\_URL</code>. The skill rewrites the +fetch host while preserving the requested URL's path + query so the +audit fixture sees the documented page on the wire. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class SpiderSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + + + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/SpiderSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SpiderSkill.cs) + +Line 22. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..62cf17e7ea --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/spider-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.SpiderSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.SpiderSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SpiderSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/SpiderSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SpiderSkill.cs) + +Line 38. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..6b483b975c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/spider-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/spider-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.SpiderSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.SpiderSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SpiderSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/SpiderSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SpiderSkill.cs) + +Line 36. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/get-hints.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/get-hints.mdx new file mode 100644 index 0000000000..dec5e321eb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/get-hints" +title: "GetHints()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.SwmlTransferSkill.GetHints()" + parent: "SignalWire.Skills.Builtin.SwmlTransferSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs" + visibility: "public" +--- +# `GetHints()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List GetHints() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs) + +Line 108. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..e43b6fbd6c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.SwmlTransferSkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.SwmlTransferSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs) + +Line 126. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/index.mdx new file mode 100644 index 0000000000..93b7dc3db3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill" +title: "SwmlTransferSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.SwmlTransferSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs" + visibility: "public" +--- +# `SwmlTransferSkill` + +Transfer calls between agents based on pattern matching (DataMap). + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class SwmlTransferSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs) + +Line 7. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..6cbdb74be7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.SwmlTransferSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.SwmlTransferSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs) + +Line 18. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..29e444ecf6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/swml-transfer-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.SwmlTransferSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.SwmlTransferSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/SwmlTransferSkill.cs) + +Line 13. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/weather-api-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/weather-api-skill/index.mdx new file mode 100644 index 0000000000..7f3e6ea56d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/weather-api-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/weather-api-skill" +title: "WeatherApiSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WeatherApiSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WeatherApiSkill.cs" + visibility: "public" +--- +# `WeatherApiSkill` + +Get current weather information from WeatherAPI.com (DataMap). + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class WeatherApiSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/WeatherApiSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WeatherApiSkill.cs) + +Line 6. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/weather-api-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/weather-api-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..3853c0e696 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/weather-api-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/weather-api-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WeatherApiSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.WeatherApiSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WeatherApiSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/WeatherApiSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WeatherApiSkill.cs) + +Line 16. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/weather-api-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/weather-api-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..f5ae4eac93 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/weather-api-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/weather-api-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WeatherApiSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.WeatherApiSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WeatherApiSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/WeatherApiSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WeatherApiSkill.cs) + +Line 11. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/get-global-data.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..97a883c11d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/web-search-skill/get-global-data" +title: "GetGlobalData()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WebSearchSkill.GetGlobalData()" + parent: "SignalWire.Skills.Builtin.WebSearchSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WebSearchSkill.cs" + visibility: "public" +--- +# `GetGlobalData()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override Dictionary GetGlobalData() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Skills/Builtin/WebSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WebSearchSkill.cs) + +Line 167. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..493d4881dc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/web-search-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WebSearchSkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.WebSearchSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WebSearchSkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/WebSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WebSearchSkill.cs) + +Line 174. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/index.mdx new file mode 100644 index 0000000000..df3e426c39 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/web-search-skill" +title: "WebSearchSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WebSearchSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WebSearchSkill.cs" + visibility: "public" +--- +# `WebSearchSkill` + +Web search skill backed by Google Custom Search. + +Mirrors signalwire-python's <code>signalwire.skills.web\_search.skill</code> +(the <code>WebSearchSkill.search\_and\_scrape\_best</code> path). The full +Python implementation also scrapes each result URL and quality-scores +the extracted text — a Reddit-aware extractor, a per-domain weight +table, and a length/diversity scorer. The .NET port ships the search +call faithfully and falls back to formatted titles+snippets when the +per-result scrape isn't requested. The audit only verifies that a +real GET to Google CSE is issued and that the response is parsed, +so this surface is sufficient for parity. Per-result scraping can be +layered on top without breaking the audit contract. + +Upstream URL override: <code>WEB\_SEARCH\_BASE\_URL</code> (used by +audit\_skills\_dispatch.py to point at a local fixture). When set, the +URL is rewritten to the override host while the path <code>/customsearch/v1</code> is preserved. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class WebSearchSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + + + + + +## Methods + + + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/WebSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WebSearchSkill.cs) + +Line 26. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..2e01a0d32e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/web-search-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WebSearchSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.WebSearchSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WebSearchSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/WebSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WebSearchSkill.cs) + +Line 42. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..7058107fb3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/web-search-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/web-search-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WebSearchSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.WebSearchSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WebSearchSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/WebSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WebSearchSkill.cs) + +Line 36. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..8501f81d9b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WikipediaSearchSkill.GetPromptSections()" + parent: "SignalWire.Skills.Builtin.WikipediaSearchSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs) + +Line 161. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/index.mdx new file mode 100644 index 0000000000..1c82fa8ede --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill" +title: "WikipediaSearchSkill" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WikipediaSearchSkill" + parent: "SignalWire.Skills.Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs" + visibility: "public" +--- +# `WikipediaSearchSkill` + +Wikipedia search skill backed by the public Wikipedia REST API. + +Mirrors signalwire-python's <code>signalwire.skills.wikipedia\_search.skill</code>. +The Python skill makes two API calls per query — first <code>action=query\&list=search</code> to find article titles, then <code>action=query\&prop=extracts</code> to fetch each article's intro +extract. Returns the article(s) as <code>**Title**\n\nExtract</code> joined +by separators. + +Upstream URL override: <code>WIKIPEDIA\_BASE\_URL</code>. Path <code>/w/api.php</code> is preserved when the env var is set so the audit +fixture sees the documented Wikipedia API path on the wire. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class WikipediaSearchSkill : SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire.Skills.SkillBase](/reference/dotnet/signal-wire.skills/skill-base) + +## Properties + + + + + +## Methods + + + + + + + + + +## Source + +[`src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs) + +Line 21. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/register-tools-agent-base.mdx new file mode 100644 index 0000000000..114fb4bdbb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WikipediaSearchSkill.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.Builtin.WikipediaSearchSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs) + +Line 31. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..3ef1039407 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills.builtin/wikipedia-search-skill/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.Builtin.WikipediaSearchSkill.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.Builtin.WikipediaSearchSkill" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `override` + +## Signature + +```dotnet +public override bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/Builtin/WikipediaSearchSkill.cs) + +Line 29. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/index.mdx new file mode 100644 index 0000000000..29f9ee9bc8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/dotnet/signal-wire.skills" +title: "SignalWire.Skills" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.Skills" +--- +# `SignalWire.Skills` + +## Classes + + + + Abstract base class for all skills. Provides lifecycle hooks, tool registration, hint/globalData/prompt merging, and a <xref href="SignalWire.Skills.SkillBase.DefineTool(System.String%2cSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d%2cSystem.Func%7bSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d%2cSignalWire.SWAIG.FunctionResult%7d)" data-throw-if-not-resolved="false"></xref> helper that delegates to the owning agent. + + + + Loads, unloads, and queries skills on behalf of an <xref href="SignalWire.Agent.AgentBase" data-throw-if-not-resolved="false"></xref>. Validates env vars, calls Setup/RegisterTools, and merges hints/globalData/prompts. + + + + Thread-safe singleton that maps snake\_case skill names to factory delegates. All 18 built-in skills are registered lazily on first access. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/cleanup.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/cleanup.mdx new file mode 100644 index 0000000000..cf6788437c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/cleanup.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/cleanup" +title: "Cleanup()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.Cleanup()" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "public" +--- +# `Cleanup()` + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual void Cleanup() +``` + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 84. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/define-tool-string-string-dictionary-string-object-func-dictionary-string-object-dictionary-string-object-function-result.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/define-tool-string-string-dictionary-string-object-func-dictionary-string-object-dictionary-string-object-function-result.mdx new file mode 100644 index 0000000000..d9beb194f7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/define-tool-string-string-dictionary-string-object-func-dictionary-string-object-dictionary-string-object-function-result.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/define-tool-string-string-dictionary-string-object-func-dictionary-string-object-dictionary-string-object-function-result" +title: "DefineTool(string, string, Dictionary, Func, Dictionary, FunctionResult>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.DefineTool(string, string, System.Collections.Generic.Dictionary, System.Func, System.Collections.Generic.Dictionary, SignalWire.SWAIG.FunctionResult>)" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "protected" +--- +# `DefineTool(string, string, Dictionary, Func, Dictionary, FunctionResult>)` + +Convenience wrapper that merges swaig\_fields and delegates to +AgentBase.DefineTool. + +## Signature + +```dotnet +protected void DefineTool(string name, string description, Dictionary parameters, Func, Dictionary, FunctionResult> handler) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 127. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-global-data.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-global-data.mdx new file mode 100644 index 0000000000..072dcec725 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/get-global-data" +title: "GetGlobalData()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.GetGlobalData()" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "public" +--- +# `GetGlobalData()` + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Dictionary GetGlobalData() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 45. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-hints.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-hints.mdx new file mode 100644 index 0000000000..1ae5260f28 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/get-hints" +title: "GetHints()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.GetHints()" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "public" +--- +# `GetHints()` + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual List GetHints() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 43. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-instance-key.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-instance-key.mdx new file mode 100644 index 0000000000..2d5e719b28 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-instance-key.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/get-instance-key" +title: "GetInstanceKey()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.GetInstanceKey()" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "public" +--- +# `GetInstanceKey()` + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual string GetInstanceKey() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 33. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-parameter-schema.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-parameter-schema.mdx new file mode 100644 index 0000000000..2fb3138434 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-parameter-schema.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/get-parameter-schema" +title: "GetParameterSchema()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.GetParameterSchema()" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "public" +--- +# `GetParameterSchema()` + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Dictionary GetParameterSchema() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 56. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-prompt-sections.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-prompt-sections.mdx new file mode 100644 index 0000000000..3258c65ff2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/get-prompt-sections" +title: "GetPromptSections()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.GetPromptSections()" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "public" +--- +# `GetPromptSections()` + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual List> GetPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 47. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-tool-name-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-tool-name-string.mdx new file mode 100644 index 0000000000..6fa2bfd3df --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/get-tool-name-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/get-tool-name-string" +title: "GetToolName(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.GetToolName(string)" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "protected" +--- +# `GetToolName(string)` + +Return the tool name override from params, or <code class="paramref">defaultName</code>. + +## Signature + +```dotnet +protected string GetToolName(string defaultName) +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 147. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/index.mdx new file mode 100644 index 0000000000..6867b06339 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/index.mdx @@ -0,0 +1,86 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base" +title: "SkillBase" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase" + parent: "SignalWire.Skills" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "public" +--- +# `SkillBase` + +Abstract base class for all skills. Provides lifecycle hooks, tool registration, +hint/globalData/prompt merging, and a <xref href="SignalWire.Skills.SkillBase.DefineTool(System.String%2cSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d%2cSystem.Func%7bSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d%2cSignalWire.SWAIG.FunctionResult%7d)" data-throw-if-not-resolved="false"></xref> helper that +delegates to the owning agent. + +**Modifiers:** `abstract` + +## Signature + +```dotnet +public abstract class SkillBase +``` + +## Properties + + + + + + + + + + + + + Check whether prompt sections should be skipped. + + + + + + +## Methods + + + + + + Convenience wrapper that merges swaig\_fields and delegates to AgentBase.DefineTool. + + + + + + + + + + + + + + Return the tool name override from params, or <code class="paramref">defaultName</code>. + + + + + + + + + + + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 10. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/register-tools-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/register-tools-agent-base.mdx new file mode 100644 index 0000000000..e04b8db3a1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/register-tools-agent-base.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/register-tools-agent-base" +title: "RegisterTools(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.RegisterTools(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "public" +--- +# `RegisterTools(AgentBase)` + +**Modifiers:** `abstract` + +## Signature + +```dotnet +public abstract void RegisterTools(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 23. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/setup-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/setup-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..638e77cf7a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/setup-agent-base-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/setup-agent-base-dictionary-string-object" +title: "Setup(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.Setup(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "public" +--- +# `Setup(AgentBase, Dictionary)` + +**Modifiers:** `abstract` + +## Signature + +```dotnet +public abstract bool Setup(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 22. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/validate-env-vars.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/validate-env-vars.mdx new file mode 100644 index 0000000000..9db0cb4316 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/validate-env-vars" +title: "ValidateEnvVars()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.ValidateEnvVars()" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "public" +--- +# `ValidateEnvVars()` + +## Signature + +```dotnet +public List ValidateEnvVars() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 106. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/wire-agent-base-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/wire-agent-base-dictionary-string-object.mdx new file mode 100644 index 0000000000..e75ad062fa --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-base/wire-agent-base-dictionary-string-object.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-base/wire-agent-base-dictionary-string-object" +title: "Wire(AgentBase, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillBase.Wire(SignalWire.Agent.AgentBase, System.Collections.Generic.Dictionary)" + parent: "SignalWire.Skills.SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs" + visibility: "public" +--- +# `Wire(AgentBase, Dictionary)` + +## Signature + +```dotnet +public void Wire(AgentBase agent, Dictionary parameters) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/Skills/SkillBase.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillBase.cs) + +Line 164. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/get-skill-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/get-skill-string.mdx new file mode 100644 index 0000000000..e31cf83647 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/get-skill-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-manager/get-skill-string" +title: "GetSkill(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillManager.GetSkill(string)" + parent: "SignalWire.Skills.SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs" + visibility: "public" +--- +# `GetSkill(string)` + +## Signature + +```dotnet +public SkillBase? GetSkill(string key) +``` + +## Parameters + + + +## Returns + +`SignalWire.Skills.SkillBase` + +## Source + +[`src/SignalWire/Skills/SkillManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs) + +Line 127. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/has-skill-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/has-skill-string.mdx new file mode 100644 index 0000000000..979808aeb5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/has-skill-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-manager/has-skill-string" +title: "HasSkill(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillManager.HasSkill(string)" + parent: "SignalWire.Skills.SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs" + visibility: "public" +--- +# `HasSkill(string)` + +## Signature + +```dotnet +public bool HasSkill(string key) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/SkillManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs) + +Line 125. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/index.mdx new file mode 100644 index 0000000000..08e9448121 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-manager" +title: "SkillManager" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillManager" + parent: "SignalWire.Skills" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs" + visibility: "public" +--- +# `SkillManager` + +Loads, unloads, and queries skills on behalf of an <xref href="SignalWire.Agent.AgentBase" data-throw-if-not-resolved="false"></xref>. +Validates env vars, calls Setup/RegisterTools, and merges hints/globalData/prompts. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class SkillManager +``` + +## Properties + + + The skill\_manager logger (Python parity: `SkillManager.logger` instance attribute). + + +## Methods + + + + + + + + + + Load a skill by name (resolved via registry) or by explicit type. Returns (success, errorMessage). + + + + + + + +## Source + +[`src/SignalWire/Skills/SkillManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/list-skills.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/list-skills.mdx new file mode 100644 index 0000000000..93095d3712 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/list-skills.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-manager/list-skills" +title: "ListSkills()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillManager.ListSkills()" + parent: "SignalWire.Skills.SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs" + visibility: "public" +--- +# `ListSkills()` + +## Signature + +```dotnet +public List ListSkills() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Skills/SkillManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs) + +Line 118. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/load-skill-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/load-skill-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..289be63fc5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/load-skill-string-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-manager/load-skill-string-dictionary-string-object" +title: "LoadSkill(string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillManager.LoadSkill(string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.Skills.SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs" + visibility: "public" +--- +# `LoadSkill(string, Dictionary?)` + +Load a skill by name (resolved via registry) or by explicit type. +Returns (success, errorMessage). + +## Signature + +```dotnet +public (bool Success, string Error) LoadSkill(string skillName, Dictionary? parameters = null) +``` + +## Parameters + + + + + +## Returns + +`System.ValueTuple` + +## Source + +[`src/SignalWire/Skills/SkillManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs) + +Line 31. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/skill-manager-agent-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/skill-manager-agent-base.mdx new file mode 100644 index 0000000000..0544648a0d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/skill-manager-agent-base.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-manager/skill-manager-agent-base" +title: "SkillManager(AgentBase)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillManager.SkillManager(SignalWire.Agent.AgentBase)" + parent: "SignalWire.Skills.SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs" + visibility: "public" +--- +# `SkillManager(AgentBase)` + +## Signature + +```dotnet +public SkillManager(AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/SkillManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs) + +Line 16. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/unload-skill-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/unload-skill-string.mdx new file mode 100644 index 0000000000..83dc53d920 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-manager/unload-skill-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-manager/unload-skill-string" +title: "UnloadSkill(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillManager.UnloadSkill(string)" + parent: "SignalWire.Skills.SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs" + visibility: "public" +--- +# `UnloadSkill(string)` + +## Signature + +```dotnet +public bool UnloadSkill(string key) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Skills/SkillManager.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillManager.cs) + +Line 105. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/add-skill-directory-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/add-skill-directory-string.mdx new file mode 100644 index 0000000000..11dfe9573d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/add-skill-directory-string.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-registry/add-skill-directory-string" +title: "AddSkillDirectory(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillRegistry.AddSkillDirectory(string)" + parent: "SignalWire.Skills.SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs" + visibility: "public" +--- +# `AddSkillDirectory(string)` + +Add a directory to the external skill-source path list. +.NET ports loading skills from disk SHOULD consult this list. +Throws when the path does not exist or is not a directory. +(Python parity: `SkillRegistry.add_skill_directory(path)`.) + +## Signature + +```dotnet +public void AddSkillDirectory(string path) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/Skills/SkillRegistry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs) + +Line 117. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/discover-skills.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/discover-skills.mdx new file mode 100644 index 0000000000..e71b06dc96 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/discover-skills.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-registry/discover-skills" +title: "DiscoverSkills()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillRegistry.DiscoverSkills()" + parent: "SignalWire.Skills.SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs" + visibility: "public" +--- +# `DiscoverSkills()` + +Deprecated no-op: skills are loaded on-demand. +(Python parity: `SkillRegistry.discover_skills` — kept for +backwards compatibility; the Python doc says exactly this.) + +## Signature + +```dotnet +public void DiscoverSkills() +``` + +## Source + +[`src/SignalWire/Skills/SkillRegistry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs) + +Line 98. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/get-factory-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/get-factory-string.mdx new file mode 100644 index 0000000000..87253c40f4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/get-factory-string.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-registry/get-factory-string" +title: "GetFactory(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillRegistry.GetFactory(string)" + parent: "SignalWire.Skills.SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs" + visibility: "public" +--- +# `GetFactory(string)` + +Get the factory for a skill name. Checks custom registrations first, +then falls back to built-in factories. + +## Signature + +```dotnet +public Func? GetFactory(string name) +``` + +## Parameters + + + +## Returns + +`System.Func` + +## Source + +[`src/SignalWire/Skills/SkillRegistry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs) + +Line 136. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/index.mdx new file mode 100644 index 0000000000..488321b024 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-registry" +title: "SkillRegistry" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillRegistry" + parent: "SignalWire.Skills" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs" + visibility: "public" +--- +# `SkillRegistry` + +Thread-safe singleton that maps snake\_case skill names to factory delegates. +All 18 built-in skills are registered lazily on first access. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class SkillRegistry +``` + +## Properties + + + External skill-source paths added via <xref href="SignalWire.Skills.SkillRegistry.AddSkillDirectory(System.String)" data-throw-if-not-resolved="false"></xref>. + + + + + + The skill\_registry logger. (Python parity: `SkillRegistry.logger` instance attribute.) + + +## Methods + + + + Add a directory to the external skill-source path list. .NET ports loading skills from disk SHOULD consult this list. Throws when the path does not exist or is not a directory. (Python parity: `SkillRegistry.add_skill_directory(path)`.) + + + + Deprecated no-op: skills are loaded on-demand. (Python parity: `SkillRegistry.discover_skills` — kept for backwards compatibility; the Python doc says exactly this.) + + + + Get the factory for a skill name. Checks custom registrations first, then falls back to built-in factories. + + + + Return all known skill names (builtins + custom), sorted. + + + + Register a custom skill factory. + + + + Reset the singleton (for testing). + + + +## Source + +[`src/SignalWire/Skills/SkillRegistry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/list-skills.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/list-skills.mdx new file mode 100644 index 0000000000..47d1e1d555 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/list-skills.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-registry/list-skills" +title: "ListSkills()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillRegistry.ListSkills()" + parent: "SignalWire.Skills.SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs" + visibility: "public" +--- +# `ListSkills()` + +Return all known skill names (builtins + custom), sorted. + +## Signature + +```dotnet +public List ListSkills() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/Skills/SkillRegistry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs) + +Line 159. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/register-skill-string-func-skill-base.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/register-skill-string-func-skill-base.mdx new file mode 100644 index 0000000000..c6b537b95b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/register-skill-string-func-skill-base.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-registry/register-skill-string-func-skill-base" +title: "RegisterSkill(string, Func)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillRegistry.RegisterSkill(string, System.Func)" + parent: "SignalWire.Skills.SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs" + visibility: "public" +--- +# `RegisterSkill(string, Func)` + +Register a custom skill factory. + +## Signature + +```dotnet +public void RegisterSkill(string name, Func factory) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/Skills/SkillRegistry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs) + +Line 87. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/reset.mdx b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/reset.mdx new file mode 100644 index 0000000000..f895a07fdc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.skills/skill-registry/reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.skills/skill-registry/reset" +title: "Reset()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Skills.SkillRegistry.Reset()" + parent: "SignalWire.Skills.SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs" + visibility: "public" +--- +# `Reset()` + +Reset the singleton (for testing). + +**Modifiers:** `static` + +## Signature + +```dotnet +public static void Reset() +``` + +## Source + +[`src/SignalWire/Skills/SkillRegistry.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Skills/SkillRegistry.cs) + +Line 78. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/add-action.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/add-action.mdx new file mode 100644 index 0000000000..c1b9db7891 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/add-action.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/add-action" +title: "AddAction" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.AddAction(string, object)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `AddAction` + +Append an action with the given name and arbitrary data +payload. Matches Python's `add_action(name, data)`. + +## Signature + + + + ```dotnet + public FunctionResult AddAction(string name, object data) + ``` + + + + ```dotnet + public FunctionResult AddAction(Dictionary action) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`SignalWire.SWAIG.FunctionResult` + +## Returns (Overload 2) + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 38. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/add-actions-i-enumerable-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/add-actions-i-enumerable-dictionary-string-object.mdx new file mode 100644 index 0000000000..29ee77a87f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/add-actions-i-enumerable-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/add-actions-i-enumerable-dictionary-string-object" +title: "AddActions(IEnumerable>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.AddActions(System.Collections.Generic.IEnumerable>)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `AddActions(IEnumerable>)` + +## Signature + +```dotnet +public FunctionResult AddActions(IEnumerable> actions) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 52. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/add-dynamic-hints-list-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/add-dynamic-hints-list-object.mdx new file mode 100644 index 0000000000..4636f89fbc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/add-dynamic-hints-list-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/add-dynamic-hints-list-object" +title: "AddDynamicHints(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.AddDynamicHints(System.Collections.Generic.List)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `AddDynamicHints(List)` + +## Signature + +```dotnet +public FunctionResult AddDynamicHints(List hints) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 354. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/clear-dynamic-hints.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/clear-dynamic-hints.mdx new file mode 100644 index 0000000000..7db5f97b51 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/clear-dynamic-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/clear-dynamic-hints" +title: "ClearDynamicHints()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.ClearDynamicHints()" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `ClearDynamicHints()` + +## Signature + +```dotnet +public FunctionResult ClearDynamicHints() +``` + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 360. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/connect-string-bool-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/connect-string-bool-string.mdx new file mode 100644 index 0000000000..77ea5909e2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/connect-string-bool-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/connect-string-bool-string" +title: "Connect(string, bool, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.Connect(string, bool, string?)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `Connect(string, bool, string?)` + +## Signature + +```dotnet +public FunctionResult Connect(string destination, bool final = true, string? fromAddr = null) +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 89. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/create-payment-action-string-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/create-payment-action-string-string-string-string.mdx new file mode 100644 index 0000000000..9feabe96f0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/create-payment-action-string-string-string-string.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/create-payment-action-string-string-string-string" +title: "CreatePaymentAction(string, string, string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.CreatePaymentAction(string, string, string, string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `CreatePaymentAction(string, string, string, string)` + +**Modifiers:** `static` + +## Signature + +```dotnet +public static Dictionary CreatePaymentAction(string type, string text, string language = "en-US", string voice = "") +``` + +## Parameters + + + + + + + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 659. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/create-payment-parameter-string-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/create-payment-parameter-string-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..eed753dcd1 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/create-payment-parameter-string-string-dictionary-string-object.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/create-payment-parameter-string-string-dictionary-string-object" +title: "CreatePaymentParameter(string, string, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.CreatePaymentParameter(string, string, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `CreatePaymentParameter(string, string, Dictionary?)` + +**Modifiers:** `static` + +## Signature + +```dotnet +public static Dictionary CreatePaymentParameter(string name, string type, Dictionary? config = null) +``` + +## Parameters + + + + + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 680. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/create-payment-prompt-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/create-payment-prompt-string-string-string.mdx new file mode 100644 index 0000000000..01da028a47 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/create-payment-prompt-string-string-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/create-payment-prompt-string-string-string" +title: "CreatePaymentPrompt(string, string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.CreatePaymentPrompt(string, string, string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `CreatePaymentPrompt(string, string, string)` + +**Modifiers:** `static` + +## Signature + +```dotnet +public static Dictionary CreatePaymentPrompt(string text, string language = "en-US", string voice = "") +``` + +## Parameters + + + + + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 640. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/enable-extensive-data-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/enable-extensive-data-bool.mdx new file mode 100644 index 0000000000..c69f2cbe6e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/enable-extensive-data-bool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/enable-extensive-data-bool" +title: "EnableExtensiveData(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.EnableExtensiveData(bool)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `EnableExtensiveData(bool)` + +## Signature + +```dotnet +public FunctionResult EnableExtensiveData(bool enabled = true) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 399. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/enable-functions-on-timeout-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/enable-functions-on-timeout-bool.mdx new file mode 100644 index 0000000000..935177d729 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/enable-functions-on-timeout-bool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/enable-functions-on-timeout-bool" +title: "EnableFunctionsOnTimeout(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.EnableFunctionsOnTimeout(bool)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `EnableFunctionsOnTimeout(bool)` + +## Signature + +```dotnet +public FunctionResult EnableFunctionsOnTimeout(bool enabled = true) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 393. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/execute-rpc-string-dictionary-string-object-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/execute-rpc-string-dictionary-string-object-string-string.mdx new file mode 100644 index 0000000000..86f1f34c3b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/execute-rpc-string-dictionary-string-object-string-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/execute-rpc-string-dictionary-string-object-string-string" +title: "ExecuteRpc(string, Dictionary?, string?, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.ExecuteRpc(string, System.Collections.Generic.Dictionary?, string?, string?)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `ExecuteRpc(string, Dictionary?, string?, string?)` + +## Signature + +```dotnet +public FunctionResult ExecuteRpc(string method, Dictionary? @params = null, string? callId = null, string? nodeId = null) +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 564. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/execute-swml-object-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/execute-swml-object-bool.mdx new file mode 100644 index 0000000000..bb4647efc9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/execute-swml-object-bool.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/execute-swml-object-bool" +title: "ExecuteSwml(object, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.ExecuteSwml(object, bool)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `ExecuteSwml(object, bool)` + +Execute inline SWML. Accepts a dictionary or a JSON string. +When <code class="paramref">transfer</code> is true, uses <code>transfer\_swml</code> instead of <code>SWML</code>. + +## Signature + +```dotnet +public FunctionResult ExecuteSwml(object swmlContent, bool transfer = false) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 419. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/function-result-string-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/function-result-string-bool.mdx new file mode 100644 index 0000000000..d3ca88bec9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/function-result-string-bool.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/function-result-string-bool" +title: "FunctionResult(string?, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.FunctionResult(string?, bool)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `FunctionResult(string?, bool)` + +## Signature + +```dotnet +public FunctionResult(string? response = null, bool postProcess = false) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 14. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/hangup.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/hangup.mdx new file mode 100644 index 0000000000..083021c3d2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/hangup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/hangup" +title: "Hangup()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.Hangup()" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `Hangup()` + +## Signature + +```dotnet +public FunctionResult Hangup() +``` + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 129. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/hold-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/hold-int.mdx new file mode 100644 index 0000000000..070f0f2682 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/hold-int.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/hold-int" +title: "Hold(int)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.Hold(int)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `Hold(int)` + +## Signature + +```dotnet +public FunctionResult Hold(int timeout = 300) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 138. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/index.mdx new file mode 100644 index 0000000000..9ffc0a1ccf --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/index.mdx @@ -0,0 +1,143 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result" +title: "FunctionResult" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult" + parent: "SignalWire.SWAIG" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `FunctionResult` + +Builds a SWAIG function result with an optional response, actions, and post-processing flag. +All action methods return <code>this</code> for fluent chaining. + +## Signature + +```dotnet +public class FunctionResult +``` + +## Methods + + + + Append an action with the given name and arbitrary data payload. Matches Python's `add_action(name, data)`. + + + + + + + + + + + + + + + + + + + + + + + + Execute inline SWML. Accepts a dictionary or a JSON string. When <code class="paramref">transfer</code> is true, uses <code>transfer\_swml</code> instead of <code>SWML</code>. + + + + + + + + + + + + + + + + + + + + + + + + Replace conversation history. Accepts `true` (default) for the summary placeholder or a string for custom replacement text. Matches Python's `replace_in_history(text: Union[bool, str] = True)`. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Serialize to a dictionary. <code>response</code> is always present; <code>action</code> only if non-empty; <code>post\_process</code> only if true. + + + + + + + + + + + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 8. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/join-conference-string-bool-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/join-conference-string-bool-string-string.mdx new file mode 100644 index 0000000000..fc90f03968 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/join-conference-string-bool-string-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/join-conference-string-bool-string-string" +title: "JoinConference(string, bool, string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.JoinConference(string, bool, string, string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `JoinConference(string, bool, string, string)` + +## Signature + +```dotnet +public FunctionResult JoinConference(string name, bool muted = false, string beep = "true", string holdAudio = "ring") +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 437. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/join-room-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/join-room-string.mdx new file mode 100644 index 0000000000..89c5f02575 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/join-room-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/join-room-string" +title: "JoinRoom(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.JoinRoom(string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `JoinRoom(string)` + +## Signature + +```dotnet +public FunctionResult JoinRoom(string name) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 456. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/pay-string-string-string-int-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/pay-string-string-string-int-int.mdx new file mode 100644 index 0000000000..953346246b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/pay-string-string-string-int-int.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/pay-string-string-string-int-int" +title: "Pay(string, string, string, int, int)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.Pay(string, string, string, int, int)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `Pay(string, string, string, int, int)` + +## Signature + +```dotnet +public FunctionResult Pay(string connectorUrl, string inputMethod = "dtmf", string actionUrl = "", int timeout = 600, int maxAttempts = 3) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 536. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/play-background-file-string-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/play-background-file-string-bool.mdx new file mode 100644 index 0000000000..a7167274e8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/play-background-file-string-bool.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/play-background-file-string-bool" +title: "PlayBackgroundFile(string, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.PlayBackgroundFile(string, bool)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `PlayBackgroundFile(string, bool)` + +## Signature + +```dotnet +public FunctionResult PlayBackgroundFile(string filename, bool wait = false) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 306. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/record-call-string-bool-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/record-call-string-bool-string-string.mdx new file mode 100644 index 0000000000..1bc341eaf5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/record-call-string-bool-string-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/record-call-string-bool-string-string" +title: "RecordCall(string, bool, string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.RecordCall(string, bool, string, string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `RecordCall(string, bool, string, string)` + +## Signature + +```dotnet +public FunctionResult RecordCall(string controlId = "", bool stereo = false, string format = "wav", string direction = "both") +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 319. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/remove-global-data-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/remove-global-data-list-string.mdx new file mode 100644 index 0000000000..1dd8b6eb16 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/remove-global-data-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/remove-global-data-list-string" +title: "RemoveGlobalData(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.RemoveGlobalData(System.Collections.Generic.List)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `RemoveGlobalData(List)` + +## Signature + +```dotnet +public FunctionResult RemoveGlobalData(List keys) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 190. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/remove-metadata-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/remove-metadata-list-string.mdx new file mode 100644 index 0000000000..7a050a0db2 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/remove-metadata-list-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/remove-metadata-list-string" +title: "RemoveMetadata(List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.RemoveMetadata(System.Collections.Generic.List)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `RemoveMetadata(List)` + +## Signature + +```dotnet +public FunctionResult RemoveMetadata(List keys) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 205. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/replace-in-history-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/replace-in-history-object.mdx new file mode 100644 index 0000000000..b17c3b8b75 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/replace-in-history-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/replace-in-history-object" +title: "ReplaceInHistory(object?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.ReplaceInHistory(object?)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `ReplaceInHistory(object?)` + +Replace conversation history. Accepts `true` (default) for the +summary placeholder or a string for custom replacement text. +Matches Python's `replace_in_history(text: Union[bool, str] = True)`. + +## Signature + +```dotnet +public FunctionResult ReplaceInHistory(object? text = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 286. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/rpc-ai-message-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/rpc-ai-message-string-string-string.mdx new file mode 100644 index 0000000000..3ecaf51648 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/rpc-ai-message-string-string-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/rpc-ai-message-string-string-string" +title: "RpcAiMessage(string, string, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.RpcAiMessage(string, string, string?)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `RpcAiMessage(string, string, string?)` + +## Signature + +```dotnet +public FunctionResult RpcAiMessage(string callId, string messageText, string? role = null) +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 611. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/rpc-ai-unhold-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/rpc-ai-unhold-string.mdx new file mode 100644 index 0000000000..7c81dd4ff3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/rpc-ai-unhold-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/rpc-ai-unhold-string" +title: "RpcAiUnhold(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.RpcAiUnhold(string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `RpcAiUnhold(string)` + +## Signature + +```dotnet +public FunctionResult RpcAiUnhold(string callId) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 622. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/rpc-dial-string-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/rpc-dial-string-string-string-string.mdx new file mode 100644 index 0000000000..1a67706691 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/rpc-dial-string-string-string-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/rpc-dial-string-string-string-string" +title: "RpcDial(string, string?, string?, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.RpcDial(string, string?, string?, string?)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `RpcDial(string, string?, string?, string?)` + +## Signature + +```dotnet +public FunctionResult RpcDial(string toNumber, string? fromNumber = null, string? destSwml = null, string? deviceType = null) +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 587. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/say-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/say-string.mdx new file mode 100644 index 0000000000..d35f6d42f5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/say-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/say-string" +title: "Say(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.Say(string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `Say(string)` + +## Signature + +```dotnet +public FunctionResult Say(string text) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 300. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/send-sms-string-string-string-list-string-list-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/send-sms-string-string-string-list-string-list-string-string.mdx new file mode 100644 index 0000000000..79df4de543 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/send-sms-string-string-string-list-string-list-string-string.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/send-sms-string-string-string-list-string-list-string-string" +title: "SendSms(string, string, string, List?, List?, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SendSms(string, string, string, System.Collections.Generic.List?, System.Collections.Generic.List?, string?)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SendSms(string, string, string, List?, List?, string?)` + +## Signature + +```dotnet +public FunctionResult SendSms(string toNumber, string fromNumber, string body, List? media = null, List? tags = null, string? region = null) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 504. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-end-of-speech-timeout-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-end-of-speech-timeout-int.mdx new file mode 100644 index 0000000000..4a40ba330f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-end-of-speech-timeout-int.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/set-end-of-speech-timeout-int" +title: "SetEndOfSpeechTimeout(int)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SetEndOfSpeechTimeout(int)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SetEndOfSpeechTimeout(int)` + +## Signature + +```dotnet +public FunctionResult SetEndOfSpeechTimeout(int ms) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 366. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-metadata-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-metadata-dictionary-string-object.mdx new file mode 100644 index 0000000000..a738c6029a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-metadata-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/set-metadata-dictionary-string-object" +title: "SetMetadata(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SetMetadata(System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SetMetadata(Dictionary)` + +## Signature + +```dotnet +public FunctionResult SetMetadata(Dictionary data) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 199. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-post-process-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-post-process-bool.mdx new file mode 100644 index 0000000000..b4d197a2fa --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-post-process-bool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/set-post-process-bool" +title: "SetPostProcess(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SetPostProcess(bool)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SetPostProcess(bool)` + +## Signature + +```dotnet +public FunctionResult SetPostProcess(bool value) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 30. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-response-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-response-string.mdx new file mode 100644 index 0000000000..1bde8778a7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-response-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/set-response-string" +title: "SetResponse(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SetResponse(string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SetResponse(string)` + +## Signature + +```dotnet +public FunctionResult SetResponse(string text) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 24. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-speech-event-timeout-int.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-speech-event-timeout-int.mdx new file mode 100644 index 0000000000..31265aa052 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/set-speech-event-timeout-int.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/set-speech-event-timeout-int" +title: "SetSpeechEventTimeout(int)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SetSpeechEventTimeout(int)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SetSpeechEventTimeout(int)` + +## Signature + +```dotnet +public FunctionResult SetSpeechEventTimeout(int ms) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 372. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/simulate-user-input-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/simulate-user-input-string.mdx new file mode 100644 index 0000000000..d0382ee523 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/simulate-user-input-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/simulate-user-input-string" +title: "SimulateUserInput(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SimulateUserInput(string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SimulateUserInput(string)` + +## Signature + +```dotnet +public FunctionResult SimulateUserInput(string text) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 630. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/sip-refer-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/sip-refer-string.mdx new file mode 100644 index 0000000000..2cd3a4d9ab --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/sip-refer-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/sip-refer-string" +title: "SipRefer(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SipRefer(string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SipRefer(string)` + +## Signature + +```dotnet +public FunctionResult SipRefer(string toUri) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 465. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop-background-file.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop-background-file.mdx new file mode 100644 index 0000000000..675c042462 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop-background-file.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/stop-background-file" +title: "StopBackgroundFile()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.StopBackgroundFile()" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `StopBackgroundFile()` + +## Signature + +```dotnet +public FunctionResult StopBackgroundFile() +``` + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 313. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop-record-call-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop-record-call-string.mdx new file mode 100644 index 0000000000..865aed4322 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop-record-call-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/stop-record-call-string" +title: "StopRecordCall(string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.StopRecordCall(string?)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `StopRecordCall(string?)` + +## Signature + +```dotnet +public FunctionResult StopRecordCall(string? controlId = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 342. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop-tap-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop-tap-string.mdx new file mode 100644 index 0000000000..b9d55da7de --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop-tap-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/stop-tap-string" +title: "StopTap(string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.StopTap(string?)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `StopTap(string?)` + +## Signature + +```dotnet +public FunctionResult StopTap(string? controlId = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 496. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop.mdx new file mode 100644 index 0000000000..83f1a92d3d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/stop.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/stop" +title: "Stop()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.Stop()" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `Stop()` + +## Signature + +```dotnet +public FunctionResult Stop() +``` + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 174. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/switch-context-string-string-bool-bool-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/switch-context-string-string-bool-bool-bool.mdx new file mode 100644 index 0000000000..b24027252f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/switch-context-string-string-bool-bool-bool.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/switch-context-string-string-bool-bool-bool" +title: "SwitchContext(string?, string?, bool, bool, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SwitchContext(string?, string?, bool, bool, bool)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SwitchContext(string?, string?, bool, bool, bool)` + +## Signature + +```dotnet +public FunctionResult SwitchContext(string? systemPrompt = null, string? userPrompt = null, bool consolidate = false, bool fullReset = false, bool isolated = false) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 238. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-change-context-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-change-context-string.mdx new file mode 100644 index 0000000000..c58ac7c06d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-change-context-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/swml-change-context-string" +title: "SwmlChangeContext(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SwmlChangeContext(string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SwmlChangeContext(string)` + +## Signature + +```dotnet +public FunctionResult SwmlChangeContext(string contextName) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 229. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-change-step-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-change-step-string.mdx new file mode 100644 index 0000000000..b6d3d26ba4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-change-step-string.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/swml-change-step-string" +title: "SwmlChangeStep(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SwmlChangeStep(string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SwmlChangeStep(string)` + +## Signature + +```dotnet +public FunctionResult SwmlChangeStep(string stepName) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 220. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-transfer-string-string-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-transfer-string-string-bool.mdx new file mode 100644 index 0000000000..db857d1416 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-transfer-string-string-bool.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/swml-transfer-string-string-bool" +title: "SwmlTransfer(string, string, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SwmlTransfer(string, string, bool)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SwmlTransfer(string, string, bool)` + +## Signature + +```dotnet +public FunctionResult SwmlTransfer(string dest, string aiResponse = "", bool final = false) +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 114. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-user-event-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-user-event-dictionary-string-object.mdx new file mode 100644 index 0000000000..7b6febf276 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/swml-user-event-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/swml-user-event-dictionary-string-object" +title: "SwmlUserEvent(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.SwmlUserEvent(System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `SwmlUserEvent(Dictionary)` + +## Signature + +```dotnet +public FunctionResult SwmlUserEvent(Dictionary eventData) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 214. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/tap-string-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/tap-string-string-string-string.mdx new file mode 100644 index 0000000000..979d430d34 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/tap-string-string-string-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/tap-string-string-string-string" +title: "Tap(string, string, string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.Tap(string, string, string, string)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `Tap(string, string, string, string)` + +## Signature + +```dotnet +public FunctionResult Tap(string uri, string controlId = "", string direction = "both", string codec = "PCMU") +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 474. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/to-dict.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/to-dict.mdx new file mode 100644 index 0000000000..818fe93e89 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/to-dict.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/to-dict" +title: "ToDict()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.ToDict()" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `ToDict()` + +Serialize to a dictionary. <code>response</code> is always present; <code>action</code> only if +non-empty; <code>post\_process</code> only if true. + +## Signature + +```dotnet +public Dictionary ToDict() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 65. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/toggle-functions-dictionary-string-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/toggle-functions-dictionary-string-bool.mdx new file mode 100644 index 0000000000..7a78ab9cc0 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/toggle-functions-dictionary-string-bool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/toggle-functions-dictionary-string-bool" +title: "ToggleFunctions(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.ToggleFunctions(System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `ToggleFunctions(Dictionary)` + +## Signature + +```dotnet +public FunctionResult ToggleFunctions(Dictionary toggles) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 378. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/update-global-data-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/update-global-data-dictionary-string-object.mdx new file mode 100644 index 0000000000..851ac92429 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/update-global-data-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/update-global-data-dictionary-string-object" +title: "UpdateGlobalData(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.UpdateGlobalData(System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `UpdateGlobalData(Dictionary)` + +## Signature + +```dotnet +public FunctionResult UpdateGlobalData(Dictionary data) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 184. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/update-settings-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/update-settings-dictionary-string-object.mdx new file mode 100644 index 0000000000..2b97d024e4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/update-settings-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/update-settings-dictionary-string-object" +title: "UpdateSettings(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.UpdateSettings(System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `UpdateSettings(Dictionary)` + +## Signature + +```dotnet +public FunctionResult UpdateSettings(Dictionary settings) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 405. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/wait-for-user-bool-int-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/wait-for-user-bool-int-bool.mdx new file mode 100644 index 0000000000..efdb95fe2b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/function-result/wait-for-user-bool-int-bool.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig/function-result/wait-for-user-bool-int-bool" +title: "WaitForUser(bool?, int?, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWAIG.FunctionResult.WaitForUser(bool?, int?, bool)" + parent: "SignalWire.SWAIG.FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs" + visibility: "public" +--- +# `WaitForUser(bool?, int?, bool)` + +## Signature + +```dotnet +public FunctionResult WaitForUser(bool? enabled = null, int? timeout = null, bool answerFirst = false) +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWAIG/FunctionResult.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWAIG/FunctionResult.cs) + +Line 148. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swaig/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swaig/index.mdx new file mode 100644 index 0000000000..4a5e6abd54 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swaig/index.mdx @@ -0,0 +1,20 @@ +--- +slug: "/reference/dotnet/signal-wire.swaig" +title: "SignalWire.SWAIG" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.SWAIG" +--- +# `SignalWire.SWAIG` + +## Classes + + + + Builds a SWAIG function result with an optional response, actions, and post-processing flag. All action methods return <code>this</code> for fluent chaining. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-raw-verb-string-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-raw-verb-string-dictionary-string-object.mdx new file mode 100644 index 0000000000..787bed0087 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-raw-verb-string-dictionary-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/add-raw-verb-string-dictionary-string-object" +title: "AddRawVerb(string, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.AddRawVerb(string, System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `AddRawVerb(string, Dictionary)` + +Append a pre-formatted verb hash to a section. + +## Signature + +```dotnet +public void AddRawVerb(string section, Dictionary verbHash) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 80. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-section-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-section-string.mdx new file mode 100644 index 0000000000..5b19dec56b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-section-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/add-section-string" +title: "AddSection(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.AddSection(string)" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `AddSection(string)` + +Add a new named section. Returns true if created, false if it already existed. + +## Signature + +```dotnet +public bool AddSection(string name) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 37. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-verb-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-verb-string-object.mdx new file mode 100644 index 0000000000..a33a66d65f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-verb-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/add-verb-string-object" +title: "AddVerb(string, object?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.AddVerb(string, object?)" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `AddVerb(string, object?)` + +Append a verb to the main section. + +## Signature + +```dotnet +public void AddVerb(string verbName, object? config) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 64. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-verb-to-section-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-verb-to-section-string-string-object.mdx new file mode 100644 index 0000000000..535854049e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/add-verb-to-section-string-string-object.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/add-verb-to-section-string-string-object" +title: "AddVerbToSection(string, string, object?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.AddVerbToSection(string, string, object?)" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `AddVerbToSection(string, string, object?)` + +Append a verb to a named section. + +## Signature + +```dotnet +public void AddVerbToSection(string section, string verbName, object? config) +``` + +## Parameters + + + + + + + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 70. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/clear-section-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/clear-section-string.mdx new file mode 100644 index 0000000000..46f2509989 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/clear-section-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/clear-section-string" +title: "ClearSection(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.ClearSection(string)" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `ClearSection(string)` + +Clear all verbs in a section (keeps the section itself). + +## Signature + +```dotnet +public void ClearSection(string section) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 90. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/document.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/document.mdx new file mode 100644 index 0000000000..47a113abaa --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/document.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/document" +title: "Document()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.Document()" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `Document()` + +## Signature + +```dotnet +public Document() +``` + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 29. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/get-verbs-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/get-verbs-string.mdx new file mode 100644 index 0000000000..617bdc0b97 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/get-verbs-string.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/get-verbs-string" +title: "GetVerbs(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.GetVerbs(string)" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `GetVerbs(string)` + +Get a copy of the verbs for a section. +Returns an empty list if the section does not exist. + +## Signature + +```dotnet +public List> GetVerbs(string section = "main") +``` + +## Parameters + + + +## Returns + +`List>` + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 54. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/has-section-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/has-section-string.mdx new file mode 100644 index 0000000000..2ddfc0405b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/has-section-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/has-section-string" +title: "HasSection(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.HasSection(string)" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `HasSection(string)` + +Check whether a named section exists. + +## Signature + +```dotnet +public bool HasSection(string name) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 48. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/index.mdx new file mode 100644 index 0000000000..edb3faf9de --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/index.mdx @@ -0,0 +1,87 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document" +title: "Document" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document" + parent: "SignalWire.SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `Document` + +Represents a SWML document containing versioned sections of verb instructions. +Each section holds an ordered list of verb dictionaries that define call-flow logic. + +## Signature + +```dotnet +public class Document +``` + +## Properties + + + SWML document version. + + +## Methods + + + + Append a pre-formatted verb hash to a section. + + + + Add a new named section. Returns true if created, false if it already existed. + + + + Append a verb to the main section. + + + + Append a verb to a named section. + + + + Clear all verbs in a section (keeps the section itself). + + + + + + Get a copy of the verbs for a section. Returns an empty list if the section does not exist. + + + + Check whether a named section exists. + + + + Compact JSON string. + + + + Pretty-printed JSON string. + + + + Reset document to initial state with an empty main section. + + + + Return document as a dictionary suitable for serialization. + + + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 9. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/render-pretty.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/render-pretty.mdx new file mode 100644 index 0000000000..32c0e75456 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/render-pretty.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/render-pretty" +title: "RenderPretty()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.RenderPretty()" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `RenderPretty()` + +Pretty-printed JSON string. + +## Signature + +```dotnet +public string RenderPretty() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 123. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/render.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/render.mdx new file mode 100644 index 0000000000..02a50a4577 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/render.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/render" +title: "Render()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.Render()" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `Render()` + +Compact JSON string. + +## Signature + +```dotnet +public string Render() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 120. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/reset.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/reset.mdx new file mode 100644 index 0000000000..7183bda2fe --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/reset.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/reset" +title: "Reset()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.Reset()" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `Reset()` + +Reset document to initial state with an empty main section. + +## Signature + +```dotnet +public void Reset() +``` + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 99. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/document/to-dict.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/to-dict.mdx new file mode 100644 index 0000000000..c2f2e68e8d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/document/to-dict.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/document/to-dict" +title: "ToDict()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Document.ToDict()" + parent: "SignalWire.SWML.Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs" + visibility: "public" +--- +# `ToDict()` + +Return document as a dictionary suitable for serialization. + +## Signature + +```dotnet +public Dictionary ToDict() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWML/Document.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Document.cs) + +Line 110. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/index.mdx new file mode 100644 index 0000000000..a69cebf668 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.swml" +title: "SignalWire.SWML" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.SWML" +--- +# `SignalWire.SWML` + +## Classes + + + + Represents a SWML document containing versioned sections of verb instructions. Each section holds an ordered list of verb dictionaries that define call-flow logic. + + + + Thread-safe singleton that loads the SWML JSON schema from an embedded resource and exposes verb definitions parsed from $defs.SWMLMethod.anyOf. + + + + Validation error raised by SchemaUtils.ValidateVerb when a verb config violates its schema. (Python parity: `signalwire.utils.schema_utils.SchemaValidationError`.) + + + + A SWML service that manages a Document, provides schema-driven verb methods, handles HTTP requests with Basic authentication, and supports routing callbacks. + + + + Configuration options for a SWML service. + + + + + + + + Metadata about a single SWML verb parsed from the schema. + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/schema-validation-error/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema-validation-error/index.mdx new file mode 100644 index 0000000000..7102d52eb6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema-validation-error/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/schema-validation-error" +title: "SchemaValidationError" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.SWML.SchemaValidationError" + parent: "SignalWire.SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `SchemaValidationError` + +Validation error raised by SchemaUtils.ValidateVerb when a +verb config violates its schema. (Python parity: +`signalwire.utils.schema_utils.SchemaValidationError`.) + +## Signature + +```dotnet +public class SchemaValidationError : Exception, ISerializable +``` + +## Inheritance + +**Extends:** `System.Exception` + +**Implements:** `System.Runtime.Serialization.ISerializable` + +## Properties + + + + + +## Methods + + + + + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 16. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/schema-validation-error/schema-validation-error-string-list-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema-validation-error/schema-validation-error-string-list-string.mdx new file mode 100644 index 0000000000..e411bbefa4 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema-validation-error/schema-validation-error-string-list-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/schema-validation-error/schema-validation-error-string-list-string" +title: "SchemaValidationError(string, List)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SchemaValidationError.SchemaValidationError(string, System.Collections.Generic.List)" + parent: "SignalWire.SWML.SchemaValidationError" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `SchemaValidationError(string, List)` + +## Signature + +```dotnet +public SchemaValidationError(string verbName, List errors) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 21. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-all-verb-names.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-all-verb-names.mdx new file mode 100644 index 0000000000..19265098b9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-all-verb-names.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/schema/get-all-verb-names" +title: "GetAllVerbNames()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Schema.GetAllVerbNames()" + parent: "SignalWire.SWML.Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `GetAllVerbNames()` + +Alias of <xref href="SignalWire.SWML.Schema.GetVerbNames" data-throw-if-not-resolved="false"></xref>. (Python parity: +`SchemaUtils.get_all_verb_names`.) + +## Signature + +```dotnet +public List GetAllVerbNames() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 90. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-verb-names.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-verb-names.mdx new file mode 100644 index 0000000000..7f820c171a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-verb-names.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/schema/get-verb-names" +title: "GetVerbNames()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Schema.GetVerbNames()" + parent: "SignalWire.SWML.Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `GetVerbNames()` + +Get a sorted list of all verb names. + +## Signature + +```dotnet +public List GetVerbNames() +``` + +## Returns + +`List` + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 72. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-verb-parameters-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-verb-parameters-string.mdx new file mode 100644 index 0000000000..773fd5b467 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-verb-parameters-string.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/schema/get-verb-parameters-string" +title: "GetVerbParameters(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Schema.GetVerbParameters(string)" + parent: "SignalWire.SWML.Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `GetVerbParameters(string)` + +Get the parameter (property) definitions for a verb. +Returns an empty dict when the verb is unknown or has no +`properties`. (Python parity: +`SchemaUtils.get_verb_parameters(verb_name)`.) + +## Signature + +```dotnet +public Dictionary GetVerbParameters(string verbName) +``` + +## Parameters + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 114. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-verb-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-verb-string.mdx new file mode 100644 index 0000000000..720c94e075 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/get-verb-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/schema/get-verb-string" +title: "GetVerb(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Schema.GetVerb(string)" + parent: "SignalWire.SWML.Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `GetVerb(string)` + +Get verb metadata, or null if not found. + +## Signature + +```dotnet +public VerbInfo? GetVerb(string name) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWML.VerbInfo` + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 80. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/index.mdx new file mode 100644 index 0000000000..c9cc994489 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/schema" +title: "Schema" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.SWML.Schema" + parent: "SignalWire.SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `Schema` + +Thread-safe singleton that loads the SWML JSON schema from an embedded resource +and exposes verb definitions parsed from $defs.SWMLMethod.anyOf. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class Schema +``` + +## Properties + + + Thread-safe singleton accessor. + + + + Number of verbs defined in the schema. + + +## Methods + + + + Alias of <xref href="SignalWire.SWML.Schema.GetVerbNames" data-throw-if-not-resolved="false"></xref>. (Python parity: `SchemaUtils.get_all_verb_names`.) + + + + Get verb metadata, or null if not found. + + + + Get a sorted list of all verb names. + + + + Get the parameter (property) definitions for a verb. Returns an empty dict when the verb is unknown or has no `properties`. (Python parity: `SchemaUtils.get_verb_parameters(verb_name)`.) + + + + Check whether a verb name is valid. + + + + Public load-schema accessor. Returns the embedded SWML schema as a Dictionary\. Empty dict when the schema can't be loaded. (Python parity: `SchemaUtils.load_schema`.) + + + + Reset the singleton (for testing). + + + + Validate a SWML document against the loaded schema. Returns `(true, [])` on success or `(false, [errors...])` on failure. Lightweight verb-presence check — full JSON-Schema validation is out of scope for the bundled SDK. (Python parity: `SchemaUtils.validate_document(document) -> (bool, list)`.) + + + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 33. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/is-valid-verb-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/is-valid-verb-string.mdx new file mode 100644 index 0000000000..08c30f439b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/is-valid-verb-string.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/schema/is-valid-verb-string" +title: "IsValidVerb(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Schema.IsValidVerb(string)" + parent: "SignalWire.SWML.Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `IsValidVerb(string)` + +Check whether a verb name is valid. + +## Signature + +```dotnet +public bool IsValidVerb(string name) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 69. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/load-schema-public.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/load-schema-public.mdx new file mode 100644 index 0000000000..30e8d457d3 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/load-schema-public.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/schema/load-schema-public" +title: "LoadSchemaPublic()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Schema.LoadSchemaPublic()" + parent: "SignalWire.SWML.Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `LoadSchemaPublic()` + +Public load-schema accessor. Returns the embedded SWML +schema as a Dictionary\. Empty dict +when the schema can't be loaded. (Python parity: +`SchemaUtils.load_schema`.) + +## Signature + +```dotnet +public Dictionary LoadSchemaPublic() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 96. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/reset.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/reset.mdx new file mode 100644 index 0000000000..2bc717c515 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/schema/reset" +title: "Reset()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Schema.Reset()" + parent: "SignalWire.SWML.Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `Reset()` + +Reset the singleton (for testing). + +**Modifiers:** `static` + +## Signature + +```dotnet +public static void Reset() +``` + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 60. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/validate-document-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/validate-document-dictionary-string-object.mdx new file mode 100644 index 0000000000..76c225e979 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/schema/validate-document-dictionary-string-object.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/schema/validate-document-dictionary-string-object" +title: "ValidateDocument(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Schema.ValidateDocument(System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWML.Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `ValidateDocument(Dictionary)` + +Validate a SWML document against the loaded schema. +Returns `(true, [])` on success or `(false, [errors...])` on +failure. Lightweight verb-presence check — full JSON-Schema +validation is out of scope for the bundled SDK. +(Python parity: +`SchemaUtils.validate_document(document) -> (bool, list)`.) + +## Signature + +```dotnet +public (bool Valid, List Errors) ValidateDocument(Dictionary document) +``` + +## Parameters + + + +## Returns + +`System.ValueTuple>` + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 137. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service-options/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service-options/index.mdx new file mode 100644 index 0000000000..7610f23f45 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service-options/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service-options" +title: "ServiceOptions" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.SWML.ServiceOptions" + parent: "SignalWire.SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `ServiceOptions` + +Configuration options for a SWML service. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed class ServiceOptions +``` + +## Properties + + + + + + + + + + + + + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 12. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/define-tool-string-string-dictionary-string-object-func-dictionary-string-object-dictionary-string-object-function-result-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/define-tool-string-string-dictionary-string-object-func-dictionary-string-object-dictionary-string-object-function-result-bool.mdx new file mode 100644 index 0000000000..e662952d4b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/define-tool-string-string-dictionary-string-object-func-dictionary-string-object-dictionary-string-object-function-result-bool.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/define-tool-string-string-dictionary-string-object-func-dictionary-string-object-dictionary-string-object-function-result-bool" +title: "DefineTool(string, string, Dictionary, Func, Dictionary, FunctionResult>, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.DefineTool(string, string, System.Collections.Generic.Dictionary, System.Func, System.Collections.Generic.Dictionary, SignalWire.SWAIG.FunctionResult>, bool)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `DefineTool(string, string, Dictionary, Func, Dictionary, FunctionResult>, bool)` + +Define a SWAIG function the AI can call. Tool descriptions and +parameter descriptions are LLM-facing prompt engineering — see +PORTING\_GUIDE for guidance on writing them. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Service DefineTool(string name, string description, Dictionary parameters, Func, Dictionary, FunctionResult> handler, bool secure = false) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SignalWire.SWML.Service` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 382. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/define-tools-list-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/define-tools-list-dictionary-string-object.mdx new file mode 100644 index 0000000000..e996fa045b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/define-tools-list-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/define-tools-list-dictionary-string-object" +title: "DefineTools(List>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.DefineTools(System.Collections.Generic.List>)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `DefineTools(List>)` + +Register multiple tool definitions at once. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Service DefineTools(List> toolDefs) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWML.Service` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 451. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/extract-sip-username-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/extract-sip-username-dictionary-string-object.mdx new file mode 100644 index 0000000000..580ba27e40 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/extract-sip-username-dictionary-string-object.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/extract-sip-username-dictionary-string-object" +title: "ExtractSipUsername(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.ExtractSipUsername(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `ExtractSipUsername(Dictionary?)` + +Extract SIP username from a request body. +Validates format: only \[a-zA-Z0-9.\_-], max 64 chars. + +**Modifiers:** `static` + +## Signature + +```dotnet +public static string? ExtractSipUsername(Dictionary? body) +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 655. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-all-functions.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-all-functions.mdx new file mode 100644 index 0000000000..08c72e871c --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-all-functions.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/get-all-functions" +title: "GetAllFunctions()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.GetAllFunctions()" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `GetAllFunctions()` + +Get a snapshot of all registered SWAIG functions +(Python parity: `tool_registry.get_all_functions()` — returns +a copy so subsequent registrations don't mutate the snapshot). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Dictionary> GetAllFunctions() +``` + +## Returns + +`Dictionary>` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 436. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-basic-auth-credentials-with-source.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-basic-auth-credentials-with-source.mdx new file mode 100644 index 0000000000..8edca8685b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-basic-auth-credentials-with-source.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/get-basic-auth-credentials-with-source" +title: "GetBasicAuthCredentialsWithSource()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.GetBasicAuthCredentialsWithSource()" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `GetBasicAuthCredentialsWithSource()` + +Get the Basic Auth credentials plus the SOURCE of the +credentials (Python parity: +`get_basic_auth_credentials(include_source=True)`). +Source is one of "provided", "environment", or "generated". + +## Signature + +```dotnet +public (string User, string Password, string Source) GetBasicAuthCredentialsWithSource() +``` + +## Returns + +`System.ValueTuple` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 176. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..69ea5e6f98 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-basic-auth-credentials.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/get-basic-auth-credentials" +title: "GetBasicAuthCredentials()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.GetBasicAuthCredentials()" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `GetBasicAuthCredentials()` + +Get the Basic Auth credentials as a tuple. + +## Signature + +```dotnet +public (string User, string Password) GetBasicAuthCredentials() +``` + +## Returns + +`System.ValueTuple` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 167. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-full-url-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-full-url-bool.mdx new file mode 100644 index 0000000000..8be4deebc8 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-full-url-bool.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/get-full-url-bool" +title: "GetFullUrl(bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.GetFullUrl(bool)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `GetFullUrl(bool)` + +Build the full URL for this service. + +## Signature + +```dotnet +public string GetFullUrl(bool includeAuth = false) +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 212. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-function-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-function-string.mdx new file mode 100644 index 0000000000..5120528005 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-function-string.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/get-function-string" +title: "GetFunction(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.GetFunction(string)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `GetFunction(string)` + +Get a registered SWAIG function by name, or null +(Python parity: `tool_registry.get_function(name)`). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Dictionary? GetFunction(string name) +``` + +## Parameters + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 430. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-proxy-url-base-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-proxy-url-base-dictionary-string-string.mdx new file mode 100644 index 0000000000..8d585de283 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/get-proxy-url-base-dictionary-string-string.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/get-proxy-url-base-dictionary-string-string" +title: "GetProxyUrlBase(Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.GetProxyUrlBase(System.Collections.Generic.Dictionary?)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `GetProxyUrlBase(Dictionary?)` + +Detect or construct the proxy URL base from request headers. +Priority: SWML\_PROXY\_URL\_BASE env > X-Forwarded-Proto+Host > X-Original-URL > fallback. + +## Signature + +```dotnet +public string GetProxyUrlBase(Dictionary? headers = null) +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 723. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-post-prompt-dictionary-string-object-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-post-prompt-dictionary-string-object-dictionary-string-string.mdx new file mode 100644 index 0000000000..a1585afa75 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-post-prompt-dictionary-string-object-dictionary-string-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/handle-post-prompt-dictionary-string-object-dictionary-string-string" +title: "HandlePostPrompt(Dictionary?, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.HandlePostPrompt(System.Collections.Generic.Dictionary?, System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "protected" +--- +# `HandlePostPrompt(Dictionary?, Dictionary)` + +Handle post-prompt callback. Override in AgentBase. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +protected virtual (int, Dictionary, string) HandlePostPrompt(Dictionary? requestData, Dictionary headers) +``` + +## Parameters + + + + + +## Returns + +`System.ValueTuple,string>` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 640. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-request-string-string-dictionary-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-request-string-string-dictionary-string-string-string.mdx new file mode 100644 index 0000000000..95cc86cd33 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-request-string-string-dictionary-string-string-string.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/handle-request-string-string-dictionary-string-string-string" +title: "HandleRequest(string, string, Dictionary, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.HandleRequest(string, string, System.Collections.Generic.Dictionary, string?)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `HandleRequest(string, string, Dictionary, string?)` + +Handle an HTTP request. Returns a tuple of (status, headers, body). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual (int Status, Dictionary Headers, string Body) HandleRequest(string method, string path, Dictionary headers, string? body) +``` + +## Parameters + + + + + + + + + +## Returns + +`System.ValueTuple,string>` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 275. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-swaig-request-string-dictionary-string-object-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-swaig-request-string-dictionary-string-object-dictionary-string-string.mdx new file mode 100644 index 0000000000..f02e6e387a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-swaig-request-string-dictionary-string-object-dictionary-string-string.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/handle-swaig-request-string-dictionary-string-object-dictionary-string-string" +title: "HandleSwaigRequest(string, Dictionary?, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.HandleSwaigRequest(string, System.Collections.Generic.Dictionary?, System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "protected" +--- +# `HandleSwaigRequest(string, Dictionary?, Dictionary)` + +Handle SWAIG function dispatch. + +GET: returns the rendered SWML document (parallel to root /). +POST: parses \{function, argument, call\_id\}, validates, runs the +SwaigPreDispatch hook, calls OnFunctionCall on the chosen target. + +Lifted from AgentBase so non-agent SWMLServices (e.g. ai\_sidecar +host) can serve /swaig without subclassing AgentBase. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +protected virtual (int, Dictionary, string) HandleSwaigRequest(string method, Dictionary? requestData, Dictionary headers) +``` + +## Parameters + + + + + + + +## Returns + +`System.ValueTuple,string>` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 545. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-swml-request-string-dictionary-string-object-dictionary-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-swml-request-string-dictionary-string-object-dictionary-string-string.mdx new file mode 100644 index 0000000000..0a8cc282fd --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/handle-swml-request-string-dictionary-string-object-dictionary-string-string.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/handle-swml-request-string-dictionary-string-object-dictionary-string-string" +title: "HandleSwmlRequest(string, Dictionary?, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.HandleSwmlRequest(string, System.Collections.Generic.Dictionary?, System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "protected" +--- +# `HandleSwmlRequest(string, Dictionary?, Dictionary)` + +Handle SWML document request. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +protected virtual (int, Dictionary, string) HandleSwmlRequest(string method, Dictionary? requestData, Dictionary headers) +``` + +## Parameters + + + + + + + +## Returns + +`System.ValueTuple,string>` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 364. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/has-function-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/has-function-string.mdx new file mode 100644 index 0000000000..e2588a321d --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/has-function-string.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/has-function-string" +title: "HasFunction(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.HasFunction(string)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `HasFunction(string)` + +Check if a SWAIG function is registered +(Python parity: `tool_registry.has_function(name)`). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual bool HasFunction(string name) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 426. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/index.mdx new file mode 100644 index 0000000000..5c59b6c203 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/index.mdx @@ -0,0 +1,165 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service" +title: "Service" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service" + parent: "SignalWire.SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `Service` + +A SWML service that manages a Document, provides schema-driven verb methods, +handles HTTP requests with Basic authentication, and supports routing callbacks. + +## Signature + +```dotnet +public class Service +``` + +## Properties + + + + + + + + + + + + + + + + + Public read-only view of the SWAIG tool registry — the same data served by /swaig get\_signature, but reachable in-process for introspection (e.g. swaig-test --list-tools against an assembly loaded via reflection). The internal "\_handler" callable is stripped because it isn't meaningful outside this process. This is an SDK accessor, not a new endpoint. Order matches registration order (mirrors ListToolNames). + + +## Methods + + + + Define a SWAIG function the AI can call. Tool descriptions and parameter descriptions are LLM-facing prompt engineering — see PORTING\_GUIDE for guidance on writing them. + + + + Register multiple tool definitions at once. + + + + Extract SIP username from a request body. Validates format: only \[a-zA-Z0-9.\_-], max 64 chars. + + + + Get a snapshot of all registered SWAIG functions (Python parity: `tool_registry.get_all_functions()` — returns a copy so subsequent registrations don't mutate the snapshot). + + + + Get the Basic Auth credentials as a tuple. + + + + Get the Basic Auth credentials plus the SOURCE of the credentials (Python parity: `get_basic_auth_credentials(include_source=True)`). Source is one of "provided", "environment", or "generated". + + + + Build the full URL for this service. + + + + Get a registered SWAIG function by name, or null (Python parity: `tool_registry.get_function(name)`). + + + + Detect or construct the proxy URL base from request headers. Priority: SWML\_PROXY\_URL\_BASE env > X-Forwarded-Proto+Host > X-Original-URL > fallback. + + + + Handle post-prompt callback. Override in AgentBase. + + + + Handle an HTTP request. Returns a tuple of (status, headers, body). + + + + Handle SWAIG function dispatch. GET: returns the rendered SWML document (parallel to root /). POST: parses \{function, argument, call\_id\}, validates, runs the SwaigPreDispatch hook, calls OnFunctionCall on the chosen target. Lifted from AgentBase so non-agent SWMLServices (e.g. ai\_sidecar host) can serve /swaig without subclassing AgentBase. + + + + Handle SWML document request. + + + + Check if a SWAIG function is registered (Python parity: `tool_registry.has_function(name)`). + + + + List registered tool names in registration order. + + + + Dispatch a function call to the registered handler. + + + + Customization hook called when SWML is requested. Default delegates to <xref href="SignalWire.SWML.Service.OnSwmlRequest(System.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d%2cSystem.String)" data-throw-if-not-resolved="false"></xref>; subclasses typically override <xref href="SignalWire.SWML.Service.OnSwmlRequest(System.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d%2cSystem.String)" data-throw-if-not-resolved="false"></xref> instead of this method. Return null to use the default SWML rendering, or a dictionary of modifications to merge in. (Python parity: `WebMixin.on_request`.) + + + + Customization hook for subclasses to modify SWML based on request data. Return null to use default rendering, or a dictionary of modifications. (Python parity: `WebMixin.on_swml_request`.) + + + + Register a callback for a sub-path under the service route. + + + + Register a raw SWAIG function definition (e.g. DataMap tools). + + + + Remove a registered SWAIG function. Returns true if removed, false if not found (Python parity: `tool_registry.remove_function(name)`). + + + + Render the SWML document for a request. Override in subclasses to customise. + + + + Start a blocking HTTP server bound to <xref href="SignalWire.SWML.Service.Host" data-throw-if-not-resolved="false"></xref>:<xref href="SignalWire.SWML.Service.Port" data-throw-if-not-resolved="false"></xref>. Each incoming request is dispatched through <xref href="SignalWire.SWML.Service.HandleRequest(System.String%2cSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.String%7d%2cSystem.String)" data-throw-if-not-resolved="false"></xref>; the response status / headers / body are written back to the client. Mirrors Python's SWMLService.run() — examples and the porting-sdk audit harness call this directly. Uses System.Net.HttpListener (BCL) — no extra deps. Server stops on Ctrl-C or when the process is killed. + + + + + + Add a sleep verb with a duration in milliseconds to the specified section. + + + + Extension point: invoked between argument parsing and function dispatch. Returns (target, shortCircuit). When shortCircuit is non-null, it's returned directly without calling OnFunctionCall. AgentBase may override to add session-token validation or ephemeral dynamic-config copies. + + + + Validate provided basic-auth credentials against the configured ones (constant-time comparison) (Python parity: `validate_basic_auth(username, password)`). + + + + Add a verb to the specified section. Validates the verb name against the schema. Returns this service for fluent chaining. + + + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 26. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/list-tool-names.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/list-tool-names.mdx new file mode 100644 index 0000000000..b48387c143 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/list-tool-names.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/list-tool-names" +title: "ListToolNames()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.ListToolNames()" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `ListToolNames()` + +List registered tool names in registration order. + +## Signature + +```dotnet +public IEnumerable ListToolNames() +``` + +## Returns + +`IEnumerable` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 482. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/on-function-call-string-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/on-function-call-string-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..6c8842175a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/on-function-call-string-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/on-function-call-string-dictionary-string-object-dictionary-string-object" +title: "OnFunctionCall(string, Dictionary, Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.OnFunctionCall(string, System.Collections.Generic.Dictionary, System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `OnFunctionCall(string, Dictionary, Dictionary)` + +Dispatch a function call to the registered handler. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual FunctionResult? OnFunctionCall(string name, Dictionary args, Dictionary rawData) +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire.SWAIG.FunctionResult` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 461. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/on-request-dictionary-string-object-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/on-request-dictionary-string-object-string.mdx new file mode 100644 index 0000000000..41e3a5d847 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/on-request-dictionary-string-object-string.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/on-request-dictionary-string-object-string" +title: "OnRequest(Dictionary?, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.OnRequest(System.Collections.Generic.Dictionary?, string?)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `OnRequest(Dictionary?, string?)` + +Customization hook called when SWML is requested. +Default delegates to <xref href="SignalWire.SWML.Service.OnSwmlRequest(System.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d%2cSystem.String)" data-throw-if-not-resolved="false"></xref>; subclasses +typically override <xref href="SignalWire.SWML.Service.OnSwmlRequest(System.Collections.Generic.Dictionary%7bSystem.String%2cSystem.Object%7d%2cSystem.String)" data-throw-if-not-resolved="false"></xref> instead of this +method. Return null to use the default SWML rendering, or a +dictionary of modifications to merge in. +(Python parity: `WebMixin.on_request`.) + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Dictionary? OnRequest(Dictionary? requestData = null, string? callbackPath = null) +``` + +## Parameters + + + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 250. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/on-swml-request-dictionary-string-object-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/on-swml-request-dictionary-string-object-string.mdx new file mode 100644 index 0000000000..341a74eff7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/on-swml-request-dictionary-string-object-string.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/on-swml-request-dictionary-string-object-string" +title: "OnSwmlRequest(Dictionary?, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.OnSwmlRequest(System.Collections.Generic.Dictionary?, string?)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `OnSwmlRequest(Dictionary?, string?)` + +Customization hook for subclasses to modify SWML based +on request data. Return null to use default rendering, or a +dictionary of modifications. (Python parity: +`WebMixin.on_swml_request`.) + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Dictionary? OnSwmlRequest(Dictionary? requestData = null, string? callbackPath = null) +``` + +## Parameters + + + + + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 261. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/register-routing-callback-string-func-dictionary-string-object-dictionary-string-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/register-routing-callback-string-func-dictionary-string-object-dictionary-string-string-object.mdx new file mode 100644 index 0000000000..658acb39da --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/register-routing-callback-string-func-dictionary-string-object-dictionary-string-string-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/register-routing-callback-string-func-dictionary-string-object-dictionary-string-string-object" +title: "RegisterRoutingCallback(string, Func?, Dictionary, object>)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.RegisterRoutingCallback(string, System.Func?, System.Collections.Generic.Dictionary, object>)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `RegisterRoutingCallback(string, Func?, Dictionary, object>)` + +Register a callback for a sub-path under the service route. + +## Signature + +```dotnet +public void RegisterRoutingCallback(string path, Func?, Dictionary, object> callback) +``` + +## Parameters + + + + + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 225. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/register-swaig-function-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/register-swaig-function-dictionary-string-object.mdx new file mode 100644 index 0000000000..ba941cece9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/register-swaig-function-dictionary-string-object.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/register-swaig-function-dictionary-string-object" +title: "RegisterSwaigFunction(Dictionary)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.RegisterSwaigFunction(System.Collections.Generic.Dictionary)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `RegisterSwaigFunction(Dictionary)` + +Register a raw SWAIG function definition (e.g. DataMap tools). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Service RegisterSwaigFunction(Dictionary funcDef) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWML.Service` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 409. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/remove-function-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/remove-function-string.mdx new file mode 100644 index 0000000000..713057c28e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/remove-function-string.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/remove-function-string" +title: "RemoveFunction(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.RemoveFunction(string)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `RemoveFunction(string)` + +Remove a registered SWAIG function. Returns true if +removed, false if not found (Python parity: +`tool_registry.remove_function(name)`). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual bool RemoveFunction(string name) +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 442. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/render-swml.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/render-swml.mdx new file mode 100644 index 0000000000..17a4d39d4e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/render-swml.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/render-swml" +title: "RenderSwml()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.RenderSwml()" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `RenderSwml()` + +Render the SWML document for a request. Override in subclasses to customise. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual Dictionary RenderSwml() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 239. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/run.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/run.mdx new file mode 100644 index 0000000000..138dc22113 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/run.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/run" +title: "Run()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.Run()" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `Run()` + +Start a blocking HTTP server bound to <xref href="SignalWire.SWML.Service.Host" data-throw-if-not-resolved="false"></xref>:<xref href="SignalWire.SWML.Service.Port" data-throw-if-not-resolved="false"></xref>. +Each incoming request is dispatched through <xref href="SignalWire.SWML.Service.HandleRequest(System.String%2cSystem.String%2cSystem.Collections.Generic.Dictionary%7bSystem.String%2cSystem.String%7d%2cSystem.String)" data-throw-if-not-resolved="false"></xref>; +the response status / headers / body are written back to the client. + +Mirrors Python's SWMLService.run() — examples and the porting-sdk +audit harness call this directly. + +Uses System.Net.HttpListener (BCL) — no extra deps. Server stops on +Ctrl-C or when the process is killed. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual void Run() +``` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 868. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/service-service-options.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/service-service-options.mdx new file mode 100644 index 0000000000..578e9bfb56 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/service-service-options.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/service-service-options" +title: "Service(ServiceOptions)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.Service(SignalWire.SWML.ServiceOptions)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `Service(ServiceOptions)` + +## Signature + +```dotnet +public Service(ServiceOptions options) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 60. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/sleep-int-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/sleep-int-string.mdx new file mode 100644 index 0000000000..7c971da2ac --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/sleep-int-string.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/sleep-int-string" +title: "Sleep(int, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.Sleep(int, string)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `Sleep(int, string)` + +Add a sleep verb with a duration in milliseconds to the specified section. + +## Signature + +```dotnet +public Service Sleep(int milliseconds, string section = "main") +``` + +## Parameters + + + + + +## Returns + +`SignalWire.SWML.Service` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 150. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/swaig-pre-dispatch-dictionary-string-object-dictionary-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/swaig-pre-dispatch-dictionary-string-object-dictionary-string-string-string.mdx new file mode 100644 index 0000000000..db356faa5a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/swaig-pre-dispatch-dictionary-string-object-dictionary-string-string-string.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/swaig-pre-dispatch-dictionary-string-object-dictionary-string-string-string" +title: "SwaigPreDispatch(Dictionary, Dictionary, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.SwaigPreDispatch(System.Collections.Generic.Dictionary, System.Collections.Generic.Dictionary, string)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "protected" +--- +# `SwaigPreDispatch(Dictionary, Dictionary, string)` + +Extension point: invoked between argument parsing and function +dispatch. Returns (target, shortCircuit). When shortCircuit is +non-null, it's returned directly without calling OnFunctionCall. +AgentBase may override to add session-token validation or ephemeral +dynamic-config copies. + +**Modifiers:** `virtual` + +## Signature + +```dotnet +protected virtual (Service Target, Dictionary? ShortCircuit) SwaigPreDispatch(Dictionary requestData, Dictionary headers, string functionName) +``` + +## Parameters + + + + + + + +## Returns + +`System.ValueTuple>` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 527. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/validate-basic-auth-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/validate-basic-auth-string-string.mdx new file mode 100644 index 0000000000..91c8e94b2f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/validate-basic-auth-string-string.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/validate-basic-auth-string-string" +title: "ValidateBasicAuth(string, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.ValidateBasicAuth(string, string)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `ValidateBasicAuth(string, string)` + +Validate provided basic-auth credentials against the +configured ones (constant-time comparison) +(Python parity: `validate_basic_auth(username, password)`). + +**Modifiers:** `virtual` + +## Signature + +```dotnet +public virtual bool ValidateBasicAuth(string username, string password) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 200. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/service/verb.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/verb.mdx new file mode 100644 index 0000000000..a79e4daed7 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/service/verb.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/service/verb" +title: "Verb" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.Service.Verb(string, string, object?)" + parent: "SignalWire.SWML.Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs" + visibility: "public" +--- +# `Verb` + +Add a verb to the specified section. Validates the verb name against the schema. +Returns this service for fluent chaining. + +## Signature + + + + ```dotnet + public Service Verb(string verbName, string section, object? config) + ``` + + + + ```dotnet + public Service Verb(string verbName, object? config) + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`SignalWire.SWML.Service` + +## Returns (Overload 2) + +`SignalWire.SWML.Service` + +## Source + +[`src/SignalWire/SWML/Service.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Service.cs) + +Line 126. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/add-section-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/add-section-string.mdx new file mode 100644 index 0000000000..579f67b77a --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/add-section-string.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-builder/add-section-string" +title: "AddSection(string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SWMLBuilder.AddSection(string)" + parent: "SignalWire.SWML.SWMLBuilder" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs" + visibility: "public" +--- +# `AddSection(string)` + +Add a section to the underlying document. +(Python parity: `SWMLBuilder.add_section`.) + +## Signature + +```dotnet +public SWMLBuilder AddSection(string sectionName) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWML.SWMLBuilder` + +## Source + +[`src/SignalWire/SWML/SWMLBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs) + +Line 107. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/ai-string-list-dictionary-string-object-string-string-dictionary-string-object-dictionary-string-object.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/ai-string-list-dictionary-string-object-string-string-dictionary-string-object-dictionary-string-object.mdx new file mode 100644 index 0000000000..8e5706c234 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/ai-string-list-dictionary-string-object-string-string-dictionary-string-object-dictionary-string-object.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-builder/ai-string-list-dictionary-string-object-string-string-dictionary-string-object-dictionary-string-object" +title: "Ai(string?, List>?, string?, string?, Dictionary?, Dictionary?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SWMLBuilder.Ai(string?, System.Collections.Generic.List>?, string?, string?, System.Collections.Generic.Dictionary?, System.Collections.Generic.Dictionary?)" + parent: "SignalWire.SWML.SWMLBuilder" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs" + visibility: "public" +--- +# `Ai(string?, List>?, string?, string?, Dictionary?, Dictionary?)` + +Add an `ai` verb. (Python parity: +`SWMLBuilder.ai(prompt_text, prompt_pom, post_prompt, post_prompt_url, swaig, ...)`.) + +## Signature + +```dotnet +public SWMLBuilder Ai(string? promptText = null, List>? promptPom = null, string? postPrompt = null, string? postPromptUrl = null, Dictionary? swaig = null, Dictionary? extraParams = null) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`SignalWire.SWML.SWMLBuilder` + +## Source + +[`src/SignalWire/SWML/SWMLBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs) + +Line 45. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/answer-int-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/answer-int-string.mdx new file mode 100644 index 0000000000..d0ad0deafb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/answer-int-string.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-builder/answer-int-string" +title: "Answer(int?, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SWMLBuilder.Answer(int?, string?)" + parent: "SignalWire.SWML.SWMLBuilder" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs" + visibility: "public" +--- +# `Answer(int?, string?)` + +Add an `answer` verb. (Python parity: +`SWMLBuilder.answer(max_duration, codecs)`.) + +## Signature + +```dotnet +public SWMLBuilder Answer(int? maxDuration = null, string? codecs = null) +``` + +## Parameters + + + + + +## Returns + +`SignalWire.SWML.SWMLBuilder` + +## Source + +[`src/SignalWire/SWML/SWMLBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs) + +Line 24. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/build.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/build.mdx new file mode 100644 index 0000000000..b6a8f716a9 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/build.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-builder/build" +title: "Build()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SWMLBuilder.Build()" + parent: "SignalWire.SWML.SWMLBuilder" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs" + visibility: "public" +--- +# `Build()` + +Build the SWML document as a dict. +(Python parity: `SWMLBuilder.build`.) + +## Signature + +```dotnet +public Dictionary Build() +``` + +## Returns + +`Dictionary` + +## Source + +[`src/SignalWire/SWML/SWMLBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs) + +Line 115. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/hangup-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/hangup-string.mdx new file mode 100644 index 0000000000..deafff4d6e --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/hangup-string.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-builder/hangup-string" +title: "Hangup(string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SWMLBuilder.Hangup(string?)" + parent: "SignalWire.SWML.SWMLBuilder" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs" + visibility: "public" +--- +# `Hangup(string?)` + +Add a `hangup` verb. (Python parity: +`SWMLBuilder.hangup(reason)`.) + +## Signature + +```dotnet +public SWMLBuilder Hangup(string? reason = null) +``` + +## Parameters + + + +## Returns + +`SignalWire.SWML.SWMLBuilder` + +## Source + +[`src/SignalWire/SWML/SWMLBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs) + +Line 35. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/index.mdx new file mode 100644 index 0000000000..b582f4f381 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-builder" +title: "SWMLBuilder" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.SWML.SWMLBuilder" + parent: "SignalWire.SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs" + visibility: "public" +--- +# `SWMLBuilder` + +## Signature + +```dotnet +public class SWMLBuilder +``` + +## Properties + + + +## Methods + + + + Add a section to the underlying document. (Python parity: `SWMLBuilder.add_section`.) + + + + Add an `ai` verb. (Python parity: `SWMLBuilder.ai(prompt_text, prompt_pom, post_prompt, post_prompt_url, swaig, ...)`.) + + + + Add an `answer` verb. (Python parity: `SWMLBuilder.answer(max_duration, codecs)`.) + + + + Build the SWML document as a dict. (Python parity: `SWMLBuilder.build`.) + + + + Add a `hangup` verb. (Python parity: `SWMLBuilder.hangup(reason)`.) + + + + Add a `play` verb. (Python parity: `SWMLBuilder.play(url, urls, volume, say_text, say_voice, say_language)`.) + + + + Render the SWML document as a JSON string. (Python parity: `SWMLBuilder.render`.) + + + + Reset the underlying document. (Python parity: `SWMLBuilder.reset`.) + + + + Add a `say` verb (synthesized speech). (Python parity: `SWMLBuilder.say(text, voice, language)`.) + + + + + +## Source + +[`src/SignalWire/SWML/SWMLBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs) + +Line 13. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/play-string-list-string-double-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/play-string-list-string-double-string-string-string.mdx new file mode 100644 index 0000000000..2c2a2b0956 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/play-string-list-string-double-string-string-string.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-builder/play-string-list-string-double-string-string-string" +title: "Play(string?, List?, double?, string?, string?, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SWMLBuilder.Play(string?, System.Collections.Generic.List?, double?, string?, string?, string?)" + parent: "SignalWire.SWML.SWMLBuilder" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs" + visibility: "public" +--- +# `Play(string?, List?, double?, string?, string?, string?)` + +Add a `play` verb. (Python parity: +`SWMLBuilder.play(url, urls, volume, say_text, say_voice, say_language)`.) + +## Signature + +```dotnet +public SWMLBuilder Play(string? url = null, List? urls = null, double? volume = null, string? sayText = null, string? sayVoice = null, string? sayLanguage = null) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`SignalWire.SWML.SWMLBuilder` + +## Source + +[`src/SignalWire/SWML/SWMLBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs) + +Line 75. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/render.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/render.mdx new file mode 100644 index 0000000000..952f1a6db6 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/render.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-builder/render" +title: "Render()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SWMLBuilder.Render()" + parent: "SignalWire.SWML.SWMLBuilder" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs" + visibility: "public" +--- +# `Render()` + +Render the SWML document as a JSON string. +(Python parity: `SWMLBuilder.render`.) + +## Signature + +```dotnet +public string Render() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/SWML/SWMLBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs) + +Line 119. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/reset.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/reset.mdx new file mode 100644 index 0000000000..39f9be9b44 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/reset.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-builder/reset" +title: "Reset()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SWMLBuilder.Reset()" + parent: "SignalWire.SWML.SWMLBuilder" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs" + visibility: "public" +--- +# `Reset()` + +Reset the underlying document. +(Python parity: `SWMLBuilder.reset`.) + +## Signature + +```dotnet +public SWMLBuilder Reset() +``` + +## Returns + +`SignalWire.SWML.SWMLBuilder` + +## Source + +[`src/SignalWire/SWML/SWMLBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs) + +Line 123. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/say-string-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/say-string-string-string.mdx new file mode 100644 index 0000000000..f208a6554f --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/say-string-string-string.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-builder/say-string-string-string" +title: "Say(string, string?, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SWMLBuilder.Say(string, string?, string?)" + parent: "SignalWire.SWML.SWMLBuilder" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs" + visibility: "public" +--- +# `Say(string, string?, string?)` + +Add a `say` verb (synthesized speech). +(Python parity: `SWMLBuilder.say(text, voice, language)`.) + +## Signature + +```dotnet +public SWMLBuilder Say(string text, string? voice = null, string? language = null) +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire.SWML.SWMLBuilder` + +## Source + +[`src/SignalWire/SWML/SWMLBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs) + +Line 96. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/swml-builder-service.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/swml-builder-service.mdx new file mode 100644 index 0000000000..b1bd533bcb --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-builder/swml-builder-service.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-builder/swml-builder-service" +title: "SWMLBuilder(Service)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SWMLBuilder.SWMLBuilder(SignalWire.SWML.Service)" + parent: "SignalWire.SWML.SWMLBuilder" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs" + visibility: "public" +--- +# `SWMLBuilder(Service)` + +## Signature + +```dotnet +public SWMLBuilder(Service service) +``` + +## Parameters + + + +## Source + +[`src/SignalWire/SWML/SWMLBuilder.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SWMLBuilder.cs) + +Line 17. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-renderer/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-renderer/index.mdx new file mode 100644 index 0000000000..2275764247 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-renderer/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-renderer" +title: "SwmlRenderer" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.SWML.SwmlRenderer" + parent: "SignalWire.SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SwmlRenderer.cs" + visibility: "public" +--- +# `SwmlRenderer` + +**Modifiers:** `static` + +## Signature + +```dotnet +public static class SwmlRenderer +``` + +## Methods + + + + Generate a SWML document for a SWAIG function response — plays the response text and queues any follow-up actions. (Python parity: `SwmlRenderer.render_function_response_swml`.) + + + + Generate a complete SWML document with AI configuration. (Python parity: `SwmlRenderer.render_swml`.) + + + +## Source + +[`src/SignalWire/SWML/SwmlRenderer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SwmlRenderer.cs) + +Line 17. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-renderer/render-function-response-swml-string-service-list-dictionary-string-object-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-renderer/render-function-response-swml-string-service-list-dictionary-string-object-string.mdx new file mode 100644 index 0000000000..a2ec2762db --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-renderer/render-function-response-swml-string-service-list-dictionary-string-object-string.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-renderer/render-function-response-swml-string-service-list-dictionary-string-object-string" +title: "RenderFunctionResponseSwml(string, Service, List>?, string)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SwmlRenderer.RenderFunctionResponseSwml(string, SignalWire.SWML.Service, System.Collections.Generic.List>?, string)" + parent: "SignalWire.SWML.SwmlRenderer" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SwmlRenderer.cs" + visibility: "public" +--- +# `RenderFunctionResponseSwml(string, Service, List>?, string)` + +Generate a SWML document for a SWAIG function response — +plays the response text and queues any follow-up actions. +(Python parity: `SwmlRenderer.render_function_response_swml`.) + +**Modifiers:** `static` + +## Signature + +```dotnet +public static string RenderFunctionResponseSwml(string responseText, Service service, List>? actions = null, string format = "json") +``` + +## Parameters + + + + + + + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/SWML/SwmlRenderer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SwmlRenderer.cs) + +Line 100. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-renderer/render-swml-object-service-string-string-list-dictionary-string-object-string-string-bool-dictionary-string-object-bool-bool-string-bool-string-string.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-renderer/render-swml-object-service-string-string-list-dictionary-string-object-string-string-bool-dictionary-string-object-bool-bool-string-bool-string-string.mdx new file mode 100644 index 0000000000..497d54b1ae --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/swml-renderer/render-swml-object-service-string-string-list-dictionary-string-object-string-string-bool-dictionary-string-object-bool-bool-string-bool-string-string.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/swml-renderer/render-swml-object-service-string-string-list-dictionary-string-object-string-string-bool-dictionary-string-object-bool-bool-string-bool-string-string" +title: "RenderSwml(object, Service, string?, string?, List>?, string?, string?, bool, Dictionary?, bool, bool, string, bool, string, string?)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.SwmlRenderer.RenderSwml(object, SignalWire.SWML.Service, string?, string?, System.Collections.Generic.List>?, string?, string?, bool, System.Collections.Generic.Dictionary?, bool, bool, string, bool, string, string?)" + parent: "SignalWire.SWML.SwmlRenderer" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SwmlRenderer.cs" + visibility: "public" +--- +# `RenderSwml(object, Service, string?, string?, List>?, string?, string?, bool, Dictionary?, bool, bool, string, bool, string, string?)` + +Generate a complete SWML document with AI configuration. +(Python parity: `SwmlRenderer.render_swml`.) + +**Modifiers:** `static` + +## Signature + +```dotnet +public static string RenderSwml(object prompt, Service service, string? postPrompt = null, string? postPromptUrl = null, List>? swaigFunctions = null, string? startupHookUrl = null, string? hangupHookUrl = null, bool promptIsPom = false, Dictionary? @params = null, bool addAnswer = false, bool recordCall = false, string recordFormat = "mp4", bool recordStereo = true, string format = "json", string? defaultWebhookUrl = null) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`string` + +## Source + +[`src/SignalWire/SWML/SwmlRenderer.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/SwmlRenderer.cs) + +Line 21. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/verb-info/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/verb-info/index.mdx new file mode 100644 index 0000000000..8ac11cf514 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/verb-info/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/verb-info" +title: "VerbInfo" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.SWML.VerbInfo" + parent: "SignalWire.SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `VerbInfo` + +Metadata about a single SWML verb parsed from the schema. + +**Modifiers:** `sealed` + +## Signature + +```dotnet +public sealed record VerbInfo : IEquatable +``` + +## Inheritance + +**Implements:** `System.IEquatable` + +## Properties + + + The full JSON schema definition for this verb. + + + + The actual verb name used in SWML documents (e.g. "answer"). + + + + The definition key in the JSON schema (e.g. "Answer"). + + +## Methods + + + + Metadata about a single SWML verb parsed from the schema. + + + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 11. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.swml/verb-info/verb-info-string-string-json-element.mdx b/fern/products/sdk-reference/dotnet/signal-wire.swml/verb-info/verb-info-string-string-json-element.mdx new file mode 100644 index 0000000000..0425f8cfbc --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.swml/verb-info/verb-info-string-string-json-element.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/dotnet/signal-wire.swml/verb-info/verb-info-string-string-json-element" +title: "VerbInfo(string, string, JsonElement)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.SWML.VerbInfo.VerbInfo(string, string, System.Text.Json.JsonElement)" + parent: "SignalWire.SWML.VerbInfo" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs" + visibility: "public" +--- +# `VerbInfo(string, string, JsonElement)` + +Metadata about a single SWML verb parsed from the schema. + +## Signature + +```dotnet +public VerbInfo(string Name, string SchemaName, JsonElement Definition) +``` + +## Parameters + + + The actual verb name used in SWML documents (e.g. "answer"). + + + + The definition key in the JSON schema (e.g. "Answer"). + + + + The full JSON schema definition for this verb. + + +## Source + +[`src/SignalWire/SWML/Schema.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/SWML/Schema.cs) + +Line 11. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.utils/execution-mode/get-execution-mode.mdx b/fern/products/sdk-reference/dotnet/signal-wire.utils/execution-mode/get-execution-mode.mdx new file mode 100644 index 0000000000..7a9d04e5f5 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.utils/execution-mode/get-execution-mode.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/dotnet/signal-wire.utils/execution-mode/get-execution-mode" +title: "GetExecutionMode()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Utils.ExecutionMode.GetExecutionMode()" + parent: "SignalWire.Utils.ExecutionMode" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/ExecutionMode.cs" + visibility: "public" +--- +# `GetExecutionMode()` + +Returns the execution-mode string — +`"server"` (default), `"cgi"`, `"lambda"`, +`"google_cloud_function"`, `"azure_function"`. +(Python parity: +`signalwire.core.logging_config.get_execution_mode`.) + +**Modifiers:** `static` + +## Signature + +```dotnet +public static string GetExecutionMode() +``` + +## Returns + +`string` + +## Source + +[`src/SignalWire/Utils/ExecutionMode.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/ExecutionMode.cs) + +Line 19. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.utils/execution-mode/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.utils/execution-mode/index.mdx new file mode 100644 index 0000000000..f9fb8f363b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.utils/execution-mode/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.utils/execution-mode" +title: "ExecutionMode" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Utils.ExecutionMode" + parent: "SignalWire.Utils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/ExecutionMode.cs" + visibility: "public" +--- +# `ExecutionMode` + +**Modifiers:** `static` + +## Signature + +```dotnet +public static class ExecutionMode +``` + +## Methods + + + + Returns the execution-mode string — `"server"` (default), `"cgi"`, `"lambda"`, `"google_cloud_function"`, `"azure_function"`. (Python parity: `signalwire.core.logging_config.get_execution_mode`.) + + + + True when running in any serverless environment (anything other than `"server"`). (Python parity: `signalwire.utils.is_serverless_mode`.) + + + +## Source + +[`src/SignalWire/Utils/ExecutionMode.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/ExecutionMode.cs) + +Line 12. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.utils/execution-mode/is-serverless-mode.mdx b/fern/products/sdk-reference/dotnet/signal-wire.utils/execution-mode/is-serverless-mode.mdx new file mode 100644 index 0000000000..1fdaf9a17b --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.utils/execution-mode/is-serverless-mode.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/dotnet/signal-wire.utils/execution-mode/is-serverless-mode" +title: "IsServerlessMode()" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Utils.ExecutionMode.IsServerlessMode()" + parent: "SignalWire.Utils.ExecutionMode" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/ExecutionMode.cs" + visibility: "public" +--- +# `IsServerlessMode()` + +True when running in any serverless environment +(anything other than `"server"`). (Python parity: +`signalwire.utils.is_serverless_mode`.) + +**Modifiers:** `static` + +## Signature + +```dotnet +public static bool IsServerlessMode() +``` + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Utils/ExecutionMode.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/ExecutionMode.cs) + +Line 44. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.utils/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.utils/index.mdx new file mode 100644 index 0000000000..9669851bbf --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.utils/index.mdx @@ -0,0 +1,20 @@ +--- +slug: "/reference/dotnet/signal-wire.utils" +title: "SignalWire.Utils" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "module" + language: "dotnet" + qualified_name: "SignalWire.Utils" +--- +# `SignalWire.Utils` + +## Classes + + + + + + diff --git a/fern/products/sdk-reference/dotnet/signal-wire.utils/url-validator/index.mdx b/fern/products/sdk-reference/dotnet/signal-wire.utils/url-validator/index.mdx new file mode 100644 index 0000000000..46569e5183 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.utils/url-validator/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/dotnet/signal-wire.utils/url-validator" +title: "UrlValidator" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "class" + language: "dotnet" + qualified_name: "SignalWire.Utils.UrlValidator" + parent: "SignalWire.Utils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/UrlValidator.cs" + visibility: "public" +--- +# `UrlValidator` + +**Modifiers:** `static` + +## Signature + +```dotnet +public static class UrlValidator +``` + +## Methods + + + + Validate that a URL is safe to fetch (not pointing to private/internal resources). Returns true when safe, false when rejected. (Python parity: `signalwire.utils.url_validator.validate_url(url, allow_private)`.) + + + + Test-friendly overload that accepts already-resolved IPs instead of doing a live DNS lookup. Cross-language audit / unit tests use this to exercise the blocked-range logic deterministically. + + + +## Source + +[`src/SignalWire/Utils/UrlValidator.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/UrlValidator.cs) + +Line 14. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.utils/url-validator/validate-url-string-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.utils/url-validator/validate-url-string-bool.mdx new file mode 100644 index 0000000000..3ff6de6487 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.utils/url-validator/validate-url-string-bool.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/dotnet/signal-wire.utils/url-validator/validate-url-string-bool" +title: "ValidateUrl(string, bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Utils.UrlValidator.ValidateUrl(string, bool)" + parent: "SignalWire.Utils.UrlValidator" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/UrlValidator.cs" + visibility: "public" +--- +# `ValidateUrl(string, bool)` + +Validate that a URL is safe to fetch (not pointing to +private/internal resources). Returns true when safe, false when +rejected. (Python parity: +`signalwire.utils.url_validator.validate_url(url, allow_private)`.) + +**Modifiers:** `static` + +## Signature + +```dotnet +public static bool ValidateUrl(string url, bool allowPrivate = false) +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Utils/UrlValidator.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/UrlValidator.cs) + +Line 20. diff --git a/fern/products/sdk-reference/dotnet/signal-wire.utils/url-validator/validate-url-with-resolved-addresses-string-ip-address-bool.mdx b/fern/products/sdk-reference/dotnet/signal-wire.utils/url-validator/validate-url-with-resolved-addresses-string-ip-address-bool.mdx new file mode 100644 index 0000000000..3586864b59 --- /dev/null +++ b/fern/products/sdk-reference/dotnet/signal-wire.utils/url-validator/validate-url-with-resolved-addresses-string-ip-address-bool.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/dotnet/signal-wire.utils/url-validator/validate-url-with-resolved-addresses-string-ip-address-bool" +title: "ValidateUrlWithResolvedAddresses(string, IPAddress[], bool)" +sdk_label: ".NET SDK" +icon: "dotnet" +lustri: + auto_generated: true + kind: "method" + language: "dotnet" + qualified_name: "SignalWire.Utils.UrlValidator.ValidateUrlWithResolvedAddresses(string, System.Net.IPAddress[], bool)" + parent: "SignalWire.Utils.UrlValidator" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/UrlValidator.cs" + visibility: "public" +--- +# `ValidateUrlWithResolvedAddresses(string, IPAddress[], bool)` + +Test-friendly overload that accepts already-resolved IPs +instead of doing a live DNS lookup. Cross-language audit / unit +tests use this to exercise the blocked-range logic deterministically. + +**Modifiers:** `static` + +## Signature + +```dotnet +public static bool ValidateUrlWithResolvedAddresses(string url, IPAddress[] resolvedAddresses, bool allowPrivate = false) +``` + +## Parameters + + + + + + + +## Returns + +`bool` + +## Source + +[`src/SignalWire/Utils/UrlValidator.cs`](https://github.com/signalwire/signalwire-dotnet/blob/main/src/SignalWire/Utils/UrlValidator.cs) + +Line 79. diff --git a/fern/products/sdk-reference/go/_meta.json b/fern/products/sdk-reference/go/_meta.json new file mode 100644 index 0000000000..9a1c954c47 --- /dev/null +++ b/fern/products/sdk-reference/go/_meta.json @@ -0,0 +1,10 @@ +{ + "language": "go", + "sdk_name": "go-sdk", + "version": null, + "source_repo": "https://github.com/signalwire/signalwire-go", + "format": "mdx", + "platform": "fern", + "base_slug": "/reference/go", + "item_count": 2135 +} \ No newline at end of file diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-signatures/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-signatures/main/index.mdx new file mode 100644 index 0000000000..0717f71ce2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-signatures/main/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-signatures/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/cmd/enumerate-signatures" + module: "github.com.signalwire.signalwire-go.cmd.enumerate-signatures" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/cmd/enumerate-signatures/main.go" +--- +# `main` + +Command enumerate-signatures emits port\_signatures.json — the canonical, signature-level cousin of port\_surface.json. Same shape as porting-sdk/python\_signatures.json (surface\_schema\_v2.json), driven by the same StructTable / FreeFnTable / FactoryInit lookup tables shared with cmd/enumerate-surface. + +This is the Go half of Phase 3 of the cross-language signature audit (see porting-sdk/SIGNATURE\_AUDIT\_PLAN.md). The pipeline: + +1. Walk pkg/\*\*/\*.go via go/ast, collect every public method's source- level signature (param names, type expressions, return types). +2. For each Go struct in surface.StructTable, translate Go method signatures onto the corresponding Python class+method using the same name-translation logic as enumerate-surface. +3. Translate Go source-level type expressions to canonical types (string, int, optional\, list\, dict\, callable\<...>, class:\, ...) via porting-sdk/type\_aliases.yaml. +4. Emit port\_signatures.json validated against porting-sdk/surface\_schema\_v2.json. + +Type translation deliberately uses source-level names (no go/types resolution). The SDK uses standard Go imports throughout — no aliased imports of stdlib types — so source spellings are unambiguous. If a future code change introduces an aliased type, the adapter raises loud failure and the alias table or vocabulary gets extended. + +Usage: + +``` +go run ./cmd/enumerate-signatures # write port_signatures.json +go run ./cmd/enumerate-signatures --strict # fail on any unknown type +go run ./cmd/enumerate-signatures --stdout +``` + +## Signature + +```go +package main +``` + +## Examples + + + + ```go + go run ./cmd/enumerate-signatures # write port_signatures.json + go run ./cmd/enumerate-signatures --strict # fail on any unknown type + go run ./cmd/enumerate-signatures --stdout + ``` + + + + ```go + go run ./cmd/enumerate-signatures # write port_signatures.json + go run ./cmd/enumerate-signatures --strict # fail on any unknown type + go run ./cmd/enumerate-signatures --stdout + ``` + + + +## Source + +[`cmd/enumerate-signatures/main.go`](https://github.com/signalwire/signalwire-go/blob/main/cmd/enumerate-signatures/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-surface/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-surface/main/index.mdx new file mode 100644 index 0000000000..e165b86fbe --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-surface/main/index.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-surface/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/cmd/enumerate-surface" + module: "github.com.signalwire.signalwire-go.cmd.enumerate-surface" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/cmd/enumerate-surface/main.go" +--- +# `main` + +Command enumerate-surface emits a JSON snapshot of the Go SDK's public API translated into Python-reference symbol names. + +The output (“port\_surface.json“) is compared against “porting-sdk/python\_surface.json“ by “diff\_port\_surface.py“ to detect unexcused drift. Each Go struct is mapped onto a (python\_module, python\_class) pair and each Go method onto a python method name — so that “AgentBase.SetPromptText“ is emitted as “signalwire.core.mixins.prompt\_mixin.PromptMixin.set\_prompt\_text“. The same Go struct may contribute to multiple Python classes (“AgentBase“ is scattered across every mixin in the Python tree). + +Usage: + +``` +go run ./cmd/enumerate-surface # writes port_surface.json +go run ./cmd/enumerate-surface --stdout # print to stdout +go run ./cmd/enumerate-surface --check # compare with existing file +``` + +## Signature + +```go +package main +``` + +## Examples + + + + ```go + go run ./cmd/enumerate-surface # writes port_surface.json + go run ./cmd/enumerate-surface --stdout # print to stdout + go run ./cmd/enumerate-surface --check # compare with existing file + ``` + + + + ```go + go run ./cmd/enumerate-surface # writes port_surface.json + go run ./cmd/enumerate-surface --stdout # print to stdout + go run ./cmd/enumerate-surface --check # compare with existing file + ``` + + + +## Classes + + + + PortAdditions is the JSON shape written to port\_additions\_actual.json. Each entry records a Go-only public symbol that wasn't projected into the Python-canonical surface (because it has no entry in StructTable / FreeFnTable). diff\_port\_surface.py reads this file alongside PORT\_ADDITIONS.md and fails CI when an entry isn't documented there. + + + +## Source + +[`cmd/enumerate-surface/main.go`](https://github.com/signalwire/signalwire-go/blob/main/cmd/enumerate-surface/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-surface/main/port-additions/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-surface/main/port-additions/index.mdx new file mode 100644 index 0000000000..bb1dfd152f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-surface/main/port-additions/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-surface/main/port-additions" +title: "PortAdditions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/cmd/enumerate-surface.PortAdditions" + parent: "github.com/signalwire/signalwire-go/cmd/enumerate-surface" + module: "github.com.signalwire.signalwire-go.cmd.enumerate-surface" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/cmd/enumerate-surface/main.go" +--- +# `PortAdditions` + +PortAdditions is the JSON shape written to port\_additions\_actual.json. Each entry records a Go-only public symbol that wasn't projected into the Python-canonical surface (because it has no entry in StructTable / FreeFnTable). diff\_port\_surface.py reads this file alongside PORT\_ADDITIONS.md and fails CI when an entry isn't documented there. + +## Signature + +```go +type PortAdditions struct +``` + +## Properties + + + + + + + + + +## Source + +[`cmd/enumerate-surface/main.go`](https://github.com/signalwire/signalwire-go/blob/main/cmd/enumerate-surface/main.go) + +Line 286. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/basic-auth/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/basic-auth/index.mdx new file mode 100644 index 0000000000..79dcdadce2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/basic-auth/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/basic-auth" +title: "BasicAuth" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/cmd/swaig-test.BasicAuth" + parent: "github.com/signalwire/signalwire-go/cmd/swaig-test" + module: "github.com.signalwire.signalwire-go.cmd.swaig-test" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go" +--- +# `BasicAuth` + +BasicAuth bundles a username/password pair for convenience. + +## Signature + +```go +type BasicAuth struct +``` + +## Properties + + + + + +## Source + +[`cmd/swaig-test/simulate.go`](https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go) + +Line 507. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/handler-factory.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/handler-factory.mdx new file mode 100644 index 0000000000..9e571c43a1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/handler-factory.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/handler-factory" +title: "HandlerFactory" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/cmd/swaig-test.HandlerFactory" + parent: "github.com/signalwire/signalwire-go/cmd/swaig-test" + module: "github.com.signalwire.signalwire-go.cmd.swaig-test" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go" +--- +# `HandlerFactory` + +HandlerFactory is a zero-arg function that constructs the http.Handler under test. The factory is called AFTER the simulator has activated the platform env vars, so any env-var-driven state the agent captures at construction (notably SWML\_PROXY\_URL\_BASE, which pkg/swml.Service reads in its constructor) reflects the simulated environment rather than the outer shell. + +This mirrors the Python SDK's mock\_env.py flow: env vars are set first, then the agent module is imported/loaded, then invocations run against that freshly-loaded agent. + +## Signature + +```go +type HandlerFactory alias +``` + +## Source + +[`cmd/swaig-test/simulate.go`](https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go) + +Line 376. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/index.mdx new file mode 100644 index 0000000000..7ec4d44ffc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/index.mdx @@ -0,0 +1,127 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/cmd/swaig-test" + module: "github.com.signalwire.signalwire-go.cmd.swaig-test" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/main.go" +--- +# `main` + +Command swaig-test is a CLI tool for testing SWAIG agents by exercising their HTTP endpoints. Unlike the Python SDK's swaig-test which loads agent files dynamically, this tool operates against a running agent server. + +Usage: + +``` +swaig-test --url http://user:pass@localhost:3000/ --dump-swml +swaig-test --url http://user:pass@localhost:3000/ --list-tools +swaig-test --url http://user:pass@localhost:3000/ --exec get_weather --param location=London +``` + +Binary-introspection mode (no HTTP): + +``` +swaig-test --example swmlservice_swaig_standalone --list-tools +``` + +In `--example` mode the CLI runs `go run ./examples/` with SWAIG\_LIST\_TOOLS=1 set in the subprocess environment. The SDK's Service.Serve() honors that env var by printing the registered tool registry between **SWAIG\_TOOLS\_BEGIN** / **SWAIG\_TOOLS\_END** sentinels and exiting 0 BEFORE binding any port. The CLI captures stdout, slices between the sentinels, parses the JSON, and pretty-prints — no HTTP, no /swaig endpoint, no rendered-SWML walk required. + +Simulator support for `--simulate-serverless` mode. + +In the Python SDK, `swaig-test` can load an agent from a source file and dispatch invocations through the chosen serverless adapter in-process. Go has no equivalent dynamic-loader for compiled binaries, so the simulator is split in two: + +1. A library API (this file) that sets/clears the mode-detection env vars, dispatches a synthetic Lambda Function URL event through pkg/lambda, and restores the outer environment on exit. Tests and in-process callers (e.g. users who embed `swaig-test` in their own test suites) drive the simulator through this API. +2. A flag on the `swaig-test` CLI (see main.go) that validates the requested platform against what the port actually implements and surfaces a clear error for unsupported platforms (Phase 9 of the porting guide). The flag also works with --url: it sets the mode-detection env vars for the duration of the invocation so the server-side URL generation goes through the platform branch. + +The simulator mirrors the behaviour of Python's `signalwire/cli/simulation/mock_env.py`: + +- Platform preset env vars are applied (AWS\_LAMBDA\_FUNCTION\_NAME etc). +- Conflicting env vars — most importantly SWML\_PROXY\_URL\_BASE — are cleared so platform-specific URL generation is actually exercised. +- The original env is restored on exit, whether the simulated call succeeded, errored, or panicked. Leaking env across simulations would corrupt later tests in the same process. + +## Signature + +```go +package main +``` + +## Examples + + + + ```go + swaig-test --url http://user:pass@localhost:3000/ --dump-swml + swaig-test --url http://user:pass@localhost:3000/ --list-tools + swaig-test --url http://user:pass@localhost:3000/ --exec get_weather --param location=London + ``` + + + + ```go + swaig-test --example swmlservice_swaig_standalone --list-tools + ``` + + + + ```go + swaig-test --url http://user:pass@localhost:3000/ --dump-swml + swaig-test --url http://user:pass@localhost:3000/ --list-tools + swaig-test --url http://user:pass@localhost:3000/ --exec get_weather --param location=London + ``` + + + + ```go + swaig-test --example swmlservice_swaig_standalone --list-tools + ``` + + + +## Functions + + + + SimulateDumpSWMLViaLambda activates the Lambda environment, calls the factory to construct the agent (so any env-captured state reflects the simulated Lambda environment), issues a POST to the agent's route through the Lambda adapter, and returns the response body (the SWML document JSON). It's the library-side equivalent of `swaig-test --simulate-serverless lambda --dump-swml`, usable from in-process tests. + + + + SimulateExecToolViaLambda activates the Lambda environment, calls the factory to construct the agent (so any env-captured state reflects the simulated Lambda environment), and dispatches a SWAIG tool invocation through the Lambda adapter at `/swaig`. Returns the raw response body. + + + + SimulateLambdaInvocation runs a single synthetic Lambda Function URL event against the given handler with the Lambda environment active. It does NOT touch env vars itself — call activateLambdaEnv first and defer restore() so the env change has the right scope. + + + +## Type Aliases + + + + HandlerFactory is a zero-arg function that constructs the http.Handler under test. The factory is called AFTER the simulator has activated the platform env vars, so any env-var-driven state the agent captures at construction (notably SWML\_PROXY\_URL\_BASE, which pkg/swml.Service reads in its constructor) reflects the simulated environment rather than the outer shell. + + + +## Classes + + + + BasicAuth bundles a username/password pair for convenience. + + + + LambdaSimResult is the decoded result of one synthetic Lambda invocation. Status is the HTTP status returned by the handler, Body is the response body (already base64-decoded if the adapter marked it so), and Headers mirrors the Lambda response envelope's flattened single-value map. + + + + SimulateLambdaOptions tunes an in-process Lambda simulation. + + + +## Source + +[`cmd/swaig-test/main.go`](https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/lambda-sim-result/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/lambda-sim-result/index.mdx new file mode 100644 index 0000000000..4888623575 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/lambda-sim-result/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/lambda-sim-result" +title: "LambdaSimResult" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/cmd/swaig-test.LambdaSimResult" + parent: "github.com/signalwire/signalwire-go/cmd/swaig-test" + module: "github.com.signalwire.signalwire-go.cmd.swaig-test" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go" +--- +# `LambdaSimResult` + +LambdaSimResult is the decoded result of one synthetic Lambda invocation. Status is the HTTP status returned by the handler, Body is the response body (already base64-decoded if the adapter marked it so), and Headers mirrors the Lambda response envelope's flattened single-value map. + +## Signature + +```go +type LambdaSimResult struct +``` + +## Properties + + + + + + + +## Source + +[`cmd/swaig-test/simulate.go`](https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go) + +Line 273. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-dump-swml-via-lambda.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-dump-swml-via-lambda.mdx new file mode 100644 index 0000000000..5e6aa3c454 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-dump-swml-via-lambda.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-dump-swml-via-lambda" +title: "SimulateDumpSWMLViaLambda" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/cmd/swaig-test.SimulateDumpSWMLViaLambda" + parent: "github.com/signalwire/signalwire-go/cmd/swaig-test" + module: "github.com.signalwire.signalwire-go.cmd.swaig-test" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go" +--- +# `SimulateDumpSWMLViaLambda` + +SimulateDumpSWMLViaLambda activates the Lambda environment, calls the factory to construct the agent (so any env-captured state reflects the simulated Lambda environment), issues a POST to the agent's route through the Lambda adapter, and returns the response body (the SWML document JSON). It's the library-side equivalent of `swaig-test --simulate-serverless lambda --dump-swml`, usable from in-process tests. + +The factory-based API is load-bearing: constructing the agent BEFORE activation would let SWML\_PROXY\_URL\_BASE from the outer shell leak into the agent's own proxyURLBase field, and the rendered webhook URLs would point at the outer proxy instead of the simulated Lambda function. Use SimulateDumpSWMLViaLambdaHandler only when you've already verified the handler doesn't capture env state — it skips the activation-ordering guarantee. + +basicAuth, if non-empty in both fields, adds a basic-auth header to the synthetic event so authed agents don't 401. + +## Signature + +```go +func SimulateDumpSWMLViaLambda( + factory HandlerFactory, + agentRoute string, + opts SimulateLambdaOptions, + basicAuth BasicAuth +) ([]byte, error) +``` + +## Parameters + + + + + + + + + +## Returns + +`([]byte, error)` + +## Source + +[`cmd/swaig-test/simulate.go`](https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go) + +Line 396. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-exec-tool-via-lambda.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-exec-tool-via-lambda.mdx new file mode 100644 index 0000000000..fc44f877ff --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-exec-tool-via-lambda.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-exec-tool-via-lambda" +title: "SimulateExecToolViaLambda" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/cmd/swaig-test.SimulateExecToolViaLambda" + parent: "github.com/signalwire/signalwire-go/cmd/swaig-test" + module: "github.com.signalwire.signalwire-go.cmd.swaig-test" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go" +--- +# `SimulateExecToolViaLambda` + +SimulateExecToolViaLambda activates the Lambda environment, calls the factory to construct the agent (so any env-captured state reflects the simulated Lambda environment), and dispatches a SWAIG tool invocation through the Lambda adapter at `/swaig`. Returns the raw response body. + +## Signature + +```go +func SimulateExecToolViaLambda( + factory HandlerFactory, + agentRoute string, + toolName string, + args map[string]any, + opts SimulateLambdaOptions, + basicAuth BasicAuth +) ([]byte, error) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`([]byte, error)` + +## Source + +[`cmd/swaig-test/simulate.go`](https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go) + +Line 445. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-lambda-invocation.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-lambda-invocation.mdx new file mode 100644 index 0000000000..3a56dee2b4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-lambda-invocation.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-lambda-invocation" +title: "SimulateLambdaInvocation" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/cmd/swaig-test.SimulateLambdaInvocation" + parent: "github.com/signalwire/signalwire-go/cmd/swaig-test" + module: "github.com.signalwire.signalwire-go.cmd.swaig-test" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go" +--- +# `SimulateLambdaInvocation` + +SimulateLambdaInvocation runs a single synthetic Lambda Function URL event against the given handler with the Lambda environment active. It does NOT touch env vars itself — call activateLambdaEnv first and defer restore() so the env change has the right scope. + +The split exists so one activation can host multiple invocations (dump-SWML then exec-tool, say) without paying the env save/restore cost per call. + +## Signature + +```go +func SimulateLambdaInvocation( + handler http.Handler, + method string, + path string, + headers map[string]string, + body io.Reader +) (LambdaSimResult, error) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`(LambdaSimResult, error)` + +## Source + +[`cmd/swaig-test/simulate.go`](https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go) + +Line 287. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-lambda-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-lambda-options/index.mdx new file mode 100644 index 0000000000..ae00b36575 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-lambda-options/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main/simulate-lambda-options" +title: "SimulateLambdaOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/cmd/swaig-test.SimulateLambdaOptions" + parent: "github.com/signalwire/signalwire-go/cmd/swaig-test" + module: "github.com.signalwire.signalwire-go.cmd.swaig-test" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go" +--- +# `SimulateLambdaOptions` + +SimulateLambdaOptions tunes an in-process Lambda simulation. + +## Signature + +```go +type SimulateLambdaOptions struct +``` + +## Properties + + + FunctionName overrides AWS\_LAMBDA\_FUNCTION\_NAME. Empty means use the preset default ("test-agent-function"). + + + + FunctionURLOverride, if non-empty, is assigned to AWS\_LAMBDA\_FUNCTION\_URL during the simulation. The default (empty) lets GetFullURL fall back to constructing the URL from AWS\_LAMBDA\_FUNCTION\_NAME + AWS\_REGION, which is the more interesting code path to exercise in tests. + + + + Logger receives warnings about env state — notably if SWML\_PROXY\_URL\_BASE is still set after the clear attempt. A nil Logger sends warnings to os.Stderr. + + + + Region overrides AWS\_REGION. Empty means use the preset default ("us-east-1"). + + +## Source + +[`cmd/swaig-test/simulate.go`](https://github.com/signalwire/signalwire-go/blob/main/cmd/swaig-test/simulate.go) + +Line 195. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/call-flow/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/call-flow/main/index.mdx new file mode 100644 index 0000000000..3651ded4d3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/call-flow/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/call-flow/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/call_flow" + module: "github.com.signalwire.signalwire-go.examples.call_flow" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/call_flow/main.go" +--- +# `main` + +Example: call\_flow + +Call flow verbs and SWAIG actions. Demonstrates pre-answer verbs (ringback), answer configuration, post-answer verbs (welcome audio), post-AI verbs (hangup), debug events, and tools that return call control actions like connect and send\_sms. + +## Signature + +```go +package main +``` + +## Source + +[`examples/call_flow/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/call_flow/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/contexts-demo/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/contexts-demo/main/index.mdx new file mode 100644 index 0000000000..c26e321188 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/contexts-demo/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/contexts-demo/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/contexts_demo" + module: "github.com.signalwire.signalwire-go.examples.contexts_demo" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/contexts_demo/main.go" +--- +# `main` + +Example: contexts\_demo + +Multi-step conversation workflows using contexts and steps. Demonstrates creating multiple contexts with sequential steps, step criteria, navigation rules, function restrictions, and per-context language/voice configuration. + +## Signature + +```go +package main +``` + +## Source + +[`examples/contexts_demo/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/contexts_demo/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/datamap-demo/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/datamap-demo/main/index.mdx new file mode 100644 index 0000000000..c9dd88d932 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/datamap-demo/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/datamap-demo/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/datamap_demo" + module: "github.com.signalwire.signalwire-go.examples.datamap_demo" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/datamap_demo/main.go" +--- +# `main` + +Example: datamap\_demo + +Server-side tools using DataMap that execute on SignalWire servers without requiring webhook endpoints. Demonstrates both webhook-based API calls (with variable expansion) and expression-based pattern matching. + +## Signature + +```go +package main +``` + +## Source + +[`examples/datamap_demo/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/datamap_demo/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/gather-per-question-functions-demo/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/gather-per-question-functions-demo/main/index.mdx new file mode 100644 index 0000000000..2b8f6ba324 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/gather-per-question-functions-demo/main/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/gather-per-question-functions-demo/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/gather_per_question_functions_demo" + module: "github.com.signalwire.signalwire-go.examples.gather_per_question_functions_demo" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/gather_per_question_functions_demo/main.go" +--- +# `main` + +Example: gather\_per\_question\_functions\_demo + +This example exists to teach one specific gotcha: while a step's gather\_info is asking questions, ALL of the step's other functions are forcibly deactivated. The only callable tools during a gather question are: + +- `gather_submit` (the native answer-submission tool, always active) +- Whatever names you list in that question's WithFunctions option + +next\_step and change\_context are also filtered out — the model literally cannot navigate away until the gather completes. This is by design: it forces a tight ask → submit → next-question loop. + +If a question needs to call out to a tool — for example, to validate an email format, geocode a ZIP, or look up something from an external service — you must list that tool name with WithFunctions on that question. The function is active ONLY for that question. + +Below: a customer-onboarding gather flow where each question unlocks a different validation tool, and where the step's own non-gather tools (escalate\_to\_human, lookup\_existing\_account) are LOCKED OUT during gather because they aren't whitelisted on any question. + +Run this file to see the resulting SWML. + +## Signature + +```go +package main +``` + +## Source + +[`examples/gather_per_question_functions_demo/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/gather_per_question_functions_demo/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/livewire-agent/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/livewire-agent/main/index.mdx new file mode 100644 index 0000000000..bc060b6cf6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/livewire-agent/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/livewire-agent/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/livewire_agent" + module: "github.com.signalwire.signalwire-go.examples.livewire_agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/livewire_agent/main.go" +--- +# `main` + +Example: livewire\_agent + +Demonstrates a LiveKit-style agent running on SignalWire's platform. Uses familiar LiveKit API symbols — just change your import path. + +## Signature + +```go +package main +``` + +## Source + +[`examples/livewire_agent/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/livewire_agent/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/mcp-agent/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/mcp-agent/main/index.mdx new file mode 100644 index 0000000000..d6125bc0b7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/mcp-agent/main/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/mcp-agent/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/mcp_agent" + module: "github.com.signalwire.signalwire-go.examples.mcp_agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/mcp_agent/main.go" +--- +# `main` + +Example: mcp\_agent + +Demonstrates both MCP features: + +1. MCP Server: Exposes tools at /mcp so external MCP clients (Claude Desktop, other agents) can discover and invoke them. + +2. MCP Client: Connects to external MCP servers to pull in additional tools for voice calls. + +Usage: + +``` +go run examples/mcp_agent/main.go + +Then: +- Point a SignalWire phone number at http://your-server:3000/agent +- Connect Claude Desktop to http://your-server:3000/agent/mcp +``` + +## Signature + +```go +package main +``` + +## Examples + + + + ```go + go run examples/mcp_agent/main.go + + Then: + - Point a SignalWire phone number at http://your-server:3000/agent + - Connect Claude Desktop to http://your-server:3000/agent/mcp + ``` + + + + ```go + go run examples/mcp_agent/main.go + + Then: + - Point a SignalWire phone number at http://your-server:3000/agent + - Connect Claude Desktop to http://your-server:3000/agent/mcp + ``` + + + +## Source + +[`examples/mcp_agent/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/mcp_agent/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/multi-agent-server/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/multi-agent-server/main/index.mdx new file mode 100644 index 0000000000..83e6f2c37c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/multi-agent-server/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/multi-agent-server/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/multi_agent_server" + module: "github.com.signalwire.signalwire-go.examples.multi_agent_server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/multi_agent_server/main.go" +--- +# `main` + +Example: multi\_agent\_server + +Hosts multiple AI agents on a single HTTP server using AgentServer. Each agent gets its own route and has unique prompts and tools. + +## Signature + +```go +package main +``` + +## Source + +[`examples/multi_agent_server/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/multi_agent_server/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/prefab-info-gatherer/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/prefab-info-gatherer/main/index.mdx new file mode 100644 index 0000000000..613bba56ae --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/prefab-info-gatherer/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/prefab-info-gatherer/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/prefab_info_gatherer" + module: "github.com.signalwire.signalwire-go.examples.prefab_info_gatherer" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/prefab_info_gatherer/main.go" +--- +# `main` + +Example: prefab\_info\_gatherer + +Prefab agent usage. The InfoGathererAgent is a pre-built agent pattern that collects answers to a series of questions sequentially. It comes with built-in tools (start\_questions, submit\_answer) and prompt sections. + +## Signature + +```go +package main +``` + +## Source + +[`examples/prefab_info_gatherer/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/prefab_info_gatherer/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/prefab-survey/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/prefab-survey/main/index.mdx new file mode 100644 index 0000000000..0d6f3f4454 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/prefab-survey/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/prefab-survey/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/prefab_survey" + module: "github.com.signalwire.signalwire-go.examples.prefab_survey" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/prefab_survey/main.go" +--- +# `main` + +Example: prefab\_survey + +Survey prefab agent. The SurveyAgent conducts structured surveys with typed questions (rating, multiple choice, yes/no, open-ended). It includes built-in response validation and a post-prompt that generates a JSON summary of all responses. + +## Signature + +```go +package main +``` + +## Source + +[`examples/prefab_survey/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/prefab_survey/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/relay-audit-harness/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/relay-audit-harness/main/index.mdx new file mode 100644 index 0000000000..383d1a35c3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/relay-audit-harness/main/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/relay-audit-harness/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/relay_audit_harness" + module: "github.com.signalwire.signalwire-go.examples.relay_audit_harness" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/relay_audit_harness/main.go" +--- +# `main` + +Example: relay\_audit\_harness + +Audit-only harness — runs a RelayClient against a local fixture that speaks JSON-RPC 2.0 + the SignalWire RELAY handshake. Used by porting-sdk/scripts/audit\_relay\_handshake.py to prove the Go RELAY client opens a real WebSocket, runs the connect handshake, subscribes to a context, and dispatches an inbound event end-to-end. + +Contract (from porting-sdk SUBAGENT\_PLAYBOOK.md): + +- Reads SIGNALWIRE\_RELAY\_HOST (e.g. "127.0.0.1:5050") +- Reads SIGNALWIRE\_RELAY\_SCHEME (e.g. "ws" — fixture serves plain WebSocket; the SDK honors this env var in its connect URL builder) +- Reads SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, SIGNALWIRE\_CONTEXTS +- Connects, subscribes, waits up to 5s for one inbound event +- When the event arrives, sends a JSON-RPC `signalwire.event` notification back so the fixture sees the dispatch ack +- Exits 0 on success, non-zero on error + +Not for production use. The harness's whole purpose is to give the audit a small, fast binary to drive its fixture against. + +## Signature + +```go +package main +``` + +## Source + +[`examples/relay_audit_harness/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/relay_audit_harness/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/relay-demo/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/relay-demo/main/index.mdx new file mode 100644 index 0000000000..1ea7463691 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/relay-demo/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/relay-demo/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/relay_demo" + module: "github.com.signalwire.signalwire-go.examples.relay_demo" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/relay_demo/main.go" +--- +# `main` + +Example: relay\_demo + +RELAY WebSocket call control. Demonstrates creating a RELAY client, setting an OnCall handler that answers inbound calls, plays TTS audio, and then hangs up. Requires SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, and SIGNALWIRE\_SPACE environment variables. + +## Signature + +```go +package main +``` + +## Source + +[`examples/relay_demo/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/relay_demo/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/rest-audit-harness/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/rest-audit-harness/main/index.mdx new file mode 100644 index 0000000000..3338715df2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/rest-audit-harness/main/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/rest-audit-harness/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/rest_audit_harness" + module: "github.com.signalwire.signalwire-go.examples.rest_audit_harness" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/rest_audit_harness/main.go" +--- +# `main` + +Example: rest\_audit\_harness + +Audit-only harness — drives a single REST operation against the loopback fixture spun up by porting-sdk's audit\_rest\_transport.py. Reads: + +- REST\_OPERATION e.g. "calling.list\_calls", "messaging.send" +- REST\_FIXTURE\_URL "http://127.0.0.1:NNNN" +- REST\_OPERATION\_ARGS JSON dict (forwarded to the operation) +- SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, SIGNALWIRE\_SPACE + +Behavior: constructs a RestClient, overrides its base URL with REST\_FIXTURE\_URL, dispatches the operation, prints the parsed response as JSON to stdout, exits 0 on success / non-zero on error. + +Operation mapping: the audit operations are dotted names that don't always 1:1 with Go method names. The mapping below routes each dotted name to the appropriate Go REST method: + +- calling.list\_calls → Compat.Calls.List (LAML endpoint) +- messaging.send → Compat.Messages.Create +- phone\_numbers.list → PhoneNumbers.List +- fabric.subscribers.list → Fabric.Subscribers.List +- compatibility.calls.list → Compat.Calls.List + +The Calling namespace in Go (and Python) is for relay-native command dispatch (POST /api/calling/calls), not for listing LAML-style calls. The audit's `calling.list_calls` is interpreted as the LAML endpoint because that's the only "list calls" operation the SDK exposes. + +Not for production use. + +## Signature + +```go +package main +``` + +## Source + +[`examples/rest_audit_harness/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/rest_audit_harness/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/rest-demo/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/rest-demo/main/index.mdx new file mode 100644 index 0000000000..2671c5b8fc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/rest-demo/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/rest-demo/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/rest_demo" + module: "github.com.signalwire.signalwire-go.examples.rest_demo" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/rest_demo/main.go" +--- +# `main` + +Example: rest\_demo + +REST API usage with the RestClient. Demonstrates creating a client, listing phone numbers, and shows other namespace usage patterns. Requires SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, and SIGNALWIRE\_SPACE environment variables. + +## Signature + +```go +package main +``` + +## Source + +[`examples/rest_demo/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/rest_demo/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/session-state/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/session-state/main/index.mdx new file mode 100644 index 0000000000..681f5e740c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/session-state/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/session-state/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/session_state" + module: "github.com.signalwire.signalwire-go.examples.session_state" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/session_state/main.go" +--- +# `main` + +Example: session\_state + +Global data management and lifecycle callbacks. Demonstrates setting initial global data, configuring a post-prompt for conversation summaries, registering an OnSummary callback, and defining a tool that uses UpdateGlobalData to track state across interactions. + +## Signature + +```go +package main +``` + +## Source + +[`examples/session_state/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/session_state/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/simple-agent/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/simple-agent/main/index.mdx new file mode 100644 index 0000000000..c417837344 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/simple-agent/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/simple-agent/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/simple_agent" + module: "github.com.signalwire.signalwire-go.examples.simple_agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/simple_agent/main.go" +--- +# `main` + +Example: simple\_agent + +Basic AI agent with prompt and tools. Demonstrates creating an AgentBase, setting prompt text, adding hints and language, defining SWAIG tools, setting global data, and running the agent. + +## Signature + +```go +package main +``` + +## Source + +[`examples/simple_agent/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/simple_agent/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/simple-dynamic-agent/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/simple-dynamic-agent/main/index.mdx new file mode 100644 index 0000000000..a95a832b81 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/simple-dynamic-agent/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/simple-dynamic-agent/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/simple_dynamic_agent" + module: "github.com.signalwire.signalwire-go.examples.simple_dynamic_agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/simple_dynamic_agent/main.go" +--- +# `main` + +Example: simple\_dynamic\_agent + +Per-request agent customization using a dynamic config callback. The callback inspects query parameters to determine the caller's tier (standard vs. premium) and adjusts the prompt, global data, and tools. + +## Signature + +```go +package main +``` + +## Source + +[`examples/simple_dynamic_agent/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/simple_dynamic_agent/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/skills-audit-harness/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/skills-audit-harness/main/index.mdx new file mode 100644 index 0000000000..2a331f45f6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/skills-audit-harness/main/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/skills-audit-harness/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/skills_audit_harness" + module: "github.com.signalwire.signalwire-go.examples.skills_audit_harness" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/skills_audit_harness/main.go" +--- +# `main` + +Example: skills\_audit\_harness + +Audit-only harness — exercises a single network skill against the loopback fixture spun up by porting-sdk's audit\_skills\_dispatch.py. Reads: + +- SKILL\_NAME e.g. "web\_search", "datasphere" +- SKILL\_FIXTURE\_URL "http://127.0.0.1:NNNN" +- SKILL\_HANDLER\_ARGS JSON dict (forwarded to handler / template) +- per-skill upstream env (e.g. WEB\_SEARCH\_BASE\_URL); the audit sets these to point the skill at its loopback fixture +- per-skill credential env vars (e.g. GOOGLE\_API\_KEY); the audit sets fake values that the fixture accepts + +Behavior: + +- For handler-based skills (web\_search, wikipedia\_search, datasphere, spider) the harness instantiates the skill, calls its registered handler with the parsed args, and prints the handler's response. +- For DataMap-based skills (api\_ninjas\_trivia, weather\_api) the SignalWire platform — not the SDK — would normally fetch the configured webhook URL. The harness simulates the platform: it extracts the webhook URL from the registered DataMap, expands %\{args.X\} references against the parsed args, and issues the HTTP call itself. This proves the SDK serialised a real URL and points it at a real upstream — which is what the audit verifies. + +Not for production use. The harness's whole purpose is to give the audit a small, fast binary to drive its fixture against. + +## Signature + +```go +package main +``` + +## Source + +[`examples/skills_audit_harness/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/skills_audit_harness/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/skills-demo/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/skills-demo/main/index.mdx new file mode 100644 index 0000000000..79f2571e12 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/skills-demo/main/index.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/skills-demo/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/skills_demo" + module: "github.com.signalwire.signalwire-go.examples.skills_demo" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/skills_demo/main.go" +--- +# `main` + +Example: skills\_demo + +Skills integration using the built-in skills registry. Demonstrates listing available skills, instantiating them via factory functions, loading them through the SkillManager, and registering their tools with an agent. + +## Signature + +```go +package main +``` + +## Source + +[`examples/skills_demo/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/skills_demo/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/step-function-inheritance-demo/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/step-function-inheritance-demo/main/index.mdx new file mode 100644 index 0000000000..e88ae8eee4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/step-function-inheritance-demo/main/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/step-function-inheritance-demo/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/step_function_inheritance_demo" + module: "github.com.signalwire.signalwire-go.examples.step_function_inheritance_demo" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/step_function_inheritance_demo/main.go" +--- +# `main` + +Example: step\_function\_inheritance\_demo + +This example exists to teach one specific gotcha: the per-step functions whitelist INHERITS from the previous step when omitted. + +Why this matters ---------------- A common mistake when building multi-step agents is to assume each step starts with a fresh tool set. It does not. The runtime only resets the active set when a step explicitly declares its `functions` field. If you forget SetFunctions() on a later step, the previous step's tools quietly remain available. + +This file shows four step-shaped patterns side by side: + +1. step\_lookup — explicitly whitelists `lookup_account` +2. step\_inherit — has NO SetFunctions() call. Inherits step\_lookup's whitelist, so `lookup_account` is still callable here. This is rarely what you want. +3. step\_explicit — explicitly whitelists `process_payment`. The previously inherited `lookup_account` is now disabled, and only `process_payment` is active. +4. step\_disabled — explicitly disables ALL user functions with \[]string\{\} (or "none"). Internal tools like next\_step still work. + +Best practice ------------- Call SetFunctions() on EVERY step that should differ from the previous one. Treat omission as an explicit decision to inherit, not a default. + +Run this file to see the rendered SWML — there are no real webhook endpoints behind the tools, this is purely a documentation example. + +## Signature + +```go +package main +``` + +## Source + +[`examples/step_function_inheritance_demo/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/step_function_inheritance_demo/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/swmlservice-ai-sidecar/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/swmlservice-ai-sidecar/main/index.mdx new file mode 100644 index 0000000000..97b8e4a848 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/swmlservice-ai-sidecar/main/index.mdx @@ -0,0 +1,100 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/swmlservice-ai-sidecar/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/swmlservice_ai_sidecar" + module: "github.com.signalwire.signalwire-go.examples.swmlservice_ai_sidecar" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/swmlservice_ai_sidecar/main.go" +--- +# `main` + +Example: swmlservice\_ai\_sidecar + +Proves that swml.Service can emit the `ai_sidecar` verb, register SWAIG tools the sidecar's LLM can call, and dispatch them end-to-end — without any agent.AgentBase code path. + +The `ai_sidecar` verb runs an AI listener alongside an in-progress call (real-time copilot, transcription analyzer, compliance monitor, etc.). It is NOT an agent — it does not own the call. So the right host is swml.Service, not agent.AgentBase. + +Run: + +``` +go run examples/swmlservice_ai_sidecar/main.go +``` + +What this serves: + +``` +GET /sales-sidecar → SWML doc with the ai_sidecar verb +POST /sales-sidecar/swaig → SWAIG tool dispatch (used by the sidecar's LLM) +POST /sales-sidecar/events → optional event sink for sidecar lifecycle events +``` + +Drive the SWAIG path through the swaig-test CLI: + +``` +go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/sales-sidecar --list-tools +go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/sales-sidecar \ + --exec lookup_competitor --param competitor=ACME +``` + +## Signature + +```go +package main +``` + +## Examples + + + + ```go + go run examples/swmlservice_ai_sidecar/main.go + ``` + + + + ```go + GET /sales-sidecar → SWML doc with the ai_sidecar verb + POST /sales-sidecar/swaig → SWAIG tool dispatch (used by the sidecar's LLM) + POST /sales-sidecar/events → optional event sink for sidecar lifecycle events + ``` + + + + ```go + go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/sales-sidecar --list-tools + go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/sales-sidecar \ + --exec lookup_competitor --param competitor=ACME + ``` + + + + ```go + go run examples/swmlservice_ai_sidecar/main.go + ``` + + + + ```go + GET /sales-sidecar → SWML doc with the ai_sidecar verb + POST /sales-sidecar/swaig → SWAIG tool dispatch (used by the sidecar's LLM) + POST /sales-sidecar/events → optional event sink for sidecar lifecycle events + ``` + + + + ```go + go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/sales-sidecar --list-tools + go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/sales-sidecar \ + --exec lookup_competitor --param competitor=ACME + ``` + + + +## Source + +[`examples/swmlservice_ai_sidecar/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/swmlservice_ai_sidecar/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/swmlservice-swaig-standalone/main/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/swmlservice-swaig-standalone/main/index.mdx new file mode 100644 index 0000000000..4b1e759442 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/examples/swmlservice-swaig-standalone/main/index.mdx @@ -0,0 +1,103 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/examples/swmlservice-swaig-standalone/main" +title: "main" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/examples/swmlservice_swaig_standalone" + module: "github.com.signalwire.signalwire-go.examples.swmlservice_swaig_standalone" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/examples/swmlservice_swaig_standalone/main.go" +--- +# `main` + +Example: swmlservice\_swaig\_standalone + +Proves that swml.Service — by itself, with NO agent.AgentBase — can host SWAIG functions and serve them on its own /swaig endpoint. + +This is the path you take when you want a SWAIG-callable HTTP service that isn't an `` agent: the SWAIG verb is a generic LLM-tool surface and swml.Service is the host. agent.AgentBase is just a swml.Service composition that _also_ layers in prompts, AI config, dynamic config, and token validation. + +Run: + +``` +go run examples/swmlservice_swaig_standalone/main.go +``` + +Then exercise the endpoints: + +``` +curl -u u:p http://localhost:3000/standalone # GET SWML doc +curl -u u:p http://localhost:3000/standalone/swaig \ + -H 'Content-Type: application/json' \ + -d '{"function":"lookup_competitor","argument":{"parsed":[{"competitor":"ACME"}]}}' +``` + +Or drive it through the swaig-test CLI: + +``` +go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/standalone --list-tools +go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/standalone \ + --exec lookup_competitor --param competitor=ACME +``` + +## Signature + +```go +package main +``` + +## Examples + + + + ```go + go run examples/swmlservice_swaig_standalone/main.go + ``` + + + + ```go + curl -u u:p http://localhost:3000/standalone # GET SWML doc + curl -u u:p http://localhost:3000/standalone/swaig \ + -H 'Content-Type: application/json' \ + -d '{"function":"lookup_competitor","argument":{"parsed":[{"competitor":"ACME"}]}}' + ``` + + + + ```go + go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/standalone --list-tools + go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/standalone \ + --exec lookup_competitor --param competitor=ACME + ``` + + + + ```go + go run examples/swmlservice_swaig_standalone/main.go + ``` + + + + ```go + curl -u u:p http://localhost:3000/standalone # GET SWML doc + curl -u u:p http://localhost:3000/standalone/swaig \ + -H 'Content-Type: application/json' \ + -d '{"function":"lookup_competitor","argument":{"parsed":[{"competitor":"ACME"}]}}' + ``` + + + + ```go + go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/standalone --list-tools + go run cmd/swaig-test/main.go --url http://u:p@localhost:3000/standalone \ + --exec lookup_competitor --param competitor=ACME + ``` + + + +## Source + +[`examples/swmlservice_swaig_standalone/main.go`](https://github.com/signalwire/signalwire-go/blob/main/examples/swmlservice_swaig_standalone/main.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-answer-verb.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-answer-verb.mdx new file mode 100644 index 0000000000..7c26def2aa --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-answer-verb.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-answer-verb" +title: "AddAnswerVerb" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddAnswerVerb" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddAnswerVerb` + +AddAnswerVerb configures the answer verb. Merged with defaults at render time. + +## Signature + +```go +func (*AgentBase) AddAnswerVerb(config map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1533. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-function-include.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-function-include.mdx new file mode 100644 index 0000000000..8bff72160a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-function-include.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-function-include" +title: "AddFunctionInclude" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddFunctionInclude" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddFunctionInclude` + +AddFunctionInclude adds a remote SWAIG function include. + +## Signature + +```go +func (*AgentBase) AddFunctionInclude(url string, functions []string, metaData map[string]any) *AgentBase +``` + +## Parameters + + + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1468. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-hint.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-hint.mdx new file mode 100644 index 0000000000..f0817e7ac9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-hint.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-hint" +title: "AddHint" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddHint" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddHint` + +AddHint adds a single speech-recognition hint. + +## Signature + +```go +func (*AgentBase) AddHint(hint string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1082. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-hints.mdx new file mode 100644 index 0000000000..58a70eeb22 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-hints.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-hints" +title: "AddHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddHints" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddHints` + +AddHints adds multiple speech-recognition hints. + +## Signature + +```go +func (*AgentBase) AddHints(hints []string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1090. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-internal-filler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-internal-filler.mdx new file mode 100644 index 0000000000..01eb589945 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-internal-filler.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-internal-filler" +title: "AddInternalFiller" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddInternalFiller" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddInternalFiller` + +AddInternalFiller adds fillers for a specific function and language. + +See SetInternalFillers for the complete list of supported funcName values (SupportedInternalFillerNames) and what fillers do. Names outside the supported set log a warning and are stored but will not play at runtime. + +## Signature + +```go +func (*AgentBase) AddInternalFiller(funcName string, langCode string, fillers []string) *AgentBase +``` + +## Parameters + + + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1440. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-language-typed.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-language-typed.mdx new file mode 100644 index 0000000000..e4a4de4736 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-language-typed.mdx @@ -0,0 +1,93 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-language-typed" +title: "AddLanguageTyped" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddLanguageTyped" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddLanguageTyped` + +AddLanguageTyped adds a language configuration using typed named parameters, matching the Python SDK's add\_language method signature exactly. + +Python equivalent: ai\_config\_mixin.AIConfigMixin.add\_language Python signature: add\_language(name, code, voice, speech\_fillers=None, + +``` +function_fillers=None, engine=None, model=None, params=None) +``` + +Parameters: + +- name: display name (e.g. "English") +- code: BCP-47 language code (e.g. "en-US") +- voice: TTS voice name; may use "engine.voice:model" combined format +- speechFillers: filler phrases for natural speech pauses +- functionFillers: filler phrases played during SWAIG function calls +- engine: explicit TTS engine name (e.g. "elevenlabs") +- model: explicit TTS model name (e.g. "eleven\_turbo\_v2\_5") +- params: optional per-language params dict (engine-specific tuning, voice settings, etc.). Variadic — passing a single non-empty map\[string]any emits the SWML language object's "params" key. Empty or omitted → key not emitted. + +## Signature + +```go +func (*AgentBase) AddLanguageTyped( + name string, + code string, + voice string, + speechFillers []string, + functionFillers []string, + engine string, + model string, + params ...map[string]any +) *AgentBase +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`*AgentBase` + +## Examples + + + + ```go + function_fillers=None, engine=None, model=None, params=None) + ``` + + + + ```go + function_fillers=None, engine=None, model=None, params=None) + ``` + + + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1156. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-language.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-language.mdx new file mode 100644 index 0000000000..e0a5a0d74e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-language.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-language" +title: "AddLanguage" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddLanguage" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddLanguage` + +AddLanguage adds a language configuration as a raw map. + +## Signature + +```go +func (*AgentBase) AddLanguage(config map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1129. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-mcp-server.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-mcp-server.mdx new file mode 100644 index 0000000000..c62f40e772 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-mcp-server.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-mcp-server" +title: "AddMcpServer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddMcpServer" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddMcpServer` + +AddMcpServer adds an external MCP server for tool discovery and invocation. Tools are discovered via the MCP protocol at session start and registered as SWAIG functions. Returns self for method chaining. + +## Signature + +```go +func (*AgentBase) AddMcpServer(cfg MCPServerConfig) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1863. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pattern-hint.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pattern-hint.mdx new file mode 100644 index 0000000000..84f6aecd65 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pattern-hint.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pattern-hint" +title: "AddPatternHint" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddPatternHint" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddPatternHint` + +AddPatternHint adds a pattern-based speech-recognition hint with regex replacement semantics. + +Python equivalent: ai\_config\_mixin.AIConfigMixin.add\_pattern\_hint Python signature: add\_pattern\_hint(hint, pattern, replace, ignore\_case=False) + +The Python implementation appends to self.\_hints (not a separate patternHints list) as a dict with keys "hint", "pattern", "replace", "ignore\_case". The Go implementation stores in patternHints and merges into the rendered "hints" array at render time. + +Parameters: + +- hint: the hint text the model receives +- pattern: regex pattern for the spoken word/phrase +- replace: replacement string for the matched pattern +- ignoreCase: when true, matching is case-insensitive + +## Signature + +```go +func (*AgentBase) AddPatternHint(hint string, pattern string, replace string, ignoreCase ...bool) *AgentBase +``` + +## Parameters + + + + + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1113. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-post-ai-verb.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-post-ai-verb.mdx new file mode 100644 index 0000000000..7a535541d4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-post-ai-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-post-ai-verb" +title: "AddPostAiVerb" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddPostAiVerb" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddPostAiVerb` + +AddPostAiVerb adds a SWML verb to execute after the AI verb. + +## Signature + +```go +func (*AgentBase) AddPostAiVerb(verbName string, config map[string]any) *AgentBase +``` + +## Parameters + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1551. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-post-answer-verb.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-post-answer-verb.mdx new file mode 100644 index 0000000000..27c183755f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-post-answer-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-post-answer-verb" +title: "AddPostAnswerVerb" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddPostAnswerVerb" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddPostAnswerVerb` + +AddPostAnswerVerb adds a SWML verb to execute after the answer. + +## Signature + +```go +func (*AgentBase) AddPostAnswerVerb(verbName string, config map[string]any) *AgentBase +``` + +## Parameters + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1543. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pre-answer-verb.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..9aab6f4b4d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pre-answer-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pre-answer-verb" +title: "AddPreAnswerVerb" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddPreAnswerVerb" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddPreAnswerVerb` + +AddPreAnswerVerb adds a SWML verb to execute before the answer. + +## Signature + +```go +func (*AgentBase) AddPreAnswerVerb(verbName string, config map[string]any) *AgentBase +``` + +## Parameters + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1525. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pronunciation.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pronunciation.mdx new file mode 100644 index 0000000000..95f4efb7b9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pronunciation.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-pronunciation" +title: "AddPronunciation" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddPronunciation" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddPronunciation` + +AddPronunciation adds a pronunciation override rule. + +Python equivalent: ai\_config\_mixin.AIConfigMixin.add\_pronunciation Python signature: add\_pronunciation(replace, with\_text, ignore\_case=False) + +Parameters: + +- replace: the word or expression to match +- withText: the phonetic spelling to substitute +- ignoreCase: when true, matching ignores case (Python: ignore\_case) + +## Signature + +```go +func (*AgentBase) AddPronunciation(replace string, withText string, ignoreCase ...bool) *AgentBase +``` + +## Parameters + + + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1285. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-skill.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-skill.mdx new file mode 100644 index 0000000000..0e1cd7374b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-skill" +title: "AddSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddSkill" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddSkill` + +AddSkill loads a skill by name with optional params and registers its tools. + +## Signature + +```go +func (*AgentBase) AddSkill(skillName string, params map[string]any) *AgentBase +``` + +## Parameters + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2234. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-swaig-query-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-swaig-query-params.mdx new file mode 100644 index 0000000000..89e346b43a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-swaig-query-params.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/add-swaig-query-params" +title: "AddSwaigQueryParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AddSwaigQueryParams" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AddSwaigQueryParams` + +AddSwaigQueryParams adds query parameters that will be appended to SWAIG webhook URLs. + +## Signature + +```go +func (*AgentBase) AddSwaigQueryParams(params map[string]string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1667. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/as-router.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/as-router.mdx new file mode 100644 index 0000000000..c810f0f311 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/as-router.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/as-router" +title: "AsRouter" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AsRouter" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AsRouter` + +AsRouter returns an http.Handler for embedding in a custom server. + +## Signature + +```go +func (*AgentBase) AsRouter() http.Handler +``` + +## Returns + +`http.Handler` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2660. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/auto-map-sip-usernames.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/auto-map-sip-usernames.mdx new file mode 100644 index 0000000000..2947e80753 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/auto-map-sip-usernames.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/auto-map-sip-usernames" +title: "AutoMapSipUsernames" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.AutoMapSipUsernames" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AutoMapSipUsernames` + +AutoMapSipUsernames automatically registers common SIP usernames derived from this agent's name and route. + +Python equivalent: AgentBase.auto\_map\_sip\_usernames (agent\_base.py line 674) + +Derives usernames by: + +1. Stripping non-alphanumeric/underscore chars from the agent name (lowercased) +2. Stripping non-alphanumeric/underscore chars from the route (lowercased) +3. If the cleaned name is longer than 3 chars, also registers a vowel-stripped variant + +## Signature + +```go +func (*AgentBase) AutoMapSipUsernames() *AgentBase +``` + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2191. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..f1ab927a40 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-post-ai-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-post-ai-verbs" +title: "ClearPostAiVerbs" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.ClearPostAiVerbs" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ClearPostAiVerbs` + +ClearPostAiVerbs removes all post-AI verbs. + +## Signature + +```go +func (*AgentBase) ClearPostAiVerbs() *AgentBase +``` + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1575. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..b6be315a4d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-post-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-post-answer-verbs" +title: "ClearPostAnswerVerbs" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.ClearPostAnswerVerbs" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ClearPostAnswerVerbs` + +ClearPostAnswerVerbs removes all post-answer verbs. + +## Signature + +```go +func (*AgentBase) ClearPostAnswerVerbs() *AgentBase +``` + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1567. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..37589d9255 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-pre-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-pre-answer-verbs" +title: "ClearPreAnswerVerbs" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.ClearPreAnswerVerbs" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ClearPreAnswerVerbs` + +ClearPreAnswerVerbs removes all pre-answer verbs. + +## Signature + +```go +func (*AgentBase) ClearPreAnswerVerbs() *AgentBase +``` + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1559. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-swaig-query-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..aae51be26c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-swaig-query-params.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/clear-swaig-query-params" +title: "ClearSwaigQueryParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.ClearSwaigQueryParams" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ClearSwaigQueryParams` + +ClearSwaigQueryParams removes all SWAIG query parameters. + +## Signature + +```go +func (*AgentBase) ClearSwaigQueryParams() *AgentBase +``` + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1677. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/contexts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/contexts.mdx new file mode 100644 index 0000000000..6765cdfb4d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/contexts.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/contexts" +title: "Contexts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.Contexts" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `Contexts` + +Contexts is an alias for DefineContexts. + +## Signature + +```go +func (*AgentBase) Contexts() *contexts.ContextBuilder +``` + +## Returns + +`*contexts.ContextBuilder` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1611. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/create-tool-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/create-tool-token.mdx new file mode 100644 index 0000000000..e572b3156e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/create-tool-token.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/create-tool-token" +title: "CreateToolToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.CreateToolToken" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `CreateToolToken` + +CreateToolToken mints a per-call SWAIG-function token via the agent's SessionManager. Returns an empty string when minting fails (Python parity: state\_mixin.StateMixin.\_create\_tool\_token, which catches all exceptions and returns "" on error). + +## Signature + +```go +func (*AgentBase) CreateToolToken(toolName string, callID string) (token string) +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1839. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-contexts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-contexts.mdx new file mode 100644 index 0000000000..7e887b77c3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-contexts.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-contexts" +title: "DefineContexts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.DefineContexts" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `DefineContexts` + +DefineContexts returns the context builder, creating it if needed. The builder is attached to this agent so Validate() can check user-defined tool names against reserved native tool names (next\_step, change\_context, gather\_submit). + +## Signature + +```go +func (*AgentBase) DefineContexts() *contexts.ContextBuilder +``` + +## Returns + +`*contexts.ContextBuilder` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1590. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-tool.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-tool.mdx new file mode 100644 index 0000000000..57414caf0a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-tool.mdx @@ -0,0 +1,155 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-tool" +title: "DefineTool" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.DefineTool" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `DefineTool` + +DefineTool registers a tool (SWAIG function) with the agent. + +A SWAIG function is exactly the same concept as a "tool" in native OpenAI / Anthropic tool calling. On every LLM turn, the SDK renders each registered SWAIG function into the OpenAI tool schema: + +``` +{ + "type": "function", + "function": { + "name": "your_name_here", + "description": "your description text", + "parameters": { /* your JSON schema */ } + } +} +``` + +That schema is sent to the model as part of the same API call that produces the next assistant message. The model reads: + +- the function Description to decide WHEN to call this tool +- each parameter "description" (inside Parameters) to decide HOW to fill in that argument from the user's utterance + +This means descriptions are prompt engineering, not developer comments. A vague Description is the #1 cause of "the model has the right tool but doesn't call it" failures. + +BAD: + +``` +Description: "Lookup function" +Parameters: {"id": {"type": "string", "description": "the id"}} +``` + +GOOD: + +``` +Description: "Look up a customer's account details by account number. "+ + "Use this BEFORE quoting any account-specific info (balance, "+ + "plan, status). Do not use for general product questions.", +Parameters: map[string]any{ + "account_number": map[string]any{ + "type": "string", + "description": "The customer's 8-digit account number, no "+ + "dashes or spaces. Ask the user if they don't provide it.", + }, +}, +``` + +LLM tool selection accuracy degrades past ~7-8 simultaneously-active tools per call. Use Step.SetFunctions() to partition tools across steps so only the relevant subset is active at any moment. + +## Signature + +```go +func (*AgentBase) DefineTool(def ToolDefinition) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Examples + + + + ```go + { + "type": "function", + "function": { + "name": "your_name_here", + "description": "your description text", + "parameters": { /* your JSON schema */ } + } + } + ``` + + + + ```go + Description: "Lookup function" + Parameters: {"id": {"type": "string", "description": "the id"}} + ``` + + + + ```go + Description: "Look up a customer's account details by account number. "+ + "Use this BEFORE quoting any account-specific info (balance, "+ + "plan, status). Do not use for general product questions.", + Parameters: map[string]any{ + "account_number": map[string]any{ + "type": "string", + "description": "The customer's 8-digit account number, no "+ + "dashes or spaces. Ask the user if they don't provide it.", + }, + }, + ``` + + + + ```go + { + "type": "function", + "function": { + "name": "your_name_here", + "description": "your description text", + "parameters": { /* your JSON schema */ } + } + } + ``` + + + + ```go + Description: "Lookup function" + Parameters: {"id": {"type": "string", "description": "the id"}} + ``` + + + + ```go + Description: "Look up a customer's account details by account number. "+ + "Use this BEFORE quoting any account-specific info (balance, "+ + "plan, status). Do not use for general product questions.", + Parameters: map[string]any{ + "account_number": map[string]any{ + "type": "string", + "description": "The customer's 8-digit account number, no "+ + "dashes or spaces. Ask the user if they don't provide it.", + }, + }, + ``` + + + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 960. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-tools.mdx new file mode 100644 index 0000000000..b3ee783d6d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/define-tools" +title: "DefineTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.DefineTools" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `DefineTools` + +DefineTools returns all registered tool definitions in insertion order. + +## Signature + +```go +func (*AgentBase) DefineTools() []*ToolDefinition +``` + +## Returns + +`[]*ToolDefinition` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1046. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-debug-events.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-debug-events.mdx new file mode 100644 index 0000000000..e1b25b52f1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-debug-events.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-debug-events" +title: "EnableDebugEvents" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.EnableDebugEvents" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `EnableDebugEvents` + +EnableDebugEvents sets the debug events level (0 = off). + +## Signature + +```go +func (*AgentBase) EnableDebugEvents(level int) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1460. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-debug-routes.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-debug-routes.mdx new file mode 100644 index 0000000000..4fc0af785b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-debug-routes.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-debug-routes" +title: "EnableDebugRoutes" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.EnableDebugRoutes" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `EnableDebugRoutes` + +EnableDebugRoutes is a placeholder for adding debug HTTP routes. + +## Signature + +```go +func (*AgentBase) EnableDebugRoutes() *AgentBase +``` + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1685. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-mcp-server.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-mcp-server.mdx new file mode 100644 index 0000000000..deb7b847cb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-mcp-server.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-mcp-server" +title: "EnableMcpServer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.EnableMcpServer" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `EnableMcpServer` + +EnableMcpServer exposes this agent's tools as an MCP server endpoint at /mcp. The endpoint speaks JSON-RPC 2.0 (MCP protocol) and supports initialize, tools/list, tools/call, and ping. Returns self for method chaining. + +## Signature + +```go +func (*AgentBase) EnableMcpServer() *AgentBase +``` + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1884. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-sip-routing.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-sip-routing.mdx new file mode 100644 index 0000000000..6470a8e808 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-sip-routing.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/enable-sip-routing" +title: "EnableSipRouting" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.EnableSipRouting" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `EnableSipRouting` + +EnableSipRouting enables SIP-based routing for this agent. + +Python equivalent: AgentBase.enable\_sip\_routing(auto\_map=True, path="/sip") + +This registers a routing callback at the given path that checks incoming SIP usernames against the agent's registered username set. When autoMap is true, AutoMapSipUsernames is called to derive common usernames from the agent name and route. + +The Python implementation (agent\_base.py line 612) creates a sip\_routing\_callback that extracts the SIP username from the body, checks it against \_sip\_usernames, and returns None in both the matched and unmatched case — letting the normal routing continue. It then calls register\_routing\_callback to register the callback, and optionally calls auto\_map\_sip\_usernames. + +## Signature + +```go +func (*AgentBase) EnableSipRouting(autoMap bool, path string) *AgentBase +``` + +## Parameters + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2080. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-all-functions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-all-functions.mdx new file mode 100644 index 0000000000..86b750ac0e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-all-functions.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-all-functions" +title: "GetAllFunctions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetAllFunctions" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetAllFunctions` + +GetAllFunctions returns a snapshot of all registered SWAIG functions keyed by name. The returned map is a copy — subsequent registrations do not mutate it. (Python parity: “ToolRegistry.get\_all\_functions“.) + +## Signature + +```go +func (*AgentBase) GetAllFunctions() map[string]*ToolDefinition +``` + +## Returns + +`map[string]*ToolDefinition` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1016. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-basic-auth-credentials-with-source.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-basic-auth-credentials-with-source.mdx new file mode 100644 index 0000000000..2f601c0a2d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-basic-auth-credentials-with-source.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-basic-auth-credentials-with-source" +title: "GetBasicAuthCredentialsWithSource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetBasicAuthCredentialsWithSource" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetBasicAuthCredentialsWithSource` + +GetBasicAuthCredentialsWithSource returns the basic-auth credentials plus a string indicating their SOURCE — one of "provided", "environment", or "generated". Mirrors Python's “auth\_mixin.AuthMixin.get\_basic\_auth\_credentials(include\_source=True)“ (auth\_mixin.py line 42-73). + +## Signature + +```go +func (*AgentBase) GetBasicAuthCredentialsWithSource() (user string, pass string, source string) +``` + +## Returns + +`(string, string, string)` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1801. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..ca680bddfe --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-basic-auth-credentials.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-basic-auth-credentials" +title: "GetBasicAuthCredentials" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetBasicAuthCredentials" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetBasicAuthCredentials` + +GetBasicAuthCredentials returns the (username, password) configured for this agent's HTTP basic auth. + +Python equivalent: auth\_mixin.AuthMixin.get\_basic\_auth\_credentials (auth\_mixin.py line 42) Python behavior: returns (username, password) tuple from self.\_basic\_auth + +## Signature + +```go +func (*AgentBase) GetBasicAuthCredentials() (string, string) +``` + +## Returns + +`(string, string)` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1792. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-contexts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-contexts.mdx new file mode 100644 index 0000000000..b7b8032cce --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-contexts.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-contexts" +title: "GetContexts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetContexts" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetContexts` + +GetContexts returns the contexts as a serialised map (the same shape SWML expects), or nil when no contexts have been defined yet. This mirrors Python's “PromptManager.get\_contexts“ which returns the contexts dict or “None“. + +Python equivalent: prompt\_manager.PromptManager.get\_contexts + +## Signature + +```go +func (*AgentBase) GetContexts() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 889. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-full-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-full-url.mdx new file mode 100644 index 0000000000..e1502f2317 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-full-url.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-full-url" +title: "GetFullURL" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetFullURL" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetFullURL` + +GetFullURL returns the full URL for this agent's endpoint, optionally embedding basic-auth credentials. + +Python equivalent: AgentBase.get\_full\_url(include\_auth=False) (agent\_base.py:325) + +The Python implementation handles serverless URL construction (CGI / Lambda / Cloud Functions / Azure) inline. In the Go SDK, serverless URL construction lives in pkg/lambda; this method delegates server-mode URL building to the embedded swml.Service and matches Python's server-mode behavior. + +## Signature + +```go +func (*AgentBase) GetFullURL(includeAuth bool) string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 570. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-function.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-function.mdx new file mode 100644 index 0000000000..aaa3baea72 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-function" +title: "GetFunction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetFunction" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetFunction` + +GetFunction returns the registered tool definition for the given name, or nil when no such function is registered. (Python parity: “ToolRegistry.get\_function“.) + +## Signature + +```go +func (*AgentBase) GetFunction(name string) *ToolDefinition +``` + +## Parameters + + + +## Returns + +`*ToolDefinition` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1004. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-language-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-language-params.mdx new file mode 100644 index 0000000000..0ce077d321 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-language-params.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-language-params" +title: "GetLanguageParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetLanguageParams" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetLanguageParams` + +GetLanguageParams reads the per-language params dict for a previously-added language. + +Python equivalent: ai\_config\_mixin.AIConfigMixin.get\_language\_params Python signature: get\_language\_params(code) -> Optional\[Dict\[str, Any]] + +Returns the params map if set, or nil otherwise (including when the code is unknown). Callers can distinguish "no params set" from "empty params set" by the fact that empty maps are never stored (SetLanguageParams with an empty dict removes the key). + +## Signature + +```go +func (*AgentBase) GetLanguageParams(code string) map[string]any +``` + +## Parameters + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1254. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-name.mdx new file mode 100644 index 0000000000..81f25a742b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-name" +title: "GetName" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetName" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetName` + +GetName returns the agent's name. + +## Signature + +```go +func (*AgentBase) GetName() string +``` + +## Returns + +`string` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 555. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-post-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-post-prompt.mdx new file mode 100644 index 0000000000..9e51c967af --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-post-prompt.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-post-prompt" +title: "GetPostPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetPostPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetPostPrompt` + +GetPostPrompt returns the current post-prompt text. Returns an empty string if no post-prompt has been set. + +Python equivalent: prompt\_mixin.PromptMixin.get\_post\_prompt (prompt\_mixin.py line 374) + +## Signature + +```go +func (*AgentBase) GetPostPrompt() string +``` + +## Returns + +`string` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 866. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-prompt.mdx new file mode 100644 index 0000000000..f798048ce6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-prompt" +title: "GetPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetPrompt` + +GetPrompt returns the current prompt. If POM mode is active, it returns \[]map\[string]any; otherwise it returns the raw string. + +## Signature + +```go +func (*AgentBase) GetPrompt() any +``` + +## Returns + +`any` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 772. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-raw-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-raw-prompt.mdx new file mode 100644 index 0000000000..978f5bf23a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-raw-prompt.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-raw-prompt" +title: "GetRawPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetRawPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetRawPrompt` + +GetRawPrompt returns the raw prompt text whatever “SetPromptText“ stored, regardless of POM mode. Returns an empty string when no raw prompt has been set. + +Python equivalent: prompt\_manager.PromptManager.get\_raw\_prompt + +## Signature + +```go +func (*AgentBase) GetRawPrompt() string +``` + +## Returns + +`string` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 877. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-route.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-route.mdx new file mode 100644 index 0000000000..5219d267cd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-route.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/get-route" +title: "GetRoute" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.GetRoute" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `GetRoute` + +GetRoute returns the agent's configured route path. + +## Signature + +```go +func (*AgentBase) GetRoute() string +``` + +## Returns + +`string` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 548. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/has-function.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/has-function.mdx new file mode 100644 index 0000000000..3b2309a9b9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/has-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/has-function" +title: "HasFunction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.HasFunction" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `HasFunction` + +HasFunction reports whether a SWAIG function with the given name is registered. (Python parity: “ToolRegistry.has\_function“.) + +## Signature + +```go +func (*AgentBase) HasFunction(name string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 994. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/has-skill.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/has-skill.mdx new file mode 100644 index 0000000000..1a0b337ad5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/has-skill.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/has-skill" +title: "HasSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.HasSkill" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `HasSkill` + +HasSkill returns whether a skill is loaded. + +## Signature + +```go +func (*AgentBase) HasSkill(skillName string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2307. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/index.mdx new file mode 100644 index 0000000000..93fe24589b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/index.mdx @@ -0,0 +1,403 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base" +title: "AgentBase" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AgentBase` + +AgentBase is the central agent struct. It embeds \*swml.Service so that Service's fields and methods (Name, Route, Host, Port, basic auth, the HTTP server, the tool registry, etc.) are promoted onto AgentBase. The agent-specific state below is layered on top. + +## Signature + +```go +type AgentBase struct +``` + +## Properties + + + Agent identity — matches Python: self.agent\_id = agent\_id or str(uuid.uuid4()) Exported so callers can read the assigned ID without a getter. + + + + + + +## Methods + + + + AddAnswerVerb configures the answer verb. Merged with defaults at render time. + + + + AddFunctionInclude adds a remote SWAIG function include. + + + + AddHint adds a single speech-recognition hint. + + + + AddHints adds multiple speech-recognition hints. + + + + AddInternalFiller adds fillers for a specific function and language. + + + + AddLanguage adds a language configuration as a raw map. + + + + AddLanguageTyped adds a language configuration using typed named parameters, matching the Python SDK's add\_language method signature exactly. + + + + AddMcpServer adds an external MCP server for tool discovery and invocation. Tools are discovered via the MCP protocol at session start and registered as SWAIG functions. Returns self for method chaining. + + + + AddPatternHint adds a pattern-based speech-recognition hint with regex replacement semantics. + + + + AddPostAiVerb adds a SWML verb to execute after the AI verb. + + + + AddPostAnswerVerb adds a SWML verb to execute after the answer. + + + + AddPreAnswerVerb adds a SWML verb to execute before the answer. + + + + AddPronunciation adds a pronunciation override rule. + + + + AddSkill loads a skill by name with optional params and registers its tools. + + + + AddSwaigQueryParams adds query parameters that will be appended to SWAIG webhook URLs. + + + + AsRouter returns an http.Handler for embedding in a custom server. + + + + AutoMapSipUsernames automatically registers common SIP usernames derived from this agent's name and route. + + + + ClearPostAiVerbs removes all post-AI verbs. + + + + ClearPostAnswerVerbs removes all post-answer verbs. + + + + ClearPreAnswerVerbs removes all pre-answer verbs. + + + + ClearSwaigQueryParams removes all SWAIG query parameters. + + + + Contexts is an alias for DefineContexts. + + + + CreateToolToken mints a per-call SWAIG-function token via the agent's SessionManager. Returns an empty string when minting fails (Python parity: state\_mixin.StateMixin.\_create\_tool\_token, which catches all exceptions and returns "" on error). + + + + DefineContexts returns the context builder, creating it if needed. The builder is attached to this agent so Validate() can check user-defined tool names against reserved native tool names (next\_step, change\_context, gather\_submit). + + + + DefineTool registers a tool (SWAIG function) with the agent. + + + + DefineTools returns all registered tool definitions in insertion order. + + + + EnableDebugEvents sets the debug events level (0 = off). + + + + EnableDebugRoutes is a placeholder for adding debug HTTP routes. + + + + EnableMcpServer exposes this agent's tools as an MCP server endpoint at /mcp. The endpoint speaks JSON-RPC 2.0 (MCP protocol) and supports initialize, tools/list, tools/call, and ping. Returns self for method chaining. + + + + EnableSipRouting enables SIP-based routing for this agent. + + + + GetAllFunctions returns a snapshot of all registered SWAIG functions keyed by name. The returned map is a copy — subsequent registrations do not mutate it. (Python parity: “ToolRegistry.get\_all\_functions“.) + + + + GetBasicAuthCredentials returns the (username, password) configured for this agent's HTTP basic auth. + + + + GetBasicAuthCredentialsWithSource returns the basic-auth credentials plus a string indicating their SOURCE — one of "provided", "environment", or "generated". Mirrors Python's “auth\_mixin.AuthMixin.get\_basic\_auth\_credentials(include\_source=True)“ (auth\_mixin.py line 42-73). + + + + GetContexts returns the contexts as a serialised map (the same shape SWML expects), or nil when no contexts have been defined yet. This mirrors Python's “PromptManager.get\_contexts“ which returns the contexts dict or “None“. + + + + GetFullURL returns the full URL for this agent's endpoint, optionally embedding basic-auth credentials. + + + + GetFunction returns the registered tool definition for the given name, or nil when no such function is registered. (Python parity: “ToolRegistry.get\_function“.) + + + + GetLanguageParams reads the per-language params dict for a previously-added language. + + + + GetName returns the agent's name. + + + + GetPostPrompt returns the current post-prompt text. Returns an empty string if no post-prompt has been set. + + + + GetPrompt returns the current prompt. If POM mode is active, it returns \[]map\[string]any; otherwise it returns the raw string. + + + + GetRawPrompt returns the raw prompt text whatever “SetPromptText“ stored, regardless of POM mode. Returns an empty string when no raw prompt has been set. + + + + GetRoute returns the agent's configured route path. + + + + HasFunction reports whether a SWAIG function with the given name is registered. (Python parity: “ToolRegistry.has\_function“.) + + + + HasSkill returns whether a skill is loaded. + + + + ListSkills returns the names of loaded skills. + + + + ListToolNames returns the names of every registered SWAIG tool in insertion order. Implements contexts.ToolLister. + + + + ManualSetProxyUrl overrides the proxy URL base used for webhook URL generation. + + + + OnDebugEvent registers a callback for debug events. + + + + OnFunctionCall dispatches a SWAIG function call to the registered handler. + + + + OnRequest is called on every SWML request before rendering. Subclasses can override this method to inspect or transform the request data. It delegates to OnSwmlRequest. + + + + OnSummary registers a callback for post-prompt summaries. + + + + OnSwmlRequest is the primary customization point for the user to modify the SWML document based on request data. If a hook has been registered via SetOnSwmlRequestHook the hook is invoked; otherwise this returns nil (no modification). + + + + Pom returns a typed PromptObjectModel built from the agent's current POM sections. Returns nil when use\_pom is false (Python parity: “self.pom“ is “None“ when “use\_pom=False“). The returned value is a deep copy / fresh build — mutations don't affect the agent's internal state. + + + + PromptAddSection appends a new section to the POM prompt. + + + + PromptAddSubsection adds a subsection under an existing parent section. + + + + PromptAddToSection finds an existing POM section by title and appends text and/or bullets. If the section does not exist, it is a no-op. + + + + PromptHasSection returns true if a POM section with the given title exists. + + + + RegisterRoutingCallback registers a callback function that is invoked for incoming requests at the given path to determine routing. + + + + RegisterSipRoutingCallback registers a callback whose string return value triggers an HTTP 307 Temporary Redirect to that route. An empty return value (or a GET / non-POST request) lets normal SWML processing continue. + + + + RegisterSipUsername registers a SIP username that this agent handles. + + + + RegisterSwaigFunction registers a raw SWAIG function definition (e.g. for DataMap tools that don't have a Go handler). + + + + RemoveFunction removes a registered SWAIG function. Returns true when the function was found and removed; false when it wasn't registered. (Python parity: “ToolRegistry.remove\_function“.) + + + + RemoveSkill unloads a skill by name. + + + + RenderSWML builds the complete SWML document for a request. + + + + ResetContexts removes all contexts, returning the agent to a no-contexts state. This is a convenience wrapper around DefineContexts().Reset(). Use it in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + + + + Run starts the HTTP server for the agent. This is a blocking call. + + + + Serve is an alias for Run. + + + + SetDynamicConfigCallback sets a callback invoked on each request to allow per-request agent customisation. + + + + SetFunctionIncludes replaces all function includes. + + + + SetGlobalData replaces all global data. + + + + SetInternalFillers replaces all internal fillers. + + + + SetLanguageParams sets (or replaces) the per-language params dict on an already-added language. Useful when language entries are built up via AddLanguage/AddLanguageTyped first and engine-specific tuning is added later (e.g., from a config loader). + + + + SetLanguages replaces all language configurations. + + + + SetNativeFunctions sets the list of native function names. + + + + SetOnSwmlRequestHook registers a function that customizes the SWML response on a per-request basis. The hook receives the parsed body, the callback path (for routing-callback dispatch), and the raw \*http.Request for header / query inspection. Returning a non-nil map applies modifications to the rendered SWML; returning nil falls through to the default rendering. + + + + SetParam sets a single AI parameter (e.g. temperature, top\_p). + + + + SetParams replaces all AI parameters. + + + + SetPostPrompt sets the post-prompt text used for conversation summary. + + + + SetPostPromptLlmParams sets LLM parameters for the post-prompt. + + + + SetPostPromptUrl sets the URL for post-prompt summary delivery. + + + + SetPromptLlmParams sets LLM parameters for the main prompt. + + + + SetPromptPom sets the POM sections directly and enables POM mode. + + + + SetPromptText sets the agent prompt to raw text, disabling POM mode. + + + + SetPromptTransformer installs a hook that is called with the assembled prompt map before it is placed into the AI verb config. The function may return a new map or mutate and return the same map. Set to nil to remove a previously installed transformer. + + + + SetPronunciations replaces all pronunciation overrides. + + + + SetupGracefulShutdown registers OS signal handlers for SIGTERM and SIGINT that initiate a graceful HTTP server shutdown. This is useful for Kubernetes deployments where the pod receives SIGTERM before termination. + + + + SetWebHookUrl explicitly sets the webhook URL used in SWAIG function defs. + + + + UpdateGlobalData merges data into existing global data. + + + + ValidateBasicAuth validates the provided username and password against the agent's configured basic auth credentials using a constant-time comparison. + + + + ValidateToolToken verifies that a SWAIG tool security token is authentic, unexpired, and matches the given function name and call ID. Returns false when the function is not registered, the SessionManager rejects the token, or the validation panics for any reason. + + + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 322. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/list-skills.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/list-skills.mdx new file mode 100644 index 0000000000..409ee5e257 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/list-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/list-skills" +title: "ListSkills" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.ListSkills" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ListSkills` + +ListSkills returns the names of loaded skills. + +## Signature + +```go +func (*AgentBase) ListSkills() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2302. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/list-tool-names.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/list-tool-names.mdx new file mode 100644 index 0000000000..aeda4e2ffb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/list-tool-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/list-tool-names" +title: "ListToolNames" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.ListToolNames" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ListToolNames` + +ListToolNames returns the names of every registered SWAIG tool in insertion order. Implements contexts.ToolLister. + +## Signature + +```go +func (*AgentBase) ListToolNames() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1602. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/manual-set-proxy-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..c687824c0d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/manual-set-proxy-url.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/manual-set-proxy-url" +title: "ManualSetProxyUrl" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.ManualSetProxyUrl" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ManualSetProxyUrl` + +ManualSetProxyUrl overrides the proxy URL base used for webhook URL generation. + +## Signature + +```go +func (*AgentBase) ManualSetProxyUrl(url string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1642. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-debug-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-debug-event.mdx new file mode 100644 index 0000000000..774fda902d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-debug-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-debug-event" +title: "OnDebugEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.OnDebugEvent" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `OnDebugEvent` + +OnDebugEvent registers a callback for debug events. + +## Signature + +```go +func (*AgentBase) OnDebugEvent(cb DebugEventHandler) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2324. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-function-call.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-function-call.mdx new file mode 100644 index 0000000000..dfb499d8b7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-function-call.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-function-call" +title: "OnFunctionCall" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.OnFunctionCall" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `OnFunctionCall` + +OnFunctionCall dispatches a SWAIG function call to the registered handler. + +## Signature + +```go +func (*AgentBase) OnFunctionCall(name string, args map[string]any, rawData map[string]any) (any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(any, error)` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1059. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-request.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-request.mdx new file mode 100644 index 0000000000..d938aa17c1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-request.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-request" +title: "OnRequest" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.OnRequest" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `OnRequest` + +OnRequest is called on every SWML request before rendering. Subclasses can override this method to inspect or transform the request data. It delegates to OnSwmlRequest. + +Python equivalent: web\_mixin.WebMixin.on\_request (web\_mixin.py line 1266) Python signature: on\_request(request\_data, callback\_path) -> Optional\[dict] + +Returns nil to proceed with default rendering, or a non-nil map containing SWML document overrides. + +## Signature + +```go +func (*AgentBase) OnRequest(requestData map[string]any, callbackPath string) map[string]any +``` + +## Parameters + + + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1699. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-summary.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-summary.mdx new file mode 100644 index 0000000000..66da1caa09 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-summary.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-summary" +title: "OnSummary" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.OnSummary" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `OnSummary` + +OnSummary registers a callback for post-prompt summaries. + +## Signature + +```go +func (*AgentBase) OnSummary(cb SummaryCallback) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2316. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-swml-request.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-swml-request.mdx new file mode 100644 index 0000000000..c33c24fc85 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-swml-request.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/on-swml-request" +title: "OnSwmlRequest" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.OnSwmlRequest" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `OnSwmlRequest` + +OnSwmlRequest is the primary customization point for the user to modify the SWML document based on request data. If a hook has been registered via SetOnSwmlRequestHook the hook is invoked; otherwise this returns nil (no modification). + +Python equivalent: web\_mixin.WebMixin.on\_swml\_request (web\_mixin.py line 1287) Python signature: on\_swml\_request(request\_data, callback\_path, request) -> Optional\[dict] + +Go has no method overriding via embedded structs alone — the hook field is the idiomatic Go equivalent of Python's overridable on\_swml\_request. The third \*http.Request argument is preserved on the Go-native signature (the cross-language audit projects only the first two args). Returning a non-nil map applies modifications to the rendered SWML; returning nil uses the default rendering unchanged. + +## Signature + +```go +func (*AgentBase) OnSwmlRequest(requestData map[string]any, callbackPath string, r *http.Request) map[string]any +``` + +## Parameters + + + + + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1717. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/pom.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/pom.mdx new file mode 100644 index 0000000000..7eba4ccfee --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/pom.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/pom" +title: "Pom" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.Pom" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `Pom` + +Pom returns a typed PromptObjectModel built from the agent's current POM sections. Returns nil when use\_pom is false (Python parity: “self.pom“ is “None“ when “use\_pom=False“). The returned value is a deep copy / fresh build — mutations don't affect the agent's internal state. + +Python equivalent: “agent.pom“ instance attribute (agent\_base.py line 209), which is a “PromptObjectModel“ instance. + +## Signature + +```go +func (*AgentBase) Pom() *pom.PromptObjectModel +``` + +## Returns + +`*pom.PromptObjectModel` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 791. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-section.mdx new file mode 100644 index 0000000000..6970a3ce44 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-section.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-section" +title: "PromptAddSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.PromptAddSection" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `PromptAddSection` + +PromptAddSection appends a new section to the POM prompt. + +Python equivalent: prompt\_mixin.PromptMixin.prompt\_add\_section Added params to match Python signature: numbered, numberedBullets, subsections. - numbered: if true the section itself is rendered with a numeric marker - numberedBullets: if true the bullet list is rendered with numbers - subsections: optional list of child section maps (each with "title", "body", "bullets") + +## Signature + +```go +func (*AgentBase) PromptAddSection( + title string, + body string, + bullets []string, + opts ...PromptSectionOption +) *AgentBase +``` + +## Parameters + + + + + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 611. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-subsection.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-subsection.mdx new file mode 100644 index 0000000000..66eed1f79e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-subsection.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-subsection" +title: "PromptAddSubsection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.PromptAddSubsection" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `PromptAddSubsection` + +PromptAddSubsection adds a subsection under an existing parent section. + +## Signature + +```go +func (*AgentBase) PromptAddSubsection( + parentTitle string, + title string, + body string, + bullets []string +) *AgentBase +``` + +## Parameters + + + + + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 735. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-to-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-to-section.mdx new file mode 100644 index 0000000000..24353302bc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-to-section.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-add-to-section" +title: "PromptAddToSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.PromptAddToSection" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `PromptAddToSection` + +PromptAddToSection finds an existing POM section by title and appends text and/or bullets. If the section does not exist, it is a no-op. + +Python equivalent: prompt\_mixin.PromptMixin.prompt\_add\_to\_section Added params to match Python signature: bullet (single bullet string) and bullets (\[]string list). When body is non-empty it is appended to the section body. When bullet is non-empty it is added to the bullets list. When bullets is non-nil its elements are appended to the bullets list. + +## Signature + +```go +func (*AgentBase) PromptAddToSection(title string, body string, opts ...PromptAddToSectionOption) *AgentBase +``` + +## Parameters + + + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 677. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-has-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-has-section.mdx new file mode 100644 index 0000000000..4d0c86822a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-has-section.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/prompt-has-section" +title: "PromptHasSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.PromptHasSection" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `PromptHasSection` + +PromptHasSection returns true if a POM section with the given title exists. + +## Signature + +```go +func (*AgentBase) PromptHasSection(title string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 759. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-routing-callback.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-routing-callback.mdx new file mode 100644 index 0000000000..0d39d044ea --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-routing-callback.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-routing-callback" +title: "RegisterRoutingCallback" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.RegisterRoutingCallback" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `RegisterRoutingCallback` + +RegisterRoutingCallback registers a callback function that is invoked for incoming requests at the given path to determine routing. + +Python equivalent: web\_mixin.WebMixin.register\_routing\_callback Python signature: register\_routing\_callback(callback\_fn, path="/sip") + +The callback receives the HTTP request and the parsed body. It should return a non-nil map to override the response, or nil to let normal processing continue. This method delegates to swml.Service.RegisterRoutingCallback. + +For Python-aligned redirect semantics (callback returns a route string and the framework issues an HTTP 307 redirect), use RegisterSipRoutingCallback. + +## Signature + +```go +func (*AgentBase) RegisterRoutingCallback( + callbackFn func(r *http.Request, body map[string]any) map[string]any, + path string +) +``` + +## Parameters + + + + + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2128. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-sip-routing-callback.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-sip-routing-callback.mdx new file mode 100644 index 0000000000..9d9c23b836 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-sip-routing-callback.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-sip-routing-callback" +title: "RegisterSipRoutingCallback" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.RegisterSipRoutingCallback" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `RegisterSipRoutingCallback` + +RegisterSipRoutingCallback registers a callback whose string return value triggers an HTTP 307 Temporary Redirect to that route. An empty return value (or a GET / non-POST request) lets normal SWML processing continue. + +Python equivalent: web\_mixin.WebMixin.register\_routing\_callback Python signature: register\_routing\_callback(callback\_fn, path="/sip") + +The Python callback returns Optional\[str]; on a non-None return the framework responds with HTTP 307 + Location: route (web\_mixin.py:628-635). This method preserves that behavior, in contrast to RegisterRoutingCallback which returns a response document override (a richer Go-only mechanism). + +Use this form when porting Python code that relies on redirect-based SIP or route-dispatch patterns. + +## Signature + +```go +func (*AgentBase) RegisterSipRoutingCallback( + callbackFn func(r *http.Request, body map[string]any) string, + path string +) +``` + +## Parameters + + + + + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2149. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-sip-username.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-sip-username.mdx new file mode 100644 index 0000000000..a3cae9d864 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-sip-username.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-sip-username" +title: "RegisterSipUsername" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.RegisterSipUsername" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `RegisterSipUsername` + +RegisterSipUsername registers a SIP username that this agent handles. + +## Signature + +```go +func (*AgentBase) RegisterSipUsername(username string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2222. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-swaig-function.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-swaig-function.mdx new file mode 100644 index 0000000000..c01dcf2458 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-swaig-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/register-swaig-function" +title: "RegisterSwaigFunction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.RegisterSwaigFunction" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `RegisterSwaigFunction` + +RegisterSwaigFunction registers a raw SWAIG function definition (e.g. for DataMap tools that don't have a Go handler). + +## Signature + +```go +func (*AgentBase) RegisterSwaigFunction(funcDef map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 972. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/remove-function.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/remove-function.mdx new file mode 100644 index 0000000000..946d7462d4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/remove-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/remove-function" +title: "RemoveFunction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.RemoveFunction" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `RemoveFunction` + +RemoveFunction removes a registered SWAIG function. Returns true when the function was found and removed; false when it wasn't registered. (Python parity: “ToolRegistry.remove\_function“.) + +## Signature + +```go +func (*AgentBase) RemoveFunction(name string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1029. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/remove-skill.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/remove-skill.mdx new file mode 100644 index 0000000000..c8ae4075c4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/remove-skill.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/remove-skill" +title: "RemoveSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.RemoveSkill" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `RemoveSkill` + +RemoveSkill unloads a skill by name. + +## Signature + +```go +func (*AgentBase) RemoveSkill(skillName string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2296. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/render-swml.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/render-swml.mdx new file mode 100644 index 0000000000..0081c62d51 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/render-swml.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/render-swml" +title: "RenderSWML" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.RenderSWML" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `RenderSWML` + +RenderSWML builds the complete SWML document for a request. + +## Signature + +```go +func (*AgentBase) RenderSWML(requestData map[string]any, request *http.Request) map[string]any +``` + +## Parameters + + + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2475. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/reset-contexts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/reset-contexts.mdx new file mode 100644 index 0000000000..e8fb06bee3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/reset-contexts.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/reset-contexts" +title: "ResetContexts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.ResetContexts" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ResetContexts` + +ResetContexts removes all contexts, returning the agent to a no-contexts state. This is a convenience wrapper around DefineContexts().Reset(). Use it in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + +## Signature + +```go +func (*AgentBase) ResetContexts() *AgentBase +``` + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1619. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/run.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/run.mdx new file mode 100644 index 0000000000..f6a5edfe7f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/run.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/run" +title: "Run" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.Run" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `Run` + +Run starts the HTTP server for the agent. This is a blocking call. + +## Signature + +```go +func (*AgentBase) Run() error +``` + +## Returns + +`error` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2650. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/serve.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/serve.mdx new file mode 100644 index 0000000000..b7ef2f5607 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/serve.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/serve" +title: "Serve" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.Serve" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `Serve` + +Serve is an alias for Run. + +## Signature + +```go +func (*AgentBase) Serve() error +``` + +## Returns + +`error` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 2655. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..2ad822aebc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-dynamic-config-callback.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-dynamic-config-callback" +title: "SetDynamicConfigCallback" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetDynamicConfigCallback" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetDynamicConfigCallback` + +SetDynamicConfigCallback sets a callback invoked on each request to allow per-request agent customisation. + +## Signature + +```go +func (*AgentBase) SetDynamicConfigCallback(cb DynamicConfigCallback) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1634. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-function-includes.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-function-includes.mdx new file mode 100644 index 0000000000..55dfe01b6c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-function-includes.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-function-includes" +title: "SetFunctionIncludes" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetFunctionIncludes" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetFunctionIncludes` + +SetFunctionIncludes replaces all function includes. + +## Signature + +```go +func (*AgentBase) SetFunctionIncludes(includes []map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1483. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-global-data.mdx new file mode 100644 index 0000000000..0ffab66294 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-global-data.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-global-data" +title: "SetGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetGlobalData` + +SetGlobalData replaces all global data. + +## Signature + +```go +func (*AgentBase) SetGlobalData(data map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1324. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-internal-fillers.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-internal-fillers.mdx new file mode 100644 index 0000000000..e995fa1506 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-internal-fillers.mdx @@ -0,0 +1,87 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-internal-fillers" +title: "SetInternalFillers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetInternalFillers" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetInternalFillers` + +SetInternalFillers replaces all internal fillers. + +Internal fillers are short phrases the AI agent speaks (via TTS) while an internal/native function is running, so the caller doesn't hear dead air during transitions or background work. + +Supported function names (match the SWAIGInternalFiller schema): + +``` +hangup — when the agent is hanging up +check_time — when checking the time +wait_for_user — when waiting for user input +wait_seconds — during deliberate pauses +adjust_response_latency — when adjusting response timing +next_step — transitioning between steps in prompt.contexts +change_context — switching between contexts in prompt.contexts +get_visual_input — processing visual input (enable_vision) +get_ideal_strategy — thinking (enable_thinking) +``` + +Notably NOT supported: change\_step, gather\_submit, or arbitrary user-defined SWAIG function names. The runtime only honors fillers for the names listed above; everything else is silently ignored at the SWML level. This method warns at registration time if you pass an unknown name so you catch the typo early. + +## Signature + +```go +func (*AgentBase) SetInternalFillers(fillers map[string]map[string][]string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Examples + + + + ```go + hangup — when the agent is hanging up + check_time — when checking the time + wait_for_user — when waiting for user input + wait_seconds — during deliberate pauses + adjust_response_latency — when adjusting response timing + next_step — transitioning between steps in prompt.contexts + change_context — switching between contexts in prompt.contexts + get_visual_input — processing visual input (enable_vision) + get_ideal_strategy — thinking (enable_thinking) + ``` + + + + ```go + hangup — when the agent is hanging up + check_time — when checking the time + wait_for_user — when waiting for user input + wait_seconds — during deliberate pauses + adjust_response_latency — when adjusting response timing + next_step — transitioning between steps in prompt.contexts + change_context — switching between contexts in prompt.contexts + get_visual_input — processing visual input (enable_vision) + get_ideal_strategy — thinking (enable_thinking) + ``` + + + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1407. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-language-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-language-params.mdx new file mode 100644 index 0000000000..3c9d85e652 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-language-params.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-language-params" +title: "SetLanguageParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetLanguageParams" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetLanguageParams` + +SetLanguageParams sets (or replaces) the per-language params dict on an already-added language. Useful when language entries are built up via AddLanguage/AddLanguageTyped first and engine-specific tuning is added later (e.g., from a config loader). + +Python equivalent: ai\_config\_mixin.AIConfigMixin.set\_language\_params Python signature: set\_language\_params(code, params) + +Parameters: + +- code: language code as previously passed to AddLanguage (e.g. "en-US") +- params: engine-specific params dict to attach. Empty/nil removes the key. + +Returns the AgentBase for chaining. No-op if the code isn't found. + +## Signature + +```go +func (*AgentBase) SetLanguageParams(code string, params map[string]any) *AgentBase +``` + +## Parameters + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1228. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-languages.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-languages.mdx new file mode 100644 index 0000000000..1e1aec4233 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-languages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-languages" +title: "SetLanguages" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetLanguages" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetLanguages` + +SetLanguages replaces all language configurations. + +## Signature + +```go +func (*AgentBase) SetLanguages(languages []map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1269. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-native-functions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-native-functions.mdx new file mode 100644 index 0000000000..59fd6aa7e0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-native-functions.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-native-functions" +title: "SetNativeFunctions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetNativeFunctions" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetNativeFunctions` + +SetNativeFunctions sets the list of native function names. + +## Signature + +```go +func (*AgentBase) SetNativeFunctions(names []string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1342. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-on-swml-request-hook.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-on-swml-request-hook.mdx new file mode 100644 index 0000000000..112d6c283a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-on-swml-request-hook.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-on-swml-request-hook" +title: "SetOnSwmlRequestHook" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetOnSwmlRequestHook" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetOnSwmlRequestHook` + +SetOnSwmlRequestHook registers a function that customizes the SWML response on a per-request basis. The hook receives the parsed body, the callback path (for routing-callback dispatch), and the raw \*http.Request for header / query inspection. Returning a non-nil map applies modifications to the rendered SWML; returning nil falls through to the default rendering. + +Python parity: this is the Go-idiomatic way of "overriding" on\_swml\_request — Go has no method inheritance. + +## Signature + +```go +func (*AgentBase) SetOnSwmlRequestHook(hook OnSwmlRequestHook) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1736. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-param.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-param.mdx new file mode 100644 index 0000000000..6a246ea7b4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-param.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-param" +title: "SetParam" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetParam" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetParam` + +SetParam sets a single AI parameter (e.g. temperature, top\_p). + +## Signature + +```go +func (*AgentBase) SetParam(key string, value any) *AgentBase +``` + +## Parameters + + + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1308. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-params.mdx new file mode 100644 index 0000000000..9724af89d0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-params.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-params" +title: "SetParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetParams" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetParams` + +SetParams replaces all AI parameters. + +## Signature + +```go +func (*AgentBase) SetParams(params map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1316. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..c8dd708ef8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt-llm-params.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt-llm-params" +title: "SetPostPromptLlmParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetPostPromptLlmParams" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetPostPromptLlmParams` + +SetPostPromptLlmParams sets LLM parameters for the post-prompt. + +## Signature + +```go +func (*AgentBase) SetPostPromptLlmParams(params map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1499. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt-url.mdx new file mode 100644 index 0000000000..effec72793 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt-url.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt-url" +title: "SetPostPromptUrl" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetPostPromptUrl" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetPostPromptUrl` + +SetPostPromptUrl sets the URL for post-prompt summary delivery. + +## Signature + +```go +func (*AgentBase) SetPostPromptUrl(url string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1658. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt.mdx new file mode 100644 index 0000000000..a0fe84d3d9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-post-prompt" +title: "SetPostPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetPostPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetPostPrompt` + +SetPostPrompt sets the post-prompt text used for conversation summary. + +## Signature + +```go +func (*AgentBase) SetPostPrompt(text string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 588. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-llm-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..e6bc7ebba4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-llm-params.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-llm-params" +title: "SetPromptLlmParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetPromptLlmParams" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetPromptLlmParams` + +SetPromptLlmParams sets LLM parameters for the main prompt. + +## Signature + +```go +func (*AgentBase) SetPromptLlmParams(params map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1491. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-pom.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-pom.mdx new file mode 100644 index 0000000000..9ebb18b753 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-pom.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-pom" +title: "SetPromptPom" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetPromptPom" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetPromptPom` + +SetPromptPom sets the POM sections directly and enables POM mode. + +## Signature + +```go +func (*AgentBase) SetPromptPom(pom []map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 596. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-text.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-text.mdx new file mode 100644 index 0000000000..ae8fd7b6b4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-text.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-text" +title: "SetPromptText" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetPromptText" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetPromptText` + +SetPromptText sets the agent prompt to raw text, disabling POM mode. + +## Signature + +```go +func (*AgentBase) SetPromptText(text string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 579. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-transformer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-transformer.mdx new file mode 100644 index 0000000000..2002b4e528 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-transformer.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-prompt-transformer" +title: "SetPromptTransformer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetPromptTransformer" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetPromptTransformer` + +SetPromptTransformer installs a hook that is called with the assembled prompt map before it is placed into the AI verb config. The function may return a new map or mutate and return the same map. Set to nil to remove a previously installed transformer. + +This is used by specialised agents (e.g. BedrockAgent) that need to add or filter prompt-level keys without reimplementing all of RenderSWML. + +## Signature + +```go +func (*AgentBase) SetPromptTransformer(fn func(map[string]any) map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1513. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-pronunciations.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-pronunciations.mdx new file mode 100644 index 0000000000..fcec087055 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-pronunciations.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-pronunciations" +title: "SetPronunciations" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetPronunciations" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetPronunciations` + +SetPronunciations replaces all pronunciation overrides. + +## Signature + +```go +func (*AgentBase) SetPronunciations(p []map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1300. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-web-hook-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-web-hook-url.mdx new file mode 100644 index 0000000000..507a104ea9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-web-hook-url.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/set-web-hook-url" +title: "SetWebHookUrl" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetWebHookUrl" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetWebHookUrl` + +SetWebHookUrl explicitly sets the webhook URL used in SWAIG function defs. + +## Signature + +```go +func (*AgentBase) SetWebHookUrl(url string) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1650. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/setup-graceful-shutdown.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/setup-graceful-shutdown.mdx new file mode 100644 index 0000000000..d0e3a14f62 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/setup-graceful-shutdown.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/setup-graceful-shutdown" +title: "SetupGracefulShutdown" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.SetupGracefulShutdown" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SetupGracefulShutdown` + +SetupGracefulShutdown registers OS signal handlers for SIGTERM and SIGINT that initiate a graceful HTTP server shutdown. This is useful for Kubernetes deployments where the pod receives SIGTERM before termination. + +Python equivalent: web\_mixin.WebMixin.setup\_graceful\_shutdown (web\_mixin.py line 1405) Python behavior: registers signal.SIGTERM and signal.SIGINT handlers that call sys.exit(0) after optional cleanup. + +The Go implementation uses signal.NotifyContext so that the active HTTP server (if started via Run/Serve) can shut down cleanly. Call this before Run(). + +## Signature + +```go +func (*AgentBase) SetupGracefulShutdown() +``` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1754. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/update-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/update-global-data.mdx new file mode 100644 index 0000000000..300833de57 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/update-global-data.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/update-global-data" +title: "UpdateGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.UpdateGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `UpdateGlobalData` + +UpdateGlobalData merges data into existing global data. + +## Signature + +```go +func (*AgentBase) UpdateGlobalData(data map[string]any) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1332. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/validate-basic-auth.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/validate-basic-auth.mdx new file mode 100644 index 0000000000..fe5e181203 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/validate-basic-auth.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/validate-basic-auth" +title: "ValidateBasicAuth" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.ValidateBasicAuth" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ValidateBasicAuth` + +ValidateBasicAuth validates the provided username and password against the agent's configured basic auth credentials using a constant-time comparison. + +Python equivalent: auth\_mixin.AuthMixin.validate\_basic\_auth (auth\_mixin.py line 24) Python behavior: hmac.compare\_digest(username, exp\_user) and compare\_digest(password, exp\_pass) + +## Signature + +```go +func (*AgentBase) ValidateBasicAuth(username string, password string) bool +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1780. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/validate-tool-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/validate-tool-token.mdx new file mode 100644 index 0000000000..8dbf5f8c1e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/validate-tool-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-base/validate-tool-token" +title: "ValidateToolToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase.ValidateToolToken" + parent: "github.com/signalwire/signalwire-go/pkg/agent.AgentBase" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ValidateToolToken` + +ValidateToolToken verifies that a SWAIG tool security token is authentic, unexpired, and matches the given function name and call ID. Returns false when the function is not registered, the SessionManager rejects the token, or the validation panics for any reason. + +Python parity: state\_mixin.StateMixin.validate\_tool\_token. Python rejects unknown function names up-front and swallows exceptions, returning false. + +## Signature + +```go +func (*AgentBase) ValidateToolToken(functionName string, token string, callID string) (ok bool) +``` + +## Parameters + + + + + + + +## Returns + +`bool` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1823. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-option.mdx new file mode 100644 index 0000000000..fade45633a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/agent-option" +title: "AgentOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.AgentOption" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `AgentOption` + +AgentOption configures an AgentBase during construction. + +## Signature + +```go +type AgentOption alias +``` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 133. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/debug-event-handler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/debug-event-handler.mdx new file mode 100644 index 0000000000..038ee1ec6f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/debug-event-handler.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/debug-event-handler" +title: "DebugEventHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.DebugEventHandler" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `DebugEventHandler` + +DebugEventHandler is called for debug events if enabled. + +## Signature + +```go +type DebugEventHandler alias +``` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 46. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/dynamic-config-callback.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/dynamic-config-callback.mdx new file mode 100644 index 0000000000..357e889601 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/dynamic-config-callback.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/dynamic-config-callback" +title: "DynamicConfigCallback" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.DynamicConfigCallback" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `DynamicConfigCallback` + +DynamicConfigCallback is invoked on each request to mutate an ephemeral agent copy before rendering. Headers and body params give the callback full context about the inbound request. + +## Signature + +```go +type DynamicConfigCallback alias +``` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 40. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/index.mdx new file mode 100644 index 0000000000..06f2da4085 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/index.mdx @@ -0,0 +1,204 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent" +title: "agent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `agent` + +Package agent provides the core AgentBase type that wires together SWML rendering, tool dispatch, prompt management, AI configuration, and HTTP serving into a single self-contained AI agent. + +## Signature + +```go +package agent +``` + +## Constants + + + SupportedInternalFillerNames is the complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — SetInternalFillers / AddInternalFiller warn if you pass an unknown name. Notable absences: change\_step, gather\_submit, and arbitrary user-defined SWAIG function names are NOT supported. + + +## Functions + + + + NewAgentBase creates a new AgentBase with default values and applies the provided functional options. + + + + WithAgentID sets a fixed agent ID. If not provided, a UUID is generated automatically in NewAgentBase. + + + + WithAIVerbName overrides the SWML verb name used for the AI section. The default is "ai". Set to "amazon\_bedrock" for BedrockAgent. + + + + WithAutoAnswer controls whether the answer verb is emitted automatically. + + + + WithBasicAuth sets explicit basic-auth credentials. + + + + WithBullet adds a single bullet point to an existing section. Python equivalent: bullet= param in prompt\_add\_to\_section + + + + WithBullets adds multiple bullet points to an existing section. Python equivalent: bullets= param in prompt\_add\_to\_section + + + + WithCheckForInputOverride enables the /check\_for\_input endpoint, which allows external systems to inject input into an active AI session. + + + + WithConfigFile sets the path to an optional YAML/JSON service configuration file. When provided, the file is loaded at startup and its values are merged with (but do not override) explicit constructor parameters. + + + + WithDefaultWebhookURL sets the default webhook URL for all SWAIG functions. When set, this URL is used as the fallback for all tools that do not specify their own WebhookURL. + + + + WithEnablePostPromptOverride allows subclasses to override the post-prompt URL with a custom handler. When enabled, the agent registers a /post\_prompt\_override endpoint and routes summary callbacks through it. + + + + WithHost sets the HTTP listen address. + + + + WithName sets the agent (and service) name. + + + + WithNativeFunctions sets the initial list of native (built-in) SWAIG function names to include in the SWAIG object on every rendered document. + + + + WithNumbered marks the section as numbered. Python equivalent: numbered=True in prompt\_add\_section + + + + WithNumberedBullets marks the bullets list as numbered. Python equivalent: numbered\_bullets=True in prompt\_add\_section + + + + WithPort sets the HTTP listen port. + + + + WithRecordCall enables or disables automatic call recording. + + + + WithRecordFormat sets the recording format (e.g. "mp4", "wav"). + + + + WithRecordStereo enables or disables stereo recording. + + + + WithRoute sets the HTTP route path the agent listens on. + + + + WithSchemaPath sets the path to an optional SWML schema file used for validation. If empty, no schema validation is performed. + + + + WithSchemaValidation controls whether the rendered SWML document is validated against the SWML schema before serving. Defaults to true. Can also be disabled via the SWML\_SKIP\_SCHEMA\_VALIDATION=1 environment variable. + + + + WithSigningKey sets the SignalWire Signing Key used to validate inbound webhook signatures. When non-empty, signed routes (POST /, /swaig, /post\_prompt, and any registered routing callbacks) are wrapped with security.WebhookMiddleware — unsigned or mis-signed requests are rejected with HTTP 403 before reaching the handler. + + + + WithSigningKeyTrustProxy enables X-Forwarded-Proto / X-Forwarded-Host honoring during URL reconstruction. Set true when AgentBase runs behind a reverse proxy / ngrok / load balancer that terminates TLS upstream; without it the validator sees the internal scheme/host and the signature will mismatch. + + + + WithSubsections attaches child sections to the parent section. Python equivalent: subsections=\[...] in prompt\_add\_section + + + + WithSuppressLogs disables verbose structured logging from the agent. When true, info-level agent lifecycle logs are suppressed. + + + + WithTokenExpiry sets the token expiry time in seconds for secure tools. + + + + WithUsePom controls whether Prompt Object Model (POM) mode is active. When true (default), structured prompt sections are used; when false, raw text from SetPromptText is used. + + + +## Type Aliases + + + + AgentOption configures an AgentBase during construction. + + + + DebugEventHandler is called for debug events if enabled. + + + + DynamicConfigCallback is invoked on each request to mutate an ephemeral agent copy before rendering. Headers and body params give the callback full context about the inbound request. + + + + OnSwmlRequestHook is the function-field hook that user code can set to override the default SWML-request customization behavior. Returning a non-nil map applies modifications to the rendered SWML; returning nil uses the default rendering unchanged. + + + + PromptAddToSectionOption is a functional option for PromptAddToSection. + + + + PromptSectionOption is a functional option for PromptAddSection. + + + + SummaryCallback is called when a post-prompt summary arrives. + + + + ToolHandler is the signature for SWAIG function handlers. + + + +## Classes + + + + AgentBase is the central agent struct. It embeds \*swml.Service so that Service's fields and methods (Name, Route, Host, Port, basic auth, the HTTP server, the tool registry, etc.) are promoted onto AgentBase. The agent-specific state below is layered on top. + + + + MCPServerConfig holds configuration for an external MCP server connection. + + + + ToolDefinition describes a single SWAIG tool including its JSON Schema parameters and a Go handler function. + + + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/mcp-server-config/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/mcp-server-config/index.mdx new file mode 100644 index 0000000000..eaf31c0ecb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/mcp-server-config/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/mcp-server-config" +title: "MCPServerConfig" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.MCPServerConfig" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `MCPServerConfig` + +MCPServerConfig holds configuration for an external MCP server connection. + +## Signature + +```go +type MCPServerConfig struct +``` + +## Properties + + + + + + + + + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 1853. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/new-agent-base.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/new-agent-base.mdx new file mode 100644 index 0000000000..1d8ddad84e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/new-agent-base.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/new-agent-base" +title: "NewAgentBase" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.NewAgentBase" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `NewAgentBase` + +NewAgentBase creates a new AgentBase with default values and applies the provided functional options. + +## Signature + +```go +func NewAgentBase(opts ...AgentOption) *AgentBase +``` + +## Parameters + + + +## Returns + +`*AgentBase` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 445. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/on-swml-request-hook.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/on-swml-request-hook.mdx new file mode 100644 index 0000000000..1d8cf3dfde --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/on-swml-request-hook.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/on-swml-request-hook" +title: "OnSwmlRequestHook" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.OnSwmlRequestHook" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `OnSwmlRequestHook` + +OnSwmlRequestHook is the function-field hook that user code can set to override the default SWML-request customization behavior. Returning a non-nil map applies modifications to the rendered SWML; returning nil uses the default rendering unchanged. + +Python parity: web\_mixin.WebMixin.on\_swml\_request — Go has no method inheritance, so we expose the override as a settable function field. + +## Signature + +```go +type OnSwmlRequestHook alias +``` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 55. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/prompt-add-to-section-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/prompt-add-to-section-option.mdx new file mode 100644 index 0000000000..8c4bbeb817 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/prompt-add-to-section-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/prompt-add-to-section-option" +title: "PromptAddToSectionOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.PromptAddToSectionOption" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `PromptAddToSectionOption` + +PromptAddToSectionOption is a functional option for PromptAddToSection. + +## Signature + +```go +type PromptAddToSectionOption alias +``` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 720. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/prompt-section-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/prompt-section-option.mdx new file mode 100644 index 0000000000..8d17d4103c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/prompt-section-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/prompt-section-option" +title: "PromptSectionOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.PromptSectionOption" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `PromptSectionOption` + +PromptSectionOption is a functional option for PromptAddSection. + +## Signature + +```go +type PromptSectionOption alias +``` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 649. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/summary-callback.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/summary-callback.mdx new file mode 100644 index 0000000000..34ce9fd833 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/summary-callback.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/summary-callback" +title: "SummaryCallback" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.SummaryCallback" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `SummaryCallback` + +SummaryCallback is called when a post-prompt summary arrives. + +## Signature + +```go +type SummaryCallback alias +``` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 43. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-definition/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-definition/index.mdx new file mode 100644 index 0000000000..8477e7aed1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-definition/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-definition" +title: "ToolDefinition" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.ToolDefinition" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ToolDefinition` + +ToolDefinition describes a single SWAIG tool including its JSON Schema parameters and a Go handler function. + +Python equivalent: signalwire.core.mixins.tool\_mixin.ToolMixin.define\_tool Added fields to match Python: WebhookURL (webhook\_url param), Required (required param for required argument names), IsTypedHandler (is\_typed\_handler). + +## Signature + +```go +type ToolDefinition struct +``` + +## Properties + + + + + + + + + whether handler uses typed structs (Python: is\_typed\_handler) + + + + + + + + JSON Schema for arguments (properties map) + + + + Required parameter names included in the JSON Schema envelope + + + + + + extra per-function SWAIG fields + + + + URL to audio file to play while the function executes + + + + Number of times to loop WaitFile (0 = no loop) + + + + Per-tool webhook URL; overrides the agent-level webhook when non-empty + + +## Methods + + + + ValidateArgs validates the provided args map against the tool's parameter schema. + + + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 67. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-definition/validate-args.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-definition/validate-args.mdx new file mode 100644 index 0000000000..4d891c9a25 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-definition/validate-args.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-definition/validate-args" +title: "ValidateArgs" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.ToolDefinition.ValidateArgs" + parent: "github.com/signalwire/signalwire-go/pkg/agent.ToolDefinition" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ValidateArgs` + +ValidateArgs validates the provided args map against the tool's parameter schema. + +It constructs a JSON Schema envelope from Parameters and Required (matching the shape emitted by buildSwaigFunctions) and validates args against that schema using encoding/json round-trip comparison. When Parameters is nil or empty the function returns (true, nil) immediately, mirroring the Python SDK's behaviour of skipping validation when no schema is declared. + +Go's standard library does not include a JSON Schema validator, so this implementation performs a best-effort structural check: + +- Every key listed in Required must be present in args. +- No third-party dependency is introduced; the check is intentionally lightweight. + +A full JSON Schema validator (e.g. github.com/xeipuuv/gojsonschema) can be swapped in by replacing the body of this method. + +## Signature + +```go +func (*ToolDefinition) ValidateArgs(args map[string]any) (bool, []string) +``` + +## Parameters + + + +## Returns + +`(bool, []string)` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 98. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-handler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-handler.mdx new file mode 100644 index 0000000000..2adcc61a7e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-handler.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/tool-handler" +title: "ToolHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.ToolHandler" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `ToolHandler` + +ToolHandler is the signature for SWAIG function handlers. + +## Signature + +```go +type ToolHandler alias +``` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 35. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-agent-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-agent-id.mdx new file mode 100644 index 0000000000..8f60e64eac --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-agent-id.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-agent-id" +title: "WithAgentID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithAgentID" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithAgentID` + +WithAgentID sets a fixed agent ID. If not provided, a UUID is generated automatically in NewAgentBase. + +Python equivalent: agent\_id parameter in AgentBase.**init** Python behavior: self.agent\_id = agent\_id or str(uuid.uuid4()) + +## Signature + +```go +func WithAgentID(id string) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 217. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-ai-verb-name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-ai-verb-name.mdx new file mode 100644 index 0000000000..ef9c50ca95 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-ai-verb-name.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-ai-verb-name" +title: "WithAIVerbName" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithAIVerbName" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithAIVerbName` + +WithAIVerbName overrides the SWML verb name used for the AI section. The default is "ai". Set to "amazon\_bedrock" for BedrockAgent. + +## Signature + +```go +func WithAIVerbName(name string) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 190. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-auto-answer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-auto-answer.mdx new file mode 100644 index 0000000000..5ce1294acc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-auto-answer.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-auto-answer" +title: "WithAutoAnswer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithAutoAnswer" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithAutoAnswer` + +WithAutoAnswer controls whether the answer verb is emitted automatically. + +## Signature + +```go +func WithAutoAnswer(autoAnswer bool) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 164. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-basic-auth.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-basic-auth.mdx new file mode 100644 index 0000000000..33a42fd17f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-basic-auth.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-basic-auth" +title: "WithBasicAuth" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithBasicAuth" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithBasicAuth` + +WithBasicAuth sets explicit basic-auth credentials. + +## Signature + +```go +func WithBasicAuth(user string, password string) AgentOption +``` + +## Parameters + + + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 156. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-bullet.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-bullet.mdx new file mode 100644 index 0000000000..8d47a2c8a9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-bullet.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-bullet" +title: "WithBullet" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithBullet" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithBullet` + +WithBullet adds a single bullet point to an existing section. Python equivalent: bullet= param in prompt\_add\_to\_section + +## Signature + +```go +func WithBullet(b string) PromptAddToSectionOption +``` + +## Parameters + + + +## Returns + +`PromptAddToSectionOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 724. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-bullets.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-bullets.mdx new file mode 100644 index 0000000000..f1f146dc9b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-bullets.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-bullets" +title: "WithBullets" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithBullets" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithBullets` + +WithBullets adds multiple bullet points to an existing section. Python equivalent: bullets= param in prompt\_add\_to\_section + +## Signature + +```go +func WithBullets(bs []string) PromptAddToSectionOption +``` + +## Parameters + + + +## Returns + +`PromptAddToSectionOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 730. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-check-for-input-override.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-check-for-input-override.mdx new file mode 100644 index 0000000000..5b6a25d2b6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-check-for-input-override.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-check-for-input-override" +title: "WithCheckForInputOverride" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithCheckForInputOverride" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithCheckForInputOverride` + +WithCheckForInputOverride enables the /check\_for\_input endpoint, which allows external systems to inject input into an active AI session. + +Python equivalent: check\_for\_input\_override parameter in AgentBase.**init** + +## Signature + +```go +func WithCheckForInputOverride(enable bool) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 262. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-config-file.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-config-file.mdx new file mode 100644 index 0000000000..ab3874144a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-config-file.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-config-file" +title: "WithConfigFile" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithConfigFile" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithConfigFile` + +WithConfigFile sets the path to an optional YAML/JSON service configuration file. When provided, the file is loaded at startup and its values are merged with (but do not override) explicit constructor parameters. + +Python equivalent: config\_file parameter in AgentBase.**init** + +## Signature + +```go +func WithConfigFile(path string) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 271. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-default-webhook-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-default-webhook-url.mdx new file mode 100644 index 0000000000..0a09b789e0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-default-webhook-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-default-webhook-url" +title: "WithDefaultWebhookURL" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithDefaultWebhookURL" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithDefaultWebhookURL` + +WithDefaultWebhookURL sets the default webhook URL for all SWAIG functions. When set, this URL is used as the fallback for all tools that do not specify their own WebhookURL. + +Python equivalent: default\_webhook\_url parameter in AgentBase.**init** + +## Signature + +```go +func WithDefaultWebhookURL(url string) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 208. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-enable-post-prompt-override.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-enable-post-prompt-override.mdx new file mode 100644 index 0000000000..3775e6fc28 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-enable-post-prompt-override.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-enable-post-prompt-override" +title: "WithEnablePostPromptOverride" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithEnablePostPromptOverride" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithEnablePostPromptOverride` + +WithEnablePostPromptOverride allows subclasses to override the post-prompt URL with a custom handler. When enabled, the agent registers a /post\_prompt\_override endpoint and routes summary callbacks through it. + +Python equivalent: enable\_post\_prompt\_override parameter in AgentBase.**init** + +## Signature + +```go +func WithEnablePostPromptOverride(enable bool) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 254. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-host.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-host.mdx new file mode 100644 index 0000000000..f526579b59 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-host.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-host" +title: "WithHost" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithHost" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithHost` + +WithHost sets the HTTP listen address. + +## Signature + +```go +func WithHost(host string) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 146. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-name.mdx new file mode 100644 index 0000000000..4013778cef --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-name.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-name" +title: "WithName" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithName" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithName` + +WithName sets the agent (and service) name. + +## Signature + +```go +func WithName(name string) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 136. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-native-functions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-native-functions.mdx new file mode 100644 index 0000000000..241fe65864 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-native-functions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-native-functions" +title: "WithNativeFunctions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithNativeFunctions" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithNativeFunctions` + +WithNativeFunctions sets the initial list of native (built-in) SWAIG function names to include in the SWAIG object on every rendered document. + +Python equivalent: native\_functions parameter in AgentBase.**init** + +## Signature + +```go +func WithNativeFunctions(names []string) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 225. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-numbered-bullets.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-numbered-bullets.mdx new file mode 100644 index 0000000000..dc87c3dc5d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-numbered-bullets.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-numbered-bullets" +title: "WithNumberedBullets" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithNumberedBullets" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithNumberedBullets` + +WithNumberedBullets marks the bullets list as numbered. Python equivalent: numbered\_bullets=True in prompt\_add\_section + +## Signature + +```go +func WithNumberedBullets(v bool) PromptSectionOption +``` + +## Parameters + + + +## Returns + +`PromptSectionOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 659. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-numbered.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-numbered.mdx new file mode 100644 index 0000000000..6e6fa10a16 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-numbered.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-numbered" +title: "WithNumbered" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithNumbered" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithNumbered` + +WithNumbered marks the section as numbered. Python equivalent: numbered=True in prompt\_add\_section + +## Signature + +```go +func WithNumbered(v bool) PromptSectionOption +``` + +## Parameters + + + +## Returns + +`PromptSectionOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 653. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-port.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-port.mdx new file mode 100644 index 0000000000..05f21707e8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-port.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-port" +title: "WithPort" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithPort" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithPort` + +WithPort sets the HTTP listen port. + +## Signature + +```go +func WithPort(port int) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 151. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-call.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-call.mdx new file mode 100644 index 0000000000..127624e40f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-call.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-call" +title: "WithRecordCall" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithRecordCall" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithRecordCall` + +WithRecordCall enables or disables automatic call recording. + +## Signature + +```go +func WithRecordCall(record bool) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 169. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-format.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-format.mdx new file mode 100644 index 0000000000..00fa03b255 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-format.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-format" +title: "WithRecordFormat" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithRecordFormat" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithRecordFormat` + +WithRecordFormat sets the recording format (e.g. "mp4", "wav"). + +## Signature + +```go +func WithRecordFormat(format string) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 174. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-stereo.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-stereo.mdx new file mode 100644 index 0000000000..6b1c5aa6f3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-stereo.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-record-stereo" +title: "WithRecordStereo" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithRecordStereo" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithRecordStereo` + +WithRecordStereo enables or disables stereo recording. + +## Signature + +```go +func WithRecordStereo(stereo bool) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 179. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-route.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-route.mdx new file mode 100644 index 0000000000..25b4e42060 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-route.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-route" +title: "WithRoute" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithRoute" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithRoute` + +WithRoute sets the HTTP route path the agent listens on. + +## Signature + +```go +func WithRoute(route string) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 141. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-schema-path.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-schema-path.mdx new file mode 100644 index 0000000000..e8d8105b87 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-schema-path.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-schema-path" +title: "WithSchemaPath" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithSchemaPath" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithSchemaPath` + +WithSchemaPath sets the path to an optional SWML schema file used for validation. If empty, no schema validation is performed. + +Python equivalent: schema\_path parameter in AgentBase.**init** + +## Signature + +```go +func WithSchemaPath(path string) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 237. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-schema-validation.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-schema-validation.mdx new file mode 100644 index 0000000000..356d7eba1f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-schema-validation.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-schema-validation" +title: "WithSchemaValidation" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithSchemaValidation" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithSchemaValidation` + +WithSchemaValidation controls whether the rendered SWML document is validated against the SWML schema before serving. Defaults to true. Can also be disabled via the SWML\_SKIP\_SCHEMA\_VALIDATION=1 environment variable. + +Python equivalent: schema\_validation parameter in AgentBase.**init** + +## Signature + +```go +func WithSchemaValidation(validate bool) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 281. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-signing-key-trust-proxy.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-signing-key-trust-proxy.mdx new file mode 100644 index 0000000000..b5f55935cd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-signing-key-trust-proxy.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-signing-key-trust-proxy" +title: "WithSigningKeyTrustProxy" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithSigningKeyTrustProxy" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithSigningKeyTrustProxy` + +WithSigningKeyTrustProxy enables X-Forwarded-Proto / X-Forwarded-Host honoring during URL reconstruction. Set true when AgentBase runs behind a reverse proxy / ngrok / load balancer that terminates TLS upstream; without it the validator sees the internal scheme/host and the signature will mismatch. + +No Python parity flag — Python's web\_mixin reads X-Forwarded-\* headers unconditionally; in Go we make it explicit because forging these headers is a real attack on naive deployments. + +## Signature + +```go +func WithSigningKeyTrustProxy(trust bool) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 310. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-signing-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-signing-key.mdx new file mode 100644 index 0000000000..f1c9579a26 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-signing-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-signing-key" +title: "WithSigningKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithSigningKey" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithSigningKey` + +WithSigningKey sets the SignalWire Signing Key used to validate inbound webhook signatures. When non-empty, signed routes (POST /, /swaig, /post\_prompt, and any registered routing callbacks) are wrapped with security.WebhookMiddleware — unsigned or mis-signed requests are rejected with HTTP 403 before reaching the handler. + +When this option is unset, AgentBase falls back to the SIGNALWIRE\_SIGNING\_KEY environment variable. When neither is set, the agent accepts unsigned requests and emits a one-time WARN log on startup, per porting-sdk/webhooks.md §"AgentBase integration". + +Python equivalent: AgentBase(signing\_key="...") parameter. + +## Signature + +```go +func WithSigningKey(key string) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 297. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-subsections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-subsections.mdx new file mode 100644 index 0000000000..c2cea8153d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-subsections.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-subsections" +title: "WithSubsections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithSubsections" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithSubsections` + +WithSubsections attaches child sections to the parent section. Python equivalent: subsections=\[...] in prompt\_add\_section + +## Signature + +```go +func WithSubsections(subs []map[string]any) PromptSectionOption +``` + +## Parameters + + + +## Returns + +`PromptSectionOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 665. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-suppress-logs.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-suppress-logs.mdx new file mode 100644 index 0000000000..f85e923723 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-suppress-logs.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-suppress-logs" +title: "WithSuppressLogs" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithSuppressLogs" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithSuppressLogs` + +WithSuppressLogs disables verbose structured logging from the agent. When true, info-level agent lifecycle logs are suppressed. + +Python equivalent: suppress\_logs parameter in AgentBase.**init** + +## Signature + +```go +func WithSuppressLogs(suppress bool) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 245. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-token-expiry.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-token-expiry.mdx new file mode 100644 index 0000000000..9552979f6b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-token-expiry.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-token-expiry" +title: "WithTokenExpiry" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithTokenExpiry" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithTokenExpiry` + +WithTokenExpiry sets the token expiry time in seconds for secure tools. + +## Signature + +```go +func WithTokenExpiry(secs int) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 184. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-use-pom.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-use-pom.mdx new file mode 100644 index 0000000000..4e6a0ef8b5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-use-pom.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent/with-use-pom" +title: "WithUsePom" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/agent.WithUsePom" + parent: "github.com/signalwire/signalwire-go/pkg/agent" + module: "github.com.signalwire.signalwire-go.pkg.agent" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go" +--- +# `WithUsePom` + +WithUsePom controls whether Prompt Object Model (POM) mode is active. When true (default), structured prompt sections are used; when false, raw text from SetPromptText is used. + +Python equivalent: use\_pom parameter in AgentBase.**init** + +## Signature + +```go +func WithUsePom(usePom bool) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/agent/agent.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/agent/agent.go) + +Line 199. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/add-context.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/add-context.mdx new file mode 100644 index 0000000000..0272354390 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/add-context.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/add-context" +title: "AddContext" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder.AddContext" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddContext` + +AddContext creates a new context with the given name and returns it. + +## Signature + +```go +func (*ContextBuilder) AddContext(name string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 831. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/attach-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/attach-agent.mdx new file mode 100644 index 0000000000..744484c13d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/attach-agent.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/attach-agent" +title: "AttachAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder.AttachAgent" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AttachAgent` + +AttachAgent wires an agent into the builder so Validate() can check user-defined tool names against ReservedNativeToolNames. AgentBase calls this internally when you invoke DefineContexts(). + +## Signature + +```go +func (*ContextBuilder) AttachAgent(a ToolLister) *ContextBuilder +``` + +## Parameters + + + +## Returns + +`*ContextBuilder` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 809. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/get-context.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/get-context.mdx new file mode 100644 index 0000000000..ea6150653e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/get-context.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/get-context" +title: "GetContext" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder.GetContext" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `GetContext` + +GetContext returns the context with the given name, or nil if not found. + +## Signature + +```go +func (*ContextBuilder) GetContext(name string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 839. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/index.mdx new file mode 100644 index 0000000000..a5870d7072 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder" +title: "ContextBuilder" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `ContextBuilder` + +ContextBuilder is the top-level builder for multi-step, multi-context AI agent workflows. + +A ContextBuilder owns one or more Contexts; each Context owns an ordered list of Steps. Only one context and one step is active at a time. Per chat turn, the runtime injects the current step's instructions as a system message, then asks the LLM for a response. + +When a step (or its enclosing context) declares valid\_steps or valid\_contexts, the runtime auto-injects two native tools so the model can navigate the flow: + +- next\_step(step: enum) — present when valid\_steps is set +- change\_context(context: enum) — present when valid\_contexts is set + +Their enum schemas are rewritten on every turn to match whatever valid\_steps / valid\_contexts apply to the current step. You do NOT need to define these tools yourself; they appear automatically. + +A third native tool — gather\_submit — is injected during gather\_info questioning (see Step.SetGatherInfo / Step.AddGatherQuestion). + +These three names — next\_step, change\_context, gather\_submit — are reserved. ContextBuilder.Validate() rejects any agent that defines a SWAIG tool with one of these names. See ReservedNativeToolNames. + +Each step may declare a functions whitelist. The whitelist is applied in-memory at the start of each LLM turn. CRITICALLY: if a step does NOT declare a functions field, it INHERITS the previous step's active set. See Step.SetFunctions for details and examples. + +## Signature + +```go +type ContextBuilder struct +``` + +## Methods + + + + AddContext creates a new context with the given name and returns it. + + + + AttachAgent wires an agent into the builder so Validate() can check user-defined tool names against ReservedNativeToolNames. AgentBase calls this internally when you invoke DefineContexts(). + + + + GetContext returns the context with the given name, or nil if not found. + + + + Reset removes all contexts, returning the builder to its initial state. Use this in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + + + + ToMap serialises all contexts to the SWML map format. It calls Validate first and returns an error if validation fails. + + + + Validate checks the builder configuration for common errors: + + + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 800. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/reset.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/reset.mdx new file mode 100644 index 0000000000..7b94d81688 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/reset.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/reset" +title: "Reset" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder.Reset" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `Reset` + +Reset removes all contexts, returning the builder to its initial state. Use this in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + +## Signature + +```go +func (*ContextBuilder) Reset() *ContextBuilder +``` + +## Returns + +`*ContextBuilder` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 824. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/to-map.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/to-map.mdx new file mode 100644 index 0000000000..2a2bf23b47 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/to-map.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/to-map" +title: "ToMap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder.ToMap" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `ToMap` + +ToMap serialises all contexts to the SWML map format. It calls Validate first and returns an error if validation fails. + +## Signature + +```go +func (*ContextBuilder) ToMap() (map[string]any, error) +``` + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 1057. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/validate.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/validate.mdx new file mode 100644 index 0000000000..f4175026cb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/validate.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context-builder/validate" +title: "Validate" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder.Validate" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.ContextBuilder" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `Validate` + +Validate checks the builder configuration for common errors: + +- At least one context must be defined. +- A single context must be named "default". +- Every context must contain at least one step. +- Every step must have a name. +- valid\_steps entries (except "next") must name existing steps in the same context. +- valid\_contexts entries (context-level) must name existing contexts. +- valid\_contexts entries (step-level) must name existing contexts. +- gather\_info questions must be non-empty and have unique keys. +- gather\_info completion\_action (if set) targets an existing step. +- No user-defined SWAIG tool collides with a reserved native name. + +## Signature + +```go +func (*ContextBuilder) Validate() error +``` + +## Returns + +`error` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 854. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-bullets.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-bullets.mdx new file mode 100644 index 0000000000..8efdae3824 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-bullets.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-bullets" +title: "AddBullets" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.AddBullets" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddBullets` + +AddBullets adds a POM section with bullet points to the context prompt. + +## Signature + +```go +func (*Context) AddBullets(title string, bullets []string) *Context +``` + +## Parameters + + + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 622. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-enter-filler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-enter-filler.mdx new file mode 100644 index 0000000000..60a78a5c7c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-enter-filler.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-enter-filler" +title: "AddEnterFiller" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.AddEnterFiller" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddEnterFiller` + +AddEnterFiller adds enter fillers for a specific language code. + +## Signature + +```go +func (*Context) AddEnterFiller(langCode string, fillers []string) *Context +``` + +## Parameters + + + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 652. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-exit-filler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-exit-filler.mdx new file mode 100644 index 0000000000..adec095d55 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-exit-filler.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-exit-filler" +title: "AddExitFiller" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.AddExitFiller" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddExitFiller` + +AddExitFiller adds exit fillers for a specific language code. + +## Signature + +```go +func (*Context) AddExitFiller(langCode string, fillers []string) *Context +``` + +## Parameters + + + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 661. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-section.mdx new file mode 100644 index 0000000000..bc9cde74f6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-section" +title: "AddSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.AddSection" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddSection` + +AddSection adds a POM section to the context prompt. + +## Signature + +```go +func (*Context) AddSection(title string, body string) *Context +``` + +## Parameters + + + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 616. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-step.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-step.mdx new file mode 100644 index 0000000000..4e88c3ef68 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-step.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-step" +title: "AddStep" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.AddStep" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddStep` + +AddStep creates a new step, appends it to the ordered list, stores it in the lookup map, and returns the Step for further configuration. + +## Signature + +```go +func (*Context) AddStep(name string) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 478. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-system-bullets.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-system-bullets.mdx new file mode 100644 index 0000000000..ffc4997110 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-system-bullets.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-system-bullets" +title: "AddSystemBullets" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.AddSystemBullets" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddSystemBullets` + +AddSystemBullets adds a POM section with bullet points to the system prompt. + +## Signature + +```go +func (*Context) AddSystemBullets(title string, bullets []string) *Context +``` + +## Parameters + + + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 634. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-system-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-system-section.mdx new file mode 100644 index 0000000000..b7b03edee8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-system-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/add-system-section" +title: "AddSystemSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.AddSystemSection" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddSystemSection` + +AddSystemSection adds a POM section to the system prompt. + +## Signature + +```go +func (*Context) AddSystemSection(title string, body string) *Context +``` + +## Parameters + + + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 628. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/get-step.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/get-step.mdx new file mode 100644 index 0000000000..29eaa6d21d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/get-step.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/get-step" +title: "GetStep" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.GetStep" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `GetStep` + +GetStep returns the step with the given name, or nil if not found. + +## Signature + +```go +func (*Context) GetStep(name string) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 486. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/index.mdx new file mode 100644 index 0000000000..430d885ac8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/index.mdx @@ -0,0 +1,129 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context" +title: "Context" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `Context` + +Context represents a single context containing ordered steps. All setter methods return \*Context for chaining. + +## Signature + +```go +type Context struct +``` + +## Methods + + + + AddBullets adds a POM section with bullet points to the context prompt. + + + + AddEnterFiller adds enter fillers for a specific language code. + + + + AddExitFiller adds exit fillers for a specific language code. + + + + AddSection adds a POM section to the context prompt. + + + + AddStep creates a new step, appends it to the ordered list, stores it in the lookup map, and returns the Step for further configuration. + + + + AddSystemBullets adds a POM section with bullet points to the system prompt. + + + + AddSystemSection adds a POM section to the system prompt. + + + + GetStep returns the step with the given name, or nil if not found. + + + + MoveStep moves an existing step to the given position (0-based index). Returns the receiver for method chaining. + + + + Name returns the context's name. + + + + RemoveStep removes a step by name. Returns the receiver for method chaining. + + + + SetConsolidate sets whether to consolidate conversation history on entry. + + + + SetEnterFillers sets all enter fillers at once. + + + + SetExitFillers sets all exit fillers at once. + + + + SetFullReset sets whether to do a full reset when entering this context. + + + + SetInitialStep sets which step the context starts on when entered. + + + + SetIsolated marks this context as isolated — entering it wipes conversation history. + + + + SetPostPrompt sets the post-prompt override for this context. + + + + SetPrompt sets the context's prompt text directly. + + + + SetSystemPrompt sets the system prompt for context switching. + + + + SetUserPrompt sets the user prompt to inject when entering this context. + + + + SetValidContexts sets which contexts can be navigated to from this context. + + + + SetValidSteps sets which steps can be navigated to from any step in this context. + + + + ToMap serialises the context to the SWML map format. + + + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 445. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/move-step.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/move-step.mdx new file mode 100644 index 0000000000..256b36ea8c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/move-step.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/move-step" +title: "MoveStep" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.MoveStep" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `MoveStep` + +MoveStep moves an existing step to the given position (0-based index). Returns the receiver for method chaining. + +## Signature + +```go +func (*Context) MoveStep(name string, position int) *Context +``` + +## Parameters + + + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 507. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/name.mdx new file mode 100644 index 0000000000..79eb049270 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/name" +title: "Name" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.Name" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `Name` + +Name returns the context's name. + +## Signature + +```go +func (*Context) Name() string +``` + +## Returns + +`string` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 474. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/remove-step.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/remove-step.mdx new file mode 100644 index 0000000000..58265108d3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/remove-step.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/remove-step" +title: "RemoveStep" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.RemoveStep" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `RemoveStep` + +RemoveStep removes a step by name. Returns the receiver for method chaining. + +## Signature + +```go +func (*Context) RemoveStep(name string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 491. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-consolidate.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-consolidate.mdx new file mode 100644 index 0000000000..9c9337e165 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-consolidate.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-consolidate" +title: "SetConsolidate" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetConsolidate" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetConsolidate` + +SetConsolidate sets whether to consolidate conversation history on entry. + +## Signature + +```go +func (*Context) SetConsolidate(consolidate bool) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 573. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-enter-fillers.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-enter-fillers.mdx new file mode 100644 index 0000000000..252b6671e5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-enter-fillers.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-enter-fillers" +title: "SetEnterFillers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetEnterFillers" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetEnterFillers` + +SetEnterFillers sets all enter fillers at once. + +## Signature + +```go +func (*Context) SetEnterFillers(fillers map[string][]string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 640. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-exit-fillers.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-exit-fillers.mdx new file mode 100644 index 0000000000..0cafd47c4d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-exit-fillers.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-exit-fillers" +title: "SetExitFillers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetExitFillers" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetExitFillers` + +SetExitFillers sets all exit fillers at once. + +## Signature + +```go +func (*Context) SetExitFillers(fillers map[string][]string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 646. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-full-reset.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-full-reset.mdx new file mode 100644 index 0000000000..1359f68759 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-full-reset.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-full-reset" +title: "SetFullReset" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetFullReset" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetFullReset` + +SetFullReset sets whether to do a full reset when entering this context. + +## Signature + +```go +func (*Context) SetFullReset(fullReset bool) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 579. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-initial-step.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-initial-step.mdx new file mode 100644 index 0000000000..48d09f65ce --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-initial-step.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-initial-step" +title: "SetInitialStep" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetInitialStep" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetInitialStep` + +SetInitialStep sets which step the context starts on when entered. + +By default, a context starts on its first step (index 0). Use this to skip a preamble step on re-entry via change\_context. + +## Signature + +```go +func (*Context) SetInitialStep(stepName string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 537. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-isolated.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-isolated.mdx new file mode 100644 index 0000000000..02dbd47857 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-isolated.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-isolated" +title: "SetIsolated" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetIsolated" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetIsolated` + +SetIsolated marks this context as isolated — entering it wipes conversation history. + +When isolated=true and the context is entered via change\_context, the runtime wipes the conversation array. The model starts fresh with only the new context's system\_prompt + step instructions, with no memory of prior turns. + +EXCEPTION — reset overrides the wipe: If the context also has a reset configuration (via SetConsolidate or SetFullReset), the wipe is skipped in favor of the reset behavior. Use reset with consolidate=true to summarize prior history into a single message instead of dropping it entirely. + +Use cases: + +- Switching to a sensitive billing flow that should not see prior small-talk +- Handing off to a different agent persona +- Resetting after a long off-topic detour + +## Signature + +```go +func (*Context) SetIsolated(isolated bool) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 610. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-post-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-post-prompt.mdx new file mode 100644 index 0000000000..ebf316e82a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-post-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-post-prompt" +title: "SetPostPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetPostPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetPostPrompt` + +SetPostPrompt sets the post-prompt override for this context. + +## Signature + +```go +func (*Context) SetPostPrompt(prompt string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 555. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-prompt.mdx new file mode 100644 index 0000000000..1558b8c388 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-prompt" +title: "SetPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetPrompt` + +SetPrompt sets the context's prompt text directly. + +## Signature + +```go +func (*Context) SetPrompt(prompt string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 567. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-system-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-system-prompt.mdx new file mode 100644 index 0000000000..1b0e1393fc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-system-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-system-prompt" +title: "SetSystemPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetSystemPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetSystemPrompt` + +SetSystemPrompt sets the system prompt for context switching. + +## Signature + +```go +func (*Context) SetSystemPrompt(prompt string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 561. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-user-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-user-prompt.mdx new file mode 100644 index 0000000000..d71a135777 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-user-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-user-prompt" +title: "SetUserPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetUserPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetUserPrompt` + +SetUserPrompt sets the user prompt to inject when entering this context. + +## Signature + +```go +func (*Context) SetUserPrompt(prompt string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 585. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-valid-contexts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-valid-contexts.mdx new file mode 100644 index 0000000000..16efabc2e5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-valid-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-valid-contexts" +title: "SetValidContexts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetValidContexts" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetValidContexts` + +SetValidContexts sets which contexts can be navigated to from this context. + +## Signature + +```go +func (*Context) SetValidContexts(ctxs []string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 543. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-valid-steps.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-valid-steps.mdx new file mode 100644 index 0000000000..180e3f9bc9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-valid-steps.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/set-valid-steps" +title: "SetValidSteps" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.SetValidSteps" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetValidSteps` + +SetValidSteps sets which steps can be navigated to from any step in this context. + +## Signature + +```go +func (*Context) SetValidSteps(steps []string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 549. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/to-map.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/to-map.mdx new file mode 100644 index 0000000000..0b5c2aacd2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/to-map.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/context/to-map" +title: "ToMap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Context.ToMap" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Context" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `ToMap` + +ToMap serialises the context to the SWML map format. + +## Signature + +```go +func (*Context) ToMap() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 693. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/create-simple-context.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/create-simple-context.mdx new file mode 100644 index 0000000000..45a5326c14 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/create-simple-context.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/create-simple-context" +title: "CreateSimpleContext" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.CreateSimpleContext" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `CreateSimpleContext` + +CreateSimpleContext creates a standalone Context. If name is empty it defaults to "default". + +## Signature + +```go +func CreateSimpleContext(name string) *Context +``` + +## Parameters + + + +## Returns + +`*Context` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 1074. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/add-question.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/add-question.mdx new file mode 100644 index 0000000000..9407a0c3ea --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/add-question.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/add-question" +title: "AddQuestion" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.GatherInfo.AddQuestion" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.GatherInfo" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddQuestion` + +AddQuestion appends a question and returns the GatherInfo for chaining. + +## Signature + +```go +func (*GatherInfo) AddQuestion(key string, question string, opts ...GatherQuestionOption) *GatherInfo +``` + +## Parameters + + + + + + + +## Returns + +`*GatherInfo` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 112. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/index.mdx new file mode 100644 index 0000000000..b3d8c9ad39 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info" +title: "GatherInfo" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.GatherInfo" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `GatherInfo` + +GatherInfo configures information gathering for a step. + +## Signature + +```go +type GatherInfo struct +``` + +## Properties + + + + + + + + + +## Methods + + + + AddQuestion appends a question and returns the GatherInfo for chaining. + + + + ToMap serialises to the SWML map format. Callers that construct GatherInfo directly should call Validate() first to ensure the result is valid SWML. Step.ToMap() enforces this automatically by only calling ToMap() when len(Questions) > 0. + + + + Validate returns an error if the GatherInfo is not ready for serialisation. Specifically, it rejects a GatherInfo with no questions, which would produce invalid SWML. This matches the Python SDK's ValueError raised by to\_dict() when \_questions is empty. + + + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 104. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/to-map.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/to-map.mdx new file mode 100644 index 0000000000..99e04e4c4c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/to-map.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/to-map" +title: "ToMap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.GatherInfo.ToMap" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.GatherInfo" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `ToMap` + +ToMap serialises to the SWML map format. Callers that construct GatherInfo directly should call Validate() first to ensure the result is valid SWML. Step.ToMap() enforces this automatically by only calling ToMap() when len(Questions) > 0. + +## Signature + +```go +func (*GatherInfo) ToMap() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 140. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/validate.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/validate.mdx new file mode 100644 index 0000000000..2ef2b7b092 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/validate.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-info/validate" +title: "Validate" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.GatherInfo.Validate" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.GatherInfo" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `Validate` + +Validate returns an error if the GatherInfo is not ready for serialisation. Specifically, it rejects a GatherInfo with no questions, which would produce invalid SWML. This matches the Python SDK's ValueError raised by to\_dict() when \_questions is empty. + +## Signature + +```go +func (*GatherInfo) Validate() error +``` + +## Returns + +`error` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 129. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question-option.mdx new file mode 100644 index 0000000000..753a4be899 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question-option" +title: "GatherQuestionOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.GatherQuestionOption" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `GatherQuestionOption` + +GatherQuestionOption is a functional option applied to a GatherQuestion. + +## Signature + +```go +type GatherQuestionOption alias +``` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 46. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question/index.mdx new file mode 100644 index 0000000000..38dbec8f0e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question" +title: "GatherQuestion" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.GatherQuestion" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `GatherQuestion` + +GatherQuestion represents a single question in a gather\_info configuration. + +## Signature + +```go +type GatherQuestion struct +``` + +## Properties + + + + + optional + + + + + + optional + + + + + + default "string" + + +## Methods + + + + ToMap serialises the question to the SWML map format. + + + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 69. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question/to-map.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question/to-map.mdx new file mode 100644 index 0000000000..6484d1685c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question/to-map.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/gather-question/to-map" +title: "ToMap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.GatherQuestion.ToMap" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.GatherQuestion" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `ToMap` + +ToMap serialises the question to the SWML map format. + +## Signature + +```go +func (*GatherQuestion) ToMap() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 79. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/index.mdx new file mode 100644 index 0000000000..a06a0c8394 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/index.mdx @@ -0,0 +1,110 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts" +title: "contexts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `contexts` + +Package contexts provides the Contexts & Steps workflow system for SignalWire AI agents. + +Instead of a single flat prompt, agents can define structured Contexts (conversation flows) containing ordered Steps (sequential stages). Each step carries its own prompt, completion criteria, function restrictions, and navigation rules. The builder serialises the whole tree into the map\[string]any format expected by the SWML AI verb. + +## Signature + +```go +package contexts +``` + +## Constants + + + Limits guard against unreasonable configurations. + + + + Limits guard against unreasonable configurations. + + + + ReservedNativeToolNames is the set of tool names the runtime auto-injects when contexts/steps are present. User-defined SWAIG tools must not collide with these names. ContextBuilder.Validate() rejects any agent that registers a user tool sharing one of these names — the runtime would never call the user tool because the native one wins. + + +## Functions + + + + CreateSimpleContext creates a standalone Context. If name is empty it defaults to "default". + + + + NewContextBuilder creates a new empty ContextBuilder. + + + + WithConfirm sets whether the model must confirm the answer with the user. + + + + WithFunctions sets additional function names visible for this question. + + + + WithPrompt sets extra instruction text appended for this question. + + + + WithType sets the JSON-schema type for the answer (default "string"). + + + +## Type Aliases + + + + GatherQuestionOption is a functional option applied to a GatherQuestion. + + + +## Classes + + + + Context represents a single context containing ordered steps. All setter methods return \*Context for chaining. + + + + ContextBuilder is the top-level builder for multi-step, multi-context AI agent workflows. + + + + GatherInfo configures information gathering for a step. + + + + GatherQuestion represents a single question in a gather\_info configuration. + + + + Step represents a single step within a context. All setter methods return \*Step so they can be chained. + + + +## Interfaces + + + + ToolLister is implemented by an agent so ContextBuilder.Validate() can check registered SWAIG tool names against ReservedNativeToolNames. AgentBase implements this by returning the insertion-ordered list of registered tool names. + + + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/new-context-builder.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/new-context-builder.mdx new file mode 100644 index 0000000000..da863d7464 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/new-context-builder.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/new-context-builder" +title: "NewContextBuilder" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.NewContextBuilder" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `NewContextBuilder` + +NewContextBuilder creates a new empty ContextBuilder. + +## Signature + +```go +func NewContextBuilder() *ContextBuilder +``` + +## Returns + +`*ContextBuilder` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 815. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-bullets.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-bullets.mdx new file mode 100644 index 0000000000..2281d0ad9e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-bullets.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-bullets" +title: "AddBullets" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.AddBullets" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddBullets` + +AddBullets adds a POM section with bullet points. + +## Signature + +```go +func (*Step) AddBullets(title string, bullets []string) *Step +``` + +## Parameters + + + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 200. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-gather-question.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-gather-question.mdx new file mode 100644 index 0000000000..b44b5d7826 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-gather-question.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-gather-question" +title: "AddGatherQuestion" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.AddGatherQuestion" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddGatherQuestion` + +AddGatherQuestion adds a question to this step's gather\_info. SetGatherInfo should be called first (this method silently initialises the struct if not, to keep callers from having to worry about ordering). Returns the Step for chaining. + +IMPORTANT — gather mode locks function access: While the model is asking gather questions, the runtime forcibly deactivates ALL of the step's other functions. The only callable tools during a gather question are: + +- gather\_submit (the native answer-submission tool) +- Whatever names you list with WithFunctions in this question's opts + +next\_step and change\_context are also filtered out — the model cannot navigate away until the gather completes. This is by design: it forces a tight ask → submit → next-question loop. + +If a question needs to call out to a tool (e.g. validate an email, geocode a ZIP), pass that tool name via WithFunctions on this question. Functions listed here are active ONLY for this question. + +## Signature + +```go +func (*Step) AddGatherQuestion(key string, question string, opts ...GatherQuestionOption) *Step +``` + +## Parameters + + + + + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 319. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-section.mdx new file mode 100644 index 0000000000..c9f610a77a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/add-section" +title: "AddSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.AddSection" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `AddSection` + +AddSection adds a POM section to the step. + +## Signature + +```go +func (*Step) AddSection(title string, body string) *Step +``` + +## Parameters + + + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 194. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/clear-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/clear-sections.mdx new file mode 100644 index 0000000000..1df5675583 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/clear-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/clear-sections" +title: "ClearSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.ClearSections" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `ClearSections` + +ClearSections removes all POM sections and direct text from this step. + +## Signature + +```go +func (*Step) ClearSections() *Step +``` + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 329. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/index.mdx new file mode 100644 index 0000000000..6604b85376 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/index.mdx @@ -0,0 +1,109 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step" +title: "Step" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `Step` + +Step represents a single step within a context. All setter methods return \*Step so they can be chained. + +## Signature + +```go +type Step struct +``` + +## Methods + + + + AddBullets adds a POM section with bullet points. + + + + AddGatherQuestion adds a question to this step's gather\_info. SetGatherInfo should be called first (this method silently initialises the struct if not, to keep callers from having to worry about ordering). Returns the Step for chaining. + + + + AddSection adds a POM section to the step. + + + + ClearSections removes all POM sections and direct text from this step. + + + + Name returns the step's name. + + + + SetEnd marks this step as terminal for the step flow. + + + + SetFunctions sets which non-internal functions are callable while this step is active. + + + + SetGatherInfo enables info gathering for this step and returns the Step for fluent chaining. This matches the Python SDK's set\_gather\_info, which returns self so that step-level setters (SetFunctions, SetValidSteps, etc.) can be chained after configuring gather info. + + + + SetResetConsolidate sets whether to consolidate conversation on context switch. + + + + SetResetFullReset sets whether to do a full reset on context switch. + + + + SetResetSystemPrompt sets the system prompt for context switching. + + + + SetResetUserPrompt sets the user prompt for context switching. + + + + SetSkipToNextStep sets whether to automatically advance to the next step. + + + + SetSkipUserTurn sets whether to skip waiting for user input after this step. + + + + SetStepCriteria sets the criteria for determining when this step is complete. + + + + SetText sets the step's prompt text directly. + + + + SetValidContexts sets which contexts can be navigated to from this step. + + + + SetValidSteps sets which steps can be navigated to from this step. + + + + ToMap serialises the step to the SWML map format. + + + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 166. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/name.mdx new file mode 100644 index 0000000000..d3d111729a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/name" +title: "Name" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.Name" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `Name` + +Name returns the step's name. + +## Signature + +```go +func (*Step) Name() string +``` + +## Returns + +`string` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 185. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-end.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-end.mdx new file mode 100644 index 0000000000..a08ccfd33d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-end.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-end" +title: "SetEnd" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetEnd" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetEnd` + +SetEnd marks this step as terminal for the step flow. + +IMPORTANT: end=true does NOT end the conversation or hang up the call. It exits step mode entirely after this step executes — clearing the steps list, current step index, valid\_steps, and valid\_contexts. The agent keeps running, but operates only under the base system prompt and the context-level prompt; no more step instructions are injected and no more next\_step tool is offered. + +To actually end the call, call a hangup tool or define a hangup\_hook. + +## Signature + +```go +func (*Step) SetEnd(end bool) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 266. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-functions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-functions.mdx new file mode 100644 index 0000000000..0c26fcdfa5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-functions.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-functions" +title: "SetFunctions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetFunctions" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetFunctions` + +SetFunctions sets which non-internal functions are callable while this step is active. + +IMPORTANT — inheritance behavior: If you do NOT call this method, the step inherits whichever function set was active on the previous step (or the previous context's last step). The server-side runtime only resets the active set when a step explicitly declares its `functions` field. This is the most common source of bugs in multi-step agents: forgetting SetFunctions on a later step lets the previous step's tools leak through. Best practice is to call SetFunctions explicitly on every step that should differ from the previous one. + +Keep the per-step active set small: LLM tool selection accuracy degrades noticeably past ~7-8 simultaneously-active tools per call. Use per-step whitelisting to partition large tool collections. + +Accepts: + +- \[]string\{"a", "b"\} — whitelist of function names allowed in this step +- \[]string\{\} — explicit disable-all +- "none" — synonym for the empty slice + +Internal functions (e.g. gather\_submit, hangup\_hook) are ALWAYS protected and cannot be deactivated by this whitelist. The native navigation tools next\_step and change\_context are injected automatically when SetValidSteps / SetValidContexts is used; they are not affected by this list and do not need to appear in it. + +## Signature + +```go +func (*Step) SetFunctions(functions any) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 239. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-gather-info.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-gather-info.mdx new file mode 100644 index 0000000000..3b0f3d05b5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-gather-info.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-gather-info" +title: "SetGatherInfo" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetGatherInfo" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetGatherInfo` + +SetGatherInfo enables info gathering for this step and returns the Step for fluent chaining. This matches the Python SDK's set\_gather\_info, which returns self so that step-level setters (SetFunctions, SetValidSteps, etc.) can be chained after configuring gather info. + +To add questions to the gather info, use AddGatherQuestion on the same \*Step receiver. + +## Signature + +```go +func (*Step) SetGatherInfo(outputKey string, completionAction string, prompt string) *Step +``` + +## Parameters + + + + + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 290. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-consolidate.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-consolidate.mdx new file mode 100644 index 0000000000..ab406d206b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-consolidate.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-consolidate" +title: "SetResetConsolidate" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetResetConsolidate" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetResetConsolidate` + +SetResetConsolidate sets whether to consolidate conversation on context switch. + +## Signature + +```go +func (*Step) SetResetConsolidate(consolidate bool) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 348. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-full-reset.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-full-reset.mdx new file mode 100644 index 0000000000..cb5d05062c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-full-reset.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-full-reset" +title: "SetResetFullReset" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetResetFullReset" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetResetFullReset` + +SetResetFullReset sets whether to do a full reset on context switch. + +## Signature + +```go +func (*Step) SetResetFullReset(fullReset bool) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 354. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-system-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-system-prompt.mdx new file mode 100644 index 0000000000..8f2b4a348c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-system-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-system-prompt" +title: "SetResetSystemPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetResetSystemPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetResetSystemPrompt` + +SetResetSystemPrompt sets the system prompt for context switching. + +## Signature + +```go +func (*Step) SetResetSystemPrompt(prompt string) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 336. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-user-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-user-prompt.mdx new file mode 100644 index 0000000000..b504b286fb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-user-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-reset-user-prompt" +title: "SetResetUserPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetResetUserPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetResetUserPrompt` + +SetResetUserPrompt sets the user prompt for context switching. + +## Signature + +```go +func (*Step) SetResetUserPrompt(prompt string) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 342. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-skip-to-next-step.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-skip-to-next-step.mdx new file mode 100644 index 0000000000..597b295a07 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-skip-to-next-step.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-skip-to-next-step" +title: "SetSkipToNextStep" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetSkipToNextStep" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetSkipToNextStep` + +SetSkipToNextStep sets whether to automatically advance to the next step. + +## Signature + +```go +func (*Step) SetSkipToNextStep(skip bool) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 278. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-skip-user-turn.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-skip-user-turn.mdx new file mode 100644 index 0000000000..bb42eda94f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-skip-user-turn.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-skip-user-turn" +title: "SetSkipUserTurn" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetSkipUserTurn" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetSkipUserTurn` + +SetSkipUserTurn sets whether to skip waiting for user input after this step. + +## Signature + +```go +func (*Step) SetSkipUserTurn(skip bool) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 272. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-step-criteria.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-step-criteria.mdx new file mode 100644 index 0000000000..cf1a4ac20e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-step-criteria.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-step-criteria" +title: "SetStepCriteria" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetStepCriteria" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetStepCriteria` + +SetStepCriteria sets the criteria for determining when this step is complete. + +## Signature + +```go +func (*Step) SetStepCriteria(criteria string) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 206. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-text.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-text.mdx new file mode 100644 index 0000000000..db256a1bc6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-text.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-text" +title: "SetText" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetText" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetText` + +SetText sets the step's prompt text directly. + +## Signature + +```go +func (*Step) SetText(text string) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 188. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-valid-contexts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-valid-contexts.mdx new file mode 100644 index 0000000000..b1a11796ed --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-valid-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-valid-contexts" +title: "SetValidContexts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetValidContexts" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetValidContexts` + +SetValidContexts sets which contexts can be navigated to from this step. + +## Signature + +```go +func (*Step) SetValidContexts(contexts []string) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 251. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-valid-steps.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-valid-steps.mdx new file mode 100644 index 0000000000..38fa000f13 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-valid-steps.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/set-valid-steps" +title: "SetValidSteps" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.SetValidSteps" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `SetValidSteps` + +SetValidSteps sets which steps can be navigated to from this step. + +## Signature + +```go +func (*Step) SetValidSteps(steps []string) *Step +``` + +## Parameters + + + +## Returns + +`*Step` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 245. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/to-map.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/to-map.mdx new file mode 100644 index 0000000000..ac2a234c12 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/to-map.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/step/to-map" +title: "ToMap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.Step.ToMap" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.Step" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `ToMap` + +ToMap serialises the step to the SWML map format. + +## Signature + +```go +func (*Step) ToMap() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 386. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/tool-lister/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/tool-lister/index.mdx new file mode 100644 index 0000000000..3d92f18792 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/tool-lister/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/tool-lister" +title: "ToolLister" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "interface" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.ToolLister" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `ToolLister` + +ToolLister is implemented by an agent so ContextBuilder.Validate() can check registered SWAIG tool names against ReservedNativeToolNames. AgentBase implements this by returning the insertion-ordered list of registered tool names. + +## Signature + +```go +type ToolLister interface { ListToolNames } +``` + +## Methods + + + + ListToolNames returns the names of every registered SWAIG tool. + + + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 761. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/tool-lister/list-tool-names.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/tool-lister/list-tool-names.mdx new file mode 100644 index 0000000000..f467baa824 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/tool-lister/list-tool-names.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/tool-lister/list-tool-names" +title: "ListToolNames" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.ToolLister.ListToolNames" + parent: "github.com/signalwire/signalwire-go/pkg/contexts.ToolLister" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `ListToolNames` + +ListToolNames returns the names of every registered SWAIG tool. + +## Signature + +```go +ListToolNames() []string +``` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 763. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-confirm.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-confirm.mdx new file mode 100644 index 0000000000..6e3e0e45fc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-confirm.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-confirm" +title: "WithConfirm" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.WithConfirm" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `WithConfirm` + +WithConfirm sets whether the model must confirm the answer with the user. + +## Signature + +```go +func WithConfirm(c bool) GatherQuestionOption +``` + +## Parameters + + + +## Returns + +`GatherQuestionOption` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 54. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-functions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-functions.mdx new file mode 100644 index 0000000000..9d577969d7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-functions.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-functions" +title: "WithFunctions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.WithFunctions" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `WithFunctions` + +WithFunctions sets additional function names visible for this question. + +## Signature + +```go +func WithFunctions(f []string) GatherQuestionOption +``` + +## Parameters + + + +## Returns + +`GatherQuestionOption` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 64. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-prompt.mdx new file mode 100644 index 0000000000..d26d81f53b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-prompt" +title: "WithPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.WithPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `WithPrompt` + +WithPrompt sets extra instruction text appended for this question. + +## Signature + +```go +func WithPrompt(p string) GatherQuestionOption +``` + +## Parameters + + + +## Returns + +`GatherQuestionOption` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 59. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-type.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-type.mdx new file mode 100644 index 0000000000..8102148840 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-type.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts/with-type" +title: "WithType" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/contexts.WithType" + parent: "github.com/signalwire/signalwire-go/pkg/contexts" + module: "github.com.signalwire.signalwire-go.pkg.contexts" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go" +--- +# `WithType` + +WithType sets the JSON-schema type for the answer (default "string"). + +## Signature + +```go +func WithType(t string) GatherQuestionOption +``` + +## Parameters + + + +## Returns + +`GatherQuestionOption` + +## Source + +[`pkg/contexts/contexts.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/contexts/contexts.go) + +Line 49. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/create-expression-tool.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/create-expression-tool.mdx new file mode 100644 index 0000000000..b5838da48e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/create-expression-tool.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/create-expression-tool" +title: "CreateExpressionTool" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.CreateExpressionTool" + parent: "github.com/signalwire/signalwire-go/pkg/datamap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `CreateExpressionTool` + +CreateExpressionTool creates a DataMap configured for expression-based pattern matching. name is the function name. patterns maps test values to an ExpressionPattern where Pattern is the regex string and Result is the \*swaig.FunctionResult to return on match. parameters maps parameter names to their definitions (each with "type", "description", "required" keys). + +## Signature + +```go +func CreateExpressionTool( + name string, + patterns map[string]ExpressionPattern, + parameters map[string]map[string]any +) *DataMap +``` + +## Parameters + + + + + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 441. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/create-simple-api-tool.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/create-simple-api-tool.mdx new file mode 100644 index 0000000000..f3c8f1b3c4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/create-simple-api-tool.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/create-simple-api-tool" +title: "CreateSimpleApiTool" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.CreateSimpleApiTool" + parent: "github.com/signalwire/signalwire-go/pkg/datamap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `CreateSimpleApiTool` + +CreateSimpleApiTool creates a DataMap configured for a simple API call. name is the function name. url is the API endpoint URL. responseTemplate is the template for formatting the response. parameters maps parameter names to their definitions (each with "type", "description", "required" keys). method is the HTTP method (e.g., "GET", "POST"). headers are optional HTTP headers (can be nil). body is an optional request body for POST/PUT (can be nil). errorKeys are optional error indicator keys (can be nil). + +## Signature + +```go +func CreateSimpleApiTool( + name string, + url string, + responseTemplate string, + parameters map[string]map[string]any, + method string, + headers map[string]string, + body map[string]any, + errorKeys []string +) *DataMap +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 391. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/body.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/body.mdx new file mode 100644 index 0000000000..a67833e870 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/body.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/body" +title: "Body" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.Body" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `Body` + +Body sets the request body for the current webhook (for POST/PUT requests). + +## Signature + +```go +func (*DataMap) Body(data map[string]any) *DataMap +``` + +## Parameters + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 259. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/description.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/description.mdx new file mode 100644 index 0000000000..9f3c2f3566 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/description.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/description" +title: "Description" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.Description" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `Description` + +Description sets the LLM-facing tool description. + +This string is read by the model to decide WHEN to call this tool. See Purpose for bad-vs-good examples. Alias for Purpose. + +## Signature + +```go +func (*DataMap) Description(description string) *DataMap +``` + +## Parameters + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 114. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/error-keys.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/error-keys.mdx new file mode 100644 index 0000000000..ed55848614 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/error-keys.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/error-keys" +title: "ErrorKeys" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.ErrorKeys" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `ErrorKeys` + +ErrorKeys sets error indicator keys for the current webhook. + +## Signature + +```go +func (*DataMap) ErrorKeys(keys []string) *DataMap +``` + +## Parameters + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 289. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/expression-regexp.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/expression-regexp.mdx new file mode 100644 index 0000000000..65ed9ec347 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/expression-regexp.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/expression-regexp" +title: "ExpressionRegexp" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.ExpressionRegexp" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `ExpressionRegexp` + +ExpressionRegexp adds a pattern-matching expression using a compiled \*regexp.Regexp. This mirrors Python's expression() which accepts either a plain string or a compiled re.Pattern object — when a compiled pattern is passed, Python extracts pattern.pattern (the raw string). Here, pattern.String() serves the same role. + +testValue is the template string to test (e.g., "$\{args.command\}"). pattern is a compiled regexp whose string representation is used as the match pattern. output is the FunctionResult returned when the pattern matches. nomatchOutput is an optional FunctionResult returned when the pattern does not match (can be nil). + +## Signature + +```go +func (*DataMap) ExpressionRegexp( + testValue string, + pattern *regexp.Regexp, + output *swaig.FunctionResult, + nomatchOutput *swaig.FunctionResult +) *DataMap +``` + +## Parameters + + + + + + + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 171. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/expression.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/expression.mdx new file mode 100644 index 0000000000..c0e966a68e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/expression.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/expression" +title: "Expression" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.Expression" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `Expression` + +Expression adds a pattern-matching expression for expression-based responses. testValue is the template string to test (e.g., "$\{args.command\}"). pattern is the regex pattern to match against. output is the FunctionResult returned when the pattern matches. nomatchOutput is an optional FunctionResult returned when the pattern does not match (can be nil). + +## Signature + +```go +func (*DataMap) Expression( + testValue string, + pattern string, + output *swaig.FunctionResult, + nomatchOutput *swaig.FunctionResult +) *DataMap +``` + +## Parameters + + + + + + + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 152. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/fallback-output.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/fallback-output.mdx new file mode 100644 index 0000000000..ef1ccd87ba --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/fallback-output.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/fallback-output" +title: "FallbackOutput" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.FallbackOutput" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `FallbackOutput` + +FallbackOutput sets the fallback output result used when all webhooks fail. + +## Signature + +```go +func (*DataMap) FallbackOutput(result *swaig.FunctionResult) *DataMap +``` + +## Parameters + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 283. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/foreach.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/foreach.mdx new file mode 100644 index 0000000000..78222cdf71 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/foreach.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/foreach" +title: "Foreach" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.Foreach" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `Foreach` + +Foreach configures array processing for the current webhook response. + +## Signature + +```go +func (*DataMap) Foreach(config map[string]any) *DataMap +``` + +## Parameters + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 271. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/function-name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/function-name.mdx new file mode 100644 index 0000000000..6d170100fc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/function-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/function-name" +title: "FunctionName" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.FunctionName" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `FunctionName` + +FunctionName returns the function name this DataMap was built for. Useful for logging, deduplication checks, and introspection by callers that hold a \*DataMap reference but need to identify which tool it represents. + +## Signature + +```go +func (*DataMap) FunctionName() string +``` + +## Returns + +`string` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 83. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/global-error-keys.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/global-error-keys.mdx new file mode 100644 index 0000000000..564b1e42e3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/global-error-keys.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/global-error-keys" +title: "GlobalErrorKeys" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.GlobalErrorKeys" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `GlobalErrorKeys` + +GlobalErrorKeys sets top-level error keys that apply to all webhooks. + +## Signature + +```go +func (*DataMap) GlobalErrorKeys(keys []string) *DataMap +``` + +## Parameters + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 295. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/index.mdx new file mode 100644 index 0000000000..c485eb8c96 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/index.mdx @@ -0,0 +1,97 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map" +title: "DataMap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + parent: "github.com/signalwire/signalwire-go/pkg/datamap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `DataMap` + +DataMap is a fluent builder for SWAIG data\_map function definitions. Data map tools execute on SignalWire servers without needing a webhook endpoint. + +## Signature + +```go +type DataMap struct +``` + +## Methods + + + + Body sets the request body for the current webhook (for POST/PUT requests). + + + + Description sets the LLM-facing tool description. + + + + ErrorKeys sets error indicator keys for the current webhook. + + + + Expression adds a pattern-matching expression for expression-based responses. testValue is the template string to test (e.g., "$\{args.command\}"). pattern is the regex pattern to match against. output is the FunctionResult returned when the pattern matches. nomatchOutput is an optional FunctionResult returned when the pattern does not match (can be nil). + + + + ExpressionRegexp adds a pattern-matching expression using a compiled \*regexp.Regexp. This mirrors Python's expression() which accepts either a plain string or a compiled re.Pattern object — when a compiled pattern is passed, Python extracts pattern.pattern (the raw string). Here, pattern.String() serves the same role. + + + + FallbackOutput sets the fallback output result used when all webhooks fail. + + + + Foreach configures array processing for the current webhook response. + + + + FunctionName returns the function name this DataMap was built for. Useful for logging, deduplication checks, and introspection by callers that hold a \*DataMap reference but need to identify which tool it represents. + + + + GlobalErrorKeys sets top-level error keys that apply to all webhooks. + + + + Output sets the output result for the current webhook. + + + + Parameter adds a parameter definition — the `desc` is LLM-FACING. + + + + Params sets the request params for the current webhook. + + + + Purpose sets the LLM-facing tool description — this is an alias for Description. + + + + ToSwaigFunction converts the DataMap to a complete SWAIG function definition map. The returned map contains "function", "description", "parameters", and "data\_map" keys, matching the canonical SWML/SWAIG schema consumed by the SignalWire AI platform. + + + + Webhook adds a webhook API call configuration. If a previous webhook was configured, it is finalized first. method is the HTTP method (GET, POST, etc.). url is the API endpoint URL (can include $\{variable\} substitutions). headers are optional HTTP headers (can be nil). formParam sends JSON body as a single form parameter with this name (empty string to skip). inputArgsAsParams merges function arguments into params. requireArgs lists arguments that must be present to execute (can be nil). + + + + WebhookExpressions sets expressions to evaluate after the current webhook completes. + + + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 52. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/output.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/output.mdx new file mode 100644 index 0000000000..b9265de9b4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/output.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/output" +title: "Output" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.Output" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `Output` + +Output sets the output result for the current webhook. + +## Signature + +```go +func (*DataMap) Output(result *swaig.FunctionResult) *DataMap +``` + +## Parameters + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 277. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/parameter.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/parameter.mdx new file mode 100644 index 0000000000..2acec6842f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/parameter.mdx @@ -0,0 +1,92 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/parameter" +title: "Parameter" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.Parameter" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `Parameter` + +Parameter adds a parameter definition — the `desc` is LLM-FACING. + +Each parameter description is rendered into the OpenAI tool schema under parameters.properties.\.description and sent to the model. The model uses it to decide HOW to fill in the argument from user speech. It is prompt engineering, not developer FYI. + +Bad vs good: + +``` +BAD: dm.Parameter("city", "string", "the city", true, nil) +GOOD: dm.Parameter("city", "string", + "The name of the city to get weather for, e.g. 'San Francisco'. "+ + "Ask the user if they did not provide one. Include the state "+ + "or country if the city name is ambiguous.", + true, nil) +``` + +The enum parameter can be nil if no enumeration constraint is needed. + +## Signature + +```go +func (*DataMap) Parameter( + name string, + paramType string, + desc string, + required bool, + enum []string +) *DataMap +``` + +## Parameters + + + + + + + + + + + +## Returns + +`*DataMap` + +## Examples + + + + ```go + BAD: dm.Parameter("city", "string", "the city", true, nil) + GOOD: dm.Parameter("city", "string", + "The name of the city to get weather for, e.g. 'San Francisco'. "+ + "Ask the user if they did not provide one. Include the state "+ + "or country if the city name is ambiguous.", + true, nil) + ``` + + + + ```go + BAD: dm.Parameter("city", "string", "the city", true, nil) + GOOD: dm.Parameter("city", "string", + "The name of the city to get weather for, e.g. 'San Francisco'. "+ + "Ask the user if they did not provide one. Include the state "+ + "or country if the city name is ambiguous.", + true, nil) + ``` + + + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 136. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/params.mdx new file mode 100644 index 0000000000..20c033d8ad --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/params.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/params" +title: "Params" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.Params" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `Params` + +Params sets the request params for the current webhook. + +## Signature + +```go +func (*DataMap) Params(data map[string]any) *DataMap +``` + +## Parameters + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 265. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/purpose.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/purpose.mdx new file mode 100644 index 0000000000..f22bfa4ded --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/purpose.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/purpose" +title: "Purpose" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.Purpose" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `Purpose` + +Purpose sets the LLM-facing tool description — this is an alias for Description. + +The description string is rendered into the OpenAI tool schema "description" field on every LLM turn. The model reads it to decide WHEN to call this tool. It is PROMPT ENGINEERING, not developer documentation. + +A vague Purpose is the #1 cause of "the model has the right tool but doesn't call it" failures with data-map tools. + +Bad vs good: + +``` +BAD: dm.Purpose("weather api") +GOOD: dm.Purpose("Get the current weather conditions and forecast " + + "for a specific city. Use this whenever the user asks about " + + "weather, temperature, rain, or similar conditions in a " + + "named location.") +``` + +## Signature + +```go +func (*DataMap) Purpose(description string) *DataMap +``` + +## Parameters + + + +## Returns + +`*DataMap` + +## Examples + + + + ```go + BAD: dm.Purpose("weather api") + GOOD: dm.Purpose("Get the current weather conditions and forecast " + + "for a specific city. Use this whenever the user asks about " + + "weather, temperature, rain, or similar conditions in a " + + "named location.") + ``` + + + + ```go + BAD: dm.Purpose("weather api") + GOOD: dm.Purpose("Get the current weather conditions and forecast " + + "for a specific city. Use this whenever the user asks about " + + "weather, temperature, rain, or similar conditions in a " + + "named location.") + ``` + + + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 105. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/to-swaig-function.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/to-swaig-function.mdx new file mode 100644 index 0000000000..3373e337a2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/to-swaig-function.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/to-swaig-function" +title: "ToSwaigFunction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.ToSwaigFunction" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `ToSwaigFunction` + +ToSwaigFunction converts the DataMap to a complete SWAIG function definition map. The returned map contains "function", "description", "parameters", and "data\_map" keys, matching the canonical SWML/SWAIG schema consumed by the SignalWire AI platform. + +## Signature + +```go +func (*DataMap) ToSwaigFunction() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 303. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/webhook-expressions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/webhook-expressions.mdx new file mode 100644 index 0000000000..8cb226415a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/webhook-expressions.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/webhook-expressions" +title: "WebhookExpressions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.WebhookExpressions" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `WebhookExpressions` + +WebhookExpressions sets expressions to evaluate after the current webhook completes. + +## Signature + +```go +func (*DataMap) WebhookExpressions(expressions []map[string]any) *DataMap +``` + +## Parameters + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 253. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/webhook.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/webhook.mdx new file mode 100644 index 0000000000..a01f522bff --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/webhook.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/data-map/webhook" +title: "Webhook" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap.Webhook" + parent: "github.com/signalwire/signalwire-go/pkg/datamap.DataMap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `Webhook` + +Webhook adds a webhook API call configuration. If a previous webhook was configured, it is finalized first. method is the HTTP method (GET, POST, etc.). url is the API endpoint URL (can include $\{variable\} substitutions). headers are optional HTTP headers (can be nil). formParam sends JSON body as a single form parameter with this name (empty string to skip). inputArgsAsParams merges function arguments into params. requireArgs lists arguments that must be present to execute (can be nil). + +## Signature + +```go +func (*DataMap) Webhook( + method string, + url string, + headers map[string]string, + formParam string, + inputArgsAsParams bool, + requireArgs []string +) *DataMap +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 237. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/expression-pattern/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/expression-pattern/index.mdx new file mode 100644 index 0000000000..14ac874bb2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/expression-pattern/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/expression-pattern" +title: "ExpressionPattern" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.ExpressionPattern" + parent: "github.com/signalwire/signalwire-go/pkg/datamap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `ExpressionPattern` + +ExpressionPattern pairs a regex pattern string with a FunctionResult to execute when test\_value matches the pattern. Go equivalent of Python's Tuple\[str, FunctionResult] entry in create\_expression\_tool patterns. + +## Signature + +```go +type ExpressionPattern struct +``` + +## Properties + + + + + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 431. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/index.mdx new file mode 100644 index 0000000000..86508573bd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/index.mdx @@ -0,0 +1,90 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap" +title: "datamap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `datamap` + +Package datamap provides a fluent builder for SWAIG data\_map configurations. + +DataMap tools execute on SignalWire's servers without requiring webhook endpoints. They support API calls, expression-based pattern matching, variable expansion, and array processing. + +Example usage: + +``` +dm := datamap.New("get_weather"). + Purpose("Get current weather information"). + Parameter("location", "string", "City name", true, nil). + Webhook("GET", "https://api.weather.com/v1/current?q=${location}", nil, "", false, nil). + Output(swaig.NewFunctionResult("Weather: ${response.current.condition.text}")) +``` + +## Signature + +```go +package datamap +``` + +## Examples + + + + ```go + dm := datamap.New("get_weather"). + Purpose("Get current weather information"). + Parameter("location", "string", "City name", true, nil). + Webhook("GET", "https://api.weather.com/v1/current?q=${location}", nil, "", false, nil). + Output(swaig.NewFunctionResult("Weather: ${response.current.condition.text}")) + ``` + + + + ```go + dm := datamap.New("get_weather"). + Purpose("Get current weather information"). + Parameter("location", "string", "City name", true, nil). + Webhook("GET", "https://api.weather.com/v1/current?q=${location}", nil, "", false, nil). + Output(swaig.NewFunctionResult("Weather: ${response.current.condition.text}")) + ``` + + + +## Functions + + + + CreateExpressionTool creates a DataMap configured for expression-based pattern matching. name is the function name. patterns maps test values to an ExpressionPattern where Pattern is the regex string and Result is the \*swaig.FunctionResult to return on match. parameters maps parameter names to their definitions (each with "type", "description", "required" keys). + + + + CreateSimpleApiTool creates a DataMap configured for a simple API call. name is the function name. url is the API endpoint URL. responseTemplate is the template for formatting the response. parameters maps parameter names to their definitions (each with "type", "description", "required" keys). method is the HTTP method (e.g., "GET", "POST"). headers are optional HTTP headers (can be nil). body is an optional request body for POST/PUT (can be nil). errorKeys are optional error indicator keys (can be nil). + + + + New creates a new DataMap builder for a function with the given name. + + + +## Classes + + + + DataMap is a fluent builder for SWAIG data\_map function definitions. Data map tools execute on SignalWire servers without needing a webhook endpoint. + + + + ExpressionPattern pairs a regex pattern string with a FunctionResult to execute when test\_value matches the pattern. Go equivalent of Python's Tuple\[str, FunctionResult] entry in create\_expression\_tool patterns. + + + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/new.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/new.mdx new file mode 100644 index 0000000000..393b7d56b1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/new.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap/new" +title: "New" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/datamap.New" + parent: "github.com/signalwire/signalwire-go/pkg/datamap" + module: "github.com.signalwire.signalwire-go.pkg.datamap" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go" +--- +# `New` + +New creates a new DataMap builder for a function with the given name. + +## Signature + +```go +func New(functionName string) *DataMap +``` + +## Parameters + + + +## Returns + +`*DataMap` + +## Source + +[`pkg/datamap/datamap.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/datamap/datamap.go) + +Line 74. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler/handle-api-gateway-v2.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler/handle-api-gateway-v2.mdx new file mode 100644 index 0000000000..127f3c81ec --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler/handle-api-gateway-v2.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler/handle-api-gateway-v2" +title: "HandleAPIGatewayV2" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/lambda.Handler.HandleAPIGatewayV2" + parent: "github.com/signalwire/signalwire-go/pkg/lambda.Handler" + module: "github.com.signalwire.signalwire-go.pkg.lambda" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/lambda/lambda.go" +--- +# `HandleAPIGatewayV2` + +HandleAPIGatewayV2 processes an API Gateway HTTP API v2 invocation. The payload shape is virtually identical to Function URLs, but the response type differs, so we provide a dedicated entry point. + +## Signature + +```go +func (*Handler) HandleAPIGatewayV2(ctx context.Context, req events.APIGatewayV2HTTPRequest) (events.APIGatewayV2HTTPResponse, error) +``` + +## Parameters + + + + + +## Returns + +`(events.APIGatewayV2HTTPResponse, error)` + +## Source + +[`pkg/lambda/lambda.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/lambda/lambda.go) + +Line 107. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler/handle-function-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler/handle-function-url.mdx new file mode 100644 index 0000000000..53c0399c6c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler/handle-function-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler/handle-function-url" +title: "HandleFunctionURL" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/lambda.Handler.HandleFunctionURL" + parent: "github.com/signalwire/signalwire-go/pkg/lambda.Handler" + module: "github.com.signalwire.signalwire-go.pkg.lambda" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/lambda/lambda.go" +--- +# `HandleFunctionURL` + +HandleFunctionURL processes a Lambda Function URL invocation. It is intended to be passed to github.com/aws/aws-lambda-go/lambda.Start. + +## Signature + +```go +func (*Handler) HandleFunctionURL(ctx context.Context, req events.LambdaFunctionURLRequest) (events.LambdaFunctionURLResponse, error) +``` + +## Parameters + + + + + +## Returns + +`(events.LambdaFunctionURLResponse, error)` + +## Source + +[`pkg/lambda/lambda.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/lambda/lambda.go) + +Line 84. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler/index.mdx new file mode 100644 index 0000000000..a87077e0f3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/handler" +title: "Handler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/lambda.Handler" + parent: "github.com/signalwire/signalwire-go/pkg/lambda" + module: "github.com.signalwire.signalwire-go.pkg.lambda" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/lambda/lambda.go" +--- +# `Handler` + +Handler wraps an http.Handler so it can service AWS Lambda invocations. Construct one with NewHandler. + +## Signature + +```go +type Handler struct +``` + +## Methods + + + + HandleAPIGatewayV2 processes an API Gateway HTTP API v2 invocation. The payload shape is virtually identical to Function URLs, but the response type differs, so we provide a dedicated entry point. + + + + HandleFunctionURL processes a Lambda Function URL invocation. It is intended to be passed to github.com/aws/aws-lambda-go/lambda.Start. + + + +## Source + +[`pkg/lambda/lambda.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/lambda/lambda.go) + +Line 65. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/index.mdx new file mode 100644 index 0000000000..8448aef60e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/index.mdx @@ -0,0 +1,112 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda" +title: "lambda" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/lambda" + module: "github.com.signalwire.signalwire-go.pkg.lambda" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/lambda/lambda.go" +--- +# `lambda` + +Package lambda adapts a net/http handler produced by the SignalWire Agents SDK (typically agent.AsRouter()) so it can run inside AWS Lambda. + +The adapter translates a Lambda invocation event into a synthetic \*http.Request, runs the underlying handler against an in-memory response recorder, and marshals the recorder's result back into the Lambda response type that matches the invoking event. + +Two event shapes are supported, because they are the two ways an AI agent is realistically exposed over HTTP on Lambda: + +- Lambda Function URLs (events.LambdaFunctionURLRequest / LambdaFunctionURLResponse). This is the simplest deployment and the one we recommend; no API Gateway is required. +- API Gateway HTTP API v2 (events.APIGatewayV2HTTPRequest / APIGatewayV2HTTPResponse). Identical payload shape in practice, but consumers with an API Gateway layer want the exact response type rather than an assignable alias. + +The classic REST API (v1) payload is intentionally not supported as a first-class path to keep this package small. Users who need v1 can wrap it via github.com/awslabs/aws-lambda-go-api-proxy. + +``` +package main + +import ( + "github.com/aws/aws-lambda-go/lambda" + swlambda "github.com/signalwire/signalwire-go/pkg/lambda" + "github.com/signalwire/signalwire-go/pkg/agent" +) + +var a = agent.NewAgentBase(agent.WithName("MyAgent"), agent.WithRoute("/my-agent")) +var handler = swlambda.NewHandler(a.AsRouter()) + +func main() { + lambda.Start(handler.HandleFunctionURL) +} +``` + +Because agent.AsRouter() installs routes relative to the agent's Route (e.g. /my-agent, /my-agent/swaig), the Lambda event's RawPath must line up with that Route. Lambda Function URLs preserve the full request path unchanged, so no rewriting is needed in the common case. + +## Signature + +```go +package lambda +``` + +## Examples + + + + ```go + package main + + import ( + "github.com/aws/aws-lambda-go/lambda" + swlambda "github.com/signalwire/signalwire-go/pkg/lambda" + "github.com/signalwire/signalwire-go/pkg/agent" + ) + + var a = agent.NewAgentBase(agent.WithName("MyAgent"), agent.WithRoute("/my-agent")) + var handler = swlambda.NewHandler(a.AsRouter()) + + func main() { + lambda.Start(handler.HandleFunctionURL) + } + ``` + + + + ```go + package main + + import ( + "github.com/aws/aws-lambda-go/lambda" + swlambda "github.com/signalwire/signalwire-go/pkg/lambda" + "github.com/signalwire/signalwire-go/pkg/agent" + ) + + var a = agent.NewAgentBase(agent.WithName("MyAgent"), agent.WithRoute("/my-agent")) + var handler = swlambda.NewHandler(a.AsRouter()) + + func main() { + lambda.Start(handler.HandleFunctionURL) + } + ``` + + + +## Functions + + + + NewHandler returns a Handler that dispatches Lambda events to the given http.Handler. The handler is usually agent.AsRouter() but any http.Handler works. + + + +## Classes + + + + Handler wraps an http.Handler so it can service AWS Lambda invocations. Construct one with NewHandler. + + + +## Source + +[`pkg/lambda/lambda.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/lambda/lambda.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/new-handler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/new-handler.mdx new file mode 100644 index 0000000000..f4e04e29d9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/new-handler.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda/new-handler" +title: "NewHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/lambda.NewHandler" + parent: "github.com/signalwire/signalwire-go/pkg/lambda" + module: "github.com.signalwire.signalwire-go.pkg.lambda" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/lambda/lambda.go" +--- +# `NewHandler` + +NewHandler returns a Handler that dispatches Lambda events to the given http.Handler. The handler is usually agent.AsRouter() but any http.Handler works. + +Panics if h is nil to fail loudly at cold-start rather than silently returning 500 on every invocation. + +## Signature + +```go +func NewHandler(h http.Handler) *Handler +``` + +## Parameters + + + +## Returns + +`*Handler` + +## Source + +[`pkg/lambda/lambda.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/lambda/lambda.go) + +Line 75. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-handoff/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-handoff/index.mdx new file mode 100644 index 0000000000..fdc46f5863 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-handoff/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-handoff" +title: "AgentHandoff" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentHandoff" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `AgentHandoff` + +AgentHandoff signals a handoff to another agent in multi-agent scenarios. Mirrors Python AgentHandoff(agent, \*, returns=None) (line 153). + +## Signature + +```go +type AgentHandoff struct +``` + +## Properties + + + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 873. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-option.mdx new file mode 100644 index 0000000000..5cddaa5546 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-option" +title: "AgentOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentOption" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `AgentOption` + +AgentOption configures an Agent during construction. + +## Signature + +```go +type AgentOption alias +``` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 139. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/generate-reply.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/generate-reply.mdx new file mode 100644 index 0000000000..8bdc0b5238 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/generate-reply.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/generate-reply" +title: "GenerateReply" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession.GenerateReply" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `GenerateReply` + +GenerateReply triggers the agent to speak. On SignalWire this is handled by the prompt; reply instructions are appended to the prompt. + +## Signature + +```go +func (*AgentSession) GenerateReply(opts ...ReplyOption) +``` + +## Parameters + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 674. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/get-sw-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/get-sw-agent.mdx new file mode 100644 index 0000000000..e87f31879d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/get-sw-agent.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/get-sw-agent" +title: "GetSwAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession.GetSwAgent" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `GetSwAgent` + +GetSwAgent returns the underlying SignalWire AgentBase (for testing/advanced use). + +## Signature + +```go +func (*AgentSession) GetSwAgent() *agent.AgentBase +``` + +## Returns + +`*agent.AgentBase` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 701. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/history.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/history.mdx new file mode 100644 index 0000000000..46d23b2993 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/history.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/history" +title: "History" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession.History" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `History` + +History returns the conversation turn history (read-only). Mirrors Python AgentSession.history property (line 497). + +## Signature + +```go +func (*AgentSession) History() []map[string]string +``` + +## Returns + +`[]map[string]string` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 532. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/index.mdx new file mode 100644 index 0000000000..6ef3d3c2ba --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session" +title: "AgentSession" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `AgentSession` + +AgentSession mirrors a LiveKit AgentSession — it binds an Agent to the SignalWire platform and manages the call lifecycle. + +## Signature + +```go +type AgentSession struct +``` + +## Methods + + + + GenerateReply triggers the agent to speak. On SignalWire this is handled by the prompt; reply instructions are appended to the prompt. + + + + GetSwAgent returns the underlying SignalWire AgentBase (for testing/advanced use). + + + + History returns the conversation turn history (read-only). Mirrors Python AgentSession.history property (line 497). + + + + Interrupt interrupts current speech — noop on SignalWire (barge-in is automatic). + + + + Say queues text to be spoken by the agent. + + + + SetUserdata sets the session-level userdata. Mirrors Python AgentSession.userdata property setter (line 493). + + + + Start binds the session to an agent and prepares the underlying SignalWire AgentBase for serving. + + + + UpdateAgent swaps in a new Agent mid-session. Mirrors Python AgentSession.update\_agent (line 528) which sets self.\_agent = agent and agent.session = self. + + + + UpdateInstructions changes the agent's prompt mid-session. + + + + Userdata returns the session-level userdata. Mirrors Python AgentSession.userdata property getter (line 489). + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 330. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/interrupt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/interrupt.mdx new file mode 100644 index 0000000000..7f8b7e3b04 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/interrupt.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/interrupt" +title: "Interrupt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession.Interrupt" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `Interrupt` + +Interrupt interrupts current speech — noop on SignalWire (barge-in is automatic). + +## Signature + +```go +func (*AgentSession) Interrupt() +``` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 686. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/say.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/say.mdx new file mode 100644 index 0000000000..66a37a4f43 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/say.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/say" +title: "Say" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession.Say" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `Say` + +Say queues text to be spoken by the agent. + +## Signature + +```go +func (*AgentSession) Say(text string) +``` + +## Parameters + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 655. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/set-userdata.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/set-userdata.mdx new file mode 100644 index 0000000000..f4445f8a3e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/set-userdata.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/set-userdata" +title: "SetUserdata" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession.SetUserdata" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `SetUserdata` + +SetUserdata sets the session-level userdata. Mirrors Python AgentSession.userdata property setter (line 493). + +## Signature + +```go +func (*AgentSession) SetUserdata(val any) +``` + +## Parameters + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 526. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/start.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/start.mdx new file mode 100644 index 0000000000..aae092ed61 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/start.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/start" +title: "Start" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession.Start" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `Start` + +Start binds the session to an agent and prepares the underlying SignalWire AgentBase for serving. + +Mirrors Python AgentSession.start(agent, \*, room=None, record=False) (line 504). The room and record parameters are accepted via StartOption functional options (WithRoom and WithRecord) following Go idioms. + +## Signature + +```go +func (*AgentSession) Start(ctx *JobContext, ag *Agent, opts ...StartOption) error +``` + +## Parameters + + + + + + + +## Returns + +`error` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 571. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/update-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/update-agent.mdx new file mode 100644 index 0000000000..7e13bce5b5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/update-agent.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/update-agent" +title: "UpdateAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession.UpdateAgent" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `UpdateAgent` + +UpdateAgent swaps in a new Agent mid-session. Mirrors Python AgentSession.update\_agent (line 528) which sets self.\_agent = agent and agent.session = self. + +## Signature + +```go +func (*AgentSession) UpdateAgent(ag *Agent) +``` + +## Parameters + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 539. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/update-instructions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/update-instructions.mdx new file mode 100644 index 0000000000..e94f66ea8b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/update-instructions.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/update-instructions" +title: "UpdateInstructions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession.UpdateInstructions" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `UpdateInstructions` + +UpdateInstructions changes the agent's prompt mid-session. + +## Signature + +```go +func (*AgentSession) UpdateInstructions(instructions string) +``` + +## Parameters + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 691. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/userdata.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/userdata.mdx new file mode 100644 index 0000000000..a261c2048f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/userdata.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent-session/userdata" +title: "Userdata" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession.Userdata" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.AgentSession" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `Userdata` + +Userdata returns the session-level userdata. Mirrors Python AgentSession.userdata property getter (line 489). + +## Signature + +```go +func (*AgentSession) Userdata() any +``` + +## Returns + +`any` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 520. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/function-tool.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/function-tool.mdx new file mode 100644 index 0000000000..fb55811e2a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/function-tool.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/function-tool" +title: "FunctionTool" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.Agent.FunctionTool" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.Agent" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `FunctionTool` + +FunctionTool registers a named tool on the agent. The handler must be + +``` +func(args map[string]any, rawData map[string]any) *swaig.FunctionResult +``` + +or a LiveKit-style handler that will be wrapped: + +``` +func(ctx *RunContext, location string) string +``` + +In the LiveKit-style case the function's string parameters are inferred and the return string is wrapped into a FunctionResult automatically. + +## Signature + +```go +func (*Agent) FunctionTool(name string, handler any, opts ...ToolOption) *Agent +``` + +## Parameters + + + + + + + +## Returns + +`*Agent` + +## Examples + + + + ```go + func(args map[string]any, rawData map[string]any) *swaig.FunctionResult + ``` + + + + ```go + func(ctx *RunContext, location string) string + ``` + + + + ```go + func(args map[string]any, rawData map[string]any) *swaig.FunctionResult + ``` + + + + ```go + func(ctx *RunContext, location string) string + ``` + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 196. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/index.mdx new file mode 100644 index 0000000000..ea0d288d54 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent" +title: "Agent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.Agent" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `Agent` + +Agent mirrors a LiveKit Agent — it holds instructions and tool definitions. + +## Signature + +```go +type Agent struct +``` + +## Methods + + + + FunctionTool registers a named tool on the agent. The handler must be + + + + Instructions returns the agent's current instructions string. Mirrors Python Agent.instructions (public read/write attribute, line 290). + + + + OnEnter registers a callback to be invoked when the agent enters a session. Mirrors Python Agent.on\_enter lifecycle hook (line 346). Returns the Agent for method chaining. + + + + OnExit registers a callback to be invoked when the agent exits a session. Mirrors Python Agent.on\_exit lifecycle hook (line 350). Returns the Agent for method chaining. + + + + OnUserTurnCompleted registers a callback invoked when the user finishes speaking. The two arguments mirror Python's turn\_ctx and new\_message parameters (line 354), typed as any to avoid a LiveKit dependency. Returns the Agent for method chaining. + + + + Session returns the AgentSession currently bound to this agent, or nil if the agent has not been started. Mirrors Python Agent.session property (lines 334–340). + + + + UpdateTools replaces the agent's tool list. Mirrors Python Agent.update\_tools (livewire/**init**.py:394) which accepts List\[Any] and stores self.\_tools = list(tools). In Go, the parameter is \[]any to keep the unexported toolDef out of the public signature (the original typed \[]toolDef made the method uncallable from external packages). Elements that aren't recognized tools are silently skipped, matching Python's permissive storage semantics. Returns the Agent for method chaining. + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 124. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/instructions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/instructions.mdx new file mode 100644 index 0000000000..652553afbd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/instructions.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/instructions" +title: "Instructions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.Agent.Instructions" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.Agent" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `Instructions` + +Instructions returns the agent's current instructions string. Mirrors Python Agent.instructions (public read/write attribute, line 290). + +## Signature + +```go +func (*Agent) Instructions() string +``` + +## Returns + +`string` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 242. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-enter.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-enter.mdx new file mode 100644 index 0000000000..fbae9983b5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-enter.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-enter" +title: "OnEnter" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.Agent.OnEnter" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.Agent" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `OnEnter` + +OnEnter registers a callback to be invoked when the agent enters a session. Mirrors Python Agent.on\_enter lifecycle hook (line 346). Returns the Agent for method chaining. + +## Signature + +```go +func (*Agent) OnEnter(fn func()) *Agent +``` + +## Parameters + + + +## Returns + +`*Agent` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 256. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-exit.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-exit.mdx new file mode 100644 index 0000000000..8eeda1725b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-exit.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-exit" +title: "OnExit" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.Agent.OnExit" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.Agent" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `OnExit` + +OnExit registers a callback to be invoked when the agent exits a session. Mirrors Python Agent.on\_exit lifecycle hook (line 350). Returns the Agent for method chaining. + +## Signature + +```go +func (*Agent) OnExit(fn func()) *Agent +``` + +## Parameters + + + +## Returns + +`*Agent` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 264. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-user-turn-completed.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-user-turn-completed.mdx new file mode 100644 index 0000000000..63f03da90a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-user-turn-completed.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/on-user-turn-completed" +title: "OnUserTurnCompleted" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.Agent.OnUserTurnCompleted" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.Agent" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `OnUserTurnCompleted` + +OnUserTurnCompleted registers a callback invoked when the user finishes speaking. The two arguments mirror Python's turn\_ctx and new\_message parameters (line 354), typed as any to avoid a LiveKit dependency. Returns the Agent for method chaining. + +## Signature + +```go +func (*Agent) OnUserTurnCompleted(fn func(turnCtx any, newMessage any)) *Agent +``` + +## Parameters + + + +## Returns + +`*Agent` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 273. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/session.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/session.mdx new file mode 100644 index 0000000000..5a9b1d8c96 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/session.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/session" +title: "Session" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.Agent.Session" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.Agent" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `Session` + +Session returns the AgentSession currently bound to this agent, or nil if the agent has not been started. Mirrors Python Agent.session property (lines 334–340). + +## Signature + +```go +func (*Agent) Session() *AgentSession +``` + +## Returns + +`*AgentSession` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 249. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/update-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/update-tools.mdx new file mode 100644 index 0000000000..f3ae0262b9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/update-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/agent/update-tools" +title: "UpdateTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.Agent.UpdateTools" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.Agent" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `UpdateTools` + +UpdateTools replaces the agent's tool list. Mirrors Python Agent.update\_tools (livewire/**init**.py:394) which accepts List\[Any] and stores self.\_tools = list(tools). In Go, the parameter is \[]any to keep the unexported toolDef out of the public signature (the original typed \[]toolDef made the method uncallable from external packages). Elements that aren't recognized tools are silently skipped, matching Python's permissive storage semantics. Returns the Agent for method chaining. + +## Signature + +```go +func (*Agent) UpdateTools(tools []any) *Agent +``` + +## Parameters + + + +## Returns + +`*Agent` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 286. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/cartesia-tts/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/cartesia-tts/index.mdx new file mode 100644 index 0000000000..b9bd3ded57 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/cartesia-tts/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/cartesia-tts" +title: "CartesiaTTS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.CartesiaTTS" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `CartesiaTTS` + +CartesiaTTS is a stub for the Cartesia TTS provider. + +## Signature + +```go +type CartesiaTTS struct +``` + +## Properties + + + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 79. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-context/append.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-context/append.mdx new file mode 100644 index 0000000000..6764f67e15 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-context/append.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-context/append" +title: "Append" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.ChatContext.Append" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.ChatContext" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `Append` + +Append adds a role/content message to the context and returns the receiver for method chaining. If role is empty it defaults to "user"; if content is empty it defaults to "" (empty string), matching the Python defaults role="user", text="". + +## Signature + +```go +func (*ChatContext) Append(role string, content string) *ChatContext +``` + +## Parameters + + + + + +## Returns + +`*ChatContext` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 929. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-context/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-context/index.mdx new file mode 100644 index 0000000000..814f7de5bc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-context/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-context" +title: "ChatContext" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.ChatContext" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `ChatContext` + +ChatContext buffers a conversation as an ordered list of role/content messages. It mirrors the Python livewire.ChatContext stub which is API-compatible with the livekit-agents ChatContext shape. + +## Signature + +```go +type ChatContext struct +``` + +## Properties + + + +## Methods + + + + Append adds a role/content message to the context and returns the receiver for method chaining. If role is empty it defaults to "user"; if content is empty it defaults to "" (empty string), matching the Python defaults role="user", text="". + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 918. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-message/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-message/index.mdx new file mode 100644 index 0000000000..e3026b845c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-message/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/chat-message" +title: "ChatMessage" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.ChatMessage" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `ChatMessage` + +ChatMessage holds a single role/content pair in a conversation history. The JSON tags match the dict keys produced by the Python ChatContext.append() implementation: \{"role": ..., "content": ...\}. + +## Signature + +```go +type ChatMessage struct +``` + +## Properties + + + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 910. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/deepgram-stt/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/deepgram-stt/index.mdx new file mode 100644 index 0000000000..a51fc45766 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/deepgram-stt/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/deepgram-stt" +title: "DeepgramSTT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.DeepgramSTT" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `DeepgramSTT` + +DeepgramSTT is a stub for the Deepgram STT provider. On SignalWire, speech recognition is handled by the control plane. + +## Signature + +```go +type DeepgramSTT struct +``` + +## Properties + + + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 9. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/eleven-labs-tts/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/eleven-labs-tts/index.mdx new file mode 100644 index 0000000000..5078916650 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/eleven-labs-tts/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/eleven-labs-tts" +title: "ElevenLabsTTS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.ElevenLabsTTS" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `ElevenLabsTTS` + +ElevenLabsTTS is a stub for the ElevenLabs TTS provider. + +## Signature + +```go +type ElevenLabsTTS struct +``` + +## Properties + + + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 65. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/google-stt/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/google-stt/index.mdx new file mode 100644 index 0000000000..da5ab856fa --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/google-stt/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/google-stt" +title: "GoogleSTT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.GoogleSTT" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `GoogleSTT` + +GoogleSTT is a stub for the Google STT provider. + +## Signature + +```go +type GoogleSTT struct +``` + +## Properties + + + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 24. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/index.mdx new file mode 100644 index 0000000000..89e1d82654 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/index.mdx @@ -0,0 +1,326 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire" +title: "livewire" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `livewire` + +Package livewire provides a LiveKit-compatible API surface that runs on SignalWire's platform. Developers can use familiar LiveKit struct and function names — just change the import path to get SignalWire's infrastructure handling STT, TTS, VAD, LLM, and call control. + +## Signature + +```go +package livewire +``` + +## Functions + + + + NewAgent creates a new Agent with the given instructions and options. + + + + NewAgentServer creates a new LiveServer. + + + + NewAgentSession creates a new AgentSession with the given options. Mirrors Python AgentSession.**init** which initializes \_history to \[] (line 480) and \_userdata to \{\} when not provided (line 460). + + + + NewCartesiaTTS creates a CartesiaTTS stub. + + + + NewChatContext returns an empty ChatContext ready for use. + + + + NewDeepgramSTT creates a DeepgramSTT stub. + + + + NewElevenLabsTTS creates an ElevenLabsTTS stub. + + + + NewGoogleSTT creates a GoogleSTT stub. + + + + NewInferenceLLM creates an InferenceLLM stub with the given options. + + + + NewInferenceSTT creates an InferenceSTT stub with the given options. + + + + NewInferenceTTS creates an InferenceTTS stub with the given model hint. The model value is stored for compatibility but is otherwise unused. + + + + NewOpenAILLM creates an OpenAILLM stub. + + + + NewOpenAITTS creates an OpenAITTS stub. + + + + NewSileroVAD creates a SileroVAD stub. Mirrors Python SileroVAD(\*\*kwargs) — accepts functional options for LiveKit portability, matching the in-file convention for all other stubs. + + + + NewToolError constructs a ToolError with the given message. + + + + RunApp starts the LiveWire agent — prints the banner, a random tip, invokes the setup function (if any), calls the entrypoint, and starts the underlying SignalWire agent server. + + + + WithAgentName sets the agent name for the RTC session. + + + + WithAllowInterruptions maps to barge configuration on SignalWire. + + + + WithDescription sets the tool description. + + + + WithInferenceLLMModel returns a functional option that sets the model string. + + + + WithInferenceSTTModel returns a functional option that sets the model string. + + + + WithLLM sets the LLM model — this maps to SignalWire AI params. + + + + WithMaxEndpointingDelay maps to AI params on SignalWire. + + + + WithMaxToolSteps sets the maximum tool call chain depth — noop on SignalWire. + + + + WithMCPServers is a LiveKit-compatible noop — MCP servers are not yet supported in LiveWire. Tools should be registered via FunctionTool. Mirrors Python Agent(mcp\_servers=...) which emits a one-time noop warning. + + + + WithMinEndpointingDelay maps to end\_of\_speech\_timeout on SignalWire. + + + + WithMinInterruptionDuration sets the minimum interruption duration — noop on SignalWire where barge-in timing is handled automatically. Mirrors Python AgentSession(min\_interruption\_duration=0.5) (line 419). + + + + WithOnRequest accepts a request callback — noop on SignalWire. Mirrors Python AgentServer.rtc\_session(on\_request=...) which silently ignores the parameter for LiveKit portability. + + + + WithOnSessionEnd accepts a session-end callback — noop on SignalWire. Mirrors Python AgentServer.rtc\_session(on\_session\_end=...) which silently ignores the parameter for LiveKit portability. + + + + WithParameters sets explicit JSON-Schema parameters for a tool. + + + + WithPreemptiveGeneration enables or disables preemptive generation — noop on SignalWire. Mirrors Python AgentSession(preemptive\_generation=False) (line 423). + + + + WithRecord enables call recording for the session. Mirrors Python AgentSession.start(record=False) keyword-only param (line 504). + + + + WithReplyInstructions sets the instructions for the generated reply. + + + + WithRoom sets the room for the session start. Mirrors Python AgentSession.start(room=...) keyword-only param (line 504). + + + + WithServerType sets the server type ("room" or "publisher") — noop on SignalWire. + + + + WithSessionMCPServers stores the MCP servers value on the session — noop on SignalWire. Mirrors Python AgentSession(mcp\_servers=...) which emits a one-time noop warning (lines 450–456). + + + + WithSessionTools appends session-level tools to the AgentSession. These are merged with the bound Agent's tools in Start(). Mirrors Python AgentSession(tools=...) which stores list(tools or \[]) on self.\_tools (line 459) and merges them in \_build\_sw\_agent() (line 591). + + + + WithSessionUserdata attaches arbitrary user data to the session. Mirrors Python AgentSession(userdata=...) which stores the value as self.\_userdata (line 460). + + + + WithSTT sets the STT provider — noop on SignalWire (handled by the control plane). + + + + WithTools is a LiveKit-compatible noop — use FunctionTool to register tools. + + + + WithTTS sets the TTS provider — noop on SignalWire (voice can be configured via languages). + + + + WithTurnDetection sets the turn detection mode — noop on SignalWire. + + + + WithUserdata attaches arbitrary user data to the agent. + + + + WithVAD sets the VAD provider — noop on SignalWire (handled by the control plane). + + + +## Type Aliases + + + + AgentOption configures an Agent during construction. + + + + ReplyOption configures a GenerateReply call. + + + + RTCOption configures an RTC session. + + + + SessionOption configures an AgentSession. + + + + StartOption configures a Start() call. + + + + ToolOption configures a tool definition. + + + +## Classes + + + + Agent mirrors a LiveKit Agent — it holds instructions and tool definitions. + + + + AgentHandoff signals a handoff to another agent in multi-agent scenarios. Mirrors Python AgentHandoff(agent, \*, returns=None) (line 153). + + + + AgentSession mirrors a LiveKit AgentSession — it binds an Agent to the SignalWire platform and manages the call lifecycle. + + + + CartesiaTTS is a stub for the Cartesia TTS provider. + + + + ChatContext buffers a conversation as an ordered list of role/content messages. It mirrors the Python livewire.ChatContext stub which is API-compatible with the livekit-agents ChatContext shape. + + + + ChatMessage holds a single role/content pair in a conversation history. The JSON tags match the dict keys produced by the Python ChatContext.append() implementation: \{"role": ..., "content": ...\}. + + + + DeepgramSTT is a stub for the Deepgram STT provider. On SignalWire, speech recognition is handled by the control plane. + + + + ElevenLabsTTS is a stub for the ElevenLabs TTS provider. + + + + GoogleSTT is a stub for the Google STT provider. + + + + InferenceLLM is a stub for the SignalWire-hosted inference LLM. On SignalWire, the LLM pipeline is handled by the control plane; the Model field is forwarded to SignalWire AI parameters. Mirrors Python InferenceLLM(model="") (livewire/**init**.py:751). + + + + InferenceSTT is a stub for the SignalWire-hosted inference STT provider. On SignalWire, speech recognition is handled by the control plane. Mirrors Python InferenceSTT(model="") (livewire/**init**.py:736). + + + + InferenceTTS is a no-op stub providing LiveKit import compatibility. SignalWire's control plane handles text-to-speech; this type exists so code written for livekit/agents inference.TTS can be dropped in unchanged. + + + + JobContext mirrors a LiveKit JobContext — provides room and connection info. + + + + JobProcess mirrors a LiveKit JobProcess — used for prewarm/setup. + + + + LiveServer mirrors a LiveKit AgentServer — it registers entrypoints and starts the agent. + + + + OpenAILLM is a stub for the OpenAI LLM provider. + + + + OpenAITTS is a stub for the OpenAI TTS provider. + + + + Room is a stub — SignalWire doesn't use the LiveKit room abstraction. + + + + RunContext mirrors a LiveKit RunContext — available inside tool handlers. + + + + SileroVAD is a stub for the Silero VAD provider. + + + + StopResponse signals that a tool should not trigger another LLM reply. + + + + ToolError signals a tool execution error. Return a \*ToolError from a tool handler to tell the framework the tool failed; the error message is forwarded to the LLM as a tool-failure notification rather than triggering a normal LLM reply. Parallel to StopResponse in this file. + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-llm/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-llm/index.mdx new file mode 100644 index 0000000000..9966dd50ce --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-llm/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-llm" +title: "InferenceLLM" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.InferenceLLM" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `InferenceLLM` + +InferenceLLM is a stub for the SignalWire-hosted inference LLM. On SignalWire, the LLM pipeline is handled by the control plane; the Model field is forwarded to SignalWire AI parameters. Mirrors Python InferenceLLM(model="") (livewire/**init**.py:751). + +## Signature + +```go +type InferenceLLM struct +``` + +## Properties + + + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 129. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-stt/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-stt/index.mdx new file mode 100644 index 0000000000..9cefe09a54 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-stt/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-stt" +title: "InferenceSTT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.InferenceSTT" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `InferenceSTT` + +InferenceSTT is a stub for the SignalWire-hosted inference STT provider. On SignalWire, speech recognition is handled by the control plane. Mirrors Python InferenceSTT(model="") (livewire/**init**.py:736). + +## Signature + +```go +type InferenceSTT struct +``` + +## Properties + + + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 41. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-tts/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-tts/index.mdx new file mode 100644 index 0000000000..08b4a7a3cc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-tts/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/inference-tts" +title: "InferenceTTS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.InferenceTTS" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `InferenceTTS` + +InferenceTTS is a no-op stub providing LiveKit import compatibility. SignalWire's control plane handles text-to-speech; this type exists so code written for livekit/agents inference.TTS can be dropped in unchanged. + +## Signature + +```go +type InferenceTTS struct +``` + +## Properties + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 944. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context/connect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context/connect.mdx new file mode 100644 index 0000000000..e745b87632 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context/connect.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context/connect" +title: "Connect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.JobContext.Connect" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.JobContext" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `Connect` + +Connect is a LiveKit compatibility noop — SignalWire agents connect automatically when the platform invokes the SWML endpoint. + +## Signature + +```go +func (*JobContext) Connect() error +``` + +## Returns + +`error` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 718. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context/index.mdx new file mode 100644 index 0000000000..193af45f13 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context" +title: "JobContext" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.JobContext" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `JobContext` + +JobContext mirrors a LiveKit JobContext — provides room and connection info. + +## Signature + +```go +type JobContext struct +``` + +## Properties + + + + + +## Methods + + + + Connect is a LiveKit compatibility noop — SignalWire agents connect automatically when the platform invokes the SWML endpoint. + + + + WaitForParticipant is a LiveKit compatibility noop — SignalWire handles participant management automatically. Mirrors Python JobContext.wait\_for\_participant(\*, identity=None) (line 670). + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 710. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context/wait-for-participant.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context/wait-for-participant.mdx new file mode 100644 index 0000000000..779b5a2b04 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context/wait-for-participant.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-context/wait-for-participant" +title: "WaitForParticipant" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.JobContext.WaitForParticipant" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.JobContext" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WaitForParticipant` + +WaitForParticipant is a LiveKit compatibility noop — SignalWire handles participant management automatically. Mirrors Python JobContext.wait\_for\_participant(\*, identity=None) (line 670). + +## Signature + +```go +func (*JobContext) WaitForParticipant(identity string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 726. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-process/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-process/index.mdx new file mode 100644 index 0000000000..a668bb8e9b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-process/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/job-process" +title: "JobProcess" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.JobProcess" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `JobProcess` + +JobProcess mirrors a LiveKit JobProcess — used for prewarm/setup. + +## Signature + +```go +type JobProcess struct +``` + +## Properties + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 823. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server/index.mdx new file mode 100644 index 0000000000..5e4fde685d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server" +title: "LiveServer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.LiveServer" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `LiveServer` + +LiveServer mirrors a LiveKit AgentServer — it registers entrypoints and starts the agent. + +## Signature + +```go +type LiveServer struct +``` + +## Methods + + + + RTCSession registers the session entrypoint function. + + + + SetSetupFunc sets the prewarm/setup function — noop on SignalWire. + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 746. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server/rtc-session.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server/rtc-session.mdx new file mode 100644 index 0000000000..75e9e97217 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server/rtc-session.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server/rtc-session" +title: "RTCSession" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.LiveServer.RTCSession" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.LiveServer" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `RTCSession` + +RTCSession registers the session entrypoint function. + +## Signature + +```go +func (*LiveServer) RTCSession(fn func(*JobContext), opts ...RTCOption) +``` + +## Parameters + + + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 807. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server/set-setup-func.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server/set-setup-func.mdx new file mode 100644 index 0000000000..43d6de754e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server/set-setup-func.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/live-server/set-setup-func" +title: "SetSetupFunc" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.LiveServer.SetSetupFunc" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.LiveServer" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `SetSetupFunc` + +SetSetupFunc sets the prewarm/setup function — noop on SignalWire. + +## Signature + +```go +func (*LiveServer) SetSetupFunc(fn func(*JobProcess)) +``` + +## Parameters + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 801. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent-server.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent-server.mdx new file mode 100644 index 0000000000..4c00036a3b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent-server.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent-server" +title: "NewAgentServer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewAgentServer" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `NewAgentServer` + +NewAgentServer creates a new LiveServer. + +## Signature + +```go +func NewAgentServer() *LiveServer +``` + +## Returns + +`*LiveServer` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 754. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent-session.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent-session.mdx new file mode 100644 index 0000000000..59c9b5305f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent-session.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent-session" +title: "NewAgentSession" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewAgentSession" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `NewAgentSession` + +NewAgentSession creates a new AgentSession with the given options. Mirrors Python AgentSession.**init** which initializes \_history to \[] (line 480) and \_userdata to \{\} when not provided (line 460). + +## Signature + +```go +func NewAgentSession(opts ...SessionOption) *AgentSession +``` + +## Parameters + + + +## Returns + +`*AgentSession` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 495. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent.mdx new file mode 100644 index 0000000000..a5ac9f7247 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-agent" +title: "NewAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewAgent" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `NewAgent` + +NewAgent creates a new Agent with the given instructions and options. + +## Signature + +```go +func NewAgent(instructions string, opts ...AgentOption) *Agent +``` + +## Parameters + + + + + +## Returns + +`*Agent` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 163. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-cartesia-tts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-cartesia-tts.mdx new file mode 100644 index 0000000000..fb018c86e5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-cartesia-tts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-cartesia-tts" +title: "NewCartesiaTTS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewCartesiaTTS" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `NewCartesiaTTS` + +NewCartesiaTTS creates a CartesiaTTS stub. + +## Signature + +```go +func NewCartesiaTTS(opts ...func(*CartesiaTTS)) *CartesiaTTS +``` + +## Parameters + + + +## Returns + +`*CartesiaTTS` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 84. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-chat-context.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-chat-context.mdx new file mode 100644 index 0000000000..23528fa5b3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-chat-context.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-chat-context" +title: "NewChatContext" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewChatContext" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `NewChatContext` + +NewChatContext returns an empty ChatContext ready for use. + +## Signature + +```go +func NewChatContext() *ChatContext +``` + +## Returns + +`*ChatContext` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 923. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-deepgram-stt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-deepgram-stt.mdx new file mode 100644 index 0000000000..4894fc7273 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-deepgram-stt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-deepgram-stt" +title: "NewDeepgramSTT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewDeepgramSTT" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `NewDeepgramSTT` + +NewDeepgramSTT creates a DeepgramSTT stub. + +## Signature + +```go +func NewDeepgramSTT(opts ...func(*DeepgramSTT)) *DeepgramSTT +``` + +## Parameters + + + +## Returns + +`*DeepgramSTT` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 14. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-eleven-labs-tts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-eleven-labs-tts.mdx new file mode 100644 index 0000000000..260262d873 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-eleven-labs-tts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-eleven-labs-tts" +title: "NewElevenLabsTTS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewElevenLabsTTS" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `NewElevenLabsTTS` + +NewElevenLabsTTS creates an ElevenLabsTTS stub. + +## Signature + +```go +func NewElevenLabsTTS(opts ...func(*ElevenLabsTTS)) *ElevenLabsTTS +``` + +## Parameters + + + +## Returns + +`*ElevenLabsTTS` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 70. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-google-stt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-google-stt.mdx new file mode 100644 index 0000000000..eabc6ec487 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-google-stt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-google-stt" +title: "NewGoogleSTT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewGoogleSTT" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `NewGoogleSTT` + +NewGoogleSTT creates a GoogleSTT stub. + +## Signature + +```go +func NewGoogleSTT(opts ...func(*GoogleSTT)) *GoogleSTT +``` + +## Parameters + + + +## Returns + +`*GoogleSTT` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 29. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-llm.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-llm.mdx new file mode 100644 index 0000000000..d81bcefbf8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-llm.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-llm" +title: "NewInferenceLLM" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewInferenceLLM" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `NewInferenceLLM` + +NewInferenceLLM creates an InferenceLLM stub with the given options. + +## Signature + +```go +func NewInferenceLLM(opts ...func(*InferenceLLM)) *InferenceLLM +``` + +## Parameters + + + +## Returns + +`*InferenceLLM` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 134. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-stt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-stt.mdx new file mode 100644 index 0000000000..d8a8fed640 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-stt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-stt" +title: "NewInferenceSTT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewInferenceSTT" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `NewInferenceSTT` + +NewInferenceSTT creates an InferenceSTT stub with the given options. + +## Signature + +```go +func NewInferenceSTT(opts ...func(*InferenceSTT)) *InferenceSTT +``` + +## Parameters + + + +## Returns + +`*InferenceSTT` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 46. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-tts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-tts.mdx new file mode 100644 index 0000000000..1de467c441 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-tts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-inference-tts" +title: "NewInferenceTTS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewInferenceTTS" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `NewInferenceTTS` + +NewInferenceTTS creates an InferenceTTS stub with the given model hint. The model value is stored for compatibility but is otherwise unused. + +## Signature + +```go +func NewInferenceTTS(model string) *InferenceTTS +``` + +## Parameters + + + +## Returns + +`*InferenceTTS` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 950. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-open-aillm.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-open-aillm.mdx new file mode 100644 index 0000000000..763e75e779 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-open-aillm.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-open-aillm" +title: "NewOpenAILLM" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewOpenAILLM" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `NewOpenAILLM` + +NewOpenAILLM creates an OpenAILLM stub. + +## Signature + +```go +func NewOpenAILLM(opts ...func(*OpenAILLM)) *OpenAILLM +``` + +## Parameters + + + +## Returns + +`*OpenAILLM` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 116. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-open-aitts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-open-aitts.mdx new file mode 100644 index 0000000000..e9d596009f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-open-aitts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-open-aitts" +title: "NewOpenAITTS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewOpenAITTS" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `NewOpenAITTS` + +NewOpenAITTS creates an OpenAITTS stub. + +## Signature + +```go +func NewOpenAITTS(opts ...func(*OpenAITTS)) *OpenAITTS +``` + +## Parameters + + + +## Returns + +`*OpenAITTS` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 98. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-silero-vad.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-silero-vad.mdx new file mode 100644 index 0000000000..f435e12037 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-silero-vad.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-silero-vad" +title: "NewSileroVAD" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewSileroVAD" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `NewSileroVAD` + +NewSileroVAD creates a SileroVAD stub. Mirrors Python SileroVAD(\*\*kwargs) — accepts functional options for LiveKit portability, matching the in-file convention for all other stubs. + +## Signature + +```go +func NewSileroVAD(opts ...func(*SileroVAD)) *SileroVAD +``` + +## Parameters + + + +## Returns + +`*SileroVAD` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 157. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-tool-error.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-tool-error.mdx new file mode 100644 index 0000000000..a63041b74a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-tool-error.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/new-tool-error" +title: "NewToolError" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.NewToolError" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `NewToolError` + +NewToolError constructs a ToolError with the given message. + +## Signature + +```go +func NewToolError(message string) *ToolError +``` + +## Parameters + + + +## Returns + +`*ToolError` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 901. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/open-aillm/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/open-aillm/index.mdx new file mode 100644 index 0000000000..9f51f257eb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/open-aillm/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/open-aillm" +title: "OpenAILLM" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.OpenAILLM" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `OpenAILLM` + +OpenAILLM is a stub for the OpenAI LLM provider. + +## Signature + +```go +type OpenAILLM struct +``` + +## Properties + + + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 111. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/open-aitts/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/open-aitts/index.mdx new file mode 100644 index 0000000000..4223c9113d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/open-aitts/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/open-aitts" +title: "OpenAITTS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.OpenAITTS" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `OpenAITTS` + +OpenAITTS is a stub for the OpenAI TTS provider. + +## Signature + +```go +type OpenAITTS struct +``` + +## Properties + + + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 93. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/reply-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/reply-option.mdx new file mode 100644 index 0000000000..701a363308 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/reply-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/reply-option" +title: "ReplyOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.ReplyOption" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `ReplyOption` + +ReplyOption configures a GenerateReply call. + +## Signature + +```go +type ReplyOption alias +``` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 665. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/room/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/room/index.mdx new file mode 100644 index 0000000000..0693a0deae --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/room/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/room" +title: "Room" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.Room" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `Room` + +Room is a stub — SignalWire doesn't use the LiveKit room abstraction. + +## Signature + +```go +type Room struct +``` + +## Properties + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 736. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/rtc-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/rtc-option.mdx new file mode 100644 index 0000000000..ddd21fbb2e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/rtc-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/rtc-option" +title: "RTCOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.RTCOption" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `RTCOption` + +RTCOption configures an RTC session. + +## Signature + +```go +type RTCOption alias +``` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 767. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/run-app.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/run-app.mdx new file mode 100644 index 0000000000..434eb14647 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/run-app.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/run-app" +title: "RunApp" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.RunApp" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `RunApp` + +RunApp starts the LiveWire agent — prints the banner, a random tip, invokes the setup function (if any), calls the entrypoint, and starts the underlying SignalWire agent server. + +## Signature + +```go +func RunApp(server *LiveServer) +``` + +## Parameters + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 834. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/run-context/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/run-context/index.mdx new file mode 100644 index 0000000000..b9541cdcc1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/run-context/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/run-context" +title: "RunContext" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.RunContext" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `RunContext` + +RunContext mirrors a LiveKit RunContext — available inside tool handlers. + +## Signature + +```go +type RunContext struct +``` + +## Properties + + + + + + + + + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 316. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/session-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/session-option.mdx new file mode 100644 index 0000000000..a7d8b5de65 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/session-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/session-option" +title: "SessionOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.SessionOption" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `SessionOption` + +SessionOption configures an AgentSession. + +## Signature + +```go +type SessionOption alias +``` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 376. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/silero-vad/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/silero-vad/index.mdx new file mode 100644 index 0000000000..58377e8ad7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/silero-vad/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/silero-vad" +title: "SileroVAD" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.SileroVAD" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `SileroVAD` + +SileroVAD is a stub for the Silero VAD provider. + +## Signature + +```go +type SileroVAD struct +``` + +## Methods + + + + Load is a noop — Silero VAD model loading is not needed on SignalWire. + + + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 152. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/silero-vad/load.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/silero-vad/load.mdx new file mode 100644 index 0000000000..7a4db00b94 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/silero-vad/load.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/silero-vad/load" +title: "Load" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.SileroVAD.Load" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.SileroVAD" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `Load` + +Load is a noop — Silero VAD model loading is not needed on SignalWire. + +## Signature + +```go +func (*SileroVAD) Load() *SileroVAD +``` + +## Returns + +`*SileroVAD` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 166. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/start-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/start-option.mdx new file mode 100644 index 0000000000..900d8a6bd0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/start-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/start-option" +title: "StartOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.StartOption" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `StartOption` + +StartOption configures a Start() call. + +## Signature + +```go +type StartOption alias +``` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 551. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/stop-response/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/stop-response/index.mdx new file mode 100644 index 0000000000..12e3b2915d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/stop-response/index.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/stop-response" +title: "StopResponse" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.StopResponse" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `StopResponse` + +StopResponse signals that a tool should not trigger another LLM reply. + +## Signature + +```go +type StopResponse struct +``` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 883. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-error/error.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-error/error.mdx new file mode 100644 index 0000000000..c95f5deb8a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-error/error.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-error/error" +title: "Error" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.ToolError.Error" + parent: "github.com/signalwire/signalwire-go/pkg/livewire.ToolError" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `Error` + +Error implements the built-in error interface. + +## Signature + +```go +func (*ToolError) Error() string +``` + +## Returns + +`string` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 898. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-error/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-error/index.mdx new file mode 100644 index 0000000000..e48d968242 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-error/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-error" +title: "ToolError" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.ToolError" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `ToolError` + +ToolError signals a tool execution error. Return a \*ToolError from a tool handler to tell the framework the tool failed; the error message is forwarded to the LLM as a tool-failure notification rather than triggering a normal LLM reply. Parallel to StopResponse in this file. + +## Signature + +```go +type ToolError struct +``` + +## Properties + + + +## Methods + + + + Error implements the built-in error interface. + + + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 893. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-option.mdx new file mode 100644 index 0000000000..df91119071 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/tool-option" +title: "ToolOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.ToolOption" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `ToolOption` + +ToolOption configures a tool definition. + +## Signature + +```go +type ToolOption alias +``` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 174. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-agent-name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-agent-name.mdx new file mode 100644 index 0000000000..83d644c8e0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-agent-name.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-agent-name" +title: "WithAgentName" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithAgentName" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithAgentName` + +WithAgentName sets the agent name for the RTC session. + +## Signature + +```go +func WithAgentName(name string) RTCOption +``` + +## Parameters + + + +## Returns + +`RTCOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 770. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-allow-interruptions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-allow-interruptions.mdx new file mode 100644 index 0000000000..3c8f745a79 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-allow-interruptions.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-allow-interruptions" +title: "WithAllowInterruptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithAllowInterruptions" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithAllowInterruptions` + +WithAllowInterruptions maps to barge configuration on SignalWire. + +## Signature + +```go +func WithAllowInterruptions(allow bool) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 418. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-description.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-description.mdx new file mode 100644 index 0000000000..dac9ff3c98 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-description.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-description" +title: "WithDescription" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithDescription" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithDescription` + +WithDescription sets the tool description. + +## Signature + +```go +func WithDescription(desc string) ToolOption +``` + +## Parameters + + + +## Returns + +`ToolOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 177. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-inference-llm-model.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-inference-llm-model.mdx new file mode 100644 index 0000000000..78119fd0f8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-inference-llm-model.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-inference-llm-model" +title: "WithInferenceLLMModel" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithInferenceLLMModel" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `WithInferenceLLMModel` + +WithInferenceLLMModel returns a functional option that sets the model string. + +## Signature + +```go +func WithInferenceLLMModel(model string) func(*InferenceLLM) +``` + +## Parameters + + + +## Returns + +`func(*InferenceLLM)` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 143. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-inference-stt-model.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-inference-stt-model.mdx new file mode 100644 index 0000000000..2e3fd90459 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-inference-stt-model.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-inference-stt-model" +title: "WithInferenceSTTModel" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithInferenceSTTModel" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go" +--- +# `WithInferenceSTTModel` + +WithInferenceSTTModel returns a functional option that sets the model string. + +## Signature + +```go +func WithInferenceSTTModel(model string) func(*InferenceSTT) +``` + +## Parameters + + + +## Returns + +`func(*InferenceSTT)` + +## Source + +[`pkg/livewire/plugins.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/plugins.go) + +Line 56. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-llm.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-llm.mdx new file mode 100644 index 0000000000..de32fbb71c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-llm.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-llm" +title: "WithLLM" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithLLM" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithLLM` + +WithLLM sets the LLM model — this maps to SignalWire AI params. + +## Signature + +```go +func WithLLM(model string) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 395. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-max-endpointing-delay.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-max-endpointing-delay.mdx new file mode 100644 index 0000000000..a8223eb98c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-max-endpointing-delay.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-max-endpointing-delay" +title: "WithMaxEndpointingDelay" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithMaxEndpointingDelay" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithMaxEndpointingDelay` + +WithMaxEndpointingDelay maps to AI params on SignalWire. + +## Signature + +```go +func WithMaxEndpointingDelay(d float64) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 432. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-max-tool-steps.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-max-tool-steps.mdx new file mode 100644 index 0000000000..7a8628d2d8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-max-tool-steps.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-max-tool-steps" +title: "WithMaxToolSteps" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithMaxToolSteps" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithMaxToolSteps` + +WithMaxToolSteps sets the maximum tool call chain depth — noop on SignalWire. + +## Signature + +```go +func WithMaxToolSteps(n int) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 439. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-mcp-servers.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-mcp-servers.mdx new file mode 100644 index 0000000000..45fcafb8c9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-mcp-servers.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-mcp-servers" +title: "WithMCPServers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithMCPServers" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithMCPServers` + +WithMCPServers is a LiveKit-compatible noop — MCP servers are not yet supported in LiveWire. Tools should be registered via FunctionTool. Mirrors Python Agent(mcp\_servers=...) which emits a one-time noop warning. + +## Signature + +```go +func WithMCPServers(servers ...any) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 156. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-min-endpointing-delay.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-min-endpointing-delay.mdx new file mode 100644 index 0000000000..5e6d35a107 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-min-endpointing-delay.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-min-endpointing-delay" +title: "WithMinEndpointingDelay" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithMinEndpointingDelay" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithMinEndpointingDelay` + +WithMinEndpointingDelay maps to end\_of\_speech\_timeout on SignalWire. + +## Signature + +```go +func WithMinEndpointingDelay(d float64) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 425. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-min-interruption-duration.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-min-interruption-duration.mdx new file mode 100644 index 0000000000..331b8a549a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-min-interruption-duration.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-min-interruption-duration" +title: "WithMinInterruptionDuration" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithMinInterruptionDuration" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithMinInterruptionDuration` + +WithMinInterruptionDuration sets the minimum interruption duration — noop on SignalWire where barge-in timing is handled automatically. Mirrors Python AgentSession(min\_interruption\_duration=0.5) (line 419). + +## Signature + +```go +func WithMinInterruptionDuration(d float64) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 476. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-on-request.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-on-request.mdx new file mode 100644 index 0000000000..3362a1bd39 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-on-request.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-on-request" +title: "WithOnRequest" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithOnRequest" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithOnRequest` + +WithOnRequest accepts a request callback — noop on SignalWire. Mirrors Python AgentServer.rtc\_session(on\_request=...) which silently ignores the parameter for LiveKit portability. + +## Signature + +```go +func WithOnRequest(fn func()) RTCOption +``` + +## Parameters + + + +## Returns + +`RTCOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 785. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-on-session-end.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-on-session-end.mdx new file mode 100644 index 0000000000..57b6346545 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-on-session-end.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-on-session-end" +title: "WithOnSessionEnd" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithOnSessionEnd" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithOnSessionEnd` + +WithOnSessionEnd accepts a session-end callback — noop on SignalWire. Mirrors Python AgentServer.rtc\_session(on\_session\_end=...) which silently ignores the parameter for LiveKit portability. + +## Signature + +```go +func WithOnSessionEnd(fn func()) RTCOption +``` + +## Parameters + + + +## Returns + +`RTCOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 794. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-parameters.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-parameters.mdx new file mode 100644 index 0000000000..da1783756e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-parameters.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-parameters" +title: "WithParameters" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithParameters" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithParameters` + +WithParameters sets explicit JSON-Schema parameters for a tool. + +## Signature + +```go +func WithParameters(params map[string]any) ToolOption +``` + +## Parameters + + + +## Returns + +`ToolOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 182. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-preemptive-generation.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-preemptive-generation.mdx new file mode 100644 index 0000000000..60b13f45b2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-preemptive-generation.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-preemptive-generation" +title: "WithPreemptiveGeneration" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithPreemptiveGeneration" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithPreemptiveGeneration` + +WithPreemptiveGeneration enables or disables preemptive generation — noop on SignalWire. Mirrors Python AgentSession(preemptive\_generation=False) (line 423). + +## Signature + +```go +func WithPreemptiveGeneration(enabled bool) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 485. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-record.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-record.mdx new file mode 100644 index 0000000000..42b0f4b928 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-record.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-record" +title: "WithRecord" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithRecord" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithRecord` + +WithRecord enables call recording for the session. Mirrors Python AgentSession.start(record=False) keyword-only param (line 504). + +## Signature + +```go +func WithRecord(record bool) StartOption +``` + +## Parameters + + + +## Returns + +`StartOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 561. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-reply-instructions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-reply-instructions.mdx new file mode 100644 index 0000000000..855d77c478 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-reply-instructions.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-reply-instructions" +title: "WithReplyInstructions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithReplyInstructions" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithReplyInstructions` + +WithReplyInstructions sets the instructions for the generated reply. + +## Signature + +```go +func WithReplyInstructions(inst string) ReplyOption +``` + +## Parameters + + + +## Returns + +`ReplyOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 668. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-room.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-room.mdx new file mode 100644 index 0000000000..87ee3427b5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-room.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-room" +title: "WithRoom" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithRoom" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithRoom` + +WithRoom sets the room for the session start. Mirrors Python AgentSession.start(room=...) keyword-only param (line 504). + +## Signature + +```go +func WithRoom(room *Room) StartOption +``` + +## Parameters + + + +## Returns + +`StartOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 555. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-server-type.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-server-type.mdx new file mode 100644 index 0000000000..6f351a619c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-server-type.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-server-type" +title: "WithServerType" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithServerType" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithServerType` + +WithServerType sets the server type ("room" or "publisher") — noop on SignalWire. + +## Signature + +```go +func WithServerType(t string) RTCOption +``` + +## Parameters + + + +## Returns + +`RTCOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 775. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-mcp-servers.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-mcp-servers.mdx new file mode 100644 index 0000000000..7fc49a898e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-mcp-servers.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-mcp-servers" +title: "WithSessionMCPServers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithSessionMCPServers" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithSessionMCPServers` + +WithSessionMCPServers stores the MCP servers value on the session — noop on SignalWire. Mirrors Python AgentSession(mcp\_servers=...) which emits a one-time noop warning (lines 450–456). + +## Signature + +```go +func WithSessionMCPServers(servers any) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 459. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-tools.mdx new file mode 100644 index 0000000000..61435354e2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-tools" +title: "WithSessionTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithSessionTools" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithSessionTools` + +WithSessionTools appends session-level tools to the AgentSession. These are merged with the bound Agent's tools in Start(). Mirrors Python AgentSession(tools=...) which stores list(tools or \[]) on self.\_tools (line 459) and merges them in \_build\_sw\_agent() (line 591). + +## Signature + +```go +func WithSessionTools(tools ...any) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 450. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-userdata.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-userdata.mdx new file mode 100644 index 0000000000..06b56bd1ce --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-userdata.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-session-userdata" +title: "WithSessionUserdata" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithSessionUserdata" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithSessionUserdata` + +WithSessionUserdata attaches arbitrary user data to the session. Mirrors Python AgentSession(userdata=...) which stores the value as self.\_userdata (line 460). + +## Signature + +```go +func WithSessionUserdata(data any) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 469. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-stt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-stt.mdx new file mode 100644 index 0000000000..708761fde4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-stt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-stt" +title: "WithSTT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithSTT" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithSTT` + +WithSTT sets the STT provider — noop on SignalWire (handled by the control plane). + +## Signature + +```go +func WithSTT(provider string) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 379. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-tools.mdx new file mode 100644 index 0000000000..4d837864ef --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-tools" +title: "WithTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithTools" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithTools` + +WithTools is a LiveKit-compatible noop — use FunctionTool to register tools. + +## Signature + +```go +func WithTools(tools ...any) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 142. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-tts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-tts.mdx new file mode 100644 index 0000000000..0c009178c9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-tts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-tts" +title: "WithTTS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithTTS" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithTTS` + +WithTTS sets the TTS provider — noop on SignalWire (voice can be configured via languages). + +## Signature + +```go +func WithTTS(provider string) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 387. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-turn-detection.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-turn-detection.mdx new file mode 100644 index 0000000000..dd8dc96130 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-turn-detection.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-turn-detection" +title: "WithTurnDetection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithTurnDetection" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithTurnDetection` + +WithTurnDetection sets the turn detection mode — noop on SignalWire. + +## Signature + +```go +func WithTurnDetection(mode string) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 410. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-userdata.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-userdata.mdx new file mode 100644 index 0000000000..6964599a0f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-userdata.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-userdata" +title: "WithUserdata" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithUserdata" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithUserdata` + +WithUserdata attaches arbitrary user data to the agent. + +## Signature + +```go +func WithUserdata(data any) AgentOption +``` + +## Parameters + + + +## Returns + +`AgentOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 149. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-vad.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-vad.mdx new file mode 100644 index 0000000000..a9e4f464e8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-vad.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire/with-vad" +title: "WithVAD" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/livewire.WithVAD" + parent: "github.com/signalwire/signalwire-go/pkg/livewire" + module: "github.com.signalwire.signalwire-go.pkg.livewire" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go" +--- +# `WithVAD` + +WithVAD sets the VAD provider — noop on SignalWire (handled by the control plane). + +## Signature + +```go +func WithVAD(vad any) SessionOption +``` + +## Parameters + + + +## Returns + +`SessionOption` + +## Source + +[`pkg/livewire/livewire.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/livewire/livewire.go) + +Line 402. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/get-global-level.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/get-global-level.mdx new file mode 100644 index 0000000000..d859bcb2ed --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/get-global-level.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/get-global-level" +title: "GetGlobalLevel" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.GetGlobalLevel" + parent: "github.com/signalwire/signalwire-go/pkg/logging" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `GetGlobalLevel` + +GetGlobalLevel returns the current global log level. + +## Signature + +```go +func GetGlobalLevel() Level +``` + +## Returns + +`Level` + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 96. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/index.mdx new file mode 100644 index 0000000000..661dd107c4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/index.mdx @@ -0,0 +1,92 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging" +title: "logging" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `logging` + +Package logging provides structured logging for the SignalWire AI Agents SDK. + +It supports log levels (debug, info, warn, error), named loggers per component, and can be suppressed globally for CLI tools or testing. + +## Signature + +```go +package logging +``` + +## Constants + + + + + + + + + + + +## Functions + + + + GetGlobalLevel returns the current global log level. + + + + IsSuppressed returns whether logging is currently suppressed. + + + + New creates a new Logger with the given component name. + + + + ParseLevel converts a string level name to a Level. Returns LevelInfo if the string is not recognized. + + + + ResetLoggingConfiguration re-reads SIGNALWIRE\_LOG\_LEVEL and SIGNALWIRE\_LOG\_MODE from the environment and resets globalLevel and suppressed to the env-derived defaults. It is the Go equivalent of Python's reset\_logging\_configuration() and is intended for test teardown and env-var-driven reconfiguration at runtime. + + + + SetGlobalLevel sets the minimum log level for all loggers. + + + + Suppress disables all log output. + + + + Unsuppress re-enables log output. + + + +## Type Aliases + + + + Level represents a log severity level. + + + +## Classes + + + + Logger is a named logger that respects global log level settings. + + + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/is-suppressed.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/is-suppressed.mdx new file mode 100644 index 0000000000..0a8ea8f7f4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/is-suppressed.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/is-suppressed" +title: "IsSuppressed" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.IsSuppressed" + parent: "github.com/signalwire/signalwire-go/pkg/logging" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `IsSuppressed` + +IsSuppressed returns whether logging is currently suppressed. + +## Signature + +```go +func IsSuppressed() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 117. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/level.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/level.mdx new file mode 100644 index 0000000000..a908971964 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/level.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/level" +title: "Level" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.Level" + parent: "github.com/signalwire/signalwire-go/pkg/logging" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `Level` + +Level represents a log severity level. + +## Signature + +```go +type Level alias +``` + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/debug.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/debug.mdx new file mode 100644 index 0000000000..0cb6adc62c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/debug.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/debug" +title: "Debug" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.Logger.Debug" + parent: "github.com/signalwire/signalwire-go/pkg/logging.Logger" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `Debug` + +Debug logs a message at debug level. + +## Signature + +```go +func (*Logger) Debug(format string, args ...any) +``` + +## Parameters + + + + + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 153. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/error.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/error.mdx new file mode 100644 index 0000000000..70316f484b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/error.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/error" +title: "Error" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.Logger.Error" + parent: "github.com/signalwire/signalwire-go/pkg/logging.Logger" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `Error` + +Error logs a message at error level. + +## Signature + +```go +func (*Logger) Error(format string, args ...any) +``` + +## Parameters + + + + + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 168. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/index.mdx new file mode 100644 index 0000000000..40d665ead7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger" +title: "Logger" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.Logger" + parent: "github.com/signalwire/signalwire-go/pkg/logging" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `Logger` + +Logger is a named logger that respects global log level settings. + +## Signature + +```go +type Logger struct +``` + +## Methods + + + + Debug logs a message at debug level. + + + + Error logs a message at error level. + + + + Info logs a message at info level. + + + + Warn logs a message at warn level. + + + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 124. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/info.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/info.mdx new file mode 100644 index 0000000000..aeff9a0eb1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/info.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/info" +title: "Info" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.Logger.Info" + parent: "github.com/signalwire/signalwire-go/pkg/logging.Logger" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `Info` + +Info logs a message at info level. + +## Signature + +```go +func (*Logger) Info(format string, args ...any) +``` + +## Parameters + + + + + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 158. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/warn.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/warn.mdx new file mode 100644 index 0000000000..b4475f7972 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/warn.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/logger/warn" +title: "Warn" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.Logger.Warn" + parent: "github.com/signalwire/signalwire-go/pkg/logging.Logger" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `Warn` + +Warn logs a message at warn level. + +## Signature + +```go +func (*Logger) Warn(format string, args ...any) +``` + +## Parameters + + + + + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 163. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/new.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/new.mdx new file mode 100644 index 0000000000..06877a4491 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/new.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/new" +title: "New" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.New" + parent: "github.com/signalwire/signalwire-go/pkg/logging" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `New` + +New creates a new Logger with the given component name. + +## Signature + +```go +func New(name string) *Logger +``` + +## Parameters + + + +## Returns + +`*Logger` + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 130. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/parse-level.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/parse-level.mdx new file mode 100644 index 0000000000..013b4182a8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/parse-level.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/parse-level" +title: "ParseLevel" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.ParseLevel" + parent: "github.com/signalwire/signalwire-go/pkg/logging" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `ParseLevel` + +ParseLevel converts a string level name to a Level. Returns LevelInfo if the string is not recognized. + +## Signature + +```go +func ParseLevel(s string) Level +``` + +## Parameters + + + +## Returns + +`Level` + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 36. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/reset-logging-configuration.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/reset-logging-configuration.mdx new file mode 100644 index 0000000000..163be05c16 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/reset-logging-configuration.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/reset-logging-configuration" +title: "ResetLoggingConfiguration" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.ResetLoggingConfiguration" + parent: "github.com/signalwire/signalwire-go/pkg/logging" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `ResetLoggingConfiguration` + +ResetLoggingConfiguration re-reads SIGNALWIRE\_LOG\_LEVEL and SIGNALWIRE\_LOG\_MODE from the environment and resets globalLevel and suppressed to the env-derived defaults. It is the Go equivalent of Python's reset\_logging\_configuration() and is intended for test teardown and env-var-driven reconfiguration at runtime. + +## Signature + +```go +func ResetLoggingConfiguration() +``` + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 82. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/set-global-level.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/set-global-level.mdx new file mode 100644 index 0000000000..d9c06d5d63 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/set-global-level.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/set-global-level" +title: "SetGlobalLevel" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.SetGlobalLevel" + parent: "github.com/signalwire/signalwire-go/pkg/logging" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `SetGlobalLevel` + +SetGlobalLevel sets the minimum log level for all loggers. + +## Signature + +```go +func SetGlobalLevel(level Level) +``` + +## Parameters + + + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 89. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/suppress.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/suppress.mdx new file mode 100644 index 0000000000..9adb1f641e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/suppress.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/suppress" +title: "Suppress" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.Suppress" + parent: "github.com/signalwire/signalwire-go/pkg/logging" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `Suppress` + +Suppress disables all log output. + +## Signature + +```go +func Suppress() +``` + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 103. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/unsuppress.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/unsuppress.mdx new file mode 100644 index 0000000000..3670190651 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/unsuppress.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging/unsuppress" +title: "Unsuppress" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/logging.Unsuppress" + parent: "github.com/signalwire/signalwire-go/pkg/logging" + module: "github.com.signalwire.signalwire-go.pkg.logging" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go" +--- +# `Unsuppress` + +Unsuppress re-enables log output. + +## Signature + +```go +func Unsuppress() +``` + +## Source + +[`pkg/logging/logger.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/logging/logger.go) + +Line 110. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-json.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-json.mdx new file mode 100644 index 0000000000..e51b0bd3e6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-json.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-json" +title: "FromJSON" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.FromJSON" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `FromJSON` + +FromJSON parses a JSON string (an array of section maps) and returns a populated \*PromptObjectModel. Subsections are validated to require a title; any section without body/bullets/subsections is rejected. + +Python equivalent: PromptObjectModel.from\_json + +## Signature + +```go +func FromJSON(jsonStr string) (*PromptObjectModel, error) +``` + +## Parameters + + + +## Returns + +`(*PromptObjectModel, error)` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 577. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-list.mdx new file mode 100644 index 0000000000..77c972afcb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-list.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-list" +title: "FromList" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.FromList" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `FromList` + +FromList builds a POM from a pre-parsed \[]map\[string]any (callers can use this when they already have the dict form, e.g. from a database row or another config source). + +Python equivalent: PromptObjectModel.\_from\_dict (the internal helper shared by from\_json / from\_yaml). + +## Signature + +```go +func FromList(data []map[string]any) (*PromptObjectModel, error) +``` + +## Parameters + + + +## Returns + +`(*PromptObjectModel, error)` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 603. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-yaml.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-yaml.mdx new file mode 100644 index 0000000000..e890632409 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-yaml.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/from-yaml" +title: "FromYAML" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.FromYAML" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `FromYAML` + +FromYAML parses a YAML string (an array of section maps) and returns a populated \*PromptObjectModel. + +Python equivalent: PromptObjectModel.from\_yaml + +## Signature + +```go +func FromYAML(yamlStr string) (*PromptObjectModel, error) +``` + +## Parameters + + + +## Returns + +`(*PromptObjectModel, error)` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 589. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/index.mdx new file mode 100644 index 0000000000..82242a5ddb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/index.mdx @@ -0,0 +1,93 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom" +title: "pom" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `pom` + +Package pom provides a typed Prompt Object Model — a structured tree of sections that can be rendered to Markdown, XML, JSON, or YAML. The rendered output matches the Python reference at signalwire/signalwire/pom/pom.py byte-for-byte for the canonical scenarios covered by the cross-port parity tests in tests/unit/pom/test\_pom\_render\_parity.py. + +Two types make up the API: + +- Section: one node in the tree (title, body, bullets, subsections, numbered, numberedBullets). +- PromptObjectModel: the root container that holds the top-level sections and provides JSON / YAML round-trip helpers plus the Markdown / XML renderers. + +Both types are exported so callers can build a POM imperatively (NewPromptObjectModel + AddSection + AddSubsection) or by parsing a JSON/YAML document (FromJSON / FromYAML). The rendered output is the canonical wire format; user-facing helpers like AgentBase.Pom() return a \*PromptObjectModel value to keep mutations off the agent's internal state. + +## Signature + +```go +package pom +``` + +## Functions + + + + FromJSON parses a JSON string (an array of section maps) and returns a populated \*PromptObjectModel. Subsections are validated to require a title; any section without body/bullets/subsections is rejected. + + + + FromList builds a POM from a pre-parsed \[]map\[string]any (callers can use this when they already have the dict form, e.g. from a database row or another config source). + + + + FromYAML parses a YAML string (an array of section maps) and returns a populated \*PromptObjectModel. + + + + NewPromptObjectModel returns an empty POM ready for AddSection calls. + + + + NewSection returns a new Section with the supplied title (which may be empty to indicate untitled). Body, bullets, and subsections start empty; populate them via AddBody / AddBullets / AddSubsection. + + + + WithBody sets the section body. + + + + WithBullets sets the section bullets (replaces, not appends). + + + + WithNumbered marks the section as numbered (or explicitly un-numbered). + + + + WithNumberedBullets switches bullet rendering to numbered form. + + + +## Type Aliases + + + + SectionOption configures a Section at construction (used by AddSubsection and PromptObjectModel.AddSection). + + + +## Classes + + + + PromptObjectModel is the root container — a list of top-level Sections plus serialization / rendering helpers. Use NewPromptObjectModel() to construct one, or FromJSON / FromYAML to parse one. + + + + Section is one node in the POM tree. + + + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/new-prompt-object-model.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/new-prompt-object-model.mdx new file mode 100644 index 0000000000..2ba39f295a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/new-prompt-object-model.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/new-prompt-object-model" +title: "NewPromptObjectModel" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.NewPromptObjectModel" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `NewPromptObjectModel` + +NewPromptObjectModel returns an empty POM ready for AddSection calls. + +Python equivalent: PromptObjectModel.**init** + +## Signature + +```go +func NewPromptObjectModel() *PromptObjectModel +``` + +## Returns + +`*PromptObjectModel` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 341. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/new-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/new-section.mdx new file mode 100644 index 0000000000..5c9d9772e6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/new-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/new-section" +title: "NewSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.NewSection" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `NewSection` + +NewSection returns a new Section with the supplied title (which may be empty to indicate untitled). Body, bullets, and subsections start empty; populate them via AddBody / AddBullets / AddSubsection. + +Python equivalent: Section.**init** + +## Signature + +```go +func NewSection(title string) *Section +``` + +## Parameters + + + +## Returns + +`*Section` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 69. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/add-pom-as-subsection.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/add-pom-as-subsection.mdx new file mode 100644 index 0000000000..c5db2be9c0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/add-pom-as-subsection.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/add-pom-as-subsection" +title: "AddPomAsSubsection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel.AddPomAsSubsection" + parent: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `AddPomAsSubsection` + +AddPomAsSubsection attaches every top-level section of pomToAdd underneath the section identified by target — either the title of an existing section in this POM, or a \*Section pointer. + +Python equivalent: PromptObjectModel.add\_pom\_as\_subsection + +## Signature + +```go +func (*PromptObjectModel) AddPomAsSubsection(target any, pomToAdd *PromptObjectModel) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 828. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/add-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/add-section.mdx new file mode 100644 index 0000000000..43d0f4b144 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/add-section.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/add-section" +title: "AddSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel.AddSection" + parent: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `AddSection` + +AddSection appends a top-level section. title may be empty only for the first section (Python contract: "Only the first section can have no title"). The returned \*Section can be configured further (for example, by calling AddSubsection on it). + +Python equivalent: PromptObjectModel.add\_section + +## Signature + +```go +func (*PromptObjectModel) AddSection(title string, opts ...SectionOption) (*Section, error) +``` + +## Parameters + + + + + +## Returns + +`(*Section, error)` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 351. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/clone.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/clone.mdx new file mode 100644 index 0000000000..38af385dac --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/clone.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/clone" +title: "Clone" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel.Clone" + parent: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `Clone` + +Clone returns a deep copy of the POM. Useful when an agent wants to hand callers a snapshot without exposing internal mutable state. + +## Signature + +```go +func (*PromptObjectModel) Clone() *PromptObjectModel +``` + +## Returns + +`*PromptObjectModel` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 849. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/find-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/find-section.mdx new file mode 100644 index 0000000000..2cdb8d7ef9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/find-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/find-section" +title: "FindSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel.FindSection" + parent: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `FindSection` + +FindSection performs a recursive depth-first search for a section whose Title matches. Returns nil if no match is found. + +Python equivalent: PromptObjectModel.find\_section + +## Signature + +```go +func (*PromptObjectModel) FindSection(title string) *Section +``` + +## Parameters + + + +## Returns + +`*Section` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 372. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/index.mdx new file mode 100644 index 0000000000..4d8bcfc369 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model" +title: "PromptObjectModel" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `PromptObjectModel` + +PromptObjectModel is the root container — a list of top-level Sections plus serialization / rendering helpers. Use NewPromptObjectModel() to construct one, or FromJSON / FromYAML to parse one. + +Python equivalent: signalwire.pom.pom.PromptObjectModel + +## Signature + +```go +type PromptObjectModel struct +``` + +## Properties + + + Debug, when true, prints rendering decisions to stderr (matches the Python flag). Off by default. + + + + Sections is the ordered list of top-level sections. Only the first section may have a nil Title. + + +## Methods + + + + AddPomAsSubsection attaches every top-level section of pomToAdd underneath the section identified by target — either the title of an existing section in this POM, or a \*Section pointer. + + + + AddSection appends a top-level section. title may be empty only for the first section (Python contract: "Only the first section can have no title"). The returned \*Section can be configured further (for example, by calling AddSubsection on it). + + + + Clone returns a deep copy of the POM. Useful when an agent wants to hand callers a snapshot without exposing internal mutable state. + + + + FindSection performs a recursive depth-first search for a section whose Title matches. Returns nil if no match is found. + + + + RenderMarkdown renders the entire POM as a Markdown document. + + + + RenderXML renders the entire POM as an XML document with the canonical “<?xml ...?>\ ... </prompt>“ envelope. + + + + ToJSON serializes the POM to a JSON string. Matches Python's json.dumps(..., indent=2) byte-for-byte for the canonical fixtures. + + + + ToList returns the POM as \[]map\[string]any (one entry per top-level section), matching Python's to\_dict. + + + + ToYAML serializes the POM to a YAML string in the same shape as Python's yaml.dump(..., default\_flow\_style=False, sort\_keys=False). PyYAML uses block-sequence-with-indent-0 by default (the leading "-" of each list item aligns with the parent's mapping key, not after it); gopkg.in/yaml.v3 cannot be configured to do the same, so this renderer writes the YAML structure manually for byte-for-byte parity. + + + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 329. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/render-markdown.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/render-markdown.mdx new file mode 100644 index 0000000000..60eabe33f1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/render-markdown.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/render-markdown" +title: "RenderMarkdown" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel.RenderMarkdown" + parent: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `RenderMarkdown` + +RenderMarkdown renders the entire POM as a Markdown document. + +Python equivalent: PromptObjectModel.render\_markdown + +## Signature + +```go +func (*PromptObjectModel) RenderMarkdown() string +``` + +## Returns + +`string` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 770. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/render-xml.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/render-xml.mdx new file mode 100644 index 0000000000..ce0bcb40bd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/render-xml.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/render-xml" +title: "RenderXML" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel.RenderXML" + parent: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `RenderXML` + +RenderXML renders the entire POM as an XML document with the canonical “<?xml ...?>\ ... </prompt>“ envelope. + +Python equivalent: PromptObjectModel.render\_xml + +## Signature + +```go +func (*PromptObjectModel) RenderXML() string +``` + +## Returns + +`string` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 797. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-json.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-json.mdx new file mode 100644 index 0000000000..a2c2da11b1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-json.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-json" +title: "ToJSON" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel.ToJSON" + parent: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `ToJSON` + +ToJSON serializes the POM to a JSON string. Matches Python's json.dumps(..., indent=2) byte-for-byte for the canonical fixtures. + +Python equivalent: PromptObjectModel.to\_json + +## Signature + +```go +func (*PromptObjectModel) ToJSON() (string, error) +``` + +## Returns + +`(string, error)` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 404. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-list.mdx new file mode 100644 index 0000000000..0d6c794a93 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-list.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-list" +title: "ToList" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel.ToList" + parent: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `ToList` + +ToList returns the POM as \[]map\[string]any (one entry per top-level section), matching Python's to\_dict. + +Python equivalent: PromptObjectModel.to\_dict + +## Signature + +```go +func (*PromptObjectModel) ToList() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 392. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-yaml.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-yaml.mdx new file mode 100644 index 0000000000..492d65de6d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-yaml.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/prompt-object-model/to-yaml" +title: "ToYAML" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel.ToYAML" + parent: "github.com/signalwire/signalwire-go/pkg/pom.PromptObjectModel" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `ToYAML` + +ToYAML serializes the POM to a YAML string in the same shape as Python's yaml.dump(..., default\_flow\_style=False, sort\_keys=False). PyYAML uses block-sequence-with-indent-0 by default (the leading "-" of each list item aligns with the parent's mapping key, not after it); gopkg.in/yaml.v3 cannot be configured to do the same, so this renderer writes the YAML structure manually for byte-for-byte parity. + +Python equivalent: PromptObjectModel.to\_yaml + +## Signature + +```go +func (*PromptObjectModel) ToYAML() string +``` + +## Returns + +`string` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 500. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section-option.mdx new file mode 100644 index 0000000000..d959348ba6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section-option" +title: "SectionOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.SectionOption" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `SectionOption` + +SectionOption configures a Section at construction (used by AddSubsection and PromptObjectModel.AddSection). + +## Signature + +```go +type SectionOption alias +``` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 109. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-body.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-body.mdx new file mode 100644 index 0000000000..18c2b888dd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-body.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-body" +title: "AddBody" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.Section.AddBody" + parent: "github.com/signalwire/signalwire-go/pkg/pom.Section" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `AddBody` + +AddBody sets (or replaces) the section body text. + +Python equivalent: Section.add\_body — the docstring says "Add OR REPLACE the body text"; this is a setter, not an appender. + +## Signature + +```go +func (*Section) AddBody(body string) +``` + +## Parameters + + + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 78. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-bullets.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-bullets.mdx new file mode 100644 index 0000000000..f06a4555f4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-bullets.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-bullets" +title: "AddBullets" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.Section.AddBullets" + parent: "github.com/signalwire/signalwire-go/pkg/pom.Section" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `AddBullets` + +AddBullets appends bullet points to the section. + +Python equivalent: Section.add\_bullets — the Python contract is to extend (not replace) the existing bullet list. + +## Signature + +```go +func (*Section) AddBullets(bullets []string) +``` + +## Parameters + + + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 86. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-subsection.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-subsection.mdx new file mode 100644 index 0000000000..30386a6a3e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-subsection.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/add-subsection" +title: "AddSubsection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.Section.AddSubsection" + parent: "github.com/signalwire/signalwire-go/pkg/pom.Section" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `AddSubsection` + +AddSubsection creates and appends a subsection under this section. title must be non-empty (subsections always require a title). Returns the new \*Section so callers can keep building. + +Python equivalent: Section.add\_subsection + +## Signature + +```go +func (*Section) AddSubsection(title string, opts ...SectionOption) (*Section, error) +``` + +## Parameters + + + + + +## Returns + +`(*Section, error)` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 95. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/index.mdx new file mode 100644 index 0000000000..d25010733c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/index.mdx @@ -0,0 +1,110 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section" +title: "Section" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.Section" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `Section` + +Section is one node in the POM tree. + +Python equivalent: signalwire.pom.pom.Section. The exported field names match the JSON / YAML schema: + +``` +{"title": "...", "body": "...", "bullets": [...], + "subsections": [...], "numbered": true, "numberedBullets": true} +``` + +Title is a \*string (not string) to faithfully model Python's "title may be None" semantics for the optional first top-level section. All other fields use zero values to mean "absent". + +## Signature + +```go +type Section struct +``` + +## Examples + + + + ```go + {"title": "...", "body": "...", "bullets": [...], + "subsections": [...], "numbered": true, "numberedBullets": true} + ``` + + + + ```go + {"title": "...", "body": "...", "bullets": [...], + "subsections": [...], "numbered": true, "numberedBullets": true} + ``` + + + +## Properties + + + Body is a paragraph of free text (rendered before any bullets). + + + + Bullets is the list of bullet points. Empty means no bullet list. + + + + Numbered, when non-nil, opts the section into (or out of) numeric section numbering. nil means "default" (inherit sibling behavior). + + + + NumberedBullets renders bullets as "1." "2." instead of "-". + + + + Subsections is the list of nested child sections. + + + + Title is the section heading. nil means untitled (only legal for the first top-level section in a PromptObjectModel). + + +## Methods + + + + AddBody sets (or replaces) the section body text. + + + + AddBullets appends bullet points to the section. + + + + AddSubsection creates and appends a subsection under this section. title must be non-empty (subsections always require a title). Returns the new \*Section so callers can keep building. + + + + RenderMarkdown returns this section (and its subsections) as a Markdown string. level controls the starting heading level (default 2 == "##"); sectionNumber is the optional dotted prefix the section inherits when its parent is numbered. + + + + RenderXML returns this section (and its subsections) as a chunk of XML. indent is the starting indent level (each level == 2 spaces). + + + + ToMap returns the section as a map\[string]any with keys in canonical order (title, body, bullets, subsections, numbered, numberedBullets). Empty-or-zero fields are omitted to match Python's to\_dict behavior. + + + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 47. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/render-markdown.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/render-markdown.mdx new file mode 100644 index 0000000000..d5137087c5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/render-markdown.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/render-markdown" +title: "RenderMarkdown" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.Section.RenderMarkdown" + parent: "github.com/signalwire/signalwire-go/pkg/pom.Section" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `RenderMarkdown` + +RenderMarkdown returns this section (and its subsections) as a Markdown string. level controls the starting heading level (default 2 == "##"); sectionNumber is the optional dotted prefix the section inherits when its parent is numbered. + +Python equivalent: Section.render\_markdown + +## Signature + +```go +func (*Section) RenderMarkdown(level int, sectionNumber []int) string +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 196. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/render-xml.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/render-xml.mdx new file mode 100644 index 0000000000..d141451cc5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/render-xml.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/render-xml" +title: "RenderXML" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.Section.RenderXML" + parent: "github.com/signalwire/signalwire-go/pkg/pom.Section" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `RenderXML` + +RenderXML returns this section (and its subsections) as a chunk of XML. indent is the starting indent level (each level == 2 spaces). + +Python equivalent: Section.render\_xml + +## Signature + +```go +func (*Section) RenderXML(indent int, sectionNumber []int) string +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 261. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/to-map.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/to-map.mdx new file mode 100644 index 0000000000..dcab58fdf4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/to-map.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/section/to-map" +title: "ToMap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.Section.ToMap" + parent: "github.com/signalwire/signalwire-go/pkg/pom.Section" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `ToMap` + +ToMap returns the section as a map\[string]any with keys in canonical order (title, body, bullets, subsections, numbered, numberedBullets). Empty-or-zero fields are omitted to match Python's to\_dict behavior. + +The returned value is intended for JSON / YAML serialization; callers that need a plain Go map (and don't care about key order) can type-assert each value. + +Python equivalent: Section.to\_dict + +## Signature + +```go +func (*Section) ToMap() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 136. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-body.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-body.mdx new file mode 100644 index 0000000000..19b7856254 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-body.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-body" +title: "WithBody" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.WithBody" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `WithBody` + +WithBody sets the section body. + +## Signature + +```go +func WithBody(body string) SectionOption +``` + +## Parameters + + + +## Returns + +`SectionOption` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 112. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-bullets.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-bullets.mdx new file mode 100644 index 0000000000..6ff485fd4a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-bullets.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-bullets" +title: "WithBullets" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.WithBullets" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `WithBullets` + +WithBullets sets the section bullets (replaces, not appends). + +## Signature + +```go +func WithBullets(bullets []string) SectionOption +``` + +## Parameters + + + +## Returns + +`SectionOption` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 115. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-numbered-bullets.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-numbered-bullets.mdx new file mode 100644 index 0000000000..fe1404fa63 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-numbered-bullets.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-numbered-bullets" +title: "WithNumberedBullets" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.WithNumberedBullets" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `WithNumberedBullets` + +WithNumberedBullets switches bullet rendering to numbered form. + +## Signature + +```go +func WithNumberedBullets(v bool) SectionOption +``` + +## Parameters + + + +## Returns + +`SectionOption` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 123. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-numbered.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-numbered.mdx new file mode 100644 index 0000000000..5029862ef4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-numbered.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom/with-numbered" +title: "WithNumbered" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/pom.WithNumbered" + parent: "github.com/signalwire/signalwire-go/pkg/pom" + module: "github.com.signalwire.signalwire-go.pkg.pom" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go" +--- +# `WithNumbered` + +WithNumbered marks the section as numbered (or explicitly un-numbered). + +## Signature + +```go +func WithNumbered(v bool) SectionOption +``` + +## Parameters + + + +## Returns + +`SectionOption` + +## Source + +[`pkg/pom/pom.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/pom/pom.go) + +Line 120. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/amenity/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/amenity/index.mdx new file mode 100644 index 0000000000..5f47f1b4db --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/amenity/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/amenity" +title: "Amenity" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.Amenity" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/concierge.go" +--- +# `Amenity` + +Amenity describes a venue amenity with its hours, location, and extra details. + +## Signature + +```go +type Amenity struct +``` + +## Properties + + + + + + + +## Source + +[`pkg/prefabs/concierge.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/concierge.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/index.mdx new file mode 100644 index 0000000000..a9913857b4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent" +title: "BedrockAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go" +--- +# `BedrockAgent` + +BedrockAgent wraps AgentBase and configures it to emit the "amazon\_bedrock" SWML verb instead of the standard "ai" verb. + +The voice\_id, temperature, and top\_p values are injected into the rendered prompt config (matching Python's \_add\_voice\_to\_prompt). Keys that are text-model-specific (barge\_confidence, presence\_penalty, frequency\_penalty) are removed from the prompt config because they do not apply to Bedrock's voice-to-voice model. + +## Signature + +```go +type BedrockAgent struct +``` + +## Properties + + + +## Methods + + + + SetInferenceParams updates one or more Bedrock inference parameters. Pass zero-value pointers to leave a parameter unchanged. + + + + SetLLMModel logs a warning and does nothing. Bedrock uses a fixed voice-to-voice model, so overriding the model name is not meaningful. + + + + SetLLMTemperature is a convenience wrapper that delegates to SetInferenceParams. + + + + SetPostPromptLLMParams logs a warning and ignores the parameters. Bedrock's post-prompt summarisation uses OpenAI configured at the platform level (in the C code), so SDK-level overrides have no effect. The keys of params are listed in the warning so the caller can see what was ignored. + + + + SetPromptLLMParams logs a warning directing the caller to SetInferenceParams instead. The keys of params are listed in the warning so the caller can see what was ignored. + + + + SetVoice sets the Bedrock voice ID. + + + +## Source + +[`pkg/prefabs/bedrock.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go) + +Line 58. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-inference-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-inference-params.mdx new file mode 100644 index 0000000000..0c455dfe90 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-inference-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-inference-params" +title: "SetInferenceParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent.SetInferenceParams" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go" +--- +# `SetInferenceParams` + +SetInferenceParams updates one or more Bedrock inference parameters. Pass zero-value pointers to leave a parameter unchanged. + +Python equivalent: BedrockAgent.set\_inference\_params + +## Signature + +```go +func (*BedrockAgent) SetInferenceParams(temperature float64, topP float64, maxTokens int) +``` + +## Parameters + + + + + + + +## Source + +[`pkg/prefabs/bedrock.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go) + +Line 183. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-llm-model.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-llm-model.mdx new file mode 100644 index 0000000000..51f87a80d6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-llm-model.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-llm-model" +title: "SetLLMModel" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent.SetLLMModel" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go" +--- +# `SetLLMModel` + +SetLLMModel logs a warning and does nothing. Bedrock uses a fixed voice-to-voice model, so overriding the model name is not meaningful. + +Python equivalent: BedrockAgent.set\_llm\_model + +## Signature + +```go +func (*BedrockAgent) SetLLMModel(model string) +``` + +## Parameters + + + +## Source + +[`pkg/prefabs/bedrock.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go) + +Line 201. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-llm-temperature.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-llm-temperature.mdx new file mode 100644 index 0000000000..93c1a2ed3c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-llm-temperature.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-llm-temperature" +title: "SetLLMTemperature" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent.SetLLMTemperature" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go" +--- +# `SetLLMTemperature` + +SetLLMTemperature is a convenience wrapper that delegates to SetInferenceParams. + +Python equivalent: BedrockAgent.set\_llm\_temperature + +## Signature + +```go +func (*BedrockAgent) SetLLMTemperature(temperature float64) +``` + +## Parameters + + + +## Source + +[`pkg/prefabs/bedrock.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go) + +Line 209. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..f3eafdfc29 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-post-prompt-llm-params.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-post-prompt-llm-params" +title: "SetPostPromptLLMParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent.SetPostPromptLLMParams" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go" +--- +# `SetPostPromptLLMParams` + +SetPostPromptLLMParams logs a warning and ignores the parameters. Bedrock's post-prompt summarisation uses OpenAI configured at the platform level (in the C code), so SDK-level overrides have no effect. The keys of params are listed in the warning so the caller can see what was ignored. + +Python equivalent: BedrockAgent.set\_post\_prompt\_llm\_params + +## Signature + +```go +func (*BedrockAgent) SetPostPromptLLMParams(params map[string]any) +``` + +## Parameters + + + +## Source + +[`pkg/prefabs/bedrock.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go) + +Line 220. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-prompt-llm-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..d03906b373 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-prompt-llm-params.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-prompt-llm-params" +title: "SetPromptLLMParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent.SetPromptLLMParams" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go" +--- +# `SetPromptLLMParams` + +SetPromptLLMParams logs a warning directing the caller to SetInferenceParams instead. The keys of params are listed in the warning so the caller can see what was ignored. + +Python equivalent: BedrockAgent.set\_prompt\_llm\_params + +## Signature + +```go +func (*BedrockAgent) SetPromptLLMParams(params map[string]any) +``` + +## Parameters + + + +## Source + +[`pkg/prefabs/bedrock.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go) + +Line 237. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-voice.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-voice.mdx new file mode 100644 index 0000000000..d4cb6468e8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-voice.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-agent/set-voice" +title: "SetVoice" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent.SetVoice" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockAgent" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go" +--- +# `SetVoice` + +SetVoice sets the Bedrock voice ID. + +Python equivalent: BedrockAgent.set\_voice + +## Signature + +```go +func (*BedrockAgent) SetVoice(voiceID string) +``` + +## Parameters + + + +## Source + +[`pkg/prefabs/bedrock.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go) + +Line 174. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-options/index.mdx new file mode 100644 index 0000000000..7143e1cc76 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-options/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/bedrock-options" +title: "BedrockOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.BedrockOptions" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go" +--- +# `BedrockOptions` + +BedrockOptions configures a new BedrockAgent. + +BedrockAgent is the Go equivalent of the Python BedrockAgent class. It extends the standard agent infrastructure but renders the SWML document with the "amazon\_bedrock" verb instead of the default "ai" verb. All standard AgentBase capabilities (prompt, SWAIG tools, skills, post-prompt, dynamic config, etc.) work unchanged. + +## Signature + +```go +type BedrockOptions struct +``` + +## Properties + + + AgentOptions are functional options forwarded to NewAgentBase. Use them to set host, port, auth credentials, etc. + + + + MaxTokens is the maximum number of tokens to generate. Defaults to 1024. + + + + Name is the agent name. Defaults to "bedrock\_agent". + + + + Route is the HTTP route for the agent. Defaults to "/bedrock". + + + + SystemPrompt is an optional initial system prompt. It can be overridden later via SetPromptText. + + + + Temperature is the generation temperature (0–1). Defaults to 0.7. + + + + TopP is the nucleus-sampling parameter (0–1). Defaults to 0.9. + + + + VoiceID is the Bedrock voice identifier. Defaults to "matthew". + + +## Source + +[`pkg/prefabs/bedrock.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go) + +Line 21. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/concierge-agent/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/concierge-agent/index.mdx new file mode 100644 index 0000000000..c3b53df376 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/concierge-agent/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/concierge-agent" +title: "ConciergeAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.ConciergeAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/concierge.go" +--- +# `ConciergeAgent` + +ConciergeAgent acts as a virtual concierge for a venue, answering questions about amenities, services, hours, and directions. + +## Signature + +```go +type ConciergeAgent struct +``` + +## Properties + + + +## Source + +[`pkg/prefabs/concierge.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/concierge.go) + +Line 36. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/concierge-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/concierge-options/index.mdx new file mode 100644 index 0000000000..89c562d5d1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/concierge-options/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/concierge-options" +title: "ConciergeOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.ConciergeOptions" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/concierge.go" +--- +# `ConciergeOptions` + +ConciergeOptions configures a new ConciergeAgent. + +## Signature + +```go +type ConciergeOptions struct +``` + +## Properties + + + + + general hours of operation + + + + + + + + + + optional additional instructions appended to the default list + + + + + + optional static greeting spoken at the start of the call + + +## Source + +[`pkg/prefabs/concierge.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/concierge.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/department/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/department/index.mdx new file mode 100644 index 0000000000..e4a2ada625 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/department/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/department" +title: "Department" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.Department" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/receptionist.go" +--- +# `Department` + +Department describes a destination the receptionist can transfer to. + +## Signature + +```go +type Department struct +``` + +## Properties + + + what the department handles + + + + e.g. "sales" + + + + phone number or SWML transfer destination + + + + true if Number is a SWML destination (uses SwmlTransfer) + + +## Source + +[`pkg/prefabs/receptionist.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/receptionist.go) + +Line 15. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq-bot-agent/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq-bot-agent/index.mdx new file mode 100644 index 0000000000..42fa220578 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq-bot-agent/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq-bot-agent" +title: "FAQBotAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.FAQBotAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/faq_bot.go" +--- +# `FAQBotAgent` + +FAQBotAgent answers frequently asked questions by matching user queries against a provided FAQ database. + +## Signature + +```go +type FAQBotAgent struct +``` + +## Properties + + + +## Source + +[`pkg/prefabs/faq_bot.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/faq_bot.go) + +Line 38. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq-bot-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq-bot-options/index.mdx new file mode 100644 index 0000000000..b0f2b648f4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq-bot-options/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq-bot-options" +title: "FAQBotOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.FAQBotOptions" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/faq_bot.go" +--- +# `FAQBotOptions` + +FAQBotOptions configures a new FAQBotAgent. + +## Signature + +```go +type FAQBotOptions struct +``` + +## Properties + + + AgentOptions holds additional functional options forwarded to NewAgentBase, matching the \*\*kwargs pass-through in the Python SDK. + + + + + + + + + + + + SuggestRelated controls whether the agent suggests related questions. Defaults to true when nil, matching the Python SDK default. + + +## Source + +[`pkg/prefabs/faq_bot.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/faq_bot.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq/index.mdx new file mode 100644 index 0000000000..df9351c5c4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/faq" +title: "FAQ" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.FAQ" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/faq_bot.go" +--- +# `FAQ` + +FAQ represents a single frequently asked question and its answer. + +## Signature + +```go +type FAQ struct +``` + +## Properties + + + + + + + +## Source + +[`pkg/prefabs/faq_bot.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/faq_bot.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/index.mdx new file mode 100644 index 0000000000..fef51c75dd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/index.mdx @@ -0,0 +1,158 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs" +title: "prefabs" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go" +--- +# `prefabs` + +Package prefabs provides pre-built agent patterns that extend AgentBase with common conversational workflows such as information gathering, surveys, reception/routing, FAQ answering, and virtual concierge services. + +## Signature + +```go +package prefabs +``` + +## Functions + + + + NewBedrockAgent creates a BedrockAgent with Bedrock-specific SWML rendering. + + + + NewConciergeAgent creates an agent that provides concierge services for a venue. + + + + NewFAQBotAgent creates an agent that answers frequently asked questions. + + + + NewInfoGathererAgent creates an agent that asks a series of questions and stores the answers in global data. Pass nil Questions to enable dynamic mode; call SetQuestionCallback on the returned agent to supply per-request questions. + + + + NewReceptionistAgent creates an agent that greets callers and transfers them to the appropriate department. + + + + NewSurveyAgent creates an agent that conducts a structured survey. + + + + NewSurveyQuestion constructs a SurveyQuestion with Required:true, matching Python SurveyAgent.\_validate\_questions which defaults required=True when unspecified. Callers opt out with WithOptional(). + + + + WithOptional marks a question as not required. Matches Python's required=False escape hatch on SurveyAgent questions. + + + + WithQuestionChoices sets the choice list for multiple\_choice questions. + + + + WithQuestionID sets the question ID. + + + + WithQuestionScale sets the scale for rating questions (answers run 1..n). + + + + WithQuestionType sets the question type ("rating", "multiple\_choice", "yes\_no", "open\_ended"). + + + +## Type Aliases + + + + SurveyQuestionOption configures a question during construction. + + + +## Classes + + + + Amenity describes a venue amenity with its hours, location, and extra details. + + + + BedrockAgent wraps AgentBase and configures it to emit the "amazon\_bedrock" SWML verb instead of the standard "ai" verb. + + + + BedrockOptions configures a new BedrockAgent. + + + + ConciergeAgent acts as a virtual concierge for a venue, answering questions about amenities, services, hours, and directions. + + + + ConciergeOptions configures a new ConciergeAgent. + + + + Department describes a destination the receptionist can transfer to. + + + + FAQ represents a single frequently asked question and its answer. + + + + FAQBotAgent answers frequently asked questions by matching user queries against a provided FAQ database. + + + + FAQBotOptions configures a new FAQBotAgent. + + + + InfoGathererAgent collects answers to a series of questions sequentially. Supports both static (questions provided at construction) and dynamic (questions determined per-request via SetQuestionCallback) modes. + + + + InfoGathererOptions configures a new InfoGathererAgent. Set Questions to nil to enable dynamic callback mode via SetQuestionCallback. + + + + Question describes a single question in an InfoGatherer sequence. + + + + ReceptionistAgent greets callers and routes them to the appropriate department. + + + + ReceptionistOptions configures a new ReceptionistAgent. + + + + SurveyAgent conducts structured surveys with typed questions. + + + + SurveyOptions configures a new SurveyAgent. + + + + SurveyQuestion describes a single question in a survey. + + + +## Source + +[`pkg/prefabs/bedrock.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-agent/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-agent/index.mdx new file mode 100644 index 0000000000..1f9a5dd377 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-agent/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-agent" +title: "InfoGathererAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.InfoGathererAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/info_gatherer.go" +--- +# `InfoGathererAgent` + +InfoGathererAgent collects answers to a series of questions sequentially. Supports both static (questions provided at construction) and dynamic (questions determined per-request via SetQuestionCallback) modes. + +## Signature + +```go +type InfoGathererAgent struct +``` + +## Properties + + + +## Methods + + + + SetQuestionCallback registers a per-request callback that returns the list of questions to ask. Calling this method enables dynamic mode: on each SWML request the callback is invoked with the request's query parameters, body parameters, and headers; the returned \[]Question becomes the session's question list. This mirrors Python's InfoGathererAgent.set\_question\_callback. + + + +## Source + +[`pkg/prefabs/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/info_gatherer.go) + +Line 36. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-agent/set-question-callback.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-agent/set-question-callback.mdx new file mode 100644 index 0000000000..34650bf2f4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-agent/set-question-callback.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-agent/set-question-callback" +title: "SetQuestionCallback" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.InfoGathererAgent.SetQuestionCallback" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs.InfoGathererAgent" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/info_gatherer.go" +--- +# `SetQuestionCallback` + +SetQuestionCallback registers a per-request callback that returns the list of questions to ask. Calling this method enables dynamic mode: on each SWML request the callback is invoked with the request's query parameters, body parameters, and headers; the returned \[]Question becomes the session's question list. This mirrors Python's InfoGathererAgent.set\_question\_callback. + +If Questions was set to nil in InfoGathererOptions (dynamic mode), a fallback question set is used when no callback is registered. + +Example: + +``` +ig.SetQuestionCallback(func(query, body map[string]any, headers map[string]string) []Question { + if body["department"] == "support" { + return []Question{{KeyName: "issue", QuestionText: "What is the issue?"}} + } + return []Question{{KeyName: "name", QuestionText: "What is your name?"}} +}) +``` + +## Signature + +```go +func (*InfoGathererAgent) SetQuestionCallback( + cb func(queryParams map[string]string, bodyParams map[string]any, headers map[string]string) []Question +) +``` + +## Parameters + + + +## Examples + + + + ```go + ig.SetQuestionCallback(func(query, body map[string]any, headers map[string]string) []Question { + if body["department"] == "support" { + return []Question{{KeyName: "issue", QuestionText: "What is the issue?"}} + } + return []Question{{KeyName: "name", QuestionText: "What is your name?"}} + }) + ``` + + + + ```go + ig.SetQuestionCallback(func(query, body map[string]any, headers map[string]string) []Question { + if body["department"] == "support" { + return []Question{{KeyName: "issue", QuestionText: "What is the issue?"}} + } + return []Question{{KeyName: "name", QuestionText: "What is your name?"}} + }) + ``` + + + +## Source + +[`pkg/prefabs/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/info_gatherer.go) + +Line 135. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-options/index.mdx new file mode 100644 index 0000000000..e6fc3999b2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-options/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/info-gatherer-options" +title: "InfoGathererOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.InfoGathererOptions" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/info_gatherer.go" +--- +# `InfoGathererOptions` + +InfoGathererOptions configures a new InfoGathererAgent. Set Questions to nil to enable dynamic callback mode via SetQuestionCallback. + +## Signature + +```go +type InfoGathererOptions struct +``` + +## Properties + + + + + nil enables dynamic callback mode; non-nil is static mode + + + + +## Source + +[`pkg/prefabs/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/info_gatherer.go) + +Line 27. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-bedrock-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-bedrock-agent.mdx new file mode 100644 index 0000000000..a29407fe4a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-bedrock-agent.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-bedrock-agent" +title: "NewBedrockAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.NewBedrockAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go" +--- +# `NewBedrockAgent` + +NewBedrockAgent creates a BedrockAgent with Bedrock-specific SWML rendering. + +Python equivalent: BedrockAgent.**init** + +## Signature + +```go +func NewBedrockAgent(opts BedrockOptions) *BedrockAgent +``` + +## Parameters + + + +## Returns + +`*BedrockAgent` + +## Source + +[`pkg/prefabs/bedrock.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/bedrock.go) + +Line 75. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-concierge-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-concierge-agent.mdx new file mode 100644 index 0000000000..2200f8dbfc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-concierge-agent.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-concierge-agent" +title: "NewConciergeAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.NewConciergeAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/concierge.go" +--- +# `NewConciergeAgent` + +NewConciergeAgent creates an agent that provides concierge services for a venue. + +## Signature + +```go +func NewConciergeAgent(opts ConciergeOptions) *ConciergeAgent +``` + +## Parameters + + + +## Returns + +`*ConciergeAgent` + +## Source + +[`pkg/prefabs/concierge.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/concierge.go) + +Line 49. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-faq-bot-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-faq-bot-agent.mdx new file mode 100644 index 0000000000..7043cf7f7d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-faq-bot-agent.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-faq-bot-agent" +title: "NewFAQBotAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.NewFAQBotAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/faq_bot.go" +--- +# `NewFAQBotAgent` + +NewFAQBotAgent creates an agent that answers frequently asked questions. + +## Signature + +```go +func NewFAQBotAgent(opts FAQBotOptions) *FAQBotAgent +``` + +## Parameters + + + +## Returns + +`*FAQBotAgent` + +## Source + +[`pkg/prefabs/faq_bot.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/faq_bot.go) + +Line 49. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-info-gatherer-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-info-gatherer-agent.mdx new file mode 100644 index 0000000000..156f173e3d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-info-gatherer-agent.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-info-gatherer-agent" +title: "NewInfoGathererAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.NewInfoGathererAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/info_gatherer.go" +--- +# `NewInfoGathererAgent` + +NewInfoGathererAgent creates an agent that asks a series of questions and stores the answers in global data. Pass nil Questions to enable dynamic mode; call SetQuestionCallback on the returned agent to supply per-request questions. + +## Signature + +```go +func NewInfoGathererAgent(opts InfoGathererOptions) *InfoGathererAgent +``` + +## Parameters + + + +## Returns + +`*InfoGathererAgent` + +## Source + +[`pkg/prefabs/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/info_gatherer.go) + +Line 49. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-receptionist-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-receptionist-agent.mdx new file mode 100644 index 0000000000..17d19e228d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-receptionist-agent.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-receptionist-agent" +title: "NewReceptionistAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.NewReceptionistAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/receptionist.go" +--- +# `NewReceptionistAgent` + +NewReceptionistAgent creates an agent that greets callers and transfers them to the appropriate department. + +## Signature + +```go +func NewReceptionistAgent(opts ReceptionistOptions) *ReceptionistAgent +``` + +## Parameters + + + +## Returns + +`*ReceptionistAgent` + +## Source + +[`pkg/prefabs/receptionist.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/receptionist.go) + +Line 43. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-survey-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-survey-agent.mdx new file mode 100644 index 0000000000..91869b29a9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-survey-agent.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-survey-agent" +title: "NewSurveyAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.NewSurveyAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go" +--- +# `NewSurveyAgent` + +NewSurveyAgent creates an agent that conducts a structured survey. + +## Signature + +```go +func NewSurveyAgent(opts SurveyOptions) *SurveyAgent +``` + +## Parameters + + + +## Returns + +`*SurveyAgent` + +## Source + +[`pkg/prefabs/survey.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go) + +Line 104. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-survey-question.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-survey-question.mdx new file mode 100644 index 0000000000..00958568b1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-survey-question.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/new-survey-question" +title: "NewSurveyQuestion" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.NewSurveyQuestion" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go" +--- +# `NewSurveyQuestion` + +NewSurveyQuestion constructs a SurveyQuestion with Required:true, matching Python SurveyAgent.\_validate\_questions which defaults required=True when unspecified. Callers opt out with WithOptional(). + +## Signature + +```go +func NewSurveyQuestion(text string, opts ...SurveyQuestionOption) SurveyQuestion +``` + +## Parameters + + + + + +## Returns + +`SurveyQuestion` + +## Source + +[`pkg/prefabs/survey.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go) + +Line 65. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/question/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/question/index.mdx new file mode 100644 index 0000000000..795dab5e05 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/question/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/question" +title: "Question" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.Question" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/info_gatherer.go" +--- +# `Question` + +Question describes a single question in an InfoGatherer sequence. + +## Signature + +```go +type Question struct +``` + +## Properties + + + if true the agent will confirm before accepting + + + + identifier used to store the answer + + + + the question to ask the user + + +## Source + +[`pkg/prefabs/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/info_gatherer.go) + +Line 19. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/receptionist-agent/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/receptionist-agent/index.mdx new file mode 100644 index 0000000000..c81ff12ade --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/receptionist-agent/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/receptionist-agent" +title: "ReceptionistAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.ReceptionistAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/receptionist.go" +--- +# `ReceptionistAgent` + +ReceptionistAgent greets callers and routes them to the appropriate department. + +## Signature + +```go +type ReceptionistAgent struct +``` + +## Properties + + + +## Source + +[`pkg/prefabs/receptionist.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/receptionist.go) + +Line 32. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/receptionist-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/receptionist-options/index.mdx new file mode 100644 index 0000000000..0bb3bfbde4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/receptionist-options/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/receptionist-options" +title: "ReceptionistOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.ReceptionistOptions" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/receptionist.go" +--- +# `ReceptionistOptions` + +ReceptionistOptions configures a new ReceptionistAgent. + +## Signature + +```go +type ReceptionistOptions struct +``` + +## Properties + + + + + + + + + + + Voice ID for TTS (default: "rime.spore") + + +## Source + +[`pkg/prefabs/receptionist.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/receptionist.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-agent/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-agent/index.mdx new file mode 100644 index 0000000000..3bc3655ec5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-agent/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-agent" +title: "SurveyAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.SurveyAgent" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go" +--- +# `SurveyAgent` + +SurveyAgent conducts structured surveys with typed questions. + +## Signature + +```go +type SurveyAgent struct +``` + +## Properties + + + +## Source + +[`pkg/prefabs/survey.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go) + +Line 89. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-options/index.mdx new file mode 100644 index 0000000000..9a65bdb979 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-options/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-options" +title: "SurveyOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.SurveyOptions" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go" +--- +# `SurveyOptions` + +SurveyOptions configures a new SurveyAgent. + +## Signature + +```go +type SurveyOptions struct +``` + +## Properties + + + + + + + + + + + + + + + + + +## Source + +[`pkg/prefabs/survey.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go) + +Line 77. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-question-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-question-option.mdx new file mode 100644 index 0000000000..c10d240852 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-question-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-question-option" +title: "SurveyQuestionOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.SurveyQuestionOption" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go" +--- +# `SurveyQuestionOption` + +SurveyQuestionOption configures a question during construction. + +## Signature + +```go +type SurveyQuestionOption alias +``` + +## Source + +[`pkg/prefabs/survey.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go) + +Line 33. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-question/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-question/index.mdx new file mode 100644 index 0000000000..d1ac512c20 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-question/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/survey-question" +title: "SurveyQuestion" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.SurveyQuestion" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go" +--- +# `SurveyQuestion` + +SurveyQuestion describes a single question in a survey. + +Prefer NewSurveyQuestion for construction — it defaults Required:true to match Python SurveyAgent behavior (signalwire/prefabs/survey.py \_validate\_questions sets required=True when unspecified). Struct literals are still supported, but the Go zero value for Required is false, which diverges from Python. + +## Signature + +```go +type SurveyQuestion struct +``` + +## Properties + + + options for multiple\_choice questions + + + + unique question identifier + + + + whether a non-empty answer is required — Python default true + + + + 1..Scale for rating questions (default 5) + + + + the question to ask + + + + "rating", "multiple\_choice", "yes\_no", "open\_ended" + + +## Source + +[`pkg/prefabs/survey.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-optional.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-optional.mdx new file mode 100644 index 0000000000..4e7605da31 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-optional.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-optional" +title: "WithOptional" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.WithOptional" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go" +--- +# `WithOptional` + +WithOptional marks a question as not required. Matches Python's required=False escape hatch on SurveyAgent questions. + +## Signature + +```go +func WithOptional() SurveyQuestionOption +``` + +## Returns + +`SurveyQuestionOption` + +## Source + +[`pkg/prefabs/survey.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go) + +Line 58. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-choices.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-choices.mdx new file mode 100644 index 0000000000..490eb650a1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-choices.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-choices" +title: "WithQuestionChoices" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.WithQuestionChoices" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go" +--- +# `WithQuestionChoices` + +WithQuestionChoices sets the choice list for multiple\_choice questions. + +## Signature + +```go +func WithQuestionChoices(choices ...string) SurveyQuestionOption +``` + +## Parameters + + + +## Returns + +`SurveyQuestionOption` + +## Source + +[`pkg/prefabs/survey.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go) + +Line 52. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-id.mdx new file mode 100644 index 0000000000..c419a36c77 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-id.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-id" +title: "WithQuestionID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.WithQuestionID" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go" +--- +# `WithQuestionID` + +WithQuestionID sets the question ID. + +## Signature + +```go +func WithQuestionID(id string) SurveyQuestionOption +``` + +## Parameters + + + +## Returns + +`SurveyQuestionOption` + +## Source + +[`pkg/prefabs/survey.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go) + +Line 36. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-scale.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-scale.mdx new file mode 100644 index 0000000000..f2374113a0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-scale.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-scale" +title: "WithQuestionScale" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.WithQuestionScale" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go" +--- +# `WithQuestionScale` + +WithQuestionScale sets the scale for rating questions (answers run 1..n). + +## Signature + +```go +func WithQuestionScale(n int) SurveyQuestionOption +``` + +## Parameters + + + +## Returns + +`SurveyQuestionOption` + +## Source + +[`pkg/prefabs/survey.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go) + +Line 47. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-type.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-type.mdx new file mode 100644 index 0000000000..8953abe15d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-type.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs/with-question-type" +title: "WithQuestionType" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/prefabs.WithQuestionType" + parent: "github.com/signalwire/signalwire-go/pkg/prefabs" + module: "github.com.signalwire.signalwire-go.pkg.prefabs" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go" +--- +# `WithQuestionType` + +WithQuestionType sets the question type ("rating", "multiple\_choice", "yes\_no", "open\_ended"). + +## Signature + +```go +func WithQuestionType(t string) SurveyQuestionOption +``` + +## Parameters + + + +## Returns + +`SurveyQuestionOption` + +## Source + +[`pkg/prefabs/survey.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/prefabs/survey.go) + +Line 42. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/completed.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/completed.mdx new file mode 100644 index 0000000000..b8ccd83231 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/completed.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/completed" +title: "Completed" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Action.Completed" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Action" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Completed` + +Completed returns whether the action finished. + +## Signature + +```go +func (*Action) Completed() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 93. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/control-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/control-id.mdx new file mode 100644 index 0000000000..cb366b88e5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/control-id.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/control-id" +title: "ControlID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Action.ControlID" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Action" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `ControlID` + +ControlID returns the control identifier for this action. + +## Signature + +```go +func (*Action) ControlID() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 62. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/index.mdx new file mode 100644 index 0000000000..5318f8eccb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action" +title: "Action" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Action" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Action` + +Action represents a long-running operation on a call, such as playing audio, recording, or collecting input. Callers can Wait for completion, check status, or register a completion callback. + +## Signature + +```go +type Action struct +``` + +## Methods + + + + Completed returns whether the action finished. + + + + ControlID returns the control identifier for this action. + + + + IsDone returns true if the action has completed. + + + + OnCompleted registers a callback invoked when the action completes. + + + + Result returns the final event that resolved this action, or nil if pending. + + + + Wait blocks until the action completes or the context is cancelled. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 12. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/is-done.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/is-done.mdx new file mode 100644 index 0000000000..26b09e6831 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/is-done.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/is-done" +title: "IsDone" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Action.IsDone" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Action" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `IsDone` + +IsDone returns true if the action has completed. + +## Signature + +```go +func (*Action) IsDone() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 79. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/on-completed.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/on-completed.mdx new file mode 100644 index 0000000000..4ecdbdd94d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/on-completed.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/on-completed" +title: "OnCompleted" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Action.OnCompleted" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Action" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `OnCompleted` + +OnCompleted registers a callback invoked when the action completes. + +## Signature + +```go +func (*Action) OnCompleted(fn func(*RelayEvent)) +``` + +## Parameters + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 98. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/result.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/result.mdx new file mode 100644 index 0000000000..c2dfce6e4e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/result.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/result" +title: "Result" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Action.Result" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Action" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Result` + +Result returns the final event that resolved this action, or nil if pending. + +## Signature + +```go +func (*Action) Result() *RelayEvent +``` + +## Returns + +`*RelayEvent` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 86. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/wait.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/wait.mdx new file mode 100644 index 0000000000..752d82bd7f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/wait.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/action/wait" +title: "Wait" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Action.Wait" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Action" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Wait` + +Wait blocks until the action completes or the context is cancelled. + +## Signature + +```go +func (*Action) Wait(ctx context.Context) (*RelayEvent, error) +``` + +## Parameters + + + +## Returns + +`(*RelayEvent, error)` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 67. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-action/index.mdx new file mode 100644 index 0000000000..d9a2a8f062 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-action" +title: "AIAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.AIAction" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `AIAction` + +AIAction represents a long-running AI operation on a call. + +## Signature + +```go +type AIAction struct +``` + +## Properties + + + +## Methods + + + + Stop sends calling.ai.stop to halt the active AI session. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 521. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-action/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-action/stop.mdx new file mode 100644 index 0000000000..1f8fdbc7e8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-action/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.AIAction.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.AIAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Stop` + +Stop sends calling.ai.stop to halt the active AI session. + +## Signature + +```go +func (*AIAction) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 533. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-event/index.mdx new file mode 100644 index 0000000000..1d65351f2e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-event/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-event" +title: "AIEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.AIEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `AIEvent` + +AIEvent represents a calling.call.ai event. + +## Signature + +```go +type AIEvent struct +``` + +## Properties + + + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 807. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-option.mdx new file mode 100644 index 0000000000..c2c8660105 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/ai-option" +title: "AIOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.AIOption" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `AIOption` + +AIOption configures an AI operation on a call. + +## Signature + +```go +type AIOption alias +``` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 300. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call-receive-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call-receive-event/index.mdx new file mode 100644 index 0000000000..bfc7b9fd94 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call-receive-event/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call-receive-event" +title: "CallReceiveEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.CallReceiveEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `CallReceiveEvent` + +CallReceiveEvent represents a calling.call.receive event for inbound calls. + +## Signature + +```go +type CallReceiveEvent struct +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 226. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call-state-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call-state-event/index.mdx new file mode 100644 index 0000000000..c8f25d0355 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call-state-event/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call-state-event" +title: "CallStateEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.CallStateEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `CallStateEvent` + +CallStateEvent represents a calling.call.state event. + +## Signature + +```go +type CallStateEvent struct +``` + +## Properties + + + + + + + + + + + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 199. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-hold.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-hold.mdx new file mode 100644 index 0000000000..43f61fa3a3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-hold.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-hold" +title: "AIHold" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.AIHold" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `AIHold` + +AIHold places the AI-controlled call on hold. controlID, timeout and prompt are all optional — pass "" to omit any of them, matching Python's ai\_hold(\*, timeout: Optional\[str] = None, prompt: Optional\[str] = None) which has no control\_id parameter and only writes keys conditionally. + +## Signature + +```go +func (*Call) AIHold(controlID string, timeout string, prompt string) error +``` + +## Parameters + + + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 969. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-message.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-message.mdx new file mode 100644 index 0000000000..dbed715516 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-message.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-message" +title: "AIMessage" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.AIMessage" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `AIMessage` + +AIMessage sends a text message within an active AI session. All parameters are optional, matching Python's ai\_message(\*, message\_text=None, role=None, reset=None, global\_data=None). Pass "" for controlID/text/role and nil for reset/globalData to omit them from the wire payload (Python omits the key entirely when the argument is None). + +## Signature + +```go +func (*Call) AIMessage( + controlID string, + text string, + role string, + reset map[string]any, + globalData map[string]any +) error +``` + +## Parameters + + + + + + + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 941. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-unhold.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-unhold.mdx new file mode 100644 index 0000000000..9065a544d2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-unhold.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai-unhold" +title: "AIUnhold" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.AIUnhold" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `AIUnhold` + +AIUnhold removes the call from AI hold. controlID and prompt are both optional — pass "" to omit either, matching Python's ai\_unhold(\*, prompt: Optional\[str] = None) which has no control\_id parameter and only writes keys conditionally. + +## Signature + +```go +func (*Call) AIUnhold(controlID string, prompt string) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 991. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai.mdx new file mode 100644 index 0000000000..6f9666948b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/ai" +title: "AI" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.AI" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `AI` + +AI starts an AI session on the call. Use WithAIControlID for an explicit control\_id (matches Python's ai(control\_id=...)). + +## Signature + +```go +func (*Call) AI(opts ...AIOption) *AIAction +``` + +## Parameters + + + +## Returns + +`*AIAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 898. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/amazon-bedrock.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/amazon-bedrock.mdx new file mode 100644 index 0000000000..671eea3c58 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/amazon-bedrock.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/amazon-bedrock" +title: "AmazonBedrock" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.AmazonBedrock" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `AmazonBedrock` + +AmazonBedrock starts an AI session using Amazon Bedrock. + +## Signature + +```go +func (*Call) AmazonBedrock(opts ...AIOption) *AIAction +``` + +## Parameters + + + +## Returns + +`*AIAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 931. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/answer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/answer.mdx new file mode 100644 index 0000000000..5437f2c16f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/answer.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/answer" +title: "Answer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Answer" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Answer` + +Answer answers an inbound call. + +## Signature + +```go +func (*Call) Answer() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 250. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/bind-digit.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/bind-digit.mdx new file mode 100644 index 0000000000..90fec7533f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/bind-digit.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/bind-digit" +title: "BindDigit" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.BindDigit" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `BindDigit` + +BindDigit binds a DTMF digit sequence to trigger a RELAY method. bindParams, realm, and maxTriggers are optional (nil/zero-value omits them), matching Python's bind\_digit(digits, bind\_method, \*, bind\_params, realm, max\_triggers). + +## Signature + +```go +func (*Call) BindDigit( + digits string, + method string, + bindParams map[string]any, + realm string, + maxTriggers int +) error +``` + +## Parameters + + + + + + + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1120. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/call-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/call-id.mdx new file mode 100644 index 0000000000..0331aa568c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/call-id.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/call-id" +title: "CallID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.CallID" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `CallID` + +CallID returns the unique call identifier assigned by the server. + +## Signature + +```go +func (*Call) CallID() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 55. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/clear-digit-bindings.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/clear-digit-bindings.mdx new file mode 100644 index 0000000000..88af6c1c1c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/clear-digit-bindings.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/clear-digit-bindings" +title: "ClearDigitBindings" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.ClearDigitBindings" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `ClearDigitBindings` + +ClearDigitBindings clears all DTMF digit bindings, optionally filtered by realm. Pass an empty string to clear all realms (matches Python's clear\_digit\_bindings(\*, realm)). + +## Signature + +```go +func (*Call) ClearDigitBindings(realm string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1143. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/collect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/collect.mdx new file mode 100644 index 0000000000..d8c047ce6c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/collect.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/collect" +title: "Collect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Collect" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Collect` + +Collect starts collecting user input without playing media. The params argument exposes named fields that mirror Python's collect() parameters at relay/call.py:565. Pass a nil CollectParams to send an empty collect body. + +Wire shape (matches Python): + +``` +{"node_id":..., "call_id":..., "control_id":..., "digits":..., "speech":..., ...} +``` + +## Signature + +```go +func (*Call) Collect(params *CollectParams) *StandaloneCollectAction +``` + +## Parameters + + + +## Returns + +`*StandaloneCollectAction` + +## Examples + + + + ```go + {"node_id":..., "call_id":..., "control_id":..., "digits":..., "speech":..., ...} + ``` + + + + ```go + {"node_id":..., "call_id":..., "control_id":..., "digits":..., "speech":..., ...} + ``` + + + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 488. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/connect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/connect.mdx new file mode 100644 index 0000000000..f2eea177bc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/connect.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/connect" +title: "Connect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Connect" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Connect` + +Connect bridges this call to one or more devices. + +## Signature + +```go +func (*Call) Connect(devices [][]map[string]any, opts ...ConnectOption) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 626. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/context.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/context.mdx new file mode 100644 index 0000000000..afc06e990f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/context.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/context" +title: "Context" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Context" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Context` + +Context returns the RELAY context this call was received on. + +## Signature + +```go +func (*Call) Context() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 78. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/denoise-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/denoise-stop.mdx new file mode 100644 index 0000000000..048308a228 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/denoise-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/denoise-stop" +title: "DenoiseStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.DenoiseStop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `DenoiseStop` + +DenoiseStop stops noise reduction on the call. + +## Signature + +```go +func (*Call) DenoiseStop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1038. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/denoise.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/denoise.mdx new file mode 100644 index 0000000000..f09589fcb8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/denoise.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/denoise" +title: "Denoise" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Denoise" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Denoise` + +Denoise starts noise reduction on the call. + +## Signature + +```go +func (*Call) Denoise() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1029. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/detect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/detect.mdx new file mode 100644 index 0000000000..37424aaaec --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/detect.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/detect" +title: "Detect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Detect" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Detect` + +Detect starts a detection operation (e.g., answering machine detection). timeout is optional; pass nil to omit it from the request (matches Python's optional float timeout parameter). + +controlID is optional — pass "" to auto-generate. Matches Python's detect(\*, control\_id=None) at relay/call.py:654. + +## Signature + +```go +func (*Call) Detect(detect map[string]any, timeout *float64, controlID ...string) *DetectAction +``` + +## Parameters + + + + + + + +## Returns + +`*DetectAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 674. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/device.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/device.mdx new file mode 100644 index 0000000000..0afc058748 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/device.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/device" +title: "Device" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Device" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Device` + +Device returns the device map describing the endpoint of this call. + +## Signature + +```go +func (*Call) Device() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 92. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/direction.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/direction.mdx new file mode 100644 index 0000000000..52de7dc81b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/direction.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/direction" +title: "Direction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Direction" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Direction` + +Direction returns the call direction ("inbound" or "outbound"). + +## Signature + +```go +func (*Call) Direction() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 85. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/disconnect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/disconnect.mdx new file mode 100644 index 0000000000..f4d489f796 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/disconnect.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/disconnect" +title: "Disconnect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Disconnect" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Disconnect` + +Disconnect tears down a previously established bridge. + +## Signature + +```go +func (*Call) Disconnect() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 640. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/echo.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/echo.mdx new file mode 100644 index 0000000000..72739ef8a3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/echo.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/echo" +title: "Echo" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Echo" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Echo` + +Echo starts echo mode on the call (echo audio back to the caller). Both timeout and statusURL are optional (nil omits them), matching Python's echo(\*, timeout: float|None, status\_url). + +## Signature + +```go +func (*Call) Echo(timeout *float64, statusURL string) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1181. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/hangup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/hangup.mdx new file mode 100644 index 0000000000..8bdf6f087c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/hangup.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/hangup" +title: "Hangup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Hangup" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Hangup` + +Hangup ends the call with the given reason. + +## Signature + +```go +func (*Call) Hangup(reason string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 259. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/hold.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/hold.mdx new file mode 100644 index 0000000000..a23346dc7d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/hold.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/hold" +title: "Hold" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Hold" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Hold` + +Hold places the call on hold. + +## Signature + +```go +func (*Call) Hold() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1011. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/index.mdx new file mode 100644 index 0000000000..a3945d616e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/index.mdx @@ -0,0 +1,245 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call" +title: "Call" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Call` + +Call represents an active voice call managed through the RELAY client. It exposes methods for every calling operation supported by SignalWire, grouped into logical categories: lifecycle, audio, recording, bridging, DTMF, detection, fax, tap, streaming, conferencing, AI, hold/denoise, room/queue, pay, and transcription. + +## Signature + +```go +type Call struct +``` + +## Methods + + + + AI starts an AI session on the call. Use WithAIControlID for an explicit control\_id (matches Python's ai(control\_id=...)). + + + + AIHold places the AI-controlled call on hold. controlID, timeout and prompt are all optional — pass "" to omit any of them, matching Python's ai\_hold(\*, timeout: Optional\[str] = None, prompt: Optional\[str] = None) which has no control\_id parameter and only writes keys conditionally. + + + + AIMessage sends a text message within an active AI session. All parameters are optional, matching Python's ai\_message(\*, message\_text=None, role=None, reset=None, global\_data=None). Pass "" for controlID/text/role and nil for reset/globalData to omit them from the wire payload (Python omits the key entirely when the argument is None). + + + + AIUnhold removes the call from AI hold. controlID and prompt are both optional — pass "" to omit either, matching Python's ai\_unhold(\*, prompt: Optional\[str] = None) which has no control\_id parameter and only writes keys conditionally. + + + + AmazonBedrock starts an AI session using Amazon Bedrock. + + + + Answer answers an inbound call. + + + + BindDigit binds a DTMF digit sequence to trigger a RELAY method. bindParams, realm, and maxTriggers are optional (nil/zero-value omits them), matching Python's bind\_digit(digits, bind\_method, \*, bind\_params, realm, max\_triggers). + + + + CallID returns the unique call identifier assigned by the server. + + + + ClearDigitBindings clears all DTMF digit bindings, optionally filtered by realm. Pass an empty string to clear all realms (matches Python's clear\_digit\_bindings(\*, realm)). + + + + Collect starts collecting user input without playing media. The params argument exposes named fields that mirror Python's collect() parameters at relay/call.py:565. Pass a nil CollectParams to send an empty collect body. + + + + Connect bridges this call to one or more devices. + + + + Context returns the RELAY context this call was received on. + + + + Denoise starts noise reduction on the call. + + + + DenoiseStop stops noise reduction on the call. + + + + Detect starts a detection operation (e.g., answering machine detection). timeout is optional; pass nil to omit it from the request (matches Python's optional float timeout parameter). + + + + Device returns the device map describing the endpoint of this call. + + + + Direction returns the call direction ("inbound" or "outbound"). + + + + Disconnect tears down a previously established bridge. + + + + Echo starts echo mode on the call (echo audio back to the caller). Both timeout and statusURL are optional (nil omits them), matching Python's echo(\*, timeout: float|None, status\_url). + + + + Hangup ends the call with the given reason. + + + + Hold places the call on hold. + + + + JoinConference joins the call to a named conference. + + + + JoinRoom joins the call to a named room. statusURL is optional (empty string omits it), matching Python's join\_room(name, \*, status\_url). + + + + LeaveConference removes the call from a conference. + + + + LeaveRoom removes the call from the current room. + + + + LiveTranscribe starts or stops live transcription on the call. The action map describes the transcription operation (e.g. \{"type": "start"\}). Matches Python's live\_transcribe(action, \*\*kwargs). + + + + LiveTranslate starts or stops live translation on the call. The action map describes the translation operation. statusURL is optional (empty string omits it), matching Python's live\_translate(action, \*, status\_url). + + + + NodeID returns the node handling this call. + + + + On registers a handler for a specific event type on this call. + + + + Pass passes the call to the next context handler without answering. + + + + Pay starts a payment collection session on the call. Use PayOption functional options to supply any of the 20+ optional parameters that Python's pay() exposes (input\_method, status\_url, payment\_method, timeout, max\_attempts, security\_code, postal\_code, min\_postal\_code\_length, token\_type, charge\_amount, currency, language, voice, description, valid\_card\_types, parameters, prompts). + + + + Play starts playing media on the call and returns a PlayAction. + + + + PlayAndCollect plays media while collecting input (DTMF or speech). + + + + ProjectID returns the project ID associated with this call. + + + + QueueEnter places the call in a named queue. statusURL is optional (empty string omits it), matching Python's queue\_enter(queue\_name, \*, control\_id, status\_url) at signalwire/relay/call.py:1268. A per-request control\_id is generated so the server can correlate this action with subsequent events. + + + + QueueLeave removes the call from the named queue. queueID and statusURL are optional (empty string omits each), matching Python's queue\_leave(queue\_name, \*, control\_id, queue\_id, status\_url) at signalwire/relay/call.py:1287. A per-request control\_id is generated. + + + + ReceiveFax starts receiving a fax on the call. Use WithFaxControlID to supply an explicit control\_id. + + + + Record starts recording the call and returns a RecordAction. + + + + Refer transfers a SIP call to an external SIP endpoint via a REFER request. statusURL is optional (empty string omits it), matching Python's refer(device, \*, status\_url). + + + + SegmentID returns the segment identifier for this call leg. + + + + SendDigits sends DTMF digits on the call. + + + + SendFax sends a fax document on the call. Use WithFaxHeaderInfo for the fax header string and WithFaxControlID for an explicit control\_id. + + + + State returns the current call state. + + + + Stream starts streaming call audio to a WebSocket URL. Use WithStreamControlID for an explicit control\_id (matches Python's stream(control\_id=...)). + + + + String returns a human-readable representation of the call. + + + + Tag returns the client-generated correlation tag. + + + + Tap starts tapping the call audio to an external destination. The optional controlID argument supplies an explicit control\_id (matches Python's tap(control\_id=...)). Pass "" or omit to auto-generate. + + + + Transcribe starts real-time transcription on the call. The optional controlID argument supplies an explicit control\_id (matches Python's transcribe(control\_id=...)). + + + + Transfer transfers call control to another RELAY app or SWML script. The dest parameter is the destination context/URL string, sent as the "dest" key to the server (matches Python's transfer(dest: str) behavior). + + + + Unhold takes the call off hold. + + + + UserEvent sends a user-defined event on the call. eventName is the custom event identifier; pass "" to omit it. Optional `extra` maps are merged into the top-level wire params (mirroring Python's \*\*kwargs in user\_event(\*, event: Optional\[str] = None, \*\*kwargs)). + + + + WaitFor blocks until an event matching the given type and predicate is received, or the context expires. + + + + WaitForEnded blocks until the call reaches the "ended" state, or the context expires. This mirrors Python's wait\_for\_ended() which awaits the \_ended asyncio.Future. + + + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/join-conference.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/join-conference.mdx new file mode 100644 index 0000000000..79fef0bb33 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/join-conference.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/join-conference" +title: "JoinConference" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.JoinConference" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `JoinConference` + +JoinConference joins the call to a named conference. + +## Signature + +```go +func (*Call) JoinConference(name string, opts ...ConferenceOption) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 869. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/join-room.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/join-room.mdx new file mode 100644 index 0000000000..3e385cd435 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/join-room.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/join-room" +title: "JoinRoom" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.JoinRoom" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `JoinRoom` + +JoinRoom joins the call to a named room. statusURL is optional (empty string omits it), matching Python's join\_room(name, \*, status\_url). + +## Signature + +```go +func (*Call) JoinRoom(name string, statusURL string) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1052. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/leave-conference.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/leave-conference.mdx new file mode 100644 index 0000000000..b4e154715d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/leave-conference.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/leave-conference" +title: "LeaveConference" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.LeaveConference" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `LeaveConference` + +LeaveConference removes the call from a conference. + +## Signature + +```go +func (*Call) LeaveConference(confID string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 883. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/leave-room.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/leave-room.mdx new file mode 100644 index 0000000000..45856ed3a7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/leave-room.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/leave-room" +title: "LeaveRoom" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.LeaveRoom" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `LeaveRoom` + +LeaveRoom removes the call from the current room. + +## Signature + +```go +func (*Call) LeaveRoom() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1066. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/live-transcribe.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/live-transcribe.mdx new file mode 100644 index 0000000000..3ce11b2a0d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/live-transcribe.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/live-transcribe" +title: "LiveTranscribe" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.LiveTranscribe" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `LiveTranscribe` + +LiveTranscribe starts or stops live transcription on the call. The action map describes the transcription operation (e.g. \{"type": "start"\}). Matches Python's live\_transcribe(action, \*\*kwargs). + +## Signature + +```go +func (*Call) LiveTranscribe(action map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 319. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/live-translate.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/live-translate.mdx new file mode 100644 index 0000000000..d2417ca11b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/live-translate.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/live-translate" +title: "LiveTranslate" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.LiveTranslate" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `LiveTranslate` + +LiveTranslate starts or stops live translation on the call. The action map describes the translation operation. statusURL is optional (empty string omits it), matching Python's live\_translate(action, \*, status\_url). + +## Signature + +```go +func (*Call) LiveTranslate(action map[string]any, statusURL string) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 331. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/node-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/node-id.mdx new file mode 100644 index 0000000000..6206c5ec89 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/node-id.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/node-id" +title: "NodeID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.NodeID" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `NodeID` + +NodeID returns the node handling this call. + +## Signature + +```go +func (*Call) NodeID() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 58. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/on.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/on.mdx new file mode 100644 index 0000000000..6a51b4f280 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/on.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/on" +title: "On" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.On" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `On` + +On registers a handler for a specific event type on this call. + +## Signature + +```go +func (*Call) On(eventType string, handler func(*RelayEvent)) +``` + +## Parameters + + + + + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 110. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/pass.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/pass.mdx new file mode 100644 index 0000000000..814a14fab4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/pass.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/pass" +title: "Pass" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Pass" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Pass` + +Pass passes the call to the next context handler without answering. + +## Signature + +```go +func (*Call) Pass() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 272. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/pay.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/pay.mdx new file mode 100644 index 0000000000..9be91d139e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/pay.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/pay" +title: "Pay" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Pay" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Pay` + +Pay starts a payment collection session on the call. Use PayOption functional options to supply any of the 20+ optional parameters that Python's pay() exposes (input\_method, status\_url, payment\_method, timeout, max\_attempts, security\_code, postal\_code, min\_postal\_code\_length, token\_type, charge\_amount, currency, language, voice, description, valid\_card\_types, parameters, prompts). + +Use WithPayControlID for an explicit control\_id (matches Python's pay(control\_id=...)). + +## Signature + +```go +func (*Call) Pay(connectorURL string, opts ...PayOption) *PayAction +``` + +## Parameters + + + + + +## Returns + +`*PayAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1209. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/play-and-collect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/play-and-collect.mdx new file mode 100644 index 0000000000..3ac456cb6d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/play-and-collect.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/play-and-collect" +title: "PlayAndCollect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.PlayAndCollect" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `PlayAndCollect` + +PlayAndCollect plays media while collecting input (DTMF or speech). + +Honors WithPlayControlID for an explicit control\_id (mirrors Python's play\_and\_collect(control\_id=...)). Note the gotcha at RELAY\_IMPLEMENTATION\_GUIDE.md: this action listens on the calling.call.collect terminal event, NOT calling.call.play(finished). + +## Signature + +```go +func (*Call) PlayAndCollect( + media []map[string]any, + collect map[string]any, + opts ...PlayOption +) *CollectAction +``` + +## Parameters + + + + + + + +## Returns + +`*CollectAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 408. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/play.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/play.mdx new file mode 100644 index 0000000000..537cf591b3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/play.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/play" +title: "Play" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Play" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Play` + +Play starts playing media on the call and returns a PlayAction. + +Use WithPlayControlID to supply an explicit control\_id (mirrors Python's play(control\_id=...)). When omitted the SDK auto-generates a UUID — same as Python's `cid = control_id or str(uuid.uuid4())` at relay/call.py:506. + +## Signature + +```go +func (*Call) Play(media []map[string]any, opts ...PlayOption) *PlayAction +``` + +## Parameters + + + + + +## Returns + +`*PlayAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 354. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/project-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/project-id.mdx new file mode 100644 index 0000000000..ac25513e28 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/project-id.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/project-id" +title: "ProjectID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.ProjectID" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `ProjectID` + +ProjectID returns the project ID associated with this call. + +## Signature + +```go +func (*Call) ProjectID() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 71. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/queue-enter.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/queue-enter.mdx new file mode 100644 index 0000000000..4abeaa38df --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/queue-enter.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/queue-enter" +title: "QueueEnter" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.QueueEnter" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `QueueEnter` + +QueueEnter places the call in a named queue. statusURL is optional (empty string omits it), matching Python's queue\_enter(queue\_name, \*, control\_id, status\_url) at signalwire/relay/call.py:1268. A per-request control\_id is generated so the server can correlate this action with subsequent events. + +## Signature + +```go +func (*Call) QueueEnter(name string, statusURL string) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1078. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/queue-leave.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/queue-leave.mdx new file mode 100644 index 0000000000..b09d10022c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/queue-leave.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/queue-leave" +title: "QueueLeave" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.QueueLeave" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `QueueLeave` + +QueueLeave removes the call from the named queue. queueID and statusURL are optional (empty string omits each), matching Python's queue\_leave(queue\_name, \*, control\_id, queue\_id, status\_url) at signalwire/relay/call.py:1287. A per-request control\_id is generated. + +## Signature + +```go +func (*Call) QueueLeave(name string, queueID string, statusURL string) error +``` + +## Parameters + + + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1096. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/receive-fax.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/receive-fax.mdx new file mode 100644 index 0000000000..9477e3de7f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/receive-fax.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/receive-fax" +title: "ReceiveFax" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.ReceiveFax" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `ReceiveFax` + +ReceiveFax starts receiving a fax on the call. Use WithFaxControlID to supply an explicit control\_id. + +## Signature + +```go +func (*Call) ReceiveFax(opts ...FaxOption) *FaxAction +``` + +## Parameters + + + +## Returns + +`*FaxAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 752. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/record.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/record.mdx new file mode 100644 index 0000000000..bbb1913dad --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/record.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/record" +title: "Record" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Record" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Record` + +Record starts recording the call and returns a RecordAction. + +Use WithRecordAudio to supply the audio config map (Python's record(audio=...)) and WithRecordControlID to fix the control\_id. Other RecordOption helpers set top-level fields directly (e.g. WithRecordBeep, WithRecordFormat); these are folded into the "record": \{"audio": \{...\}\} object on transmit so the wire shape matches Python: \{"record": \{"audio": \{...\}\}\}. + +## Signature + +```go +func (*Call) Record(opts ...RecordOption) *RecordAction +``` + +## Parameters + + + +## Returns + +`*RecordAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 557. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/refer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/refer.mdx new file mode 100644 index 0000000000..da645b4479 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/refer.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/refer" +title: "Refer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Refer" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Refer` + +Refer transfers a SIP call to an external SIP endpoint via a REFER request. statusURL is optional (empty string omits it), matching Python's refer(device, \*, status\_url). + +## Signature + +```go +func (*Call) Refer(device map[string]any, statusURL string) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 299. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/segment-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/segment-id.mdx new file mode 100644 index 0000000000..63722c484f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/segment-id.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/segment-id" +title: "SegmentID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.SegmentID" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `SegmentID` + +SegmentID returns the segment identifier for this call leg. + +## Signature + +```go +func (*Call) SegmentID() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 99. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/send-digits.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/send-digits.mdx new file mode 100644 index 0000000000..33ae159421 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/send-digits.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/send-digits" +title: "SendDigits" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.SendDigits" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `SendDigits` + +SendDigits sends DTMF digits on the call. + +## Signature + +```go +func (*Call) SendDigits(digits string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 653. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/send-fax.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/send-fax.mdx new file mode 100644 index 0000000000..b01cc96e3c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/send-fax.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/send-fax" +title: "SendFax" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.SendFax" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `SendFax` + +SendFax sends a fax document on the call. Use WithFaxHeaderInfo for the fax header string and WithFaxControlID for an explicit control\_id. + +## Signature + +```go +func (*Call) SendFax(document string, identity string, opts ...FaxOption) *FaxAction +``` + +## Parameters + + + + + + + +## Returns + +`*FaxAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 714. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/state.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/state.mdx new file mode 100644 index 0000000000..b402e764aa --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/state.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/state" +title: "State" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.State" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `State` + +State returns the current call state. + +## Signature + +```go +func (*Call) State() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 64. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/stream.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/stream.mdx new file mode 100644 index 0000000000..fc22819044 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/stream.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/stream" +title: "Stream" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Stream" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Stream` + +Stream starts streaming call audio to a WebSocket URL. Use WithStreamControlID for an explicit control\_id (matches Python's stream(control\_id=...)). + +## Signature + +```go +func (*Call) Stream(url string, opts ...StreamOption) *StreamAction +``` + +## Parameters + + + + + +## Returns + +`*StreamAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 831. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/string.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/string.mdx new file mode 100644 index 0000000000..628ea2485f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/string.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/string" +title: "String" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.String" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `String` + +String returns a human-readable representation of the call. + +## Signature + +```go +func (*Call) String() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1288. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/tag.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/tag.mdx new file mode 100644 index 0000000000..e81ffcb472 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/tag.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/tag" +title: "Tag" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Tag" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Tag` + +Tag returns the client-generated correlation tag. + +## Signature + +```go +func (*Call) Tag() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 61. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/tap.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/tap.mdx new file mode 100644 index 0000000000..012f311e2c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/tap.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/tap" +title: "Tap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Tap" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Tap` + +Tap starts tapping the call audio to an external destination. The optional controlID argument supplies an explicit control\_id (matches Python's tap(control\_id=...)). Pass "" or omit to auto-generate. + +## Signature + +```go +func (*Call) Tap(tap map[string]any, device map[string]any, controlID ...string) *TapAction +``` + +## Parameters + + + + + + + +## Returns + +`*TapAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 791. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/transcribe.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/transcribe.mdx new file mode 100644 index 0000000000..edb48694cc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/transcribe.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/transcribe" +title: "Transcribe" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Transcribe" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Transcribe` + +Transcribe starts real-time transcription on the call. The optional controlID argument supplies an explicit control\_id (matches Python's transcribe(control\_id=...)). + +## Signature + +```go +func (*Call) Transcribe(statusURL string, controlID ...string) *TranscribeAction +``` + +## Parameters + + + + + +## Returns + +`*TranscribeAction` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1249. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/transfer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/transfer.mdx new file mode 100644 index 0000000000..cf933beaf0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/transfer.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/transfer" +title: "Transfer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Transfer" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Transfer` + +Transfer transfers call control to another RELAY app or SWML script. The dest parameter is the destination context/URL string, sent as the "dest" key to the server (matches Python's transfer(dest: str) behavior). + +## Signature + +```go +func (*Call) Transfer(dest string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 283. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/unhold.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/unhold.mdx new file mode 100644 index 0000000000..784d8edc86 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/unhold.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/unhold" +title: "Unhold" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.Unhold" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `Unhold` + +Unhold takes the call off hold. + +## Signature + +```go +func (*Call) Unhold() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1020. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/user-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/user-event.mdx new file mode 100644 index 0000000000..d7783ea7e6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/user-event.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/user-event" +title: "UserEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.UserEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `UserEvent` + +UserEvent sends a user-defined event on the call. eventName is the custom event identifier; pass "" to omit it. Optional `extra` maps are merged into the top-level wire params (mirroring Python's \*\*kwargs in user\_event(\*, event: Optional\[str] = None, \*\*kwargs)). + +Wire shape (matches Python): \{"event": \, ...extra\}. + +## Signature + +```go +func (*Call) UserEvent(eventName string, extra ...map[string]any) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 1161. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/wait-for-ended.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/wait-for-ended.mdx new file mode 100644 index 0000000000..7112754ba4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/wait-for-ended.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/wait-for-ended" +title: "WaitForEnded" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.WaitForEnded" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `WaitForEnded` + +WaitForEnded blocks until the call reaches the "ended" state, or the context expires. This mirrors Python's wait\_for\_ended() which awaits the \_ended asyncio.Future. + +## Signature + +```go +func (*Call) WaitForEnded(ctx context.Context) (*RelayEvent, error) +``` + +## Parameters + + + +## Returns + +`(*RelayEvent, error)` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 139. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/wait-for.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/wait-for.mdx new file mode 100644 index 0000000000..b475058ee0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/wait-for.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/call/wait-for" +title: "WaitFor" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Call.WaitFor" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Call" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `WaitFor` + +WaitFor blocks until an event matching the given type and predicate is received, or the context expires. + +## Signature + +```go +func (*Call) WaitFor(ctx context.Context, eventType string, predicate func(*RelayEvent) bool) (*RelayEvent, error) +``` + +## Parameters + + + + + + + +## Returns + +`(*RelayEvent, error)` + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 118. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/calling-error-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/calling-error-event/index.mdx new file mode 100644 index 0000000000..d0125793ba --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/calling-error-event/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/calling-error-event" +title: "CallingErrorEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.CallingErrorEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `CallingErrorEvent` + +CallingErrorEvent represents a calling.call.error event. + +## Signature + +```go +type CallingErrorEvent struct +``` + +## Properties + + + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 674. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client-option.mdx new file mode 100644 index 0000000000..a63ef5116d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client-option" +title: "ClientOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.ClientOption" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `ClientOption` + +ClientOption configures the RELAY Client. + +## Signature + +```go +type ClientOption alias +``` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 343. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/authenticate.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/authenticate.mdx new file mode 100644 index 0000000000..ed94787a68 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/authenticate.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/authenticate" +title: "Authenticate" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Authenticate" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Authenticate` + +Authenticate runs the signalwire.connect handshake and stores the server-issued protocol string. Mirrors Python's RelayClient.connect() auth phase. Use Connect first to establish the WebSocket; this call reads the auth response synchronously (the read loop has not yet started so no other reader is contending for the socket). + +## Signature + +```go +func (*Client) Authenticate() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 273. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/authorization-state.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/authorization-state.mdx new file mode 100644 index 0000000000..6703ad1e21 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/authorization-state.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/authorization-state" +title: "AuthorizationState" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.AuthorizationState" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `AuthorizationState` + +AuthorizationState returns the most recent encrypted authorization state blob received via signalwire.authorization.state events. Mirrors Python's RelayClient.\_authorization\_state used during reconnection (relay/client.py:174). Empty until the server pushes such an event. + +## Signature + +```go +func (*Client) AuthorizationState() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 168. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/connect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/connect.mdx new file mode 100644 index 0000000000..6acd2cf5d7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/connect.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/connect" +title: "Connect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Connect" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Connect` + +Connect establishes the WebSocket connection to SignalWire. This is the public equivalent of the internal connect() method, mirroring Python's async connect() which is also used in the async-with context manager. In most cases callers should use Run() which calls Connect internally and then drives the read loop. + +## Signature + +```go +func (*Client) Connect() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 179. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/contexts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/contexts.mdx new file mode 100644 index 0000000000..1ddfcb7fa9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/contexts.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/contexts" +title: "Contexts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Contexts" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Contexts` + +Contexts returns a copy of the configured RELAY contexts. Mirrors Python's public client.contexts attribute. The returned slice is a copy — mutating it does not affect the client. + +## Signature + +```go +func (*Client) Contexts() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 157. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/dial.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/dial.mdx new file mode 100644 index 0000000000..59d6d1d65f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/dial.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/dial" +title: "Dial" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Dial" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Dial` + +Dial initiates an outbound call to the given device list. The devices parameter is a list of serial/parallel device groups (same structure as the Blade calling.dial devices field). + +Mirrors Python's RelayClient.dial(devices, \*, tag=None, max\_duration=None, dial\_timeout=None). The calling.dial RPC response only contains \{"code": "200", "message": "Dialing"\} — no call\_id. The real call\_id and node\_id arrive via subsequent calling.call.dial events keyed by tag. This method waits for that event so the returned Call always has valid identifiers. + +To pass a caller-supplied tag, use WithDialTag. Without it the SDK generates a UUID, matching Python's tag = tag or str(uuid.uuid4()). + +## Signature + +```go +func (*Client) Dial(devices [][]map[string]any, opts ...DialOption) (*Call, error) +``` + +## Parameters + + + + + +## Returns + +`(*Call, error)` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 333. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/execute.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/execute.mdx new file mode 100644 index 0000000000..3a2b1c99f8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/execute.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/execute" +title: "Execute" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Execute" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Execute` + +Execute sends a JSON-RPC request over the WebSocket and waits for the response. Mirrors Python's async execute(method, params) which is the public arbitrary-RPC surface used by callers that need low-level access. + +## Signature + +```go +func (*Client) Execute(method string, params map[string]any) (json.RawMessage, error) +``` + +## Parameters + + + + + +## Returns + +`(json.RawMessage, error)` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 186. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/index.mdx new file mode 100644 index 0000000000..b59f7610ff --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/index.mdx @@ -0,0 +1,121 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client" +title: "Client" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Client` + +Client is the main RELAY WebSocket client that manages a persistent connection to SignalWire, handles Blade/JSON-RPC 2.0 authentication, event dispatch, and exposes high-level Dial/SendMessage methods. + +## Signature + +```go +type Client struct +``` + +## Methods + + + + Authenticate runs the signalwire.connect handshake and stores the server-issued protocol string. Mirrors Python's RelayClient.connect() auth phase. Use Connect first to establish the WebSocket; this call reads the auth response synchronously (the read loop has not yet started so no other reader is contending for the socket). + + + + AuthorizationState returns the most recent encrypted authorization state blob received via signalwire.authorization.state events. Mirrors Python's RelayClient.\_authorization\_state used during reconnection (relay/client.py:174). Empty until the server pushes such an event. + + + + Connect establishes the WebSocket connection to SignalWire. This is the public equivalent of the internal connect() method, mirroring Python's async connect() which is also used in the async-with context manager. In most cases callers should use Run() which calls Connect internally and then drives the read loop. + + + + Contexts returns a copy of the configured RELAY contexts. Mirrors Python's public client.contexts attribute. The returned slice is a copy — mutating it does not affect the client. + + + + Dial initiates an outbound call to the given device list. The devices parameter is a list of serial/parallel device groups (same structure as the Blade calling.dial devices field). + + + + Execute sends a JSON-RPC request over the WebSocket and waits for the response. Mirrors Python's async execute(method, params) which is the public arbitrary-RPC surface used by callers that need low-level access. + + + + JWTToken returns the configured JWT. Mirrors Python's public client.jwt\_token attribute, allowing callers to read back the value supplied via WithJWT(...). + + + + Notify sends a JSON-RPC notification (no `id`, no response expected) with the given method and params. Used for fire-and-forget frames such as the client-side `signalwire.event` ACK pattern that some integration fixtures expect. Returns any write error from the underlying socket. + + + + OnCall registers a handler invoked for each inbound call. + + + + OnEvent registers a handler invoked for every inbound `signalwire.event` frame, AFTER type-specific routing (call, messaging) has run. The handler receives the raw event\_type string and params map. This is the lowest-level event hook — most callers should use OnCall or OnMessage instead. Mirrors Python RelayClient's public event-tap surface used by integration tests. + + + + OnMessage registers a handler invoked for each inbound message. + + + + ProjectID returns the configured project ID. Mirrors Python's public client.project attribute, allowing callers to read back the value supplied via WithProject(...) or the SIGNALWIRE\_PROJECT\_ID env var. + + + + Receive subscribes to additional contexts for inbound events after the client is already connected. Sends signalwire.receive on the assigned protocol. Mirrors Python's async receive(contexts). + + + + RelayProtocol returns the server-assigned protocol string received during authentication. Mirrors Python's relay\_protocol property. The value is empty until after a successful Connect/Run. + + + + Run connects to SignalWire, authenticates, subscribes to configured contexts, and starts the read loop. It blocks until Stop is called or the context is cancelled. + + + + SendMessage sends an SMS/MMS message and returns a Message that can be used to track delivery. + + + + Space returns the configured SignalWire space hostname. Mirrors Python's public client.host attribute (Python uses the term "host"; Go uses "space" because that's the more accurate noun — see WithSpace). + + + + StartReadLoop spawns the read goroutine and marks the client running. Mirrors the goroutine-spawn portion of Run() — call it after Authenticate() and before any Execute() call so JSON-RPC responses have a reader. Pair with Stop() to terminate. + + + + Stop gracefully shuts down the client connection. + + + + SubscribeContexts subscribes to whatever contexts were configured via WithContexts. No-op when the contexts slice is empty. Used by the mock-relay test helper which drives connect/auth/read-loop manually. + + + + Token returns the configured API token. Mirrors Python's public client.token attribute, allowing callers to read back the value supplied via WithToken(...) or the SIGNALWIRE\_API\_TOKEN env var. + + + + Unreceive unsubscribes from contexts for inbound events. Sends signalwire.unreceive on the assigned protocol. Mirrors Python's async unreceive(contexts). + + + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 22. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/jwt-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/jwt-token.mdx new file mode 100644 index 0000000000..7a9833888e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/jwt-token.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/jwt-token" +title: "JWTToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.JWTToken" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `JWTToken` + +JWTToken returns the configured JWT. Mirrors Python's public client.jwt\_token attribute, allowing callers to read back the value supplied via WithJWT(...). + +## Signature + +```go +func (*Client) JWTToken() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 139. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/notify.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/notify.mdx new file mode 100644 index 0000000000..4ed0cd55eb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/notify.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/notify" +title: "Notify" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Notify" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Notify` + +Notify sends a JSON-RPC notification (no `id`, no response expected) with the given method and params. Used for fire-and-forget frames such as the client-side `signalwire.event` ACK pattern that some integration fixtures expect. Returns any write error from the underlying socket. + +## Signature + +```go +func (*Client) Notify(method string, params map[string]any) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 195. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-call.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-call.mdx new file mode 100644 index 0000000000..5744a27d1c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-call.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-call" +title: "OnCall" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.OnCall" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `OnCall` + +OnCall registers a handler invoked for each inbound call. + +## Signature + +```go +func (*Client) OnCall(handler func(*Call)) +``` + +## Parameters + + + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 84. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-event.mdx new file mode 100644 index 0000000000..137026c925 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-event.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-event" +title: "OnEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.OnEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `OnEvent` + +OnEvent registers a handler invoked for every inbound `signalwire.event` frame, AFTER type-specific routing (call, messaging) has run. The handler receives the raw event\_type string and params map. This is the lowest-level event hook — most callers should use OnCall or OnMessage instead. Mirrors Python RelayClient's public event-tap surface used by integration tests. + +## Signature + +```go +func (*Client) OnEvent(handler func(eventType string, params map[string]any)) +``` + +## Parameters + + + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 103. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-message.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-message.mdx new file mode 100644 index 0000000000..afbf4bdd2e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-message.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/on-message" +title: "OnMessage" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.OnMessage" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `OnMessage` + +OnMessage registers a handler invoked for each inbound message. + +## Signature + +```go +func (*Client) OnMessage(handler func(*Message)) +``` + +## Parameters + + + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 91. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/project-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/project-id.mdx new file mode 100644 index 0000000000..008a30a691 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/project-id.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/project-id" +title: "ProjectID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.ProjectID" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `ProjectID` + +ProjectID returns the configured project ID. Mirrors Python's public client.project attribute, allowing callers to read back the value supplied via WithProject(...) or the SIGNALWIRE\_PROJECT\_ID env var. + +## Signature + +```go +func (*Client) ProjectID() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 121. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/receive.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/receive.mdx new file mode 100644 index 0000000000..7066ca9695 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/receive.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/receive" +title: "Receive" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Receive" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Receive` + +Receive subscribes to additional contexts for inbound events after the client is already connected. Sends signalwire.receive on the assigned protocol. Mirrors Python's async receive(contexts). + +## Signature + +```go +func (*Client) Receive(contexts ...string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 207. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/relay-protocol.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/relay-protocol.mdx new file mode 100644 index 0000000000..2a30a93b0f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/relay-protocol.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/relay-protocol" +title: "RelayProtocol" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.RelayProtocol" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `RelayProtocol` + +RelayProtocol returns the server-assigned protocol string received during authentication. Mirrors Python's relay\_protocol property. The value is empty until after a successful Connect/Run. + +## Signature + +```go +func (*Client) RelayProtocol() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 112. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/run.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/run.mdx new file mode 100644 index 0000000000..87eff2efdd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/run.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/run" +title: "Run" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Run" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Run` + +Run connects to SignalWire, authenticates, subscribes to configured contexts, and starts the read loop. It blocks until Stop is called or the context is cancelled. + +Important: the read loop must be running before subscribeContexts() is called. subscribeContexts() executes a JSON-RPC request whose response is delivered through the read loop's pending-id channel machinery. If the read loop isn't running, the JSON-RPC reply has no reader and the request times out (30s). Hence we start readLoop in a goroutine BEFORE the subscribe call, then block on a done channel here. + +## Signature + +```go +func (*Client) Run() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 241. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/send-message.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/send-message.mdx new file mode 100644 index 0000000000..600c430742 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/send-message.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/send-message" +title: "SendMessage" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.SendMessage" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `SendMessage` + +SendMessage sends an SMS/MMS message and returns a Message that can be used to track delivery. + +The context option (WithMessageContext) sets the routing context for the message; it defaults to the relay protocol when omitted, matching Python SDK behaviour. The on\_completed option (WithMessageOnCompleted) registers a callback fired when the message reaches a terminal state. + +## Signature + +```go +func (*Client) SendMessage(to string, from string, body string, opts ...MessageOption) (*Message, error) +``` + +## Parameters + + + + + + + + + +## Returns + +`(*Message, error)` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 393. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/space.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/space.mdx new file mode 100644 index 0000000000..9320c9944e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/space.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/space" +title: "Space" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Space" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Space` + +Space returns the configured SignalWire space hostname. Mirrors Python's public client.host attribute (Python uses the term "host"; Go uses "space" because that's the more accurate noun — see WithSpace). + +## Signature + +```go +func (*Client) Space() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 148. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/start-read-loop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/start-read-loop.mdx new file mode 100644 index 0000000000..75286cfc1a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/start-read-loop.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/start-read-loop" +title: "StartReadLoop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.StartReadLoop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `StartReadLoop` + +StartReadLoop spawns the read goroutine and marks the client running. Mirrors the goroutine-spawn portion of Run() — call it after Authenticate() and before any Execute() call so JSON-RPC responses have a reader. Pair with Stop() to terminate. + +## Signature + +```go +func (*Client) StartReadLoop() +``` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 281. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/stop.mdx new file mode 100644 index 0000000000..a0a1a5ae30 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/stop.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Stop` + +Stop gracefully shuts down the client connection. + +Equivalent to Python's RelayClient.disconnect() (relay/client.py:286). Python users porting code can search for "disconnect" and find this method by its rename. + +## Signature + +```go +func (*Client) Stop() +``` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 298. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/subscribe-contexts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/subscribe-contexts.mdx new file mode 100644 index 0000000000..afe06580ab --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/subscribe-contexts.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/subscribe-contexts" +title: "SubscribeContexts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.SubscribeContexts" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `SubscribeContexts` + +SubscribeContexts subscribes to whatever contexts were configured via WithContexts. No-op when the contexts slice is empty. Used by the mock-relay test helper which drives connect/auth/read-loop manually. + +## Signature + +```go +func (*Client) SubscribeContexts() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 289. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/token.mdx new file mode 100644 index 0000000000..c782332d33 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/token.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/token" +title: "Token" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Token" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Token` + +Token returns the configured API token. Mirrors Python's public client.token attribute, allowing callers to read back the value supplied via WithToken(...) or the SIGNALWIRE\_API\_TOKEN env var. + +## Signature + +```go +func (*Client) Token() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 130. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/unreceive.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/unreceive.mdx new file mode 100644 index 0000000000..1f12d7e1d1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/unreceive.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/client/unreceive" +title: "Unreceive" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Client.Unreceive" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Client" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `Unreceive` + +Unreceive unsubscribes from contexts for inbound events. Sends signalwire.unreceive on the assigned protocol. Mirrors Python's async unreceive(contexts). + +## Signature + +```go +func (*Client) Unreceive(contexts ...string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 220. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/index.mdx new file mode 100644 index 0000000000..4b47d264e9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action" +title: "CollectAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.CollectAction" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `CollectAction` + +CollectAction represents a play-and-collect operation. + +## Signature + +```go +type CollectAction struct +``` + +## Properties + + + +## Methods + + + + StartInputTimers starts the initial\_timeout timer on an active collect, equivalent to Python's CollectAction.start\_input\_timers(). + + + + Stop sends calling.play\_and\_collect.stop to halt the play-and-collect operation. + + + + Volume adjusts the playback volume by the given dB offset during a play-and-collect operation. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 288. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/start-input-timers.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..099c736b93 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/start-input-timers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/start-input-timers" +title: "StartInputTimers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.CollectAction.StartInputTimers" + parent: "github.com/signalwire/signalwire-go/pkg/relay.CollectAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `StartInputTimers` + +StartInputTimers starts the initial\_timeout timer on an active collect, equivalent to Python's CollectAction.start\_input\_timers(). + +## Signature + +```go +func (*CollectAction) StartInputTimers() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 332. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/stop.mdx new file mode 100644 index 0000000000..dfece0fd35 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.CollectAction.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.CollectAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Stop` + +Stop sends calling.play\_and\_collect.stop to halt the play-and-collect operation. + +## Signature + +```go +func (*CollectAction) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 303. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/volume.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/volume.mdx new file mode 100644 index 0000000000..911edd4770 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/volume.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-action/volume" +title: "Volume" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.CollectAction.Volume" + parent: "github.com/signalwire/signalwire-go/pkg/relay.CollectAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Volume` + +Volume adjusts the playback volume by the given dB offset during a play-and-collect operation. + +## Signature + +```go +func (*CollectAction) Volume(db float64) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 317. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-event/index.mdx new file mode 100644 index 0000000000..1177a48549 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-event/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-event" +title: "CollectEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.CollectEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `CollectEvent` + +CollectEvent represents a calling.call.collect event. + +## Signature + +```go +type CollectEvent struct +``` + +## Properties + + + + + Final is a \*bool matching Python's Optional\[bool] = None semantics. + + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 333. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-params/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-params/index.mdx new file mode 100644 index 0000000000..01cd128144 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-params/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/collect-params" +title: "CollectParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.CollectParams" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go" +--- +# `CollectParams` + +CollectParams holds named parameters for the Collect method, matching Python's collect() named arguments. The fields are placed at the top level of the on-wire calling.collect frame (NOT nested under a "collect" object) — mirroring Python's params\["digits"] = digits at relay/call.py:583. + +## Signature + +```go +type CollectParams struct +``` + +## Properties + + + Continuous enables continuous collection after a result is received. + + + + ControlID overrides the auto-generated control identifier. + + + + Digits configures DTMF digit collection. + + + + InitialTimeout is the number of seconds to wait for first input. + + + + OnCompleted is fired when the collect action reaches a terminal state. + + + + PartialResults enables streaming partial results as input is gathered. + + + + SendStartOfInput signals when the user begins speaking/pressing. + + + + Speech configures speech recognition collection. + + + + StartInputTimers controls whether input timers start immediately. + + +## Source + +[`pkg/relay/call.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/call.go) + +Line 459. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/conference-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/conference-event/index.mdx new file mode 100644 index 0000000000..5759a038cf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/conference-event/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/conference-event" +title: "ConferenceEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.ConferenceEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `ConferenceEvent` + +ConferenceEvent represents a calling.call.conference event. + +## Signature + +```go +type ConferenceEvent struct +``` + +## Properties + + + + + + + + + + + Status reads wire key "status" matching Python's status field. (Replaces the previous State field which incorrectly read "state".) + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 651. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/conference-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/conference-option.mdx new file mode 100644 index 0000000000..95f440474e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/conference-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/conference-option" +title: "ConferenceOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.ConferenceOption" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `ConferenceOption` + +ConferenceOption configures a JoinConference call. + +## Signature + +```go +type ConferenceOption alias +``` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 164. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/connect-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/connect-event/index.mdx new file mode 100644 index 0000000000..8a4e2a8172 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/connect-event/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/connect-event" +title: "ConnectEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.ConnectEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `ConnectEvent` + +ConnectEvent represents a calling.call.connect event. + +## Signature + +```go +type ConnectEvent struct +``` + +## Properties + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 355. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/connect-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/connect-option.mdx new file mode 100644 index 0000000000..cd2e18ebc8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/connect-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/connect-option" +title: "ConnectOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.ConnectOption" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `ConnectOption` + +ConnectOption configures a Connect call. + +## Signature + +```go +type ConnectOption alias +``` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 131. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/denoise-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/denoise-event/index.mdx new file mode 100644 index 0000000000..f724f4c025 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/denoise-event/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/denoise-event" +title: "DenoiseEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.DenoiseEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `DenoiseEvent` + +DenoiseEvent represents a calling.call.denoise event. + +## Signature + +```go +type DenoiseEvent struct +``` + +## Properties + + + + + Denoised matches Python's denoised bool field. + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 517. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-action/index.mdx new file mode 100644 index 0000000000..4115f54b5b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-action" +title: "DetectAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.DetectAction" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `DetectAction` + +DetectAction represents a long-running detect operation (e.g. machine detection). + +## Signature + +```go +type DetectAction struct +``` + +## Properties + + + +## Methods + + + + Stop sends calling.detect.stop to halt the active detect operation. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 258. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-action/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-action/stop.mdx new file mode 100644 index 0000000000..fdd4f83baa --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-action/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.DetectAction.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.DetectAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Stop` + +Stop sends calling.detect.stop to halt the active detect operation. + +## Signature + +```go +func (*DetectAction) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 275. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-event/index.mdx new file mode 100644 index 0000000000..307a03065e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-event/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/detect-event" +title: "DetectEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.DetectEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `DetectEvent` + +DetectEvent represents a calling.call.detect event. + +## Signature + +```go +type DetectEvent struct +``` + +## Properties + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 372. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/dial-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/dial-event/index.mdx new file mode 100644 index 0000000000..6d2d5fe385 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/dial-event/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/dial-event" +title: "DialEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.DialEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `DialEvent` + +DialEvent represents a calling.call.dial event. + +## Signature + +```go +type DialEvent struct +``` + +## Properties + + + Call is the nested call dict, matching Python's call field. + + + + + + DialState reads wire key "dial\_state" matching Python's dial\_state field. (Replaces the previous State field which incorrectly read "state".) + + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 468. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/dial-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/dial-option.mdx new file mode 100644 index 0000000000..0738c87369 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/dial-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/dial-option" +title: "DialOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.DialOption" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `DialOption` + +DialOption configures a Dial (outbound call) operation. + +## Signature + +```go +type DialOption alias +``` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 388. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/echo-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/echo-event/index.mdx new file mode 100644 index 0000000000..83f49d3009 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/echo-event/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/echo-event" +title: "EchoEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.EchoEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `EchoEvent` + +EchoEvent represents a calling.call.echo event. + +## Signature + +```go +type EchoEvent struct +``` + +## Properties + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 586. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-action/index.mdx new file mode 100644 index 0000000000..3aad6dd7bf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-action" +title: "FaxAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.FaxAction" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `FaxAction` + +FaxAction represents a long-running fax send/receive operation. methodPrefix distinguishes "send\_fax" from "receive\_fax" and is used to build the operation-specific stop command (e.g. "calling.send\_fax.stop"). + +## Signature + +```go +type FaxAction struct +``` + +## Properties + + + +## Methods + + + + Stop sends "calling.\{methodPrefix\}.stop" (e.g. "calling.send\_fax.stop" or "calling.receive\_fax.stop") to halt the active fax operation. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 388. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-action/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-action/stop.mdx new file mode 100644 index 0000000000..8f28ab7623 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-action/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.FaxAction.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.FaxAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Stop` + +Stop sends "calling.\{methodPrefix\}.stop" (e.g. "calling.send\_fax.stop" or "calling.receive\_fax.stop") to halt the active fax operation. + +## Signature + +```go +func (*FaxAction) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 407. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-event/index.mdx new file mode 100644 index 0000000000..1d25426ff1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-event/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-event" +title: "FaxEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.FaxEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `FaxEvent` + +FaxEvent represents a calling.call.fax event. + +## Signature + +```go +type FaxEvent struct +``` + +## Properties + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 389. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-option.mdx new file mode 100644 index 0000000000..c1ac305e0b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/fax-option" +title: "FaxOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.FaxOption" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `FaxOption` + +FaxOption configures a SendFax call. + +## Signature + +```go +type FaxOption alias +``` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 188. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/hold-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/hold-event/index.mdx new file mode 100644 index 0000000000..c663a63c0e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/hold-event/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/hold-event" +title: "HoldEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.HoldEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `HoldEvent` + +HoldEvent represents a calling.call.hold event. + +## Signature + +```go +type HoldEvent struct +``` + +## Properties + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 634. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/index.mdx new file mode 100644 index 0000000000..ccb4da2e1c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/index.mdx @@ -0,0 +1,836 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay" +title: "relay" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `relay` + +Package relay implements real-time WebSocket call control over the SignalWire Blade protocol (JSON-RPC 2.0). It provides a RELAY client that manages WebSocket connections, authentication, and event routing for calling, messaging, and other real-time communication primitives. + +## Signature + +```go +package relay +``` + +## Constants + + + AgentString is the SDK identifier the connect frame announces to the RELAY server. Mirrors Python's AGENT\_STRING at relay/constants.py:5, translated to identify this language's port. Sent as `params.agent` on signalwire.connect. + + + + Call states represent the lifecycle of a call. + + + + Call states represent the lifecycle of a call. + + + + Call states represent the lifecycle of a call. + + + + Call states represent the lifecycle of a call. + + + + Call states represent the lifecycle of a call. + + + + Call directions. + + + + Call directions. + + + + Call end reasons indicate why a call ended. + + + + Call end reasons indicate why a call ended. + + + + Call end reasons indicate why a call ended. + + + + Call end reasons indicate why a call ended. + + + + Call end reasons indicate why a call ended. + + + + Call end reasons indicate why a call ended. + + + + Authorization-state event used to refresh reconnect material. Mirrors Python's EVENT\_AUTHORIZATION\_STATE = "signalwire.authorization.state" (relay/constants.py:16). + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for calling events. + + + + Event types for messaging events. + + + + Event types for messaging events. + + + + Message states represent the lifecycle of an SMS/MMS message. + + + + Message states represent the lifecycle of an SMS/MMS message. + + + + Message states represent the lifecycle of an SMS/MMS message. + + + + Message states represent the lifecycle of an SMS/MMS message. + + + + Message states represent the lifecycle of an SMS/MMS message. + + + + Message states represent the lifecycle of an SMS/MMS message. + + + + Message states represent the lifecycle of an SMS/MMS message. + + + + Blade/SignalWire internal method constants. + + + + Blade/SignalWire internal method constants. + + + + Blade/SignalWire internal method constants. + + + + Blade/SignalWire internal method constants. + + + + Blade/SignalWire internal method constants. + + + + Protocol version for the SignalWire Blade protocol. + + + + Protocol version for the SignalWire Blade protocol. + + + + Protocol version for the SignalWire Blade protocol. + + +## Functions + + + + NewAIEvent constructs an AIEvent from raw params. + + + + NewCallingErrorEvent constructs a CallingErrorEvent from raw params. + + + + NewCallReceiveEvent constructs a CallReceiveEvent from raw params. + + + + NewCallStateEvent constructs a CallStateEvent from raw params. + + + + NewCollectEvent constructs a CollectEvent from raw params. + + + + NewConferenceEvent constructs a ConferenceEvent from raw params. + + + + NewConnectEvent constructs a ConnectEvent from raw params. + + + + NewDenoiseEvent constructs a DenoiseEvent from raw params. + + + + NewDetectEvent constructs a DetectEvent from raw params. + + + + NewDialEvent constructs a DialEvent from raw params. + + + + NewEchoEvent constructs an EchoEvent from raw params. + + + + NewFaxEvent constructs a FaxEvent from raw params. + + + + NewHoldEvent constructs a HoldEvent from raw params. + + + + NewMessageReceiveEvent constructs a MessageReceiveEvent from raw params. + + + + NewMessageStateEvent constructs a MessageStateEvent from raw params. + + + + NewPayEvent constructs a PayEvent from raw params. + + + + NewPlayEvent constructs a PlayEvent from raw params. + + + + NewQueueEvent constructs a QueueEvent from raw params. + + + + NewRecordEvent constructs a RecordEvent from raw params. URL, Duration, and Size are extracted from the nested "record" dict first, falling back to top-level params — matching Python's from\_payload behavior. + + + + NewReferEvent constructs a ReferEvent from raw params. + + + + NewRelayClient creates a new RELAY Client with the given options. + + + + NewRelayError constructs a RelayError with the given code and message. + + + + NewRelayEvent creates a new RelayEvent from the given type and params. + + + + NewSendDigitsEvent constructs a SendDigitsEvent from raw params. + + + + NewStreamEvent constructs a StreamEvent from raw params. + + + + NewTapEvent constructs a TapEvent from raw params. + + + + NewTranscribeEvent constructs a TranscribeEvent from raw params. + + + + ParseEvent parses a raw signalwire event payload dict into a typed event object. It reads "event\_type" from the top-level payload and "params" as the inner parameter map, then dispatches to the appropriate typed constructor. If the event\_type is not recognised, a plain \*RelayEvent is returned. Callers can type-assert or type-switch on the result to access the concrete event fields. + + + + WithAIControlID supplies an explicit control\_id for the AI action, matching Python's ai(control\_id=...). + + + + WithAIEngine sets the AI engine to use. + + + + WithAIParams sets arbitrary AI parameters. + + + + WithAIPostPrompt sets the AI post-prompt configuration. + + + + WithAIPrompt sets the AI prompt text. + + + + WithConferenceBeep enables beep on join/leave. + + + + WithConferenceDeaf joins deaf (cannot hear others). + + + + WithConferenceMuted joins muted. + + + + WithConnectRingback sets ringback media for the connect operation. + + + + WithContexts sets the contexts to subscribe to for inbound events. + + + + WithDialClientTimeout bounds how long Dial() will wait for the calling.call.dial event before raising a timeout error. Mirrors Python's dial(dial\_timeout=\). Default is 120s when omitted. + + + + WithDialFromNumber sets the caller ID for the outbound call. + + + + WithDialMaxDuration sets the maximum call duration in minutes. Mirrors Python's dial(max\_duration=...) parameter. + + + + WithDialTag sets an explicit caller-supplied dial tag. When omitted the SDK generates a UUID, mirroring Python's `tag = tag or str(uuid.uuid4())` at relay/client.py:368. + + + + WithDialTimeout sets the legacy per-leg dial timeout in seconds. (Was the only Go option; retained for back-compat. To bound the overall Dial() call use WithDialClientTimeout.) + + + + WithEnvDefaults is now a no-op pass-through retained for backwards compatibility — env defaults are loaded automatically at the end of NewRelayClient (mirroring Python RelayClient.**init**). New code can rely on the auto-load behavior and omit this option entirely. + + + + WithFaxControlID supplies an explicit control\_id for the fax action, matching Python's send\_fax(control\_id=...) / receive\_fax(control\_id=...). + + + + WithFaxHeaderInfo sets the fax header info string (matches Python's header\_info param). + + + + WithJWT sets a pre-existing JWT for authentication. + + + + WithMaxActiveCalls limits the number of concurrent active calls. + + + + WithMessageContext sets the routing context for the message. Mirrors Python's send\_message(context=...) parameter — defaults to the relay protocol when omitted. + + + + WithMessageMedia adds media URLs to the message (MMS). + + + + WithMessageOnCompleted registers a callback invoked when the message reaches a terminal state (delivered, undelivered, or failed). The callback receives both the message and the terminal RelayEvent, mirroring Python's \_on\_completed callback contract (relay/message.py:115-117) which receives the event directly. Mirrors Python's send\_message(on\_completed=...) parameter. + + + + WithMessageRegion sets the region for message delivery. + + + + WithMessageTags sets tags on the message for tracking. + + + + WithPayChargeAmount sets the charge amount. + + + + WithPayControlID supplies an explicit control\_id for the pay action, matching Python's pay(control\_id=...). + + + + WithPayCurrency sets the payment currency. + + + + WithPayDescription sets a description for the payment. + + + + WithPayInputMethod sets the payment input method. + + + + WithPayLanguage sets the language for payment prompts. + + + + WithPayMaxAttempts sets the maximum number of payment attempts. + + + + WithPayMinPostalCodeLength sets the minimum postal code length. + + + + WithPayParameters sets additional payment parameters. + + + + WithPayPaymentMethod sets the payment method (e.g. "credit-card"). + + + + WithPayPostalCode sets whether to collect postal code. + + + + WithPayPrompts sets custom payment prompts. + + + + WithPaySecurityCode sets whether to collect security code. + + + + WithPayStatusURL sets the payment status callback URL. + + + + WithPayTimeout sets the timeout string for the payment session. + + + + WithPayTokenType sets the payment token type. + + + + WithPayValidCardTypes sets the valid card types string. + + + + WithPayVoice sets the voice for payment prompts. + + + + WithPlayControlID sets an explicit control\_id for the play action. Mirrors Python's play(control\_id=...). When omitted the SDK auto-generates a UUID. The same key is honored by play\_and\_collect. + + + + WithPlayDirection sets the play direction (e.g. "self" / "peer" / "both"). + + + + WithPlayLoop sets the number of loop iterations for playback. + + + + WithPlayOnCompleted registers a callback fired when the play action reaches a terminal state. Mirrors Python's play(on\_completed=...). + + + + WithPlayVolume sets the volume for playback in dB. + + + + WithProject sets the project ID for authentication. + + + + WithRecordAudio sets the audio config map for the record action's "record": \{"audio": ...\} payload. Mirrors Python's record(audio=...). + + + + WithRecordBeep enables a beep before recording. + + + + WithRecordControlID sets an explicit control\_id for the record action. Mirrors Python's record(control\_id=...). + + + + WithRecordDirection sets the recording direction ("listen", "speak", "both"). + + + + WithRecordEndSilenceTimeout sets the end-of-speech silence timeout in seconds. + + + + WithRecordFormat sets the recording format (e.g. "wav", "mp3"). + + + + WithRecordInitialTimeout sets the initial timeout in seconds. + + + + WithRecordOnCompleted registers a callback fired when the record action reaches a terminal state. Mirrors Python's record(on\_completed=...). + + + + WithRecordStereo enables stereo recording. + + + + WithRecordTerminators sets DTMF terminators to stop recording. + + + + WithSpace sets the SignalWire space (e.g. "example.signalwire.com"). + + + + WithStreamCodec sets the stream audio codec. + + + + WithStreamControlID supplies an explicit control\_id for the stream action, matching Python's stream(control\_id=...). + + + + WithStreamDirection sets the stream direction. + + + + WithToken sets the API token for authentication. + + + +## Type Aliases + + + + AIOption configures an AI operation on a call. + + + + ClientOption configures the RELAY Client. + + + + ConferenceOption configures a JoinConference call. + + + + ConnectOption configures a Connect call. + + + + DialOption configures a Dial (outbound call) operation. + + + + FaxOption configures a SendFax call. + + + + MessageOption configures a SendMessage operation. + + + + PayOption configures a Pay call. + + + + PlayOption configures a Play call. + + + + RecordOption configures a Record call. + + + + StreamOption configures a Stream call. + + + +## Classes + + + + Action represents a long-running operation on a call, such as playing audio, recording, or collecting input. Callers can Wait for completion, check status, or register a completion callback. + + + + AIAction represents a long-running AI operation on a call. + + + + AIEvent represents a calling.call.ai event. + + + + Call represents an active voice call managed through the RELAY client. It exposes methods for every calling operation supported by SignalWire, grouped into logical categories: lifecycle, audio, recording, bridging, DTMF, detection, fax, tap, streaming, conferencing, AI, hold/denoise, room/queue, pay, and transcription. + + + + CallingErrorEvent represents a calling.call.error event. + + + + CallReceiveEvent represents a calling.call.receive event for inbound calls. + + + + CallStateEvent represents a calling.call.state event. + + + + Client is the main RELAY WebSocket client that manages a persistent connection to SignalWire, handles Blade/JSON-RPC 2.0 authentication, event dispatch, and exposes high-level Dial/SendMessage methods. + + + + CollectAction represents a play-and-collect operation. + + + + CollectEvent represents a calling.call.collect event. + + + + CollectParams holds named parameters for the Collect method, matching Python's collect() named arguments. The fields are placed at the top level of the on-wire calling.collect frame (NOT nested under a "collect" object) — mirroring Python's params\["digits"] = digits at relay/call.py:583. + + + + ConferenceEvent represents a calling.call.conference event. + + + + ConnectEvent represents a calling.call.connect event. + + + + DenoiseEvent represents a calling.call.denoise event. + + + + DetectAction represents a long-running detect operation (e.g. machine detection). + + + + DetectEvent represents a calling.call.detect event. + + + + DialEvent represents a calling.call.dial event. + + + + EchoEvent represents a calling.call.echo event. + + + + FaxAction represents a long-running fax send/receive operation. methodPrefix distinguishes "send\_fax" from "receive\_fax" and is used to build the operation-specific stop command (e.g. "calling.send\_fax.stop"). + + + + FaxEvent represents a calling.call.fax event. + + + + HoldEvent represents a calling.call.hold event. + + + + Message represents an SMS/MMS message tracked through its lifecycle. + + + + MessageReceiveEvent represents a messaging.receive event. + + + + MessageStateEvent represents a messaging.state event. + + + + PayAction represents a long-running pay operation. + + + + PayEvent represents a calling.call.pay event. + + + + PlayAction represents a long-running play operation with media controls. + + + + PlayEvent represents a calling.call.play event. + + + + QueueEvent represents a calling.call.queue event. + + + + RecordAction represents a long-running record operation. + + + + RecordEvent represents a calling.call.record event. + + + + ReferEvent represents a calling.call.refer event. + + + + RelayError is a typed error returned by the RELAY protocol client. It carries the numeric code and message from the server so callers can programmatically inspect failures via errors.As. + + + + RelayEvent is the base event type for all events received from the SignalWire RELAY service. It carries an event type string and a generic parameter map that can be queried via helper methods. + + + + SendDigitsEvent represents a calling.call.send\_digits event. + + + + StandaloneCollectAction represents a standalone collect (without play). + + + + StreamAction represents a long-running media stream operation. + + + + StreamEvent represents a calling.call.stream event. + + + + TapAction represents a long-running tap operation. + + + + TapEvent represents a calling.call.tap event. + + + + TranscribeAction represents a long-running transcription operation. + + + + TranscribeEvent represents a calling.call.transcribe event. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-option.mdx new file mode 100644 index 0000000000..e54492f903 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-option" +title: "MessageOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.MessageOption" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `MessageOption` + +MessageOption configures a SendMessage operation. + +## Signature + +```go +type MessageOption alias +``` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 437. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-receive-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-receive-event/index.mdx new file mode 100644 index 0000000000..99f87b67a3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-receive-event/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-receive-event" +title: "MessageReceiveEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.MessageReceiveEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `MessageReceiveEvent` + +MessageReceiveEvent represents a messaging.receive event. + +## Signature + +```go +type MessageReceiveEvent struct +``` + +## Properties + + + + + + + + + + + + + + + MessageState matches Python's message\_state field. + + + + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 693. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-state-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-state-event/index.mdx new file mode 100644 index 0000000000..67ab3fbf70 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-state-event/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message-state-event" +title: "MessageStateEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.MessageStateEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `MessageStateEvent` + +MessageStateEvent represents a messaging.state event. + +## Signature + +```go +type MessageStateEvent struct +``` + +## Properties + + + Body matches Python's body field. + + + + Context matches Python's context field. + + + + + + + + Media matches Python's media: list\[str] field. + + + + + + MessageState reads wire key "message\_state" matching Python's message\_state field. (Replaces the previous State field which incorrectly read "state".) + + + + + + + + Segments matches Python's segments: int field. + + + + Tags matches Python's tags: list\[str] field. + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 746. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/body.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/body.mdx new file mode 100644 index 0000000000..66a58de85e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/body.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/body" +title: "Body" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.Body" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `Body` + +Body returns the text body of the message. + +## Signature + +```go +func (*Message) Body() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 60. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/context.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/context.mdx new file mode 100644 index 0000000000..067d764e03 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/context.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/context" +title: "Context" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.Context" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `Context` + +Context returns the RELAY context on which this message was received. + +## Signature + +```go +func (*Message) Context() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 48. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/direction.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/direction.mdx new file mode 100644 index 0000000000..31a4afc824 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/direction.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/direction" +title: "Direction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.Direction" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `Direction` + +Direction returns "inbound" or "outbound". + +## Signature + +```go +func (*Message) Direction() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 51. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/from-number.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/from-number.mdx new file mode 100644 index 0000000000..64a6c57179 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/from-number.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/from-number" +title: "FromNumber" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.FromNumber" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `FromNumber` + +FromNumber returns the sender number. + +## Signature + +```go +func (*Message) FromNumber() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 54. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/index.mdx new file mode 100644 index 0000000000..da159bee0a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/index.mdx @@ -0,0 +1,93 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message" +title: "Message" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `Message` + +Message represents an SMS/MMS message tracked through its lifecycle. + +## Signature + +```go +type Message struct +``` + +## Methods + + + + Body returns the text body of the message. + + + + Context returns the RELAY context on which this message was received. + + + + Direction returns "inbound" or "outbound". + + + + FromNumber returns the sender number. + + + + IsDone returns true if the message has reached a terminal state. + + + + Media returns the list of media URLs attached to the message. + + + + MessageID returns the unique message identifier. + + + + On registers an event handler called when message state changes. + + + + Reason returns the failure reason if the message failed. + + + + Result returns the terminal RelayEvent if the message has reached a terminal state, or nil if not yet done. This is the non-blocking equivalent of Python's Message.result property. + + + + Segments returns the number of SMS segments. + + + + State returns the current message state. + + + + Tags returns the tags associated with the message. + + + + ToNumber returns the recipient number. + + + + Wait blocks until the message reaches a terminal state or the context is cancelled. Returns the final event or the context error. + + + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 9. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/is-done.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/is-done.mdx new file mode 100644 index 0000000000..2c0a754afd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/is-done.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/is-done" +title: "IsDone" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.IsDone" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `IsDone` + +IsDone returns true if the message has reached a terminal state. + +## Signature + +```go +func (*Message) IsDone() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 111. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/media.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/media.mdx new file mode 100644 index 0000000000..42c191b7f5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/media.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/media" +title: "Media" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.Media" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `Media` + +Media returns the list of media URLs attached to the message. + +## Signature + +```go +func (*Message) Media() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 63. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/message-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/message-id.mdx new file mode 100644 index 0000000000..9bdc2c1fce --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/message-id.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/message-id" +title: "MessageID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.MessageID" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `MessageID` + +MessageID returns the unique message identifier. + +## Signature + +```go +func (*Message) MessageID() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 45. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/on.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/on.mdx new file mode 100644 index 0000000000..cdb37d0e4a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/on.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/on" +title: "On" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.On" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `On` + +On registers an event handler called when message state changes. + +## Signature + +```go +func (*Message) On(handler func(*RelayEvent)) +``` + +## Parameters + + + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 118. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/reason.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/reason.mdx new file mode 100644 index 0000000000..010324097c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/reason.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/reason" +title: "Reason" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.Reason" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `Reason` + +Reason returns the failure reason if the message failed. + +## Signature + +```go +func (*Message) Reason() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 76. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/result.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/result.mdx new file mode 100644 index 0000000000..46e8c33a75 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/result.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/result" +title: "Result" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.Result" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `Result` + +Result returns the terminal RelayEvent if the message has reached a terminal state, or nil if not yet done. This is the non-blocking equivalent of Python's Message.result property. + +## Signature + +```go +func (*Message) Result() *RelayEvent +``` + +## Returns + +`*RelayEvent` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 88. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/segments.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/segments.mdx new file mode 100644 index 0000000000..ee3eec2cae --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/segments.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/segments" +title: "Segments" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.Segments" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `Segments` + +Segments returns the number of SMS segments. + +## Signature + +```go +func (*Message) Segments() int +``` + +## Returns + +`int` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 66. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/state.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/state.mdx new file mode 100644 index 0000000000..4bfcfc2353 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/state.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/state" +title: "State" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.State" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `State` + +State returns the current message state. + +## Signature + +```go +func (*Message) State() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 69. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/tags.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/tags.mdx new file mode 100644 index 0000000000..93cf440c95 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/tags.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/tags" +title: "Tags" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.Tags" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `Tags` + +Tags returns the tags associated with the message. + +## Signature + +```go +func (*Message) Tags() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 83. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/to-number.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/to-number.mdx new file mode 100644 index 0000000000..db44cc41dc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/to-number.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/to-number" +title: "ToNumber" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.ToNumber" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `ToNumber` + +ToNumber returns the recipient number. + +## Signature + +```go +func (*Message) ToNumber() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 57. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/wait.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/wait.mdx new file mode 100644 index 0000000000..cbf78695a6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/wait.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/message/wait" +title: "Wait" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.Message.Wait" + parent: "github.com/signalwire/signalwire-go/pkg/relay.Message" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go" +--- +# `Wait` + +Wait blocks until the message reaches a terminal state or the context is cancelled. Returns the final event or the context error. + +## Signature + +```go +func (*Message) Wait(ctx context.Context) (*RelayEvent, error) +``` + +## Parameters + + + +## Returns + +`(*RelayEvent, error)` + +## Source + +[`pkg/relay/message.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/message.go) + +Line 99. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-ai-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-ai-event.mdx new file mode 100644 index 0000000000..b1f211ccec --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-ai-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-ai-event" +title: "NewAIEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewAIEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewAIEvent` + +NewAIEvent constructs an AIEvent from raw params. + +## Signature + +```go +func NewAIEvent(params map[string]any) *AIEvent +``` + +## Parameters + + + +## Returns + +`*AIEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 815. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-call-receive-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-call-receive-event.mdx new file mode 100644 index 0000000000..9c341c9b93 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-call-receive-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-call-receive-event" +title: "NewCallReceiveEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewCallReceiveEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewCallReceiveEvent` + +NewCallReceiveEvent constructs a CallReceiveEvent from raw params. + +## Signature + +```go +func NewCallReceiveEvent(params map[string]any) *CallReceiveEvent +``` + +## Parameters + + + +## Returns + +`*CallReceiveEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 240. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-call-state-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-call-state-event.mdx new file mode 100644 index 0000000000..b564cf71fa --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-call-state-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-call-state-event" +title: "NewCallStateEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewCallStateEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewCallStateEvent` + +NewCallStateEvent constructs a CallStateEvent from raw params. + +## Signature + +```go +func NewCallStateEvent(params map[string]any) *CallStateEvent +``` + +## Parameters + + + +## Returns + +`*CallStateEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 211. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-calling-error-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-calling-error-event.mdx new file mode 100644 index 0000000000..45570fe840 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-calling-error-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-calling-error-event" +title: "NewCallingErrorEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewCallingErrorEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewCallingErrorEvent` + +NewCallingErrorEvent constructs a CallingErrorEvent from raw params. + +## Signature + +```go +func NewCallingErrorEvent(params map[string]any) *CallingErrorEvent +``` + +## Parameters + + + +## Returns + +`*CallingErrorEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 682. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-collect-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-collect-event.mdx new file mode 100644 index 0000000000..18b5e7733d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-collect-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-collect-event" +title: "NewCollectEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewCollectEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewCollectEvent` + +NewCollectEvent constructs a CollectEvent from raw params. + +## Signature + +```go +func NewCollectEvent(params map[string]any) *CollectEvent +``` + +## Parameters + + + +## Returns + +`*CollectEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 343. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-conference-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-conference-event.mdx new file mode 100644 index 0000000000..2844780cd6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-conference-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-conference-event" +title: "NewConferenceEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewConferenceEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewConferenceEvent` + +NewConferenceEvent constructs a ConferenceEvent from raw params. + +## Signature + +```go +func NewConferenceEvent(params map[string]any) *ConferenceEvent +``` + +## Parameters + + + +## Returns + +`*ConferenceEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 662. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-connect-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-connect-event.mdx new file mode 100644 index 0000000000..1f8a6d8d8d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-connect-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-connect-event" +title: "NewConnectEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewConnectEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewConnectEvent` + +NewConnectEvent constructs a ConnectEvent from raw params. + +## Signature + +```go +func NewConnectEvent(params map[string]any) *ConnectEvent +``` + +## Parameters + + + +## Returns + +`*ConnectEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 362. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-denoise-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-denoise-event.mdx new file mode 100644 index 0000000000..b83f1fc7fe --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-denoise-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-denoise-event" +title: "NewDenoiseEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewDenoiseEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewDenoiseEvent` + +NewDenoiseEvent constructs a DenoiseEvent from raw params. + +## Signature + +```go +func NewDenoiseEvent(params map[string]any) *DenoiseEvent +``` + +## Parameters + + + +## Returns + +`*DenoiseEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 526. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-detect-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-detect-event.mdx new file mode 100644 index 0000000000..3b98244733 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-detect-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-detect-event" +title: "NewDetectEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewDetectEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewDetectEvent` + +NewDetectEvent constructs a DetectEvent from raw params. + +## Signature + +```go +func NewDetectEvent(params map[string]any) *DetectEvent +``` + +## Parameters + + + +## Returns + +`*DetectEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 379. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-dial-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-dial-event.mdx new file mode 100644 index 0000000000..48a24bb63b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-dial-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-dial-event" +title: "NewDialEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewDialEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewDialEvent` + +NewDialEvent constructs a DialEvent from raw params. + +## Signature + +```go +func NewDialEvent(params map[string]any) *DialEvent +``` + +## Parameters + + + +## Returns + +`*DialEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 481. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-echo-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-echo-event.mdx new file mode 100644 index 0000000000..315ac2e40c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-echo-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-echo-event" +title: "NewEchoEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewEchoEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewEchoEvent` + +NewEchoEvent constructs an EchoEvent from raw params. + +## Signature + +```go +func NewEchoEvent(params map[string]any) *EchoEvent +``` + +## Parameters + + + +## Returns + +`*EchoEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 593. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-fax-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-fax-event.mdx new file mode 100644 index 0000000000..efe51e6e0d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-fax-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-fax-event" +title: "NewFaxEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewFaxEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewFaxEvent` + +NewFaxEvent constructs a FaxEvent from raw params. + +## Signature + +```go +func NewFaxEvent(params map[string]any) *FaxEvent +``` + +## Parameters + + + +## Returns + +`*FaxEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 396. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-hold-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-hold-event.mdx new file mode 100644 index 0000000000..64dc6c42da --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-hold-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-hold-event" +title: "NewHoldEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewHoldEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewHoldEvent` + +NewHoldEvent constructs a HoldEvent from raw params. + +## Signature + +```go +func NewHoldEvent(params map[string]any) *HoldEvent +``` + +## Parameters + + + +## Returns + +`*HoldEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 641. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-message-receive-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-message-receive-event.mdx new file mode 100644 index 0000000000..4978433863 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-message-receive-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-message-receive-event" +title: "NewMessageReceiveEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewMessageReceiveEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewMessageReceiveEvent` + +NewMessageReceiveEvent constructs a MessageReceiveEvent from raw params. + +## Signature + +```go +func NewMessageReceiveEvent(params map[string]any) *MessageReceiveEvent +``` + +## Parameters + + + +## Returns + +`*MessageReceiveEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 709. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-message-state-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-message-state-event.mdx new file mode 100644 index 0000000000..22c2f65733 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-message-state-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-message-state-event" +title: "NewMessageStateEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewMessageStateEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewMessageStateEvent` + +NewMessageStateEvent constructs a MessageStateEvent from raw params. + +## Signature + +```go +func NewMessageStateEvent(params map[string]any) *MessageStateEvent +``` + +## Parameters + + + +## Returns + +`*MessageStateEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 769. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-pay-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-pay-event.mdx new file mode 100644 index 0000000000..0ec13035b5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-pay-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-pay-event" +title: "NewPayEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewPayEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewPayEvent` + +NewPayEvent constructs a PayEvent from raw params. + +## Signature + +```go +func NewPayEvent(params map[string]any) *PayEvent +``` + +## Parameters + + + +## Returns + +`*PayEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 545. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-play-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-play-event.mdx new file mode 100644 index 0000000000..676d152309 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-play-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-play-event" +title: "NewPlayEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewPlayEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewPlayEvent` + +NewPlayEvent constructs a PlayEvent from raw params. + +## Signature + +```go +func NewPlayEvent(params map[string]any) *PlayEvent +``` + +## Parameters + + + +## Returns + +`*PlayEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 274. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-queue-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-queue-event.mdx new file mode 100644 index 0000000000..ce9f025aa0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-queue-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-queue-event" +title: "NewQueueEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewQueueEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewQueueEvent` + +NewQueueEvent constructs a QueueEvent from raw params. + +## Signature + +```go +func NewQueueEvent(params map[string]any) *QueueEvent +``` + +## Parameters + + + +## Returns + +`*QueueEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 572. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-record-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-record-event.mdx new file mode 100644 index 0000000000..ab5ca30d12 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-record-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-record-event" +title: "NewRecordEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewRecordEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewRecordEvent` + +NewRecordEvent constructs a RecordEvent from raw params. URL, Duration, and Size are extracted from the nested "record" dict first, falling back to top-level params — matching Python's from\_payload behavior. + +## Signature + +```go +func NewRecordEvent(params map[string]any) *RecordEvent +``` + +## Parameters + + + +## Returns + +`*RecordEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 299. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-refer-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-refer-event.mdx new file mode 100644 index 0000000000..33d1e28b4e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-refer-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-refer-event" +title: "NewReferEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewReferEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewReferEvent` + +NewReferEvent constructs a ReferEvent from raw params. + +## Signature + +```go +func NewReferEvent(params map[string]any) *ReferEvent +``` + +## Parameters + + + +## Returns + +`*ReferEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 504. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-client.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-client.mdx new file mode 100644 index 0000000000..109eb67657 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-client.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-client" +title: "NewRelayClient" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewRelayClient" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go" +--- +# `NewRelayClient` + +NewRelayClient creates a new RELAY Client with the given options. + +After explicit options are applied, any remaining unset auth/space fields fall back to SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, SIGNALWIRE\_JWT\_TOKEN, SIGNALWIRE\_SPACE, and RELAY\_MAX\_ACTIVE\_CALLS environment variables — matching Python RelayClient.**init**'s automatic env-var fallback (relay/client.py:115-119). Explicit options always win. + +## Signature + +```go +func NewRelayClient(opts ...ClientOption) *Client +``` + +## Parameters + + + +## Returns + +`*Client` + +## Source + +[`pkg/relay/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/client.go) + +Line 63. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-error.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-error.mdx new file mode 100644 index 0000000000..02a151569c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-error.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-error" +title: "NewRelayError" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewRelayError" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/error.go" +--- +# `NewRelayError` + +NewRelayError constructs a RelayError with the given code and message. + +## Signature + +```go +func NewRelayError(code int, message string) *RelayError +``` + +## Parameters + + + + + +## Returns + +`*RelayError` + +## Source + +[`pkg/relay/error.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/error.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-event.mdx new file mode 100644 index 0000000000..deae13222e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-relay-event" +title: "NewRelayEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewRelayEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewRelayEvent` + +NewRelayEvent creates a new RelayEvent from the given type and params. + +## Signature + +```go +func NewRelayEvent(eventType string, params map[string]any) *RelayEvent +``` + +## Parameters + + + + + +## Returns + +`*RelayEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-send-digits-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-send-digits-event.mdx new file mode 100644 index 0000000000..b75c4c2124 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-send-digits-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-send-digits-event" +title: "NewSendDigitsEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewSendDigitsEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewSendDigitsEvent` + +NewSendDigitsEvent constructs a SendDigitsEvent from raw params. + +## Signature + +```go +func NewSendDigitsEvent(params map[string]any) *SendDigitsEvent +``` + +## Parameters + + + +## Returns + +`*SendDigitsEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 458. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-stream-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-stream-event.mdx new file mode 100644 index 0000000000..e6ae4ebc12 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-stream-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-stream-event" +title: "NewStreamEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewStreamEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewStreamEvent` + +NewStreamEvent constructs a StreamEvent from raw params. + +## Signature + +```go +func NewStreamEvent(params map[string]any) *StreamEvent +``` + +## Parameters + + + +## Returns + +`*StreamEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 439. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-tap-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-tap-event.mdx new file mode 100644 index 0000000000..1e17732207 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-tap-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-tap-event" +title: "NewTapEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewTapEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewTapEvent` + +NewTapEvent constructs a TapEvent from raw params. + +## Signature + +```go +func NewTapEvent(params map[string]any) *TapEvent +``` + +## Parameters + + + +## Returns + +`*TapEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 416. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-transcribe-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-transcribe-event.mdx new file mode 100644 index 0000000000..ee00beddf8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-transcribe-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/new-transcribe-event" +title: "NewTranscribeEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.NewTranscribeEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `NewTranscribeEvent` + +NewTranscribeEvent constructs a TranscribeEvent from raw params. + +## Signature + +```go +func NewTranscribeEvent(params map[string]any) *TranscribeEvent +``` + +## Parameters + + + +## Returns + +`*TranscribeEvent` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 619. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/parse-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/parse-event.mdx new file mode 100644 index 0000000000..a152363332 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/parse-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/parse-event" +title: "ParseEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.ParseEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `ParseEvent` + +ParseEvent parses a raw signalwire event payload dict into a typed event object. It reads "event\_type" from the top-level payload and "params" as the inner parameter map, then dispatches to the appropriate typed constructor. If the event\_type is not recognised, a plain \*RelayEvent is returned. Callers can type-assert or type-switch on the result to access the concrete event fields. + +This mirrors Python's relay.event.parse\_event(payload). + +## Signature + +```go +func ParseEvent(payload map[string]any) any +``` + +## Parameters + + + +## Returns + +`any` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 833. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-action/index.mdx new file mode 100644 index 0000000000..1f9e6ae1da --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-action" +title: "PayAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.PayAction" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `PayAction` + +PayAction represents a long-running pay operation. + +## Signature + +```go +type PayAction struct +``` + +## Properties + + + +## Methods + + + + Stop sends calling.pay.stop to halt the active pay operation. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 470. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-action/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-action/stop.mdx new file mode 100644 index 0000000000..16e88f931a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-action/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.PayAction.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.PayAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Stop` + +Stop sends calling.pay.stop to halt the active pay operation. + +## Signature + +```go +func (*PayAction) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 482. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-event/index.mdx new file mode 100644 index 0000000000..339cda8a14 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-event/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-event" +title: "PayEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.PayEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `PayEvent` + +PayEvent represents a calling.call.pay event. + +## Signature + +```go +type PayEvent struct +``` + +## Properties + + + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 537. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-option.mdx new file mode 100644 index 0000000000..657063fb7a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/pay-option" +title: "PayOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.PayOption" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `PayOption` + +PayOption configures a Pay call. + +## Signature + +```go +type PayOption alias +``` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 206. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/index.mdx new file mode 100644 index 0000000000..44512d2510 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action" +title: "PlayAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.PlayAction" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `PlayAction` + +PlayAction represents a long-running play operation with media controls. + +## Signature + +```go +type PlayAction struct +``` + +## Properties + + + +## Methods + + + + Pause pauses the currently playing media. + + + + Resume resumes paused media playback. + + + + Stop sends calling.play.stop to halt the active play operation. + + + + Volume adjusts playback volume by the given dB offset. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 129. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/pause.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/pause.mdx new file mode 100644 index 0000000000..679aa8d84e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/pause.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/pause" +title: "Pause" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.PlayAction.Pause" + parent: "github.com/signalwire/signalwire-go/pkg/relay.PlayAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Pause` + +Pause pauses the currently playing media. + +## Signature + +```go +func (*PlayAction) Pause() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 158. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/resume.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/resume.mdx new file mode 100644 index 0000000000..5286189a36 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/resume.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/resume" +title: "Resume" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.PlayAction.Resume" + parent: "github.com/signalwire/signalwire-go/pkg/relay.PlayAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Resume` + +Resume resumes paused media playback. + +## Signature + +```go +func (*PlayAction) Resume() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 171. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/stop.mdx new file mode 100644 index 0000000000..afd88de33a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.PlayAction.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.PlayAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Stop` + +Stop sends calling.play.stop to halt the active play operation. + +## Signature + +```go +func (*PlayAction) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 145. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/volume.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/volume.mdx new file mode 100644 index 0000000000..9d8e88d1fd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/volume.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-action/volume" +title: "Volume" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.PlayAction.Volume" + parent: "github.com/signalwire/signalwire-go/pkg/relay.PlayAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Volume` + +Volume adjusts playback volume by the given dB offset. + +## Signature + +```go +func (*PlayAction) Volume(db float64) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 184. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-event/index.mdx new file mode 100644 index 0000000000..7914b5a631 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-event/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-event" +title: "PlayEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.PlayEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `PlayEvent` + +PlayEvent represents a calling.call.play event. + +## Signature + +```go +type PlayEvent struct +``` + +## Properties + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 267. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-option.mdx new file mode 100644 index 0000000000..ccc5123686 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/play-option" +title: "PlayOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.PlayOption" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `PlayOption` + +PlayOption configures a Play call. + +## Signature + +```go +type PlayOption alias +``` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 13. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/queue-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/queue-event/index.mdx new file mode 100644 index 0000000000..369c415db6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/queue-event/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/queue-event" +title: "QueueEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.QueueEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `QueueEvent` + +QueueEvent represents a calling.call.queue event. + +## Signature + +```go +type QueueEvent struct +``` + +## Properties + + + + + + + QueueID reads wire key "id" matching Python's queue\_id = p.get("id", ""). + + + + QueueName reads wire key "name" matching Python's queue\_name = p.get("name", ""). (Previously read "queue\_name" which was wrong.) + + + + + + + + Status reads wire key "status" matching Python's status field. (Replaces the previous State field which incorrectly read "state".) + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 556. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/index.mdx new file mode 100644 index 0000000000..1e231fa47a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action" +title: "RecordAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RecordAction" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `RecordAction` + +RecordAction represents a long-running record operation. + +## Signature + +```go +type RecordAction struct +``` + +## Properties + + + +## Methods + + + + Pause pauses the active recording. An optional behavior string may be provided (e.g. "silence" or "skip") to control how the gap is handled. Pass no argument — or "" — to omit behavior, matching Python's pause(behavior: Optional\[str] = None) signature. + + + + Resume resumes a paused recording. + + + + Stop sends calling.record.stop to halt the active recording. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 198. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/pause.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/pause.mdx new file mode 100644 index 0000000000..770d590832 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/pause.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/pause" +title: "Pause" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RecordAction.Pause" + parent: "github.com/signalwire/signalwire-go/pkg/relay.RecordAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Pause` + +Pause pauses the active recording. An optional behavior string may be provided (e.g. "silence" or "skip") to control how the gap is handled. Pass no argument — or "" — to omit behavior, matching Python's pause(behavior: Optional\[str] = None) signature. + +## Signature + +```go +func (*RecordAction) Pause(behavior ...string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 228. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/resume.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/resume.mdx new file mode 100644 index 0000000000..acc8ff2fe0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/resume.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/resume" +title: "Resume" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RecordAction.Resume" + parent: "github.com/signalwire/signalwire-go/pkg/relay.RecordAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Resume` + +Resume resumes a paused recording. + +## Signature + +```go +func (*RecordAction) Resume() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 245. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/stop.mdx new file mode 100644 index 0000000000..067d18f308 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-action/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RecordAction.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.RecordAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Stop` + +Stop sends calling.record.stop to halt the active recording. + +## Signature + +```go +func (*RecordAction) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 212. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-event/index.mdx new file mode 100644 index 0000000000..765a2f0e31 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-event/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-event" +title: "RecordEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RecordEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `RecordEvent` + +RecordEvent represents a calling.call.record event. + +## Signature + +```go +type RecordEvent struct +``` + +## Properties + + + + + Duration is float64 (matching Python's float) to preserve subsecond precision. + + + + Record is the raw nested record dict from the wire payload, matching Python's record field. + + + + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 284. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-option.mdx new file mode 100644 index 0000000000..8f872c8a5b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/record-option" +title: "RecordOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RecordOption" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `RecordOption` + +RecordOption configures a Record call. + +## Signature + +```go +type RecordOption alias +``` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 54. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/refer-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/refer-event/index.mdx new file mode 100644 index 0000000000..7e6a5495af --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/refer-event/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/refer-event" +title: "ReferEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.ReferEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `ReferEvent` + +ReferEvent represents a calling.call.refer event. + +## Signature + +```go +type ReferEvent struct +``` + +## Properties + + + + + + + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 494. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-error/error.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-error/error.mdx new file mode 100644 index 0000000000..ed1e73b4f4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-error/error.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-error/error" +title: "Error" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RelayError.Error" + parent: "github.com/signalwire/signalwire-go/pkg/relay.RelayError" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/error.go" +--- +# `Error` + +Error implements the built-in error interface. Format matches Python's RelayError.**str**: "RELAY error \{code\}: \{message\}". + +## Signature + +```go +func (*RelayError) Error() string +``` + +## Returns + +`string` + +## Source + +[`pkg/relay/error.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/error.go) + +Line 18. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-error/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-error/index.mdx new file mode 100644 index 0000000000..ef0be57540 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-error/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-error" +title: "RelayError" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RelayError" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/error.go" +--- +# `RelayError` + +RelayError is a typed error returned by the RELAY protocol client. It carries the numeric code and message from the server so callers can programmatically inspect failures via errors.As. + +The error format matches Python's RelayError.**str**: "RELAY error \{code\}: \{message\}". + +## Signature + +```go +type RelayError struct +``` + +## Properties + + + + + +## Methods + + + + Error implements the built-in error interface. Format matches Python's RelayError.**str**: "RELAY error \{code\}: \{message\}". + + + +## Source + +[`pkg/relay/error.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/error.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-bool-ptr.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-bool-ptr.mdx new file mode 100644 index 0000000000..466e3a9a88 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-bool-ptr.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-bool-ptr" +title: "GetBoolPtr" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent.GetBoolPtr" + parent: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `GetBoolPtr` + +GetBoolPtr returns a \*bool for a key in params, or nil if the key is absent. This matches Python's Optional\[bool] = None semantics. + +## Signature + +```go +func (*RelayEvent) GetBoolPtr(key string) *bool +``` + +## Parameters + + + +## Returns + +`*bool` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 131. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-bool.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-bool.mdx new file mode 100644 index 0000000000..e7f7c3934d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-bool.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-bool" +title: "GetBool" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent.GetBool" + parent: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `GetBool` + +GetBool returns the boolean value for a key in params, or false if missing/wrong type. + +## Signature + +```go +func (*RelayEvent) GetBool(key string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 107. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-float64.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-float64.mdx new file mode 100644 index 0000000000..ff82cf0445 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-float64.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-float64" +title: "GetFloat64" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent.GetFloat64" + parent: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `GetFloat64` + +GetFloat64 returns the float64 value for a key in params, or 0.0 if missing/wrong type. This preserves subsecond precision for duration and timestamp fields. + +## Signature + +```go +func (*RelayEvent) GetFloat64(key string) float64 +``` + +## Parameters + + + +## Returns + +`float64` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 81. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-int.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-int.mdx new file mode 100644 index 0000000000..91c73c7225 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-int.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-int" +title: "GetInt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent.GetInt" + parent: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `GetInt` + +GetInt returns the integer value for a key in params, or 0 if missing/wrong type. + +## Signature + +```go +func (*RelayEvent) GetInt(key string) int +``` + +## Parameters + + + +## Returns + +`int` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 56. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-map.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-map.mdx new file mode 100644 index 0000000000..cb447d4d8c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-map.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-map" +title: "GetMap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent.GetMap" + parent: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `GetMap` + +GetMap returns the nested map for a key in params, or nil if missing/wrong type. + +## Signature + +```go +func (*RelayEvent) GetMap(key string) map[string]any +``` + +## Parameters + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 156. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-string-slice.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-string-slice.mdx new file mode 100644 index 0000000000..83dcbfc37f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-string-slice.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-string-slice" +title: "GetStringSlice" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent.GetStringSlice" + parent: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `GetStringSlice` + +GetStringSlice returns a \[]string for a key in params whose wire value is \[]any. Returns nil if absent or wrong type. Matches Python list\[str] field behavior. + +## Signature + +```go +func (*RelayEvent) GetStringSlice(key string) []string +``` + +## Parameters + + + +## Returns + +`[]string` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 173. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-string.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-string.mdx new file mode 100644 index 0000000000..eb93e3cf5d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-string.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/get-string" +title: "GetString" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent.GetString" + parent: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `GetString` + +GetString returns the string value for a key in params, or "" if missing/wrong type. + +## Signature + +```go +func (*RelayEvent) GetString(key string) string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 37. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/index.mdx new file mode 100644 index 0000000000..c0488a6525 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event/index.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/relay-event" +title: "RelayEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.RelayEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `RelayEvent` + +RelayEvent is the base event type for all events received from the SignalWire RELAY service. It carries an event type string and a generic parameter map that can be queried via helper methods. + +## Signature + +```go +type RelayEvent struct +``` + +## Properties + + + CallID is the call identifier, populated from the "call\_id" wire key. Python base class always carries this field. + + + + + + + + Timestamp is the event timestamp (float for subsecond precision), populated from the "timestamp" wire key. + + +## Methods + + + + GetBool returns the boolean value for a key in params, or false if missing/wrong type. + + + + GetBoolPtr returns a \*bool for a key in params, or nil if the key is absent. This matches Python's Optional\[bool] = None semantics. + + + + GetFloat64 returns the float64 value for a key in params, or 0.0 if missing/wrong type. This preserves subsecond precision for duration and timestamp fields. + + + + GetInt returns the integer value for a key in params, or 0 if missing/wrong type. + + + + GetMap returns the nested map for a key in params, or nil if missing/wrong type. + + + + GetString returns the string value for a key in params, or "" if missing/wrong type. + + + + GetStringSlice returns a \[]string for a key in params whose wire value is \[]any. Returns nil if absent or wrong type. Matches Python list\[str] field behavior. + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/send-digits-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/send-digits-event/index.mdx new file mode 100644 index 0000000000..0ffa22968d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/send-digits-event/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/send-digits-event" +title: "SendDigitsEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.SendDigitsEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `SendDigitsEvent` + +SendDigitsEvent represents a calling.call.send\_digits event. + +## Signature + +```go +type SendDigitsEvent struct +``` + +## Properties + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 451. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action/index.mdx new file mode 100644 index 0000000000..3456625477 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action" +title: "StandaloneCollectAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.StandaloneCollectAction" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `StandaloneCollectAction` + +StandaloneCollectAction represents a standalone collect (without play). + +## Signature + +```go +type StandaloneCollectAction struct +``` + +## Properties + + + +## Methods + + + + StartInputTimers starts the initial\_timeout timer on an active standalone collect, equivalent to Python's StandaloneCollectAction.start\_input\_timers(). + + + + Stop sends calling.collect.stop to halt the standalone collect operation. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 345. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action/start-input-timers.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..8b37c47e4d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action/start-input-timers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action/start-input-timers" +title: "StartInputTimers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.StandaloneCollectAction.StartInputTimers" + parent: "github.com/signalwire/signalwire-go/pkg/relay.StandaloneCollectAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `StartInputTimers` + +StartInputTimers starts the initial\_timeout timer on an active standalone collect, equivalent to Python's StandaloneCollectAction.start\_input\_timers(). + +## Signature + +```go +func (*StandaloneCollectAction) StartInputTimers() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 373. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action/stop.mdx new file mode 100644 index 0000000000..0b109f0403 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/standalone-collect-action/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.StandaloneCollectAction.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.StandaloneCollectAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Stop` + +Stop sends calling.collect.stop to halt the standalone collect operation. + +## Signature + +```go +func (*StandaloneCollectAction) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 359. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-action/index.mdx new file mode 100644 index 0000000000..314fb60f49 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-action" +title: "StreamAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.StreamAction" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `StreamAction` + +StreamAction represents a long-running media stream operation. + +## Signature + +```go +type StreamAction struct +``` + +## Properties + + + +## Methods + + + + Stop sends calling.stream.stop to halt the active stream operation. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 445. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-action/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-action/stop.mdx new file mode 100644 index 0000000000..81a4305447 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-action/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.StreamAction.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.StreamAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Stop` + +Stop sends calling.stream.stop to halt the active stream operation. + +## Signature + +```go +func (*StreamAction) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 457. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-event/index.mdx new file mode 100644 index 0000000000..7558164377 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-event/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-event" +title: "StreamEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.StreamEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `StreamEvent` + +StreamEvent represents a calling.call.stream event. + +## Signature + +```go +type StreamEvent struct +``` + +## Properties + + + + + Name is the stream name, matching Python's name field. + + + + + + + + URL is the stream URL, matching Python's url field. + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 428. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-option.mdx new file mode 100644 index 0000000000..ad32447b75 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/stream-option" +title: "StreamOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.StreamOption" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `StreamOption` + +StreamOption configures a Stream call. + +## Signature + +```go +type StreamOption alias +``` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 141. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-action/index.mdx new file mode 100644 index 0000000000..32ed006f7d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-action" +title: "TapAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.TapAction" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `TapAction` + +TapAction represents a long-running tap operation. + +## Signature + +```go +type TapAction struct +``` + +## Properties + + + +## Methods + + + + Stop sends calling.tap.stop to halt the active tap operation. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 420. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-action/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-action/stop.mdx new file mode 100644 index 0000000000..bb128f6fd8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-action/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.TapAction.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.TapAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Stop` + +Stop sends calling.tap.stop to halt the active tap operation. + +## Signature + +```go +func (*TapAction) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 432. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-event/index.mdx new file mode 100644 index 0000000000..6c1aa2d299 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-event/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/tap-event" +title: "TapEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.TapEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `TapEvent` + +TapEvent represents a calling.call.tap event. + +## Signature + +```go +type TapEvent struct +``` + +## Properties + + + + + Device is the tap device dict, matching Python's device field. + + + + + + + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 406. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-action/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-action/index.mdx new file mode 100644 index 0000000000..c4c780e79b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-action" +title: "TranscribeAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.TranscribeAction" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `TranscribeAction` + +TranscribeAction represents a long-running transcription operation. + +## Signature + +```go +type TranscribeAction struct +``` + +## Properties + + + +## Methods + + + + Stop sends calling.transcribe.stop to halt the active transcription. + + + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 495. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-action/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-action/stop.mdx new file mode 100644 index 0000000000..233be77104 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-action/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.TranscribeAction.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/relay.TranscribeAction" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go" +--- +# `Stop` + +Stop sends calling.transcribe.stop to halt the active transcription. + +## Signature + +```go +func (*TranscribeAction) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/relay/action.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/action.go) + +Line 508. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-event/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-event/index.mdx new file mode 100644 index 0000000000..28c4b7370c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-event/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/transcribe-event" +title: "TranscribeEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.TranscribeEvent" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go" +--- +# `TranscribeEvent` + +TranscribeEvent represents a calling.call.transcribe event. + +## Signature + +```go +type TranscribeEvent struct +``` + +## Properties + + + + + Duration is float64 for subsecond precision, matching Python's duration: float field. + + + + RecordingID is the recording identifier, matching Python's recording\_id field. + + + + + + Size is the recording size in bytes, matching Python's size field. + + + + + + + + URL is the transcription recording URL, matching Python's url field. + + +## Source + +[`pkg/relay/event.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/event.go) + +Line 603. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-control-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-control-id.mdx new file mode 100644 index 0000000000..70a8cc4f4d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-control-id.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-control-id" +title: "WithAIControlID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithAIControlID" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithAIControlID` + +WithAIControlID supplies an explicit control\_id for the AI action, matching Python's ai(control\_id=...). + +## Signature + +```go +func WithAIControlID(id string) AIOption +``` + +## Parameters + + + +## Returns + +`AIOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 304. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-engine.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-engine.mdx new file mode 100644 index 0000000000..fe01884ca4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-engine.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-engine" +title: "WithAIEngine" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithAIEngine" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithAIEngine` + +WithAIEngine sets the AI engine to use. + +## Signature + +```go +func WithAIEngine(engine string) AIOption +``` + +## Parameters + + + +## Returns + +`AIOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 309. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-params.mdx new file mode 100644 index 0000000000..757379ce62 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-params.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-params" +title: "WithAIParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithAIParams" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithAIParams` + +WithAIParams sets arbitrary AI parameters. + +## Signature + +```go +func WithAIParams(params map[string]any) AIOption +``` + +## Parameters + + + +## Returns + +`AIOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 330. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-post-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-post-prompt.mdx new file mode 100644 index 0000000000..bf814990b0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-post-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-post-prompt" +title: "WithAIPostPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithAIPostPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithAIPostPrompt` + +WithAIPostPrompt sets the AI post-prompt configuration. + +## Signature + +```go +func WithAIPostPrompt(pp map[string]any) AIOption +``` + +## Parameters + + + +## Returns + +`AIOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 323. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-prompt.mdx new file mode 100644 index 0000000000..0e57be6580 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-ai-prompt" +title: "WithAIPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithAIPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithAIPrompt` + +WithAIPrompt sets the AI prompt text. + +## Signature + +```go +func WithAIPrompt(prompt map[string]any) AIOption +``` + +## Parameters + + + +## Returns + +`AIOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 316. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-beep.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-beep.mdx new file mode 100644 index 0000000000..ad7dd87f7c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-beep.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-beep" +title: "WithConferenceBeep" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithConferenceBeep" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithConferenceBeep` + +WithConferenceBeep enables beep on join/leave. + +## Signature + +```go +func WithConferenceBeep(beep string) ConferenceOption +``` + +## Parameters + + + +## Returns + +`ConferenceOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 167. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-deaf.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-deaf.mdx new file mode 100644 index 0000000000..b4b7bff8c1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-deaf.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-deaf" +title: "WithConferenceDeaf" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithConferenceDeaf" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithConferenceDeaf` + +WithConferenceDeaf joins deaf (cannot hear others). + +## Signature + +```go +func WithConferenceDeaf(deaf bool) ConferenceOption +``` + +## Parameters + + + +## Returns + +`ConferenceOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 181. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-muted.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-muted.mdx new file mode 100644 index 0000000000..20fcb6eaba --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-muted.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-conference-muted" +title: "WithConferenceMuted" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithConferenceMuted" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithConferenceMuted` + +WithConferenceMuted joins muted. + +## Signature + +```go +func WithConferenceMuted(muted bool) ConferenceOption +``` + +## Parameters + + + +## Returns + +`ConferenceOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 174. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-connect-ringback.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-connect-ringback.mdx new file mode 100644 index 0000000000..812a9a39af --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-connect-ringback.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-connect-ringback" +title: "WithConnectRingback" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithConnectRingback" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithConnectRingback` + +WithConnectRingback sets ringback media for the connect operation. + +## Signature + +```go +func WithConnectRingback(media []map[string]any) ConnectOption +``` + +## Parameters + + + +## Returns + +`ConnectOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 134. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-contexts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-contexts.mdx new file mode 100644 index 0000000000..2485cd8662 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-contexts" +title: "WithContexts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithContexts" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithContexts` + +WithContexts sets the contexts to subscribe to for inbound events. + +## Signature + +```go +func WithContexts(contexts ...string) ClientOption +``` + +## Parameters + + + +## Returns + +`ClientOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 374. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-client-timeout.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-client-timeout.mdx new file mode 100644 index 0000000000..bbf8bc6112 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-client-timeout.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-client-timeout" +title: "WithDialClientTimeout" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithDialClientTimeout" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithDialClientTimeout` + +WithDialClientTimeout bounds how long Dial() will wait for the calling.call.dial event before raising a timeout error. Mirrors Python's dial(dial\_timeout=\). Default is 120s when omitted. + +The duration is consumed by the Go Dial() loop; it never goes on the wire — that's why it's stored under an underscore-prefixed key removed before transmit. + +## Signature + +```go +func WithDialClientTimeout(d time.Duration) DialOption +``` + +## Parameters + + + +## Returns + +`DialOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 422. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-from-number.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-from-number.mdx new file mode 100644 index 0000000000..f6d5ffd586 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-from-number.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-from-number" +title: "WithDialFromNumber" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithDialFromNumber" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithDialFromNumber` + +WithDialFromNumber sets the caller ID for the outbound call. + +## Signature + +```go +func WithDialFromNumber(from string) DialOption +``` + +## Parameters + + + +## Returns + +`DialOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 391. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-max-duration.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-max-duration.mdx new file mode 100644 index 0000000000..6a45a19744 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-max-duration.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-max-duration" +title: "WithDialMaxDuration" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithDialMaxDuration" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithDialMaxDuration` + +WithDialMaxDuration sets the maximum call duration in minutes. Mirrors Python's dial(max\_duration=...) parameter. + +## Signature + +```go +func WithDialMaxDuration(minutes int) DialOption +``` + +## Parameters + + + +## Returns + +`DialOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 430. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-tag.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-tag.mdx new file mode 100644 index 0000000000..bd961e53ea --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-tag.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-tag" +title: "WithDialTag" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithDialTag" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithDialTag` + +WithDialTag sets an explicit caller-supplied dial tag. When omitted the SDK generates a UUID, mirroring Python's `tag = tag or str(uuid.uuid4())` at relay/client.py:368. + +## Signature + +```go +func WithDialTag(tag string) DialOption +``` + +## Parameters + + + +## Returns + +`DialOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 409. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-timeout.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-timeout.mdx new file mode 100644 index 0000000000..7f585c764d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-timeout.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-dial-timeout" +title: "WithDialTimeout" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithDialTimeout" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithDialTimeout` + +WithDialTimeout sets the legacy per-leg dial timeout in seconds. (Was the only Go option; retained for back-compat. To bound the overall Dial() call use WithDialClientTimeout.) + +## Signature + +```go +func WithDialTimeout(t int) DialOption +``` + +## Parameters + + + +## Returns + +`DialOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 400. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-env-defaults.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-env-defaults.mdx new file mode 100644 index 0000000000..7a09bca8e4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-env-defaults.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-env-defaults" +title: "WithEnvDefaults" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithEnvDefaults" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithEnvDefaults` + +WithEnvDefaults is now a no-op pass-through retained for backwards compatibility — env defaults are loaded automatically at the end of NewRelayClient (mirroring Python RelayClient.**init**). New code can rely on the auto-load behavior and omit this option entirely. + +## Signature + +```go +func WithEnvDefaults() ClientOption +``` + +## Returns + +`ClientOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 519. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-fax-control-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-fax-control-id.mdx new file mode 100644 index 0000000000..a72dff0019 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-fax-control-id.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-fax-control-id" +title: "WithFaxControlID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithFaxControlID" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithFaxControlID` + +WithFaxControlID supplies an explicit control\_id for the fax action, matching Python's send\_fax(control\_id=...) / receive\_fax(control\_id=...). + +## Signature + +```go +func WithFaxControlID(id string) FaxOption +``` + +## Parameters + + + +## Returns + +`FaxOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 201. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-fax-header-info.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-fax-header-info.mdx new file mode 100644 index 0000000000..d596c0d524 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-fax-header-info.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-fax-header-info" +title: "WithFaxHeaderInfo" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithFaxHeaderInfo" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithFaxHeaderInfo` + +WithFaxHeaderInfo sets the fax header info string (matches Python's header\_info param). + +## Signature + +```go +func WithFaxHeaderInfo(headerInfo string) FaxOption +``` + +## Parameters + + + +## Returns + +`FaxOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 191. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-jwt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-jwt.mdx new file mode 100644 index 0000000000..768b1b5a98 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-jwt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-jwt" +title: "WithJWT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithJWT" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithJWT` + +WithJWT sets a pre-existing JWT for authentication. + +## Signature + +```go +func WithJWT(jwt string) ClientOption +``` + +## Parameters + + + +## Returns + +`ClientOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 360. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-max-active-calls.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-max-active-calls.mdx new file mode 100644 index 0000000000..e70df5afce --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-max-active-calls.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-max-active-calls" +title: "WithMaxActiveCalls" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithMaxActiveCalls" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithMaxActiveCalls` + +WithMaxActiveCalls limits the number of concurrent active calls. + +## Signature + +```go +func WithMaxActiveCalls(n int) ClientOption +``` + +## Parameters + + + +## Returns + +`ClientOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 381. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-context.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-context.mdx new file mode 100644 index 0000000000..5c6553c35a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-context.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-context" +title: "WithMessageContext" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithMessageContext" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithMessageContext` + +WithMessageContext sets the routing context for the message. Mirrors Python's send\_message(context=...) parameter — defaults to the relay protocol when omitted. + +## Signature + +```go +func WithMessageContext(ctx string) MessageOption +``` + +## Parameters + + + +## Returns + +`MessageOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 463. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-media.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-media.mdx new file mode 100644 index 0000000000..b64e244b14 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-media.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-media" +title: "WithMessageMedia" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithMessageMedia" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithMessageMedia` + +WithMessageMedia adds media URLs to the message (MMS). + +## Signature + +```go +func WithMessageMedia(urls []string) MessageOption +``` + +## Parameters + + + +## Returns + +`MessageOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 440. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-on-completed.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-on-completed.mdx new file mode 100644 index 0000000000..c850e6e2f5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-on-completed.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-on-completed" +title: "WithMessageOnCompleted" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithMessageOnCompleted" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithMessageOnCompleted` + +WithMessageOnCompleted registers a callback invoked when the message reaches a terminal state (delivered, undelivered, or failed). The callback receives both the message and the terminal RelayEvent, mirroring Python's \_on\_completed callback contract (relay/message.py:115-117) which receives the event directly. Mirrors Python's send\_message(on\_completed=...) parameter. + +## Signature + +```go +func WithMessageOnCompleted(cb func(*Message, *RelayEvent)) MessageOption +``` + +## Parameters + + + +## Returns + +`MessageOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 474. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-region.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-region.mdx new file mode 100644 index 0000000000..bf145cae6d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-region.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-region" +title: "WithMessageRegion" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithMessageRegion" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithMessageRegion` + +WithMessageRegion sets the region for message delivery. + +## Signature + +```go +func WithMessageRegion(region string) MessageOption +``` + +## Parameters + + + +## Returns + +`MessageOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 447. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-tags.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-tags.mdx new file mode 100644 index 0000000000..78c77c5316 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-tags.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-message-tags" +title: "WithMessageTags" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithMessageTags" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithMessageTags` + +WithMessageTags sets tags on the message for tracking. + +## Signature + +```go +func WithMessageTags(tags []string) MessageOption +``` + +## Parameters + + + +## Returns + +`MessageOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 454. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-charge-amount.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-charge-amount.mdx new file mode 100644 index 0000000000..89418b9ba7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-charge-amount.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-charge-amount" +title: "WithPayChargeAmount" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayChargeAmount" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayChargeAmount` + +WithPayChargeAmount sets the charge amount. + +## Signature + +```go +func WithPayChargeAmount(amount string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 260. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-control-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-control-id.mdx new file mode 100644 index 0000000000..a8df8cfa72 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-control-id.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-control-id" +title: "WithPayControlID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayControlID" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayControlID` + +WithPayControlID supplies an explicit control\_id for the pay action, matching Python's pay(control\_id=...). + +## Signature + +```go +func WithPayControlID(id string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 210. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-currency.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-currency.mdx new file mode 100644 index 0000000000..d0fc8d4dbd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-currency.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-currency" +title: "WithPayCurrency" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayCurrency" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayCurrency` + +WithPayCurrency sets the payment currency. + +## Signature + +```go +func WithPayCurrency(currency string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 265. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-description.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-description.mdx new file mode 100644 index 0000000000..20618f905c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-description.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-description" +title: "WithPayDescription" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayDescription" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayDescription` + +WithPayDescription sets a description for the payment. + +## Signature + +```go +func WithPayDescription(desc string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 280. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-input-method.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-input-method.mdx new file mode 100644 index 0000000000..cfd1e2fe0a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-input-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-input-method" +title: "WithPayInputMethod" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayInputMethod" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayInputMethod` + +WithPayInputMethod sets the payment input method. + +## Signature + +```go +func WithPayInputMethod(method string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 215. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-language.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-language.mdx new file mode 100644 index 0000000000..075e32a4e0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-language.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-language" +title: "WithPayLanguage" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayLanguage" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayLanguage` + +WithPayLanguage sets the language for payment prompts. + +## Signature + +```go +func WithPayLanguage(language string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 270. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-max-attempts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-max-attempts.mdx new file mode 100644 index 0000000000..45df540f48 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-max-attempts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-max-attempts" +title: "WithPayMaxAttempts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayMaxAttempts" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayMaxAttempts` + +WithPayMaxAttempts sets the maximum number of payment attempts. + +## Signature + +```go +func WithPayMaxAttempts(max string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 235. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-min-postal-code-length.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-min-postal-code-length.mdx new file mode 100644 index 0000000000..d5f0672324 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-min-postal-code-length.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-min-postal-code-length" +title: "WithPayMinPostalCodeLength" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayMinPostalCodeLength" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayMinPostalCodeLength` + +WithPayMinPostalCodeLength sets the minimum postal code length. + +## Signature + +```go +func WithPayMinPostalCodeLength(length string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 250. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-parameters.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-parameters.mdx new file mode 100644 index 0000000000..a781669f1f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-parameters.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-parameters" +title: "WithPayParameters" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayParameters" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayParameters` + +WithPayParameters sets additional payment parameters. + +## Signature + +```go +func WithPayParameters(parameters []map[string]any) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 290. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-payment-method.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-payment-method.mdx new file mode 100644 index 0000000000..29943f2308 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-payment-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-payment-method" +title: "WithPayPaymentMethod" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayPaymentMethod" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayPaymentMethod` + +WithPayPaymentMethod sets the payment method (e.g. "credit-card"). + +## Signature + +```go +func WithPayPaymentMethod(method string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 225. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-postal-code.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-postal-code.mdx new file mode 100644 index 0000000000..0f0f07fac0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-postal-code.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-postal-code" +title: "WithPayPostalCode" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayPostalCode" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayPostalCode` + +WithPayPostalCode sets whether to collect postal code. + +## Signature + +```go +func WithPayPostalCode(code string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 245. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-prompts.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-prompts.mdx new file mode 100644 index 0000000000..c397f2edd4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-prompts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-prompts" +title: "WithPayPrompts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayPrompts" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayPrompts` + +WithPayPrompts sets custom payment prompts. + +## Signature + +```go +func WithPayPrompts(prompts []map[string]any) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 295. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-security-code.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-security-code.mdx new file mode 100644 index 0000000000..e90280547b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-security-code.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-security-code" +title: "WithPaySecurityCode" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPaySecurityCode" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPaySecurityCode` + +WithPaySecurityCode sets whether to collect security code. + +## Signature + +```go +func WithPaySecurityCode(code string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 240. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-status-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-status-url.mdx new file mode 100644 index 0000000000..af0c0c1f24 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-status-url.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-status-url" +title: "WithPayStatusURL" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayStatusURL" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayStatusURL` + +WithPayStatusURL sets the payment status callback URL. + +## Signature + +```go +func WithPayStatusURL(url string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 220. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-timeout.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-timeout.mdx new file mode 100644 index 0000000000..c4e4899720 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-timeout.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-timeout" +title: "WithPayTimeout" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayTimeout" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayTimeout` + +WithPayTimeout sets the timeout string for the payment session. + +## Signature + +```go +func WithPayTimeout(timeout string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 230. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-token-type.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-token-type.mdx new file mode 100644 index 0000000000..fb08c1162f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-token-type.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-token-type" +title: "WithPayTokenType" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayTokenType" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayTokenType` + +WithPayTokenType sets the payment token type. + +## Signature + +```go +func WithPayTokenType(tokenType string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 255. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-valid-card-types.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-valid-card-types.mdx new file mode 100644 index 0000000000..63cb55925a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-valid-card-types.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-valid-card-types" +title: "WithPayValidCardTypes" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayValidCardTypes" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayValidCardTypes` + +WithPayValidCardTypes sets the valid card types string. + +## Signature + +```go +func WithPayValidCardTypes(types string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 285. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-voice.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-voice.mdx new file mode 100644 index 0000000000..3f3dc1f955 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-voice.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-pay-voice" +title: "WithPayVoice" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPayVoice" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPayVoice` + +WithPayVoice sets the voice for payment prompts. + +## Signature + +```go +func WithPayVoice(voice string) PayOption +``` + +## Parameters + + + +## Returns + +`PayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 275. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-control-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-control-id.mdx new file mode 100644 index 0000000000..a305c3f87c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-control-id.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-control-id" +title: "WithPlayControlID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPlayControlID" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPlayControlID` + +WithPlayControlID sets an explicit control\_id for the play action. Mirrors Python's play(control\_id=...). When omitted the SDK auto-generates a UUID. The same key is honored by play\_and\_collect. + +## Signature + +```go +func WithPlayControlID(id string) PlayOption +``` + +## Parameters + + + +## Returns + +`PlayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 25. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-direction.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-direction.mdx new file mode 100644 index 0000000000..2651cacbe8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-direction.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-direction" +title: "WithPlayDirection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPlayDirection" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPlayDirection` + +WithPlayDirection sets the play direction (e.g. "self" / "peer" / "both"). + +## Signature + +```go +func WithPlayDirection(dir string) PlayOption +``` + +## Parameters + + + +## Returns + +`PlayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 32. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-loop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-loop.mdx new file mode 100644 index 0000000000..654735b8a5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-loop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-loop" +title: "WithPlayLoop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPlayLoop" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPlayLoop` + +WithPlayLoop sets the number of loop iterations for playback. + +## Signature + +```go +func WithPlayLoop(n int) PlayOption +``` + +## Parameters + + + +## Returns + +`PlayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 39. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-on-completed.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-on-completed.mdx new file mode 100644 index 0000000000..c3e5cb7c08 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-on-completed.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-on-completed" +title: "WithPlayOnCompleted" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPlayOnCompleted" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPlayOnCompleted` + +WithPlayOnCompleted registers a callback fired when the play action reaches a terminal state. Mirrors Python's play(on\_completed=...). + +## Signature + +```go +func WithPlayOnCompleted(cb func(*RelayEvent)) PlayOption +``` + +## Parameters + + + +## Returns + +`PlayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 47. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-volume.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-volume.mdx new file mode 100644 index 0000000000..b05765aa3b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-volume.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-play-volume" +title: "WithPlayVolume" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithPlayVolume" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithPlayVolume` + +WithPlayVolume sets the volume for playback in dB. + +## Signature + +```go +func WithPlayVolume(db float64) PlayOption +``` + +## Parameters + + + +## Returns + +`PlayOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-project.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-project.mdx new file mode 100644 index 0000000000..b5711cc194 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-project.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-project" +title: "WithProject" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithProject" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithProject` + +WithProject sets the project ID for authentication. + +## Signature + +```go +func WithProject(id string) ClientOption +``` + +## Parameters + + + +## Returns + +`ClientOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 346. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-audio.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-audio.mdx new file mode 100644 index 0000000000..72c9f7fe35 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-audio.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-audio" +title: "WithRecordAudio" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithRecordAudio" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithRecordAudio` + +WithRecordAudio sets the audio config map for the record action's "record": \{"audio": ...\} payload. Mirrors Python's record(audio=...). + +## Signature + +```go +func WithRecordAudio(audio map[string]any) RecordOption +``` + +## Parameters + + + +## Returns + +`RecordOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 115. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-beep.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-beep.mdx new file mode 100644 index 0000000000..da84417242 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-beep.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-beep" +title: "WithRecordBeep" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithRecordBeep" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithRecordBeep` + +WithRecordBeep enables a beep before recording. + +## Signature + +```go +func WithRecordBeep(beep bool) RecordOption +``` + +## Parameters + + + +## Returns + +`RecordOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 57. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-control-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-control-id.mdx new file mode 100644 index 0000000000..29ff2e2d2a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-control-id.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-control-id" +title: "WithRecordControlID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithRecordControlID" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithRecordControlID` + +WithRecordControlID sets an explicit control\_id for the record action. Mirrors Python's record(control\_id=...). + +## Signature + +```go +func WithRecordControlID(id string) RecordOption +``` + +## Parameters + + + +## Returns + +`RecordOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 107. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-direction.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-direction.mdx new file mode 100644 index 0000000000..e8d1c646b5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-direction.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-direction" +title: "WithRecordDirection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithRecordDirection" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithRecordDirection` + +WithRecordDirection sets the recording direction ("listen", "speak", "both"). + +## Signature + +```go +func WithRecordDirection(dir string) RecordOption +``` + +## Parameters + + + +## Returns + +`RecordOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 78. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-end-silence-timeout.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-end-silence-timeout.mdx new file mode 100644 index 0000000000..22e94657d2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-end-silence-timeout.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-end-silence-timeout" +title: "WithRecordEndSilenceTimeout" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithRecordEndSilenceTimeout" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithRecordEndSilenceTimeout` + +WithRecordEndSilenceTimeout sets the end-of-speech silence timeout in seconds. + +## Signature + +```go +func WithRecordEndSilenceTimeout(t float64) RecordOption +``` + +## Parameters + + + +## Returns + +`RecordOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 99. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-format.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-format.mdx new file mode 100644 index 0000000000..6168e9cd63 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-format.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-format" +title: "WithRecordFormat" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithRecordFormat" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithRecordFormat` + +WithRecordFormat sets the recording format (e.g. "wav", "mp3"). + +## Signature + +```go +func WithRecordFormat(format string) RecordOption +``` + +## Parameters + + + +## Returns + +`RecordOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 64. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-initial-timeout.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-initial-timeout.mdx new file mode 100644 index 0000000000..bf31a1e1d2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-initial-timeout.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-initial-timeout" +title: "WithRecordInitialTimeout" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithRecordInitialTimeout" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithRecordInitialTimeout` + +WithRecordInitialTimeout sets the initial timeout in seconds. + +## Signature + +```go +func WithRecordInitialTimeout(t float64) RecordOption +``` + +## Parameters + + + +## Returns + +`RecordOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 92. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-on-completed.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-on-completed.mdx new file mode 100644 index 0000000000..19c595c58a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-on-completed.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-on-completed" +title: "WithRecordOnCompleted" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithRecordOnCompleted" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithRecordOnCompleted` + +WithRecordOnCompleted registers a callback fired when the record action reaches a terminal state. Mirrors Python's record(on\_completed=...). + +## Signature + +```go +func WithRecordOnCompleted(cb func(*RelayEvent)) RecordOption +``` + +## Parameters + + + +## Returns + +`RecordOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 124. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-stereo.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-stereo.mdx new file mode 100644 index 0000000000..5df8100a3b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-stereo.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-stereo" +title: "WithRecordStereo" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithRecordStereo" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithRecordStereo` + +WithRecordStereo enables stereo recording. + +## Signature + +```go +func WithRecordStereo(stereo bool) RecordOption +``` + +## Parameters + + + +## Returns + +`RecordOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 71. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-terminators.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-terminators.mdx new file mode 100644 index 0000000000..cf3a962308 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-terminators.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-record-terminators" +title: "WithRecordTerminators" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithRecordTerminators" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithRecordTerminators` + +WithRecordTerminators sets DTMF terminators to stop recording. + +## Signature + +```go +func WithRecordTerminators(terminators string) RecordOption +``` + +## Parameters + + + +## Returns + +`RecordOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 85. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-space.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-space.mdx new file mode 100644 index 0000000000..097ae50439 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-space.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-space" +title: "WithSpace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithSpace" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithSpace` + +WithSpace sets the SignalWire space (e.g. "example.signalwire.com"). + +## Signature + +```go +func WithSpace(space string) ClientOption +``` + +## Parameters + + + +## Returns + +`ClientOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 367. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-codec.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-codec.mdx new file mode 100644 index 0000000000..e437b2ae0a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-codec.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-codec" +title: "WithStreamCodec" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithStreamCodec" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithStreamCodec` + +WithStreamCodec sets the stream audio codec. + +## Signature + +```go +func WithStreamCodec(codec string) StreamOption +``` + +## Parameters + + + +## Returns + +`StreamOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 157. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-control-id.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-control-id.mdx new file mode 100644 index 0000000000..e0ae5f8c80 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-control-id.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-control-id" +title: "WithStreamControlID" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithStreamControlID" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithStreamControlID` + +WithStreamControlID supplies an explicit control\_id for the stream action, matching Python's stream(control\_id=...). + +## Signature + +```go +func WithStreamControlID(id string) StreamOption +``` + +## Parameters + + + +## Returns + +`StreamOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 145. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-direction.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-direction.mdx new file mode 100644 index 0000000000..1ecc32d754 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-direction.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-stream-direction" +title: "WithStreamDirection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithStreamDirection" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithStreamDirection` + +WithStreamDirection sets the stream direction. + +## Signature + +```go +func WithStreamDirection(dir string) StreamOption +``` + +## Parameters + + + +## Returns + +`StreamOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 150. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-token.mdx new file mode 100644 index 0000000000..d7d95d0155 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay/with-token" +title: "WithToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/relay.WithToken" + parent: "github.com/signalwire/signalwire-go/pkg/relay" + module: "github.com.signalwire.signalwire-go.pkg.relay" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go" +--- +# `WithToken` + +WithToken sets the API token for authentication. + +## Signature + +```go +func WithToken(token string) ClientOption +``` + +## Parameters + + + +## Returns + +`ClientOption` + +## Source + +[`pkg/relay/options.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/relay/options.go) + +Line 353. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/create.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/create.mdx new file mode 100644 index 0000000000..68aee15659 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/create.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/create" +title: "Create" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AddressesNamespace.Create" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AddressesNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go" +--- +# `Create` + +Create creates a new address. + +## Signature + +```go +func (*AddressesNamespace) Create(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/addresses.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go) + +Line 28. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/delete.mdx new file mode 100644 index 0000000000..970dba2b29 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AddressesNamespace.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AddressesNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go" +--- +# `Delete` + +Delete removes an address by ID. + +## Signature + +```go +func (*AddressesNamespace) Delete(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/addresses.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go) + +Line 38. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/get.mdx new file mode 100644 index 0000000000..eeb6bce4ae --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AddressesNamespace.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AddressesNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go" +--- +# `Get` + +Get retrieves an address by ID. + +## Signature + +```go +func (*AddressesNamespace) Get(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/addresses.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go) + +Line 33. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/index.mdx new file mode 100644 index 0000000000..cc681cccec --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace" +title: "AddressesNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AddressesNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go" +--- +# `AddressesNamespace` + +AddressesNamespace provides address management (no update endpoint). + +## Signature + +```go +type AddressesNamespace struct +``` + +## Properties + + + +## Methods + + + + Create creates a new address. + + + + Delete removes an address by ID. + + + + Get retrieves an address by ID. + + + + List lists all addresses. + + + +## Source + +[`pkg/rest/namespaces/addresses.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/list.mdx new file mode 100644 index 0000000000..3d550065bd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-namespace/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AddressesNamespace.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AddressesNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go" +--- +# `List` + +List lists all addresses. + +## Signature + +```go +func (*AddressesNamespace) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/addresses.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-resource.mdx new file mode 100644 index 0000000000..d05b947edb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/addresses-resource" +title: "AddressesResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AddressesResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go" +--- +# `AddressesResource` + +AddressesResource is an alias for AddressesNamespace, matching the Python class name for cross-SDK parity. Prefer AddressesNamespace in new Go code. + +## Signature + +```go +type AddressesResource alias +``` + +## Source + +[`pkg/rest/namespaces/addresses.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go) + +Line 44. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/all-phone-call-handlers.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/all-phone-call-handlers.mdx new file mode 100644 index 0000000000..5aacfddbbb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/all-phone-call-handlers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/all-phone-call-handlers" +title: "AllPhoneCallHandlers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AllPhoneCallHandlers" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/call_handler.go" +--- +# `AllPhoneCallHandlers` + +AllPhoneCallHandlers returns every PhoneCallHandler value. Useful for enum-contract tests and for callers that need to validate or enumerate the set. + +## Signature + +```go +func AllPhoneCallHandlers() []PhoneCallHandler +``` + +## Returns + +`[]PhoneCallHandler` + +## Source + +[`pkg/rest/namespaces/call_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/call_handler.go) + +Line 58. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/auto-materialized-webhook-resource/create.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/auto-materialized-webhook-resource/create.mdx new file mode 100644 index 0000000000..f8a7458bfc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/auto-materialized-webhook-resource/create.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/auto-materialized-webhook-resource/create" +title: "Create" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AutoMaterializedWebhookResource.Create" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AutoMaterializedWebhookResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" + deprecated: true +--- +# `Create` + + + **Deprecated.** Creating a webhook Fabric resource directly produces an orphan not bound to any phone number. Use phone\_numbers.SetSwmlWebhook or phone\_numbers.SetCxmlWebhook instead; setting call\_handler on the phone number causes the server to auto-materialize the webhook resource. See porting-sdk's phone-binding.md. + + +Create sends a POST to create a new webhook resource. + +## Signature + +```go +func (*AutoMaterializedWebhookResource) Create(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 199. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/auto-materialized-webhook-resource/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/auto-materialized-webhook-resource/index.mdx new file mode 100644 index 0000000000..4ec703e342 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/auto-materialized-webhook-resource/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/auto-materialized-webhook-resource" +title: "AutoMaterializedWebhookResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.AutoMaterializedWebhookResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `AutoMaterializedWebhookResource` + +AutoMaterializedWebhookResource is a Fabric webhook resource that is normally auto-created by the phone\_numbers.Set\*Webhook helpers. Exposed for backwards compatibility: list/get/update/delete work as usual, but Create now emits a deprecation warning because creating a webhook resource directly produces an orphan that isn't bound to any phone number. + +## Signature + +```go +type AutoMaterializedWebhookResource struct +``` + +## Properties + + + +## Methods + + + + Create sends a POST to create a new webhook resource. + + + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 182. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flow-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flow-options/index.mdx new file mode 100644 index 0000000000..695a8a0812 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flow-options/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flow-options" +title: "CallFlowOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallFlowOptions" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `CallFlowOptions` + +CallFlowOptions holds optional fields for SetCallFlow. + +## Signature + +```go +type CallFlowOptions struct +``` + +## Properties + + + Extra passes through additional wire-level fields. + + + + Version accepts "working\_copy" or "current\_deployed" (server default when omitted). + + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 125. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/deploy-version.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/deploy-version.mdx new file mode 100644 index 0000000000..8030aca9f5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/deploy-version.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/deploy-version" +title: "DeployVersion" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallFlowsResource.DeployVersion" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallFlowsResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `DeployVersion` + +DeployVersion deploys a new version of a call flow. + +## Signature + +```go +func (*CallFlowsResource) DeployVersion(id string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 94. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/index.mdx new file mode 100644 index 0000000000..f5bd32b747 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource" +title: "CallFlowsResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallFlowsResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `CallFlowsResource` + +CallFlowsResource extends CrudResource with version management and a singular sub-resource path convention. + +## Signature + +```go +type CallFlowsResource struct +``` + +## Properties + + + +## Methods + + + + DeployVersion deploys a new version of a call flow. + + + + ListAddresses lists addresses for a call flow (uses singular "call\_flow" path). + + + + ListVersions lists versions of a call flow. + + + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 77. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/list-addresses.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/list-addresses.mdx new file mode 100644 index 0000000000..5de3fe6b60 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/list-addresses.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/list-addresses" +title: "ListAddresses" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallFlowsResource.ListAddresses" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallFlowsResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `ListAddresses` + +ListAddresses lists addresses for a call flow (uses singular "call\_flow" path). + +## Signature + +```go +func (*CallFlowsResource) ListAddresses(id string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 82. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/list-versions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/list-versions.mdx new file mode 100644 index 0000000000..970098edd6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/list-versions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/call-flows-resource/list-versions" +title: "ListVersions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallFlowsResource.ListVersions" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallFlowsResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `ListVersions` + +ListVersions lists versions of a call flow. + +## Signature + +```go +func (*CallFlowsResource) ListVersions(id string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 88. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-hold.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-hold.mdx new file mode 100644 index 0000000000..68e24cb075 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-hold.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-hold" +title: "AIHold" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.AIHold" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `AIHold` + +AIHold puts the AI on hold. + +## Signature + +```go +func (*CallingNamespace) AIHold(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 196. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-message.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-message.mdx new file mode 100644 index 0000000000..45f7a1c81b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-message.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-message" +title: "AIMessage" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.AIMessage" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `AIMessage` + +AIMessage sends a message to the AI agent on a call. + +## Signature + +```go +func (*CallingNamespace) AIMessage(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 191. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-stop.mdx new file mode 100644 index 0000000000..e22951dfdb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-stop.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-stop" +title: "AIStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.AIStop" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `AIStop` + +AIStop stops the AI session. + +## Signature + +```go +func (*CallingNamespace) AIStop(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 206. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-unhold.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-unhold.mdx new file mode 100644 index 0000000000..940e0ec83e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-unhold.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/ai-unhold" +title: "AIUnhold" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.AIUnhold" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `AIUnhold` + +AIUnhold takes the AI off hold. + +## Signature + +```go +func (*CallingNamespace) AIUnhold(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 201. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect-start-input-timers.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect-start-input-timers.mdx new file mode 100644 index 0000000000..a5e9832c00 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect-start-input-timers.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect-start-input-timers" +title: "CollectStartInputTimers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.CollectStartInputTimers" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `CollectStartInputTimers` + +CollectStartInputTimers starts input timers for collection. + +## Signature + +```go +func (*CallingNamespace) CollectStartInputTimers(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 124. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect-stop.mdx new file mode 100644 index 0000000000..19a0e61d99 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect-stop.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect-stop" +title: "CollectStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.CollectStop" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `CollectStop` + +CollectStop stops input collection. + +## Signature + +```go +func (*CallingNamespace) CollectStop(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 119. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect.mdx new file mode 100644 index 0000000000..5e4974896f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/collect" +title: "Collect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Collect" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Collect` + +Collect starts input collection on a call. + +## Signature + +```go +func (*CallingNamespace) Collect(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 114. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/denoise-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/denoise-stop.mdx new file mode 100644 index 0000000000..6845ea12a8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/denoise-stop.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/denoise-stop" +title: "DenoiseStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.DenoiseStop" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `DenoiseStop` + +DenoiseStop disables denoising. + +## Signature + +```go +func (*CallingNamespace) DenoiseStop(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 172. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/denoise.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/denoise.mdx new file mode 100644 index 0000000000..f4c410f1af --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/denoise.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/denoise" +title: "Denoise" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Denoise" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Denoise` + +Denoise enables denoising on a call. + +## Signature + +```go +func (*CallingNamespace) Denoise(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 167. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/detect-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/detect-stop.mdx new file mode 100644 index 0000000000..271ed9887b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/detect-stop.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/detect-stop" +title: "DetectStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.DetectStop" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `DetectStop` + +DetectStop stops detection. + +## Signature + +```go +func (*CallingNamespace) DetectStop(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 136. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/detect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/detect.mdx new file mode 100644 index 0000000000..b61b391c3f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/detect.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/detect" +title: "Detect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Detect" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Detect` + +Detect starts detection (e.g., answering machine) on a call. + +## Signature + +```go +func (*CallingNamespace) Detect(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 131. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/dial.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/dial.mdx new file mode 100644 index 0000000000..6ee2361071 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/dial.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/dial" +title: "Dial" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Dial" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Dial` + +Dial initiates a new call. + +## Signature + +```go +func (*CallingNamespace) Dial(params map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 38. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/disconnect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/disconnect.mdx new file mode 100644 index 0000000000..8da427f8bd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/disconnect.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/disconnect" +title: "Disconnect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Disconnect" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Disconnect` + +Disconnect disconnects a call. + +## Signature + +```go +func (*CallingNamespace) Disconnect(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 58. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/end.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/end.mdx new file mode 100644 index 0000000000..7c205803c4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/end.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/end" +title: "End" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.End" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `End` + +End terminates a call. + +## Signature + +```go +func (*CallingNamespace) End(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 48. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/index.mdx new file mode 100644 index 0000000000..bf96ddc0d8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/index.mdx @@ -0,0 +1,185 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace" +title: "CallingNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `CallingNamespace` + +CallingNamespace provides REST-based call control. All commands are dispatched as POST /api/calling/calls with a "command" field. + +## Signature + +```go +type CallingNamespace struct +``` + +## Properties + + + +## Methods + + + + AIHold puts the AI on hold. + + + + AIMessage sends a message to the AI agent on a call. + + + + AIStop stops the AI session. + + + + AIUnhold takes the AI off hold. + + + + Collect starts input collection on a call. + + + + CollectStartInputTimers starts input timers for collection. + + + + CollectStop stops input collection. + + + + Denoise enables denoising on a call. + + + + DenoiseStop disables denoising. + + + + Detect starts detection (e.g., answering machine) on a call. + + + + DetectStop stops detection. + + + + Dial initiates a new call. + + + + Disconnect disconnects a call. + + + + End terminates a call. + + + + LiveTranscribe starts live transcription. + + + + LiveTranslate starts live translation. + + + + Play starts playback on a call. + + + + PlayPause pauses playback. + + + + PlayResume resumes playback. + + + + PlayStop stops playback. + + + + PlayVolume adjusts playback volume. + + + + ReceiveFaxStop stops receiving a fax. + + + + Record starts recording on a call. + + + + RecordPause pauses recording. + + + + RecordResume resumes recording. + + + + RecordStop stops recording. + + + + Refer sends a SIP REFER on a call. + + + + SendFaxStop stops sending a fax. + + + + Stream starts streaming on a call. + + + + StreamStop stops streaming. + + + + Tap starts tapping a call. + + + + TapStop stops tapping. + + + + Transcribe starts transcription on a call. + + + + TranscribeStop stops transcription. + + + + Transfer transfers a call. + + + + Update updates call parameters. + + + + UserEvent sends a custom user event on a call. + + + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 12. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/live-transcribe.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/live-transcribe.mdx new file mode 100644 index 0000000000..2d879236dd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/live-transcribe.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/live-transcribe" +title: "LiveTranscribe" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.LiveTranscribe" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `LiveTranscribe` + +LiveTranscribe starts live transcription. + +## Signature + +```go +func (*CallingNamespace) LiveTranscribe(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 213. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/live-translate.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/live-translate.mdx new file mode 100644 index 0000000000..25a8e2625f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/live-translate.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/live-translate" +title: "LiveTranslate" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.LiveTranslate" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `LiveTranslate` + +LiveTranslate starts live translation. + +## Signature + +```go +func (*CallingNamespace) LiveTranslate(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 218. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-pause.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-pause.mdx new file mode 100644 index 0000000000..e20c72ad81 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-pause.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-pause" +title: "PlayPause" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.PlayPause" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `PlayPause` + +PlayPause pauses playback. + +## Signature + +```go +func (*CallingNamespace) PlayPause(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 70. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-resume.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-resume.mdx new file mode 100644 index 0000000000..99fa008134 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-resume.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-resume" +title: "PlayResume" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.PlayResume" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `PlayResume` + +PlayResume resumes playback. + +## Signature + +```go +func (*CallingNamespace) PlayResume(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 75. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-stop.mdx new file mode 100644 index 0000000000..569a570dae --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-stop.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-stop" +title: "PlayStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.PlayStop" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `PlayStop` + +PlayStop stops playback. + +## Signature + +```go +func (*CallingNamespace) PlayStop(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 80. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-volume.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-volume.mdx new file mode 100644 index 0000000000..ed4226124e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-volume.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play-volume" +title: "PlayVolume" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.PlayVolume" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `PlayVolume` + +PlayVolume adjusts playback volume. + +## Signature + +```go +func (*CallingNamespace) PlayVolume(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 85. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play.mdx new file mode 100644 index 0000000000..3988f5c89c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/play" +title: "Play" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Play" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Play` + +Play starts playback on a call. + +## Signature + +```go +func (*CallingNamespace) Play(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 65. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/receive-fax-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/receive-fax-stop.mdx new file mode 100644 index 0000000000..cf0673238c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/receive-fax-stop.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/receive-fax-stop" +title: "ReceiveFaxStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.ReceiveFaxStop" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `ReceiveFaxStop` + +ReceiveFaxStop stops receiving a fax. + +## Signature + +```go +func (*CallingNamespace) ReceiveFaxStop(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 230. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-pause.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-pause.mdx new file mode 100644 index 0000000000..1e482a9f5d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-pause.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-pause" +title: "RecordPause" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.RecordPause" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `RecordPause` + +RecordPause pauses recording. + +## Signature + +```go +func (*CallingNamespace) RecordPause(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 97. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-resume.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-resume.mdx new file mode 100644 index 0000000000..a250741d63 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-resume.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-resume" +title: "RecordResume" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.RecordResume" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `RecordResume` + +RecordResume resumes recording. + +## Signature + +```go +func (*CallingNamespace) RecordResume(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 102. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-stop.mdx new file mode 100644 index 0000000000..f17acd49f6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-stop.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record-stop" +title: "RecordStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.RecordStop" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `RecordStop` + +RecordStop stops recording. + +## Signature + +```go +func (*CallingNamespace) RecordStop(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 107. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record.mdx new file mode 100644 index 0000000000..fdfe818bff --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/record" +title: "Record" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Record" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Record` + +Record starts recording on a call. + +## Signature + +```go +func (*CallingNamespace) Record(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 92. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/refer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/refer.mdx new file mode 100644 index 0000000000..c04fe2d915 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/refer.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/refer" +title: "Refer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Refer" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Refer` + +Refer sends a SIP REFER on a call. + +## Signature + +```go +func (*CallingNamespace) Refer(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 237. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/send-fax-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/send-fax-stop.mdx new file mode 100644 index 0000000000..9412a7d4fa --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/send-fax-stop.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/send-fax-stop" +title: "SendFaxStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.SendFaxStop" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `SendFaxStop` + +SendFaxStop stops sending a fax. + +## Signature + +```go +func (*CallingNamespace) SendFaxStop(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 225. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/stream-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/stream-stop.mdx new file mode 100644 index 0000000000..ed6fcbc4ec --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/stream-stop.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/stream-stop" +title: "StreamStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.StreamStop" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `StreamStop` + +StreamStop stops streaming. + +## Signature + +```go +func (*CallingNamespace) StreamStop(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 160. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/stream.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/stream.mdx new file mode 100644 index 0000000000..e2a2b547c6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/stream.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/stream" +title: "Stream" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Stream" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Stream` + +Stream starts streaming on a call. + +## Signature + +```go +func (*CallingNamespace) Stream(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 155. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/tap-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/tap-stop.mdx new file mode 100644 index 0000000000..d3dd12a06b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/tap-stop.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/tap-stop" +title: "TapStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.TapStop" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `TapStop` + +TapStop stops tapping. + +## Signature + +```go +func (*CallingNamespace) TapStop(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 148. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/tap.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/tap.mdx new file mode 100644 index 0000000000..ffb9904711 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/tap.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/tap" +title: "Tap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Tap" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Tap` + +Tap starts tapping a call. + +## Signature + +```go +func (*CallingNamespace) Tap(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 143. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transcribe-stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transcribe-stop.mdx new file mode 100644 index 0000000000..b27304891c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transcribe-stop.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transcribe-stop" +title: "TranscribeStop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.TranscribeStop" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `TranscribeStop` + +TranscribeStop stops transcription. + +## Signature + +```go +func (*CallingNamespace) TranscribeStop(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 184. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transcribe.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transcribe.mdx new file mode 100644 index 0000000000..ec01e3210f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transcribe.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transcribe" +title: "Transcribe" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Transcribe" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Transcribe` + +Transcribe starts transcription on a call. + +## Signature + +```go +func (*CallingNamespace) Transcribe(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 179. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transfer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transfer.mdx new file mode 100644 index 0000000000..bfde440fc0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transfer.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/transfer" +title: "Transfer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Transfer" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Transfer` + +Transfer transfers a call. + +## Signature + +```go +func (*CallingNamespace) Transfer(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 53. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/update.mdx new file mode 100644 index 0000000000..4b1965603f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/update.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `Update` + +Update updates call parameters. + +## Signature + +```go +func (*CallingNamespace) Update(params map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 43. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/user-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/user-event.mdx new file mode 100644 index 0000000000..5d20a35c89 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/user-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/calling-namespace/user-event" +title: "UserEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace.UserEvent" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CallingNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `UserEvent` + +UserEvent sends a custom user event on a call. + +## Signature + +```go +func (*CallingNamespace) UserEvent(callID string, params map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 244. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/chat-namespace/create-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/chat-namespace/create-token.mdx new file mode 100644 index 0000000000..a949dbf4d9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/chat-namespace/create-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/chat-namespace/create-token" +title: "CreateToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ChatNamespace.CreateToken" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ChatNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/chat.go" +--- +# `CreateToken` + +CreateToken creates a Chat token. + +## Signature + +```go +func (*ChatNamespace) CreateToken(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/chat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/chat.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/chat-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/chat-namespace/index.mdx new file mode 100644 index 0000000000..0e7865082f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/chat-namespace/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/chat-namespace" +title: "ChatNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ChatNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/chat.go" +--- +# `ChatNamespace` + +ChatNamespace provides Chat token generation. + +## Signature + +```go +type ChatNamespace struct +``` + +## Properties + + + +## Methods + + + + CreateToken creates a Chat token. + + + +## Source + +[`pkg/rest/namespaces/chat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/chat.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/create.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/create.mdx new file mode 100644 index 0000000000..3cb33c386b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/create.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/create" +title: "Create" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatAccounts.Create" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatAccounts" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Create` + +Create creates a new compat account. + +## Signature + +```go +func (*CompatAccounts) Create(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 25. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/get.mdx new file mode 100644 index 0000000000..39e6f2798c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatAccounts.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatAccounts" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Get` + +Get retrieves a compat account by SID. + +## Signature + +```go +func (*CompatAccounts) Get(sid string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 30. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/index.mdx new file mode 100644 index 0000000000..2e42a0c35b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts" +title: "CompatAccounts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatAccounts" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatAccounts` + +CompatAccounts provides compat account/subproject management. + +## Signature + +```go +type CompatAccounts struct +``` + +## Properties + + + +## Methods + + + + Create creates a new compat account. + + + + Get retrieves a compat account by SID. + + + + List lists all compat accounts. + + + + Update updates a compat account by SID. + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 15. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/list.mdx new file mode 100644 index 0000000000..9281e23dcb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatAccounts.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatAccounts" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `List` + +List lists all compat accounts. + +## Signature + +```go +func (*CompatAccounts) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 20. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/update.mdx new file mode 100644 index 0000000000..1d4743bee2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-accounts/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatAccounts.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatAccounts" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Update` + +Update updates a compat account by SID. + +## Signature + +```go +func (*CompatAccounts) Update(sid string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 35. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-applications/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-applications/index.mdx new file mode 100644 index 0000000000..d093490b66 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-applications/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-applications" +title: "CompatApplications" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatApplications" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatApplications` + +CompatApplications provides compat application management. + +## Signature + +```go +type CompatApplications struct +``` + +## Properties + + + +## Methods + + + + Update updates an application (uses POST per Twilio compat). + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 261. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-applications/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-applications/update.mdx new file mode 100644 index 0000000000..f733ac2549 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-applications/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-applications/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatApplications.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatApplications" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Update` + +Update updates an application (uses POST per Twilio compat). + +## Signature + +```go +func (*CompatApplications) Update(sid string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 266. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/index.mdx new file mode 100644 index 0000000000..240edf84f7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls" +title: "CompatCalls" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatCalls" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatCalls` + +CompatCalls provides compat call management with recording and stream sub-resources. + +## Signature + +```go +type CompatCalls struct +``` + +## Properties + + + +## Methods + + + + StartRecording starts recording on a call. + + + + StartStream starts a stream on a call. + + + + StopStream stops a stream on a call. + + + + Update updates a call (uses POST per Twilio compat). + + + + UpdateRecording updates a recording on a call. + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 42. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/start-recording.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/start-recording.mdx new file mode 100644 index 0000000000..02ec3bd8c6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/start-recording.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/start-recording" +title: "StartRecording" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatCalls.StartRecording" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatCalls" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `StartRecording` + +StartRecording starts recording on a call. + +## Signature + +```go +func (*CompatCalls) StartRecording(callSID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 52. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/start-stream.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/start-stream.mdx new file mode 100644 index 0000000000..799d8b53ea --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/start-stream.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/start-stream" +title: "StartStream" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatCalls.StartStream" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatCalls" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `StartStream` + +StartStream starts a stream on a call. + +## Signature + +```go +func (*CompatCalls) StartStream(callSID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 62. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/stop-stream.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/stop-stream.mdx new file mode 100644 index 0000000000..76d9bbf861 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/stop-stream.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/stop-stream" +title: "StopStream" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatCalls.StopStream" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatCalls" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `StopStream` + +StopStream stops a stream on a call. + +## Signature + +```go +func (*CompatCalls) StopStream(callSID string, streamSID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 67. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/update-recording.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/update-recording.mdx new file mode 100644 index 0000000000..bbf8e7bfb8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/update-recording.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/update-recording" +title: "UpdateRecording" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatCalls.UpdateRecording" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatCalls" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `UpdateRecording` + +UpdateRecording updates a recording on a call. + +## Signature + +```go +func (*CompatCalls) UpdateRecording(callSID string, recordingSID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 57. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/update.mdx new file mode 100644 index 0000000000..e32f1c02a1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-calls/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatCalls.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatCalls" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Update` + +Update updates a call (uses POST per Twilio compat). + +## Signature + +```go +func (*CompatCalls) Update(sid string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 47. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/delete-recording.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/delete-recording.mdx new file mode 100644 index 0000000000..6c3d108b90 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/delete-recording.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/delete-recording" +title: "DeleteRecording" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.DeleteRecording" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `DeleteRecording` + +DeleteRecording deletes a recording from a conference. + +## Signature + +```go +func (*CompatConferences) DeleteRecording(conferenceSID string, recordingSID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 188. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get-participant.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get-participant.mdx new file mode 100644 index 0000000000..fa4d9c3ae7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get-participant.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get-participant" +title: "GetParticipant" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.GetParticipant" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `GetParticipant` + +GetParticipant retrieves a participant from a conference. + +## Signature + +```go +func (*CompatConferences) GetParticipant(conferenceSID string, callSID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 156. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get-recording.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get-recording.mdx new file mode 100644 index 0000000000..494c6d2384 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get-recording.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get-recording" +title: "GetRecording" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.GetRecording" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `GetRecording` + +GetRecording retrieves a recording from a conference. + +## Signature + +```go +func (*CompatConferences) GetRecording(conferenceSID string, recordingSID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 178. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get.mdx new file mode 100644 index 0000000000..5b0d72e0e7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Get` + +Get retrieves a conference by SID. + +## Signature + +```go +func (*CompatConferences) Get(sid string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 139. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/index.mdx new file mode 100644 index 0000000000..f020397ea6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/index.mdx @@ -0,0 +1,89 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences" +title: "CompatConferences" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatConferences` + +CompatConferences provides compat conference management with participants, recordings, and streams. + +## Signature + +```go +type CompatConferences struct +``` + +## Properties + + + +## Methods + + + + DeleteRecording deletes a recording from a conference. + + + + Get retrieves a conference by SID. + + + + GetParticipant retrieves a participant from a conference. + + + + GetRecording retrieves a recording from a conference. + + + + List lists all conferences. + + + + ListParticipants lists participants in a conference. + + + + ListRecordings lists recordings for a conference. + + + + RemoveParticipant removes a participant from a conference. + + + + StartStream starts a stream on a conference. + + + + StopStream stops a stream on a conference. + + + + Update updates a conference. + + + + UpdateParticipant updates a participant in a conference. + + + + UpdateRecording updates a recording in a conference. + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 129. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list-participants.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list-participants.mdx new file mode 100644 index 0000000000..64588e3574 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list-participants.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list-participants" +title: "ListParticipants" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.ListParticipants" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `ListParticipants` + +ListParticipants lists participants in a conference. + +## Signature + +```go +func (*CompatConferences) ListParticipants(conferenceSID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 151. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list-recordings.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list-recordings.mdx new file mode 100644 index 0000000000..7b1d6751e6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list-recordings.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list-recordings" +title: "ListRecordings" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.ListRecordings" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `ListRecordings` + +ListRecordings lists recordings for a conference. + +## Signature + +```go +func (*CompatConferences) ListRecordings(conferenceSID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 173. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list.mdx new file mode 100644 index 0000000000..e77a253e0d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `List` + +List lists all conferences. + +## Signature + +```go +func (*CompatConferences) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 134. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/remove-participant.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/remove-participant.mdx new file mode 100644 index 0000000000..5077773724 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/remove-participant.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/remove-participant" +title: "RemoveParticipant" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.RemoveParticipant" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `RemoveParticipant` + +RemoveParticipant removes a participant from a conference. + +## Signature + +```go +func (*CompatConferences) RemoveParticipant(conferenceSID string, callSID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 166. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/start-stream.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/start-stream.mdx new file mode 100644 index 0000000000..e62669413a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/start-stream.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/start-stream" +title: "StartStream" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.StartStream" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `StartStream` + +StartStream starts a stream on a conference. + +## Signature + +```go +func (*CompatConferences) StartStream(conferenceSID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 195. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/stop-stream.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/stop-stream.mdx new file mode 100644 index 0000000000..43a5d60f02 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/stop-stream.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/stop-stream" +title: "StopStream" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.StopStream" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `StopStream` + +StopStream stops a stream on a conference. + +## Signature + +```go +func (*CompatConferences) StopStream(conferenceSID string, streamSID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 200. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update-participant.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update-participant.mdx new file mode 100644 index 0000000000..2ecfe5e22e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update-participant.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update-participant" +title: "UpdateParticipant" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.UpdateParticipant" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `UpdateParticipant` + +UpdateParticipant updates a participant in a conference. + +## Signature + +```go +func (*CompatConferences) UpdateParticipant(conferenceSID string, callSID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 161. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update-recording.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update-recording.mdx new file mode 100644 index 0000000000..1c926c1d7a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update-recording.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update-recording" +title: "UpdateRecording" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.UpdateRecording" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `UpdateRecording` + +UpdateRecording updates a recording in a conference. + +## Signature + +```go +func (*CompatConferences) UpdateRecording(conferenceSID string, recordingSID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 183. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update.mdx new file mode 100644 index 0000000000..d05b45f34d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-conferences/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Update` + +Update updates a conference. + +## Signature + +```go +func (*CompatConferences) Update(sid string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 144. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/delete-media.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/delete-media.mdx new file mode 100644 index 0000000000..681ff2c803 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/delete-media.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/delete-media" +title: "DeleteMedia" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatFaxes.DeleteMedia" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatFaxes" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `DeleteMedia` + +DeleteMedia deletes a media item from a fax. + +## Signature + +```go +func (*CompatFaxes) DeleteMedia(faxSID string, mediaSID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 121. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/get-media.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/get-media.mdx new file mode 100644 index 0000000000..4381a7001a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/get-media.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/get-media" +title: "GetMedia" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatFaxes.GetMedia" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatFaxes" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `GetMedia` + +GetMedia retrieves a specific media item from a fax. + +## Signature + +```go +func (*CompatFaxes) GetMedia(faxSID string, mediaSID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 116. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/index.mdx new file mode 100644 index 0000000000..cb36d8aaad --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes" +title: "CompatFaxes" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatFaxes" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatFaxes` + +CompatFaxes provides compat fax management with media sub-resources. + +## Signature + +```go +type CompatFaxes struct +``` + +## Properties + + + +## Methods + + + + DeleteMedia deletes a media item from a fax. + + + + GetMedia retrieves a specific media item from a fax. + + + + ListMedia lists media for a fax. + + + + Update updates a fax (uses POST per Twilio compat). + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 101. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/list-media.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/list-media.mdx new file mode 100644 index 0000000000..44bbadbc9f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/list-media.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/list-media" +title: "ListMedia" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatFaxes.ListMedia" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatFaxes" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `ListMedia` + +ListMedia lists media for a fax. + +## Signature + +```go +func (*CompatFaxes) ListMedia(faxSID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 111. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/update.mdx new file mode 100644 index 0000000000..5d05480231 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-faxes/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatFaxes.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatFaxes" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Update` + +Update updates a fax (uses POST per Twilio compat). + +## Signature + +```go +func (*CompatFaxes) Update(sid string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 106. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-laml-bins/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-laml-bins/index.mdx new file mode 100644 index 0000000000..f99ab02372 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-laml-bins/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-laml-bins" +title: "CompatLamlBins" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatLamlBins" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatLamlBins` + +CompatLamlBins provides compat cXML/LaML script management. + +## Signature + +```go +type CompatLamlBins struct +``` + +## Properties + + + +## Methods + + + + Update updates a LaML bin (uses POST per Twilio compat). + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 273. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-laml-bins/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-laml-bins/update.mdx new file mode 100644 index 0000000000..0eb52d6692 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-laml-bins/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-laml-bins/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatLamlBins.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatLamlBins" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Update` + +Update updates a LaML bin (uses POST per Twilio compat). + +## Signature + +```go +func (*CompatLamlBins) Update(sid string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 278. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/delete-media.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/delete-media.mdx new file mode 100644 index 0000000000..7c5164dff1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/delete-media.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/delete-media" +title: "DeleteMedia" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatMessages.DeleteMedia" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatMessages" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `DeleteMedia` + +DeleteMedia deletes a media item from a message. + +## Signature + +```go +func (*CompatMessages) DeleteMedia(messageSID string, mediaSID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 94. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/get-media.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/get-media.mdx new file mode 100644 index 0000000000..ba9a084d7c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/get-media.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/get-media" +title: "GetMedia" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatMessages.GetMedia" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatMessages" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `GetMedia` + +GetMedia retrieves a specific media item from a message. + +## Signature + +```go +func (*CompatMessages) GetMedia(messageSID string, mediaSID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 89. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/index.mdx new file mode 100644 index 0000000000..db1d109a45 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages" +title: "CompatMessages" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatMessages" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatMessages` + +CompatMessages provides compat message management with media sub-resources. + +## Signature + +```go +type CompatMessages struct +``` + +## Properties + + + +## Methods + + + + DeleteMedia deletes a media item from a message. + + + + GetMedia retrieves a specific media item from a message. + + + + ListMedia lists media for a message. + + + + Update updates a message (uses POST per Twilio compat). + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 74. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/list-media.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/list-media.mdx new file mode 100644 index 0000000000..10269f4589 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/list-media.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/list-media" +title: "ListMedia" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatMessages.ListMedia" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatMessages" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `ListMedia` + +ListMedia lists media for a message. + +## Signature + +```go +func (*CompatMessages) ListMedia(messageSID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 84. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/update.mdx new file mode 100644 index 0000000000..e13cfd291f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-messages/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatMessages.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatMessages" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Update` + +Update updates a message (uses POST per Twilio compat). + +## Signature + +```go +func (*CompatMessages) Update(sid string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 79. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-namespace/index.mdx new file mode 100644 index 0000000000..a4f26168a2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-namespace/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-namespace" +title: "CompatNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatNamespace` + +CompatNamespace provides the Twilio-compatible LAML API with AccountSid scoping. + +## Signature + +```go +type CompatNamespace struct +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 378. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/delete.mdx new file mode 100644 index 0000000000..05da35fc60 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Delete` + +Delete releases an incoming phone number. + +## Signature + +```go +func (*CompatPhoneNumbers) Delete(sid string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 233. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/get.mdx new file mode 100644 index 0000000000..fd73d7d944 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Get` + +Get retrieves an incoming phone number by SID. + +## Signature + +```go +func (*CompatPhoneNumbers) Get(sid string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 223. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/import-number.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/import-number.mdx new file mode 100644 index 0000000000..ff31726414 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/import-number.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/import-number" +title: "ImportNumber" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers.ImportNumber" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `ImportNumber` + +ImportNumber imports an externally-hosted phone number. + +## Signature + +```go +func (*CompatPhoneNumbers) ImportNumber(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 238. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/index.mdx new file mode 100644 index 0000000000..fe72834cbe --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers" +title: "CompatPhoneNumbers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatPhoneNumbers` + +CompatPhoneNumbers provides compat phone number management. + +## Signature + +```go +type CompatPhoneNumbers struct +``` + +## Properties + + + +## Methods + + + + Delete releases an incoming phone number. + + + + Get retrieves an incoming phone number by SID. + + + + ImportNumber imports an externally-hosted phone number. + + + + List lists all incoming phone numbers. + + + + ListAvailableCountries lists countries with available numbers. + + + + Purchase purchases a phone number. + + + + SearchLocal searches for available local numbers in a country. + + + + SearchTollFree searches for available toll-free numbers in a country. + + + + Update updates an incoming phone number. + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 207. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/list-available-countries.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/list-available-countries.mdx new file mode 100644 index 0000000000..d9d70e78c1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/list-available-countries.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/list-available-countries" +title: "ListAvailableCountries" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers.ListAvailableCountries" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `ListAvailableCountries` + +ListAvailableCountries lists countries with available numbers. + +## Signature + +```go +func (*CompatPhoneNumbers) ListAvailableCountries(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 244. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/list.mdx new file mode 100644 index 0000000000..6a3a2e7768 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `List` + +List lists all incoming phone numbers. + +## Signature + +```go +func (*CompatPhoneNumbers) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 213. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/purchase.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/purchase.mdx new file mode 100644 index 0000000000..bfe4b865be --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/purchase.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/purchase" +title: "Purchase" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers.Purchase" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Purchase` + +Purchase purchases a phone number. + +## Signature + +```go +func (*CompatPhoneNumbers) Purchase(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 218. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/search-local.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/search-local.mdx new file mode 100644 index 0000000000..43397f6998 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/search-local.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/search-local" +title: "SearchLocal" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers.SearchLocal" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `SearchLocal` + +SearchLocal searches for available local numbers in a country. + +## Signature + +```go +func (*CompatPhoneNumbers) SearchLocal(country string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 249. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/search-toll-free.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/search-toll-free.mdx new file mode 100644 index 0000000000..d857bc805c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/search-toll-free.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/search-toll-free" +title: "SearchTollFree" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers.SearchTollFree" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `SearchTollFree` + +SearchTollFree searches for available toll-free numbers in a country. + +## Signature + +```go +func (*CompatPhoneNumbers) SearchTollFree(country string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 254. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/update.mdx new file mode 100644 index 0000000000..87c888284d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-phone-numbers/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatPhoneNumbers" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Update` + +Update updates an incoming phone number. + +## Signature + +```go +func (*CompatPhoneNumbers) Update(sid string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 228. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/dequeue-member.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/dequeue-member.mdx new file mode 100644 index 0000000000..e0ec31cd2a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/dequeue-member.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/dequeue-member" +title: "DequeueMember" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatQueues.DequeueMember" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatQueues" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `DequeueMember` + +DequeueMember dequeues a member from a queue. + +## Signature + +```go +func (*CompatQueues) DequeueMember(queueSID string, callSID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 305. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/get-member.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/get-member.mdx new file mode 100644 index 0000000000..f69ff77951 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/get-member.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/get-member" +title: "GetMember" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatQueues.GetMember" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatQueues" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `GetMember` + +GetMember retrieves a member from a queue. + +## Signature + +```go +func (*CompatQueues) GetMember(queueSID string, callSID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 300. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/index.mdx new file mode 100644 index 0000000000..ebb5daf39f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues" +title: "CompatQueues" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatQueues" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatQueues` + +CompatQueues provides compat queue management with members. + +## Signature + +```go +type CompatQueues struct +``` + +## Properties + + + +## Methods + + + + DequeueMember dequeues a member from a queue. + + + + GetMember retrieves a member from a queue. + + + + ListMembers lists members of a queue. + + + + Update updates a queue (uses POST per Twilio compat). + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 285. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/list-members.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/list-members.mdx new file mode 100644 index 0000000000..e38c888203 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/list-members.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/list-members" +title: "ListMembers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatQueues.ListMembers" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatQueues" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `ListMembers` + +ListMembers lists members of a queue. + +## Signature + +```go +func (*CompatQueues) ListMembers(queueSID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 295. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/update.mdx new file mode 100644 index 0000000000..3ad4208fea --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-queues/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatQueues.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatQueues" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Update` + +Update updates a queue (uses POST per Twilio compat). + +## Signature + +```go +func (*CompatQueues) Update(sid string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 290. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/delete.mdx new file mode 100644 index 0000000000..326c1439d7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatRecordings.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatRecordings" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Delete` + +Delete removes a recording. + +## Signature + +```go +func (*CompatRecordings) Delete(sid string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 327. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/get.mdx new file mode 100644 index 0000000000..5c7c1ff47c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatRecordings.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatRecordings" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Get` + +Get retrieves a recording by SID. + +## Signature + +```go +func (*CompatRecordings) Get(sid string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 322. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/index.mdx new file mode 100644 index 0000000000..7ac046df2b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings" +title: "CompatRecordings" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatRecordings" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatRecordings` + +CompatRecordings provides compat recording management. + +## Signature + +```go +type CompatRecordings struct +``` + +## Properties + + + +## Methods + + + + Delete removes a recording. + + + + Get retrieves a recording by SID. + + + + List lists all recordings. + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 312. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/list.mdx new file mode 100644 index 0000000000..2d00ce5ee7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-recordings/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatRecordings.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatRecordings" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `List` + +List lists all recordings. + +## Signature + +```go +func (*CompatRecordings) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 317. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/create.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/create.mdx new file mode 100644 index 0000000000..af21098760 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/create.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/create" +title: "Create" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTokens.Create" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Create` + +Create creates a new API token. + +## Signature + +```go +func (*CompatTokens) Create(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 361. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/delete.mdx new file mode 100644 index 0000000000..3e2d257354 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTokens.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Delete` + +Delete removes an API token. + +## Signature + +```go +func (*CompatTokens) Delete(tokenID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 371. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/index.mdx new file mode 100644 index 0000000000..897957e6c5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens" +title: "CompatTokens" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTokens" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatTokens` + +CompatTokens provides compat API token management. + +## Signature + +```go +type CompatTokens struct +``` + +## Properties + + + +## Methods + + + + Create creates a new API token. + + + + Delete removes an API token. + + + + Update modifies an API token. + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 356. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/update.mdx new file mode 100644 index 0000000000..5d8bc2faa8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-tokens/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTokens.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Update` + +Update modifies an API token. + +## Signature + +```go +func (*CompatTokens) Update(tokenID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 366. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/delete.mdx new file mode 100644 index 0000000000..3a6da69e23 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTranscriptions.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTranscriptions" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Delete` + +Delete removes a transcription. + +## Signature + +```go +func (*CompatTranscriptions) Delete(sid string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 349. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/get.mdx new file mode 100644 index 0000000000..a15fe3dd00 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTranscriptions.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTranscriptions" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `Get` + +Get retrieves a transcription by SID. + +## Signature + +```go +func (*CompatTranscriptions) Get(sid string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 344. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/index.mdx new file mode 100644 index 0000000000..b4cf3beaee --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions" +title: "CompatTranscriptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTranscriptions" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `CompatTranscriptions` + +CompatTranscriptions provides compat transcription management. + +## Signature + +```go +type CompatTranscriptions struct +``` + +## Properties + + + +## Methods + + + + Delete removes a transcription. + + + + Get retrieves a transcription by SID. + + + + List lists all transcriptions. + + + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 334. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/list.mdx new file mode 100644 index 0000000000..8b13fc9acf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/compat-transcriptions/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTranscriptions.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CompatTranscriptions" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `List` + +List lists all transcriptions. + +## Signature + +```go +func (*CompatTranscriptions) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 339. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-logs/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-logs/index.mdx new file mode 100644 index 0000000000..067046943e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-logs/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-logs" +title: "ConferenceLogs" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ConferenceLogs" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `ConferenceLogs` + +ConferenceLogs provides conference log queries. + +## Signature + +```go +type ConferenceLogs struct +``` + +## Properties + + + +## Methods + + + + List lists conference logs. + + + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 69. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-logs/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-logs/list.mdx new file mode 100644 index 0000000000..9f37e406c6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-logs/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-logs/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ConferenceLogs.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ConferenceLogs" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `List` + +List lists conference logs. + +## Signature + +```go +func (*ConferenceLogs) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 74. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-rooms-resource/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-rooms-resource/index.mdx new file mode 100644 index 0000000000..a35d22f3ef --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-rooms-resource/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-rooms-resource" +title: "ConferenceRoomsResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ConferenceRoomsResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `ConferenceRoomsResource` + +ConferenceRoomsResource uses singular "conference\_room" for sub-resource paths. + +## Signature + +```go +type ConferenceRoomsResource struct +``` + +## Properties + + + +## Methods + + + + ListAddresses lists addresses for a conference room. + + + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 102. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-rooms-resource/list-addresses.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-rooms-resource/list-addresses.mdx new file mode 100644 index 0000000000..a56d8897ef --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-rooms-resource/list-addresses.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/conference-rooms-resource/list-addresses" +title: "ListAddresses" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ConferenceRoomsResource.ListAddresses" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ConferenceRoomsResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `ListAddresses` + +ListAddresses lists addresses for a conference room. + +## Signature + +```go +func (*ConferenceRoomsResource) ListAddresses(id string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 107. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/create.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/create.mdx new file mode 100644 index 0000000000..58fc9ac2b0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/create.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/create" +title: "Create" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudResource.Create" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `Create` + +Create sends a POST request to create a new resource. + +## Signature + +```go +func (*CrudResource) Create(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 68. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/delete.mdx new file mode 100644 index 0000000000..19a4e3eb79 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudResource.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `Delete` + +Delete removes a resource by ID. It returns the parsed response body (or an empty map for 204 No Content) and any error. + +## Signature + +```go +func (*CrudResource) Delete(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 88. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/get.mdx new file mode 100644 index 0000000000..a53245e858 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudResource.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `Get` + +Get retrieves a single resource by ID. + +## Signature + +```go +func (*CrudResource) Get(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 73. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/index.mdx new file mode 100644 index 0000000000..c0d8cbf15c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource" +title: "CrudResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `CrudResource` + +CrudResource provides standard List, Create, Get, Update, Delete operations against a REST collection endpoint within a namespace. + +## Signature + +```go +type CrudResource struct +``` + +## Properties + + + + + "PATCH" (default) or "PUT" + + +## Methods + + + + Create sends a POST request to create a new resource. + + + + Delete removes a resource by ID. It returns the parsed response body (or an empty map for 204 No Content) and any error. + + + + Get retrieves a single resource by ID. + + + + List retrieves all items from the collection. + + + + Update modifies an existing resource by ID. + + + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 41. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/list.mdx new file mode 100644 index 0000000000..4cecbd5487 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudResource.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `List` + +List retrieves all items from the collection. + +## Signature + +```go +func (*CrudResource) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 63. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/update.mdx new file mode 100644 index 0000000000..f6fc74c523 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-resource/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudResource.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `Update` + +Update modifies an existing resource by ID. + +## Signature + +```go +func (*CrudResource) Update(id string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 78. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-with-addresses/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-with-addresses/index.mdx new file mode 100644 index 0000000000..6b29661d21 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-with-addresses/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-with-addresses" +title: "CrudWithAddresses" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudWithAddresses" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `CrudWithAddresses` + +CrudWithAddresses extends CrudResource with the nested addresses endpoint. Matches Python's CrudWithAddresses at \_base.py:109-113. Only resources that explicitly support the addresses sub-resource should embed this type; plain CrudResource does not expose ListAddresses. + +## Signature + +```go +type CrudWithAddresses struct +``` + +## Properties + + + +## Methods + + + + ListAddresses lists addresses associated with the resource identified by id. + + + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 96. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-with-addresses/list-addresses.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-with-addresses/list-addresses.mdx new file mode 100644 index 0000000000..7df2de32a8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-with-addresses/list-addresses.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/crud-with-addresses/list-addresses" +title: "ListAddresses" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudWithAddresses.ListAddresses" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CrudWithAddresses" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `ListAddresses` + +ListAddresses lists addresses associated with the resource identified by id. + +## Signature + +```go +func (*CrudWithAddresses) ListAddresses(id string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 113. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource/create.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource/create.mdx new file mode 100644 index 0000000000..7461eef00a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource/create.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource/create" +title: "Create" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CxmlApplicationsResource.Create" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CxmlApplicationsResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `Create` + +Create always returns an error — cXML applications cannot be created via this API. The params argument is accepted for API parity with other CRUD resources but is reported in the error so the caller can see what payload was rejected. To create a new cXML application use a different API surface or the SignalWire dashboard. + +Mirrors Python's CxmlApplicationsResource.create raising NotImplementedError (signalwire/rest/namespaces/fabric.py:90). + +## Signature + +```go +func (*CxmlApplicationsResource) Create(params map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 162. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource/index.mdx new file mode 100644 index 0000000000..5a602dc400 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource" +title: "CxmlApplicationsResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CxmlApplicationsResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `CxmlApplicationsResource` + +CxmlApplicationsResource exposes the fabric cXML applications sub-resource. Create is explicitly disallowed — cXML applications cannot be created via this API. This mirrors Python's CxmlApplicationsResource.create raising NotImplementedError (fabric.py:90). + +## Signature + +```go +type CxmlApplicationsResource struct +``` + +## Properties + + + +## Methods + + + + Create always returns an error — cXML applications cannot be created via this API. The params argument is accepted for API parity with other CRUD resources but is reported in the error so the caller can see what payload was rejected. To create a new cXML application use a different API surface or the SignalWire dashboard. + + + + ListAddresses lists addresses for a cXML application. + + + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 150. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource/list-addresses.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource/list-addresses.mdx new file mode 100644 index 0000000000..bc9d27a57e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource/list-addresses.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-applications-resource/list-addresses" +title: "ListAddresses" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CxmlApplicationsResource.ListAddresses" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CxmlApplicationsResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `ListAddresses` + +ListAddresses lists addresses for a cXML application. + +## Signature + +```go +func (*CxmlApplicationsResource) ListAddresses(id string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 170. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-webhook-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-webhook-options/index.mdx new file mode 100644 index 0000000000..342323f0d4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-webhook-options/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-webhook-options" +title: "CxmlWebhookOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CxmlWebhookOptions" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `CxmlWebhookOptions` + +CxmlWebhookOptions holds optional fields for SetCxmlWebhook. + +## Signature + +```go +type CxmlWebhookOptions struct +``` + +## Properties + + + Extra passes through additional wire-level fields. + + + + FallbackURL is used when the primary URL fails. + + + + StatusCallbackURL receives call status updates. + + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 71. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-webhooks-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-webhooks-resource.mdx new file mode 100644 index 0000000000..f1fcd329e6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-webhooks-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/cxml-webhooks-resource" +title: "CxmlWebhooksResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.CxmlWebhooksResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `CxmlWebhooksResource` + +CxmlWebhooksResource is the Python class name for the auto-materialized CXML webhook resource. Go aliases AutoMaterializedWebhookResource here. + +## Signature + +```go +type CxmlWebhooksResource alias +``` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 328. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/delete-chunk.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/delete-chunk.mdx new file mode 100644 index 0000000000..2326b5836d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/delete-chunk.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/delete-chunk" +title: "DeleteChunk" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.DatasphereDocuments.DeleteChunk" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.DatasphereDocuments" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go" +--- +# `DeleteChunk` + +DeleteChunk deletes a specific chunk from a document. + +## Signature + +```go +func (*DatasphereDocuments) DeleteChunk(documentID string, chunkID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go) + +Line 32. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/get-chunk.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/get-chunk.mdx new file mode 100644 index 0000000000..0bf3078660 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/get-chunk.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/get-chunk" +title: "GetChunk" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.DatasphereDocuments.GetChunk" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.DatasphereDocuments" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go" +--- +# `GetChunk` + +GetChunk retrieves a specific chunk from a document. + +## Signature + +```go +func (*DatasphereDocuments) GetChunk(documentID string, chunkID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go) + +Line 27. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/index.mdx new file mode 100644 index 0000000000..159aa7c303 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents" +title: "DatasphereDocuments" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.DatasphereDocuments" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go" +--- +# `DatasphereDocuments` + +DatasphereDocuments provides document management with search and chunk operations for the Datasphere API. + +## Signature + +```go +type DatasphereDocuments struct +``` + +## Properties + + + +## Methods + + + + DeleteChunk deletes a specific chunk from a document. + + + + GetChunk retrieves a specific chunk from a document. + + + + ListChunks lists chunks for a specific document. + + + + Search performs a semantic search across documents. + + + +## Source + +[`pkg/rest/namespaces/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go) + +Line 12. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/list-chunks.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/list-chunks.mdx new file mode 100644 index 0000000000..fa6e385ffa --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/list-chunks.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/list-chunks" +title: "ListChunks" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.DatasphereDocuments.ListChunks" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.DatasphereDocuments" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go" +--- +# `ListChunks` + +ListChunks lists chunks for a specific document. + +## Signature + +```go +func (*DatasphereDocuments) ListChunks(documentID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go) + +Line 22. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/search.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/search.mdx new file mode 100644 index 0000000000..ea15e1ab77 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/search.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-documents/search" +title: "Search" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.DatasphereDocuments.Search" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.DatasphereDocuments" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go" +--- +# `Search` + +Search performs a semantic search across documents. + +## Signature + +```go +func (*DatasphereDocuments) Search(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go) + +Line 17. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-namespace/index.mdx new file mode 100644 index 0000000000..1b12b5fc55 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-namespace/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/datasphere-namespace" +title: "DatasphereNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.DatasphereNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go" +--- +# `DatasphereNamespace` + +DatasphereNamespace groups Datasphere API resources. + +## Signature + +```go +type DatasphereNamespace struct +``` + +## Properties + + + +## Source + +[`pkg/rest/namespaces/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go) + +Line 37. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses/get.mdx new file mode 100644 index 0000000000..be21abca5e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricAddresses.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricAddresses" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `Get` + +Get retrieves a fabric address by ID. + +## Signature + +```go +func (*FabricAddresses) Get(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 275. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses/index.mdx new file mode 100644 index 0000000000..26feba4bb3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses" +title: "FabricAddresses" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricAddresses" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `FabricAddresses` + +FabricAddresses provides read-only access to fabric addresses. + +## Signature + +```go +type FabricAddresses struct +``` + +## Properties + + + +## Methods + + + + Get retrieves a fabric address by ID. + + + + List lists all fabric addresses. + + + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 265. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses/list.mdx new file mode 100644 index 0000000000..7ee25b16fe --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-addresses/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricAddresses.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricAddresses" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `List` + +List lists all fabric addresses. + +## Signature + +```go +func (*FabricAddresses) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 270. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-namespace/index.mdx new file mode 100644 index 0000000000..40a4c3f74f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-namespace/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-namespace" +title: "FabricNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `FabricNamespace` + +FabricNamespace groups all Fabric API resource types. + +## Signature + +```go +type FabricNamespace struct +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + Special resources + + + + + + + + + + PUT-update resources + + + + PATCH-update resources SWMLWebhooks and CXMLWebhooks are auto-materialized: prefer PhoneNumbers.SetSwmlWebhook / SetCxmlWebhook for creation. Direct .Create still works for backcompat but emits a deprecation warning. + + + + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 333. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-resource-put.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-resource-put.mdx new file mode 100644 index 0000000000..5ac33b7b7d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-resource-put.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-resource-put" +title: "FabricResourcePUT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricResourcePUT" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `FabricResourcePUT` + +FabricResourcePUT is the Python class name for a CrudResource that uses PUT for updates. Go aliases CrudResource here so the cross-language audit sees the same type name on both sides without requiring a distinct struct. + +## Signature + +```go +type FabricResourcePUT alias +``` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 315. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-resource.mdx new file mode 100644 index 0000000000..1e1a306a9c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-resource" +title: "FabricResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `FabricResource` + +FabricResource is the Python class name for a CrudResource that exposes the addresses sub-resource. Go aliases CrudWithAddresses here for the same reason as FabricResourcePUT. + +## Signature + +```go +type FabricResource alias +``` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 320. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-embed-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-embed-token.mdx new file mode 100644 index 0000000000..78781a81a1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-embed-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-embed-token" +title: "CreateEmbedToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricTokens.CreateEmbedToken" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `CreateEmbedToken` + +CreateEmbedToken creates an embed token. + +## Signature + +```go +func (*FabricTokens) CreateEmbedToken(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 307. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-guest-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-guest-token.mdx new file mode 100644 index 0000000000..cb1fcb6b77 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-guest-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-guest-token" +title: "CreateGuestToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricTokens.CreateGuestToken" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `CreateGuestToken` + +CreateGuestToken creates a guest token. + +## Signature + +```go +func (*FabricTokens) CreateGuestToken(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 302. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-invite-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-invite-token.mdx new file mode 100644 index 0000000000..487b1a169f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-invite-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-invite-token" +title: "CreateInviteToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricTokens.CreateInviteToken" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `CreateInviteToken` + +CreateInviteToken creates an invite token. + +## Signature + +```go +func (*FabricTokens) CreateInviteToken(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 297. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-subscriber-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-subscriber-token.mdx new file mode 100644 index 0000000000..1e94dde540 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-subscriber-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/create-subscriber-token" +title: "CreateSubscriberToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricTokens.CreateSubscriberToken" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `CreateSubscriberToken` + +CreateSubscriberToken creates a subscriber token. + +## Signature + +```go +func (*FabricTokens) CreateSubscriberToken(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 287. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/index.mdx new file mode 100644 index 0000000000..b42280dd2a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens" +title: "FabricTokens" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricTokens" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `FabricTokens` + +FabricTokens provides subscriber, guest, invite, and embed token creation. + +## Signature + +```go +type FabricTokens struct +``` + +## Properties + + + +## Methods + + + + CreateEmbedToken creates an embed token. + + + + CreateGuestToken creates a guest token. + + + + CreateInviteToken creates an invite token. + + + + CreateSubscriberToken creates a subscriber token. + + + + RefreshSubscriberToken refreshes a subscriber token. + + + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 282. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/refresh-subscriber-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/refresh-subscriber-token.mdx new file mode 100644 index 0000000000..6b374a61cf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/refresh-subscriber-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fabric-tokens/refresh-subscriber-token" +title: "RefreshSubscriberToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricTokens.RefreshSubscriberToken" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FabricTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `RefreshSubscriberToken` + +RefreshSubscriberToken refreshes a subscriber token. + +## Signature + +```go +func (*FabricTokens) RefreshSubscriberToken(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 292. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs/get.mdx new file mode 100644 index 0000000000..14674df5f3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FaxLogs.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FaxLogs" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `Get` + +Get retrieves a specific fax log entry. + +## Signature + +```go +func (*FaxLogs) Get(logID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 62. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs/index.mdx new file mode 100644 index 0000000000..efbd41d041 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs" +title: "FaxLogs" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FaxLogs" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `FaxLogs` + +FaxLogs provides fax log queries. + +## Signature + +```go +type FaxLogs struct +``` + +## Properties + + + +## Methods + + + + Get retrieves a specific fax log entry. + + + + List lists fax logs. + + + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 52. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs/list.mdx new file mode 100644 index 0000000000..8a85c13589 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/fax-logs/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FaxLogs.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.FaxLogs" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `List` + +List lists fax logs. + +## Signature + +```go +func (*FaxLogs) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 57. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/assign-domain-application.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/assign-domain-application.mdx new file mode 100644 index 0000000000..501f075a86 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/assign-domain-application.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/assign-domain-application" +title: "AssignDomainApplication" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources.AssignDomainApplication" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `AssignDomainApplication` + +AssignDomainApplication assigns a domain application to a resource. + +## Signature + +```go +func (*GenericResources) AssignDomainApplication(id string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 258. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/assign-phone-route.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/assign-phone-route.mdx new file mode 100644 index 0000000000..8757219f90 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/assign-phone-route.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/assign-phone-route" +title: "AssignPhoneRoute" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources.AssignPhoneRoute" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" + deprecated: true +--- +# `AssignPhoneRoute` + + + **Deprecated.** This endpoint (POST /api/fabric/resources/\{id\}/phone\_routes) accepts only a narrow set of legacy resource types as the attach target. It does NOT work for swml\_webhook / cxml\_webhook / ai\_agent bindings — those are configured on the phone number and the Fabric resource is auto-materialized. Use phone\_numbers.SetSwmlWebhook, SetCxmlWebhook, SetAiAgent, etc. instead. See porting-sdk's phone-binding.md. + + +AssignPhoneRoute assigns a phone route to a resource. + +## Signature + +```go +func (*GenericResources) AssignPhoneRoute(id string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 245. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/delete.mdx new file mode 100644 index 0000000000..51ce3d0249 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `Delete` + +Delete removes a generic resource by ID. + +## Signature + +```go +func (*GenericResources) Delete(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 228. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/get.mdx new file mode 100644 index 0000000000..ad037da1ff --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `Get` + +Get retrieves a generic resource by ID. + +## Signature + +```go +func (*GenericResources) Get(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 223. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/index.mdx new file mode 100644 index 0000000000..f1b5967334 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources" +title: "GenericResources" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `GenericResources` + +GenericResources provides operations across all fabric resource types. + +## Signature + +```go +type GenericResources struct +``` + +## Properties + + + +## Methods + + + + AssignDomainApplication assigns a domain application to a resource. + + + + AssignPhoneRoute assigns a phone route to a resource. + + + + Delete removes a generic resource by ID. + + + + Get retrieves a generic resource by ID. + + + + List lists all generic resources. + + + + ListAddresses lists addresses for a generic resource. + + + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 213. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/list-addresses.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/list-addresses.mdx new file mode 100644 index 0000000000..b4ffd38333 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/list-addresses.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/list-addresses" +title: "ListAddresses" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources.ListAddresses" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `ListAddresses` + +ListAddresses lists addresses for a generic resource. + +## Signature + +```go +func (*GenericResources) ListAddresses(id string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 233. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/list.mdx new file mode 100644 index 0000000000..6f3217824b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/generic-resources/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.GenericResources" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `List` + +List lists all generic resources. + +## Signature + +```go +func (*GenericResources) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 218. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/delete.mdx new file mode 100644 index 0000000000..bb51ed19e4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/delete.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.HTTPClient.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.HTTPClient" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `Delete` + +## Signature + +```go +Delete(path string) (map[string]any, error) +``` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 22. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/get.mdx new file mode 100644 index 0000000000..ef748ff0ca --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/get.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.HTTPClient.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.HTTPClient" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `Get` + +## Signature + +```go +Get(path string, params map[string]string) (map[string]any, error) +``` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 18. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/index.mdx new file mode 100644 index 0000000000..a75ab11431 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client" +title: "HTTPClient" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "interface" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.HTTPClient" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `HTTPClient` + +HTTPClient is the interface that namespace implementations use to make HTTP requests. It is satisfied by the httpAdapter in the parent rest package, which prevents an import cycle. + +## Signature + +```go +type HTTPClient interface { Get; Post; Put; Patch; Delete } +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 17. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/patch.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/patch.mdx new file mode 100644 index 0000000000..7df0e4674d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/patch.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/patch" +title: "Patch" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.HTTPClient.Patch" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.HTTPClient" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `Patch` + +## Signature + +```go +Patch(path string, body map[string]any) (map[string]any, error) +``` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 21. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/post.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/post.mdx new file mode 100644 index 0000000000..490633f915 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/post.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/post" +title: "Post" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.HTTPClient.Post" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.HTTPClient" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `Post` + +## Signature + +```go +Post(path string, body map[string]any, params map[string]string) (map[string]any, error) +``` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 19. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/put.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/put.mdx new file mode 100644 index 0000000000..5afb1c895c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/put.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/http-client/put" +title: "Put" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.HTTPClient.Put" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.HTTPClient" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `Put` + +## Signature + +```go +Put(path string, body map[string]any) (map[string]any, error) +``` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 20. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/imported-numbers-namespace/create.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/imported-numbers-namespace/create.mdx new file mode 100644 index 0000000000..8a9a7c108c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/imported-numbers-namespace/create.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/imported-numbers-namespace/create" +title: "Create" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ImportedNumbersNamespace.Create" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ImportedNumbersNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/imported_numbers.go" +--- +# `Create` + +Create imports an externally-hosted phone number. + +## Signature + +```go +func (*ImportedNumbersNamespace) Create(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/imported_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/imported_numbers.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/imported-numbers-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/imported-numbers-namespace/index.mdx new file mode 100644 index 0000000000..68f8f8e86f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/imported-numbers-namespace/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/imported-numbers-namespace" +title: "ImportedNumbersNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ImportedNumbersNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/imported_numbers.go" +--- +# `ImportedNumbersNamespace` + +ImportedNumbersNamespace provides imported phone number management. + +## Signature + +```go +type ImportedNumbersNamespace struct +``` + +## Properties + + + +## Methods + + + + Create imports an externally-hosted phone number. + + + +## Source + +[`pkg/rest/namespaces/imported_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/imported_numbers.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/index.mdx new file mode 100644 index 0000000000..8ed8ebb544 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/index.mdx @@ -0,0 +1,516 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces" +title: "namespaces" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go" +--- +# `namespaces` + +Package namespaces contains the individual API namespace implementations for the SignalWire REST client. + +## Signature + +```go +package namespaces +``` + +## Constants + + + PhoneCallHandler wire values accepted by phone\_numbers.Update. + + + + PhoneCallHandler wire values accepted by phone\_numbers.Update. + + + + PhoneCallHandler wire values accepted by phone\_numbers.Update. + + + + PhoneCallHandler wire values accepted by phone\_numbers.Update. + + + + PhoneCallHandler wire values accepted by phone\_numbers.Update. + + + + PhoneCallHandler wire values accepted by phone\_numbers.Update. + + + + PhoneCallHandler wire values accepted by phone\_numbers.Update. + + + + PhoneCallHandler wire values accepted by phone\_numbers.Update. + + + + PhoneCallHandler wire values accepted by phone\_numbers.Update. + + + + PhoneCallHandler wire values accepted by phone\_numbers.Update. + + + + PhoneCallHandler wire values accepted by phone\_numbers.Update. + + +## Functions + + + + AllPhoneCallHandlers returns every PhoneCallHandler value. Useful for enum-contract tests and for callers that need to validate or enumerate the set. + + + + NewAddressesNamespace creates a new AddressesNamespace. + + + + NewCallingNamespace creates a new CallingNamespace. + + + + NewChatNamespace creates a new ChatNamespace. + + + + NewCompatNamespace creates a new CompatNamespace with all sub-resources scoped to the given account SID. + + + + NewCrudResource creates a CrudResource with PATCH as the update method. + + + + NewCrudResourcePUT creates a CrudResource that uses PUT for updates. + + + + NewCrudWithAddresses constructs a CrudWithAddresses backed by a PATCH-default CrudResource. Use NewCrudWithAddressesPUT for resources that update via PUT. + + + + NewCrudWithAddressesPUT constructs a CrudWithAddresses backed by a PUT-update CrudResource. + + + + NewDatasphereNamespace creates a new DatasphereNamespace. + + + + NewFabricNamespace creates a new FabricNamespace with all sub-resources initialized. + + + + NewImportedNumbersNamespace creates a new ImportedNumbersNamespace. + + + + NewLogsNamespace creates a new LogsNamespace with all sub-resources initialized. + + + + NewLookupNamespace creates a new LookupNamespace. + + + + NewMFANamespace creates a new MFANamespace. + + + + NewNumberGroupsNamespace creates a new NumberGroupsNamespace. + + + + NewPhoneNumbersNamespace creates a new PhoneNumbersNamespace. + + + + NewProjectNamespace creates a new ProjectNamespace. + + + + NewPubSubNamespace creates a new PubSubNamespace. + + + + NewQueuesNamespace creates a new QueuesNamespace. + + + + NewRecordingsNamespace creates a new RecordingsNamespace. + + + + NewRegistryNamespace creates a new RegistryNamespace with all sub-resources. + + + + NewShortCodesNamespace creates a new ShortCodesNamespace. + + + + NewSipProfileNamespace creates a new SipProfileNamespace. + + + + NewVerifiedCallersNamespace creates a new VerifiedCallersNamespace. + + + + NewVideoNamespace creates a new VideoNamespace with all sub-resources initialized. + + + + ResetDeprecationWarnOnce clears the "once" tracking set so deprecation warnings fire again. Test-only helper. + + + + SetDeprecationLogger replaces the package-level deprecation logger. The previous logger is returned so tests can restore it. Passing nil is a no-op. + + + +## Type Aliases + + + + AddressesResource is an alias for AddressesNamespace, matching the Python class name for cross-SDK parity. Prefer AddressesNamespace in new Go code. + + + + CxmlWebhooksResource is the Python class name for the auto-materialized CXML webhook resource. Go aliases AutoMaterializedWebhookResource here. + + + + FabricResource is the Python class name for a CrudResource that exposes the addresses sub-resource. Go aliases CrudWithAddresses here for the same reason as FabricResourcePUT. + + + + FabricResourcePUT is the Python class name for a CrudResource that uses PUT for updates. Go aliases CrudResource here so the cross-language audit sees the same type name on both sides without requiring a distinct struct. + + + + LookupResource is an alias for LookupNamespace, matching the Python class name for cross-SDK parity. Prefer LookupNamespace in new Go code. + + + + NumberGroupsResource is an alias for NumberGroupsNamespace, matching the Python class name for cross-SDK parity. + + + + PhoneCallHandler is the value of the “call\_handler“ field accepted by phone\_numbers.Update. + + + + PhoneNumbersResource is an alias for PhoneNumbersNamespace, matching the Python class name for cross-SDK parity. Prefer PhoneNumbersNamespace in new Go code. + + + + PubSubResource is an alias for PubSubNamespace, matching the Python class name for cross-SDK parity. Prefer PubSubNamespace in new Go code. + + + + QueuesResource is an alias for QueuesNamespace, matching the Python class name for cross-SDK parity. Prefer QueuesNamespace in new Go code. + + + + RecordingsResource is an alias for RecordingsNamespace, matching the Python class name for cross-SDK parity. Prefer RecordingsNamespace in new Go code. + + + + ShortCodesResource is an alias for ShortCodesNamespace, matching the Python class name for cross-SDK parity. Prefer ShortCodesNamespace in new Go code. + + + + SipProfileResource is an alias for SipProfileNamespace, matching the Python class name for cross-SDK parity. Prefer SipProfileNamespace in new Go code. + + + + SwmlWebhooksResource is the Python class name for the auto-materialized SWML webhook resource. Go aliases AutoMaterializedWebhookResource here. + + + +## Classes + + + + AddressesNamespace provides address management (no update endpoint). + + + + AutoMaterializedWebhookResource is a Fabric webhook resource that is normally auto-created by the phone\_numbers.Set\*Webhook helpers. Exposed for backwards compatibility: list/get/update/delete work as usual, but Create now emits a deprecation warning because creating a webhook resource directly produces an orphan that isn't bound to any phone number. + + + + CallFlowOptions holds optional fields for SetCallFlow. + + + + CallFlowsResource extends CrudResource with version management and a singular sub-resource path convention. + + + + CallingNamespace provides REST-based call control. All commands are dispatched as POST /api/calling/calls with a "command" field. + + + + ChatNamespace provides Chat token generation. + + + + CompatAccounts provides compat account/subproject management. + + + + CompatApplications provides compat application management. + + + + CompatCalls provides compat call management with recording and stream sub-resources. + + + + CompatConferences provides compat conference management with participants, recordings, and streams. + + + + CompatFaxes provides compat fax management with media sub-resources. + + + + CompatLamlBins provides compat cXML/LaML script management. + + + + CompatMessages provides compat message management with media sub-resources. + + + + CompatNamespace provides the Twilio-compatible LAML API with AccountSid scoping. + + + + CompatPhoneNumbers provides compat phone number management. + + + + CompatQueues provides compat queue management with members. + + + + CompatRecordings provides compat recording management. + + + + CompatTokens provides compat API token management. + + + + CompatTranscriptions provides compat transcription management. + + + + ConferenceLogs provides conference log queries. + + + + ConferenceRoomsResource uses singular "conference\_room" for sub-resource paths. + + + + CrudResource provides standard List, Create, Get, Update, Delete operations against a REST collection endpoint within a namespace. + + + + CrudWithAddresses extends CrudResource with the nested addresses endpoint. Matches Python's CrudWithAddresses at \_base.py:109-113. Only resources that explicitly support the addresses sub-resource should embed this type; plain CrudResource does not expose ListAddresses. + + + + CxmlApplicationsResource exposes the fabric cXML applications sub-resource. Create is explicitly disallowed — cXML applications cannot be created via this API. This mirrors Python's CxmlApplicationsResource.create raising NotImplementedError (fabric.py:90). + + + + CxmlWebhookOptions holds optional fields for SetCxmlWebhook. + + + + DatasphereDocuments provides document management with search and chunk operations for the Datasphere API. + + + + DatasphereNamespace groups Datasphere API resources. + + + + FabricAddresses provides read-only access to fabric addresses. + + + + FabricNamespace groups all Fabric API resource types. + + + + FabricTokens provides subscriber, guest, invite, and embed token creation. + + + + FaxLogs provides fax log queries. + + + + GenericResources provides operations across all fabric resource types. + + + + ImportedNumbersNamespace provides imported phone number management. + + + + LogsNamespace groups all log query resources. + + + + LookupNamespace provides phone number lookup (carrier, CNAM). + + + + MessageLogs provides message log queries. + + + + MFANamespace provides multi-factor authentication via SMS or phone call. + + + + NumberGroupsNamespace provides number group management with membership operations. + + + + PhoneNumbersNamespace provides phone number management with search and typed helpers for binding an inbound call to a handler (SWML webhook, cXML webhook, AI agent, call flow, RELAY application/topic). + + + + ProjectNamespace groups project management resources. + + + + ProjectTokens provides project API token management. + + + + PubSubNamespace provides PubSub token generation. + + + + QueuesNamespace provides queue management with member operations. + + + + RecordingsNamespace provides recording management (read-only + delete). + + + + RegistryBrands provides 10DLC brand management. + + + + RegistryCampaigns provides 10DLC campaign management. + + + + RegistryNamespace groups all 10DLC Campaign Registry resources. + + + + RegistryNumbers provides 10DLC number assignment management. + + + + RegistryOrders provides 10DLC assignment order management. + + + + RelayTopicOptions holds optional fields for SetRelayTopic. + + + + Resource is a helper for building sub-paths from a base path. + + + + ShortCodesNamespace provides short code management (read + update only). + + + + SipProfileNamespace provides project SIP profile management (singleton resource). + + + + SubscribersResource extends CrudResource with SIP endpoint management. + + + + VerifiedCallersNamespace provides verified caller ID management with verification flow. + + + + VideoConferences provides video conference management with tokens and streams. + + + + VideoConferenceTokens provides video conference token management. + + + + VideoNamespace groups all Video API resources. + + + + VideoRoomRecordings provides video room recording management. + + + + VideoRooms provides video room management with stream sub-resources. + + + + VideoRoomSessions provides video room session management. + + + + VideoRoomTokens provides video room token generation. + + + + VideoStreams provides video stream management. + + + + VoiceLogs provides voice log queries. + + + +## Interfaces + + + + HTTPClient is the interface that namespace implementations use to make HTTP requests. It is satisfied by the httpAdapter in the parent rest package, which prevents an import cycle. + + + +## Source + +[`pkg/rest/namespaces/addresses.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/logs-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/logs-namespace/index.mdx new file mode 100644 index 0000000000..03e106327e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/logs-namespace/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/logs-namespace" +title: "LogsNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.LogsNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `LogsNamespace` + +LogsNamespace groups all log query resources. + +## Signature + +```go +type LogsNamespace struct +``` + +## Properties + + + + + + + + + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 81. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-namespace/index.mdx new file mode 100644 index 0000000000..219fe2aad6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-namespace/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-namespace" +title: "LookupNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.LookupNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/lookup.go" +--- +# `LookupNamespace` + +LookupNamespace provides phone number lookup (carrier, CNAM). + +## Signature + +```go +type LookupNamespace struct +``` + +## Properties + + + +## Methods + + + + PhoneNumber looks up information about a phone number. The e164 parameter should be the number in E.164 format. Optional params can include "include" for additional data (e.g., "carrier"). + + + +## Source + +[`pkg/rest/namespaces/lookup.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/lookup.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-namespace/phone-number.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-namespace/phone-number.mdx new file mode 100644 index 0000000000..89c33e991c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-namespace/phone-number.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-namespace/phone-number" +title: "PhoneNumber" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.LookupNamespace.PhoneNumber" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.LookupNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/lookup.go" +--- +# `PhoneNumber` + +PhoneNumber looks up information about a phone number. The e164 parameter should be the number in E.164 format. Optional params can include "include" for additional data (e.g., "carrier"). + +## Signature + +```go +func (*LookupNamespace) PhoneNumber(e164 string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/lookup.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/lookup.go) + +Line 25. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-resource.mdx new file mode 100644 index 0000000000..7b7e398c93 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/lookup-resource" +title: "LookupResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.LookupResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/lookup.go" +--- +# `LookupResource` + +LookupResource is an alias for LookupNamespace, matching the Python class name for cross-SDK parity. Prefer LookupNamespace in new Go code. + +## Signature + +```go +type LookupResource alias +``` + +## Source + +[`pkg/rest/namespaces/lookup.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/lookup.go) + +Line 31. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs/get.mdx new file mode 100644 index 0000000000..3bf5aa556d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MessageLogs.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MessageLogs" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `Get` + +Get retrieves a specific message log entry. + +## Signature + +```go +func (*MessageLogs) Get(logID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs/index.mdx new file mode 100644 index 0000000000..e2acbad59c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs" +title: "MessageLogs" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MessageLogs" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `MessageLogs` + +MessageLogs provides message log queries. + +## Signature + +```go +type MessageLogs struct +``` + +## Properties + + + +## Methods + + + + Get retrieves a specific message log entry. + + + + List lists message logs. + + + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 13. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs/list.mdx new file mode 100644 index 0000000000..d6a8dc66c7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/message-logs/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MessageLogs.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MessageLogs" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `List` + +List lists message logs. + +## Signature + +```go +func (*MessageLogs) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 18. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/call.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/call.mdx new file mode 100644 index 0000000000..4f3d6de510 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/call.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/call" +title: "Call" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MFANamespace.Call" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MFANamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/mfa.go" +--- +# `Call` + +Call initiates MFA verification via phone call. + +## Signature + +```go +func (*MFANamespace) Call(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/mfa.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/mfa.go) + +Line 28. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/index.mdx new file mode 100644 index 0000000000..84e646ba8e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace" +title: "MFANamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MFANamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/mfa.go" +--- +# `MFANamespace` + +MFANamespace provides multi-factor authentication via SMS or phone call. + +## Signature + +```go +type MFANamespace struct +``` + +## Properties + + + +## Methods + + + + Call initiates MFA verification via phone call. + + + + SMS initiates MFA verification via SMS. + + + + Verify verifies an MFA token for a given request ID. + + + +## Source + +[`pkg/rest/namespaces/mfa.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/mfa.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/sms.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/sms.mdx new file mode 100644 index 0000000000..8f8a886499 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/sms.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/sms" +title: "SMS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MFANamespace.SMS" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MFANamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/mfa.go" +--- +# `SMS` + +SMS initiates MFA verification via SMS. + +## Signature + +```go +func (*MFANamespace) SMS(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/mfa.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/mfa.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/verify.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/verify.mdx new file mode 100644 index 0000000000..8037b39e3f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/verify.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/mfa-namespace/verify" +title: "Verify" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MFANamespace.Verify" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.MFANamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/mfa.go" +--- +# `Verify` + +Verify verifies an MFA token for a given request ID. + +## Signature + +```go +func (*MFANamespace) Verify(requestID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/mfa.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/mfa.go) + +Line 33. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-addresses-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-addresses-namespace.mdx new file mode 100644 index 0000000000..b619ccb6bb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-addresses-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-addresses-namespace" +title: "NewAddressesNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewAddressesNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go" +--- +# `NewAddressesNamespace` + +NewAddressesNamespace creates a new AddressesNamespace. + +## Signature + +```go +func NewAddressesNamespace(client HTTPClient) *AddressesNamespace +``` + +## Parameters + + + +## Returns + +`*AddressesNamespace` + +## Source + +[`pkg/rest/namespaces/addresses.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/addresses.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-calling-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-calling-namespace.mdx new file mode 100644 index 0000000000..5db0bd4fd4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-calling-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-calling-namespace" +title: "NewCallingNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewCallingNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go" +--- +# `NewCallingNamespace` + +NewCallingNamespace creates a new CallingNamespace. + +## Signature + +```go +func NewCallingNamespace(client HTTPClient) *CallingNamespace +``` + +## Parameters + + + +## Returns + +`*CallingNamespace` + +## Source + +[`pkg/rest/namespaces/calling.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/calling.go) + +Line 17. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-chat-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-chat-namespace.mdx new file mode 100644 index 0000000000..a728241ff8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-chat-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-chat-namespace" +title: "NewChatNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewChatNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/chat.go" +--- +# `NewChatNamespace` + +NewChatNamespace creates a new ChatNamespace. + +## Signature + +```go +func NewChatNamespace(client HTTPClient) *ChatNamespace +``` + +## Parameters + + + +## Returns + +`*ChatNamespace` + +## Source + +[`pkg/rest/namespaces/chat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/chat.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-compat-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-compat-namespace.mdx new file mode 100644 index 0000000000..d865958192 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-compat-namespace.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-compat-namespace" +title: "NewCompatNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewCompatNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go" +--- +# `NewCompatNamespace` + +NewCompatNamespace creates a new CompatNamespace with all sub-resources scoped to the given account SID. + +## Signature + +```go +func NewCompatNamespace(client HTTPClient, accountSID string) *CompatNamespace +``` + +## Parameters + + + + + +## Returns + +`*CompatNamespace` + +## Source + +[`pkg/rest/namespaces/compat.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/compat.go) + +Line 395. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-resource-put.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-resource-put.mdx new file mode 100644 index 0000000000..53fb36114e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-resource-put.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-resource-put" +title: "NewCrudResourcePUT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewCrudResourcePUT" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `NewCrudResourcePUT` + +NewCrudResourcePUT creates a CrudResource that uses PUT for updates. + +## Signature + +```go +func NewCrudResourcePUT(client HTTPClient, path string) *CrudResource +``` + +## Parameters + + + + + +## Returns + +`*CrudResource` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 55. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-resource.mdx new file mode 100644 index 0000000000..c6e51a00e7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-resource.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-resource" +title: "NewCrudResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewCrudResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `NewCrudResource` + +NewCrudResource creates a CrudResource with PATCH as the update method. + +## Signature + +```go +func NewCrudResource(client HTTPClient, path string) *CrudResource +``` + +## Parameters + + + + + +## Returns + +`*CrudResource` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 47. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-with-addresses-put.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-with-addresses-put.mdx new file mode 100644 index 0000000000..4f8a9af744 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-with-addresses-put.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-with-addresses-put" +title: "NewCrudWithAddressesPUT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewCrudWithAddressesPUT" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `NewCrudWithAddressesPUT` + +NewCrudWithAddressesPUT constructs a CrudWithAddresses backed by a PUT-update CrudResource. + +## Signature + +```go +func NewCrudWithAddressesPUT(client HTTPClient, path string) *CrudWithAddresses +``` + +## Parameters + + + + + +## Returns + +`*CrudWithAddresses` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 108. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-with-addresses.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-with-addresses.mdx new file mode 100644 index 0000000000..5278fe23a6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-with-addresses.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-crud-with-addresses" +title: "NewCrudWithAddresses" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewCrudWithAddresses" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `NewCrudWithAddresses` + +NewCrudWithAddresses constructs a CrudWithAddresses backed by a PATCH-default CrudResource. Use NewCrudWithAddressesPUT for resources that update via PUT. + +## Signature + +```go +func NewCrudWithAddresses(client HTTPClient, path string) *CrudWithAddresses +``` + +## Parameters + + + + + +## Returns + +`*CrudWithAddresses` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 102. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-datasphere-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-datasphere-namespace.mdx new file mode 100644 index 0000000000..2c24100609 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-datasphere-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-datasphere-namespace" +title: "NewDatasphereNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewDatasphereNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go" +--- +# `NewDatasphereNamespace` + +NewDatasphereNamespace creates a new DatasphereNamespace. + +## Signature + +```go +func NewDatasphereNamespace(client HTTPClient) *DatasphereNamespace +``` + +## Parameters + + + +## Returns + +`*DatasphereNamespace` + +## Source + +[`pkg/rest/namespaces/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/datasphere.go) + +Line 42. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-fabric-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-fabric-namespace.mdx new file mode 100644 index 0000000000..90af04718f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-fabric-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-fabric-namespace" +title: "NewFabricNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewFabricNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `NewFabricNamespace` + +NewFabricNamespace creates a new FabricNamespace with all sub-resources initialized. + +## Signature + +```go +func NewFabricNamespace(client HTTPClient) *FabricNamespace +``` + +## Parameters + + + +## Returns + +`*FabricNamespace` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 362. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-imported-numbers-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-imported-numbers-namespace.mdx new file mode 100644 index 0000000000..cb1d397004 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-imported-numbers-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-imported-numbers-namespace" +title: "NewImportedNumbersNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewImportedNumbersNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/imported_numbers.go" +--- +# `NewImportedNumbersNamespace` + +NewImportedNumbersNamespace creates a new ImportedNumbersNamespace. + +## Signature + +```go +func NewImportedNumbersNamespace(client HTTPClient) *ImportedNumbersNamespace +``` + +## Parameters + + + +## Returns + +`*ImportedNumbersNamespace` + +## Source + +[`pkg/rest/namespaces/imported_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/imported_numbers.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-logs-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-logs-namespace.mdx new file mode 100644 index 0000000000..047c594192 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-logs-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-logs-namespace" +title: "NewLogsNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewLogsNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `NewLogsNamespace` + +NewLogsNamespace creates a new LogsNamespace with all sub-resources initialized. + +## Signature + +```go +func NewLogsNamespace(client HTTPClient) *LogsNamespace +``` + +## Parameters + + + +## Returns + +`*LogsNamespace` + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 89. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-lookup-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-lookup-namespace.mdx new file mode 100644 index 0000000000..f8a6e14130 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-lookup-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-lookup-namespace" +title: "NewLookupNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewLookupNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/lookup.go" +--- +# `NewLookupNamespace` + +NewLookupNamespace creates a new LookupNamespace. + +## Signature + +```go +func NewLookupNamespace(client HTTPClient) *LookupNamespace +``` + +## Parameters + + + +## Returns + +`*LookupNamespace` + +## Source + +[`pkg/rest/namespaces/lookup.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/lookup.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-mfa-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-mfa-namespace.mdx new file mode 100644 index 0000000000..4944f8265f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-mfa-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-mfa-namespace" +title: "NewMFANamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewMFANamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/mfa.go" +--- +# `NewMFANamespace` + +NewMFANamespace creates a new MFANamespace. + +## Signature + +```go +func NewMFANamespace(client HTTPClient) *MFANamespace +``` + +## Parameters + + + +## Returns + +`*MFANamespace` + +## Source + +[`pkg/rest/namespaces/mfa.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/mfa.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-number-groups-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-number-groups-namespace.mdx new file mode 100644 index 0000000000..27afad3c4c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-number-groups-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-number-groups-namespace" +title: "NewNumberGroupsNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewNumberGroupsNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go" +--- +# `NewNumberGroupsNamespace` + +NewNumberGroupsNamespace creates a new NumberGroupsNamespace. + +## Signature + +```go +func NewNumberGroupsNamespace(client HTTPClient) *NumberGroupsNamespace +``` + +## Parameters + + + +## Returns + +`*NumberGroupsNamespace` + +## Source + +[`pkg/rest/namespaces/number_groups.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-phone-numbers-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-phone-numbers-namespace.mdx new file mode 100644 index 0000000000..471c22ac31 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-phone-numbers-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-phone-numbers-namespace" +title: "NewPhoneNumbersNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewPhoneNumbersNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `NewPhoneNumbersNamespace` + +NewPhoneNumbersNamespace creates a new PhoneNumbersNamespace. + +## Signature + +```go +func NewPhoneNumbersNamespace(client HTTPClient) *PhoneNumbersNamespace +``` + +## Parameters + + + +## Returns + +`*PhoneNumbersNamespace` + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 26. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-project-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-project-namespace.mdx new file mode 100644 index 0000000000..82dac84c02 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-project-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-project-namespace" +title: "NewProjectNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewProjectNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go" +--- +# `NewProjectNamespace` + +NewProjectNamespace creates a new ProjectNamespace. + +## Signature + +```go +func NewProjectNamespace(client HTTPClient) *ProjectNamespace +``` + +## Parameters + + + +## Returns + +`*ProjectNamespace` + +## Source + +[`pkg/rest/namespaces/project.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go) + +Line 36. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-pub-sub-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-pub-sub-namespace.mdx new file mode 100644 index 0000000000..2d2c1925f2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-pub-sub-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-pub-sub-namespace" +title: "NewPubSubNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewPubSubNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/pubsub.go" +--- +# `NewPubSubNamespace` + +NewPubSubNamespace creates a new PubSubNamespace. + +## Signature + +```go +func NewPubSubNamespace(client HTTPClient) *PubSubNamespace +``` + +## Parameters + + + +## Returns + +`*PubSubNamespace` + +## Source + +[`pkg/rest/namespaces/pubsub.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/pubsub.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-queues-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-queues-namespace.mdx new file mode 100644 index 0000000000..bd487266fe --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-queues-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-queues-namespace" +title: "NewQueuesNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewQueuesNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go" +--- +# `NewQueuesNamespace` + +NewQueuesNamespace creates a new QueuesNamespace. + +## Signature + +```go +func NewQueuesNamespace(client HTTPClient) *QueuesNamespace +``` + +## Parameters + + + +## Returns + +`*QueuesNamespace` + +## Source + +[`pkg/rest/namespaces/queues.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-recordings-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-recordings-namespace.mdx new file mode 100644 index 0000000000..d78d820e2b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-recordings-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-recordings-namespace" +title: "NewRecordingsNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewRecordingsNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go" +--- +# `NewRecordingsNamespace` + +NewRecordingsNamespace creates a new RecordingsNamespace. + +## Signature + +```go +func NewRecordingsNamespace(client HTTPClient) *RecordingsNamespace +``` + +## Parameters + + + +## Returns + +`*RecordingsNamespace` + +## Source + +[`pkg/rest/namespaces/recordings.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go) + +Line 18. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-registry-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-registry-namespace.mdx new file mode 100644 index 0000000000..a3fd5c5ac7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-registry-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-registry-namespace" +title: "NewRegistryNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewRegistryNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `NewRegistryNamespace` + +NewRegistryNamespace creates a new RegistryNamespace with all sub-resources. + +## Signature + +```go +func NewRegistryNamespace(client HTTPClient) *RegistryNamespace +``` + +## Parameters + + + +## Returns + +`*RegistryNamespace` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 109. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-short-codes-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-short-codes-namespace.mdx new file mode 100644 index 0000000000..905b70257d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-short-codes-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-short-codes-namespace" +title: "NewShortCodesNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewShortCodesNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go" +--- +# `NewShortCodesNamespace` + +NewShortCodesNamespace creates a new ShortCodesNamespace. + +## Signature + +```go +func NewShortCodesNamespace(client HTTPClient) *ShortCodesNamespace +``` + +## Parameters + + + +## Returns + +`*ShortCodesNamespace` + +## Source + +[`pkg/rest/namespaces/short_codes.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go) + +Line 18. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-sip-profile-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-sip-profile-namespace.mdx new file mode 100644 index 0000000000..89e8c4624c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-sip-profile-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-sip-profile-namespace" +title: "NewSipProfileNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewSipProfileNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/sip_profile.go" +--- +# `NewSipProfileNamespace` + +NewSipProfileNamespace creates a new SipProfileNamespace. + +## Signature + +```go +func NewSipProfileNamespace(client HTTPClient) *SipProfileNamespace +``` + +## Parameters + + + +## Returns + +`*SipProfileNamespace` + +## Source + +[`pkg/rest/namespaces/sip_profile.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/sip_profile.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-verified-callers-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-verified-callers-namespace.mdx new file mode 100644 index 0000000000..1ee551e955 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-verified-callers-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-verified-callers-namespace" +title: "NewVerifiedCallersNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewVerifiedCallersNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/verified_callers.go" +--- +# `NewVerifiedCallersNamespace` + +NewVerifiedCallersNamespace creates a new VerifiedCallersNamespace. + +## Signature + +```go +func NewVerifiedCallersNamespace(client HTTPClient) *VerifiedCallersNamespace +``` + +## Parameters + + + +## Returns + +`*VerifiedCallersNamespace` + +## Source + +[`pkg/rest/namespaces/verified_callers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/verified_callers.go) + +Line 17. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-video-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-video-namespace.mdx new file mode 100644 index 0000000000..27b18cfe8e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-video-namespace.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/new-video-namespace" +title: "NewVideoNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NewVideoNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `NewVideoNamespace` + +NewVideoNamespace creates a new VideoNamespace with all sub-resources initialized. + +## Signature + +```go +func NewVideoNamespace(client HTTPClient) *VideoNamespace +``` + +## Parameters + + + +## Returns + +`*VideoNamespace` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 175. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/add-membership.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/add-membership.mdx new file mode 100644 index 0000000000..96f4177d31 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/add-membership.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/add-membership" +title: "AddMembership" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NumberGroupsNamespace.AddMembership" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NumberGroupsNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go" +--- +# `AddMembership` + +AddMembership adds a number to a group. + +## Signature + +```go +func (*NumberGroupsNamespace) AddMembership(groupID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/number_groups.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go) + +Line 28. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/delete-membership.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/delete-membership.mdx new file mode 100644 index 0000000000..ba647f4b3d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/delete-membership.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/delete-membership" +title: "DeleteMembership" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NumberGroupsNamespace.DeleteMembership" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NumberGroupsNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go" +--- +# `DeleteMembership` + +DeleteMembership removes a membership by ID. + +## Signature + +```go +func (*NumberGroupsNamespace) DeleteMembership(membershipID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/number_groups.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go) + +Line 38. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/get-membership.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/get-membership.mdx new file mode 100644 index 0000000000..8719871e1a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/get-membership.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/get-membership" +title: "GetMembership" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NumberGroupsNamespace.GetMembership" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NumberGroupsNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go" +--- +# `GetMembership` + +GetMembership retrieves a specific membership by ID. + +## Signature + +```go +func (*NumberGroupsNamespace) GetMembership(membershipID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/number_groups.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go) + +Line 33. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/index.mdx new file mode 100644 index 0000000000..b4834bfaf7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace" +title: "NumberGroupsNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NumberGroupsNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go" +--- +# `NumberGroupsNamespace` + +NumberGroupsNamespace provides number group management with membership operations. + +## Signature + +```go +type NumberGroupsNamespace struct +``` + +## Properties + + + +## Methods + + + + AddMembership adds a number to a group. + + + + DeleteMembership removes a membership by ID. + + + + GetMembership retrieves a specific membership by ID. + + + + ListMemberships lists number group memberships for a group. + + + +## Source + +[`pkg/rest/namespaces/number_groups.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/list-memberships.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/list-memberships.mdx new file mode 100644 index 0000000000..f4c9322b61 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/list-memberships.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-namespace/list-memberships" +title: "ListMemberships" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NumberGroupsNamespace.ListMemberships" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NumberGroupsNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go" +--- +# `ListMemberships` + +ListMemberships lists number group memberships for a group. + +## Signature + +```go +func (*NumberGroupsNamespace) ListMemberships(groupID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/number_groups.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-resource.mdx new file mode 100644 index 0000000000..1b4ce0d4ab --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/number-groups-resource" +title: "NumberGroupsResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.NumberGroupsResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go" +--- +# `NumberGroupsResource` + +NumberGroupsResource is an alias for NumberGroupsNamespace, matching the Python class name for cross-SDK parity. + +## Signature + +```go +type NumberGroupsResource alias +``` + +## Source + +[`pkg/rest/namespaces/number_groups.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/number_groups.go) + +Line 44. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-call-handler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-call-handler.mdx new file mode 100644 index 0000000000..0956d625df --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-call-handler.mdx @@ -0,0 +1,88 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-call-handler" +title: "PhoneCallHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneCallHandler" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/call_handler.go" +--- +# `PhoneCallHandler` + +PhoneCallHandler is the value of the “call\_handler“ field accepted by phone\_numbers.Update. + +Named PhoneCallHandler (not CallHandler) to avoid colliding with the RELAY client's inbound-call-handler callback type already present in the SDK (pkg/relay OnCallHandler). + +Setting a phone number's call\_handler + the handler-specific companion field routes inbound calls and, for most values, auto-materializes the matching Fabric resource on the server. See the high-level helpers on PhoneNumbersNamespace (SetSwmlWebhook, SetCxmlWebhook, SetCxmlApplication, SetAiAgent, SetCallFlow, SetRelayApplication, SetRelayTopic). + +``` +Enum member Companion field (required) Auto-creates resource +RelayScript call_relay_script_url swml_webhook +LamlWebhooks call_request_url cxml_webhook +LamlApplication call_laml_application_id cxml_application +AiAgent call_ai_agent_id ai_agent +CallFlow call_flow_id call_flow +RelayApplication call_relay_application relay_application +RelayTopic call_relay_topic (routes via RELAY) +RelayContext call_relay_context (legacy, prefer topic) +RelayConnector (connector config) (internal) +VideoRoom call_video_room_id (routes to Video API) +Dialogflow call_dialogflow_agent_id (none) +``` + +Note: LamlWebhooks (wire value "laml\_webhooks") produces a cXML handler, not a generic webhook. For SWML, use RelayScript. + +## Signature + +```go +type PhoneCallHandler alias +``` + +## Examples + + + + ```go + Enum member Companion field (required) Auto-creates resource + RelayScript call_relay_script_url swml_webhook + LamlWebhooks call_request_url cxml_webhook + LamlApplication call_laml_application_id cxml_application + AiAgent call_ai_agent_id ai_agent + CallFlow call_flow_id call_flow + RelayApplication call_relay_application relay_application + RelayTopic call_relay_topic (routes via RELAY) + RelayContext call_relay_context (legacy, prefer topic) + RelayConnector (connector config) (internal) + VideoRoom call_video_room_id (routes to Video API) + Dialogflow call_dialogflow_agent_id (none) + ``` + + + + ```go + Enum member Companion field (required) Auto-creates resource + RelayScript call_relay_script_url swml_webhook + LamlWebhooks call_request_url cxml_webhook + LamlApplication call_laml_application_id cxml_application + AiAgent call_ai_agent_id ai_agent + CallFlow call_flow_id call_flow + RelayApplication call_relay_application relay_application + RelayTopic call_relay_topic (routes via RELAY) + RelayContext call_relay_context (legacy, prefer topic) + RelayConnector (connector config) (internal) + VideoRoom call_video_room_id (routes to Video API) + Dialogflow call_dialogflow_agent_id (none) + ``` + + + +## Source + +[`pkg/rest/namespaces/call_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/call_handler.go) + +Line 38. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/index.mdx new file mode 100644 index 0000000000..b9f1374ad4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace" +title: "PhoneNumbersNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `PhoneNumbersNamespace` + +PhoneNumbersNamespace provides phone number management with search and typed helpers for binding an inbound call to a handler (SWML webhook, cXML webhook, AI agent, call flow, RELAY application/topic). + +Binding model: set “call\_handler“ + the handler-specific companion field on the phone number; the server auto-materializes the matching Fabric resource. The helpers below (Set\*) are one-line wrappers around Update with the right call\_handler + field combination baked in. See PhoneCallHandler for the enum. + +## Signature + +```go +type PhoneNumbersNamespace struct +``` + +## Properties + + + +## Methods + + + + Search searches for available phone numbers with optional filter parameters such as area\_code, contains, starts\_with, etc. + + + + SetAiAgent routes inbound calls to an AI Agent Fabric resource by ID. + + + + SetCallFlow routes inbound calls to a Call Flow by ID. Pass nil opts for the minimal form; pass opts.Version to pin a specific version. + + + + SetCxmlApplication routes inbound calls to an existing cXML application by ID. + + + + SetCxmlWebhook routes inbound calls to a cXML (Twilio-compat / LAML) webhook. + + + + SetRelayApplication routes inbound calls to a named RELAY application. + + + + SetRelayTopic routes inbound calls to a RELAY topic (client subscription). Pass nil opts for the minimal form. + + + + SetSwmlWebhook routes inbound calls to an SWML webhook URL. + + + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 21. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/search.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/search.mdx new file mode 100644 index 0000000000..4d91e2fc24 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/search.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/search" +title: "Search" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace.Search" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `Search` + +Search searches for available phone numbers with optional filter parameters such as area\_code, contains, starts\_with, etc. + +params may contain values of any type (string, int, bool, etc.); they are converted to strings internally before the HTTP request is made, matching Python's \*\*params behaviour which accepts numeric and boolean query values. + +## Signature + +```go +func (*PhoneNumbersNamespace) Search(params map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 38. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-ai-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-ai-agent.mdx new file mode 100644 index 0000000000..c1efde2b96 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-ai-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-ai-agent" +title: "SetAiAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace.SetAiAgent" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `SetAiAgent` + +SetAiAgent routes inbound calls to an AI Agent Fabric resource by ID. + +## Signature + +```go +func (*PhoneNumbersNamespace) SetAiAgent(sid string, agentID string, extra ...map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 115. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-call-flow.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-call-flow.mdx new file mode 100644 index 0000000000..a9d4f5df69 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-call-flow.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-call-flow" +title: "SetCallFlow" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace.SetCallFlow" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `SetCallFlow` + +SetCallFlow routes inbound calls to a Call Flow by ID. Pass nil opts for the minimal form; pass opts.Version to pin a specific version. + +## Signature + +```go +func (*PhoneNumbersNamespace) SetCallFlow(sid string, flowID string, opts *CallFlowOptions) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 135. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-application.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-application.mdx new file mode 100644 index 0000000000..9a6c5bb4be --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-application.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-application" +title: "SetCxmlApplication" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace.SetCxmlApplication" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `SetCxmlApplication` + +SetCxmlApplication routes inbound calls to an existing cXML application by ID. + +## Signature + +```go +func (*PhoneNumbersNamespace) SetCxmlApplication(sid string, applicationID string, extra ...map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 105. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-webhook.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-webhook.mdx new file mode 100644 index 0000000000..26a7123605 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-webhook.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-webhook" +title: "SetCxmlWebhook" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace.SetCxmlWebhook" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `SetCxmlWebhook` + +SetCxmlWebhook routes inbound calls to a cXML (Twilio-compat / LAML) webhook. + +Despite the wire value "laml\_webhooks" being plural, this creates a single cxml\_webhook Fabric resource. Pass opts to set FallbackURL and StatusCallbackURL; pass nil for the minimal form. + +## Signature + +```go +func (*PhoneNumbersNamespace) SetCxmlWebhook(sid string, url string, opts *CxmlWebhookOptions) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 85. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-application.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-application.mdx new file mode 100644 index 0000000000..e1a166a2df --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-application.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-application" +title: "SetRelayApplication" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace.SetRelayApplication" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `SetRelayApplication` + +SetRelayApplication routes inbound calls to a named RELAY application. + +## Signature + +```go +func (*PhoneNumbersNamespace) SetRelayApplication(sid string, name string, extra ...map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 152. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-topic.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-topic.mdx new file mode 100644 index 0000000000..e75186808c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-topic.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-topic" +title: "SetRelayTopic" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace.SetRelayTopic" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `SetRelayTopic` + +SetRelayTopic routes inbound calls to a RELAY topic (client subscription). Pass nil opts for the minimal form. + +## Signature + +```go +func (*PhoneNumbersNamespace) SetRelayTopic(sid string, topic string, opts *RelayTopicOptions) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 171. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-swml-webhook.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-swml-webhook.mdx new file mode 100644 index 0000000000..6bd157a4c1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-swml-webhook.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-namespace/set-swml-webhook" +title: "SetSwmlWebhook" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace.SetSwmlWebhook" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `SetSwmlWebhook` + +SetSwmlWebhook routes inbound calls to an SWML webhook URL. + +Your backend returns an SWML document per call. The server auto-creates a swml\_webhook Fabric resource keyed off this URL. + +## Signature + +```go +func (*PhoneNumbersNamespace) SetSwmlWebhook(sid string, url string, extra ...map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 61. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-resource.mdx new file mode 100644 index 0000000000..dc3022a275 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/phone-numbers-resource" +title: "PhoneNumbersResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PhoneNumbersResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `PhoneNumbersResource` + +PhoneNumbersResource is an alias for PhoneNumbersNamespace, matching the Python class name for cross-SDK parity. Prefer PhoneNumbersNamespace in new Go code. + +## Signature + +```go +type PhoneNumbersResource alias +``` + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 201. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-namespace/index.mdx new file mode 100644 index 0000000000..1cf76491b5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-namespace/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-namespace" +title: "ProjectNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ProjectNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go" +--- +# `ProjectNamespace` + +ProjectNamespace groups project management resources. + +## Signature + +```go +type ProjectNamespace struct +``` + +## Properties + + + +## Source + +[`pkg/rest/namespaces/project.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go) + +Line 31. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/create.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/create.mdx new file mode 100644 index 0000000000..206f4ccac4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/create.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/create" +title: "Create" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ProjectTokens.Create" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ProjectTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go" +--- +# `Create` + +Create creates a new project API token. + +## Signature + +```go +func (*ProjectTokens) Create(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/project.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/delete.mdx new file mode 100644 index 0000000000..c6c639bf4c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ProjectTokens.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ProjectTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go" +--- +# `Delete` + +Delete removes a project API token. + +## Signature + +```go +func (*ProjectTokens) Delete(tokenID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/project.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go) + +Line 26. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/index.mdx new file mode 100644 index 0000000000..4ef9eb5e3b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens" +title: "ProjectTokens" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ProjectTokens" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go" +--- +# `ProjectTokens` + +ProjectTokens provides project API token management. + +## Signature + +```go +type ProjectTokens struct +``` + +## Properties + + + +## Methods + + + + Create creates a new project API token. + + + + Delete removes a project API token. + + + + Update modifies a project API token. + + + +## Source + +[`pkg/rest/namespaces/project.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/update.mdx new file mode 100644 index 0000000000..44e62ce809 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/project-tokens/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ProjectTokens.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ProjectTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go" +--- +# `Update` + +Update modifies a project API token. + +## Signature + +```go +func (*ProjectTokens) Update(tokenID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/project.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/project.go) + +Line 21. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-namespace/create-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-namespace/create-token.mdx new file mode 100644 index 0000000000..21a5d8a19c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-namespace/create-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-namespace/create-token" +title: "CreateToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PubSubNamespace.CreateToken" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PubSubNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/pubsub.go" +--- +# `CreateToken` + +CreateToken creates a PubSub token. + +## Signature + +```go +func (*PubSubNamespace) CreateToken(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/pubsub.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/pubsub.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-namespace/index.mdx new file mode 100644 index 0000000000..c9709df061 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-namespace/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-namespace" +title: "PubSubNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PubSubNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/pubsub.go" +--- +# `PubSubNamespace` + +PubSubNamespace provides PubSub token generation. + +## Signature + +```go +type PubSubNamespace struct +``` + +## Properties + + + +## Methods + + + + CreateToken creates a PubSub token. + + + +## Source + +[`pkg/rest/namespaces/pubsub.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/pubsub.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-resource.mdx new file mode 100644 index 0000000000..d0385b9950 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/pub-sub-resource" +title: "PubSubResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.PubSubResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/pubsub.go" +--- +# `PubSubResource` + +PubSubResource is an alias for PubSubNamespace, matching the Python class name for cross-SDK parity. Prefer PubSubNamespace in new Go code. + +## Signature + +```go +type PubSubResource alias +``` + +## Source + +[`pkg/rest/namespaces/pubsub.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/pubsub.go) + +Line 29. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/get-member.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/get-member.mdx new file mode 100644 index 0000000000..7d19e97368 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/get-member.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/get-member" +title: "GetMember" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.QueuesNamespace.GetMember" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.QueuesNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go" +--- +# `GetMember` + +GetMember retrieves a specific member from a queue. + +## Signature + +```go +func (*QueuesNamespace) GetMember(queueID string, memberID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/queues.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go) + +Line 33. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/get-next-member.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/get-next-member.mdx new file mode 100644 index 0000000000..317ac1e68a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/get-next-member.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/get-next-member" +title: "GetNextMember" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.QueuesNamespace.GetNextMember" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.QueuesNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go" +--- +# `GetNextMember` + +GetNextMember retrieves the next member in the queue. + +## Signature + +```go +func (*QueuesNamespace) GetNextMember(queueID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/queues.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go) + +Line 28. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/index.mdx new file mode 100644 index 0000000000..fbeda12b11 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace" +title: "QueuesNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.QueuesNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go" +--- +# `QueuesNamespace` + +QueuesNamespace provides queue management with member operations. + +## Signature + +```go +type QueuesNamespace struct +``` + +## Properties + + + +## Methods + + + + GetMember retrieves a specific member from a queue. + + + + GetNextMember retrieves the next member in the queue. + + + + ListMembers lists members of a queue. + + + +## Source + +[`pkg/rest/namespaces/queues.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/list-members.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/list-members.mdx new file mode 100644 index 0000000000..80beaa31e8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/list-members.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-namespace/list-members" +title: "ListMembers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.QueuesNamespace.ListMembers" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.QueuesNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go" +--- +# `ListMembers` + +ListMembers lists members of a queue. + +## Signature + +```go +func (*QueuesNamespace) ListMembers(queueID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/queues.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-resource.mdx new file mode 100644 index 0000000000..47c778f321 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/queues-resource" +title: "QueuesResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.QueuesResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go" +--- +# `QueuesResource` + +QueuesResource is an alias for QueuesNamespace, matching the Python class name for cross-SDK parity. Prefer QueuesNamespace in new Go code. + +## Signature + +```go +type QueuesResource alias +``` + +## Source + +[`pkg/rest/namespaces/queues.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/queues.go) + +Line 39. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/delete.mdx new file mode 100644 index 0000000000..8e3669de67 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RecordingsNamespace.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RecordingsNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go" +--- +# `Delete` + +Delete removes a recording by ID. + +## Signature + +```go +func (*RecordingsNamespace) Delete(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/recordings.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go) + +Line 48. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/get.mdx new file mode 100644 index 0000000000..1377fa2cb5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RecordingsNamespace.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RecordingsNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go" +--- +# `Get` + +Get retrieves a recording by ID. + +## Signature + +```go +func (*RecordingsNamespace) Get(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/recordings.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go) + +Line 43. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/index.mdx new file mode 100644 index 0000000000..1794ce9da7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace" +title: "RecordingsNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RecordingsNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go" +--- +# `RecordingsNamespace` + +RecordingsNamespace provides recording management (read-only + delete). + +## Signature + +```go +type RecordingsNamespace struct +``` + +## Properties + + + +## Methods + + + + Delete removes a recording by ID. + + + + Get retrieves a recording by ID. + + + + List lists all recordings. params may contain values of any type (matching Python's \*\*data); non-string values are stringified via fmt.Sprintf before being sent as query parameters. + + + +## Source + +[`pkg/rest/namespaces/recordings.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go) + +Line 13. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/list.mdx new file mode 100644 index 0000000000..54f5472511 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-namespace/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RecordingsNamespace.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RecordingsNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go" +--- +# `List` + +List lists all recordings. params may contain values of any type (matching Python's \*\*data); non-string values are stringified via fmt.Sprintf before being sent as query parameters. + +## Signature + +```go +func (*RecordingsNamespace) List(params map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/recordings.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go) + +Line 27. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-resource.mdx new file mode 100644 index 0000000000..bdd4639a3b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/recordings-resource" +title: "RecordingsResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RecordingsResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go" +--- +# `RecordingsResource` + +RecordingsResource is an alias for RecordingsNamespace, matching the Python class name for cross-SDK parity. Prefer RecordingsNamespace in new Go code. + +## Signature + +```go +type RecordingsResource alias +``` + +## Source + +[`pkg/rest/namespaces/recordings.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/recordings.go) + +Line 54. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/create-campaign.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/create-campaign.mdx new file mode 100644 index 0000000000..d9a8a24d2a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/create-campaign.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/create-campaign" +title: "CreateCampaign" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryBrands.CreateCampaign" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryBrands" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `CreateCampaign` + +CreateCampaign creates a campaign under a brand. + +## Signature + +```go +func (*RegistryBrands) CreateCampaign(brandID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 38. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/create.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/create.mdx new file mode 100644 index 0000000000..cf08c8016d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/create.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/create" +title: "Create" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryBrands.Create" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryBrands" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `Create` + +Create creates a new brand. + +## Signature + +```go +func (*RegistryBrands) Create(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/get.mdx new file mode 100644 index 0000000000..a336ceadd1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryBrands.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryBrands" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `Get` + +Get retrieves a brand by ID. + +## Signature + +```go +func (*RegistryBrands) Get(brandID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 28. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/index.mdx new file mode 100644 index 0000000000..cd3ae4e361 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands" +title: "RegistryBrands" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryBrands" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `RegistryBrands` + +RegistryBrands provides 10DLC brand management. + +## Signature + +```go +type RegistryBrands struct +``` + +## Properties + + + +## Methods + + + + Create creates a new brand. + + + + CreateCampaign creates a campaign under a brand. + + + + Get retrieves a brand by ID. + + + + List lists all brands. + + + + ListCampaigns lists campaigns for a brand. + + + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 13. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/list-campaigns.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/list-campaigns.mdx new file mode 100644 index 0000000000..21c714b465 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/list-campaigns.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/list-campaigns" +title: "ListCampaigns" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryBrands.ListCampaigns" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryBrands" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `ListCampaigns` + +ListCampaigns lists campaigns for a brand. + +## Signature + +```go +func (*RegistryBrands) ListCampaigns(brandID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 33. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/list.mdx new file mode 100644 index 0000000000..ec7d5381ce --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-brands/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryBrands.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryBrands" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `List` + +List lists all brands. + +## Signature + +```go +func (*RegistryBrands) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 18. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/create-order.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/create-order.mdx new file mode 100644 index 0000000000..165ae5adbd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/create-order.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/create-order" +title: "CreateOrder" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryCampaigns.CreateOrder" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryCampaigns" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `CreateOrder` + +CreateOrder creates a number assignment order for a campaign. + +## Signature + +```go +func (*RegistryCampaigns) CreateOrder(campaignID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 70. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/get.mdx new file mode 100644 index 0000000000..888737191f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryCampaigns.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryCampaigns" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `Get` + +Get retrieves a campaign by ID. + +## Signature + +```go +func (*RegistryCampaigns) Get(campaignID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 50. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/index.mdx new file mode 100644 index 0000000000..8dd5fc44a0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns" +title: "RegistryCampaigns" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryCampaigns" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `RegistryCampaigns` + +RegistryCampaigns provides 10DLC campaign management. + +## Signature + +```go +type RegistryCampaigns struct +``` + +## Properties + + + +## Methods + + + + CreateOrder creates a number assignment order for a campaign. + + + + Get retrieves a campaign by ID. + + + + ListNumbers lists numbers assigned to a campaign. + + + + ListOrders lists orders for a campaign. + + + + Update modifies a campaign by ID. + + + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 45. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/list-numbers.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/list-numbers.mdx new file mode 100644 index 0000000000..b29a625433 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/list-numbers.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/list-numbers" +title: "ListNumbers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryCampaigns.ListNumbers" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryCampaigns" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `ListNumbers` + +ListNumbers lists numbers assigned to a campaign. + +## Signature + +```go +func (*RegistryCampaigns) ListNumbers(campaignID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 60. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/list-orders.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/list-orders.mdx new file mode 100644 index 0000000000..bf697375f3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/list-orders.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/list-orders" +title: "ListOrders" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryCampaigns.ListOrders" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryCampaigns" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `ListOrders` + +ListOrders lists orders for a campaign. + +## Signature + +```go +func (*RegistryCampaigns) ListOrders(campaignID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 65. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/update.mdx new file mode 100644 index 0000000000..e526c20ef8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-campaigns/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryCampaigns.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryCampaigns" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `Update` + +Update modifies a campaign by ID. + +## Signature + +```go +func (*RegistryCampaigns) Update(campaignID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 55. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-namespace/index.mdx new file mode 100644 index 0000000000..069a7fc1aa --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-namespace/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-namespace" +title: "RegistryNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `RegistryNamespace` + +RegistryNamespace groups all 10DLC Campaign Registry resources. + +## Signature + +```go +type RegistryNamespace struct +``` + +## Properties + + + + + + + + + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 101. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-numbers/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-numbers/delete.mdx new file mode 100644 index 0000000000..f92a0123c8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-numbers/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-numbers/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryNumbers.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryNumbers" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `Delete` + +Delete removes a number assignment. + +## Signature + +```go +func (*RegistryNumbers) Delete(numberID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 94. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-numbers/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-numbers/index.mdx new file mode 100644 index 0000000000..3fb466f20e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-numbers/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-numbers" +title: "RegistryNumbers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryNumbers" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `RegistryNumbers` + +RegistryNumbers provides 10DLC number assignment management. + +## Signature + +```go +type RegistryNumbers struct +``` + +## Properties + + + +## Methods + + + + Delete removes a number assignment. + + + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 89. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-orders/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-orders/get.mdx new file mode 100644 index 0000000000..708a42fc78 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-orders/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-orders/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryOrders.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryOrders" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `Get` + +Get retrieves an order by ID. + +## Signature + +```go +func (*RegistryOrders) Get(orderID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 82. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-orders/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-orders/index.mdx new file mode 100644 index 0000000000..30634f0a1e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-orders/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/registry-orders" +title: "RegistryOrders" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RegistryOrders" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go" +--- +# `RegistryOrders` + +RegistryOrders provides 10DLC assignment order management. + +## Signature + +```go +type RegistryOrders struct +``` + +## Properties + + + +## Methods + + + + Get retrieves an order by ID. + + + +## Source + +[`pkg/rest/namespaces/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/registry.go) + +Line 77. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/relay-topic-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/relay-topic-options/index.mdx new file mode 100644 index 0000000000..f7060e401e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/relay-topic-options/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/relay-topic-options" +title: "RelayTopicOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.RelayTopicOptions" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go" +--- +# `RelayTopicOptions` + +RelayTopicOptions holds optional fields for SetRelayTopic. + +## Signature + +```go +type RelayTopicOptions struct +``` + +## Properties + + + Extra passes through additional wire-level fields. + + + + StatusCallbackURL receives topic status updates. + + +## Source + +[`pkg/rest/namespaces/phone_numbers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/phone_numbers.go) + +Line 162. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/reset-deprecation-warn-once.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/reset-deprecation-warn-once.mdx new file mode 100644 index 0000000000..9fd553b467 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/reset-deprecation-warn-once.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/reset-deprecation-warn-once" +title: "ResetDeprecationWarnOnce" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ResetDeprecationWarnOnce" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `ResetDeprecationWarnOnce` + +ResetDeprecationWarnOnce clears the "once" tracking set so deprecation warnings fire again. Test-only helper. + +## Signature + +```go +func ResetDeprecationWarnOnce() +``` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 67. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/resource/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/resource/index.mdx new file mode 100644 index 0000000000..ac39e60cff --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/resource/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/resource" +title: "Resource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.Resource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `Resource` + +Resource is a helper for building sub-paths from a base path. + +## Signature + +```go +type Resource struct +``` + +## Properties + + + + + +## Methods + + + + Path joins additional segments onto the base path. + + + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 26. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/resource/path.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/resource/path.mdx new file mode 100644 index 0000000000..4b6c65873c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/resource/path.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/resource/path" +title: "Path" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.Resource.Path" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.Resource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go" +--- +# `Path` + +Path joins additional segments onto the base path. + +## Signature + +```go +func (*Resource) Path(parts ...string) string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`pkg/rest/namespaces/common.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/common.go) + +Line 32. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/set-deprecation-logger.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/set-deprecation-logger.mdx new file mode 100644 index 0000000000..8aa7c52110 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/set-deprecation-logger.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/set-deprecation-logger" +title: "SetDeprecationLogger" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SetDeprecationLogger" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `SetDeprecationLogger` + +SetDeprecationLogger replaces the package-level deprecation logger. The previous logger is returned so tests can restore it. Passing nil is a no-op. + +## Signature + +```go +func SetDeprecationLogger(l *logging.Logger) *logging.Logger +``` + +## Parameters + + + +## Returns + +`*logging.Logger` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 54. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/get.mdx new file mode 100644 index 0000000000..7819ce288c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ShortCodesNamespace.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ShortCodesNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go" +--- +# `Get` + +Get retrieves a short code by ID. + +## Signature + +```go +func (*ShortCodesNamespace) Get(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/short_codes.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go) + +Line 34. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/index.mdx new file mode 100644 index 0000000000..9a51109870 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace" +title: "ShortCodesNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ShortCodesNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go" +--- +# `ShortCodesNamespace` + +ShortCodesNamespace provides short code management (read + update only). + +## Signature + +```go +type ShortCodesNamespace struct +``` + +## Properties + + + +## Methods + + + + Get retrieves a short code by ID. + + + + List lists all short codes. + + + + Update modifies a short code by ID. + + + +## Source + +[`pkg/rest/namespaces/short_codes.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go) + +Line 13. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/list.mdx new file mode 100644 index 0000000000..6bbba8f9f8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ShortCodesNamespace.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ShortCodesNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go" +--- +# `List` + +List lists all short codes. + +## Signature + +```go +func (*ShortCodesNamespace) List(params map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/short_codes.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go) + +Line 25. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/update.mdx new file mode 100644 index 0000000000..5a943fcdc2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-namespace/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ShortCodesNamespace.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ShortCodesNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go" +--- +# `Update` + +Update modifies a short code by ID. + +## Signature + +```go +func (*ShortCodesNamespace) Update(id string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/short_codes.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go) + +Line 39. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-resource.mdx new file mode 100644 index 0000000000..94ac245c35 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/short-codes-resource" +title: "ShortCodesResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.ShortCodesResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go" +--- +# `ShortCodesResource` + +ShortCodesResource is an alias for ShortCodesNamespace, matching the Python class name for cross-SDK parity. Prefer ShortCodesNamespace in new Go code. + +## Signature + +```go +type ShortCodesResource alias +``` + +## Source + +[`pkg/rest/namespaces/short_codes.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/short_codes.go) + +Line 45. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace/get.mdx new file mode 100644 index 0000000000..ae51bd4fe1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace/get.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SipProfileNamespace.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SipProfileNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/sip_profile.go" +--- +# `Get` + +Get retrieves the project SIP profile. + +## Signature + +```go +func (*SipProfileNamespace) Get() (map[string]any, error) +``` + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/sip_profile.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/sip_profile.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace/index.mdx new file mode 100644 index 0000000000..900138fb95 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace" +title: "SipProfileNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SipProfileNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/sip_profile.go" +--- +# `SipProfileNamespace` + +SipProfileNamespace provides project SIP profile management (singleton resource). + +## Signature + +```go +type SipProfileNamespace struct +``` + +## Properties + + + +## Methods + + + + Get retrieves the project SIP profile. + + + + Update modifies the project SIP profile. + + + +## Source + +[`pkg/rest/namespaces/sip_profile.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/sip_profile.go) + +Line 11. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace/update.mdx new file mode 100644 index 0000000000..f9a0989e60 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace/update.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-namespace/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SipProfileNamespace.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SipProfileNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/sip_profile.go" +--- +# `Update` + +Update modifies the project SIP profile. + +## Signature + +```go +func (*SipProfileNamespace) Update(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/sip_profile.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/sip_profile.go) + +Line 28. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-resource.mdx new file mode 100644 index 0000000000..313cce16fc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/sip-profile-resource" +title: "SipProfileResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SipProfileResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/sip_profile.go" +--- +# `SipProfileResource` + +SipProfileResource is an alias for SipProfileNamespace, matching the Python class name for cross-SDK parity. Prefer SipProfileNamespace in new Go code. + +## Signature + +```go +type SipProfileResource alias +``` + +## Source + +[`pkg/rest/namespaces/sip_profile.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/sip_profile.go) + +Line 34. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/create-sip-endpoint.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/create-sip-endpoint.mdx new file mode 100644 index 0000000000..92b101891c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/create-sip-endpoint.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/create-sip-endpoint" +title: "CreateSIPEndpoint" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SubscribersResource.CreateSIPEndpoint" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SubscribersResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `CreateSIPEndpoint` + +CreateSIPEndpoint creates a SIP endpoint for a subscriber. + +## Signature + +```go +func (*SubscribersResource) CreateSIPEndpoint(subscriberID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 125. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/delete-sip-endpoint.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/delete-sip-endpoint.mdx new file mode 100644 index 0000000000..2a1221477e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/delete-sip-endpoint.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/delete-sip-endpoint" +title: "DeleteSIPEndpoint" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SubscribersResource.DeleteSIPEndpoint" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SubscribersResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `DeleteSIPEndpoint` + +DeleteSIPEndpoint deletes a SIP endpoint from a subscriber. + +## Signature + +```go +func (*SubscribersResource) DeleteSIPEndpoint(subscriberID string, endpointID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 140. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/get-sip-endpoint.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/get-sip-endpoint.mdx new file mode 100644 index 0000000000..3cfb19b281 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/get-sip-endpoint.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/get-sip-endpoint" +title: "GetSIPEndpoint" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SubscribersResource.GetSIPEndpoint" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SubscribersResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `GetSIPEndpoint` + +GetSIPEndpoint retrieves a SIP endpoint for a subscriber. + +## Signature + +```go +func (*SubscribersResource) GetSIPEndpoint(subscriberID string, endpointID string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 130. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/index.mdx new file mode 100644 index 0000000000..89e9d324a7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource" +title: "SubscribersResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SubscribersResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `SubscribersResource` + +SubscribersResource extends CrudResource with SIP endpoint management. + +## Signature + +```go +type SubscribersResource struct +``` + +## Properties + + + +## Methods + + + + CreateSIPEndpoint creates a SIP endpoint for a subscriber. + + + + DeleteSIPEndpoint deletes a SIP endpoint from a subscriber. + + + + GetSIPEndpoint retrieves a SIP endpoint for a subscriber. + + + + ListSIPEndpoints lists SIP endpoints for a subscriber. + + + + UpdateSIPEndpoint updates a SIP endpoint for a subscriber. + + + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 115. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/list-sip-endpoints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/list-sip-endpoints.mdx new file mode 100644 index 0000000000..9ad0990c7c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/list-sip-endpoints.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/list-sip-endpoints" +title: "ListSIPEndpoints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SubscribersResource.ListSIPEndpoints" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SubscribersResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `ListSIPEndpoints` + +ListSIPEndpoints lists SIP endpoints for a subscriber. + +## Signature + +```go +func (*SubscribersResource) ListSIPEndpoints(subscriberID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 120. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/update-sip-endpoint.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/update-sip-endpoint.mdx new file mode 100644 index 0000000000..ba815138a8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/update-sip-endpoint.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/subscribers-resource/update-sip-endpoint" +title: "UpdateSIPEndpoint" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SubscribersResource.UpdateSIPEndpoint" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SubscribersResource" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `UpdateSIPEndpoint` + +UpdateSIPEndpoint updates a SIP endpoint for a subscriber. + +## Signature + +```go +func (*SubscribersResource) UpdateSIPEndpoint(subscriberID string, endpointID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 135. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/swml-webhooks-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/swml-webhooks-resource.mdx new file mode 100644 index 0000000000..e3a4e97909 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/swml-webhooks-resource.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/swml-webhooks-resource" +title: "SwmlWebhooksResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.SwmlWebhooksResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go" +--- +# `SwmlWebhooksResource` + +SwmlWebhooksResource is the Python class name for the auto-materialized SWML webhook resource. Go aliases AutoMaterializedWebhookResource here. + +## Signature + +```go +type SwmlWebhooksResource alias +``` + +## Source + +[`pkg/rest/namespaces/fabric.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/fabric.go) + +Line 324. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace/index.mdx new file mode 100644 index 0000000000..5be1175b05 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace" +title: "VerifiedCallersNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VerifiedCallersNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/verified_callers.go" +--- +# `VerifiedCallersNamespace` + +VerifiedCallersNamespace provides verified caller ID management with verification flow. + +## Signature + +```go +type VerifiedCallersNamespace struct +``` + +## Properties + + + +## Methods + + + + RedialVerification redials the verification call for a caller ID. + + + + SubmitVerification submits a verification code for a caller ID. + + + +## Source + +[`pkg/rest/namespaces/verified_callers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/verified_callers.go) + +Line 12. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace/redial-verification.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace/redial-verification.mdx new file mode 100644 index 0000000000..ded5066cf6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace/redial-verification.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace/redial-verification" +title: "RedialVerification" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VerifiedCallersNamespace.RedialVerification" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VerifiedCallersNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/verified_callers.go" +--- +# `RedialVerification` + +RedialVerification redials the verification call for a caller ID. + +## Signature + +```go +func (*VerifiedCallersNamespace) RedialVerification(callerID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/verified_callers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/verified_callers.go) + +Line 24. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace/submit-verification.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace/submit-verification.mdx new file mode 100644 index 0000000000..1db8bc4ab1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace/submit-verification.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/verified-callers-namespace/submit-verification" +title: "SubmitVerification" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VerifiedCallersNamespace.SubmitVerification" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VerifiedCallersNamespace" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/verified_callers.go" +--- +# `SubmitVerification` + +SubmitVerification submits a verification code for a caller ID. + +## Signature + +```go +func (*VerifiedCallersNamespace) SubmitVerification(callerID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/verified_callers.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/verified_callers.go) + +Line 29. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens/get.mdx new file mode 100644 index 0000000000..7cffc6f613 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferenceTokens.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferenceTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `Get` + +Get retrieves a conference token. + +## Signature + +```go +func (*VideoConferenceTokens) Get(tokenID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 129. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens/index.mdx new file mode 100644 index 0000000000..c5141240a6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens" +title: "VideoConferenceTokens" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferenceTokens" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `VideoConferenceTokens` + +VideoConferenceTokens provides video conference token management. + +## Signature + +```go +type VideoConferenceTokens struct +``` + +## Properties + + + +## Methods + + + + Get retrieves a conference token. + + + + Reset resets a conference token. + + + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 124. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens/reset.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens/reset.mdx new file mode 100644 index 0000000000..8d871b6b20 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens/reset.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conference-tokens/reset" +title: "Reset" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferenceTokens.Reset" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferenceTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `Reset` + +Reset resets a conference token. + +## Signature + +```go +func (*VideoConferenceTokens) Reset(tokenID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 134. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/create-stream.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/create-stream.mdx new file mode 100644 index 0000000000..2e8310f8f6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/create-stream.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/create-stream" +title: "CreateStream" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferences.CreateStream" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `CreateStream` + +CreateStream creates a stream for a conference. + +## Signature + +```go +func (*VideoConferences) CreateStream(conferenceID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 117. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/index.mdx new file mode 100644 index 0000000000..b88c3812d0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences" +title: "VideoConferences" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferences" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `VideoConferences` + +VideoConferences provides video conference management with tokens and streams. + +## Signature + +```go +type VideoConferences struct +``` + +## Properties + + + +## Methods + + + + CreateStream creates a stream for a conference. + + + + ListConferenceTokens lists tokens for a conference. + + + + ListStreams lists streams for a conference. + + + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 102. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/list-conference-tokens.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/list-conference-tokens.mdx new file mode 100644 index 0000000000..f1aec3994c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/list-conference-tokens.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/list-conference-tokens" +title: "ListConferenceTokens" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferences.ListConferenceTokens" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `ListConferenceTokens` + +ListConferenceTokens lists tokens for a conference. + +## Signature + +```go +func (*VideoConferences) ListConferenceTokens(conferenceID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 107. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/list-streams.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/list-streams.mdx new file mode 100644 index 0000000000..3081d98ec7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/list-streams.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-conferences/list-streams" +title: "ListStreams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferences.ListStreams" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoConferences" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `ListStreams` + +ListStreams lists streams for a conference. + +## Signature + +```go +func (*VideoConferences) ListStreams(conferenceID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 112. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-namespace/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-namespace/index.mdx new file mode 100644 index 0000000000..3bc01cf743 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-namespace/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-namespace" +title: "VideoNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `VideoNamespace` + +VideoNamespace groups all Video API resources. + +## Signature + +```go +type VideoNamespace struct +``` + +## Properties + + + + + + + + + + + + + + + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 164. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/delete.mdx new file mode 100644 index 0000000000..64edd0df4a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomRecordings.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomRecordings" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `Delete` + +Delete removes a room recording. It returns the parsed response body (or an empty map for 204 No Content) and any error. + +## Signature + +```go +func (*VideoRoomRecordings) Delete(recordingID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 90. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/get.mdx new file mode 100644 index 0000000000..1d3208eda4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomRecordings.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomRecordings" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `Get` + +Get retrieves a specific room recording. + +## Signature + +```go +func (*VideoRoomRecordings) Get(recordingID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 84. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/index.mdx new file mode 100644 index 0000000000..2ea7f315ab --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings" +title: "VideoRoomRecordings" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomRecordings" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `VideoRoomRecordings` + +VideoRoomRecordings provides video room recording management. + +## Signature + +```go +type VideoRoomRecordings struct +``` + +## Properties + + + +## Methods + + + + Delete removes a room recording. It returns the parsed response body (or an empty map for 204 No Content) and any error. + + + + Get retrieves a specific room recording. + + + + List lists all room recordings. + + + + ListEvents lists events for a room recording. + + + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 74. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/list-events.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/list-events.mdx new file mode 100644 index 0000000000..d93580d4ff --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/list-events.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/list-events" +title: "ListEvents" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomRecordings.ListEvents" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomRecordings" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `ListEvents` + +ListEvents lists events for a room recording. + +## Signature + +```go +func (*VideoRoomRecordings) ListEvents(recordingID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 95. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/list.mdx new file mode 100644 index 0000000000..e82ec6da2e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-recordings/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomRecordings.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomRecordings" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `List` + +List lists all room recordings. + +## Signature + +```go +func (*VideoRoomRecordings) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 79. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/get.mdx new file mode 100644 index 0000000000..fae1b5e93a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomSessions.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomSessions" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `Get` + +Get retrieves a specific room session. + +## Signature + +```go +func (*VideoRoomSessions) Get(sessionID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 52. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/index.mdx new file mode 100644 index 0000000000..77f0b0686a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions" +title: "VideoRoomSessions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomSessions" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `VideoRoomSessions` + +VideoRoomSessions provides video room session management. + +## Signature + +```go +type VideoRoomSessions struct +``` + +## Properties + + + +## Methods + + + + Get retrieves a specific room session. + + + + List lists all room sessions. + + + + ListEvents lists events for a room session. + + + + ListMembers lists members in a room session. + + + + ListRecordings lists recordings for a room session. + + + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 42. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-events.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-events.mdx new file mode 100644 index 0000000000..ccbe61f2f9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-events.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-events" +title: "ListEvents" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomSessions.ListEvents" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomSessions" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `ListEvents` + +ListEvents lists events for a room session. + +## Signature + +```go +func (*VideoRoomSessions) ListEvents(sessionID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 57. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-members.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-members.mdx new file mode 100644 index 0000000000..474db5b03b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-members.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-members" +title: "ListMembers" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomSessions.ListMembers" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomSessions" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `ListMembers` + +ListMembers lists members in a room session. + +## Signature + +```go +func (*VideoRoomSessions) ListMembers(sessionID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 62. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-recordings.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-recordings.mdx new file mode 100644 index 0000000000..13ec9bc158 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-recordings.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list-recordings" +title: "ListRecordings" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomSessions.ListRecordings" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomSessions" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `ListRecordings` + +ListRecordings lists recordings for a room session. + +## Signature + +```go +func (*VideoRoomSessions) ListRecordings(sessionID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 67. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list.mdx new file mode 100644 index 0000000000..2b0664b2d2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-sessions/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomSessions.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomSessions" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `List` + +List lists all room sessions. + +## Signature + +```go +func (*VideoRoomSessions) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 47. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-tokens/create.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-tokens/create.mdx new file mode 100644 index 0000000000..d69f424676 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-tokens/create.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-tokens/create" +title: "Create" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomTokens.Create" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomTokens" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `Create` + +Create creates a video room token. + +## Signature + +```go +func (*VideoRoomTokens) Create(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 35. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-tokens/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-tokens/index.mdx new file mode 100644 index 0000000000..b90d32e2b3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-tokens/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-room-tokens" +title: "VideoRoomTokens" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRoomTokens" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `VideoRoomTokens` + +VideoRoomTokens provides video room token generation. + +## Signature + +```go +type VideoRoomTokens struct +``` + +## Properties + + + +## Methods + + + + Create creates a video room token. + + + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 30. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms/create-stream.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms/create-stream.mdx new file mode 100644 index 0000000000..78f1c7c93b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms/create-stream.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms/create-stream" +title: "CreateStream" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRooms.CreateStream" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRooms" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `CreateStream` + +CreateStream creates a stream for a video room. + +## Signature + +```go +func (*VideoRooms) CreateStream(roomID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms/index.mdx new file mode 100644 index 0000000000..78d2f9c562 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms" +title: "VideoRooms" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRooms" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `VideoRooms` + +VideoRooms provides video room management with stream sub-resources. + +## Signature + +```go +type VideoRooms struct +``` + +## Properties + + + +## Methods + + + + CreateStream creates a stream for a video room. + + + + ListStreams lists streams for a video room. + + + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 13. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms/list-streams.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms/list-streams.mdx new file mode 100644 index 0000000000..966078c89a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms/list-streams.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-rooms/list-streams" +title: "ListStreams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRooms.ListStreams" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoRooms" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `ListStreams` + +ListStreams lists streams for a video room. + +## Signature + +```go +func (*VideoRooms) ListStreams(roomID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 18. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/delete.mdx new file mode 100644 index 0000000000..1d012fc1dd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoStreams.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoStreams" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `Delete` + +Delete removes a video stream. It returns the parsed response body (or an empty map for 204 No Content) and any error. + +## Signature + +```go +func (*VideoStreams) Delete(streamID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 157. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/get.mdx new file mode 100644 index 0000000000..dc102d140a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoStreams.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoStreams" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `Get` + +Get retrieves a video stream. + +## Signature + +```go +func (*VideoStreams) Get(streamID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 146. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/index.mdx new file mode 100644 index 0000000000..7488dbf4cf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams" +title: "VideoStreams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoStreams" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `VideoStreams` + +VideoStreams provides video stream management. + +## Signature + +```go +type VideoStreams struct +``` + +## Properties + + + +## Methods + + + + Delete removes a video stream. It returns the parsed response body (or an empty map for 204 No Content) and any error. + + + + Get retrieves a video stream. + + + + Update modifies a video stream. + + + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 141. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/update.mdx new file mode 100644 index 0000000000..ae38d86204 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/video-streams/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoStreams.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VideoStreams" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go" +--- +# `Update` + +Update modifies a video stream. + +## Signature + +```go +func (*VideoStreams) Update(streamID string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/video.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/video.go) + +Line 151. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/get.mdx new file mode 100644 index 0000000000..b85467bebc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VoiceLogs.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VoiceLogs" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `Get` + +Get retrieves a specific voice log entry. + +## Signature + +```go +func (*VoiceLogs) Get(logID string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 40. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/index.mdx new file mode 100644 index 0000000000..46f1ee054b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs" +title: "VoiceLogs" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VoiceLogs" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `VoiceLogs` + +VoiceLogs provides voice log queries. + +## Signature + +```go +type VoiceLogs struct +``` + +## Properties + + + +## Methods + + + + Get retrieves a specific voice log entry. + + + + List lists voice logs. + + + + ListEvents lists events for a voice log entry. + + + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 30. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/list-events.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/list-events.mdx new file mode 100644 index 0000000000..1e61c708a5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/list-events.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/list-events" +title: "ListEvents" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VoiceLogs.ListEvents" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VoiceLogs" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `ListEvents` + +ListEvents lists events for a voice log entry. + +## Signature + +```go +func (*VoiceLogs) ListEvents(logID string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 45. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/list.mdx new file mode 100644 index 0000000000..86f87f2dbf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces/voice-logs/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VoiceLogs.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest/namespaces.VoiceLogs" + module: "github.com.signalwire.signalwire-go.pkg.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go" +--- +# `List` + +List lists voice logs. + +## Signature + +```go +func (*VoiceLogs) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/namespaces/logs.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/namespaces/logs.go) + +Line 35. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/create.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/create.mdx new file mode 100644 index 0000000000..1e9881dd72 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/create.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/create" +title: "Create" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.CrudResource.Create" + parent: "github.com/signalwire/signalwire-go/pkg/rest.CrudResource" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `Create` + +Create sends a POST request to create a new resource. + +## Signature + +```go +func (*CrudResource) Create(data map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 242. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/delete.mdx new file mode 100644 index 0000000000..707374c0ea --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.CrudResource.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest.CrudResource" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `Delete` + +Delete removes a resource by ID. It returns the parsed response body (or an empty map for 204 No Content) and any error. + +## Signature + +```go +func (*CrudResource) Delete(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 263. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/get.mdx new file mode 100644 index 0000000000..8f0628162c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.CrudResource.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest.CrudResource" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `Get` + +Get retrieves a single resource by ID. + +## Signature + +```go +func (*CrudResource) Get(id string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 247. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/index.mdx new file mode 100644 index 0000000000..3495318857 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource" +title: "CrudResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.CrudResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `CrudResource` + +CrudResource provides standard List, Create, Get, Update, Delete operations against a REST collection endpoint. Update defaults to PATCH; set UpdateMethod to "PUT" to override. + +## Signature + +```go +type CrudResource struct +``` + +## Properties + + + + + + + "PATCH" (default) or "PUT" + + +## Methods + + + + Create sends a POST request to create a new resource. + + + + Delete removes a resource by ID. It returns the parsed response body (or an empty map for 204 No Content) and any error. + + + + Get retrieves a single resource by ID. + + + + List retrieves all items from the collection. Optional query parameters can be provided. The raw JSON response map is returned. + + + + Update modifies an existing resource by ID using the configured update method (PATCH or PUT). + + + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 205. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/list.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/list.mdx new file mode 100644 index 0000000000..e59db1d318 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/list.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/list" +title: "List" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.CrudResource.List" + parent: "github.com/signalwire/signalwire-go/pkg/rest.CrudResource" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `List` + +List retrieves all items from the collection. Optional query parameters can be provided. The raw JSON response map is returned. + +## Signature + +```go +func (*CrudResource) List(params map[string]string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 237. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/update.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/update.mdx new file mode 100644 index 0000000000..c324d95b28 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/update.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/crud-resource/update" +title: "Update" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.CrudResource.Update" + parent: "github.com/signalwire/signalwire-go/pkg/rest.CrudResource" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `Update` + +Update modifies an existing resource by ID using the configured update method (PATCH or PUT). + +## Signature + +```go +func (*CrudResource) Update(id string, data map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 253. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/base-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/base-url.mdx new file mode 100644 index 0000000000..08bed82f83 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/base-url.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/base-url" +title: "BaseURL" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient.BaseURL" + parent: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `BaseURL` + +BaseURL returns the base URL used by this client. + +## Signature + +```go +func (*HttpClient) BaseURL() string +``` + +## Returns + +`string` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 90. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/delete.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/delete.mdx new file mode 100644 index 0000000000..e5020ef21b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/delete.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/delete" +title: "Delete" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient.Delete" + parent: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `Delete` + +Delete performs an HTTP DELETE request. It returns the parsed response body (or an empty map for 204 No Content) and any error. + +## Signature + +```go +func (*HttpClient) Delete(path string) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 126. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/get.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/get.mdx new file mode 100644 index 0000000000..bd189cd307 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/get.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/get" +title: "Get" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient.Get" + parent: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `Get` + +Get performs an HTTP GET request. params are added as query-string parameters. + +## Signature + +```go +func (*HttpClient) Get(path string, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 104. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/index.mdx new file mode 100644 index 0000000000..5d21d4036a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client" +title: "HttpClient" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient" + parent: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `HttpClient` + +HttpClient is a thin wrapper around net/http that provides Basic Auth, JSON encoding/decoding, and standard headers for SignalWire API calls. + +## Signature + +```go +type HttpClient struct +``` + +## Methods + + + + BaseURL returns the base URL used by this client. + + + + Delete performs an HTTP DELETE request. It returns the parsed response body (or an empty map for 204 No Content) and any error. + + + + Get performs an HTTP GET request. params are added as query-string parameters. + + + + Patch performs an HTTP PATCH request with a JSON body. + + + + Post performs an HTTP POST request with a JSON body. Optional params are appended to the URL as query-string parameters. + + + + Put performs an HTTP PUT request with a JSON body. + + + + SetBaseURL overrides the base URL used by this client. Useful for pointing the client at a non-default endpoint (audit fixtures, mock servers, etc.) without re-running the constructor with a synthetic space name. + + + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 60. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/patch.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/patch.mdx new file mode 100644 index 0000000000..f17b5c8415 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/patch.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/patch" +title: "Patch" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient.Patch" + parent: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `Patch` + +Patch performs an HTTP PATCH request with a JSON body. + +## Signature + +```go +func (*HttpClient) Patch(path string, body map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 120. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/post.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/post.mdx new file mode 100644 index 0000000000..c88be544bd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/post.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/post" +title: "Post" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient.Post" + parent: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `Post` + +Post performs an HTTP POST request with a JSON body. Optional params are appended to the URL as query-string parameters. + +## Signature + +```go +func (*HttpClient) Post(path string, body map[string]any, params map[string]string) (map[string]any, error) +``` + +## Parameters + + + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 110. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/put.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/put.mdx new file mode 100644 index 0000000000..58b2355046 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/put.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/put" +title: "Put" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient.Put" + parent: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `Put` + +Put performs an HTTP PUT request with a JSON body. + +## Signature + +```go +func (*HttpClient) Put(path string, body map[string]any) (map[string]any, error) +``` + +## Parameters + + + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 115. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/set-base-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/set-base-url.mdx new file mode 100644 index 0000000000..18cc1b49ff --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/set-base-url.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/http-client/set-base-url" +title: "SetBaseURL" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient.SetBaseURL" + parent: "github.com/signalwire/signalwire-go/pkg/rest.HttpClient" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `SetBaseURL` + +SetBaseURL overrides the base URL used by this client. Useful for pointing the client at a non-default endpoint (audit fixtures, mock servers, etc.) without re-running the constructor with a synthetic space name. + +## Signature + +```go +func (*HttpClient) SetBaseURL(url string) +``` + +## Parameters + + + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 98. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/index.mdx new file mode 100644 index 0000000000..0d1afe3717 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/index.mdx @@ -0,0 +1,80 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest" +title: "rest" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `rest` + +Package rest provides a REST client for the SignalWire platform APIs. + +It includes an HTTP transport layer, generic CRUD resource abstractions, paginated iteration, and namespaced sub-clients for each API domain. + +## Signature + +```go +package rest +``` + +## Functions + + + + NewCrudResource creates a CrudResource for the given path. The default update method is PATCH. + + + + NewCrudResourcePUT creates a CrudResource that uses PUT for updates. + + + + NewHttpClient creates a new HttpClient configured for the given SignalWire space. The baseURL is normally constructed as "https://\", but the SIGNALWIRE\_REST\_BASE\_URL environment variable overrides it when set — pointing the client at a loopback fixture for the porting-sdk audit\_rest\_transport.py harness, or at any non-default endpoint. + + + + NewPaginatedIterator creates a new iterator for the given endpoint. dataKey is the JSON key that holds the array of items (typically "data"). + + + + NewRestClient creates a new RestClient. If project, token, or space are empty strings the corresponding environment variables are used: + + + + NewSignalWireRestError constructs a SignalWireRestError, substituting "GET" as the method when method is empty — matches Python's default. + + + +## Classes + + + + CrudResource provides standard List, Create, Get, Update, Delete operations against a REST collection endpoint. Update defaults to PATCH; set UpdateMethod to "PUT" to override. + + + + HttpClient is a thin wrapper around net/http that provides Basic Auth, JSON encoding/decoding, and standard headers for SignalWire API calls. + + + + PaginatedIterator walks through paginated API responses one page at a time. Each call to Next returns the items from the current page, a boolean indicating whether more pages exist, and any error encountered. + + + + RestClient is the top-level REST client for the SignalWire platform. It provides namespaced access to all SignalWire API domains. + + + + SignalWireRestError is returned when the SignalWire REST API responds with a non-2xx status code. + + + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-crud-resource-put.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-crud-resource-put.mdx new file mode 100644 index 0000000000..e49ab09927 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-crud-resource-put.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-crud-resource-put" +title: "NewCrudResourcePUT" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.NewCrudResourcePUT" + parent: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `NewCrudResourcePUT` + +NewCrudResourcePUT creates a CrudResource that uses PUT for updates. + +## Signature + +```go +func NewCrudResourcePUT(client *HttpClient, path string) *CrudResource +``` + +## Parameters + + + + + +## Returns + +`*CrudResource` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 222. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-crud-resource.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-crud-resource.mdx new file mode 100644 index 0000000000..604a39e3dc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-crud-resource.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-crud-resource" +title: "NewCrudResource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.NewCrudResource" + parent: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `NewCrudResource` + +NewCrudResource creates a CrudResource for the given path. The default update method is PATCH. + +## Signature + +```go +func NewCrudResource(client *HttpClient, path string) *CrudResource +``` + +## Parameters + + + + + +## Returns + +`*CrudResource` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 213. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-http-client.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-http-client.mdx new file mode 100644 index 0000000000..1a407302b0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-http-client.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-http-client" +title: "NewHttpClient" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.NewHttpClient" + parent: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `NewHttpClient` + +NewHttpClient creates a new HttpClient configured for the given SignalWire space. The baseURL is normally constructed as "https://\", but the SIGNALWIRE\_REST\_BASE\_URL environment variable overrides it when set — pointing the client at a loopback fixture for the porting-sdk audit\_rest\_transport.py harness, or at any non-default endpoint. + +## Signature + +```go +func NewHttpClient(projectID string, token string, space string) *HttpClient +``` + +## Parameters + + + + + + + +## Returns + +`*HttpClient` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 73. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-paginated-iterator.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-paginated-iterator.mdx new file mode 100644 index 0000000000..ca2c7e78a9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-paginated-iterator.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-paginated-iterator" +title: "NewPaginatedIterator" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.NewPaginatedIterator" + parent: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `NewPaginatedIterator` + +NewPaginatedIterator creates a new iterator for the given endpoint. dataKey is the JSON key that holds the array of items (typically "data"). + +## Signature + +```go +func NewPaginatedIterator( + client *HttpClient, + path string, + params map[string]string, + dataKey string +) *PaginatedIterator +``` + +## Parameters + + + + + + + + + +## Returns + +`*PaginatedIterator` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 282. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-rest-client.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-rest-client.mdx new file mode 100644 index 0000000000..92b3e36a3f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-rest-client.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-rest-client" +title: "NewRestClient" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.NewRestClient" + parent: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/rest_client.go" +--- +# `NewRestClient` + +NewRestClient creates a new RestClient. If project, token, or space are empty strings the corresponding environment variables are used: + +``` +SIGNALWIRE_PROJECT_ID +SIGNALWIRE_API_TOKEN +SIGNALWIRE_SPACE +``` + +An error is returned when any of the three values is still empty after the environment lookup. + +## Signature + +```go +func NewRestClient(project string, token string, space string) (*RestClient, error) +``` + +## Parameters + + + + + + + +## Returns + +`(*RestClient, error)` + +## Examples + + + + ```go + SIGNALWIRE_PROJECT_ID + SIGNALWIRE_API_TOKEN + SIGNALWIRE_SPACE + ``` + + + + ```go + SIGNALWIRE_PROJECT_ID + SIGNALWIRE_API_TOKEN + SIGNALWIRE_SPACE + ``` + + + +## Source + +[`pkg/rest/rest_client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/rest_client.go) + +Line 99. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-signal-wire-rest-error.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-signal-wire-rest-error.mdx new file mode 100644 index 0000000000..a432314f2d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-signal-wire-rest-error.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/new-signal-wire-rest-error" +title: "NewSignalWireRestError" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.NewSignalWireRestError" + parent: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `NewSignalWireRestError` + +NewSignalWireRestError constructs a SignalWireRestError, substituting "GET" as the method when method is empty — matches Python's default. + +## Signature + +```go +func NewSignalWireRestError(statusCode int, body string, url string, method string) *SignalWireRestError +``` + +## Parameters + + + + + + + + + +## Returns + +`*SignalWireRestError` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 49. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator/for-each.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator/for-each.mdx new file mode 100644 index 0000000000..e76d56cc83 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator/for-each.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator/for-each" +title: "ForEach" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.PaginatedIterator.ForEach" + parent: "github.com/signalwire/signalwire-go/pkg/rest.PaginatedIterator" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `ForEach` + +ForEach calls fn for every item across all pages. It fetches pages lazily via Next and invokes fn once per item in the order they are returned. Iteration stops early if fn returns a non-nil error (that error is returned to the caller) or when Next signals there are no more pages. + +## Signature + +```go +func (*PaginatedIterator) ForEach(fn func(map[string]any) error) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 353. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator/index.mdx new file mode 100644 index 0000000000..5fd9e78edd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator" +title: "PaginatedIterator" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.PaginatedIterator" + parent: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `PaginatedIterator` + +PaginatedIterator walks through paginated API responses one page at a time. Each call to Next returns the items from the current page, a boolean indicating whether more pages exist, and any error encountered. + +## Signature + +```go +type PaginatedIterator struct +``` + +## Methods + + + + ForEach calls fn for every item across all pages. It fetches pages lazily via Next and invokes fn once per item in the order they are returned. Iteration stops early if fn returns a non-nil error (that error is returned to the caller) or when Next signals there are no more pages. + + + + Next fetches the next page of results. It returns the items from the page, a boolean hasMore that is true when additional pages remain, and any error. When there are no more pages, it returns nil, false, nil. + + + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 272. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator/next.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator/next.mdx new file mode 100644 index 0000000000..0e2f3e1d4e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator/next.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/paginated-iterator/next" +title: "Next" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.PaginatedIterator.Next" + parent: "github.com/signalwire/signalwire-go/pkg/rest.PaginatedIterator" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `Next` + +Next fetches the next page of results. It returns the items from the page, a boolean hasMore that is true when additional pages remain, and any error. When there are no more pages, it returns nil, false, nil. + +## Signature + +```go +func (*PaginatedIterator) Next() ([]map[string]any, bool, error) +``` + +## Returns + +`([]map[string]any, bool, error)` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 300. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client/http-client.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client/http-client.mdx new file mode 100644 index 0000000000..03ffaed608 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client/http-client.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client/http-client" +title: "HttpClient" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.RestClient.HttpClient" + parent: "github.com/signalwire/signalwire-go/pkg/rest.RestClient" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/rest_client.go" +--- +# `HttpClient` + +HttpClient exposes the underlying HTTP transport. It is the public form of Python's “signalwire\_client.\_http“ and is the entry point used by helpers like PaginatedIterator that need raw GET access without going through a namespace resource. + +## Signature + +```go +func (*RestClient) HttpClient() *HttpClient +``` + +## Returns + +`*HttpClient` + +## Source + +[`pkg/rest/rest_client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/rest_client.go) + +Line 86. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client/index.mdx new file mode 100644 index 0000000000..3502668489 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client/index.mdx @@ -0,0 +1,142 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client" +title: "RestClient" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.RestClient" + parent: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/rest_client.go" +--- +# `RestClient` + +RestClient is the top-level REST client for the SignalWire platform. It provides namespaced access to all SignalWire API domains. + +Usage: + +``` +client, err := rest.NewRestClient("project-id", "api-token", "your-space.signalwire.com") +// or use environment variables SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, SIGNALWIRE_SPACE +client, err := rest.NewRestClient("", "", "") + +agents, err := client.Fabric.AIAgents.List(nil) +client.Calling.Play("call-id", map[string]any{"play": [...]}) +``` + +## Signature + +```go +type RestClient struct +``` + +## Examples + + + + ```go + client, err := rest.NewRestClient("project-id", "api-token", "your-space.signalwire.com") + // or use environment variables SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, SIGNALWIRE_SPACE + client, err := rest.NewRestClient("", "", "") + + agents, err := client.Fabric.AIAgents.List(nil) + client.Calling.Play("call-id", map[string]any{"play": [...]}) + ``` + + + + ```go + client, err := rest.NewRestClient("project-id", "api-token", "your-space.signalwire.com") + // or use environment variables SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, SIGNALWIRE_SPACE + client, err := rest.NewRestClient("", "", "") + + agents, err := client.Fabric.AIAgents.List(nil) + client.Calling.Play("call-id", map[string]any{"play": [...]}) + ``` + + + +## Properties + + + + + Calling API (REST-based call control) + + + + + + Compatibility (Twilio-compatible) LAML API + + + + Datasphere API + + + + Fabric API + + + + + + Logs + + + + + + + + + + Relay REST resources + + + + Project management + + + + PubSub & Chat + + + + + + + + 10DLC Campaign Registry + + + + + + + + + + Video API + + +## Methods + + + + HttpClient exposes the underlying HTTP transport. It is the public form of Python's “signalwire\_client.\_http“ and is the entry point used by helpers like PaginatedIterator that need raw GET access without going through a namespace resource. + + + + SetBaseURL overrides the base URL used by the underlying HttpClient. Useful for pointing the client at a non-default endpoint such as the audit\_rest\_transport.py harness fixture, a recorded-cassette mock server, or a regional endpoint without re-running the constructor. + + + +## Source + +[`pkg/rest/rest_client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/rest_client.go) + +Line 28. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client/set-base-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client/set-base-url.mdx new file mode 100644 index 0000000000..243b2b6c9c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client/set-base-url.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/rest-client/set-base-url" +title: "SetBaseURL" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.RestClient.SetBaseURL" + parent: "github.com/signalwire/signalwire-go/pkg/rest.RestClient" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/rest_client.go" +--- +# `SetBaseURL` + +SetBaseURL overrides the base URL used by the underlying HttpClient. Useful for pointing the client at a non-default endpoint such as the audit\_rest\_transport.py harness fixture, a recorded-cassette mock server, or a regional endpoint without re-running the constructor. + +## Signature + +```go +func (*RestClient) SetBaseURL(url string) +``` + +## Parameters + + + +## Source + +[`pkg/rest/rest_client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/rest_client.go) + +Line 78. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/signal-wire-rest-error/error.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/signal-wire-rest-error/error.mdx new file mode 100644 index 0000000000..8337361888 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/signal-wire-rest-error/error.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/signal-wire-rest-error/error" +title: "Error" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.SignalWireRestError.Error" + parent: "github.com/signalwire/signalwire-go/pkg/rest.SignalWireRestError" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `Error` + +Error implements the error interface. + +## Signature + +```go +func (*SignalWireRestError) Error() string +``` + +## Returns + +`string` + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 43. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/signal-wire-rest-error/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/signal-wire-rest-error/index.mdx new file mode 100644 index 0000000000..7afb1ce62f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/signal-wire-rest-error/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest/signal-wire-rest-error" +title: "SignalWireRestError" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/rest.SignalWireRestError" + parent: "github.com/signalwire/signalwire-go/pkg/rest" + module: "github.com.signalwire.signalwire-go.pkg.rest" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go" +--- +# `SignalWireRestError` + +SignalWireRestError is returned when the SignalWire REST API responds with a non-2xx status code. + +## Signature + +```go +type SignalWireRestError struct +``` + +## Properties + + + + + + + + + +## Methods + + + + Error implements the error interface. + + + +## Source + +[`pkg/rest/client.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/rest/client.go) + +Line 35. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/index.mdx new file mode 100644 index 0000000000..df7f87d3c5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/index.mdx @@ -0,0 +1,96 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security" +title: "security" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go" +--- +# `security` + +Package security provides session management and token-based authentication for SWAIG function calls, preventing unauthorized tool execution. + +## Signature + +```go +package security +``` + +## Constants + + + ErrMissingSigningKey is returned by ValidateWebhookSignatureE / ValidateRequestE when an empty signing key is supplied. Per the spec, a missing signing key is a programming error rather than a validation failure, so the bool-returning entry points panic; the \*E variants return this sentinel for callers that prefer error returns. + + + + RawBodyContextKey is the context key under which WebhookMiddleware stashes the raw request body. Downstream handlers should retrieve via RawBodyFromContext rather than reaching for this key directly. + + +## Functions + + + + NewSessionManager creates a new SessionManager. If tokenExpirySecs is \<= 0, a default of 900 seconds (15 minutes) is used, matching the Python SDK default. Provide functional options (e.g. WithSecret) to customise behaviour. + + + + RawBodyFromContext returns the raw request body bytes that the webhook middleware captured before signature validation. Returns nil and false when called from a handler that wasn't wrapped by WebhookMiddleware (or when the request had no body). + + + + ValidateRequest is the legacy @signalwire/compatibility-api drop-in entry point. The fourth argument is dynamically dispatched: + + + + ValidateRequestE is the error-returning variant of ValidateRequest. Returns ErrMissingSigningKey when signingKey is empty, or a typed error when paramsOrRawBody is neither a string, nil, nor a recognized map shape. + + + + ValidateWebhookSignature validates a SignalWire webhook signature against both schemes. Returns true if the signature matches Scheme A (hex JSON) or Scheme B (base64 form, with port-normalization variants and optional bodySHA256 fallback); false otherwise. + + + + ValidateWebhookSignatureE is the error-returning variant of ValidateWebhookSignature. Returns ErrMissingSigningKey when signingKey is empty; otherwise (matched, nil). + + + + WebhookMiddleware returns an http.Handler middleware that validates the X-SignalWire-Signature (or X-Twilio-Signature) header against signingKey before invoking the wrapped handler. + + + + WithDebugMode enables the DebugToken method. Off by default to prevent accidental token introspection in production. + + + + WithSecret injects a fixed secret key into the SessionManager. Use this when you need multiple processes or instances to validate each other's tokens. Pass nil to keep the default behaviour (auto-generate a random 32-byte secret). + + + +## Type Aliases + + + + Option is a functional option for NewSessionManager. + + + +## Classes + + + + SessionManager creates and validates HMAC-SHA256 tokens for SWAIG function calls. The secret can be supplied at construction time (for cross-process validation) or auto-generated (default, single-process use). + + + + WebhookOpts configures WebhookMiddleware. + + + +## Source + +[`pkg/security/session_manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/new-session-manager.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/new-session-manager.mdx new file mode 100644 index 0000000000..54a8b0b0d3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/new-session-manager.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/new-session-manager" +title: "NewSessionManager" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.NewSessionManager" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go" +--- +# `NewSessionManager` + +NewSessionManager creates a new SessionManager. If tokenExpirySecs is \<= 0, a default of 900 seconds (15 minutes) is used, matching the Python SDK default. Provide functional options (e.g. WithSecret) to customise behaviour. + +## Signature + +```go +func NewSessionManager(tokenExpirySecs int, opts ...Option) *SessionManager +``` + +## Parameters + + + + + +## Returns + +`*SessionManager` + +## Source + +[`pkg/security/session_manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go) + +Line 55. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/option.mdx new file mode 100644 index 0000000000..64e03cb32a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/option" +title: "Option" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.Option" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go" +--- +# `Option` + +Option is a functional option for NewSessionManager. + +## Signature + +```go +type Option alias +``` + +## Source + +[`pkg/security/session_manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go) + +Line 31. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/raw-body-from-context.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/raw-body-from-context.mdx new file mode 100644 index 0000000000..9e4c18aeac --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/raw-body-from-context.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/raw-body-from-context" +title: "RawBodyFromContext" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.RawBodyFromContext" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook_middleware.go" +--- +# `RawBodyFromContext` + +RawBodyFromContext returns the raw request body bytes that the webhook middleware captured before signature validation. Returns nil and false when called from a handler that wasn't wrapped by WebhookMiddleware (or when the request had no body). + +## Signature + +```go +func RawBodyFromContext(ctx context.Context) ([]byte, bool) +``` + +## Parameters + + + +## Returns + +`([]byte, bool)` + +## Source + +[`pkg/security/webhook_middleware.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook_middleware.go) + +Line 42. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/create-session.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/create-session.mdx new file mode 100644 index 0000000000..4e3f61a690 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/create-session.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/create-session" +title: "CreateSession" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.SessionManager.CreateSession" + parent: "github.com/signalwire/signalwire-go/pkg/security.SessionManager" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go" +--- +# `CreateSession` + +CreateSession returns callID unchanged if it is non-empty; otherwise it generates a cryptographically random URL-safe string (matches Python secrets.token\_urlsafe(16) — 16 bytes of entropy, base64url-encoded without padding). + +## Signature + +```go +func (*SessionManager) CreateSession(callID string) string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`pkg/security/session_manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go) + +Line 84. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/create-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/create-token.mdx new file mode 100644 index 0000000000..b61e226a7c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/create-token.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/create-token" +title: "CreateToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.SessionManager.CreateToken" + parent: "github.com/signalwire/signalwire-go/pkg/security.SessionManager" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go" +--- +# `CreateToken` + +CreateToken generates an HMAC-SHA256 signed token for the given function name and call ID. The token embeds an expiry timestamp and is returned as a base64url-encoded string. + +## Signature + +```go +func (*SessionManager) CreateToken(functionName string, callID string) string +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`pkg/security/session_manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go) + +Line 99. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/debug-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/debug-token.mdx new file mode 100644 index 0000000000..e0d0ad27b8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/debug-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/debug-token" +title: "DebugToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.SessionManager.DebugToken" + parent: "github.com/signalwire/signalwire-go/pkg/security.SessionManager" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go" +--- +# `DebugToken` + +DebugToken decodes a token and returns a map of its components and status without performing signature validation. This is intended for development and debugging only. It requires debug mode to be enabled via WithDebugMode; if not, it returns map\["error": "debug mode not enabled"]. + +## Signature + +```go +func (*SessionManager) DebugToken(token string) map[string]any +``` + +## Parameters + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/security/session_manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go) + +Line 194. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/index.mdx new file mode 100644 index 0000000000..5c53194d27 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager" +title: "SessionManager" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.SessionManager" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go" +--- +# `SessionManager` + +SessionManager creates and validates HMAC-SHA256 tokens for SWAIG function calls. The secret can be supplied at construction time (for cross-process validation) or auto-generated (default, single-process use). + +## Signature + +```go +type SessionManager struct +``` + +## Methods + + + + CreateSession returns callID unchanged if it is non-empty; otherwise it generates a cryptographically random URL-safe string (matches Python secrets.token\_urlsafe(16) — 16 bytes of entropy, base64url-encoded without padding). + + + + CreateToken generates an HMAC-SHA256 signed token for the given function name and call ID. The token embeds an expiry timestamp and is returned as a base64url-encoded string. + + + + DebugToken decodes a token and returns a map of its components and status without performing signature validation. This is intended for development and debugging only. It requires debug mode to be enabled via WithDebugMode; if not, it returns map\["error": "debug mode not enabled"]. + + + + ValidateToken verifies that a token is authentic, unexpired, and matches the expected function name and call ID. All comparisons are performed in constant time where possible to prevent timing attacks. Returns true only if every check passes. + + + +## Source + +[`pkg/security/session_manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/validate-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/validate-token.mdx new file mode 100644 index 0000000000..7e3459098d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/validate-token.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/session-manager/validate-token" +title: "ValidateToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.SessionManager.ValidateToken" + parent: "github.com/signalwire/signalwire-go/pkg/security.SessionManager" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go" +--- +# `ValidateToken` + +ValidateToken verifies that a token is authentic, unexpired, and matches the expected function name and call ID. All comparisons are performed in constant time where possible to prevent timing attacks. Returns true only if every check passes. + +## Signature + +```go +func (*SessionManager) ValidateToken(functionName string, token string, callID string) bool +``` + +## Parameters + + + + + + + +## Returns + +`bool` + +## Source + +[`pkg/security/session_manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go) + +Line 115. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-request-e.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-request-e.mdx new file mode 100644 index 0000000000..fc633ffe5a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-request-e.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-request-e" +title: "ValidateRequestE" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.ValidateRequestE" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook.go" +--- +# `ValidateRequestE` + +ValidateRequestE is the error-returning variant of ValidateRequest. Returns ErrMissingSigningKey when signingKey is empty, or a typed error when paramsOrRawBody is neither a string, nil, nor a recognized map shape. + +## Signature + +```go +func ValidateRequestE( + signingKey string, + signature string, + urlStr string, + paramsOrRawBody any +) (bool, error) +``` + +## Parameters + + + + + + + + + +## Returns + +`(bool, error)` + +## Source + +[`pkg/security/webhook.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook.go) + +Line 299. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-request.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-request.mdx new file mode 100644 index 0000000000..7e15e335b9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-request.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-request" +title: "ValidateRequest" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.ValidateRequest" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook.go" +--- +# `ValidateRequest` + +ValidateRequest is the legacy @signalwire/compatibility-api drop-in entry point. The fourth argument is dynamically dispatched: + +- string: delegate to ValidateWebhookSignature (Scheme A then Scheme B with parsed form); +- map\[string]\[]string / url.Values / map\[string]string: pre-parsed form params, run Scheme B directly with URL port normalization; +- nil: pre-parsed empty params, run Scheme B with empty concat string; +- anything else: panic with a clear message (programmer error). + +## Signature + +```go +func ValidateRequest( + signingKey string, + signature string, + urlStr string, + paramsOrRawBody any +) bool +``` + +## Parameters + + + + + + + + + +## Returns + +`bool` + +## Source + +[`pkg/security/webhook.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook.go) + +Line 243. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-webhook-signature-e.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-webhook-signature-e.mdx new file mode 100644 index 0000000000..f4a21ed5da --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-webhook-signature-e.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-webhook-signature-e" +title: "ValidateWebhookSignatureE" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.ValidateWebhookSignatureE" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook.go" +--- +# `ValidateWebhookSignatureE` + +ValidateWebhookSignatureE is the error-returning variant of ValidateWebhookSignature. Returns ErrMissingSigningKey when signingKey is empty; otherwise (matched, nil). + +## Signature + +```go +func ValidateWebhookSignatureE( + signingKey string, + signature string, + urlStr string, + rawBody string +) (bool, error) +``` + +## Parameters + + + + + + + + + +## Returns + +`(bool, error)` + +## Source + +[`pkg/security/webhook.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook.go) + +Line 258. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-webhook-signature.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-webhook-signature.mdx new file mode 100644 index 0000000000..9616cfd116 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-webhook-signature.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/validate-webhook-signature" +title: "ValidateWebhookSignature" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.ValidateWebhookSignature" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook.go" +--- +# `ValidateWebhookSignature` + +ValidateWebhookSignature validates a SignalWire webhook signature against both schemes. Returns true if the signature matches Scheme A (hex JSON) or Scheme B (base64 form, with port-normalization variants and optional bodySHA256 fallback); false otherwise. + +signingKey: customer's Signing Key. Empty string panics — that's a programming error, not a validation failure (use ValidateWebhookSignatureE for the error-returning variant). + +signature: X-SignalWire-Signature (or X-Twilio-Signature) header value. Empty returns false without panicking. + +url: full URL SignalWire POSTed to (scheme, host, optional port, path, query). Must match what the platform saw — see the URL reconstruction section of porting-sdk/webhooks.md. + +rawBody: raw request body bytes as a UTF-8 string, BEFORE any JSON / form parsing. + +All comparisons use crypto/subtle.ConstantTimeCompare. The function does not log which scheme was tried, what the expected signature was, or any other branch information. + +## Signature + +```go +func ValidateWebhookSignature( + signingKey string, + signature string, + url string, + rawBody string +) bool +``` + +## Parameters + + + + + + + + + +## Returns + +`bool` + +## Source + +[`pkg/security/webhook.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook.go) + +Line 226. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/webhook-middleware.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/webhook-middleware.mdx new file mode 100644 index 0000000000..906df0a9a6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/webhook-middleware.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/webhook-middleware" +title: "WebhookMiddleware" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.WebhookMiddleware" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook_middleware.go" +--- +# `WebhookMiddleware` + +WebhookMiddleware returns an http.Handler middleware that validates the X-SignalWire-Signature (or X-Twilio-Signature) header against signingKey before invoking the wrapped handler. + +Pass nil for opts to use defaults (no proxy trust, no size cap, env-var override consulted). + +The middleware never logs the signing key, the expected signature, or which validation branch matched — per porting-sdk/webhooks.md §"Required SDK Behaviors / Error modes". + +## Signature + +```go +func WebhookMiddleware(signingKey string, opts *WebhookOpts) func(http.Handler) http.Handler +``` + +## Parameters + + + + + +## Returns + +`func(http.Handler) http.Handler` + +## Source + +[`pkg/security/webhook_middleware.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook_middleware.go) + +Line 82. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/webhook-opts/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/webhook-opts/index.mdx new file mode 100644 index 0000000000..bd9b9d86df --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/webhook-opts/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/webhook-opts" +title: "WebhookOpts" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.WebhookOpts" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook_middleware.go" +--- +# `WebhookOpts` + +WebhookOpts configures WebhookMiddleware. + +## Signature + +```go +type WebhookOpts struct +``` + +## Properties + + + MaxBodyBytes caps the body size the middleware will buffer before signature validation. Zero (default) imposes no cap beyond Go's own MaxBytesReader behavior. A small positive value protects against memory exhaustion from oversized POSTs targeted at the gate. + + + + ProxyURLBase, when non-empty, overrides URL reconstruction entirely: the validator sees ProxyURLBase + r.URL.RequestURI(). This matches the SWML\_PROXY\_URL\_BASE env-var override documented in the spec. When empty, the env var is consulted at construction time. + + + + TrustProxy makes the middleware honor X-Forwarded-Proto and X-Forwarded-Host when reconstructing the URL passed to the validator. Leave false (default) when the SDK terminates TLS itself; flip true when running behind a reverse proxy / ngrok / load balancer. + + +## Source + +[`pkg/security/webhook_middleware.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/webhook_middleware.go) + +Line 52. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/with-debug-mode.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/with-debug-mode.mdx new file mode 100644 index 0000000000..68a0deea79 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/with-debug-mode.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/with-debug-mode" +title: "WithDebugMode" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.WithDebugMode" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go" +--- +# `WithDebugMode` + +WithDebugMode enables the DebugToken method. Off by default to prevent accidental token introspection in production. + +## Signature + +```go +func WithDebugMode(enabled bool) Option +``` + +## Parameters + + + +## Returns + +`Option` + +## Source + +[`pkg/security/session_manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go) + +Line 46. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/with-secret.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/with-secret.mdx new file mode 100644 index 0000000000..1032beba36 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/security/security/with-secret.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/security/security/with-secret" +title: "WithSecret" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/security.WithSecret" + parent: "github.com/signalwire/signalwire-go/pkg/security" + module: "github.com.signalwire.signalwire-go.pkg.security" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go" +--- +# `WithSecret` + +WithSecret injects a fixed secret key into the SessionManager. Use this when you need multiple processes or instances to validate each other's tokens. Pass nil to keep the default behaviour (auto-generate a random 32-byte secret). + +## Signature + +```go +func WithSecret(key []byte) Option +``` + +## Parameters + + + +## Returns + +`Option` + +## Source + +[`pkg/security/session_manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/security/session_manager.go) + +Line 36. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-entry/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-entry/index.mdx new file mode 100644 index 0000000000..976fa536d1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-entry/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-entry" +title: "AgentEntry" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentEntry" + parent: "github.com/signalwire/signalwire-go/pkg/server" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `AgentEntry` + +AgentEntry pairs a route with its agent for listing purposes. + +## Signature + +```go +type AgentEntry struct +``` + +## Properties + + + + + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 168. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/get-agent.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/get-agent.mdx new file mode 100644 index 0000000000..8cbfaef27a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/get-agent.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/get-agent" +title: "GetAgent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentServer.GetAgent" + parent: "github.com/signalwire/signalwire-go/pkg/server.AgentServer" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `GetAgent` + +GetAgent returns the agent registered at the given route, or nil if none. + +## Signature + +```go +func (*AgentServer) GetAgent(route string) *agent.AgentBase +``` + +## Parameters + + + +## Returns + +`*agent.AgentBase` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 188. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/get-agents.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/get-agents.mdx new file mode 100644 index 0000000000..49c86d8042 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/get-agents.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/get-agents" +title: "GetAgents" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentServer.GetAgents" + parent: "github.com/signalwire/signalwire-go/pkg/server.AgentServer" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `GetAgents` + +GetAgents returns all registered agents in insertion order. + +## Signature + +```go +func (*AgentServer) GetAgents() []AgentEntry +``` + +## Returns + +`[]AgentEntry` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 174. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/index.mdx new file mode 100644 index 0000000000..9948d06a60 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server" +title: "AgentServer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentServer" + parent: "github.com/signalwire/signalwire-go/pkg/server" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `AgentServer` + +AgentServer hosts multiple agents on a single HTTP server with route-based dispatch. Each registered agent is mounted at its own route prefix and exposed via the agent's AsRouter() handler. + +## Signature + +```go +type AgentServer struct +``` + +## Methods + + + + GetAgent returns the agent registered at the given route, or nil if none. + + + + GetAgents returns all registered agents in insertion order. + + + + Register adds an agent to the server at the given route. If route is empty the agent's configured route (via WithRoute) is used instead. The route is normalised to always start with "/". + + + + RegisterGlobalRoutingCallback registers a routing callback across all currently-registered agents at the given path. The callback fires on every incoming request to that path and can return an SWML document override (or nil to fall through to the agent's default response). + + + + RegisterGlobalSipRoutingCallback registers a SIP redirect-routing callback across all currently-registered agents at the given path. The callback returns a route string; on a non-empty return the framework responds with HTTP 307 Temporary Redirect (matching Python register\_routing\_callback semantics — see AgentBase.RegisterSipRoutingCallback for details). + + + + RegisterSipUsername maps a SIP username to an agent route so that inbound SIP calls for that username are routed to the correct agent. + + + + Run starts the HTTP server. This is a blocking call. Optional RunOption values can override host and port at start time. + + + + ServeStaticFiles registers a directory to be served at the given route. + + + + SetupSipRouting enables a central SIP routing endpoint. When autoMap is true, all currently registered agents are automatically mapped using their route as the SIP username. + + + + Unregister removes the agent at the given route. Returns true if an agent was found and removed. + + + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 24. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-global-routing-callback.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-global-routing-callback.mdx new file mode 100644 index 0000000000..3c89e1c512 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-global-routing-callback.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-global-routing-callback" +title: "RegisterGlobalRoutingCallback" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentServer.RegisterGlobalRoutingCallback" + parent: "github.com/signalwire/signalwire-go/pkg/server.AgentServer" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `RegisterGlobalRoutingCallback` + +RegisterGlobalRoutingCallback registers a routing callback across all currently-registered agents at the given path. The callback fires on every incoming request to that path and can return an SWML document override (or nil to fall through to the agent's default response). + +This is the Go equivalent of Python's AgentServer.register\_global\_routing\_callback(callback\_fn, path). + +## Signature + +```go +func (*AgentServer) RegisterGlobalRoutingCallback(path string, cb swml.RoutingCallback) +``` + +## Parameters + + + + + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 257. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-global-sip-routing-callback.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-global-sip-routing-callback.mdx new file mode 100644 index 0000000000..1307c9724f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-global-sip-routing-callback.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-global-sip-routing-callback" +title: "RegisterGlobalSipRoutingCallback" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentServer.RegisterGlobalSipRoutingCallback" + parent: "github.com/signalwire/signalwire-go/pkg/server.AgentServer" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `RegisterGlobalSipRoutingCallback` + +RegisterGlobalSipRoutingCallback registers a SIP redirect-routing callback across all currently-registered agents at the given path. The callback returns a route string; on a non-empty return the framework responds with HTTP 307 Temporary Redirect (matching Python register\_routing\_callback semantics — see AgentBase.RegisterSipRoutingCallback for details). + +Use this form when porting Python AgentServer code that registers a redirect-style global routing callback. For a global response-document override (the richer Go-only mechanism), use RegisterGlobalRoutingCallback. + +## Signature + +```go +func (*AgentServer) RegisterGlobalSipRoutingCallback( + path string, + cb func(r *http.Request, body map[string]any) string +) +``` + +## Parameters + + + + + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 286. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-sip-username.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-sip-username.mdx new file mode 100644 index 0000000000..306393b461 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-sip-username.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register-sip-username" +title: "RegisterSipUsername" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentServer.RegisterSipUsername" + parent: "github.com/signalwire/signalwire-go/pkg/server.AgentServer" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `RegisterSipUsername` + +RegisterSipUsername maps a SIP username to an agent route so that inbound SIP calls for that username are routed to the correct agent. + +## Signature + +```go +func (*AgentServer) RegisterSipUsername(username string, route string) +``` + +## Parameters + + + + + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 227. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register.mdx new file mode 100644 index 0000000000..a932b90282 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/register" +title: "Register" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentServer.Register" + parent: "github.com/signalwire/signalwire-go/pkg/server.AgentServer" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `Register` + +Register adds an agent to the server at the given route. If route is empty the agent's configured route (via WithRoute) is used instead. The route is normalised to always start with "/". + +## Signature + +```go +func (*AgentServer) Register(a *agent.AgentBase, route string) +``` + +## Parameters + + + + + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 120. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/run.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/run.mdx new file mode 100644 index 0000000000..ce701ee976 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/run.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/run" +title: "Run" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentServer.Run" + parent: "github.com/signalwire/signalwire-go/pkg/server.AgentServer" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `Run` + +Run starts the HTTP server. This is a blocking call. Optional RunOption values can override host and port at start time. + +Serverless dispatch: unlike Python's AgentServer.run() which auto-detects CGI and Lambda environments, Run() is HTTP-server-only. For AWS Lambda deployments use the pkg/lambda package instead. CGI mode has no Go equivalent; deploy as a standard HTTP service behind a reverse proxy. + +## Signature + +```go +func (*AgentServer) Run(opts ...RunOption) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 316. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/serve-static-files.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/serve-static-files.mdx new file mode 100644 index 0000000000..7419d08fae --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/serve-static-files.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/serve-static-files" +title: "ServeStaticFiles" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentServer.ServeStaticFiles" + parent: "github.com/signalwire/signalwire-go/pkg/server.AgentServer" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `ServeStaticFiles` + +ServeStaticFiles registers a directory to be served at the given route. + +## Signature + +```go +func (*AgentServer) ServeStaticFiles(directory string, route string) +``` + +## Parameters + + + + + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 239. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/setup-sip-routing.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/setup-sip-routing.mdx new file mode 100644 index 0000000000..173f8c213f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/setup-sip-routing.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/setup-sip-routing" +title: "SetupSipRouting" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentServer.SetupSipRouting" + parent: "github.com/signalwire/signalwire-go/pkg/server.AgentServer" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `SetupSipRouting` + +SetupSipRouting enables a central SIP routing endpoint. When autoMap is true, all currently registered agents are automatically mapped using their route as the SIP username. + +## Signature + +```go +func (*AgentServer) SetupSipRouting(route string, autoMap bool) +``` + +## Parameters + + + + + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 201. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/unregister.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/unregister.mdx new file mode 100644 index 0000000000..54b9337348 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/unregister.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/agent-server/unregister" +title: "Unregister" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.AgentServer.Unregister" + parent: "github.com/signalwire/signalwire-go/pkg/server.AgentServer" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `Unregister` + +Unregister removes the agent at the given route. Returns true if an agent was found and removed. + +## Signature + +```go +func (*AgentServer) Unregister(route string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 145. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/index.mdx new file mode 100644 index 0000000000..6d87f5e436 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/index.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server" +title: "server" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `server` + +Package server provides AgentServer for hosting multiple AI agents on a single HTTP server with route-based dispatch. + +## Signature + +```go +package server +``` + +## Functions + + + + NewAgentServer creates a new AgentServer with the given options. Default host is "0.0.0.0" and default port is 3000. + + + + WithLogLevel sets the global log level for the server. Accepted values (case-insensitive): "debug", "info", "warn", "warning", "error", "off". Mirrors Python AgentServer(log\_level=...) behavior: the level is applied globally via logging.SetGlobalLevel so all loggers in the process are affected. The default level is "info". + + + + WithRunHost overrides the listen address when calling Run. + + + + WithRunPort overrides the listen port when calling Run. + + + + WithServerHost sets the listen address for the server. + + + + WithServerPort sets the listen port for the server. + + + +## Type Aliases + + + + RunOption overrides server settings at run time. + + + + ServerOption configures an AgentServer during construction. + + + +## Classes + + + + AgentEntry pairs a route with its agent for listing purposes. + + + + AgentServer hosts multiple agents on a single HTTP server with route-based dispatch. Each registered agent is mounted at its own route prefix and exposed via the agent's AsRouter() handler. + + + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/new-agent-server.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/new-agent-server.mdx new file mode 100644 index 0000000000..27d367091c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/new-agent-server.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/new-agent-server" +title: "NewAgentServer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.NewAgentServer" + parent: "github.com/signalwire/signalwire-go/pkg/server" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `NewAgentServer` + +NewAgentServer creates a new AgentServer with the given options. Default host is "0.0.0.0" and default port is 3000. + +## Signature + +```go +func NewAgentServer(opts ...ServerOption) *AgentServer +``` + +## Parameters + + + +## Returns + +`*AgentServer` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 94. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/run-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/run-option.mdx new file mode 100644 index 0000000000..9cb2279ef8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/run-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/run-option" +title: "RunOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.RunOption" + parent: "github.com/signalwire/signalwire-go/pkg/server" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `RunOption` + +RunOption overrides server settings at run time. + +## Signature + +```go +type RunOption alias +``` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 76. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/server-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/server-option.mdx new file mode 100644 index 0000000000..1d6a4379f0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/server-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/server-option" +title: "ServerOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.ServerOption" + parent: "github.com/signalwire/signalwire-go/pkg/server" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `ServerOption` + +ServerOption configures an AgentServer during construction. + +## Signature + +```go +type ServerOption alias +``` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 48. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-log-level.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-log-level.mdx new file mode 100644 index 0000000000..e808ca79cd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-log-level.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-log-level" +title: "WithLogLevel" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.WithLogLevel" + parent: "github.com/signalwire/signalwire-go/pkg/server" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `WithLogLevel` + +WithLogLevel sets the global log level for the server. Accepted values (case-insensitive): "debug", "info", "warn", "warning", "error", "off". Mirrors Python AgentServer(log\_level=...) behavior: the level is applied globally via logging.SetGlobalLevel so all loggers in the process are affected. The default level is "info". + +## Signature + +```go +func WithLogLevel(level string) ServerOption +``` + +## Parameters + + + +## Returns + +`ServerOption` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 65. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-run-host.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-run-host.mdx new file mode 100644 index 0000000000..38d6650164 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-run-host.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-run-host" +title: "WithRunHost" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.WithRunHost" + parent: "github.com/signalwire/signalwire-go/pkg/server" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `WithRunHost` + +WithRunHost overrides the listen address when calling Run. + +## Signature + +```go +func WithRunHost(host string) RunOption +``` + +## Parameters + + + +## Returns + +`RunOption` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 79. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-run-port.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-run-port.mdx new file mode 100644 index 0000000000..9a87777986 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-run-port.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-run-port" +title: "WithRunPort" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.WithRunPort" + parent: "github.com/signalwire/signalwire-go/pkg/server" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `WithRunPort` + +WithRunPort overrides the listen port when calling Run. + +## Signature + +```go +func WithRunPort(port int) RunOption +``` + +## Parameters + + + +## Returns + +`RunOption` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 84. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-server-host.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-server-host.mdx new file mode 100644 index 0000000000..bbad28a202 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-server-host.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-server-host" +title: "WithServerHost" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.WithServerHost" + parent: "github.com/signalwire/signalwire-go/pkg/server" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `WithServerHost` + +WithServerHost sets the listen address for the server. + +## Signature + +```go +func WithServerHost(host string) ServerOption +``` + +## Parameters + + + +## Returns + +`ServerOption` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 51. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-server-port.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-server-port.mdx new file mode 100644 index 0000000000..efa709527b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-server-port.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/server/server/with-server-port" +title: "WithServerPort" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/server.WithServerPort" + parent: "github.com/signalwire/signalwire-go/pkg/server" + module: "github.com.signalwire.signalwire-go.pkg.server" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go" +--- +# `WithServerPort` + +WithServerPort sets the listen port for the server. + +## Signature + +```go +func WithServerPort(port int) ServerOption +``` + +## Parameters + + + +## Returns + +`ServerOption` + +## Source + +[`pkg/server/server.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/server/server.go) + +Line 56. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-hints.mdx new file mode 100644 index 0000000000..3a659287b8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-hints.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go" +--- +# `GetHints` + +## Signature + +```go +func (*APINinjasTriviaSkill) GetHints() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/api_ninjas_trivia.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go) + +Line 225. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-instance-key.mdx new file mode 100644 index 0000000000..3e718efaf4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-instance-key.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go" +--- +# `GetInstanceKey` + +## Signature + +```go +func (*APINinjasTriviaSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/builtin/api_ninjas_trivia.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go) + +Line 64. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..33cbfd5dbd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*APINinjasTriviaSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/api_ninjas_trivia.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go) + +Line 242. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..85177ac0a8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*APINinjasTriviaSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/api_ninjas_trivia.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go) + +Line 229. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/index.mdx new file mode 100644 index 0000000000..8b844167c7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill" +title: "APINinjasTriviaSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go" +--- +# `APINinjasTriviaSkill` + +APINinjasTriviaSkill gets trivia questions from API Ninjas. + +## Signature + +```go +type APINinjasTriviaSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/api_ninjas_trivia.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go) + +Line 34. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/register-tools.mdx new file mode 100644 index 0000000000..7b8dd7a6de --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*APINinjasTriviaSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/api_ninjas_trivia.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go) + +Line 116. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/required-env-vars.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/required-env-vars.mdx new file mode 100644 index 0000000000..2b628c5eeb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/required-env-vars.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/required-env-vars" +title: "RequiredEnvVars" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill.RequiredEnvVars" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go" +--- +# `RequiredEnvVars` + +## Signature + +```go +func (*APINinjasTriviaSkill) RequiredEnvVars() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/api_ninjas_trivia.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go) + +Line 53. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/setup.mdx new file mode 100644 index 0000000000..fef33a9a14 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go" +--- +# `Setup` + +## Signature + +```go +func (*APINinjasTriviaSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/api_ninjas_trivia.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go) + +Line 69. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..497640bdc7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/supports-multiple-instances.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/api-ninjas-trivia-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.APINinjasTriviaSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go" +--- +# `SupportsMultipleInstances` + +## Signature + +```go +func (*APINinjasTriviaSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/api_ninjas_trivia.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go) + +Line 62. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-hints.mdx new file mode 100644 index 0000000000..c181a94248 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go" +--- +# `GetHints` + +GetHints returns speech recognition hints derived from loaded skill names. + +## Signature + +```go +func (*ClaudeSkillsSkill) GetHints() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/claude_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go) + +Line 728. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-instance-key.mdx new file mode 100644 index 0000000000..68e7705cdc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-instance-key.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go" +--- +# `GetInstanceKey` + +GetInstanceKey returns a unique key based on skills\_path for multi-instance support. + +## Signature + +```go +func (*ClaudeSkillsSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/builtin/claude_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go) + +Line 797. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..ecca6e505d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-parameter-schema.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go" +--- +# `GetParameterSchema` + +GetParameterSchema returns the full parameter schema for the SKILL.md loader. + +## Signature + +```go +func (*ClaudeSkillsSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/claude_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go) + +Line 804. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..781eb1120d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go" +--- +# `GetPromptSections` + +GetPromptSections returns one prompt section per loaded skill (excluding skipped ones). + +## Signature + +```go +func (*ClaudeSkillsSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/claude_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go) + +Line 744. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/index.mdx new file mode 100644 index 0000000000..b6a93a997c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill" +title: "ClaudeSkillsSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go" +--- +# `ClaudeSkillsSkill` + +ClaudeSkillsSkill loads Claude-style SKILL.md files as SignalWire agent tools. + +Each directory under skills\_path that contains a SKILL.md becomes a SWAIG tool. The SKILL.md frontmatter provides the tool name and description; the body becomes the tool's response content when invoked. + +## Signature + +```go +type ClaudeSkillsSkill struct +``` + +## Properties + + + +## Methods + + + + GetHints returns speech recognition hints derived from loaded skill names. + + + + GetInstanceKey returns a unique key based on skills\_path for multi-instance support. + + + + GetParameterSchema returns the full parameter schema for the SKILL.md loader. + + + + GetPromptSections returns one prompt section per loaded skill (excluding skipped ones). + + + + RegisterTools returns one ToolRegistration per discovered SKILL.md that is not flagged to skip. + + + + RequiredEnvVars returns nil — no env vars required (skills\_path is a param). + + + + Setup validates configuration and discovers SKILL.md files. + + + + SupportsMultipleInstances returns true — different skills\_path values create distinct instances. + + + +## Source + +[`pkg/skills/builtin/claude_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go) + +Line 82. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/register-tools.mdx new file mode 100644 index 0000000000..7bd6f3d7c1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go" +--- +# `RegisterTools` + +RegisterTools returns one ToolRegistration per discovered SKILL.md that is not flagged to skip. + +## Signature + +```go +func (*ClaudeSkillsSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/claude_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go) + +Line 612. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/required-env-vars.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/required-env-vars.mdx new file mode 100644 index 0000000000..8a0ad430ab --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/required-env-vars.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/required-env-vars" +title: "RequiredEnvVars" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill.RequiredEnvVars" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go" +--- +# `RequiredEnvVars` + +RequiredEnvVars returns nil — no env vars required (skills\_path is a param). + +## Signature + +```go +func (*ClaudeSkillsSkill) RequiredEnvVars() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/claude_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go) + +Line 118. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/setup.mdx new file mode 100644 index 0000000000..53bbf0d9fc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go" +--- +# `Setup` + +Setup validates configuration and discovers SKILL.md files. + +## Signature + +```go +func (*ClaudeSkillsSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/claude_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go) + +Line 121. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..50f290a162 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/supports-multiple-instances.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/claude-skills-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.ClaudeSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go" +--- +# `SupportsMultipleInstances` + +SupportsMultipleInstances returns true — different skills\_path values create distinct instances. + +## Signature + +```go +func (*ClaudeSkillsSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/claude_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go) + +Line 115. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-instance-key.mdx new file mode 100644 index 0000000000..f2704e41d2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-instance-key.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go" +--- +# `GetInstanceKey` + +## Signature + +```go +func (*CustomSkillsSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/builtin/custom_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go) + +Line 28. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..fab513a2ae --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*CustomSkillsSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/custom_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go) + +Line 134. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..17c1518f5d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*CustomSkillsSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/custom_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go) + +Line 110. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/index.mdx new file mode 100644 index 0000000000..258be9799a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill" +title: "CustomSkillsSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go" +--- +# `CustomSkillsSkill` + +CustomSkillsSkill is a meta-skill that registers user-defined tools. + +## Signature + +```go +type CustomSkillsSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/custom_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go) + +Line 9. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/register-tools.mdx new file mode 100644 index 0000000000..6525e5aacf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*CustomSkillsSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/custom_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go) + +Line 60. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/setup.mdx new file mode 100644 index 0000000000..4467a77f78 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go" +--- +# `Setup` + +## Signature + +```go +func (*CustomSkillsSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/custom_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go) + +Line 33. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..39dd3125af --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/supports-multiple-instances.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/custom-skills-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.CustomSkillsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go" +--- +# `SupportsMultipleInstances` + +## Signature + +```go +func (*CustomSkillsSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/custom_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go) + +Line 26. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-global-data.mdx new file mode 100644 index 0000000000..7b70472e75 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-global-data" +title: "GetGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill.GetGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go" +--- +# `GetGlobalData` + +GetGlobalData returns global data for agent context. + +## Signature + +```go +func (*DataSphereServerlessSkill) GetGlobalData() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/skills/builtin/datasphere_serverless.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go) + +Line 176. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-instance-key.mdx new file mode 100644 index 0000000000..8c355b2857 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-instance-key.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go" +--- +# `GetInstanceKey` + +## Signature + +```go +func (*DataSphereServerlessSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/builtin/datasphere_serverless.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go) + +Line 58. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..43a8e7c071 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*DataSphereServerlessSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/datasphere_serverless.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go) + +Line 200. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..513a4b4ddf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*DataSphereServerlessSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/datasphere_serverless.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go) + +Line 184. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/index.mdx new file mode 100644 index 0000000000..b58bc053bd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill" +title: "DataSphereServerlessSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go" +--- +# `DataSphereServerlessSkill` + +DataSphereServerlessSkill provides DataSphere search using DataMap (serverless execution). + +## Signature + +```go +type DataSphereServerlessSkill struct +``` + +## Properties + + + +## Methods + + + + GetGlobalData returns global data for agent context. + + + + + + + + + + RegisterTools returns DataMap-style tool registration for serverless execution. The actual tool is registered as a DataMap function that runs on SignalWire servers. + + + + + + + + + +## Source + +[`pkg/skills/builtin/datasphere_serverless.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go) + +Line 14. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/register-tools.mdx new file mode 100644 index 0000000000..a6c47612e2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go" +--- +# `RegisterTools` + +RegisterTools returns DataMap-style tool registration for serverless execution. The actual tool is registered as a DataMap function that runs on SignalWire servers. + +## Signature + +```go +func (*DataSphereServerlessSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/datasphere_serverless.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go) + +Line 100. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/required-env-vars.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/required-env-vars.mdx new file mode 100644 index 0000000000..5b00ca3db7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/required-env-vars.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/required-env-vars" +title: "RequiredEnvVars" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill.RequiredEnvVars" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go" +--- +# `RequiredEnvVars` + +## Signature + +```go +func (*DataSphereServerlessSkill) RequiredEnvVars() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/datasphere_serverless.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go) + +Line 44. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/setup.mdx new file mode 100644 index 0000000000..d3955e0b93 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go" +--- +# `Setup` + +## Signature + +```go +func (*DataSphereServerlessSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/datasphere_serverless.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go) + +Line 63. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..08c9f2e8b3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/supports-multiple-instances.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-serverless-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereServerlessSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go" +--- +# `SupportsMultipleInstances` + +## Signature + +```go +func (*DataSphereServerlessSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/datasphere_serverless.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go) + +Line 56. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-global-data.mdx new file mode 100644 index 0000000000..61361ddeda --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-global-data.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-global-data" +title: "GetGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill.GetGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go" +--- +# `GetGlobalData` + +## Signature + +```go +func (*DataSphereSkill) GetGlobalData() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/skills/builtin/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go) + +Line 221. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-instance-key.mdx new file mode 100644 index 0000000000..6a964bbbff --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-instance-key.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go" +--- +# `GetInstanceKey` + +## Signature + +```go +func (*DataSphereSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/builtin/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go) + +Line 60. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..8dd5c39cb3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*DataSphereSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go) + +Line 244. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..4b61842e14 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*DataSphereSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go) + +Line 229. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/index.mdx new file mode 100644 index 0000000000..f24d1cfb5b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill" +title: "DataSphereSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go" +--- +# `DataSphereSkill` + +DataSphereSkill searches knowledge using SignalWire DataSphere RAG stack. + +## Signature + +```go +type DataSphereSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/register-tools.mdx new file mode 100644 index 0000000000..c92f5f7482 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*DataSphereSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go) + +Line 124. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/required-env-vars.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/required-env-vars.mdx new file mode 100644 index 0000000000..017993c49f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/required-env-vars.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/required-env-vars" +title: "RequiredEnvVars" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill.RequiredEnvVars" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go" +--- +# `RequiredEnvVars` + +## Signature + +```go +func (*DataSphereSkill) RequiredEnvVars() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go) + +Line 46. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/setup.mdx new file mode 100644 index 0000000000..38bfa227f2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go" +--- +# `Setup` + +## Signature + +```go +func (*DataSphereSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go) + +Line 65. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..9bf86c60d2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/supports-multiple-instances.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/data-sphere-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DataSphereSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go" +--- +# `SupportsMultipleInstances` + +## Signature + +```go +func (*DataSphereSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go) + +Line 58. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/get-hints.mdx new file mode 100644 index 0000000000..8fc78f0d44 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/get-hints.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DateTimeSkill.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DateTimeSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go" +--- +# `GetHints` + +## Signature + +```go +func (*DateTimeSkill) GetHints() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/datetime.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go) + +Line 128. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..aaaef58250 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DateTimeSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DateTimeSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*DateTimeSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/datetime.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go) + +Line 132. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/index.mdx new file mode 100644 index 0000000000..6935952b56 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill" +title: "DateTimeSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DateTimeSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go" +--- +# `DateTimeSkill` + +DateTimeSkill provides current date and time information. + +## Signature + +```go +type DateTimeSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/datetime.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go) + +Line 12. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/register-tools.mdx new file mode 100644 index 0000000000..0253df1b1c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DateTimeSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DateTimeSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*DateTimeSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/datetime.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go) + +Line 35. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/setup.mdx new file mode 100644 index 0000000000..9d2600a4ae --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/date-time-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DateTimeSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.DateTimeSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go" +--- +# `Setup` + +## Signature + +```go +func (*DateTimeSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/datetime.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go) + +Line 30. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-hints.mdx new file mode 100644 index 0000000000..3a56aa0a2d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-hints.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go" +--- +# `GetHints` + +## Signature + +```go +func (*GoogleMapsSkill) GetHints() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/google_maps.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go) + +Line 293. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..57e710e3f3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*GoogleMapsSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/google_maps.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go) + +Line 312. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..85a67987d4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*GoogleMapsSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/google_maps.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go) + +Line 297. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/index.mdx new file mode 100644 index 0000000000..a874bd7b6e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill" +title: "GoogleMapsSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go" +--- +# `GoogleMapsSkill` + +GoogleMapsSkill validates addresses and computes routes using Google Maps. + +## Signature + +```go +type GoogleMapsSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/google_maps.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go) + +Line 18. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/register-tools.mdx new file mode 100644 index 0000000000..0ca124d554 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*GoogleMapsSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/google_maps.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go) + +Line 53. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/required-env-vars.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/required-env-vars.mdx new file mode 100644 index 0000000000..df376d65fc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/required-env-vars.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/required-env-vars" +title: "RequiredEnvVars" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill.RequiredEnvVars" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go" +--- +# `RequiredEnvVars` + +## Signature + +```go +func (*GoogleMapsSkill) RequiredEnvVars() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/google_maps.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go) + +Line 37. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/setup.mdx new file mode 100644 index 0000000000..0691b2b3cd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/google-maps-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.GoogleMapsSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go" +--- +# `Setup` + +## Signature + +```go +func (*GoogleMapsSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/google_maps.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go) + +Line 46. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/index.mdx new file mode 100644 index 0000000000..772fe72026 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/index.mdx @@ -0,0 +1,198 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin" +title: "builtin" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go" +--- +# `builtin` + +## Signature + +```go +package builtin +``` + +## Constants + + + \_digitStartRE checks if a string starts with a digit. + + + + \_hyphenSpaceRE matches hyphens and spaces for sanitization. + + + + \_sanitizeRE matches characters invalid in SWAIG tool names. + + + + \_shellInjectionRE matches !`command` patterns in skill bodies. + + + + \_unsupportedFields maps SKILL.md frontmatter field names to warning message templates. + + +## Functions + + + + NewAPINinjasTrivia creates a new APINinjasTriviaSkill. + + + + NewClaudeSkills creates a new ClaudeSkillsSkill. + + + + NewCustomSkills creates a new CustomSkillsSkill. + + + + NewDataSphere creates a new DataSphereSkill. + + + + NewDataSphereServerless creates a new DataSphereServerlessSkill. + + + + NewDateTime creates a new DateTimeSkill. + + + + NewGoogleMaps creates a new GoogleMapsSkill. + + + + NewInfoGatherer creates a new InfoGathererSkill. + + + + NewJoke creates a new JokeSkill. + + + + NewMath creates a new MathSkill. + + + + NewMCPGateway creates a new MCPGatewaySkill. + + + + NewNativeVectorSearch creates a new NativeVectorSearchSkill. + + + + NewPlayBackgroundFile creates a new PlayBackgroundFileSkill. + + + + NewSpider creates a new SpiderSkill. + + + + NewSWMLTransfer creates a new SWMLTransferSkill. + + + + NewWeatherAPI creates a new WeatherAPISkill. + + + + NewWebSearch creates a new WebSearchSkill. + + + + NewWikipediaSearch creates a new WikipediaSearchSkill. + + + +## Classes + + + + APINinjasTriviaSkill gets trivia questions from API Ninjas. + + + + ClaudeSkillsSkill loads Claude-style SKILL.md files as SignalWire agent tools. + + + + CustomSkillsSkill is a meta-skill that registers user-defined tools. + + + + DataSphereServerlessSkill provides DataSphere search using DataMap (serverless execution). + + + + DataSphereSkill searches knowledge using SignalWire DataSphere RAG stack. + + + + DateTimeSkill provides current date and time information. + + + + GoogleMapsSkill validates addresses and computes routes using Google Maps. + + + + InfoGathererSkill guides an AI agent through a series of questions, collecting and storing answers in global\_data. + + + + JokeSkill tells random jokes from a built-in list. + + + + MathSkill provides basic mathematical calculation capabilities. + + + + MCPGatewaySkill connects to MCP gateway servers and registers their tools. + + + + NativeVectorSearchSkill searches knowledge using a remote search server. + + + + PlayBackgroundFileSkill plays audio files in the background. + + + + SpiderSkill fetches and extracts text content from URLs. + + + + SWMLTransferSkill transfers calls between agents using DataMap pattern matching. + + + + WeatherAPISkill gets current weather from WeatherAPI.com. + + + + WebSearchSkill searches the web using Google Custom Search API. + + + + WikipediaSearchSkill searches Wikipedia for information. + + + +## Source + +[`pkg/skills/builtin/api_ninjas_trivia.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-global-data.mdx new file mode 100644 index 0000000000..d609b9f680 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-global-data.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-global-data" +title: "GetGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill.GetGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go" +--- +# `GetGlobalData` + +## Signature + +```go +func (*InfoGathererSkill) GetGlobalData() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/skills/builtin/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go) + +Line 249. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-instance-key.mdx new file mode 100644 index 0000000000..e46e6a0ce1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-instance-key.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go" +--- +# `GetInstanceKey` + +## Signature + +```go +func (*InfoGathererSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/builtin/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go) + +Line 35. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..3333ec2b76 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*InfoGathererSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go) + +Line 282. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..a592974226 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*InfoGathererSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go) + +Line 259. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/index.mdx new file mode 100644 index 0000000000..ba7f2c6609 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill" +title: "InfoGathererSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go" +--- +# `InfoGathererSkill` + +InfoGathererSkill guides an AI agent through a series of questions, collecting and storing answers in global\_data. + +## Signature + +```go +type InfoGathererSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go) + +Line 12. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/register-tools.mdx new file mode 100644 index 0000000000..3b96d19335 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*InfoGathererSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go) + +Line 84. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/setup.mdx new file mode 100644 index 0000000000..fa27524aae --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go" +--- +# `Setup` + +## Signature + +```go +func (*InfoGathererSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go) + +Line 42. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..c06669edcc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/supports-multiple-instances.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/info-gatherer-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.InfoGathererSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go" +--- +# `SupportsMultipleInstances` + +## Signature + +```go +func (*InfoGathererSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go) + +Line 33. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-global-data.mdx new file mode 100644 index 0000000000..2f99f1c558 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-global-data.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-global-data" +title: "GetGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.JokeSkill.GetGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.JokeSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go" +--- +# `GetGlobalData` + +## Signature + +```go +func (*JokeSkill) GetGlobalData() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/skills/builtin/joke.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go) + +Line 79. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-hints.mdx new file mode 100644 index 0000000000..60b3654f09 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-hints.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.JokeSkill.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.JokeSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go" +--- +# `GetHints` + +## Signature + +```go +func (*JokeSkill) GetHints() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/joke.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go) + +Line 85. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..65cbf2d7f2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.JokeSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.JokeSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*JokeSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/joke.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go) + +Line 89. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/index.mdx new file mode 100644 index 0000000000..a84c28fba6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill" +title: "JokeSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.JokeSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go" +--- +# `JokeSkill` + +JokeSkill tells random jokes from a built-in list. + +## Signature + +```go +type JokeSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/joke.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go) + +Line 29. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/register-tools.mdx new file mode 100644 index 0000000000..9f9b3763fd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.JokeSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.JokeSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*JokeSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/joke.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go) + +Line 53. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/setup.mdx new file mode 100644 index 0000000000..84624500b2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/joke-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.JokeSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.JokeSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go" +--- +# `Setup` + +## Signature + +```go +func (*JokeSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/joke.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go) + +Line 47. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..3d7254d13e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MathSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MathSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/math.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*MathSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/math.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/math.go) + +Line 143. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/index.mdx new file mode 100644 index 0000000000..ebcba8109a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill" +title: "MathSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MathSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/math.go" +--- +# `MathSkill` + +MathSkill provides basic mathematical calculation capabilities. + +## Signature + +```go +type MathSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + +## Source + +[`pkg/skills/builtin/math.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/math.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/register-tools.mdx new file mode 100644 index 0000000000..e245134057 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MathSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MathSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/math.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*MathSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/math.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/math.go) + +Line 34. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/setup.mdx new file mode 100644 index 0000000000..27dc8df614 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/math-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MathSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MathSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/math.go" +--- +# `Setup` + +## Signature + +```go +func (*MathSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/math.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/math.go) + +Line 32. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-global-data.mdx new file mode 100644 index 0000000000..d1287656ce --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-global-data" +title: "GetGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill.GetGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go" +--- +# `GetGlobalData` + +GetGlobalData returns MCP gateway state for DataMap variable expansion. Mirrors Python get\_global\_data: mcp\_gateway\_url, mcp\_session\_id, mcp\_services. + +## Signature + +```go +func (*MCPGatewaySkill) GetGlobalData() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/skills/builtin/mcp_gateway.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go) + +Line 353. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-hints.mdx new file mode 100644 index 0000000000..b11aee1b1e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-hints.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go" +--- +# `GetHints` + +## Signature + +```go +func (*MCPGatewaySkill) GetHints() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/mcp_gateway.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go) + +Line 367. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..603869480e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*MCPGatewaySkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/mcp_gateway.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go) + +Line 398. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..d425018ea0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*MCPGatewaySkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/mcp_gateway.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go) + +Line 377. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/index.mdx new file mode 100644 index 0000000000..779ce9ebd7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill" +title: "MCPGatewaySkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go" +--- +# `MCPGatewaySkill` + +MCPGatewaySkill connects to MCP gateway servers and registers their tools. + +## Signature + +```go +type MCPGatewaySkill struct +``` + +## Properties + + + +## Methods + + + + GetGlobalData returns MCP gateway state for DataMap variable expansion. Mirrors Python get\_global\_data: mcp\_gateway\_url, mcp\_session\_id, mcp\_services. + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/mcp_gateway.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go) + +Line 17. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/register-tools.mdx new file mode 100644 index 0000000000..38100b34f1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*MCPGatewaySkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/mcp_gateway.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go) + +Line 110. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/setup.mdx new file mode 100644 index 0000000000..76a3d7e591 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/mcp-gateway-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.MCPGatewaySkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go" +--- +# `Setup` + +## Signature + +```go +func (*MCPGatewaySkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/mcp_gateway.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go) + +Line 45. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..927d552008 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-global-data.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-global-data" +title: "GetGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill.GetGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go" +--- +# `GetGlobalData` + +## Signature + +```go +func (*NativeVectorSearchSkill) GetGlobalData() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/skills/builtin/native_vector_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go) + +Line 380. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-hints.mdx new file mode 100644 index 0000000000..0e9b6337d1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-hints.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go" +--- +# `GetHints` + +## Signature + +```go +func (*NativeVectorSearchSkill) GetHints() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/native_vector_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go) + +Line 350. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-instance-key.mdx new file mode 100644 index 0000000000..58d2924535 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-instance-key.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go" +--- +# `GetInstanceKey` + +## Signature + +```go +func (*NativeVectorSearchSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/builtin/native_vector_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go) + +Line 52. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..e774deef55 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*NativeVectorSearchSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/native_vector_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go) + +Line 386. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..bec7ceedfe --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*NativeVectorSearchSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/native_vector_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go) + +Line 362. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/index.mdx new file mode 100644 index 0000000000..fac282ae01 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill" +title: "NativeVectorSearchSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go" +--- +# `NativeVectorSearchSkill` + +NativeVectorSearchSkill searches knowledge using a remote search server. + +## Signature + +```go +type NativeVectorSearchSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/native_vector_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go) + +Line 20. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/register-tools.mdx new file mode 100644 index 0000000000..385612afdf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*NativeVectorSearchSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/native_vector_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go) + +Line 200. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/setup.mdx new file mode 100644 index 0000000000..a5a8e3564b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go" +--- +# `Setup` + +## Signature + +```go +func (*NativeVectorSearchSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/native_vector_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go) + +Line 116. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..db36d8a2c7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/supports-multiple-instances.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/native-vector-search-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NativeVectorSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go" +--- +# `SupportsMultipleInstances` + +## Signature + +```go +func (*NativeVectorSearchSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/native_vector_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go) + +Line 50. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-api-ninjas-trivia.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-api-ninjas-trivia.mdx new file mode 100644 index 0000000000..2b17b13c68 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-api-ninjas-trivia.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-api-ninjas-trivia" +title: "NewAPINinjasTrivia" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewAPINinjasTrivia" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go" +--- +# `NewAPINinjasTrivia` + +NewAPINinjasTrivia creates a new APINinjasTriviaSkill. + +## Signature + +```go +func NewAPINinjasTrivia(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/api_ninjas_trivia.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/api_ninjas_trivia.go) + +Line 42. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-claude-skills.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-claude-skills.mdx new file mode 100644 index 0000000000..da9c209409 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-claude-skills.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-claude-skills" +title: "NewClaudeSkills" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewClaudeSkills" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go" +--- +# `NewClaudeSkills` + +NewClaudeSkills creates a new ClaudeSkillsSkill. + +## Signature + +```go +func NewClaudeSkills(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/claude_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/claude_skills.go) + +Line 103. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-custom-skills.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-custom-skills.mdx new file mode 100644 index 0000000000..ea60a3efe9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-custom-skills.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-custom-skills" +title: "NewCustomSkills" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewCustomSkills" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go" +--- +# `NewCustomSkills` + +NewCustomSkills creates a new CustomSkillsSkill. + +## Signature + +```go +func NewCustomSkills(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/custom_skills.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/custom_skills.go) + +Line 15. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-data-sphere-serverless.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-data-sphere-serverless.mdx new file mode 100644 index 0000000000..42914ccc4e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-data-sphere-serverless.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-data-sphere-serverless" +title: "NewDataSphereServerless" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewDataSphereServerless" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go" +--- +# `NewDataSphereServerless` + +NewDataSphereServerless creates a new DataSphereServerlessSkill. + +## Signature + +```go +func NewDataSphereServerless(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/datasphere_serverless.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere_serverless.go) + +Line 33. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-data-sphere.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-data-sphere.mdx new file mode 100644 index 0000000000..830cd69a66 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-data-sphere.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-data-sphere" +title: "NewDataSphere" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewDataSphere" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go" +--- +# `NewDataSphere` + +NewDataSphere creates a new DataSphereSkill. + +## Signature + +```go +func NewDataSphere(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/datasphere.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datasphere.go) + +Line 34. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-date-time.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-date-time.mdx new file mode 100644 index 0000000000..195a8a6f92 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-date-time.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-date-time" +title: "NewDateTime" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewDateTime" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go" +--- +# `NewDateTime` + +NewDateTime creates a new DateTimeSkill. + +## Signature + +```go +func NewDateTime(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/datetime.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/datetime.go) + +Line 18. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-google-maps.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-google-maps.mdx new file mode 100644 index 0000000000..5f7be02c0f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-google-maps.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-google-maps" +title: "NewGoogleMaps" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewGoogleMaps" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go" +--- +# `NewGoogleMaps` + +NewGoogleMaps creates a new GoogleMapsSkill. + +## Signature + +```go +func NewGoogleMaps(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/google_maps.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/google_maps.go) + +Line 26. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-info-gatherer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-info-gatherer.mdx new file mode 100644 index 0000000000..7ba1c05e99 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-info-gatherer.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-info-gatherer" +title: "NewInfoGatherer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewInfoGatherer" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go" +--- +# `NewInfoGatherer` + +NewInfoGatherer creates a new InfoGathererSkill. + +## Signature + +```go +func NewInfoGatherer(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/info_gatherer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/info_gatherer.go) + +Line 22. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-joke.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-joke.mdx new file mode 100644 index 0000000000..f902ca344e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-joke.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-joke" +title: "NewJoke" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewJoke" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go" +--- +# `NewJoke` + +NewJoke creates a new JokeSkill. + +## Signature + +```go +func NewJoke(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/joke.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/joke.go) + +Line 36. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-math.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-math.mdx new file mode 100644 index 0000000000..3ebc2b4467 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-math.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-math" +title: "NewMath" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewMath" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/math.go" +--- +# `NewMath` + +NewMath creates a new MathSkill. + +## Signature + +```go +func NewMath(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/math.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/math.go) + +Line 21. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-mcp-gateway.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-mcp-gateway.mdx new file mode 100644 index 0000000000..ba8f5d3060 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-mcp-gateway.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-mcp-gateway" +title: "NewMCPGateway" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewMCPGateway" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go" +--- +# `NewMCPGateway` + +NewMCPGateway creates a new MCPGatewaySkill. + +## Signature + +```go +func NewMCPGateway(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/mcp_gateway.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/mcp_gateway.go) + +Line 34. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-native-vector-search.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-native-vector-search.mdx new file mode 100644 index 0000000000..018402d6c3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-native-vector-search.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-native-vector-search" +title: "NewNativeVectorSearch" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewNativeVectorSearch" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go" +--- +# `NewNativeVectorSearch` + +NewNativeVectorSearch creates a new NativeVectorSearchSkill. + +## Signature + +```go +func NewNativeVectorSearch(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/native_vector_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/native_vector_search.go) + +Line 38. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-play-background-file.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-play-background-file.mdx new file mode 100644 index 0000000000..082a126469 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-play-background-file.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-play-background-file" +title: "NewPlayBackgroundFile" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewPlayBackgroundFile" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go" +--- +# `NewPlayBackgroundFile` + +NewPlayBackgroundFile creates a new PlayBackgroundFileSkill. + +## Signature + +```go +func NewPlayBackgroundFile(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/play_background_file.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go) + +Line 22. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-spider.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-spider.mdx new file mode 100644 index 0000000000..03d90450e4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-spider.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-spider" +title: "NewSpider" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewSpider" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go" +--- +# `NewSpider` + +NewSpider creates a new SpiderSkill. + +## Signature + +```go +func NewSpider(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/spider.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go) + +Line 72. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-swml-transfer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-swml-transfer.mdx new file mode 100644 index 0000000000..2eb1b5e11c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-swml-transfer.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-swml-transfer" +title: "NewSWMLTransfer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewSWMLTransfer" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go" +--- +# `NewSWMLTransfer` + +NewSWMLTransfer creates a new SWMLTransferSkill. + +## Signature + +```go +func NewSWMLTransfer(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/swml_transfer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go) + +Line 25. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-weather-api.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-weather-api.mdx new file mode 100644 index 0000000000..244ab26d8d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-weather-api.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-weather-api" +title: "NewWeatherAPI" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewWeatherAPI" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go" +--- +# `NewWeatherAPI` + +NewWeatherAPI creates a new WeatherAPISkill. + +## Signature + +```go +func NewWeatherAPI(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/weather_api.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go) + +Line 25. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-web-search.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-web-search.mdx new file mode 100644 index 0000000000..2a5093a5bd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-web-search.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-web-search" +title: "NewWebSearch" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewWebSearch" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go" +--- +# `NewWebSearch` + +NewWebSearch creates a new WebSearchSkill. + +## Signature + +```go +func NewWebSearch(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/web_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go) + +Line 43. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-wikipedia-search.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-wikipedia-search.mdx new file mode 100644 index 0000000000..8a10e78d69 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-wikipedia-search.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/new-wikipedia-search" +title: "NewWikipediaSearch" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.NewWikipediaSearch" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go" +--- +# `NewWikipediaSearch` + +NewWikipediaSearch creates a new WikipediaSearchSkill. + +## Signature + +```go +func NewWikipediaSearch(params map[string]any) skills.SkillBase +``` + +## Parameters + + + +## Returns + +`skills.SkillBase` + +## Source + +[`pkg/skills/builtin/wikipedia_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go) + +Line 24. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/get-instance-key.mdx new file mode 100644 index 0000000000..c3b8368b6a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/get-instance-key.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.PlayBackgroundFileSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.PlayBackgroundFileSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go" +--- +# `GetInstanceKey` + +## Signature + +```go +func (*PlayBackgroundFileSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/builtin/play_background_file.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go) + +Line 35. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..b113c92376 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.PlayBackgroundFileSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.PlayBackgroundFileSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*PlayBackgroundFileSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/play_background_file.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go) + +Line 158. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/index.mdx new file mode 100644 index 0000000000..ebdaea9634 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill" +title: "PlayBackgroundFileSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.PlayBackgroundFileSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go" +--- +# `PlayBackgroundFileSkill` + +PlayBackgroundFileSkill plays audio files in the background. + +## Signature + +```go +type PlayBackgroundFileSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/play_background_file.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go) + +Line 15. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/register-tools.mdx new file mode 100644 index 0000000000..8e08ba8cbb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.PlayBackgroundFileSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.PlayBackgroundFileSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*PlayBackgroundFileSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/play_background_file.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go) + +Line 84. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/setup.mdx new file mode 100644 index 0000000000..9a539097d8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.PlayBackgroundFileSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.PlayBackgroundFileSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go" +--- +# `Setup` + +## Signature + +```go +func (*PlayBackgroundFileSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/play_background_file.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go) + +Line 40. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..84e13aaad0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/supports-multiple-instances.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/play-background-file-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.PlayBackgroundFileSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.PlayBackgroundFileSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go" +--- +# `SupportsMultipleInstances` + +## Signature + +```go +func (*PlayBackgroundFileSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/play_background_file.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/play_background_file.go) + +Line 33. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/cleanup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/cleanup.mdx new file mode 100644 index 0000000000..d1efd212ee --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/cleanup.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/cleanup" +title: "Cleanup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill.Cleanup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go" +--- +# `Cleanup` + +Cleanup releases resources when the skill is unloaded. + +## Signature + +```go +func (*SpiderSkill) Cleanup() +``` + +## Source + +[`pkg/skills/builtin/spider.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go) + +Line 720. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-hints.mdx new file mode 100644 index 0000000000..a0f52cc9c4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-hints.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go" +--- +# `GetHints` + +## Signature + +```go +func (*SpiderSkill) GetHints() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/spider.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go) + +Line 715. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-instance-key.mdx new file mode 100644 index 0000000000..a27e0b5bdd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-instance-key.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go" +--- +# `GetInstanceKey` + +## Signature + +```go +func (*SpiderSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/builtin/spider.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go) + +Line 85. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..521bb27e29 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-parameter-schema.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go" +--- +# `GetParameterSchema` + +GetParameterSchema returns the full parameter schema extending the base schema. + +## Signature + +```go +func (*SpiderSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/spider.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go) + +Line 149. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/index.mdx new file mode 100644 index 0000000000..5b647e0954 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill" +title: "SpiderSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go" +--- +# `SpiderSkill` + +SpiderSkill fetches and extracts text content from URLs. + +## Signature + +```go +type SpiderSkill struct +``` + +## Properties + + + +## Methods + + + + Cleanup releases resources when the skill is unloaded. + + + + + + + + GetParameterSchema returns the full parameter schema extending the base schema. + + + + + + + + + +## Source + +[`pkg/skills/builtin/spider.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go) + +Line 47. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/register-tools.mdx new file mode 100644 index 0000000000..b0d40bae6f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*SpiderSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/spider.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go) + +Line 253. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/setup.mdx new file mode 100644 index 0000000000..8655d52174 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go" +--- +# `Setup` + +## Signature + +```go +func (*SpiderSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/spider.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go) + +Line 90. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..1b66842da0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/supports-multiple-instances.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/spider-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SpiderSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go" +--- +# `SupportsMultipleInstances` + +## Signature + +```go +func (*SpiderSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/spider.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/spider.go) + +Line 83. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-hints.mdx new file mode 100644 index 0000000000..ddb1a6182b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-hints.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go" +--- +# `GetHints` + +## Signature + +```go +func (*SWMLTransferSkill) GetHints() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/swml_transfer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go) + +Line 221. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-instance-key.mdx new file mode 100644 index 0000000000..c8052837d0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-instance-key.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go" +--- +# `GetInstanceKey` + +## Signature + +```go +func (*SWMLTransferSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/builtin/swml_transfer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go) + +Line 38. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..14eb292179 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*SWMLTransferSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/swml_transfer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go) + +Line 305. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..2ac489218f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*SWMLTransferSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/swml_transfer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go) + +Line 247. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/index.mdx new file mode 100644 index 0000000000..7e8ba02fa1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill" +title: "SWMLTransferSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go" +--- +# `SWMLTransferSkill` + +SWMLTransferSkill transfers calls between agents using DataMap pattern matching. + +## Signature + +```go +type SWMLTransferSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/swml_transfer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go) + +Line 12. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/register-tools.mdx new file mode 100644 index 0000000000..79b6617111 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*SWMLTransferSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/swml_transfer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go) + +Line 75. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/setup.mdx new file mode 100644 index 0000000000..c2e94c385f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go" +--- +# `Setup` + +## Signature + +```go +func (*SWMLTransferSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/swml_transfer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go) + +Line 43. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..4d98291210 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/supports-multiple-instances.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/swml-transfer-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.SWMLTransferSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go" +--- +# `SupportsMultipleInstances` + +## Signature + +```go +func (*SWMLTransferSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/swml_transfer.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/swml_transfer.go) + +Line 36. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-hints.mdx new file mode 100644 index 0000000000..cf919c933d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-hints.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go" +--- +# `GetHints` + +## Signature + +```go +func (*WeatherAPISkill) GetHints() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/weather_api.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go) + +Line 217. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..563b8ae9a9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*WeatherAPISkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/weather_api.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go) + +Line 234. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..9debc06886 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*WeatherAPISkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/weather_api.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go) + +Line 221. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/index.mdx new file mode 100644 index 0000000000..86df8e40e9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill" +title: "WeatherAPISkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go" +--- +# `WeatherAPISkill` + +WeatherAPISkill gets current weather from WeatherAPI.com. + +## Signature + +```go +type WeatherAPISkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/weather_api.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go) + +Line 17. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/register-tools.mdx new file mode 100644 index 0000000000..86c72c6c59 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*WeatherAPISkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/weather_api.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go) + +Line 61. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/required-env-vars.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/required-env-vars.mdx new file mode 100644 index 0000000000..77e69504c3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/required-env-vars.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/required-env-vars" +title: "RequiredEnvVars" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill.RequiredEnvVars" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go" +--- +# `RequiredEnvVars` + +## Signature + +```go +func (*WeatherAPISkill) RequiredEnvVars() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/weather_api.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go) + +Line 36. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/setup.mdx new file mode 100644 index 0000000000..9a694bf311 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/weather-api-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WeatherAPISkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go" +--- +# `Setup` + +## Signature + +```go +func (*WeatherAPISkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/weather_api.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/weather_api.go) + +Line 46. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..34dc65dcb5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-global-data" +title: "GetGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill.GetGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go" +--- +# `GetGlobalData` + +GetGlobalData returns global context data signalling that quality-filtered web search is available. Mirrors Python's get\_global\_data return value. + +## Signature + +```go +func (*WebSearchSkill) GetGlobalData() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/skills/builtin/web_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go) + +Line 731. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-instance-key.mdx new file mode 100644 index 0000000000..a830b36708 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-instance-key.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go" +--- +# `GetInstanceKey` + +GetInstanceKey returns a unique key incorporating both searchEngineID and toolName, matching Python's f"\{SKILL\_NAME\}_\{search\_engine\_id\}_\{tool\_name\}" pattern. + +## Signature + +```go +func (*WebSearchSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/builtin/web_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go) + +Line 69. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..9b8ed9e631 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*WebSearchSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/web_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go) + +Line 754. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..4574deb675 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*WebSearchSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/web_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go) + +Line 739. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/index.mdx new file mode 100644 index 0000000000..172e48e75d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill" +title: "WebSearchSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go" +--- +# `WebSearchSkill` + +WebSearchSkill searches the web using Google Custom Search API. + +## Signature + +```go +type WebSearchSkill struct +``` + +## Properties + + + +## Methods + + + + GetGlobalData returns global context data signalling that quality-filtered web search is available. Mirrors Python's get\_global\_data return value. + + + + GetInstanceKey returns a unique key incorporating both searchEngineID and toolName, matching Python's f"\{SKILL\_NAME\}_\{search\_engine\_id\}_\{tool\_name\}" pattern. + + + + + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/web_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go) + +Line 22. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/register-tools.mdx new file mode 100644 index 0000000000..0e9f4f356c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*WebSearchSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/web_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go) + +Line 94. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/required-env-vars.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/required-env-vars.mdx new file mode 100644 index 0000000000..f6e5b162f3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/required-env-vars.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/required-env-vars" +title: "RequiredEnvVars" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill.RequiredEnvVars" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go" +--- +# `RequiredEnvVars` + +## Signature + +```go +func (*WebSearchSkill) RequiredEnvVars() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/builtin/web_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go) + +Line 54. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/setup.mdx new file mode 100644 index 0000000000..150d6b92d2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go" +--- +# `Setup` + +## Signature + +```go +func (*WebSearchSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/web_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go) + +Line 73. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..eac70ab971 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/supports-multiple-instances.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/web-search-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WebSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go" +--- +# `SupportsMultipleInstances` + +## Signature + +```go +func (*WebSearchSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/web_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/web_search.go) + +Line 65. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..fcf31ff9f1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/get-parameter-schema.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WikipediaSearchSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WikipediaSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go" +--- +# `GetParameterSchema` + +## Signature + +```go +func (*WikipediaSearchSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/builtin/wikipedia_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go) + +Line 46. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..4051b89e75 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/get-prompt-sections.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WikipediaSearchSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WikipediaSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go" +--- +# `GetPromptSections` + +## Signature + +```go +func (*WikipediaSearchSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/builtin/wikipedia_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go) + +Line 182. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/index.mdx new file mode 100644 index 0000000000..459a277bd3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill" +title: "WikipediaSearchSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WikipediaSearchSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go" +--- +# `WikipediaSearchSkill` + +WikipediaSearchSkill searches Wikipedia for information. + +## Signature + +```go +type WikipediaSearchSkill struct +``` + +## Properties + + + +## Methods + + + + + + + + + + + +## Source + +[`pkg/skills/builtin/wikipedia_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go) + +Line 17. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/register-tools.mdx new file mode 100644 index 0000000000..3752ce2c7a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WikipediaSearchSkill.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WikipediaSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go" +--- +# `RegisterTools` + +## Signature + +```go +func (*WikipediaSearchSkill) RegisterTools() []skills.ToolRegistration +``` + +## Returns + +`[]skills.ToolRegistration` + +## Source + +[`pkg/skills/builtin/wikipedia_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go) + +Line 65. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/setup.mdx new file mode 100644 index 0000000000..e77383ae4c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin/wikipedia-search-skill/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WikipediaSearchSkill.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills/builtin.WikipediaSearchSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go" +--- +# `Setup` + +## Signature + +```go +func (*WikipediaSearchSkill) Setup() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/builtin/wikipedia_search.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/builtin/wikipedia_search.go) + +Line 35. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/add-skill-directory.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/add-skill-directory.mdx new file mode 100644 index 0000000000..3e5f8e45b2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/add-skill-directory.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/add-skill-directory" +title: "AddSkillDirectory" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.AddSkillDirectory" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go" +--- +# `AddSkillDirectory` + +AddSkillDirectory is a package-level shim that delegates to the shared `globalRegistry.AddSkillDirectory`. It mirrors Python's `signalwire.add_skill_directory` (which delegates to the module singleton `signalwire.skills.registry.skill_registry`). + +The path is validated (must exist and be a directory) and added (de-duplicated) to the global registry's external-paths list. Note that Go compiles to a static binary; dynamic on-disk skill loading is not implemented here, but the path-tracking surface is — so tools that introspect "what external directories has this agent registered?" get the same answer they'd get on the Python side. + +## Signature + +```go +func AddSkillDirectory(path string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/skills/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go) + +Line 135. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/cleanup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/cleanup.mdx new file mode 100644 index 0000000000..6ecfb5085d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/cleanup.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/cleanup" +title: "Cleanup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.Cleanup" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `Cleanup` + +Cleanup is a no-op by default. + +## Signature + +```go +func (*BaseSkill) Cleanup() +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 111. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/description.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/description.mdx new file mode 100644 index 0000000000..24abfd3939 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/description.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/description" +title: "Description" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.Description" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `Description` + +Description returns the skill description. + +## Signature + +```go +func (*BaseSkill) Description() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 70. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-global-data.mdx new file mode 100644 index 0000000000..a1ad57811a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-global-data" +title: "GetGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetGlobalData` + +GetGlobalData returns nil (no global data by default). + +## Signature + +```go +func (*BaseSkill) GetGlobalData() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 90. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-hints.mdx new file mode 100644 index 0000000000..1c01e867df --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetHints` + +GetHints returns nil (no hints by default). + +## Signature + +```go +func (*BaseSkill) GetHints() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 87. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-instance-key.mdx new file mode 100644 index 0000000000..995a4c7b40 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-instance-key.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetInstanceKey` + +GetInstanceKey returns a unique key for tracking this skill instance. When SupportsMultipleInstances() returns true, the key is composed of the skill name and the "tool\_name" parameter (defaulting to the skill name), matching Python's get\_instance\_key() behavior for multi-instance skills. When SupportsMultipleInstances() returns false, returns the skill name. + +## Signature + +```go +func (*BaseSkill) GetInstanceKey() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 118. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-bool.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-bool.mdx new file mode 100644 index 0000000000..406a0dba21 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-bool.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-bool" +title: "GetParamBool" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetParamBool" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetParamBool` + +GetParamBool retrieves a boolean parameter, returning the default if not found. + +## Signature + +```go +func (*BaseSkill) GetParamBool(key string, defaultVal bool) bool +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 262. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-float.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-float.mdx new file mode 100644 index 0000000000..de38e3822c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-float.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-float" +title: "GetParamFloat" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetParamFloat" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetParamFloat` + +GetParamFloat retrieves a float parameter, returning the default if not found. + +## Signature + +```go +func (*BaseSkill) GetParamFloat(key string, defaultVal float64) float64 +``` + +## Parameters + + + + + +## Returns + +`float64` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 241. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-int.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-int.mdx new file mode 100644 index 0000000000..81b6a9347a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-int.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-int" +title: "GetParamInt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetParamInt" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetParamInt` + +GetParamInt retrieves an integer parameter, returning the default if not found. + +## Signature + +```go +func (*BaseSkill) GetParamInt(key string, defaultVal int) int +``` + +## Parameters + + + + + +## Returns + +`int` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 220. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-string.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-string.mdx new file mode 100644 index 0000000000..6ec63b555d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-string.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param-string" +title: "GetParamString" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetParamString" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetParamString` + +GetParamString retrieves a string parameter, returning the default if not found. + +## Signature + +```go +func (*BaseSkill) GetParamString(key string, defaultVal string) string +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 204. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param.mdx new file mode 100644 index 0000000000..593b8a745b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-param" +title: "GetParam" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetParam" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetParam` + +GetParam retrieves a parameter value from the skill's Params map. Returns the value and true if found, or nil and false otherwise. + +## Signature + +```go +func (*BaseSkill) GetParam(key string) (any, bool) +``` + +## Parameters + + + +## Returns + +`(any, bool)` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 195. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..8a0d40870c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-parameter-schema.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetParameterSchema` + +GetParameterSchema returns the common parameters available to all skills. The "tool\_name" parameter is only included when SupportsMultipleInstances() returns true, matching Python's conditional inclusion in get\_parameter\_schema(). + +## Signature + +```go +func (*BaseSkill) GetParameterSchema() map[string]map[string]any +``` + +## Returns + +`map[string]map[string]any` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 129. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..f51c1bf0b4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetPromptSections` + +GetPromptSections returns nil (no prompt sections by default). When skip\_prompt is set to true in Params, returns nil even for concrete overrides — concrete overrides that inject prompt sections MUST call ShouldSkipPrompt() and return nil (or an empty slice) when it is true. + +## Signature + +```go +func (*BaseSkill) GetPromptSections() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 103. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-skill-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-skill-data.mdx new file mode 100644 index 0000000000..4f57734522 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-skill-data.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-skill-data" +title: "GetSkillData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetSkillData" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetSkillData` + +GetSkillData reads this skill instance's namespaced state from rawData. rawData is the raw\_data map passed to SWAIG function handlers, expected to contain a "global\_data" key. Returns an empty map when not found. Mirrors Python's get\_skill\_data(raw\_data). + +## Signature + +```go +func (*BaseSkill) GetSkillData(rawData map[string]any) map[string]any +``` + +## Parameters + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 172. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..c6f22de8a4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-skill-namespace.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/get-skill-namespace" +title: "GetSkillNamespace" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.GetSkillNamespace" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetSkillNamespace` + +GetSkillNamespace returns the namespaced key used to store this skill instance's state in agent global\_data. Uses the "prefix" parameter if set, otherwise falls back to the instance key. Mirrors Python's \_get\_skill\_namespace(). + +Example: a skill named "datasphere" with no prefix returns "skill:datasphere". With prefix "kb" it returns "skill:kb". + +## Signature + +```go +func (*BaseSkill) GetSkillNamespace() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 161. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/index.mdx new file mode 100644 index 0000000000..b3c3fc94bf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/index.mdx @@ -0,0 +1,127 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill" +title: "BaseSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `BaseSkill` + +BaseSkill provides default implementations for the SkillBase interface. Concrete skills should embed this struct and override methods as needed. + +## Signature + +```go +type BaseSkill struct +``` + +## Properties + + + Logger is a named logger for this skill instance. It is initialized automatically when Name() is first called via NewBaseSkill, or can be set explicitly. Mirrors Python SkillBase.logger. + + + + + + + + + + +## Methods + + + + Cleanup is a no-op by default. + + + + Description returns the skill description. + + + + GetGlobalData returns nil (no global data by default). + + + + GetHints returns nil (no hints by default). + + + + GetInstanceKey returns a unique key for tracking this skill instance. When SupportsMultipleInstances() returns true, the key is composed of the skill name and the "tool\_name" parameter (defaulting to the skill name), matching Python's get\_instance\_key() behavior for multi-instance skills. When SupportsMultipleInstances() returns false, returns the skill name. + + + + GetParam retrieves a parameter value from the skill's Params map. Returns the value and true if found, or nil and false otherwise. + + + + GetParamBool retrieves a boolean parameter, returning the default if not found. + + + + GetParameterSchema returns the common parameters available to all skills. The "tool\_name" parameter is only included when SupportsMultipleInstances() returns true, matching Python's conditional inclusion in get\_parameter\_schema(). + + + + GetParamFloat retrieves a float parameter, returning the default if not found. + + + + GetParamInt retrieves an integer parameter, returning the default if not found. + + + + GetParamString retrieves a string parameter, returning the default if not found. + + + + GetPromptSections returns nil (no prompt sections by default). When skip\_prompt is set to true in Params, returns nil even for concrete overrides — concrete overrides that inject prompt sections MUST call ShouldSkipPrompt() and return nil (or an empty slice) when it is true. + + + + GetSkillData reads this skill instance's namespaced state from rawData. rawData is the raw\_data map passed to SWAIG function handlers, expected to contain a "global\_data" key. Returns an empty map when not found. Mirrors Python's get\_skill\_data(raw\_data). + + + + GetSkillNamespace returns the namespaced key used to store this skill instance's state in agent global\_data. Uses the "prefix" parameter if set, otherwise falls back to the instance key. Mirrors Python's \_get\_skill\_namespace(). + + + + Name returns the skill name. + + + + RequiredEnvVars returns nil (no required env vars by default). + + + + ShouldSkipPrompt returns true if the "skip\_prompt" parameter is set to true. Concrete skill overrides of GetPromptSections should call this helper before returning prompt content, mirroring Python's get\_prompt\_sections() guard. + + + + SupportsMultipleInstances returns false by default. + + + + UpdateSkillData writes this skill instance's namespaced state into result's global\_data via result.UpdateGlobalData(). Returns result for method chaining. Mirrors Python's update\_skill\_data(result, data). + + + + Version returns the skill version, defaulting to "1.0.0". + + + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 55. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/name.mdx new file mode 100644 index 0000000000..e5f7c5a11a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/name" +title: "Name" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.Name" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `Name` + +Name returns the skill name. + +## Signature + +```go +func (*BaseSkill) Name() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 67. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/required-env-vars.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/required-env-vars.mdx new file mode 100644 index 0000000000..a7e0822f21 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/required-env-vars.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/required-env-vars" +title: "RequiredEnvVars" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.RequiredEnvVars" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `RequiredEnvVars` + +RequiredEnvVars returns nil (no required env vars by default). + +## Signature + +```go +func (*BaseSkill) RequiredEnvVars() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 81. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/should-skip-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/should-skip-prompt.mdx new file mode 100644 index 0000000000..7b71de0536 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/should-skip-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/should-skip-prompt" +title: "ShouldSkipPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.ShouldSkipPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `ShouldSkipPrompt` + +ShouldSkipPrompt returns true if the "skip\_prompt" parameter is set to true. Concrete skill overrides of GetPromptSections should call this helper before returning prompt content, mirroring Python's get\_prompt\_sections() guard. + +## Signature + +```go +func (*BaseSkill) ShouldSkipPrompt() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 95. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..7b70578215 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/supports-multiple-instances.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `SupportsMultipleInstances` + +SupportsMultipleInstances returns false by default. + +## Signature + +```go +func (*BaseSkill) SupportsMultipleInstances() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 84. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/update-skill-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/update-skill-data.mdx new file mode 100644 index 0000000000..dbb3f8733e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/update-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/update-skill-data" +title: "UpdateSkillData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.UpdateSkillData" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `UpdateSkillData` + +UpdateSkillData writes this skill instance's namespaced state into result's global\_data via result.UpdateGlobalData(). Returns result for method chaining. Mirrors Python's update\_skill\_data(result, data). + +## Signature + +```go +func (*BaseSkill) UpdateSkillData(result *swaig.FunctionResult, data map[string]any) *swaig.FunctionResult +``` + +## Parameters + + + + + +## Returns + +`*swaig.FunctionResult` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 187. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/version.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/version.mdx new file mode 100644 index 0000000000..c00fdae3cd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/version.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/base-skill/version" +title: "Version" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill.Version" + parent: "github.com/signalwire/signalwire-go/pkg/skills.BaseSkill" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `Version` + +Version returns the skill version, defaulting to "1.0.0". + +## Signature + +```go +func (*BaseSkill) Version() string +``` + +## Returns + +`string` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 73. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/get-skill-factory.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/get-skill-factory.mdx new file mode 100644 index 0000000000..8f72262efa --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/get-skill-factory.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/get-skill-factory" +title: "GetSkillFactory" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.GetSkillFactory" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go" +--- +# `GetSkillFactory` + +GetSkillFactory returns the factory function for a registered skill name. Returns nil if the skill is not registered. + +## Signature + +```go +func GetSkillFactory(name string) func(params map[string]any) SkillBase +``` + +## Parameters + + + +## Returns + +`func(params map[string]any) SkillBase` + +## Source + +[`pkg/skills/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go) + +Line 91. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/index.mdx new file mode 100644 index 0000000000..0f75bb404f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/index.mdx @@ -0,0 +1,86 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills" +title: "skills" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go" +--- +# `skills` + +Package skills provides the skills system for SignalWire AI agents. Skills are modular capabilities that can be loaded into agents to provide tools, prompt sections, speech hints, and global data. + +## Signature + +```go +package skills +``` + +## Functions + + + + AddSkillDirectory is a package-level shim that delegates to the shared `globalRegistry.AddSkillDirectory`. It mirrors Python's `signalwire.add_skill_directory` (which delegates to the module singleton `signalwire.skills.registry.skill_registry`). + + + + GetSkillFactory returns the factory function for a registered skill name. Returns nil if the skill is not registered. + + + + ListSkills returns sorted names of all registered skills. + + + + ListSkillsWithParams returns the complete parameter schema for all registered skills. It instantiates each skill with nil params to obtain its GetParameterSchema output. This mirrors Python's skill\_registry.get\_all\_skills\_schema(). The returned map has skill names as keys and their parameter schemas as values. + + + + NewSkillManager creates a new SkillManager. + + + + NewSkillRegistry constructs a new SkillRegistry. The Python reference uses a singleton-per-module (`skill_registry`); Go callers can either construct their own via NewSkillRegistry() or use the global `globalRegistry` accessed through the package-level helpers. + + + + RegisterSkill registers a skill factory function by name. This is typically called from init() functions in builtin skill packages. + + + +## Classes + + + + BaseSkill provides default implementations for the SkillBase interface. Concrete skills should embed this struct and override methods as needed. + + + + SkillManager manages the lifecycle of loaded skill instances. + + + + SkillRegistry is the per-instance Python-parity surface mirroring `signalwire.skills.registry.SkillRegistry`. Each instance owns its own list of external skill directories, validated and de-duplicated on insert. The package-level `RegisterSkill` / `GetSkillFactory` / `ListSkills` functions remain the canonical Go API for static compile-time skill registration; `SkillRegistry` exists so the `add_skill_directory` parity case has a real owning object the audit and downstream callers can hold. + + + + ToolRegistration describes a tool that a skill wants to register with the agent. + + + +## Interfaces + + + + SkillBase defines the interface that all skills must implement. + + + +## Source + +[`pkg/skills/manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/list-skills-with-params.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/list-skills-with-params.mdx new file mode 100644 index 0000000000..370af99e01 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/list-skills-with-params.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/list-skills-with-params" +title: "ListSkillsWithParams" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.ListSkillsWithParams" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go" +--- +# `ListSkillsWithParams` + +ListSkillsWithParams returns the complete parameter schema for all registered skills. It instantiates each skill with nil params to obtain its GetParameterSchema output. This mirrors Python's skill\_registry.get\_all\_skills\_schema(). The returned map has skill names as keys and their parameter schemas as values. + +## Signature + +```go +func ListSkillsWithParams() map[string]map[string]map[string]any +``` + +## Returns + +`map[string]map[string]map[string]any` + +## Source + +[`pkg/skills/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go) + +Line 113. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/list-skills.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/list-skills.mdx new file mode 100644 index 0000000000..4c76a0957f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/list-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/list-skills" +title: "ListSkills" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.ListSkills" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go" +--- +# `ListSkills` + +ListSkills returns sorted names of all registered skills. + +## Signature + +```go +func ListSkills() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go) + +Line 98. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/new-skill-manager.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/new-skill-manager.mdx new file mode 100644 index 0000000000..57664227ac --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/new-skill-manager.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/new-skill-manager" +title: "NewSkillManager" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.NewSkillManager" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go" +--- +# `NewSkillManager` + +NewSkillManager creates a new SkillManager. + +## Signature + +```go +func NewSkillManager() *SkillManager +``` + +## Returns + +`*SkillManager` + +## Source + +[`pkg/skills/manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/new-skill-registry.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/new-skill-registry.mdx new file mode 100644 index 0000000000..b03ee9f950 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/new-skill-registry.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/new-skill-registry" +title: "NewSkillRegistry" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.NewSkillRegistry" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go" +--- +# `NewSkillRegistry` + +NewSkillRegistry constructs a new SkillRegistry. The Python reference uses a singleton-per-module (`skill_registry`); Go callers can either construct their own via NewSkillRegistry() or use the global `globalRegistry` accessed through the package-level helpers. + +## Signature + +```go +func NewSkillRegistry() *SkillRegistry +``` + +## Returns + +`*SkillRegistry` + +## Source + +[`pkg/skills/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go) + +Line 34. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/register-skill.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/register-skill.mdx new file mode 100644 index 0000000000..a27f5ad62b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/register-skill.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/register-skill" +title: "RegisterSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.RegisterSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go" +--- +# `RegisterSkill` + +RegisterSkill registers a skill factory function by name. This is typically called from init() functions in builtin skill packages. + +## Signature + +```go +func RegisterSkill(name string, factory func(params map[string]any) SkillBase) +``` + +## Parameters + + + + + +## Source + +[`pkg/skills/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go) + +Line 83. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/cleanup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/cleanup.mdx new file mode 100644 index 0000000000..349fe71e9a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/cleanup.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/cleanup" +title: "Cleanup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.Cleanup" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `Cleanup` + +Cleanup releases resources when the skill is unloaded. + +## Signature + +```go +Cleanup() +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 35. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/description.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/description.mdx new file mode 100644 index 0000000000..1b5e36d47c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/description.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/description" +title: "Description" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.Description" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `Description` + +Description returns a human-readable description of the skill. + +## Signature + +```go +Description() string +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 16. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-global-data.mdx new file mode 100644 index 0000000000..b3c945688d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-global-data.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-global-data" +title: "GetGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.GetGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetGlobalData` + +GetGlobalData returns data to add to the agent's global context. + +## Signature + +```go +GetGlobalData() map[string]any +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 31. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-hints.mdx new file mode 100644 index 0000000000..0fecc15054 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-hints.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-hints" +title: "GetHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.GetHints" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetHints` + +GetHints returns speech recognition hints for this skill. + +## Signature + +```go +GetHints() []string +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 29. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-instance-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-instance-key.mdx new file mode 100644 index 0000000000..37f468deea --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-instance-key.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-instance-key" +title: "GetInstanceKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.GetInstanceKey" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetInstanceKey` + +GetInstanceKey returns a unique key for tracking this skill instance. + +## Signature + +```go +GetInstanceKey() string +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 37. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-parameter-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-parameter-schema.mdx new file mode 100644 index 0000000000..4f61b96e15 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-parameter-schema.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-parameter-schema" +title: "GetParameterSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.GetParameterSchema" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetParameterSchema` + +GetParameterSchema returns metadata about all parameters the skill accepts. + +## Signature + +```go +GetParameterSchema() map[string]map[string]any +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 39. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-prompt-sections.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-prompt-sections.mdx new file mode 100644 index 0000000000..d9bfdbbce9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-prompt-sections.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/get-prompt-sections" +title: "GetPromptSections" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.GetPromptSections" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `GetPromptSections` + +GetPromptSections returns prompt sections to inject into the agent. + +## Signature + +```go +GetPromptSections() []map[string]any +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 33. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/index.mdx new file mode 100644 index 0000000000..470cbd7f0a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/index.mdx @@ -0,0 +1,85 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base" +title: "SkillBase" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "interface" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `SkillBase` + +SkillBase defines the interface that all skills must implement. + +## Signature + +```go +type SkillBase interface { Name; Description; Version; RequiredEnvVars; SupportsMultipleInstances; Setup; RegisterTools; GetHints; GetGlobalData; GetPromptSections; Cleanup; GetInstanceKey; GetParameterSchema } +``` + +## Methods + + + + Cleanup releases resources when the skill is unloaded. + + + + Description returns a human-readable description of the skill. + + + + GetGlobalData returns data to add to the agent's global context. + + + + GetHints returns speech recognition hints for this skill. + + + + GetInstanceKey returns a unique key for tracking this skill instance. + + + + GetParameterSchema returns metadata about all parameters the skill accepts. + + + + GetPromptSections returns prompt sections to inject into the agent. + + + + Name returns the unique skill identifier. + + + + RegisterTools returns tool registrations for this skill. + + + + RequiredEnvVars returns environment variable names that must be set. + + + + Setup validates configuration and initializes the skill. + + + + SupportsMultipleInstances returns whether multiple instances are allowed. + + + + Version returns the semantic version of the skill. + + + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 12. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/name.mdx new file mode 100644 index 0000000000..249c81feb7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/name.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/name" +title: "Name" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.Name" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `Name` + +Name returns the unique skill identifier. + +## Signature + +```go +Name() string +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 14. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/register-tools.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/register-tools.mdx new file mode 100644 index 0000000000..e66be80a95 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/register-tools.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/register-tools" +title: "RegisterTools" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.RegisterTools" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `RegisterTools` + +RegisterTools returns tool registrations for this skill. + +## Signature + +```go +RegisterTools() []ToolRegistration +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 27. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/required-env-vars.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/required-env-vars.mdx new file mode 100644 index 0000000000..23d4c3bbd4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/required-env-vars.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/required-env-vars" +title: "RequiredEnvVars" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.RequiredEnvVars" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `RequiredEnvVars` + +RequiredEnvVars returns environment variable names that must be set. + +## Signature + +```go +RequiredEnvVars() []string +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 20. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/setup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/setup.mdx new file mode 100644 index 0000000000..2e71ef298a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/setup" +title: "Setup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.Setup" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `Setup` + +Setup validates configuration and initializes the skill. + +Returns true if setup was successful. + +## Signature + +```go +Setup() bool +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 25. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/supports-multiple-instances.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/supports-multiple-instances.mdx new file mode 100644 index 0000000000..074529d0d9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/supports-multiple-instances.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/supports-multiple-instances" +title: "SupportsMultipleInstances" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.SupportsMultipleInstances" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `SupportsMultipleInstances` + +SupportsMultipleInstances returns whether multiple instances are allowed. + +## Signature + +```go +SupportsMultipleInstances() bool +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 22. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/version.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/version.mdx new file mode 100644 index 0000000000..47e9151ce0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/version.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-base/version" +title: "Version" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase.Version" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillBase" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `Version` + +Version returns the semantic version of the skill. + +## Signature + +```go +Version() string +``` + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 18. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/get-skill.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/get-skill.mdx new file mode 100644 index 0000000000..eee9fbd637 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/get-skill.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/get-skill" +title: "GetSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillManager.GetSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillManager" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go" +--- +# `GetSkill` + +GetSkill returns the skill with the given instance key, or nil if not found. + +## Signature + +```go +func (*SkillManager) GetSkill(key string) SkillBase +``` + +## Parameters + + + +## Returns + +`SkillBase` + +## Source + +[`pkg/skills/manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go) + +Line 98. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/has-skill.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/has-skill.mdx new file mode 100644 index 0000000000..e4847aa08b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/has-skill.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/has-skill" +title: "HasSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillManager.HasSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillManager" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go" +--- +# `HasSkill` + +HasSkill returns true if a skill with the given instance key is loaded. + +## Signature + +```go +func (*SkillManager) HasSkill(key string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/skills/manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go) + +Line 90. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/index.mdx new file mode 100644 index 0000000000..41a18c93ac --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager" +title: "SkillManager" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillManager" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go" +--- +# `SkillManager` + +SkillManager manages the lifecycle of loaded skill instances. + +## Signature + +```go +type SkillManager struct +``` + +## Methods + + + + GetSkill returns the skill with the given instance key, or nil if not found. + + + + HasSkill returns true if a skill with the given instance key is loaded. + + + + ListLoadedSkills returns the instance keys of all loaded skills. + + + + LoadSkill validates environment variables, calls Setup, and registers the skill. Returns (success bool, errorMessage string). + + + + UnloadSkill removes a skill by its instance key. Returns true if found and removed. + + + +## Source + +[`pkg/skills/manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go) + +Line 10. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/list-loaded-skills.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/list-loaded-skills.mdx new file mode 100644 index 0000000000..ff9821c553 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/list-loaded-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/list-loaded-skills" +title: "ListLoadedSkills" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillManager.ListLoadedSkills" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillManager" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go" +--- +# `ListLoadedSkills` + +ListLoadedSkills returns the instance keys of all loaded skills. + +## Signature + +```go +func (*SkillManager) ListLoadedSkills() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go) + +Line 78. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/load-skill.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/load-skill.mdx new file mode 100644 index 0000000000..e4959a1688 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/load-skill.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/load-skill" +title: "LoadSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillManager.LoadSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillManager" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go" +--- +# `LoadSkill` + +LoadSkill validates environment variables, calls Setup, and registers the skill. Returns (success bool, errorMessage string). + +When a skill with the same instance key is already loaded, the behavior depends on SupportsMultipleInstances(): + +- false (default): returns (false, error) — duplicate is an error. +- true: returns (true, "") — duplicate instance is silently accepted, matching Python's SkillManager.load\_skill() warning-and-continue behavior. + +## Signature + +```go +func (*SkillManager) LoadSkill(skill SkillBase) (bool, string) +``` + +## Parameters + + + +## Returns + +`(bool, string)` + +## Source + +[`pkg/skills/manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go) + +Line 30. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/unload-skill.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/unload-skill.mdx new file mode 100644 index 0000000000..57f1d94214 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/unload-skill.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-manager/unload-skill" +title: "UnloadSkill" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillManager.UnloadSkill" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillManager" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go" +--- +# `UnloadSkill` + +UnloadSkill removes a skill by its instance key. Returns true if found and removed. + +## Signature + +```go +func (*SkillManager) UnloadSkill(key string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/skills/manager.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/manager.go) + +Line 63. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry/add-skill-directory.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry/add-skill-directory.mdx new file mode 100644 index 0000000000..7bab5bdec9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry/add-skill-directory.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry/add-skill-directory" +title: "AddSkillDirectory" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillRegistry.AddSkillDirectory" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillRegistry" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go" +--- +# `AddSkillDirectory` + +AddSkillDirectory adds a directory to search for skills. Mirrors Python's `SkillRegistry.add_skill_directory`: validates that the path exists and is a directory, then appends it (de-duplicated) to the registry's external paths list. Returns an error (the Go analog of Python's `ValueError`) for non-existent paths or non-directories. + +## Signature + +```go +func (*SkillRegistry) AddSkillDirectory(path string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/skills/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go) + +Line 49. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry/external-paths.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry/external-paths.mdx new file mode 100644 index 0000000000..89ea5ff8dd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry/external-paths.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry/external-paths" +title: "ExternalPaths" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillRegistry.ExternalPaths" + parent: "github.com/signalwire/signalwire-go/pkg/skills.SkillRegistry" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go" +--- +# `ExternalPaths` + +ExternalPaths returns a copy of the registered external skill directories. Parity surface for Python's `_external_paths`. + +## Signature + +```go +func (*SkillRegistry) ExternalPaths() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/skills/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go) + +Line 73. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry/index.mdx new file mode 100644 index 0000000000..26f1d0085e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/skill-registry" +title: "SkillRegistry" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.SkillRegistry" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go" +--- +# `SkillRegistry` + +SkillRegistry is the per-instance Python-parity surface mirroring `signalwire.skills.registry.SkillRegistry`. Each instance owns its own list of external skill directories, validated and de-duplicated on insert. The package-level `RegisterSkill` / `GetSkillFactory` / `ListSkills` functions remain the canonical Go API for static compile-time skill registration; `SkillRegistry` exists so the `add_skill_directory` parity case has a real owning object the audit and downstream callers can hold. + +## Signature + +```go +type SkillRegistry struct +``` + +## Methods + + + + AddSkillDirectory adds a directory to search for skills. Mirrors Python's `SkillRegistry.add_skill_directory`: validates that the path exists and is a directory, then appends it (de-duplicated) to the registry's external paths list. Returns an error (the Go analog of Python's `ValueError`) for non-existent paths or non-directories. + + + + ExternalPaths returns a copy of the registered external skill directories. Parity surface for Python's `_external_paths`. + + + +## Source + +[`pkg/skills/registry.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/registry.go) + +Line 25. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/tool-registration/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/tool-registration/index.mdx new file mode 100644 index 0000000000..c945235c57 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/tool-registration/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills/tool-registration" +title: "ToolRegistration" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/skills.ToolRegistration" + parent: "github.com/signalwire/signalwire-go/pkg/skills" + module: "github.com.signalwire.signalwire-go.pkg.skills" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go" +--- +# `ToolRegistration` + +ToolRegistration describes a tool that a skill wants to register with the agent. + +## Signature + +```go +type ToolRegistration struct +``` + +## Properties + + + + + + + + + + + + + + + +## Source + +[`pkg/skills/skill_base.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/skills/skill_base.go) + +Line 43. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-action.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-action.mdx new file mode 100644 index 0000000000..8575d090dd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-action.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-action" +title: "CreatePaymentAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.CreatePaymentAction" + parent: "github.com/signalwire/signalwire-go/pkg/swaig" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `CreatePaymentAction` + +CreatePaymentAction creates a single payment action entry. + +## Signature + +```go +func CreatePaymentAction(actionType string, phrase string) map[string]string +``` + +## Parameters + + + + + +## Returns + +`map[string]string` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 957. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-parameter.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-parameter.mdx new file mode 100644 index 0000000000..c5b3c5af99 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-parameter.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-parameter" +title: "CreatePaymentParameter" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.CreatePaymentParameter" + parent: "github.com/signalwire/signalwire-go/pkg/swaig" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `CreatePaymentParameter` + +CreatePaymentParameter creates a payment parameter entry. + +## Signature + +```go +func CreatePaymentParameter(name string, value string) map[string]string +``` + +## Parameters + + + + + +## Returns + +`map[string]string` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 965. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-prompt.mdx new file mode 100644 index 0000000000..4fe90684f5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-prompt.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/create-payment-prompt" +title: "CreatePaymentPrompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.CreatePaymentPrompt" + parent: "github.com/signalwire/signalwire-go/pkg/swaig" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `CreatePaymentPrompt` + +CreatePaymentPrompt creates a payment prompt configuration. cardType and errorType are optional; pass empty strings to omit them. This matches the Python SDK's create\_payment\_prompt() static method signature. + +## Signature + +```go +func CreatePaymentPrompt( + forSituation string, + actions []map[string]string, + cardType string, + errorType string +) map[string]any +``` + +## Parameters + + + + + + + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 942. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/actions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/actions.mdx new file mode 100644 index 0000000000..7e19ab2e6f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/actions.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/actions" +title: "Actions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.Actions" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `Actions` + +Actions returns the list of actions added to this result. + +## Signature + +```go +func (*FunctionResult) Actions() []map[string]any +``` + +## Returns + +`[]map[string]any` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 39. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-action.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-action.mdx new file mode 100644 index 0000000000..eea5f2f00e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-action.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-action" +title: "AddAction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.AddAction" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `AddAction` + +AddAction appends a single named action to the result. + +## Signature + +```go +func (*FunctionResult) AddAction(name string, data any) *FunctionResult +``` + +## Parameters + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 63. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-actions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-actions.mdx new file mode 100644 index 0000000000..3163be832b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-actions.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-actions" +title: "AddActions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.AddActions" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `AddActions` + +AddActions appends multiple actions to the result. + +## Signature + +```go +func (*FunctionResult) AddActions(actions []map[string]any) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 69. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-dynamic-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-dynamic-hints.mdx new file mode 100644 index 0000000000..25fb0863e0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-dynamic-hints.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/add-dynamic-hints" +title: "AddDynamicHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.AddDynamicHints" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `AddDynamicHints` + +AddDynamicHints adds dynamic speech recognition hints during a call. + +## Signature + +```go +func (*FunctionResult) AddDynamicHints(hints []any) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 401. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/clear-dynamic-hints.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/clear-dynamic-hints.mdx new file mode 100644 index 0000000000..59a1408fc3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/clear-dynamic-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/clear-dynamic-hints" +title: "ClearDynamicHints" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.ClearDynamicHints" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `ClearDynamicHints` + +ClearDynamicHints removes all dynamic speech recognition hints. + +## Signature + +```go +func (*FunctionResult) ClearDynamicHints() *FunctionResult +``` + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 406. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/connect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/connect.mdx new file mode 100644 index 0000000000..1ab610f41b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/connect.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/connect" +title: "Connect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.Connect" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `Connect` + +Connect adds a connect action to transfer/connect the call to another destination. If final is true, the call permanently transfers (exits the agent). If final is false, the call returns to the agent when the far end hangs up. The from parameter sets the caller ID; pass empty string to use the call's default. + +## Signature + +```go +func (*FunctionResult) Connect(destination string, final bool, from string) *FunctionResult +``` + +## Parameters + + + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 96. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/enable-extensive-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/enable-extensive-data.mdx new file mode 100644 index 0000000000..ede4842635 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/enable-extensive-data.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/enable-extensive-data" +title: "EnableExtensiveData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.EnableExtensiveData" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `EnableExtensiveData` + +EnableExtensiveData sends full data to LLM for this turn only. + +## Signature + +```go +func (*FunctionResult) EnableExtensiveData(enabled bool) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 433. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/enable-functions-on-timeout.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/enable-functions-on-timeout.mdx new file mode 100644 index 0000000000..f7714ce026 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/enable-functions-on-timeout.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/enable-functions-on-timeout" +title: "EnableFunctionsOnTimeout" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.EnableFunctionsOnTimeout" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `EnableFunctionsOnTimeout` + +EnableFunctionsOnTimeout enables or disables function calls on speaker timeout. + +## Signature + +```go +func (*FunctionResult) EnableFunctionsOnTimeout(enabled bool) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 428. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/execute-rpc.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/execute-rpc.mdx new file mode 100644 index 0000000000..f2a18a57c5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/execute-rpc.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/execute-rpc" +title: "ExecuteRpc" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.ExecuteRpc" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `ExecuteRpc` + +ExecuteRpc executes an RPC method on a call. Pass empty strings for callID and nodeID to omit them from the payload. + +## Signature + +```go +func (*FunctionResult) ExecuteRpc(method string, params map[string]any, callID string, nodeID string) *FunctionResult +``` + +## Parameters + + + + + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 865. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/execute-swml.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/execute-swml.mdx new file mode 100644 index 0000000000..5ab514c082 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/execute-swml.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/execute-swml" +title: "ExecuteSwml" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.ExecuteSwml" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `ExecuteSwml` + +ExecuteSwml executes SWML content. If transfer is true, the call exits the agent after execution. swmlContent can be a map\[string]any or a string (raw SWML JSON). + +## Signature + +```go +func (*FunctionResult) ExecuteSwml(swmlContent any, transfer bool) *FunctionResult +``` + +## Parameters + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 446. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/hangup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/hangup.mdx new file mode 100644 index 0000000000..9b83b131cf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/hangup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/hangup" +title: "Hangup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.Hangup" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `Hangup` + +Hangup terminates the call. + +## Signature + +```go +func (*FunctionResult) Hangup() *FunctionResult +``` + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 138. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/hold.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/hold.mdx new file mode 100644 index 0000000000..1a96eb1108 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/hold.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/hold" +title: "Hold" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.Hold" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `Hold` + +Hold puts the call on hold with the given timeout in seconds. Timeout is clamped to the range \[0, 900]. + +## Signature + +```go +func (*FunctionResult) Hold(timeout int) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 144. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/index.mdx new file mode 100644 index 0000000000..8314298aec --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/index.mdx @@ -0,0 +1,241 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result" +title: "FunctionResult" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + parent: "github.com/signalwire/signalwire-go/pkg/swaig" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `FunctionResult` + +FunctionResult represents the response from a SWAIG tool handler. It contains a text response, optional actions, and post-processing control. All mutating methods return \*FunctionResult for method chaining. + +## Signature + +```go +type FunctionResult struct +``` + +## Methods + + + + Actions returns the list of actions added to this result. + + + + AddAction appends a single named action to the result. + + + + AddActions appends multiple actions to the result. + + + + AddDynamicHints adds dynamic speech recognition hints during a call. + + + + ClearDynamicHints removes all dynamic speech recognition hints. + + + + Connect adds a connect action to transfer/connect the call to another destination. If final is true, the call permanently transfers (exits the agent). If final is false, the call returns to the agent when the far end hangs up. The from parameter sets the caller ID; pass empty string to use the call's default. + + + + EnableExtensiveData sends full data to LLM for this turn only. + + + + EnableFunctionsOnTimeout enables or disables function calls on speaker timeout. + + + + ExecuteRpc executes an RPC method on a call. Pass empty strings for callID and nodeID to omit them from the payload. + + + + ExecuteSwml executes SWML content. If transfer is true, the call exits the agent after execution. swmlContent can be a map\[string]any or a string (raw SWML JSON). + + + + Hangup terminates the call. + + + + Hold puts the call on hold with the given timeout in seconds. Timeout is clamped to the range \[0, 900]. + + + + JoinConference joins an ad-hoc audio conference. Pass nil for opts to use default behavior (muted=false, beep="true", no holdAudio). + + + + JoinRoom joins a RELAY room for multi-party communication. + + + + Pay processes a payment using SWML pay action. connectorURL is the only required parameter. opts may be nil to use Python SDK defaults for all optional parameters. + + + + PlayBackgroundFile plays an audio or video file in the background. If wait is true, attention-getting behavior is suppressed during playback. + + + + PostProcess returns whether post-processing is enabled. + + + + RecordCall starts background call recording using SWML. controlID, stereo, format, and direction are the primary parameters. Use opts to specify additional optional parameters (pass nil to use defaults). + + + + RemoveGlobalData removes global agent data variables by key slice. + + + + RemoveGlobalDataKey removes a single global agent data variable by key. This matches the Python SDK's Union\[str, List\[str]] behavior for a bare string argument, which emits the key as a string (not a one-element array) in the action payload. + + + + RemoveMetadata removes metadata keys from the current function's scope. + + + + RemoveMetadataKey removes a single metadata key from the current function's scope. This matches the Python SDK's Union\[str, List\[str]] behavior for a bare string argument, which emits the key as a string (not a one-element array) in the action payload. + + + + ReplaceInHistory replaces the tool call and result pair in conversation history. If text is a string, the tool call is replaced with an assistant message containing that text. If text is a bool and true, the pair is removed from history entirely. + + + + Response returns the natural language response text. + + + + RpcAiMessage injects a message into an AI agent on another call. role defaults to "system" when empty, matching the Python SDK default. This matches the Python SDK's rpc\_ai\_message() which calls execute\_rpc(method="ai\_message", ...). + + + + RpcAiUnhold unholds another call. This matches the Python SDK's rpc\_ai\_unhold() which calls execute\_rpc(method="ai\_unhold", ...). + + + + RpcDial dials out to a number with a destination SWML URL using execute\_rpc. deviceType defaults to "phone" when empty. This matches the Python SDK's rpc\_dial() which calls execute\_rpc(method="dial", ...). + + + + Say makes the agent speak specific text. + + + + SendSms sends a text message to a PSTN phone number. Pass empty string for body if only sending media, nil for optional slices, and empty string for region to omit it. + + + + SetEndOfSpeechTimeout adjusts the end-of-speech timeout in milliseconds. + + + + SetMetadata sets metadata scoped to the current function's meta\_data\_token. + + + + SetPostProcess controls whether the AI takes another turn before executing actions. + + + + SetResponse sets the natural language response text. + + + + SetSpeechEventTimeout adjusts the speech event timeout in milliseconds. + + + + SimulateUserInput queues simulated user input text. Emits action key "user\_input" matching the Python SDK's add\_action("user\_input", text). + + + + SipRefer sends a SIP REFER for call transfer in SIP environments. + + + + Stop stops the agent execution. + + + + StopBackgroundFile stops the currently playing background file. + + + + StopRecordCall stops an active background call recording. + + + + StopTap stops an active tap stream. + + + + String returns a human-readable representation including the response and action count. + + + + SwitchContext changes the agent context/prompt during conversation. Only non-empty/true fields are included in the action. + + + + SwmlChangeContext transitions to a different conversation context. Emits action key "change\_context" with the context name as a plain string value, matching the Python SDK's add\_action("change\_context", context\_name). + + + + SwmlChangeStep transitions to a different conversation step. Emits action key "change\_step" with the step name as a plain string value, matching the Python SDK's add\_action("change\_step", step\_name). + + + + SwmlTransfer adds a SWML transfer action with an AI response for when control returns. + + + + SwmlUserEvent sends a user event through SWML for real-time UI updates. + + + + Tap starts background call tapping, streaming media to the given URI. rtpPtime sets the packetization time in milliseconds for RTP streams (0 = use default of 20ms). Pass empty string for statusURL to omit it. + + + + ToggleFunctions enables or disables specific SWAIG functions. Each toggle should have "function" and "active" keys. + + + + ToMap serializes the FunctionResult to a map suitable for JSON encoding. The "action" key is only included if there are actions. The "post\_process" key is only included if true. + + + + UpdateGlobalData sets or updates global agent data variables. + + + + UpdateSettings updates agent runtime settings such as temperature, top\_p, etc. + + + + WaitForUser controls how the agent waits for user input. Pass nil for enabled/timeout to omit those fields. If answerFirst is true, the value is set to "answer\_first" regardless of other parameters. + + + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 17. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/join-conference.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/join-conference.mdx new file mode 100644 index 0000000000..b184ea88c6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/join-conference.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/join-conference" +title: "JoinConference" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.JoinConference" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `JoinConference` + +JoinConference joins an ad-hoc audio conference. Pass nil for opts to use default behavior (muted=false, beep="true", no holdAudio). + +## Signature + +```go +func (*FunctionResult) JoinConference(name string, opts *JoinConferenceOptions) *FunctionResult +``` + +## Parameters + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 510. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/join-room.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/join-room.mdx new file mode 100644 index 0000000000..63c1a89a69 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/join-room.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/join-room" +title: "JoinRoom" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.JoinRoom" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `JoinRoom` + +JoinRoom joins a RELAY room for multi-party communication. + +## Signature + +```go +func (*FunctionResult) JoinRoom(name string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 580. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/pay.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/pay.mdx new file mode 100644 index 0000000000..2759f3df27 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/pay.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/pay" +title: "Pay" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.Pay" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `Pay` + +Pay processes a payment using SWML pay action. connectorURL is the only required parameter. opts may be nil to use Python SDK defaults for all optional parameters. + +## Signature + +```go +func (*FunctionResult) Pay(connectorURL string, opts *PayOptions) *FunctionResult +``` + +## Parameters + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 735. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/play-background-file.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/play-background-file.mdx new file mode 100644 index 0000000000..320e768653 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/play-background-file.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/play-background-file" +title: "PlayBackgroundFile" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.PlayBackgroundFile" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `PlayBackgroundFile` + +PlayBackgroundFile plays an audio or video file in the background. If wait is true, attention-getting behavior is suppressed during playback. + +## Signature + +```go +func (*FunctionResult) PlayBackgroundFile(filename string, wait bool) *FunctionResult +``` + +## Parameters + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 293. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/post-process.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/post-process.mdx new file mode 100644 index 0000000000..bf6009ba7e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/post-process.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/post-process" +title: "PostProcess" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.PostProcess" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `PostProcess` + +PostProcess returns whether post-processing is enabled. + +## Signature + +```go +func (*FunctionResult) PostProcess() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 44. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/record-call.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/record-call.mdx new file mode 100644 index 0000000000..1f27e19e6f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/record-call.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/record-call" +title: "RecordCall" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.RecordCall" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `RecordCall` + +RecordCall starts background call recording using SWML. controlID, stereo, format, and direction are the primary parameters. Use opts to specify additional optional parameters (pass nil to use defaults). + +## Signature + +```go +func (*FunctionResult) RecordCall( + controlID string, + stereo bool, + format string, + direction string, + opts *RecordCallOptions +) *FunctionResult +``` + +## Parameters + + + + + + + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 335. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-global-data-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-global-data-key.mdx new file mode 100644 index 0000000000..3404863a47 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-global-data-key.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-global-data-key" +title: "RemoveGlobalDataKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.RemoveGlobalDataKey" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `RemoveGlobalDataKey` + +RemoveGlobalDataKey removes a single global agent data variable by key. This matches the Python SDK's Union\[str, List\[str]] behavior for a bare string argument, which emits the key as a string (not a one-element array) in the action payload. + +## Signature + +```go +func (*FunctionResult) RemoveGlobalDataKey(key string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 190. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-global-data.mdx new file mode 100644 index 0000000000..ed6c8b2b3a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-global-data.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-global-data" +title: "RemoveGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.RemoveGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `RemoveGlobalData` + +RemoveGlobalData removes global agent data variables by key slice. + +## Signature + +```go +func (*FunctionResult) RemoveGlobalData(keys []string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 183. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-metadata-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-metadata-key.mdx new file mode 100644 index 0000000000..9b21e19072 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-metadata-key.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-metadata-key" +title: "RemoveMetadataKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.RemoveMetadataKey" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `RemoveMetadataKey` + +RemoveMetadataKey removes a single metadata key from the current function's scope. This matches the Python SDK's Union\[str, List\[str]] behavior for a bare string argument, which emits the key as a string (not a one-element array) in the action payload. + +## Signature + +```go +func (*FunctionResult) RemoveMetadataKey(key string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 207. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-metadata.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-metadata.mdx new file mode 100644 index 0000000000..ecb13fe1a3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-metadata.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/remove-metadata" +title: "RemoveMetadata" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.RemoveMetadata" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `RemoveMetadata` + +RemoveMetadata removes metadata keys from the current function's scope. + +## Signature + +```go +func (*FunctionResult) RemoveMetadata(keys []string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 200. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/replace-in-history.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/replace-in-history.mdx new file mode 100644 index 0000000000..77e97df6c2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/replace-in-history.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/replace-in-history" +title: "ReplaceInHistory" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.ReplaceInHistory" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `ReplaceInHistory` + +ReplaceInHistory replaces the tool call and result pair in conversation history. If text is a string, the tool call is replaced with an assistant message containing that text. If text is a bool and true, the pair is removed from history entirely. + +## Signature + +```go +func (*FunctionResult) ReplaceInHistory(text any) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 272. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/response.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/response.mdx new file mode 100644 index 0000000000..74bfc6e3a4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/response.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/response" +title: "Response" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.Response" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `Response` + +Response returns the natural language response text. + +## Signature + +```go +func (*FunctionResult) Response() string +``` + +## Returns + +`string` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 34. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-ai-message.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-ai-message.mdx new file mode 100644 index 0000000000..91b563e3b2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-ai-message.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-ai-message" +title: "RpcAiMessage" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.RpcAiMessage" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `RpcAiMessage` + +RpcAiMessage injects a message into an AI agent on another call. role defaults to "system" when empty, matching the Python SDK default. This matches the Python SDK's rpc\_ai\_message() which calls execute\_rpc(method="ai\_message", ...). + +## Signature + +```go +func (*FunctionResult) RpcAiMessage(callID string, messageText string, role string) *FunctionResult +``` + +## Parameters + + + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 915. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-ai-unhold.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-ai-unhold.mdx new file mode 100644 index 0000000000..ab52d4be46 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-ai-unhold.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-ai-unhold" +title: "RpcAiUnhold" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.RpcAiUnhold" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `RpcAiUnhold` + +RpcAiUnhold unholds another call. This matches the Python SDK's rpc\_ai\_unhold() which calls execute\_rpc(method="ai\_unhold", ...). + +## Signature + +```go +func (*FunctionResult) RpcAiUnhold(callID string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 927. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-dial.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-dial.mdx new file mode 100644 index 0000000000..d8d09f5b58 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-dial.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/rpc-dial" +title: "RpcDial" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.RpcDial" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `RpcDial` + +RpcDial dials out to a number with a destination SWML URL using execute\_rpc. deviceType defaults to "phone" when empty. This matches the Python SDK's rpc\_dial() which calls execute\_rpc(method="dial", ...). + +## Signature + +```go +func (*FunctionResult) RpcDial(toNumber string, fromNumber string, destSwml string, deviceType string) *FunctionResult +``` + +## Parameters + + + + + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 894. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/say.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/say.mdx new file mode 100644 index 0000000000..fb10d6875f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/say.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/say" +title: "Say" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.Say" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `Say` + +Say makes the agent speak specific text. + +## Signature + +```go +func (*FunctionResult) Say(text string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 287. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/send-sms.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/send-sms.mdx new file mode 100644 index 0000000000..63bcb6d78d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/send-sms.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/send-sms" +title: "SendSms" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SendSms" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SendSms` + +SendSms sends a text message to a PSTN phone number. Pass empty string for body if only sending media, nil for optional slices, and empty string for region to omit it. + +## Signature + +```go +func (*FunctionResult) SendSms( + toNumber string, + fromNumber string, + body string, + media []string, + tags []string, + region string +) *FunctionResult +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 658. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-end-of-speech-timeout.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-end-of-speech-timeout.mdx new file mode 100644 index 0000000000..3c374d89d2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-end-of-speech-timeout.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-end-of-speech-timeout" +title: "SetEndOfSpeechTimeout" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SetEndOfSpeechTimeout" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SetEndOfSpeechTimeout` + +SetEndOfSpeechTimeout adjusts the end-of-speech timeout in milliseconds. + +## Signature + +```go +func (*FunctionResult) SetEndOfSpeechTimeout(ms int) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 412. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-metadata.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-metadata.mdx new file mode 100644 index 0000000000..4736da8f43 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-metadata.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-metadata" +title: "SetMetadata" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SetMetadata" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SetMetadata` + +SetMetadata sets metadata scoped to the current function's meta\_data\_token. + +## Signature + +```go +func (*FunctionResult) SetMetadata(data map[string]any) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 195. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-post-process.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-post-process.mdx new file mode 100644 index 0000000000..ea8575af7d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-post-process.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-post-process" +title: "SetPostProcess" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SetPostProcess" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SetPostProcess` + +SetPostProcess controls whether the AI takes another turn before executing actions. + +## Signature + +```go +func (*FunctionResult) SetPostProcess(postProcess bool) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 57. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-response.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-response.mdx new file mode 100644 index 0000000000..15b6e8a646 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-response.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-response" +title: "SetResponse" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SetResponse" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SetResponse` + +SetResponse sets the natural language response text. + +## Signature + +```go +func (*FunctionResult) SetResponse(response string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 51. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-speech-event-timeout.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-speech-event-timeout.mdx new file mode 100644 index 0000000000..02b9e7069c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-speech-event-timeout.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/set-speech-event-timeout" +title: "SetSpeechEventTimeout" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SetSpeechEventTimeout" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SetSpeechEventTimeout` + +SetSpeechEventTimeout adjusts the speech event timeout in milliseconds. + +## Signature + +```go +func (*FunctionResult) SetSpeechEventTimeout(ms int) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 417. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/simulate-user-input.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/simulate-user-input.mdx new file mode 100644 index 0000000000..16b802f247 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/simulate-user-input.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/simulate-user-input" +title: "SimulateUserInput" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SimulateUserInput" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SimulateUserInput` + +SimulateUserInput queues simulated user input text. Emits action key "user\_input" matching the Python SDK's add\_action("user\_input", text). + +## Signature + +```go +func (*FunctionResult) SimulateUserInput(text string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 933. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/sip-refer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/sip-refer.mdx new file mode 100644 index 0000000000..8d1f960633 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/sip-refer.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/sip-refer" +title: "SipRefer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SipRefer" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SipRefer` + +SipRefer sends a SIP REFER for call transfer in SIP environments. + +## Signature + +```go +func (*FunctionResult) SipRefer(toURI string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 593. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-background-file.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-background-file.mdx new file mode 100644 index 0000000000..a11607ff01 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-background-file.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-background-file" +title: "StopBackgroundFile" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.StopBackgroundFile" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `StopBackgroundFile` + +StopBackgroundFile stops the currently playing background file. + +## Signature + +```go +func (*FunctionResult) StopBackgroundFile() *FunctionResult +``` + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 301. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-record-call.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-record-call.mdx new file mode 100644 index 0000000000..0ce8d75b48 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-record-call.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-record-call" +title: "StopRecordCall" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.StopRecordCall" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `StopRecordCall` + +StopRecordCall stops an active background call recording. + +## Signature + +```go +func (*FunctionResult) StopRecordCall(controlID string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 381. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-tap.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-tap.mdx new file mode 100644 index 0000000000..1a27bedc5c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-tap.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop-tap" +title: "StopTap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.StopTap" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `StopTap` + +StopTap stops an active tap stream. + +## Signature + +```go +func (*FunctionResult) StopTap(controlID string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 638. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop.mdx new file mode 100644 index 0000000000..2a22871a1f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `Stop` + +Stop stops the agent execution. + +## Signature + +```go +func (*FunctionResult) Stop() *FunctionResult +``` + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 171. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/string.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/string.mdx new file mode 100644 index 0000000000..5ec02e3b06 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/string.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/string" +title: "String" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.String" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `String` + +String returns a human-readable representation including the response and action count. + +## Signature + +```go +func (*FunctionResult) String() string +``` + +## Returns + +`string` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 973. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/switch-context.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/switch-context.mdx new file mode 100644 index 0000000000..98910e2145 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/switch-context.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/switch-context" +title: "SwitchContext" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SwitchContext" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SwitchContext` + +SwitchContext changes the agent context/prompt during conversation. Only non-empty/true fields are included in the action. + +## Signature + +```go +func (*FunctionResult) SwitchContext( + systemPrompt string, + userPrompt string, + consolidate bool, + fullReset bool, + isolated bool +) *FunctionResult +``` + +## Parameters + + + + + + + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 244. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-change-context.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-change-context.mdx new file mode 100644 index 0000000000..edf574011c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-change-context.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-change-context" +title: "SwmlChangeContext" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SwmlChangeContext" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SwmlChangeContext` + +SwmlChangeContext transitions to a different conversation context. Emits action key "change\_context" with the context name as a plain string value, matching the Python SDK's add\_action("change\_context", context\_name). + +## Signature + +```go +func (*FunctionResult) SwmlChangeContext(contextName string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 238. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-change-step.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-change-step.mdx new file mode 100644 index 0000000000..93b1af9ceb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-change-step.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-change-step" +title: "SwmlChangeStep" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SwmlChangeStep" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SwmlChangeStep` + +SwmlChangeStep transitions to a different conversation step. Emits action key "change\_step" with the step name as a plain string value, matching the Python SDK's add\_action("change\_step", step\_name). + +## Signature + +```go +func (*FunctionResult) SwmlChangeStep(stepName string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 231. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-transfer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-transfer.mdx new file mode 100644 index 0000000000..e251021036 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-transfer.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-transfer" +title: "SwmlTransfer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SwmlTransfer" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SwmlTransfer` + +SwmlTransfer adds a SWML transfer action with an AI response for when control returns. + +## Signature + +```go +func (*FunctionResult) SwmlTransfer(dest string, aiResponse string, final bool) *FunctionResult +``` + +## Parameters + + + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 119. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-user-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-user-event.mdx new file mode 100644 index 0000000000..ac8db9d1de --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-user-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/swml-user-event" +title: "SwmlUserEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.SwmlUserEvent" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `SwmlUserEvent` + +SwmlUserEvent sends a user event through SWML for real-time UI updates. + +## Signature + +```go +func (*FunctionResult) SwmlUserEvent(eventData map[string]any) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 212. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/tap.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/tap.mdx new file mode 100644 index 0000000000..631dcac321 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/tap.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/tap" +title: "Tap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.Tap" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `Tap` + +Tap starts background call tapping, streaming media to the given URI. rtpPtime sets the packetization time in milliseconds for RTP streams (0 = use default of 20ms). Pass empty string for statusURL to omit it. + +## Signature + +```go +func (*FunctionResult) Tap( + uri string, + controlID string, + direction string, + codec string, + rtpPtime int, + statusURL string +) *FunctionResult +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 608. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/to-map.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/to-map.mdx new file mode 100644 index 0000000000..cbf921824a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/to-map.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/to-map" +title: "ToMap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.ToMap" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `ToMap` + +ToMap serializes the FunctionResult to a map suitable for JSON encoding. The "action" key is only included if there are actions. The "post\_process" key is only included if true. + +## Signature + +```go +func (*FunctionResult) ToMap() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 77. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/toggle-functions.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/toggle-functions.mdx new file mode 100644 index 0000000000..7280d1150d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/toggle-functions.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/toggle-functions" +title: "ToggleFunctions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.ToggleFunctions" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `ToggleFunctions` + +ToggleFunctions enables or disables specific SWAIG functions. Each toggle should have "function" and "active" keys. + +## Signature + +```go +func (*FunctionResult) ToggleFunctions(toggles []map[string]any) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 423. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/update-global-data.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/update-global-data.mdx new file mode 100644 index 0000000000..67a5f30772 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/update-global-data.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/update-global-data" +title: "UpdateGlobalData" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.UpdateGlobalData" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `UpdateGlobalData` + +UpdateGlobalData sets or updates global agent data variables. + +## Signature + +```go +func (*FunctionResult) UpdateGlobalData(data map[string]any) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 178. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/update-settings.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/update-settings.mdx new file mode 100644 index 0000000000..e7b7ca0ef2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/update-settings.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/update-settings" +title: "UpdateSettings" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.UpdateSettings" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `UpdateSettings` + +UpdateSettings updates agent runtime settings such as temperature, top\_p, etc. + +## Signature + +```go +func (*FunctionResult) UpdateSettings(settings map[string]any) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 438. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/wait-for-user.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/wait-for-user.mdx new file mode 100644 index 0000000000..cd63df7193 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/wait-for-user.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/function-result/wait-for-user" +title: "WaitForUser" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult.WaitForUser" + parent: "github.com/signalwire/signalwire-go/pkg/swaig.FunctionResult" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `WaitForUser` + +WaitForUser controls how the agent waits for user input. Pass nil for enabled/timeout to omit those fields. If answerFirst is true, the value is set to "answer\_first" regardless of other parameters. + +## Signature + +```go +func (*FunctionResult) WaitForUser(enabled *bool, timeout *int, answerFirst bool) *FunctionResult +``` + +## Parameters + + + + + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 157. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/index.mdx new file mode 100644 index 0000000000..31bbcc596e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig" +title: "swaig" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `swaig` + +Package swaig provides SWAIG (SignalWire AI Gateway) function result handling for building AI agent tool responses with actions and call control. + +## Signature + +```go +package swaig +``` + +## Functions + + + + CreatePaymentAction creates a single payment action entry. + + + + CreatePaymentParameter creates a payment parameter entry. + + + + CreatePaymentPrompt creates a payment prompt configuration. cardType and errorType are optional; pass empty strings to omit them. This matches the Python SDK's create\_payment\_prompt() static method signature. + + + + NewFunctionResult creates a new FunctionResult with the given response text. + + + +## Type Aliases + + + + ToolHandler is the function signature for SWAIG tool handlers. args contains the parsed function arguments, rawData contains the full request payload including global\_data, call\_id, etc. + + + +## Classes + + + + FunctionResult represents the response from a SWAIG tool handler. It contains a text response, optional actions, and post-processing control. All mutating methods return \*FunctionResult for method chaining. + + + + JoinConferenceOptions holds optional parameters for JoinConference beyond the required name. + + + + PayOptions holds all optional parameters for the Pay method. + + + + RecordCallOptions holds optional parameters for RecordCall beyond the required fields. + + + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/join-conference-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/join-conference-options/index.mdx new file mode 100644 index 0000000000..4f4b1fd429 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/join-conference-options/index.mdx @@ -0,0 +1,99 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/join-conference-options" +title: "JoinConferenceOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.JoinConferenceOptions" + parent: "github.com/signalwire/signalwire-go/pkg/swaig" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `JoinConferenceOptions` + +JoinConferenceOptions holds optional parameters for JoinConference beyond the required name. + +## Signature + +```go +type JoinConferenceOptions struct +``` + +## Properties + + + Beep controls beep behavior: "true" (default), "false", "onEnter", "onExit". + + + + Coach sets the SWML Call ID or CXML CallSid for coaching. + + + + EndOnExit controls whether the conference ends when this participant exits (default false). + + + + MaxParticipants sets the maximum number of participants (\<= 250). 0 uses server default. + + + + Muted joins the conference muted when true. + + + + Record sets the recording mode: "do-not-record" (default) or "record-from-start". + + + + RecordingStatusCallback is the URL for recording status callbacks. + + + + RecordingStatusCallbackEvent sets recording events to report. + + + + RecordingStatusCallbackMethod sets the HTTP method for recording callbacks ("GET" or "POST"). + + + + Region sets the conference region. + + + + Result sets switch-on-return-value behavior (object or array). + + + + StartOnEnter controls whether the conference starts when this participant enters (default true in Python). + + + + StatusCallback is the URL for status callbacks. + + + + StatusCallbackEvent specifies events to report (space-separated). + + + + StatusCallbackMethod sets the HTTP method for status callbacks ("GET" or "POST"). + + + + Trim controls silence trimming: "trim-silence" (default) or "do-not-trim". + + + + WaitURL is the SWML URL for hold music (replaces the old holdAudio parameter). + + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 471. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/new-function-result.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/new-function-result.mdx new file mode 100644 index 0000000000..b85e1cb7be --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/new-function-result.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/new-function-result" +title: "NewFunctionResult" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.NewFunctionResult" + parent: "github.com/signalwire/signalwire-go/pkg/swaig" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `NewFunctionResult` + +NewFunctionResult creates a new FunctionResult with the given response text. + +## Signature + +```go +func NewFunctionResult(response string) *FunctionResult +``` + +## Parameters + + + +## Returns + +`*FunctionResult` + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 24. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/pay-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/pay-options/index.mdx new file mode 100644 index 0000000000..a29dde72ee --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/pay-options/index.mdx @@ -0,0 +1,107 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/pay-options" +title: "PayOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.PayOptions" + parent: "github.com/signalwire/signalwire-go/pkg/swaig" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `PayOptions` + +PayOptions holds all optional parameters for the Pay method. + +## Signature + +```go +type PayOptions struct +``` + +## Properties + + + AIResponse is the message set via "set" verb before pay; empty string uses Python default. Set to "-" to suppress the set verb entirely (no ai\_response). + + + + ChargeAmount is the amount to charge as a decimal string (e.g. "9.99"). + + + + Currency is the currency code. Defaults to "usd". + + + + Description is a custom payment description. + + + + InputMethod is the method to collect payment details ("dtmf" or "voice"). Defaults to "dtmf". + + + + Language is the language for prompts. Defaults to "en-US". + + + + MaxAttempts is the number of retry attempts. Defaults to 1. + + + + MinPostalCodeLength sets the minimum number of postal code digits. Defaults to 0. + + + + Parameters is an array of name/value pairs for the payment connector. + + + + PaymentMethod is the payment method type. Defaults to "credit-card". + + + + PostalCode controls whether to prompt for postal code, or supplies the actual code. String value is used as-is; bool true/false becomes "true"/"false". + + + + Prompts is an array of custom prompt configurations. + + + + SecurityCode controls whether to prompt for security code. Defaults to true. Use SecurityCodeSet to override; zero value (false) is treated as "not set". + + + + SecurityCodeSet must be true to explicitly set SecurityCode=false. + + + + StatusURL is the URL for payment status change notifications. + + + + Timeout is the seconds to wait for the next digit. Defaults to 5. + + + + TokenType is the payment token type: "one-time" or "reusable". Defaults to "reusable". + + + + ValidCardTypes is a space-separated list of card types. Defaults to "visa mastercard amex". + + + + Voice is the TTS voice to use. Defaults to "woman". + + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 688. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/record-call-options/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/record-call-options/index.mdx new file mode 100644 index 0000000000..ed0eb18782 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/record-call-options/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/record-call-options" +title: "RecordCallOptions" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.RecordCallOptions" + parent: "github.com/signalwire/signalwire-go/pkg/swaig" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go" +--- +# `RecordCallOptions` + +RecordCallOptions holds optional parameters for RecordCall beyond the required fields. + +## Signature + +```go +type RecordCallOptions struct +``` + +## Properties + + + Beep plays a beep before recording starts when true. + + + + EndSilenceTimeout is seconds of silence before ending (voicemail-style). Negative value is omitted. + + + + EndSilenceTimeoutSet must be true for EndSilenceTimeout of 0.0 to be included. + + + + InitialTimeout is the time in seconds to wait for speech to start (voicemail-style). Negative value is omitted. + + + + InitialTimeoutSet must be true for InitialTimeout of 0.0 to be included. + + + + InputSensitivity sets the input sensitivity for recording (default 44.0 in Python). Zero value is omitted from the SWML payload. + + + + MaxLength is the maximum recording length in seconds. Negative value is omitted. + + + + MaxLengthSet must be true for MaxLength of 0.0 to be included. + + + + StatusURL is the URL to send recording status events to. + + + + Terminators specifies digits that stop recording when pressed. + + +## Source + +[`pkg/swaig/function_result.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/function_result.go) + +Line 306. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/tool-handler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/tool-handler.mdx new file mode 100644 index 0000000000..3935f4dc89 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/tool-handler.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig/tool-handler" +title: "ToolHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swaig.ToolHandler" + parent: "github.com/signalwire/signalwire-go/pkg/swaig" + module: "github.com.signalwire.signalwire-go.pkg.swaig" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/handler.go" +--- +# `ToolHandler` + +ToolHandler is the function signature for SWAIG tool handlers. args contains the parsed function arguments, rawData contains the full request payload including global\_data, call\_id, etc. + +## Signature + +```go +type ToolHandler alias +``` + +## Source + +[`pkg/swaig/handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swaig/handler.go) + +Line 6. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/build-config.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/build-config.mdx new file mode 100644 index 0000000000..5656f34357 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/build-config.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/build-config" +title: "BuildConfig" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.AIVerbHandler.BuildConfig" + parent: "github.com/signalwire/signalwire-go/pkg/swml.AIVerbHandler" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go" +--- +# `BuildConfig` + +BuildConfig assembles an AI verb configuration map from the provided params. + +Recognised keys in params (ported from Python AIVerbHandler.build\_config): + +- "prompt\_text" (string) — text prompt; mutually exclusive with "prompt\_pom" +- "prompt\_pom" (\[]any or similar) — POM structure; mutually exclusive with "prompt\_text" +- "contexts" (map\[string]any) — optional contexts / steps configuration +- "post\_prompt" (string) — optional post-prompt text; wrapped in \{"text": value\} +- "post\_prompt\_url" (string) — optional post-prompt URL +- "swaig" (map\[string]any) — optional SWAIG configuration; emitted as "SWAIG" + +Additional keys in params are handled as follows (matching Python \*\*kwargs logic): + +- "languages", "hints", "pronounce", "global\_data" — emitted as top-level keys. +- All other extra keys are collected under a nested "params" map. + +Returns (configMap, nil) on success, or (nil, error) if the parameters are contradictory (e.g. both prompt\_text and prompt\_pom supplied, or neither). + +## Signature + +```go +func (*AIVerbHandler) BuildConfig(params map[string]any) (map[string]any, error) +``` + +## Parameters + + + +## Returns + +`(map[string]any, error)` + +## Source + +[`pkg/swml/ai_verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go) + +Line 112. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/get-verb-name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/get-verb-name.mdx new file mode 100644 index 0000000000..d2f87bbeff --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/get-verb-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/get-verb-name" +title: "GetVerbName" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.AIVerbHandler.GetVerbName" + parent: "github.com/signalwire/signalwire-go/pkg/swml.AIVerbHandler" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go" +--- +# `GetVerbName` + +GetVerbName returns "ai", the name of the SWML verb this handler handles. + +## Signature + +```go +func (*AIVerbHandler) GetVerbName() string +``` + +## Returns + +`string` + +## Source + +[`pkg/swml/ai_verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go) + +Line 32. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/index.mdx new file mode 100644 index 0000000000..0e9e1e6334 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler" +title: "AIVerbHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.AIVerbHandler" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go" +--- +# `AIVerbHandler` + +AIVerbHandler is a concrete VerbHandler for the SWML "ai" verb. + +It implements the VerbHandler interface and provides validation and configuration-building logic for the AI verb. This is the Go equivalent of the Python AIVerbHandler class in core/swml\_handler.py. + +The AI verb is complex and requires specialized handling, particularly for managing prompts, SWAIG functions, and AI configurations. + +## Signature + +```go +type AIVerbHandler struct +``` + +## Methods + + + + BuildConfig assembles an AI verb configuration map from the provided params. + + + + GetVerbName returns "ai", the name of the SWML verb this handler handles. + + + + ValidateConfig validates the configuration map for the AI verb. + + + +## Source + +[`pkg/swml/ai_verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go) + +Line 20. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/validate-config.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/validate-config.mdx new file mode 100644 index 0000000000..fd47951130 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/validate-config.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/ai-verb-handler/validate-config" +title: "ValidateConfig" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.AIVerbHandler.ValidateConfig" + parent: "github.com/signalwire/signalwire-go/pkg/swml.AIVerbHandler" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go" +--- +# `ValidateConfig` + +ValidateConfig validates the configuration map for the AI verb. + +Validation rules (ported from Python AIVerbHandler.validate\_config): + +- "prompt" key must be present and must be a map\[string]any. +- "prompt" must contain exactly one of "text" or "pom" (mutually exclusive). +- If "prompt.contexts" is present it must be a map\[string]any. +- If "SWAIG" is present it must be a map\[string]any. + +Returns (true, nil) when the config is valid; (false, errors) when it is not. + +## Signature + +```go +func (*AIVerbHandler) ValidateConfig(config map[string]any) (bool, []string) +``` + +## Parameters + + + +## Returns + +`(bool, []string)` + +## Source + +[`pkg/swml/ai_verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go) + +Line 45. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-section.mdx new file mode 100644 index 0000000000..cca2c53790 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-section.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-section" +title: "AddSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Document.AddSection" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Document" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `AddSection` + +AddSection creates a new named section in the document. Returns false if the section already exists. + +## Signature + +```go +func (*Document) AddSection(name string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 46. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-verb-to-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-verb-to-section.mdx new file mode 100644 index 0000000000..0f48da7b3c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-verb-to-section.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-verb-to-section" +title: "AddVerbToSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Document.AddVerbToSection" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Document" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `AddVerbToSection` + +AddVerbToSection appends a verb to a named section. Creates the section if it doesn't exist. + +## Signature + +```go +func (*Document) AddVerbToSection(section string, verbName string, config any) error +``` + +## Parameters + + + + + + + +## Returns + +`error` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 72. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-verb.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-verb.mdx new file mode 100644 index 0000000000..7d8c28e32e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/add-verb" +title: "AddVerb" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Document.AddVerb" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Document" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `AddVerb` + +AddVerb appends a verb to the "main" section. Returns an error if the verb name is empty. + +## Signature + +```go +func (*Document) AddVerb(verbName string, config any) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 66. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/get-verbs.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/get-verbs.mdx new file mode 100644 index 0000000000..b1162ce596 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/get-verbs.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/get-verbs" +title: "GetVerbs" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Document.GetVerbs" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Document" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `GetVerbs` + +GetVerbs returns the verbs in a named section. Returns nil if the section doesn't exist. + +## Signature + +```go +func (*Document) GetVerbs(section string) []Verb +``` + +## Parameters + + + +## Returns + +`[]Verb` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 88. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/has-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/has-section.mdx new file mode 100644 index 0000000000..b3f6225f7c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/has-section.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/has-section" +title: "HasSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Document.HasSection" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Document" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `HasSection` + +HasSection returns whether a section exists in the document. + +## Signature + +```go +func (*Document) HasSection(name string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 57. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/index.mdx new file mode 100644 index 0000000000..728038f56f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document" +title: "Document" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Document" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `Document` + +Document represents a complete SWML document with version and sections. + +## Signature + +```go +type Document struct +``` + +## Properties + + + + + +## Methods + + + + AddSection creates a new named section in the document. Returns false if the section already exists. + + + + AddVerb appends a verb to the "main" section. Returns an error if the verb name is empty. + + + + AddVerbToSection appends a verb to a named section. Creates the section if it doesn't exist. + + + + GetVerbs returns the verbs in a named section. Returns nil if the section doesn't exist. + + + + HasSection returns whether a section exists in the document. + + + + MarshalJSON implements the json.Marshaler interface. + + + + Render serializes the document to a JSON string. + + + + RenderPretty serializes the document to an indented JSON string. + + + + Reset clears all sections and recreates the default "main" section. + + + + ToMap returns the document as a nested map suitable for JSON serialization. + + + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 15. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/marshal-json.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/marshal-json.mdx new file mode 100644 index 0000000000..e763bb1a31 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/marshal-json.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/marshal-json" +title: "MarshalJSON" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Document.MarshalJSON" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Document" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `MarshalJSON` + +MarshalJSON implements the json.Marshaler interface. + +## Signature + +```go +func (*Document) MarshalJSON() ([]byte, error) +``` + +## Returns + +`([]byte, error)` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 139. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/render-pretty.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/render-pretty.mdx new file mode 100644 index 0000000000..24ed197709 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/render-pretty.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/render-pretty" +title: "RenderPretty" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Document.RenderPretty" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Document" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `RenderPretty` + +RenderPretty serializes the document to an indented JSON string. + +## Signature + +```go +func (*Document) RenderPretty() (string, error) +``` + +## Returns + +`(string, error)` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 130. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/render.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/render.mdx new file mode 100644 index 0000000000..87c8f619d9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/render.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/render" +title: "Render" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Document.Render" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Document" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `Render` + +Render serializes the document to a JSON string. + +## Signature + +```go +func (*Document) Render() (string, error) +``` + +## Returns + +`(string, error)` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 121. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/reset.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/reset.mdx new file mode 100644 index 0000000000..b4edb55db4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/reset.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/reset" +title: "Reset" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Document.Reset" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Document" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `Reset` + +Reset clears all sections and recreates the default "main" section. + +## Signature + +```go +func (*Document) Reset() +``` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 36. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/to-map.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/to-map.mdx new file mode 100644 index 0000000000..0f02a2ce0f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/to-map.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/document/to-map" +title: "ToMap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Document.ToMap" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Document" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `ToMap` + +ToMap returns the document as a nested map suitable for JSON serialization. + +## Signature + +```go +func (*Document) ToMap() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 101. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/execution-mode.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/execution-mode.mdx new file mode 100644 index 0000000000..c2546d6b85 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/execution-mode.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/execution-mode" +title: "ExecutionMode" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.ExecutionMode" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/execution_mode.go" +--- +# `ExecutionMode` + +ExecutionMode identifies the runtime environment the service is executing in. The value is used to adjust URL construction, request parsing, and auth handling for platforms that do not provide a traditional TCP listener. + +## Signature + +```go +type ExecutionMode alias +``` + +## Source + +[`pkg/swml/execution_mode.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/execution_mode.go) + +Line 8. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/extract-sip-username.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/extract-sip-username.mdx new file mode 100644 index 0000000000..9a2e543990 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/extract-sip-username.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/extract-sip-username" +title: "ExtractSIPUsername" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.ExtractSIPUsername" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `ExtractSIPUsername` + +ExtractSIPUsername extracts a SIP username from a request body. + +## Signature + +```go +func ExtractSIPUsername(body map[string]any) string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1049. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/get-execution-mode.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/get-execution-mode.mdx new file mode 100644 index 0000000000..113badf8da --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/get-execution-mode.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/get-execution-mode" +title: "GetExecutionMode" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.GetExecutionMode" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/execution_mode.go" +--- +# `GetExecutionMode` + +GetExecutionMode inspects the process environment and returns the detected runtime mode. The detection order matches the Python and TypeScript SDKs so that the same env vars resolve to the same mode across languages. + +Detection order: + +1. CGI (GATEWAY\_INTERFACE) +2. AWS Lambda (AWS\_LAMBDA\_FUNCTION\_NAME or LAMBDA\_TASK\_ROOT) +3. GCF (FUNCTION\_TARGET, K\_SERVICE, or GOOGLE\_CLOUD\_PROJECT) +4. Azure (AZURE\_FUNCTIONS\_ENVIRONMENT, FUNCTIONS\_WORKER\_RUNTIME, or AzureWebJobsStorage) +5. Server (default fallback) + +## Signature + +```go +func GetExecutionMode() ExecutionMode +``` + +## Returns + +`ExecutionMode` + +## Source + +[`pkg/swml/execution_mode.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/execution_mode.go) + +Line 40. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/get-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/get-schema.mdx new file mode 100644 index 0000000000..330e4db2c0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/get-schema.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/get-schema" +title: "GetSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.GetSchema" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go" +--- +# `GetSchema` + +GetSchema returns the global singleton Schema loaded from the embedded schema.json. + +## Signature + +```go +func GetSchema() (*Schema, error) +``` + +## Returns + +`(*Schema, error)` + +## Source + +[`pkg/swml/schema.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go) + +Line 42. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/index.mdx new file mode 100644 index 0000000000..4a6f491749 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/index.mdx @@ -0,0 +1,218 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml" +title: "swml" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go" +--- +# `swml` + +Package swml provides the SWML (SignalWire Markup Language) document model, builder, and rendering for the SignalWire AI platform. + +SWML documents define call flows, AI agent behavior, and telephony operations. The SignalWire platform fetches SWML from agents and executes it. + +Package swml — URL validation utility to prevent SSRF attacks. Ported from signalwire/utils/url\_validator.py. + +## Signature + +```go +package swml +``` + +## Constants + + + + + + + + + + + +## Functions + + + + ExtractSIPUsername extracts a SIP username from a request body. + + + + GetExecutionMode inspects the process environment and returns the detected runtime mode. The detection order matches the Python and TypeScript SDKs so that the same env vars resolve to the same mode across languages. + + + + GetSchema returns the global singleton Schema loaded from the embedded schema.json. + + + + IsServerlessMode reports whether the process is running in any serverless environment (i.e. NOT in plain long-running server mode). + + + + LoadSchemaFromFile loads a SWML schema from the given file path instead of the embedded schema.json. Mirrors Python's schema\_path constructor param. + + + + NewAIVerbHandler returns a new AIVerbHandler ready for registration. + + + + NewDocument creates a new empty SWML document with default version. + + + + NewSchemaUtils constructs a SchemaUtils. Mirrors Python's “SchemaUtils(schema\_path, schema\_validation=True)“. + + + + NewSchemaValidationError constructs a SchemaValidationError. Mirrors Python's SchemaValidationError.**init**(verb\_name, errors). + + + + NewService creates a new SWML service with the given options. + + + + ValidateURL reports whether rawURL is safe to fetch (i.e. does not point to a private or internal resource). It returns an error describing why the URL was rejected, or nil if the URL is acceptable. + + + + WithAPIKey configures API key authentication. When set, the withSecurity middleware accepts requests where the header named by header equals key. header is the HTTP header name (e.g. "X-API-Key"); pass an empty string to use the default "X-API-Key". Mirrors Python's SecurityConfig.api\_key / api\_key\_header fields and the AuthHandler verify\_api\_key / flask\_decorator behaviour. + + + + WithBasicAuth sets explicit basic auth credentials. + + + + WithBearerToken configures Bearer token authentication. When set, the withSecurity middleware accepts requests carrying an "Authorization: Bearer \" header that matches token in addition to (or instead of) Basic Auth. Mirrors Python's SecurityConfig.bearer\_token field and the AuthHandler verify\_bearer\_token / flask\_decorator behaviour. + + + + WithConfigFile loads a YAML configuration file and applies its `security` section to the Service. Mirrors Python's SecurityConfig(config\_file=...) loader (signalwire/core/security\_config.py \_load\_config\_file). The expected schema is: + + + + WithDomain sets the domain name used in URL generation when TLS is enabled. Mirrors Python's SecurityConfig.domain / SWML\_DOMAIN env var. + + + + WithHost sets the HTTP server bind host. + + + + WithName sets the service name. + + + + WithPort sets the HTTP server port. + + + + WithRoute sets the HTTP route path. + + + + WithSchemaPath overrides the schema file path used for verb validation. By default the embedded schema.json is used. Pass a custom path when testing or when deploying a modified schema alongside your binary. Mirrors Python's schema\_path constructor parameter. + + + + WithSchemaValidation enables or disables SWML schema validation. Defaults to true (validation on). Set to false, or export SWML\_SKIP\_SCHEMA\_VALIDATION=1, to bypass schema checks. Mirrors Python's schema\_validation constructor parameter. + + + + WithSecurityConfig applies a SecurityConfig bundle, setting Basic Auth, Bearer token, and API key configuration in one call. This is the Go equivalent of Python's AuthHandler(security\_config=...) pattern: it maps each SecurityConfig field to the corresponding WithXxx option. + + + + WithTLS configures TLS for the service. When set, Serve() calls ListenAndServeTLS instead of ListenAndServe. Mirrors Python's ssl\_cert / ssl\_key serve() parameters and ssl\_enabled property. + + + +## Type Aliases + + + + ExecutionMode identifies the runtime environment the service is executing in. The value is used to adjust URL construction, request parsing, and auth handling for platforms that do not provide a traditional TCP listener. + + + + RoutingCallback is a function called on incoming requests to customize responses. It receives the request and request body, and returns an optional SWML JSON override. If it returns nil, the default document is used. + + + + ServiceOption is a functional option for configuring a Service. + + + + ToolHandler is the function signature for a registered SWAIG tool. Returns a result that will be JSON-encoded as the SWAIG response. + + + + Verb represents a single SWML verb (instruction) as a key-value pair. Example: \{"play": \{"url": "https://example.com/audio.mp3"\}\} + + + +## Classes + + + + AIVerbHandler is a concrete VerbHandler for the SWML "ai" verb. + + + + Document represents a complete SWML document with version and sections. + + + + Schema holds the parsed SWML schema and provides verb metadata. + + + + SchemaUtils is the Go port of signalwire.utils.schema\_utils.SchemaUtils. + + + + SchemaValidationError is the canonical error type raised when SWML schema validation fails. Mirrors Python's SchemaValidationError. + + + + SecurityConfig bundles configuration for all supported authentication methods: HTTP Basic Auth, Bearer token, and API key. Pass it to WithSecurityConfig to configure multiple auth methods in one call. + + + + Service is the base SWML service that manages documents, HTTP endpoints, and auth. It provides auto-vivified verb methods driven by the SWML schema. + + + + ToolDefinition is a SWAIG tool registered on the Service. + + + + ValidationResult mirrors Python's “Tuple\[bool, List\[str]]“ return shape used by ValidateVerb / ValidateDocument. + + + + VerbInfo holds metadata about a SWML verb extracted from the schema. + + + +## Interfaces + + + + VerbHandler defines the contract for specialized SWML verb handlers. + + + +## Source + +[`pkg/swml/ai_verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/is-serverless-mode.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/is-serverless-mode.mdx new file mode 100644 index 0000000000..359d76aced --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/is-serverless-mode.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/is-serverless-mode" +title: "IsServerlessMode" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.IsServerlessMode" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/execution_mode.go" +--- +# `IsServerlessMode` + +IsServerlessMode reports whether the process is running in any serverless environment (i.e. NOT in plain long-running server mode). + +Mirrors Python's is\_serverless\_mode(): + +``` +def is_serverless_mode() -> bool: + return get_execution_mode() != 'server' +``` + +## Signature + +```go +func IsServerlessMode() bool +``` + +## Returns + +`bool` + +## Examples + + + + ```go + def is_serverless_mode() -> bool: + return get_execution_mode() != 'server' + ``` + + + + ```go + def is_serverless_mode() -> bool: + return get_execution_mode() != 'server' + ``` + + + +## Source + +[`pkg/swml/execution_mode.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/execution_mode.go) + +Line 67. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/load-schema-from-file.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/load-schema-from-file.mdx new file mode 100644 index 0000000000..26c36db192 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/load-schema-from-file.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/load-schema-from-file" +title: "LoadSchemaFromFile" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.LoadSchemaFromFile" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go" +--- +# `LoadSchemaFromFile` + +LoadSchemaFromFile loads a SWML schema from the given file path instead of the embedded schema.json. Mirrors Python's schema\_path constructor param. + +## Signature + +```go +func LoadSchemaFromFile(path string) (*Schema, error) +``` + +## Parameters + + + +## Returns + +`(*Schema, error)` + +## Source + +[`pkg/swml/schema.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go) + +Line 163. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-ai-verb-handler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-ai-verb-handler.mdx new file mode 100644 index 0000000000..b1bd461877 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-ai-verb-handler.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-ai-verb-handler" +title: "NewAIVerbHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.NewAIVerbHandler" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go" +--- +# `NewAIVerbHandler` + +NewAIVerbHandler returns a new AIVerbHandler ready for registration. + +Example: + +``` +svc.RegisterVerbHandler(swml.NewAIVerbHandler()) +``` + +## Signature + +```go +func NewAIVerbHandler() *AIVerbHandler +``` + +## Returns + +`*AIVerbHandler` + +## Examples + + + + ```go + svc.RegisterVerbHandler(swml.NewAIVerbHandler()) + ``` + + + + ```go + svc.RegisterVerbHandler(swml.NewAIVerbHandler()) + ``` + + + +## Source + +[`pkg/swml/ai_verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/ai_verb_handler.go) + +Line 27. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-document.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-document.mdx new file mode 100644 index 0000000000..548c37308e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-document.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-document" +title: "NewDocument" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.NewDocument" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `NewDocument` + +NewDocument creates a new empty SWML document with default version. + +## Signature + +```go +func NewDocument() *Document +``` + +## Returns + +`*Document` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 26. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-schema-utils.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-schema-utils.mdx new file mode 100644 index 0000000000..36d2ee1079 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-schema-utils.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-schema-utils" +title: "NewSchemaUtils" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.NewSchemaUtils" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `NewSchemaUtils` + +NewSchemaUtils constructs a SchemaUtils. Mirrors Python's “SchemaUtils(schema\_path, schema\_validation=True)“. + +Pass schemaPath="" to use the embedded schema.json bundled with the SDK. schemaValidation=false disables validation; the env var SWML\_SKIP\_SCHEMA\_VALIDATION=1/true/yes also disables it. + +## Signature + +```go +func NewSchemaUtils(schemaPath string, schemaValidation bool) *SchemaUtils +``` + +## Parameters + + + + + +## Returns + +`*SchemaUtils` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 88. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-schema-validation-error.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-schema-validation-error.mdx new file mode 100644 index 0000000000..150740e694 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-schema-validation-error.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-schema-validation-error" +title: "NewSchemaValidationError" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.NewSchemaValidationError" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `NewSchemaValidationError` + +NewSchemaValidationError constructs a SchemaValidationError. Mirrors Python's SchemaValidationError.**init**(verb\_name, errors). + +## Signature + +```go +func NewSchemaValidationError(verbName string, errors []string) *SchemaValidationError +``` + +## Parameters + + + + + +## Returns + +`*SchemaValidationError` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 36. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-service.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-service.mdx new file mode 100644 index 0000000000..f8be2bfe0b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-service.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/new-service" +title: "NewService" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.NewService" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `NewService` + +NewService creates a new SWML service with the given options. + +## Signature + +```go +func NewService(opts ...ServiceOption) *Service +``` + +## Parameters + + + +## Returns + +`*Service` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 285. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/routing-callback.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/routing-callback.mdx new file mode 100644 index 0000000000..d5441409af --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/routing-callback.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/routing-callback" +title: "RoutingCallback" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.RoutingCallback" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `RoutingCallback` + +RoutingCallback is a function called on incoming requests to customize responses. It receives the request and request body, and returns an optional SWML JSON override. If it returns nil, the default document is used. + +## Signature + +```go +type RoutingCallback alias +``` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 37. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/full-validation-available.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/full-validation-available.mdx new file mode 100644 index 0000000000..89a1530add --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/full-validation-available.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/full-validation-available" +title: "FullValidationAvailable" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils.FullValidationAvailable" + parent: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `FullValidationAvailable` + +FullValidationAvailable reports whether the full JSON Schema validator is wired up. Mirrors Python's full\_validation\_available. + +## Signature + +```go +func (*SchemaUtils) FullValidationAvailable() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 199. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/generate-method-body.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/generate-method-body.mdx new file mode 100644 index 0000000000..810809fd78 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/generate-method-body.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/generate-method-body" +title: "GenerateMethodBody" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils.GenerateMethodBody" + parent: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `GenerateMethodBody` + +GenerateMethodBody renders a Python-style method body for a verb. Mirrors Python's “generate\_method\_body(verb\_name)“. + +## Signature + +```go +func (*SchemaUtils) GenerateMethodBody(verbName string) string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 358. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/generate-method-signature.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/generate-method-signature.mdx new file mode 100644 index 0000000000..a76955ba93 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/generate-method-signature.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/generate-method-signature" +title: "GenerateMethodSignature" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils.GenerateMethodSignature" + parent: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `GenerateMethodSignature` + +GenerateMethodSignature renders a Python-style method signature for a verb — used by code-gen tooling. Mirrors Python's “generate\_method\_signature(verb\_name)“. + +## Signature + +```go +func (*SchemaUtils) GenerateMethodSignature(verbName string) string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 317. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-all-verb-names.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-all-verb-names.mdx new file mode 100644 index 0000000000..a327221b92 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-all-verb-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-all-verb-names" +title: "GetAllVerbNames" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils.GetAllVerbNames" + parent: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `GetAllVerbNames` + +GetAllVerbNames returns the sorted list of all known verb names. Mirrors Python's “get\_all\_verb\_names()“. + +## Signature + +```go +func (*SchemaUtils) GetAllVerbNames() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 205. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-parameters.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-parameters.mdx new file mode 100644 index 0000000000..206bcf1a01 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-parameters.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-parameters" +title: "GetVerbParameters" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils.GetVerbParameters" + parent: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `GetVerbParameters` + +GetVerbParameters returns the parameter-definition block used for codegen — verb\_props\["properties"]. Mirrors Python's “get\_verb\_parameters(verb\_name)“. + +## Signature + +```go +func (*SchemaUtils) GetVerbParameters(verbName string) map[string]any +``` + +## Parameters + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 253. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-properties.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-properties.mdx new file mode 100644 index 0000000000..29f4c5181a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-properties.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-properties" +title: "GetVerbProperties" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils.GetVerbProperties" + parent: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `GetVerbProperties` + +GetVerbProperties returns the inner “properties\[verb\_name]“ block for a verb, or an empty map when the verb is unknown. Mirrors Python's “get\_verb\_properties(verb\_name)“. + +## Signature + +```go +func (*SchemaUtils) GetVerbProperties(verbName string) map[string]any +``` + +## Parameters + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 217. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-required-properties.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-required-properties.mdx new file mode 100644 index 0000000000..e76280ac13 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-required-properties.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/get-verb-required-properties" +title: "GetVerbRequiredProperties" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils.GetVerbRequiredProperties" + parent: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `GetVerbRequiredProperties` + +GetVerbRequiredProperties returns the “required“ list for a verb. Mirrors Python's “get\_verb\_required\_properties(verb\_name)“. + +## Signature + +```go +func (*SchemaUtils) GetVerbRequiredProperties(verbName string) []string +``` + +## Parameters + + + +## Returns + +`[]string` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 235. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/index.mdx new file mode 100644 index 0000000000..e4c5f0e0b3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils" +title: "SchemaUtils" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `SchemaUtils` + +SchemaUtils is the Go port of signalwire.utils.schema\_utils.SchemaUtils. + +Construction rules: + +- schemaPath empty + SWML\_SKIP\_SCHEMA\_VALIDATION unset → load embedded. +- schemaPath set → load from file. +- schemaValidation=false OR SWML\_SKIP\_SCHEMA\_VALIDATION=1 → no full validator (lightweight required-property check still runs). + +## Signature + +```go +type SchemaUtils struct +``` + +## Methods + + + + FullValidationAvailable reports whether the full JSON Schema validator is wired up. Mirrors Python's full\_validation\_available. + + + + GenerateMethodBody renders a Python-style method body for a verb. Mirrors Python's “generate\_method\_body(verb\_name)“. + + + + GenerateMethodSignature renders a Python-style method signature for a verb — used by code-gen tooling. Mirrors Python's “generate\_method\_signature(verb\_name)“. + + + + GetAllVerbNames returns the sorted list of all known verb names. Mirrors Python's “get\_all\_verb\_names()“. + + + + GetVerbParameters returns the parameter-definition block used for codegen — verb\_props\["properties"]. Mirrors Python's “get\_verb\_parameters(verb\_name)“. + + + + GetVerbProperties returns the inner “properties\[verb\_name]“ block for a verb, or an empty map when the verb is unknown. Mirrors Python's “get\_verb\_properties(verb\_name)“. + + + + GetVerbRequiredProperties returns the “required“ list for a verb. Mirrors Python's “get\_verb\_required\_properties(verb\_name)“. + + + + LoadSchema reads and parses the JSON Schema. Mirrors Python's “load\_schema()“. + + + + ValidateDocument validates a complete SWML document against the schema. Mirrors Python's “validate\_document(document)“. + + + + ValidateVerb validates a verb config against the schema. Mirrors Python's “validate\_verb(verb\_name, verb\_config)“. + + + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 65. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/load-schema.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/load-schema.mdx new file mode 100644 index 0000000000..6038a45344 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/load-schema.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/load-schema" +title: "LoadSchema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils.LoadSchema" + parent: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `LoadSchema` + +LoadSchema reads and parses the JSON Schema. Mirrors Python's “load\_schema()“. + +## Signature + +```go +func (*SchemaUtils) LoadSchema() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 113. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/validate-document.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/validate-document.mdx new file mode 100644 index 0000000000..c08e6c0ce7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/validate-document.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/validate-document" +title: "ValidateDocument" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils.ValidateDocument" + parent: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `ValidateDocument` + +ValidateDocument validates a complete SWML document against the schema. Mirrors Python's “validate\_document(document)“. + +When the full validator is unavailable Python returns “(False, \["Schema validator not initialized"])“; the Go port matches that contract bit-for-bit. + +## Signature + +```go +func (*SchemaUtils) ValidateDocument(document map[string]any) ValidationResult +``` + +## Parameters + + + +## Returns + +`ValidationResult` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 306. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/validate-verb.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/validate-verb.mdx new file mode 100644 index 0000000000..0f55934107 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/validate-verb.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-utils/validate-verb" +title: "ValidateVerb" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils.ValidateVerb" + parent: "github.com/signalwire/signalwire-go/pkg/swml.SchemaUtils" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `ValidateVerb` + +ValidateVerb validates a verb config against the schema. Mirrors Python's “validate\_verb(verb\_name, verb\_config)“. + +When validation is disabled returns Valid=true. When the verb name is unknown returns Valid=false with a single "Unknown verb" error. Otherwise runs the full validator if available, falling back to the lightweight required-property check. + +## Signature + +```go +func (*SchemaUtils) ValidateVerb(verbName string, verbConfig map[string]any) ValidationResult +``` + +## Parameters + + + + + +## Returns + +`ValidationResult` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 269. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-validation-error/error.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-validation-error/error.mdx new file mode 100644 index 0000000000..d352d5ed57 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-validation-error/error.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-validation-error/error" +title: "Error" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaValidationError.Error" + parent: "github.com/signalwire/signalwire-go/pkg/swml.SchemaValidationError" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `Error` + +Error renders the validation failure as a single string. + +## Signature + +```go +func (*SchemaValidationError) Error() string +``` + +## Returns + +`string` + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 41. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-validation-error/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-validation-error/index.mdx new file mode 100644 index 0000000000..5d2683e535 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-validation-error/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema-validation-error" +title: "SchemaValidationError" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SchemaValidationError" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `SchemaValidationError` + +SchemaValidationError is the canonical error type raised when SWML schema validation fails. Mirrors Python's SchemaValidationError. + +## Signature + +```go +type SchemaValidationError struct +``` + +## Properties + + + + + +## Methods + + + + Error renders the validation failure as a single string. + + + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 29. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/get-all-verb-names.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/get-all-verb-names.mdx new file mode 100644 index 0000000000..ac1ee94faf --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/get-all-verb-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/get-all-verb-names" +title: "GetAllVerbNames" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Schema.GetAllVerbNames" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Schema" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go" +--- +# `GetAllVerbNames` + +GetAllVerbNames returns all known verb names (the actual SWML names, not schema names). + +## Signature + +```go +func (*Schema) GetAllVerbNames() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/swml/schema.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go) + +Line 136. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/get-verb.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/get-verb.mdx new file mode 100644 index 0000000000..d49e51654e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/get-verb.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/get-verb" +title: "GetVerb" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Schema.GetVerb" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Schema" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go" +--- +# `GetVerb` + +GetVerb returns metadata for a verb by its actual name (e.g., "sip\_refer"). + +## Signature + +```go +func (*Schema) GetVerb(name string) (*VerbInfo, bool) +``` + +## Parameters + + + +## Returns + +`(*VerbInfo, bool)` + +## Source + +[`pkg/swml/schema.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go) + +Line 128. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/index.mdx new file mode 100644 index 0000000000..5780a290bd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema" +title: "Schema" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Schema" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go" +--- +# `Schema` + +Schema holds the parsed SWML schema and provides verb metadata. + +## Signature + +```go +type Schema struct +``` + +## Methods + + + + GetAllVerbNames returns all known verb names (the actual SWML names, not schema names). + + + + GetVerb returns metadata for a verb by its actual name (e.g., "sip\_refer"). + + + + IsValidVerb returns whether a name is a recognized SWML verb. + + + + VerbCount returns the number of verbs in the schema. + + + +## Source + +[`pkg/swml/schema.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go) + +Line 29. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/is-valid-verb.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/is-valid-verb.mdx new file mode 100644 index 0000000000..e66c7f0061 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/is-valid-verb.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/is-valid-verb" +title: "IsValidVerb" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Schema.IsValidVerb" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Schema" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go" +--- +# `IsValidVerb` + +IsValidVerb returns whether a name is a recognized SWML verb. + +## Signature + +```go +func (*Schema) IsValidVerb(name string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/swml/schema.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go) + +Line 147. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/verb-count.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/verb-count.mdx new file mode 100644 index 0000000000..5aa987dff8 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/verb-count.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/schema/verb-count" +title: "VerbCount" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Schema.VerbCount" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Schema" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go" +--- +# `VerbCount` + +VerbCount returns the number of verbs in the schema. + +## Signature + +```go +func (*Schema) VerbCount() int +``` + +## Returns + +`int` + +## Source + +[`pkg/swml/schema.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go) + +Line 155. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/security-config/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/security-config/index.mdx new file mode 100644 index 0000000000..57dd7f446c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/security-config/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/security-config" +title: "SecurityConfig" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.SecurityConfig" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `SecurityConfig` + +SecurityConfig bundles configuration for all supported authentication methods: HTTP Basic Auth, Bearer token, and API key. Pass it to WithSecurityConfig to configure multiple auth methods in one call. + +Fields default to the zero value (disabled). Set only the fields you need. + +- BasicAuthUser / BasicAuthPassword — HTTP Basic Auth credentials. +- BearerToken — Expected value of the "Authorization: Bearer \" header. +- APIKey — Expected API key value. +- APIKeyHeader — Header name to read the API key from (default "X-API-Key"). + +Mirrors Python's SecurityConfig dataclass. + +## Signature + +```go +type SecurityConfig struct +``` + +## Properties + + + + + defaults to "X-API-Key" when APIKey is set + + + + + + + + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 53. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service-option.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service-option.mdx new file mode 100644 index 0000000000..81253ef7e5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service-option.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service-option" +title: "ServiceOption" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.ServiceOption" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `ServiceOption` + +ServiceOption is a functional option for configuring a Service. + +## Signature + +```go +type ServiceOption alias +``` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 138. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/add-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/add-section.mdx new file mode 100644 index 0000000000..58c356737e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/add-section.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/add-section" +title: "AddSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.AddSection" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `AddSection` + +AddSection adds a new named section to the SWML document. Returns false if the section already exists. Delegates to Document.AddSection. Mirrors Python's add\_section method which was only on the Document in Go but is on SWMLService in Python. + +## Signature + +```go +func (*Service) AddSection(name string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 565. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/ai.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/ai.mdx new file mode 100644 index 0000000000..c7f922efdb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/ai.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/ai" +title: "AI" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.AI" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `AI` + +AI adds the ai verb. AgentBase overrides this with its own AI rendering. promptText and promptPOM are mutually exclusive; providing both is an error. promptText sets a plain-text prompt; promptPOM sets a structured POM prompt. postPrompt and postPromptURL configure post-prompt behavior (optional). swaig supplies SWAIG configuration (optional). extra is a map of additional AI parameters merged into the verb config (optional). Mirrors Python SWMLBuilder.ai(prompt\_text, prompt\_pom, post\_prompt, post\_prompt\_url, swaig, \*\*kwargs). + +## Signature + +```go +func (*Service) AI( + promptText *string, + promptPOM []map[string]any, + postPrompt *string, + postPromptURL *string, + swaig map[string]any, + extra map[string]any +) error +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 762. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/amazon-bedrock.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/amazon-bedrock.mdx new file mode 100644 index 0000000000..d28b31154f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/amazon-bedrock.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/amazon-bedrock" +title: "AmazonBedrock" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.AmazonBedrock" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `AmazonBedrock` + +AmazonBedrock adds the amazon\_bedrock verb. + +## Signature + +```go +func (*Service) AmazonBedrock(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 792. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/answer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/answer.mdx new file mode 100644 index 0000000000..aebcf03ecc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/answer.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/answer" +title: "Answer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Answer" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Answer` + +Answer adds the answer verb to the document. maxDuration sets the maximum call duration in seconds (optional). codecs sets a comma-separated list of allowed codecs (optional). Mirrors Python SWMLBuilder.answer(max\_duration, codecs). + +## Signature + +```go +func (*Service) Answer(maxDuration *int, codecs *string) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 637. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/as-router.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/as-router.mdx new file mode 100644 index 0000000000..8ac13876ab --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/as-router.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/as-router" +title: "AsRouter" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.AsRouter" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `AsRouter` + +AsRouter returns an http.Handler that serves this service's endpoints. Use this to embed the service in a custom HTTP mux or router. Mirrors Python's as\_router() -> APIRouter method on SWMLService. + +## Signature + +```go +func (*Service) AsRouter() http.Handler +``` + +## Returns + +`http.Handler` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 572. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/build-swaig-list-tools-payload.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/build-swaig-list-tools-payload.mdx new file mode 100644 index 0000000000..882b024568 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/build-swaig-list-tools-payload.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/build-swaig-list-tools-payload" +title: "BuildSwaigListToolsPayload" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.BuildSwaigListToolsPayload" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `BuildSwaigListToolsPayload` + +BuildSwaigListToolsPayload returns the JSON payload that --example mode expects between the sentinel markers: \{"tools": \[\]\}. Each element echoes whatever the in-memory ToolDefinition stores (name, description, parameters); we deliberately do not normalize so the CLI can be permissive about field names. + +Exposed for tests so the env-var-driven exit branch in Serve() can be asserted without forking a process. + +## Signature + +```go +func (*Service) BuildSwaigListToolsPayload() ([]byte, error) +``` + +## Returns + +`([]byte, error)` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1117. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/cond.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/cond.mdx new file mode 100644 index 0000000000..c3ac2f39f7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/cond.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/cond" +title: "Cond" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Cond" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Cond` + +Cond adds the cond verb (conditional logic). + +## Signature + +```go +func (*Service) Cond(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 797. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/connect.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/connect.mdx new file mode 100644 index 0000000000..45e230f6d4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/connect.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/connect" +title: "Connect" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Connect" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Connect` + +Connect adds the connect verb. + +## Signature + +```go +func (*Service) Connect(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 726. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/define-tool.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/define-tool.mdx new file mode 100644 index 0000000000..a0c8172b47 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/define-tool.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/define-tool" +title: "DefineTool" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.DefineTool" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `DefineTool` + +DefineTool registers a SWAIG function the AI can call. Tool descriptions and parameter descriptions are LLM-facing prompt engineering — see PORTING\_GUIDE for guidance. + +## Signature + +```go +func (*Service) DefineTool(td *ToolDefinition) *Service +``` + +## Parameters + + + +## Returns + +`*Service` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1261. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/denoise.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/denoise.mdx new file mode 100644 index 0000000000..3382f3b542 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/denoise.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/denoise" +title: "Denoise" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Denoise" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Denoise` + +Denoise adds the denoise verb. + +## Signature + +```go +func (*Service) Denoise(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 852. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/detect-machine.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/detect-machine.mdx new file mode 100644 index 0000000000..9556fba6c1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/detect-machine.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/detect-machine" +title: "DetectMachine" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.DetectMachine" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `DetectMachine` + +DetectMachine adds the detect\_machine verb. + +## Signature + +```go +func (*Service) DetectMachine(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 892. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/enter-queue.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/enter-queue.mdx new file mode 100644 index 0000000000..3632cf2fd5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/enter-queue.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/enter-queue" +title: "EnterQueue" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.EnterQueue" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `EnterQueue` + +EnterQueue adds the enter\_queue verb. + +## Signature + +```go +func (*Service) EnterQueue(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 877. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute-verb-to-section.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute-verb-to-section.mdx new file mode 100644 index 0000000000..a80567f958 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute-verb-to-section.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute-verb-to-section" +title: "ExecuteVerbToSection" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.ExecuteVerbToSection" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `ExecuteVerbToSection` + +ExecuteVerbToSection adds a SWML verb to a named section. + +## Signature + +```go +func (*Service) ExecuteVerbToSection(section string, verbName string, config any) error +``` + +## Parameters + + + + + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 611. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute-verb.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute-verb.mdx new file mode 100644 index 0000000000..c85086d0f7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute-verb" +title: "ExecuteVerb" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.ExecuteVerb" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `ExecuteVerb` + +ExecuteVerb adds any SWML verb to the document, validated against the schema and any registered VerbHandler. This is the core method that all verb convenience methods delegate to. For most verbs, config should be a map\[string]any of verb parameters. For "sleep", config should be an integer (milliseconds). + +## Signature + +```go +func (*Service) ExecuteVerb(verbName string, config any) error +``` + +## Parameters + + + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 592. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute.mdx new file mode 100644 index 0000000000..3898ee0afb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/execute" +title: "Execute" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Execute" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Execute` + +Execute adds the execute verb (run another SWML section). + +## Signature + +```go +func (*Service) Execute(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 807. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/full-validation-enabled.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/full-validation-enabled.mdx new file mode 100644 index 0000000000..3d27e030c7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/full-validation-enabled.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/full-validation-enabled" +title: "FullValidationEnabled" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.FullValidationEnabled" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `FullValidationEnabled` + +FullValidationEnabled reports whether schema validation is active. Returns true when a schema was successfully loaded and schemaValidation is on. Mirrors Python's full\_validation\_enabled property. + +## Signature + +```go +func (*Service) FullValidationEnabled() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 555. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-auth-info.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-auth-info.mdx new file mode 100644 index 0000000000..0fc7543b5e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-auth-info.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-auth-info" +title: "GetAuthInfo" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.GetAuthInfo" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `GetAuthInfo` + +GetAuthInfo returns a map describing every configured authentication method. The map mirrors the Python AuthHandler.get\_auth\_info() return value: + +- "basic" → \{"enabled": true, "username": "\"\} +- "bearer" → \{"enabled": true, "hint": "Use Authorization: Bearer \"\} +- "api\_key" → \{"enabled": true, "header": "\", "hint": "Use \: \"\} + +Only methods that are actively configured appear in the map. Basic auth is always present because the service always has a username/password (either explicit or auto-generated). Mirrors Python AuthHandler.get\_auth\_info() -> Dict\[str, Any]. + +## Signature + +```go +func (*Service) GetAuthInfo() map[string]any +``` + +## Returns + +`map[string]any` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 513. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-basic-auth-credentials-with-source.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-basic-auth-credentials-with-source.mdx new file mode 100644 index 0000000000..1ab5b34b70 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-basic-auth-credentials-with-source.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-basic-auth-credentials-with-source" +title: "GetBasicAuthCredentialsWithSource" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.GetBasicAuthCredentialsWithSource" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `GetBasicAuthCredentialsWithSource` + +GetBasicAuthCredentialsWithSource returns (username, password, source) where source is one of "environment", "explicit", or "auto-generated". Mirrors Python's get\_basic\_auth\_credentials(include\_source=True) three-tuple return. + +## Signature + +```go +func (*Service) GetBasicAuthCredentialsWithSource() (string, string, string) +``` + +## Returns + +`(string, string, string)` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 435. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..60e6e5dc1f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-basic-auth-credentials.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-basic-auth-credentials" +title: "GetBasicAuthCredentials" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.GetBasicAuthCredentials" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `GetBasicAuthCredentials` + +GetBasicAuthCredentials returns the (username, password) for basic auth. + +## Signature + +```go +func (*Service) GetBasicAuthCredentials() (string, string) +``` + +## Returns + +`(string, string)` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 428. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-document.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-document.mdx new file mode 100644 index 0000000000..fc5783bfe3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-document.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-document" +title: "GetDocument" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.GetDocument" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `GetDocument` + +GetDocument returns the current SWML document. + +## Signature + +```go +func (*Service) GetDocument() *Document +``` + +## Returns + +`*Document` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 407. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-full-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-full-url.mdx new file mode 100644 index 0000000000..04d93f76ce --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-full-url.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-full-url" +title: "GetFullURL" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.GetFullURL" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `GetFullURL` + +GetFullURL returns the full URL for this service including auth. + +Base URL resolution order: + +1. SWML\_PROXY\_URL\_BASE (explicit proxy override — always wins) +2. Platform-specific base derived from GetExecutionMode() when running inside a serverless runtime (currently AWS Lambda) +3. Local http://host:port base (default server mode) + +In every branch the agent's Route is appended to the base. Callers that need to serve SWAIG / post\_prompt endpoints then append further path segments onto the result. This invariant is load-bearing: a Lambda-hosted agent at route "/my-agent" must emit SWAIG URLs like "https://xxx.lambda-url.us-east-1.on.aws/my-agent/swaig" — NOT "https://xxx.lambda-url.us-east-1.on.aws/swaig". See buildWebhookURL in pkg/agent/agent.go for the defensive HasSuffix re-check that enforces the same property downstream. + +## Signature + +```go +func (*Service) GetFullURL(includeAuth bool) string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 929. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-verb-handler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-verb-handler.mdx new file mode 100644 index 0000000000..18c2916ca7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-verb-handler.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/get-verb-handler" +title: "GetVerbHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.GetVerbHandler" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go" +--- +# `GetVerbHandler` + +GetVerbHandler returns the registered handler for verbName, or nil if no handler has been registered for that verb. This is the Go equivalent of Python's VerbHandlerRegistry.get\_handler. + +## Signature + +```go +func (*Service) GetVerbHandler(verbName string) VerbHandler +``` + +## Parameters + + + +## Returns + +`VerbHandler` + +## Source + +[`pkg/swml/verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go) + +Line 57. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/goto.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/goto.mdx new file mode 100644 index 0000000000..43ab95cab9 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/goto.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/goto" +title: "Goto" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Goto" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Goto` + +Goto adds the goto verb. + +## Signature + +```go +func (*Service) Goto(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 817. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/hangup.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/hangup.mdx new file mode 100644 index 0000000000..05faf45244 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/hangup.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/hangup" +title: "Hangup" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Hangup" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Hangup` + +Hangup adds the hangup verb. reason is an optional reason string for the hangup. Mirrors Python SWMLBuilder.hangup(reason). + +## Signature + +```go +func (*Service) Hangup(reason *string) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 651. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/has-tool.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/has-tool.mdx new file mode 100644 index 0000000000..f12bec441d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/has-tool.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/has-tool" +title: "HasTool" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.HasTool" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `HasTool` + +HasTool reports whether a tool with the given name has been registered. + +## Signature + +```go +func (*Service) HasTool(name string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1315. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/has-verb-handler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/has-verb-handler.mdx new file mode 100644 index 0000000000..fd4ec3814e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/has-verb-handler.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/has-verb-handler" +title: "HasVerbHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.HasVerbHandler" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go" +--- +# `HasVerbHandler` + +HasVerbHandler reports whether a custom handler is registered for verbName. This is the Go equivalent of Python's VerbHandlerRegistry.has\_handler. + +## Signature + +```go +func (*Service) HasVerbHandler(verbName string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/swml/verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go) + +Line 65. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/index.mdx new file mode 100644 index 0000000000..ee9c4a46c4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/index.mdx @@ -0,0 +1,349 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service" +title: "Service" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Service` + +Service is the base SWML service that manages documents, HTTP endpoints, and auth. It provides auto-vivified verb methods driven by the SWML schema. + +## Signature + +```go +type Service struct +``` + +## Properties + + + Domain for TLS certificates and URL generation (SWML\_DOMAIN env var) + + + + + + + + + + + + +## Methods + + + + AddSection adds a new named section to the SWML document. Returns false if the section already exists. Delegates to Document.AddSection. Mirrors Python's add\_section method which was only on the Document in Go but is on SWMLService in Python. + + + + AI adds the ai verb. AgentBase overrides this with its own AI rendering. promptText and promptPOM are mutually exclusive; providing both is an error. promptText sets a plain-text prompt; promptPOM sets a structured POM prompt. postPrompt and postPromptURL configure post-prompt behavior (optional). swaig supplies SWAIG configuration (optional). extra is a map of additional AI parameters merged into the verb config (optional). Mirrors Python SWMLBuilder.ai(prompt\_text, prompt\_pom, post\_prompt, post\_prompt\_url, swaig, \*\*kwargs). + + + + AmazonBedrock adds the amazon\_bedrock verb. + + + + Answer adds the answer verb to the document. maxDuration sets the maximum call duration in seconds (optional). codecs sets a comma-separated list of allowed codecs (optional). Mirrors Python SWMLBuilder.answer(max\_duration, codecs). + + + + AsRouter returns an http.Handler that serves this service's endpoints. Use this to embed the service in a custom HTTP mux or router. Mirrors Python's as\_router() -> APIRouter method on SWMLService. + + + + BuildSwaigListToolsPayload returns the JSON payload that --example mode expects between the sentinel markers: \{"tools": \[\]\}. Each element echoes whatever the in-memory ToolDefinition stores (name, description, parameters); we deliberately do not normalize so the CLI can be permissive about field names. + + + + Cond adds the cond verb (conditional logic). + + + + Connect adds the connect verb. + + + + DefineTool registers a SWAIG function the AI can call. Tool descriptions and parameter descriptions are LLM-facing prompt engineering — see PORTING\_GUIDE for guidance. + + + + Denoise adds the denoise verb. + + + + DetectMachine adds the detect\_machine verb. + + + + EnterQueue adds the enter\_queue verb. + + + + Execute adds the execute verb (run another SWML section). + + + + ExecuteVerb adds any SWML verb to the document, validated against the schema and any registered VerbHandler. This is the core method that all verb convenience methods delegate to. For most verbs, config should be a map\[string]any of verb parameters. For "sleep", config should be an integer (milliseconds). + + + + ExecuteVerbToSection adds a SWML verb to a named section. + + + + FullValidationEnabled reports whether schema validation is active. Returns true when a schema was successfully loaded and schemaValidation is on. Mirrors Python's full\_validation\_enabled property. + + + + GetAuthInfo returns a map describing every configured authentication method. The map mirrors the Python AuthHandler.get\_auth\_info() return value: + + + + GetBasicAuthCredentials returns the (username, password) for basic auth. + + + + GetBasicAuthCredentialsWithSource returns (username, password, source) where source is one of "environment", "explicit", or "auto-generated". Mirrors Python's get\_basic\_auth\_credentials(include\_source=True) three-tuple return. + + + + GetDocument returns the current SWML document. + + + + GetFullURL returns the full URL for this service including auth. + + + + GetVerbHandler returns the registered handler for verbName, or nil if no handler has been registered for that verb. This is the Go equivalent of Python's VerbHandlerRegistry.get\_handler. + + + + Goto adds the goto verb. + + + + Hangup adds the hangup verb. reason is an optional reason string for the hangup. Mirrors Python SWMLBuilder.hangup(reason). + + + + HasTool reports whether a tool with the given name has been registered. + + + + HasVerbHandler reports whether a custom handler is registered for verbName. This is the Go equivalent of Python's VerbHandlerRegistry.has\_handler. + + + + JoinConference adds the join\_conference verb. + + + + JoinRoom adds the join\_room verb. + + + + Label adds the label verb. + + + + ListToolNames returns the registered tool names in insertion order. + + + + LiveTranscribe adds the live\_transcribe verb. + + + + LiveTranslate adds the live\_translate verb. + + + + ManualSetProxyUrl overrides the proxy URL base used for URL generation. Call this at runtime to set or update the proxy URL (e.g. an ngrok URL). Mirrors Python's manual\_set\_proxy\_url(proxy\_url: str) on SWMLService. + + + + OnFunctionCall dispatches a function call to the registered handler. Default implementation: looks up the tool in the registry and invokes its handler. Subclasses (AgentBase) may override at the type level by providing their own method (Go method dispatch is static — to override in a way that is callable through Service, use the SwaigPreDispatch extension hook to substitute a target). + + + + OnRequest generates the SWML response for an incoming request. It checks routing callbacks first, then returns the default document. + + + + Pay adds the pay verb. + + + + Play adds the play verb. Exactly one of url or urls must be provided; providing both is an error. volume sets the playback volume (-40 to 40, optional). sayVoice, sayLanguage, sayGender configure text-to-speech (optional). autoAnswer controls whether to auto-answer the call (optional). Mirrors Python SWMLBuilder.play(url, urls, volume, say\_voice, say\_language, say\_gender, auto\_answer). + + + + Prompt adds the prompt verb. + + + + ReceiveFax adds the receive\_fax verb. + + + + Record adds the record verb. + + + + RecordCall adds the record\_call verb. + + + + RegisterAdditionalRoutes is an extension hook for subclasses (e.g. AgentBase) to mount additional routes (/post\_prompt, /mcp). Default no-op. Composing types call this from their own buildMux equivalent. + + + + RegisterRoutingCallback registers a callback for a specific path. + + + + RegisterSwaigFunction registers a raw SWAIG function definition (e.g. DataMap tools that have no local handler). The map must contain a "function" key giving the tool name. + + + + RegisterVerbHandler registers a custom handler for a SWML verb, keyed by the name returned by h.GetVerbName(). A subsequent call with the same verb name replaces the previous handler. This is the Go equivalent of Python's VerbHandlerRegistry.register\_handler. + + + + Render returns the SWML document as a JSON string. + + + + RenderMainSwml is an extension hook invoked for the main route and for GET /swaig. Default returns the currently-built document. AgentBase overrides to render with prompts + dynamic config. + + + + RenderPretty returns the SWML document as an indented JSON string. + + + + Request adds the request verb (HTTP request). + + + + ResetDocument resets the SWML document to empty. + + + + Return adds the return verb. + + + + RoutingCallbackPaths returns the paths that have routing callbacks registered. Callers use this to register corresponding HTTP endpoints (mirrors Python web\_mixin.py line 428 which iterates self.\_routing\_callbacks to register callback endpoints on the router). Paths are returned in sorted order for deterministic HTTP registration. + + + + Say adds a play verb with a "say:" prefix for text-to-speech. voice, language, and gender configure the TTS voice (optional). volume sets the playback volume (-40 to 40, optional). Mirrors Python SWMLBuilder.say(text, voice, language, gender, volume). + + + + SchemaUtils returns the SchemaUtils helper bound to this Service. Mirrors Python's “self.schema\_utils“ instance attribute exposed publicly on signalwire.core.swml\_service.SWMLService. + + + + SendDigits adds the send\_digits verb. + + + + SendFax adds the send\_fax verb. + + + + SendSMS adds the send\_sms verb. + + + + Serve starts the HTTP server. This is a blocking call. + + + + Set adds the set verb (set variables). + + + + SIPRefer adds the sip\_refer verb. + + + + Sleep adds the sleep verb. Duration is in milliseconds. + + + + Stop gracefully stops the HTTP server. + + + + StopDenoise adds the stop\_denoise verb. + + + + StopRecordCall adds the stop\_record\_call verb. + + + + StopTap adds the stop\_tap verb. + + + + SwaigPreDispatch is an extension hook invoked between argument parsing and function dispatch on POST /swaig. It returns a target Service to dispatch on (defaults to s) and an optional short-circuit response. Subclasses (AgentBase) override to add session-token validation or ephemeral dynamic-config copies. + + + + Switch adds the switch verb. + + + + Tap adds the tap verb (media tapping). + + + + TLSEnabled reports whether TLS is configured for this service. Mirrors Python's ssl\_enabled property on SWMLService. + + + + Transfer adds the transfer verb. + + + + Unset adds the unset verb. + + + + UserEvent adds the user\_event verb. + + + + VerifyAPIKey performs a timing-safe comparison of the supplied key value against the service's configured API key. Returns false when no API key is configured (i.e. WithAPIKey was not called). + + + + VerifyBasicAuth performs a timing-safe comparison of the supplied credentials against the service's configured basic auth username and password. Returns true when both username and password match. + + + + VerifyBearerToken performs a timing-safe comparison of the supplied token against the service's configured bearer token. Returns false when no bearer token is configured (i.e. WithBearerToken was not called). + + + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 63. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/join-conference.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/join-conference.mdx new file mode 100644 index 0000000000..5bb15698f2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/join-conference.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/join-conference" +title: "JoinConference" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.JoinConference" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `JoinConference` + +JoinConference adds the join\_conference verb. + +## Signature + +```go +func (*Service) JoinConference(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 867. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/join-room.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/join-room.mdx new file mode 100644 index 0000000000..d3a1c63c0e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/join-room.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/join-room" +title: "JoinRoom" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.JoinRoom" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `JoinRoom` + +JoinRoom adds the join\_room verb. + +## Signature + +```go +func (*Service) JoinRoom(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 862. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/label.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/label.mdx new file mode 100644 index 0000000000..cd5c8503d6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/label.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/label" +title: "Label" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Label" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Label` + +Label adds the label verb. + +## Signature + +```go +func (*Service) Label(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 822. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/list-tool-names.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/list-tool-names.mdx new file mode 100644 index 0000000000..78efc11721 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/list-tool-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/list-tool-names" +title: "ListToolNames" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.ListToolNames" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `ListToolNames` + +ListToolNames returns the registered tool names in insertion order. + +## Signature + +```go +func (*Service) ListToolNames() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1323. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/live-transcribe.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/live-transcribe.mdx new file mode 100644 index 0000000000..8977627de0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/live-transcribe.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/live-transcribe" +title: "LiveTranscribe" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.LiveTranscribe" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `LiveTranscribe` + +LiveTranscribe adds the live\_transcribe verb. + +## Signature + +```go +func (*Service) LiveTranscribe(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 897. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/live-translate.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/live-translate.mdx new file mode 100644 index 0000000000..ca10d49dde --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/live-translate.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/live-translate" +title: "LiveTranslate" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.LiveTranslate" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `LiveTranslate` + +LiveTranslate adds the live\_translate verb. + +## Signature + +```go +func (*Service) LiveTranslate(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 902. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/manual-set-proxy-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..1265a05127 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/manual-set-proxy-url.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/manual-set-proxy-url" +title: "ManualSetProxyUrl" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.ManualSetProxyUrl" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `ManualSetProxyUrl` + +ManualSetProxyUrl overrides the proxy URL base used for URL generation. Call this at runtime to set or update the proxy URL (e.g. an ngrok URL). Mirrors Python's manual\_set\_proxy\_url(proxy\_url: str) on SWMLService. + +## Signature + +```go +func (*Service) ManualSetProxyUrl(url string) +``` + +## Parameters + + + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 579. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/on-function-call.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/on-function-call.mdx new file mode 100644 index 0000000000..ba6b41fb16 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/on-function-call.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/on-function-call" +title: "OnFunctionCall" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.OnFunctionCall" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `OnFunctionCall` + +OnFunctionCall dispatches a function call to the registered handler. Default implementation: looks up the tool in the registry and invokes its handler. Subclasses (AgentBase) may override at the type level by providing their own method (Go method dispatch is static — to override in a way that is callable through Service, use the SwaigPreDispatch extension hook to substitute a target). + +## Signature + +```go +func (*Service) OnFunctionCall(name string, args map[string]any, rawData map[string]any) any +``` + +## Parameters + + + + + + + +## Returns + +`any` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1304. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/on-request.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/on-request.mdx new file mode 100644 index 0000000000..2be059edc5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/on-request.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/on-request" +title: "OnRequest" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.OnRequest" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `OnRequest` + +OnRequest generates the SWML response for an incoming request. It checks routing callbacks first, then returns the default document. + +The return value is a pointer to allow subclasses (AgentBase) to signal "no override" by returning nil — matching Python's Optional\[dict] return type for on\_request. Callers should treat a nil return as "use the default document unchanged". + +## Signature + +```go +func (*Service) OnRequest(requestData map[string]any, callbackPath string) map[string]any +``` + +## Parameters + + + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1021. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/pay.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/pay.mdx new file mode 100644 index 0000000000..a702e2ff9e --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/pay.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/pay" +title: "Pay" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Pay" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Pay` + +Pay adds the pay verb. + +## Signature + +```go +func (*Service) Pay(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 887. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/play.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/play.mdx new file mode 100644 index 0000000000..07405553b1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/play.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/play" +title: "Play" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Play" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Play` + +Play adds the play verb. Exactly one of url or urls must be provided; providing both is an error. volume sets the playback volume (-40 to 40, optional). sayVoice, sayLanguage, sayGender configure text-to-speech (optional). autoAnswer controls whether to auto-answer the call (optional). Mirrors Python SWMLBuilder.play(url, urls, volume, say\_voice, say\_language, say\_gender, auto\_answer). + +## Signature + +```go +func (*Service) Play( + url *string, + urls []string, + volume *float64, + sayVoice *string, + sayLanguage *string, + sayGender *string, + autoAnswer *bool +) error +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 665. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/prompt.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/prompt.mdx new file mode 100644 index 0000000000..552918400d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/prompt" +title: "Prompt" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Prompt" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Prompt` + +Prompt adds the prompt verb. + +## Signature + +```go +func (*Service) Prompt(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 872. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/receive-fax.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/receive-fax.mdx new file mode 100644 index 0000000000..e7f26d584b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/receive-fax.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/receive-fax" +title: "ReceiveFax" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.ReceiveFax" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `ReceiveFax` + +ReceiveFax adds the receive\_fax verb. + +## Signature + +```go +func (*Service) ReceiveFax(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 746. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/record-call.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/record-call.mdx new file mode 100644 index 0000000000..9d9d379d4b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/record-call.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/record-call" +title: "RecordCall" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.RecordCall" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `RecordCall` + +RecordCall adds the record\_call verb. + +## Signature + +```go +func (*Service) RecordCall(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 711. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/record.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/record.mdx new file mode 100644 index 0000000000..6131220fdd --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/record.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/record" +title: "Record" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Record" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Record` + +Record adds the record verb. + +## Signature + +```go +func (*Service) Record(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 706. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-additional-routes.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-additional-routes.mdx new file mode 100644 index 0000000000..56fa5f87b1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-additional-routes.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-additional-routes" +title: "RegisterAdditionalRoutes" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.RegisterAdditionalRoutes" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `RegisterAdditionalRoutes` + +RegisterAdditionalRoutes is an extension hook for subclasses (e.g. AgentBase) to mount additional routes (/post\_prompt, /mcp). Default no-op. Composing types call this from their own buildMux equivalent. + +## Signature + +```go +func (*Service) RegisterAdditionalRoutes(mux *http.ServeMux) +``` + +## Parameters + + + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1252. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-routing-callback.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-routing-callback.mdx new file mode 100644 index 0000000000..2aad5ebac2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-routing-callback.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-routing-callback" +title: "RegisterRoutingCallback" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.RegisterRoutingCallback" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `RegisterRoutingCallback` + +RegisterRoutingCallback registers a callback for a specific path. + +## Signature + +```go +func (*Service) RegisterRoutingCallback(path string, cb RoutingCallback) +``` + +## Parameters + + + + + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 986. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-swaig-function.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-swaig-function.mdx new file mode 100644 index 0000000000..9460b79693 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-swaig-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-swaig-function" +title: "RegisterSwaigFunction" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.RegisterSwaigFunction" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `RegisterSwaigFunction` + +RegisterSwaigFunction registers a raw SWAIG function definition (e.g. DataMap tools that have no local handler). The map must contain a "function" key giving the tool name. + +## Signature + +```go +func (*Service) RegisterSwaigFunction(funcDef map[string]any) *Service +``` + +## Parameters + + + +## Returns + +`*Service` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1277. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-verb-handler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-verb-handler.mdx new file mode 100644 index 0000000000..578e8e2629 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-verb-handler.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/register-verb-handler" +title: "RegisterVerbHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.RegisterVerbHandler" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go" +--- +# `RegisterVerbHandler` + +RegisterVerbHandler registers a custom handler for a SWML verb, keyed by the name returned by h.GetVerbName(). A subsequent call with the same verb name replaces the previous handler. This is the Go equivalent of Python's VerbHandlerRegistry.register\_handler. + +## Signature + +```go +func (*Service) RegisterVerbHandler(h VerbHandler) +``` + +## Parameters + + + +## Source + +[`pkg/swml/verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go) + +Line 45. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render-main-swml.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render-main-swml.mdx new file mode 100644 index 0000000000..f9585076af --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render-main-swml.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render-main-swml" +title: "RenderMainSwml" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.RenderMainSwml" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `RenderMainSwml` + +RenderMainSwml is an extension hook invoked for the main route and for GET /swaig. Default returns the currently-built document. AgentBase overrides to render with prompts + dynamic config. + +## Signature + +```go +func (*Service) RenderMainSwml(r *http.Request) map[string]any +``` + +## Parameters + + + +## Returns + +`map[string]any` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1343. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render-pretty.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render-pretty.mdx new file mode 100644 index 0000000000..83308451a3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render-pretty.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render-pretty" +title: "RenderPretty" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.RenderPretty" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `RenderPretty` + +RenderPretty returns the SWML document as an indented JSON string. + +## Signature + +```go +func (*Service) RenderPretty() (string, error) +``` + +## Returns + +`(string, error)` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1044. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render.mdx new file mode 100644 index 0000000000..1a31a357a0 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/render" +title: "Render" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Render" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Render` + +Render returns the SWML document as a JSON string. + +## Signature + +```go +func (*Service) Render() (string, error) +``` + +## Returns + +`(string, error)` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1039. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/request.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/request.mdx new file mode 100644 index 0000000000..1ea5e4d073 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/request.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/request" +title: "Request" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Request" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Request` + +Request adds the request verb (HTTP request). + +## Signature + +```go +func (*Service) Request(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 882. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/reset-document.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/reset-document.mdx new file mode 100644 index 0000000000..47308e56a4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/reset-document.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/reset-document" +title: "ResetDocument" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.ResetDocument" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `ResetDocument` + +ResetDocument resets the SWML document to empty. + +## Signature + +```go +func (*Service) ResetDocument() +``` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 414. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/return.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/return.mdx new file mode 100644 index 0000000000..cc2f0cd1c7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/return.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/return" +title: "Return" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Return" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Return` + +Return adds the return verb. + +## Signature + +```go +func (*Service) Return(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 812. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/routing-callback-paths.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/routing-callback-paths.mdx new file mode 100644 index 0000000000..2a00ad3f66 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/routing-callback-paths.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/routing-callback-paths" +title: "RoutingCallbackPaths" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.RoutingCallbackPaths" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `RoutingCallbackPaths` + +RoutingCallbackPaths returns the paths that have routing callbacks registered. Callers use this to register corresponding HTTP endpoints (mirrors Python web\_mixin.py line 428 which iterates self.\_routing\_callbacks to register callback endpoints on the router). Paths are returned in sorted order for deterministic HTTP registration. + +## Signature + +```go +func (*Service) RoutingCallbackPaths() []string +``` + +## Returns + +`[]string` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 997. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/say.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/say.mdx new file mode 100644 index 0000000000..f839bd120f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/say.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/say" +title: "Say" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Say" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Say` + +Say adds a play verb with a "say:" prefix for text-to-speech. voice, language, and gender configure the TTS voice (optional). volume sets the playback volume (-40 to 40, optional). Mirrors Python SWMLBuilder.say(text, voice, language, gender, volume). + +## Signature + +```go +func (*Service) Say( + text string, + voice *string, + language *string, + gender *string, + volume *float64 +) error +``` + +## Parameters + + + + + + + + + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 700. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/schema-utils.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/schema-utils.mdx new file mode 100644 index 0000000000..994cc1204d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/schema-utils.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/schema-utils" +title: "SchemaUtils" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.SchemaUtils" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `SchemaUtils` + +SchemaUtils returns the SchemaUtils helper bound to this Service. Mirrors Python's “self.schema\_utils“ instance attribute exposed publicly on signalwire.core.swml\_service.SWMLService. + +## Signature + +```go +func (*Service) SchemaUtils() *SchemaUtils +``` + +## Returns + +`*SchemaUtils` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 423. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-digits.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-digits.mdx new file mode 100644 index 0000000000..9de7838325 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-digits.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-digits" +title: "SendDigits" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.SendDigits" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `SendDigits` + +SendDigits adds the send\_digits verb. + +## Signature + +```go +func (*Service) SendDigits(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 731. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-fax.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-fax.mdx new file mode 100644 index 0000000000..2215599d31 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-fax.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-fax" +title: "SendFax" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.SendFax" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `SendFax` + +SendFax adds the send\_fax verb. + +## Signature + +```go +func (*Service) SendFax(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 741. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-sms.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-sms.mdx new file mode 100644 index 0000000000..cb0ac05841 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-sms.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/send-sms" +title: "SendSMS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.SendSMS" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `SendSMS` + +SendSMS adds the send\_sms verb. + +## Signature + +```go +func (*Service) SendSMS(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 736. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/serve.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/serve.mdx new file mode 100644 index 0000000000..4e9027c8f5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/serve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/serve" +title: "Serve" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Serve" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Serve` + +Serve starts the HTTP server. This is a blocking call. + +When TLS is configured via WithTLS (or SWML\_SSL\_CERT\_PATH / SWML\_SSL\_KEY\_PATH env vars), ListenAndServeTLS is called automatically. Mirrors Python's serve() ssl\_cert / ssl\_key / ssl\_enabled parameter support. + +If SWAIG\_LIST\_TOOLS is set in the environment, Serve() does NOT bind a port; instead it prints the registered tool registry sandwiched by **SWAIG\_TOOLS\_BEGIN** / **SWAIG\_TOOLS\_END** sentinels to stdout and exits 0. This is how `swaig-test --example NAME` introspects a SWMLService-only binary without HTTP-walking rendered SWML. + +## Signature + +```go +func (*Service) Serve() error +``` + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1170. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/set.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/set.mdx new file mode 100644 index 0000000000..b241868b91 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/set.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/set" +title: "Set" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Set" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Set` + +Set adds the set verb (set variables). + +## Signature + +```go +func (*Service) Set(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 827. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/sip-refer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/sip-refer.mdx new file mode 100644 index 0000000000..bc0eda6a84 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/sip-refer.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/sip-refer" +title: "SIPRefer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.SIPRefer" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `SIPRefer` + +SIPRefer adds the sip\_refer verb. + +## Signature + +```go +func (*Service) SIPRefer(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 751. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/sleep.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/sleep.mdx new file mode 100644 index 0000000000..7379a17b4f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/sleep.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/sleep" +title: "Sleep" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Sleep" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Sleep` + +Sleep adds the sleep verb. Duration is in milliseconds. + +## Signature + +```go +func (*Service) Sleep(duration int) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 721. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-denoise.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-denoise.mdx new file mode 100644 index 0000000000..990e26afba --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-denoise.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-denoise" +title: "StopDenoise" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.StopDenoise" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `StopDenoise` + +StopDenoise adds the stop\_denoise verb. + +## Signature + +```go +func (*Service) StopDenoise(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 857. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-record-call.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-record-call.mdx new file mode 100644 index 0000000000..c8fad2937a --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-record-call.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-record-call" +title: "StopRecordCall" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.StopRecordCall" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `StopRecordCall` + +StopRecordCall adds the stop\_record\_call verb. + +## Signature + +```go +func (*Service) StopRecordCall(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 716. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-tap.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-tap.mdx new file mode 100644 index 0000000000..9ea6d4c952 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-tap.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop-tap" +title: "StopTap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.StopTap" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `StopTap` + +StopTap adds the stop\_tap verb. + +## Signature + +```go +func (*Service) StopTap(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 847. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop.mdx new file mode 100644 index 0000000000..9167025634 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/stop" +title: "Stop" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Stop" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Stop` + +Stop gracefully stops the HTTP server. + +## Signature + +```go +func (*Service) Stop() error +``` + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1207. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..ce7643d9cb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/swaig-pre-dispatch.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/swaig-pre-dispatch" +title: "SwaigPreDispatch" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.SwaigPreDispatch" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `SwaigPreDispatch` + +SwaigPreDispatch is an extension hook invoked between argument parsing and function dispatch on POST /swaig. It returns a target Service to dispatch on (defaults to s) and an optional short-circuit response. Subclasses (AgentBase) override to add session-token validation or ephemeral dynamic-config copies. + +## Signature + +```go +func (*Service) SwaigPreDispatch(requestData map[string]any, funcName string) (target *Service, shortCircuit map[string]any) +``` + +## Parameters + + + + + +## Returns + +`(*Service, map[string]any)` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 1336. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/switch.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/switch.mdx new file mode 100644 index 0000000000..c3f9aa3af2 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/switch.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/switch" +title: "Switch" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Switch" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Switch` + +Switch adds the switch verb. + +## Signature + +```go +func (*Service) Switch(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 802. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/tap.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/tap.mdx new file mode 100644 index 0000000000..d48b2ceeaa --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/tap.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/tap" +title: "Tap" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Tap" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Tap` + +Tap adds the tap verb (media tapping). + +## Signature + +```go +func (*Service) Tap(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 842. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/tls-enabled.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/tls-enabled.mdx new file mode 100644 index 0000000000..839ef6975d --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/tls-enabled.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/tls-enabled" +title: "TLSEnabled" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.TLSEnabled" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `TLSEnabled` + +TLSEnabled reports whether TLS is configured for this service. Mirrors Python's ssl\_enabled property on SWMLService. + +## Signature + +```go +func (*Service) TLSEnabled() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 548. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/transfer.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/transfer.mdx new file mode 100644 index 0000000000..1591c02771 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/transfer.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/transfer" +title: "Transfer" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Transfer" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Transfer` + +Transfer adds the transfer verb. + +## Signature + +```go +func (*Service) Transfer(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 837. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/unset.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/unset.mdx new file mode 100644 index 0000000000..b91cfa2c4b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/unset.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/unset" +title: "Unset" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.Unset" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `Unset` + +Unset adds the unset verb. + +## Signature + +```go +func (*Service) Unset(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 832. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/user-event.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/user-event.mdx new file mode 100644 index 0000000000..577bedb3ca --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/user-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/user-event" +title: "UserEvent" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.UserEvent" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `UserEvent` + +UserEvent adds the user\_event verb. + +## Signature + +```go +func (*Service) UserEvent(config map[string]any) error +``` + +## Parameters + + + +## Returns + +`error` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 907. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-api-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-api-key.mdx new file mode 100644 index 0000000000..9cf1f58c7b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-api-key.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-api-key" +title: "VerifyAPIKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.VerifyAPIKey" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `VerifyAPIKey` + +VerifyAPIKey performs a timing-safe comparison of the supplied key value against the service's configured API key. Returns false when no API key is configured (i.e. WithAPIKey was not called). + +Callers typically read the key from the header returned by APIKeyHeader(). Mirrors Python AuthHandler.verify\_api\_key(api\_key: str) -> bool. + +## Signature + +```go +func (*Service) VerifyAPIKey(key string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 493. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-basic-auth.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-basic-auth.mdx new file mode 100644 index 0000000000..1c5482ccb7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-basic-auth.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-basic-auth" +title: "VerifyBasicAuth" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.VerifyBasicAuth" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `VerifyBasicAuth` + +VerifyBasicAuth performs a timing-safe comparison of the supplied credentials against the service's configured basic auth username and password. Returns true when both username and password match. + +This exposes the same check that withSecurity applies inside the HTTP middleware, making auth testable in isolation without an HTTP round-trip. Mirrors Python AuthHandler.verify\_basic\_auth(credentials) -> bool using secrets.compare\_digest (equivalent: crypto/subtle.ConstantTimeCompare). + +## Signature + +```go +func (*Service) VerifyBasicAuth(username string, password string) bool +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 462. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-bearer-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-bearer-token.mdx new file mode 100644 index 0000000000..874ff7ada5 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-bearer-token.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/service/verify-bearer-token" +title: "VerifyBearerToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Service.VerifyBearerToken" + parent: "github.com/signalwire/signalwire-go/pkg/swml.Service" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `VerifyBearerToken` + +VerifyBearerToken performs a timing-safe comparison of the supplied token against the service's configured bearer token. Returns false when no bearer token is configured (i.e. WithBearerToken was not called). + +Callers typically extract the token from the "Authorization: Bearer \" header before calling this method. Mirrors Python AuthHandler.verify\_bearer\_token(credentials) -> bool. + +## Signature + +```go +func (*Service) VerifyBearerToken(token string) bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 478. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/tool-definition/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/tool-definition/index.mdx new file mode 100644 index 0000000000..6dbbbc0413 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/tool-definition/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/tool-definition" +title: "ToolDefinition" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.ToolDefinition" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `ToolDefinition` + +ToolDefinition is a SWAIG tool registered on the Service. + +## Signature + +```go +type ToolDefinition struct +``` + +## Properties + + + + + + + + + + + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 26. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/tool-handler.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/tool-handler.mdx new file mode 100644 index 0000000000..1537eec503 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/tool-handler.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/tool-handler" +title: "ToolHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.ToolHandler" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `ToolHandler` + +ToolHandler is the function signature for a registered SWAIG tool. Returns a result that will be JSON-encoded as the SWAIG response. + +## Signature + +```go +type ToolHandler alias +``` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/validate-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/validate-url.mdx new file mode 100644 index 0000000000..e8bf540b07 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/validate-url.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/validate-url" +title: "ValidateURL" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.ValidateURL" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/url_validator.go" +--- +# `ValidateURL` + +ValidateURL reports whether rawURL is safe to fetch (i.e. does not point to a private or internal resource). It returns an error describing why the URL was rejected, or nil if the URL is acceptable. + +Behavior mirrors Python's validate\_url(url, allow\_private=False): + +- Only http and https schemes are accepted. +- A non-empty hostname is required. +- When allowPrivate is false AND the SWML\_ALLOW\_PRIVATE\_URLS env var is not set to "1", "true", or "yes" (case-insensitive), every IP address that the hostname resolves to is checked against the nine blocked CIDR ranges above. If any resolved IP falls in a blocked range the URL is rejected. + +Go idiom: returns (bool, error) instead of a bare bool so callers can log or propagate the rejection reason. Returning (false, nil) never happens — err is always non-nil when the bool is false. + +## Signature + +```go +func ValidateURL(rawURL string, allowPrivate bool) (bool, error) +``` + +## Parameters + + + + + +## Returns + +`(bool, error)` + +## Source + +[`pkg/swml/url_validator.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/url_validator.go) + +Line 73. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/validation-result/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/validation-result/index.mdx new file mode 100644 index 0000000000..07c0d1a937 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/validation-result/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/validation-result" +title: "ValidationResult" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.ValidationResult" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go" +--- +# `ValidationResult` + +ValidationResult mirrors Python's “Tuple\[bool, List\[str]]“ return shape used by ValidateVerb / ValidateDocument. + +The cross-language type alias table maps this struct to the canonical “tuple\>“ so audits accept it as Python-shaped. + +## Signature + +```go +type ValidationResult struct +``` + +## Properties + + + + + +## Source + +[`pkg/swml/schema_utils.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema_utils.go) + +Line 53. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/build-config.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/build-config.mdx new file mode 100644 index 0000000000..7be6dbee59 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/build-config.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/build-config" +title: "BuildConfig" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.VerbHandler.BuildConfig" + parent: "github.com/signalwire/signalwire-go/pkg/swml.VerbHandler" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go" +--- +# `BuildConfig` + +BuildConfig builds a configuration map for this verb from the provided + +parameters. + +params contains keyword arguments specific to this verb, mirroring the +\*\*kwargs pattern from Python. It returns the constructed configuration +map, or an error if the provided parameters are insufficient or +contradictory. + +## Signature + +```go +BuildConfig(params map[string]any) (map[string]any, error) +``` + +## Source + +[`pkg/swml/verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go) + +Line 38. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/get-verb-name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/get-verb-name.mdx new file mode 100644 index 0000000000..023251261c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/get-verb-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/get-verb-name" +title: "GetVerbName" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.VerbHandler.GetVerbName" + parent: "github.com/signalwire/signalwire-go/pkg/swml.VerbHandler" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go" +--- +# `GetVerbName` + +GetVerbName returns the name of the SWML verb this handler handles. + +The returned name must match the verb name used in SWML documents +(e.g., "ai", "play", "record"). + +## Signature + +```go +GetVerbName() string +``` + +## Source + +[`pkg/swml/verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go) + +Line 20. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/index.mdx new file mode 100644 index 0000000000..5245210372 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler" +title: "VerbHandler" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "interface" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.VerbHandler" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go" +--- +# `VerbHandler` + +VerbHandler defines the contract for specialized SWML verb handlers. + +Implementations provide verb-specific validation and configuration-building logic for complex SWML verbs that cannot be handled generically. This is the Go equivalent of the Python SWMLVerbHandler abstract base class. + +## Signature + +```go +type VerbHandler interface { GetVerbName; ValidateConfig; BuildConfig } +``` + +## Methods + + + + BuildConfig builds a configuration map for this verb from the provided + + + + GetVerbName returns the name of the SWML verb this handler handles. + + + + ValidateConfig validates the configuration map for this verb. + + + +## Source + +[`pkg/swml/verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go) + +Line 15. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/validate-config.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/validate-config.mdx new file mode 100644 index 0000000000..f673e791fb --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/validate-config.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-handler/validate-config" +title: "ValidateConfig" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "method" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.VerbHandler.ValidateConfig" + parent: "github.com/signalwire/signalwire-go/pkg/swml.VerbHandler" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go" +--- +# `ValidateConfig` + +ValidateConfig validates the configuration map for this verb. + +config is the configuration dictionary for this verb. It returns +(isValid, errorMessages): isValid is true when the config passes all +validation checks, and errorMessages contains human-readable descriptions +of any validation failures. When isValid is true, errorMessages will be +empty. + +## Signature + +```go +ValidateConfig(config map[string]any) (bool, []string) +``` + +## Source + +[`pkg/swml/verb_handler.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/verb_handler.go) + +Line 29. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-info/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-info/index.mdx new file mode 100644 index 0000000000..99b039be93 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-info/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb-info" +title: "VerbInfo" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "class" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.VerbInfo" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go" +--- +# `VerbInfo` + +VerbInfo holds metadata about a SWML verb extracted from the schema. + +## Signature + +```go +type VerbInfo struct +``` + +## Properties + + + Definition is the raw schema definition for this verb + + + + Name is the actual SWML verb name (e.g., "sip\_refer", "ai", "play") + + + + SchemaName is the PascalCase name from the schema definition (e.g., "SIPRefer", "AI", "Play") + + +## Source + +[`pkg/swml/schema.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/schema.go) + +Line 19. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb.mdx new file mode 100644 index 0000000000..d0b55f8bf1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/verb" +title: "Verb" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "type_alias" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.Verb" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go" +--- +# `Verb` + +Verb represents a single SWML verb (instruction) as a key-value pair. Example: \{"play": \{"url": "https://example.com/audio.mp3"\}\} + +## Signature + +```go +type Verb alias +``` + +## Source + +[`pkg/swml/document.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/document.go) + +Line 23. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-api-key.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-api-key.mdx new file mode 100644 index 0000000000..699b73c19b --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-api-key.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-api-key" +title: "WithAPIKey" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithAPIKey" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithAPIKey` + +WithAPIKey configures API key authentication. When set, the withSecurity middleware accepts requests where the header named by header equals key. header is the HTTP header name (e.g. "X-API-Key"); pass an empty string to use the default "X-API-Key". Mirrors Python's SecurityConfig.api\_key / api\_key\_header fields and the AuthHandler verify\_api\_key / flask\_decorator behaviour. + +## Signature + +```go +func WithAPIKey(key string, header string) ServiceOption +``` + +## Parameters + + + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 184. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-basic-auth.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-basic-auth.mdx new file mode 100644 index 0000000000..fa4688f25c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-basic-auth.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-basic-auth" +title: "WithBasicAuth" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithBasicAuth" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithBasicAuth` + +WithBasicAuth sets explicit basic auth credentials. + +## Signature + +```go +func WithBasicAuth(user string, password string) ServiceOption +``` + +## Parameters + + + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 161. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-bearer-token.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-bearer-token.mdx new file mode 100644 index 0000000000..449a49e0d1 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-bearer-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-bearer-token" +title: "WithBearerToken" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithBearerToken" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithBearerToken` + +WithBearerToken configures Bearer token authentication. When set, the withSecurity middleware accepts requests carrying an "Authorization: Bearer \" header that matches token in addition to (or instead of) Basic Auth. Mirrors Python's SecurityConfig.bearer\_token field and the AuthHandler verify\_bearer\_token / flask\_decorator behaviour. + +## Signature + +```go +func WithBearerToken(token string) ServiceOption +``` + +## Parameters + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 174. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-config-file.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-config-file.mdx new file mode 100644 index 0000000000..063da526cc --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-config-file.mdx @@ -0,0 +1,89 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-config-file" +title: "WithConfigFile" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithConfigFile" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithConfigFile` + +WithConfigFile loads a YAML configuration file and applies its `security` section to the Service. Mirrors Python's SecurityConfig(config\_file=...) loader (signalwire/core/security\_config.py \_load\_config\_file). The expected schema is: + +``` +security: + ssl_cert_path: /path/to/cert.pem + ssl_key_path: /path/to/key.pem + domain: example.com + auth: + basic: + user: alice + password: secret + bearer_token: + api_key: + api_key_header: X-API-Key +``` + +Settings from the file are applied AFTER the explicit WithBasicAuth / WithBearerToken / WithAPIKey / WithTLS / WithDomain options, so config-file values take precedence (matching Python's documented load order). If the file cannot be read or parsed, NewService logs a warning and keeps running with the previously-set values; this matches Python's "best-effort" load behaviour and avoids crashing services whose config is missing. + +## Signature + +```go +func WithConfigFile(path string) ServiceOption +``` + +## Parameters + + + +## Returns + +`ServiceOption` + +## Examples + + + + ```go + security: + ssl_cert_path: /path/to/cert.pem + ssl_key_path: /path/to/key.pem + domain: example.com + auth: + basic: + user: alice + password: secret + bearer_token: + api_key: + api_key_header: X-API-Key + ``` + + + + ```go + security: + ssl_cert_path: /path/to/cert.pem + ssl_key_path: /path/to/key.pem + domain: example.com + auth: + basic: + user: alice + password: secret + bearer_token: + api_key: + api_key_header: X-API-Key + ``` + + + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 267. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-domain.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-domain.mdx new file mode 100644 index 0000000000..e0577e1ed7 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-domain.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-domain" +title: "WithDomain" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithDomain" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithDomain` + +WithDomain sets the domain name used in URL generation when TLS is enabled. Mirrors Python's SecurityConfig.domain / SWML\_DOMAIN env var. + +## Signature + +```go +func WithDomain(domain string) ServiceOption +``` + +## Parameters + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 232. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-host.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-host.mdx new file mode 100644 index 0000000000..fc6ffe16c3 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-host.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-host" +title: "WithHost" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithHost" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithHost` + +WithHost sets the HTTP server bind host. + +## Signature + +```go +func WithHost(host string) ServiceOption +``` + +## Parameters + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 151. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-name.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-name.mdx new file mode 100644 index 0000000000..98e48037b6 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-name.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-name" +title: "WithName" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithName" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithName` + +WithName sets the service name. + +## Signature + +```go +func WithName(name string) ServiceOption +``` + +## Parameters + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 141. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-port.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-port.mdx new file mode 100644 index 0000000000..efbad64dda --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-port.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-port" +title: "WithPort" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithPort" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithPort` + +WithPort sets the HTTP server port. + +## Signature + +```go +func WithPort(port int) ServiceOption +``` + +## Parameters + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 156. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-route.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-route.mdx new file mode 100644 index 0000000000..422d3769ff --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-route.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-route" +title: "WithRoute" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithRoute" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithRoute` + +WithRoute sets the HTTP route path. + +## Signature + +```go +func WithRoute(route string) ServiceOption +``` + +## Parameters + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 146. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-schema-path.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-schema-path.mdx new file mode 100644 index 0000000000..a232196266 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-schema-path.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-schema-path" +title: "WithSchemaPath" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithSchemaPath" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithSchemaPath` + +WithSchemaPath overrides the schema file path used for verb validation. By default the embedded schema.json is used. Pass a custom path when testing or when deploying a modified schema alongside your binary. Mirrors Python's schema\_path constructor parameter. + +## Signature + +```go +func WithSchemaPath(path string) ServiceOption +``` + +## Parameters + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 240. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-schema-validation.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-schema-validation.mdx new file mode 100644 index 0000000000..8df90ef254 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-schema-validation.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-schema-validation" +title: "WithSchemaValidation" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithSchemaValidation" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithSchemaValidation` + +WithSchemaValidation enables or disables SWML schema validation. Defaults to true (validation on). Set to false, or export SWML\_SKIP\_SCHEMA\_VALIDATION=1, to bypass schema checks. Mirrors Python's schema\_validation constructor parameter. + +## Signature + +```go +func WithSchemaValidation(enabled bool) ServiceOption +``` + +## Parameters + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 280. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-security-config.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-security-config.mdx new file mode 100644 index 0000000000..b366231d06 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-security-config.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-security-config" +title: "WithSecurityConfig" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithSecurityConfig" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithSecurityConfig` + +WithSecurityConfig applies a SecurityConfig bundle, setting Basic Auth, Bearer token, and API key configuration in one call. This is the Go equivalent of Python's AuthHandler(security\_config=...) pattern: it maps each SecurityConfig field to the corresponding WithXxx option. + +## Signature + +```go +func WithSecurityConfig(cfg SecurityConfig) ServiceOption +``` + +## Parameters + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 198. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-tls.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-tls.mdx new file mode 100644 index 0000000000..d10c2bc27f --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-tls.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml/with-tls" +title: "WithTLS" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/swml.WithTLS" + parent: "github.com/signalwire/signalwire-go/pkg/swml" + module: "github.com.signalwire.signalwire-go.pkg.swml" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go" +--- +# `WithTLS` + +WithTLS configures TLS for the service. When set, Serve() calls ListenAndServeTLS instead of ListenAndServe. Mirrors Python's ssl\_cert / ssl\_key serve() parameters and ssl\_enabled property. + +## Signature + +```go +func WithTLS(certFile string, keyFile string) ServiceOption +``` + +## Parameters + + + + + +## Returns + +`ServiceOption` + +## Source + +[`pkg/swml/service.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/swml/service.go) + +Line 223. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/get-execution-mode.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/get-execution-mode.mdx new file mode 100644 index 0000000000..da0c1caf3c --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/get-execution-mode.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/util/util/get-execution-mode" +title: "GetExecutionMode" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/util.GetExecutionMode" + parent: "github.com/signalwire/signalwire-go/pkg/util" + module: "github.com.signalwire.signalwire-go.pkg.util" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/util/execution_mode.go" +--- +# `GetExecutionMode` + +GetExecutionMode reports the SDK's deployment environment based on well-known environment variables. Returned values are: "cgi", "lambda", "google\_cloud\_function", "azure\_function", "server". + +## Signature + +```go +func GetExecutionMode() string +``` + +## Returns + +`string` + +## Source + +[`pkg/util/execution_mode.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/util/execution_mode.go) + +Line 26. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/index.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/index.mdx new file mode 100644 index 0000000000..38ce8b81ac --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/util/util" +title: "util" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "module" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/util" + module: "github.com.signalwire.signalwire-go.pkg.util" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/util/execution_mode.go" +--- +# `util` + +Package util provides cross-cutting helpers used across the Go SDK. + +validate\_url is the SSRF-prevention guard applied to user-supplied URLs before they are fetched. It must mirror the Python reference at signalwire.utils.url\_validator.validate\_url: + +- require http or https scheme +- require a hostname +- allow\_private bypass (param OR SWML\_ALLOW\_PRIVATE\_URLS env var) +- resolve hostname; reject any IP that lands in a blocked network + +The blocked-network list is identical across all SDK ports. + +## Signature + +```go +package util +``` + +## Functions + + + + GetExecutionMode reports the SDK's deployment environment based on well-known environment variables. Returned values are: "cgi", "lambda", "google\_cloud\_function", "azure\_function", "server". + + + + IsServerlessMode reports whether the SDK is running in any serverless invocation environment (i.e. not "server"). + + + + ValidateURL reports whether the supplied URL is safe to fetch. + + + +## Source + +[`pkg/util/execution_mode.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/util/execution_mode.go) diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/is-serverless-mode.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/is-serverless-mode.mdx new file mode 100644 index 0000000000..8433d7d117 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/is-serverless-mode.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/util/util/is-serverless-mode" +title: "IsServerlessMode" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/util.IsServerlessMode" + parent: "github.com/signalwire/signalwire-go/pkg/util" + module: "github.com.signalwire.signalwire-go.pkg.util" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/util/execution_mode.go" +--- +# `IsServerlessMode` + +IsServerlessMode reports whether the SDK is running in any serverless invocation environment (i.e. not "server"). + +## Signature + +```go +func IsServerlessMode() bool +``` + +## Returns + +`bool` + +## Source + +[`pkg/util/execution_mode.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/util/execution_mode.go) + +Line 48. diff --git a/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/validate-url.mdx b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/validate-url.mdx new file mode 100644 index 0000000000..703fbce9e4 --- /dev/null +++ b/fern/products/sdk-reference/go/github.com/signalwire/signalwire-go/pkg/util/util/validate-url.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/go/github.com/signalwire/signalwire-go/pkg/util/util/validate-url" +title: "ValidateURL" +sdk_label: "Go SDK" +icon: "golang" +lustri: + auto_generated: true + kind: "function" + language: "go" + qualified_name: "github.com/signalwire/signalwire-go/pkg/util.ValidateURL" + parent: "github.com/signalwire/signalwire-go/pkg/util" + module: "github.com.signalwire.signalwire-go.pkg.util" + source_url: "https://github.com/signalwire/signalwire-go/blob/main/pkg/util/url_validator.go" +--- +# `ValidateURL` + +ValidateURL reports whether the supplied URL is safe to fetch. + +Mirrors Python's validate\_url(url, allow\_private=False) -> bool. Returns false (without raising) for any of: + +- parse failure +- scheme not http/https +- missing hostname +- DNS resolution failure +- any resolved IP in a blocked network + +When allowPrivate is true, or the SWML\_ALLOW\_PRIVATE\_URLS env var is set to "1", "true" or "yes" (case-insensitive), the IP-blocklist check is skipped. Scheme + hostname checks still apply. + +This function is projected onto the Python free function name validate\_url via internal/surface/tables.go. + +## Signature + +```go +func ValidateURL(url_ string, allowPrivate bool) bool +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`pkg/util/url_validator.go`](https://github.com/signalwire/signalwire-go/blob/main/pkg/util/url_validator.go) + +Line 73. diff --git a/fern/products/sdk-reference/go/index.mdx b/fern/products/sdk-reference/go/index.mdx new file mode 100644 index 0000000000..150c6a6ab9 --- /dev/null +++ b/fern/products/sdk-reference/go/index.mdx @@ -0,0 +1,55 @@ +--- +title: "Go SDK" +slug: "/reference/go" +lustri: + auto_generated: true + language: "go" + kind: "sdk" +--- +# Go SDK Reference + +## Modules + +- [`agent`](/reference/go/github.com/signalwire/signalwire-go/pkg/agent/agent) +- [`builtin`](/reference/go/github.com/signalwire/signalwire-go/pkg/skills/builtin/builtin) +- [`contexts`](/reference/go/github.com/signalwire/signalwire-go/pkg/contexts/contexts) +- [`datamap`](/reference/go/github.com/signalwire/signalwire-go/pkg/datamap/datamap) +- [`lambda`](/reference/go/github.com/signalwire/signalwire-go/pkg/lambda/lambda) +- [`livewire`](/reference/go/github.com/signalwire/signalwire-go/pkg/livewire/livewire) +- [`logging`](/reference/go/github.com/signalwire/signalwire-go/pkg/logging/logging) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-signatures/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/cmd/enumerate-surface/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/cmd/swaig-test/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/call-flow/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/contexts-demo/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/datamap-demo/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/gather-per-question-functions-demo/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/livewire-agent/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/mcp-agent/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/multi-agent-server/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/prefab-info-gatherer/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/prefab-survey/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/relay-audit-harness/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/relay-demo/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/rest-audit-harness/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/rest-demo/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/session-state/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/simple-agent/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/simple-dynamic-agent/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/skills-audit-harness/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/skills-demo/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/step-function-inheritance-demo/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/swmlservice-ai-sidecar/main) +- [`main`](/reference/go/github.com/signalwire/signalwire-go/examples/swmlservice-swaig-standalone/main) +- [`namespaces`](/reference/go/github.com/signalwire/signalwire-go/pkg/rest/namespaces/namespaces) +- [`pom`](/reference/go/github.com/signalwire/signalwire-go/pkg/pom/pom) +- [`prefabs`](/reference/go/github.com/signalwire/signalwire-go/pkg/prefabs/prefabs) +- [`relay`](/reference/go/github.com/signalwire/signalwire-go/pkg/relay/relay) +- [`rest`](/reference/go/github.com/signalwire/signalwire-go/pkg/rest/rest) +- [`security`](/reference/go/github.com/signalwire/signalwire-go/pkg/security/security) +- [`server`](/reference/go/github.com/signalwire/signalwire-go/pkg/server/server) +- [`skills`](/reference/go/github.com/signalwire/signalwire-go/pkg/skills/skills) +- [`swaig`](/reference/go/github.com/signalwire/signalwire-go/pkg/swaig/swaig) +- [`swml`](/reference/go/github.com/signalwire/signalwire-go/pkg/swml/swml) +- [`util`](/reference/go/github.com/signalwire/signalwire-go/pkg/util/util) + diff --git a/fern/products/sdk-reference/java/_meta.json b/fern/products/sdk-reference/java/_meta.json new file mode 100644 index 0000000000..f8f7c5d3aa --- /dev/null +++ b/fern/products/sdk-reference/java/_meta.json @@ -0,0 +1,10 @@ +{ + "language": "java", + "sdk_name": "java-sdk", + "version": null, + "source_repo": "https://github.com/signalwire/signalwire-java", + "format": "mdx", + "platform": "fern", + "base_slug": "/reference/java", + "item_count": 1774 +} \ No newline at end of file diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-answer-verb.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-answer-verb.mdx new file mode 100644 index 0000000000..206ca207f9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-answer-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-answer-verb" +title: "addAnswerVerb" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addAnswerVerb" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addAnswerVerb` + +## Signature + +```java +public AgentBase addAnswerVerb(String verbName, Object verbData) +``` + +## Parameters + + + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 967. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-function-include.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-function-include.mdx new file mode 100644 index 0000000000..a6d289c55a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-function-include.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-function-include" +title: "addFunctionInclude" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addFunctionInclude" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addFunctionInclude` + +## Signature + +```java +public AgentBase addFunctionInclude(String url, Map functions) +``` + +## Parameters + + + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 930. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-hint.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-hint.mdx new file mode 100644 index 0000000000..cf8bcbda0d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-hint.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-hint" +title: "addHint" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addHint" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addHint` + +## Signature + +```java +public AgentBase addHint(String hint) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 662. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-hints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-hints.mdx new file mode 100644 index 0000000000..64ec237d87 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-hints" +title: "addHints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addHints" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addHints` + +## Signature + +```java +public AgentBase addHints(List newHints) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 667. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-internal-filler.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-internal-filler.mdx new file mode 100644 index 0000000000..d198492cdc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-internal-filler.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-internal-filler" +title: "addInternalFiller" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addInternalFiller" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addInternalFiller` + +Add internal fillers for a single internal function and language. + +<p>See `#setInternalFillersMap(java.util.Map)` for the complete +list of supported function names and an explanation of what fillers +do. + +Names outside the supported set log a warning and are stored, but +the runtime will not play them. + +## Signature + + + + ```java + public AgentBase addInternalFiller(String text, String file) + ``` + + + + ```java + public AgentBase addInternalFiller( + String functionName, + String languageCode, + List fillers + ) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + one of `#SUPPORTED_INTERNAL_FILLER_NAMES`. + + + + BCP-47 language code (e.g. `"en-US"`). + + + + phrases to speak while the function runs. + + +## Returns (Overload 1) + +`AgentBase` + +## Returns (Overload 2) + +`AgentBase` — this agent for chaining. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 888. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-language.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-language.mdx new file mode 100644 index 0000000000..304884bffd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-language.mdx @@ -0,0 +1,117 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-language" +title: "addLanguage" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addLanguage" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addLanguage` + +Add a language configuration with an optional per-language `params` +dict (engine-specific tuning, voice settings, etc.). + +The `params` +key is only emitted into SWML when non-empty so existing language +entries stay byte-identical when no params are passed. +Mirrors Python's add\_language(params=...) addition. + +## Signature + + + + ```java + public AgentBase addLanguage(String name, String code, String voice) + ``` + + + + ```java + public AgentBase addLanguage( + String name, + String code, + String voice, + String speechModel, + String fillerWord, + String engine + ) + ``` + + + + ```java + public AgentBase addLanguage( + String name, + String code, + String voice, + String speechModel, + String fillerWord, + String engine, + Map params + ) + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Parameters (Overload 2) + + + + + + + + + + + + + +## Parameters (Overload 3) + + + + + + + + + + + + + + + +## Returns (Overload 1) + +`AgentBase` + +## Returns (Overload 2) + +`AgentBase` + +## Returns (Overload 3) + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 677. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-mcp-server.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-mcp-server.mdx new file mode 100644 index 0000000000..e1201271f4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-mcp-server.mdx @@ -0,0 +1,92 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-mcp-server" +title: "addMcpServer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addMcpServer" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addMcpServer` + +Add an external MCP server for tool discovery and invocation. +Tools are discovered via MCP protocol at session start and added to SWAIG. + +## Signature + + + + ```java + public AgentBase addMcpServer( + String url, + Map headers, + boolean resources, + Map resourceVars + ) + ``` + + + + ```java + public AgentBase addMcpServer(String url) + ``` + + + + ```java + public AgentBase addMcpServer(String url, Map headers) + ``` + + + +## Parameters (Overload 1) + + + MCP server HTTP endpoint URL + + + + Optional HTTP headers (e.g. Authorization) + + + + Whether to fetch resources into global\_data + + + + Variables for URI template substitution + + +## Parameters (Overload 2) + + + +## Parameters (Overload 3) + + + + + +## Returns (Overload 1) + +`AgentBase` — this for chaining + +## Returns (Overload 2) + +`AgentBase` + +## Returns (Overload 3) + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1102. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pattern-hint.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pattern-hint.mdx new file mode 100644 index 0000000000..4a8fb70960 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pattern-hint.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pattern-hint" +title: "addPatternHint" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addPatternHint" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addPatternHint` + +## Signature + +```java +public AgentBase addPatternHint(String pattern) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 672. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-post-ai-verb.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-post-ai-verb.mdx new file mode 100644 index 0000000000..b7ac50413d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-post-ai-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-post-ai-verb" +title: "addPostAiVerb" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addPostAiVerb" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addPostAiVerb` + +## Signature + +```java +public AgentBase addPostAiVerb(String verbName, Object verbData) +``` + +## Parameters + + + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 981. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-post-answer-verb.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-post-answer-verb.mdx new file mode 100644 index 0000000000..715f12368d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-post-answer-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-post-answer-verb" +title: "addPostAnswerVerb" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addPostAnswerVerb" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addPostAnswerVerb` + +## Signature + +```java +public AgentBase addPostAnswerVerb(String verbName, Object verbData) +``` + +## Parameters + + + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 974. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pre-answer-verb.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..0ce3512c70 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pre-answer-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pre-answer-verb" +title: "addPreAnswerVerb" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addPreAnswerVerb" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addPreAnswerVerb` + +## Signature + +```java +public AgentBase addPreAnswerVerb(String verbName, Object verbData) +``` + +## Parameters + + + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 960. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pronunciation.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pronunciation.mdx new file mode 100644 index 0000000000..a1a89bb859 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pronunciation.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-pronunciation" +title: "addPronunciation" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addPronunciation" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addPronunciation` + +## Signature + +```java +public AgentBase addPronunciation( + String replace, + String with, + boolean ignoreCase +) +``` + +## Parameters + + + + + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 751. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-skill.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-skill.mdx new file mode 100644 index 0000000000..6633877c0c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-skill.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-skill" +title: "addSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addSkill" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addSkill` + +## Signature + +```java +public AgentBase addSkill(String skillName, Map params) +``` + +## Parameters + + + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1031. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-swaig-query-params.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-swaig-query-params.mdx new file mode 100644 index 0000000000..a826b4d469 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/add-swaig-query-params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/add-swaig-query-params" +title: "addSwaigQueryParams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.addSwaigQueryParams" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `addSwaigQueryParams` + +## Signature + +```java +public AgentBase addSwaigQueryParams(Map params) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1073. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/build-mcp-tool-list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/build-mcp-tool-list.mdx new file mode 100644 index 0000000000..5e24703b7a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/build-mcp-tool-list.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/build-mcp-tool-list" +title: "buildMcpToolList" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.buildMcpToolList" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `buildMcpToolList` + +Build MCP tool list from registered tools. + +## Signature + +```java +public List> buildMcpToolList() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1161. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder.mdx new file mode 100644 index 0000000000..e40fe308cc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder" +title: "builder" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.builder" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `builder` + +**Modifiers:** `static` + +## Signature + +```java +public static Builder builder() +``` + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 158. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auth-password.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auth-password.mdx new file mode 100644 index 0000000000..a26afa8ade --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auth-password.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auth-password" +title: "authPassword" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.authPassword" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `authPassword` + +## Signature + +```java +public Builder authPassword(String password) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 193. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auth-user.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auth-user.mdx new file mode 100644 index 0000000000..5440d99540 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auth-user.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auth-user" +title: "authUser" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.authUser" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `authUser` + +## Signature + +```java +public Builder authUser(String user) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 192. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auto-answer.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auto-answer.mdx new file mode 100644 index 0000000000..2d5bce8f6f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auto-answer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/auto-answer" +title: "autoAnswer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.autoAnswer" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `autoAnswer` + +## Signature + +```java +public Builder autoAnswer(boolean autoAnswer) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 187. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/build.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/build.mdx new file mode 100644 index 0000000000..7ede1fd35e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/build.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/build" +title: "build" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.build" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `build` + +## Signature + +```java +public AgentBase build() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 256. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/env-provider.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/env-provider.mdx new file mode 100644 index 0000000000..03ecc24595 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/env-provider.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/env-provider" +title: "envProvider" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.envProvider" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `envProvider` + +Supply an alternative `EnvProvider` for the build-time env +var reads (`SWML_BASIC_AUTH_USER`, `SWML_BASIC_AUTH_PASSWORD`, +`SWML_PROXY_URL_BASE`). + +<p>Primarily for the --simulate-serverless +harness, which needs to mask the real process env with simulated +values without mutating `System#getenv()` (which Java does +not support). + +Pass `null` to fall back to the real process +env (the default). + +## Signature + +```java +public Builder envProvider(EnvProvider env) +``` + +## Parameters + + + environment source. + + +## Returns + +`Builder` — this builder. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 251. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/host.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/host.mdx new file mode 100644 index 0000000000..7682c8d4a8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/host.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/host" +title: "host" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.host" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `host` + +## Signature + +```java +public Builder host(String host) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 185. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/index.mdx new file mode 100644 index 0000000000..59e295418f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder" +title: "Builder" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `Builder` + +**Modifiers:** `static` + +## Signature + +```java +public static class Builder +``` + +## Methods + + + + + + + + + + + + + + Supply an alternative `EnvProvider` for the build-time env var reads (`SWML_BASIC_AUTH_USER`, `SWML_BASIC_AUTH_PASSWORD`, `SWML_PROXY_URL_BASE`). <p>Primarily for the --simulate-serverless harness, which needs to mask the real process env with simulated values without mutating `System#getenv()` (which Java does not support). + + + + + + + + + + + + + + + + + + + + Configure the customer's SignalWire Signing Key from the Dashboard (API Credentials → Signing Key). + + + + When set to `true`, the webhook URL reconstruction honors `X-Forwarded-Proto` / `X-Forwarded-Host` headers during signature validation. + + + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 162. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/init.mdx new file mode 100644 index 0000000000..8dad37560e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder." + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/max-duration.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/max-duration.mdx new file mode 100644 index 0000000000..dad5313bbd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/max-duration.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/max-duration" +title: "maxDuration" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.maxDuration" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `maxDuration` + +## Signature + +```java +public Builder maxDuration(int maxDuration) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 188. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/name.mdx new file mode 100644 index 0000000000..8bd2186d79 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/name.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/name" +title: "name" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.name" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `name` + +## Signature + +```java +public Builder name(String name) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 179. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/port.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/port.mdx new file mode 100644 index 0000000000..686fda8c17 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/port.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/port" +title: "port" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.port" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `port` + +## Signature + +```java +public Builder port(int port) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 186. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-call.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-call.mdx new file mode 100644 index 0000000000..4b5cf22920 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-call" +title: "recordCall" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.recordCall" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `recordCall` + +## Signature + +```java +public Builder recordCall(boolean recordCall) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 189. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-format.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-format.mdx new file mode 100644 index 0000000000..82c4cd96dc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-format.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-format" +title: "recordFormat" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.recordFormat" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `recordFormat` + +## Signature + +```java +public Builder recordFormat(String format) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 190. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-stereo.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-stereo.mdx new file mode 100644 index 0000000000..7aec2b636c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-stereo.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/record-stereo" +title: "recordStereo" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.recordStereo" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `recordStereo` + +## Signature + +```java +public Builder recordStereo(boolean stereo) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 191. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/route.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/route.mdx new file mode 100644 index 0000000000..c44ed46d68 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/route.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/route" +title: "route" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.route" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `route` + +## Signature + +```java +public Builder route(String route) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 180. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/signing-key.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/signing-key.mdx new file mode 100644 index 0000000000..fccc1274ff --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/signing-key.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/signing-key" +title: "signingKey" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.signingKey" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `signingKey` + +Configure the customer's SignalWire Signing Key from the Dashboard +(API Credentials → Signing Key). + +When set, the agent enforces +webhook signature validation on POST `/`, `/swaig`, +and `/post_prompt` — unsigned or invalidly-signed requests +are rejected with HTTP 403. + +<p>Resolution order at `#build()` time: +<ol> + <li>Explicit `signingKey(...)` on the builder.</li> + <li>`SIGNALWIRE_SIGNING_KEY` environment variable.</li> + <li>Unset → validation disabled, with a startup warning.</li> +</ol> + +## Signature + +```java +public Builder signingKey(String key) +``` + +## Parameters + + + the Signing Key. Pass `null` to fall through to env-var resolution. + + +## Returns + +`Builder` — this builder. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 217. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/trust-proxy-for-signature.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/trust-proxy-for-signature.mdx new file mode 100644 index 0000000000..979093fe5c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/trust-proxy-for-signature.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/builder/trust-proxy-for-signature" +title: "trustProxyForSignature" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.Builder.trustProxyForSignature" + parent: "com.signalwire.sdk.agent.AgentBase.Builder" + module: "com.signalwire.sdk.agent.AgentBase.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `trustProxyForSignature` + +When set to `true`, the webhook URL reconstruction honors +`X-Forwarded-Proto` / `X-Forwarded-Host` headers +during signature validation. + +Default `false` — proxy +headers are spoofable, so opt in only when you control the +proxy chain. + +## Signature + +```java +public Builder trustProxyForSignature(boolean trust) +``` + +## Parameters + + + whether to trust proxy headers. + + +## Returns + +`Builder` — this builder. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 232. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..9e9279f14f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-post-ai-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-post-ai-verbs" +title: "clearPostAiVerbs" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.clearPostAiVerbs" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `clearPostAiVerbs` + +## Signature + +```java +public AgentBase clearPostAiVerbs() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 990. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..1995a2810e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-post-answer-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-post-answer-verbs" +title: "clearPostAnswerVerbs" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.clearPostAnswerVerbs" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `clearPostAnswerVerbs` + +## Signature + +```java +public AgentBase clearPostAnswerVerbs() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 989. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..cf3a3d92c3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-pre-answer-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-pre-answer-verbs" +title: "clearPreAnswerVerbs" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.clearPreAnswerVerbs" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `clearPreAnswerVerbs` + +## Signature + +```java +public AgentBase clearPreAnswerVerbs() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 988. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-swaig-query-params.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..5b1ec317a3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-swaig-query-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/clear-swaig-query-params" +title: "clearSwaigQueryParams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.clearSwaigQueryParams" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `clearSwaigQueryParams` + +## Signature + +```java +public AgentBase clearSwaigQueryParams() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1078. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clone.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clone.mdx new file mode 100644 index 0000000000..a123526dee --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/clone.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/clone" +title: "clone" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.clone" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `clone` + +Create a deep copy of this agent for per-request customization. + +## Signature + +```java +public AgentBase clone() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1708. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/contexts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/contexts.mdx new file mode 100644 index 0000000000..8a8aede495 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/contexts" +title: "contexts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.contexts" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `contexts` + +## Signature + +```java +public ContextBuilder contexts() +``` + +## Returns + +`ContextBuilder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1008. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/create-tool-token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/create-tool-token.mdx new file mode 100644 index 0000000000..355b2c2d47 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/create-tool-token.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/create-tool-token" +title: "createToolToken" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.createToolToken" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `createToolToken` + +Mint a per-call SWAIG-function token via the agent's SessionManager. + +<p>Python parity: `state_mixin.StateMixin._create_tool_token`. +Returns an empty string when the underlying SessionManager throws +(Python catches all exceptions and returns "" on error). + +## Signature + +```java +public String createToolToken(String toolName, String callId) +``` + +## Parameters + + + + + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 631. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/define-contexts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/define-contexts.mdx new file mode 100644 index 0000000000..7c58d59272 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/define-contexts.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/define-contexts" +title: "defineContexts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.defineContexts" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `defineContexts` + +Define or return the ContextBuilder for this agent. + +The builder is +wired to report registered SWAIG tool names back so that its +`validate()` can check for collisions with reserved native tool +names (`next_step`, `change_context`, `gather_submit`). + +## Signature + +```java +public ContextBuilder defineContexts() +``` + +## Returns + +`ContextBuilder` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1002. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/define-tool.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/define-tool.mdx new file mode 100644 index 0000000000..c70b3c0fa9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/define-tool.mdx @@ -0,0 +1,127 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/define-tool" +title: "defineTool" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.defineTool" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `defineTool` + +Register a SWAIG tool (function) that the AI can invoke during a call. + +<h3>How this becomes a tool the model sees</h3> + +<p>A SWAIG function is <b>exactly the same concept</b> as a "tool" in +native OpenAI / Anthropic tool calling. + +On every LLM turn, the SDK +renders each registered SWAIG function into the OpenAI tool schema: + +<pre>"type": "function", + "function": { + "name": "your_name_here", + "description": "your description text", + "parameters": { ... your JSON schema ... + } +} +}</pre> + +<p>That schema is sent to the model as part of the same API call that +produces the next assistant message. The model reads: +<ul> + <li>the function `description` to decide WHEN to call this tool</li> + <li>each parameter `description` (inside parameters) to decide + HOW to fill in that argument from the user's utterance</li> +</ul> + +<p>This means <b>descriptions are prompt engineering</b>, not developer +comments. A vague description is the #1 cause of "the model has the +right tool but doesn't call it" failures. + +<h3>Bad vs good descriptions</h3> +<pre>: description: "Lookup function" +GOOD: description: "Look up a customer's account details by account " + + "number. Use this BEFORE quoting any account-" + + "specific info (balance, plan, status). Do not " + + "use for general product questions." + +BAD : parameters : Map.of("id", Map.of("type", "string", +"description", "the id")) +GOOD: parameters : Map.of("account\_number", Map.of("type", "string", +"description", "The customer's 8-digit account " +\+ "number, no dashes or spaces. Ask the user if " +\+ "they don't provide it."))</pre> + +<h3>Tool count matters</h3> + +<p>LLM tool selection accuracy degrades past ~7-8 simultaneously-active +tools per call. Use `com.signalwire.sdk.contexts.Step#setFunctions(Object)` +to partition tools across steps so only the relevant subset is active +at any moment. + +**Decorators:** `@Override` + +## Signature + + + + ```java + public AgentBase defineTool( + String name, + String description, + Map parameters, + ToolHandler handler + ) + ``` + + + + ```java + public AgentBase defineTool(ToolDefinition toolDef) + ``` + + + +## Parameters (Overload 1) + + + the function name (snake\_case verb recommended). + + + + LLM-facing description of when to call this tool. + + + + JSON-schema properties map with LLM-facing descriptions for each parameter. + + + + the Java handler invoked when the model calls this tool. + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`AgentBase` + +## Returns (Overload 2) + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 566. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/define-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/define-tools.mdx new file mode 100644 index 0000000000..3db99cfe1e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/define-tools.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/define-tools" +title: "defineTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.defineTools" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `defineTools` + +**Decorators:** `@Override` + +## Signature + +```java +public AgentBase defineTools(List toolDefs) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 585. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/detect-serverless-base-url.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/detect-serverless-base-url.mdx new file mode 100644 index 0000000000..2114606fd0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/detect-serverless-base-url.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/detect-serverless-base-url" +title: "detectServerlessBaseUrl" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.detectServerlessBaseUrl" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `detectServerlessBaseUrl` + +Resolve a base URL from environment variables alone (proxy or +serverless platform). + +Returns `null` if no suitable env +vars are set. + +<p>This is used by both the HTTP server path (when no proxy is +manually set) and by non-HTTP transports such as the Lambda +adapter, so they agree on the origin to use for webhook URLs. + +<p>The returned origin is a bare scheme + host(:port) with NO +route appended — callers must layer their route on top via +`#buildWebhookUrl(String)` and the post-prompt URL builder. +This matters: it is how we guarantee that the agent's route +always appears in webhook URLs regardless of which source +produced the base. + +## Signature + + + + ```java + public String detectServerlessBaseUrl() + ``` + + + + ```java + public String detectServerlessBaseUrl(EnvProvider env) + ``` + + + +## Parameters (Overload 2) + + + environment variable source. + + +## Returns (Overload 1) + +`String` — base URL, or `null`. + +## Returns (Overload 2) + +`String` — base URL, or `null`. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1826. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/dynamic-config-callback/configure.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/dynamic-config-callback/configure.mdx new file mode 100644 index 0000000000..f8bbc8b295 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/dynamic-config-callback/configure.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/dynamic-config-callback/configure" +title: "configure" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.DynamicConfigCallback.configure" + parent: "com.signalwire.sdk.agent.AgentBase.DynamicConfigCallback" + module: "com.signalwire.sdk.agent.AgentBase.DynamicConfigCallback" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `configure` + +## Signature + +```java +void configure( + Map queryParams, + Map bodyParams, + Map> headers, + AgentBase agent +) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 2071. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/dynamic-config-callback/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/dynamic-config-callback/index.mdx new file mode 100644 index 0000000000..671901d2ab --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/dynamic-config-callback/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/dynamic-config-callback" +title: "DynamicConfigCallback" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "interface" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.DynamicConfigCallback" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `DynamicConfigCallback` + +**Decorators:** `@FunctionalInterface` + +## Signature + +```java +public interface DynamicConfigCallback +``` + +## Methods + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 2069. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-debug-events.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-debug-events.mdx new file mode 100644 index 0000000000..0db8a4e35b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-debug-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-debug-events" +title: "enableDebugEvents" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.enableDebugEvents" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `enableDebugEvents` + +## Signature + +```java +public AgentBase enableDebugEvents() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 925. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-debug-routes.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-debug-routes.mdx new file mode 100644 index 0000000000..1954ca22a2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-debug-routes.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-debug-routes" +title: "enableDebugRoutes" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.enableDebugRoutes" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `enableDebugRoutes` + +## Signature + +```java +public AgentBase enableDebugRoutes() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1083. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-mcp-server.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-mcp-server.mdx new file mode 100644 index 0000000000..45205f3921 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-mcp-server.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-mcp-server" +title: "enableMcpServer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.enableMcpServer" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `enableMcpServer` + +Expose this agent's tools as an MCP server endpoint at /mcp. +Adds a JSON-RPC 2.0 endpoint that MCP clients can connect to. + +## Signature + +```java +public AgentBase enableMcpServer() +``` + +## Returns + +`AgentBase` — this for chaining + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1139. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-sip-routing.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-sip-routing.mdx new file mode 100644 index 0000000000..d483994089 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-sip-routing.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/enable-sip-routing" +title: "enableSipRouting" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.enableSipRouting" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `enableSipRouting` + +## Signature + +```java +public AgentBase enableSipRouting() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1264. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/extract-sip-username.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/extract-sip-username.mdx new file mode 100644 index 0000000000..5839f85cf4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/extract-sip-username.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/extract-sip-username" +title: "extractSipUsername" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.extractSipUsername" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `extractSipUsername` + +Extract the username portion from a SIP URI. + +<p> +Handles formats: +<ul> + <li>`sip:user@host` -> `user`</li> + <li>`sip:user@host:port` -> `user`</li> + <li>`user@host` -> `user`</li> + <li>`+15551234567` -> `+15551234567` (returned as-is)</li> +</ul> + +**Modifiers:** `static` + +## Signature + +```java +public static String extractSipUsername(String sipUri) +``` + +## Parameters + + + The SIP URI or phone number + + +## Returns + +`String` — The extracted username, or the original string if no @ is found + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1295. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-auth-password.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-auth-password.mdx new file mode 100644 index 0000000000..a6ba45ba78 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-auth-password.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-auth-password" +title: "getAuthPassword" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getAuthPassword" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getAuthPassword` + +## Signature + +```java +public String getAuthPassword() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1345. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-auth-user.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-auth-user.mdx new file mode 100644 index 0000000000..9b41d93f45 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-auth-user.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-auth-user" +title: "getAuthUser" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getAuthUser" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getAuthUser` + +## Signature + +```java +public String getAuthUser() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1344. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-contexts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-contexts.mdx new file mode 100644 index 0000000000..19575ab6ac --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-contexts.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-contexts" +title: "getContexts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getContexts" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getContexts` + +Returns the contexts dictionary as serialised SWML, or null when no +contexts have been defined yet. + +Mirrors Python's PromptManager.get\_contexts which returns the contexts +dict or None. + +## Signature + +```java +public Map getContexts() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 489. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-dynamic-config-callback.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-dynamic-config-callback.mdx new file mode 100644 index 0000000000..66bd2a3c6d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-dynamic-config-callback.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-dynamic-config-callback" +title: "getDynamicConfigCallback" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getDynamicConfigCallback" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getDynamicConfigCallback` + +## Signature + +```java +public DynamicConfigCallback getDynamicConfigCallback() +``` + +## Returns + +`DynamicConfigCallback` — the dynamic config callback, or `null` if none set. Exposed primarily so alternative transports (e.g. the Lambda adapter) can invoke it outside the HTTP server path. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1475. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-global-data.mdx new file mode 100644 index 0000000000..9ce2eade9d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-global-data" +title: "getGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getGlobalData" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```java +public Map getGlobalData() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 787. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-host.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-host.mdx new file mode 100644 index 0000000000..086d4aefa4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-host.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-host" +title: "getHost" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getHost" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getHost` + +## Signature + +```java +public String getHost() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1342. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-language-params.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-language-params.mdx new file mode 100644 index 0000000000..315fafbea4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-language-params.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-language-params" +title: "getLanguageParams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getLanguageParams" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getLanguageParams` + +Read the per-language `params` dict for a previously-added language. +Returns null when the code is unknown or params were never set. +Mirrors Python's get\_language\_params. + +**Decorators:** `@SuppressWarnings` + +## Signature + +```java +public Map getLanguageParams(String code) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 734. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-mcp-servers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-mcp-servers.mdx new file mode 100644 index 0000000000..4c448d0bd3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-mcp-servers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-mcp-servers" +title: "getMcpServers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getMcpServers" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getMcpServers` + +Get configured MCP servers (read-only). + +## Signature + +```java +public List> getMcpServers() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1154. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-name.mdx new file mode 100644 index 0000000000..2749c91903 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getName" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getName` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1340. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-normalised-route.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-normalised-route.mdx new file mode 100644 index 0000000000..6a934d40af --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-normalised-route.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-normalised-route" +title: "getNormalisedRoute" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getNormalisedRoute" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getNormalisedRoute` + +Return the agent's route normalised to an empty string for the +root route or `"/"` otherwise. + +Exposed so non-HTTP +transports can construct paths correctly. + +## Signature + +```java +public String getNormalisedRoute() +``` + +## Returns + +`String` — normalised route prefix. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1493. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-on-summary-callback.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-on-summary-callback.mdx new file mode 100644 index 0000000000..0c09edcceb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-on-summary-callback.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-on-summary-callback" +title: "getOnSummaryCallback" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getOnSummaryCallback" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getOnSummaryCallback` + +## Signature + +```java +public BiConsumer,Map> getOnSummaryCallback() +``` + +## Returns + +`BiConsumer,Map>` — the post-prompt summary callback, or `null`. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1482. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-pom.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-pom.mdx new file mode 100644 index 0000000000..a0ee9f8c89 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-pom.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-pom" +title: "getPom" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getPom" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getPom` + +Read-only snapshot of the agent's POM as a typed +`PromptObjectModel`. + +Wraps the internal map-based section list so +callers get the rich Section / render API without mutating internal +state. + +<p>Python parity: `agent.pom` instance attribute +(agent_base.py line 209). Returns `null` when `usePom` is +false (mirroring Python's = None). + +## Signature + +```java +public PromptObjectModel getPom() +``` + +## Returns + +`PromptObjectModel` — typed POM wrapper, or `null` when POM mode is off. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 475. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-port.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-port.mdx new file mode 100644 index 0000000000..4a659efd1b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-port.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-port" +title: "getPort" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getPort" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getPort` + +## Signature + +```java +public int getPort() +``` + +## Returns + +`int` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1343. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-post-prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-post-prompt.mdx new file mode 100644 index 0000000000..5bb3e25c2a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-post-prompt" +title: "getPostPrompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getPostPrompt" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getPostPrompt` + +Returns the post-prompt text that was set via setPostPrompt, or null +when none has been set. + +Mirrors Python's PromptManager.get\_post\_prompt / +PromptMixin.get\_post\_prompt — used by SWML rendering when a post-prompt +is configured. + +## Signature + +```java +public String getPostPrompt() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 429. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-prompt.mdx new file mode 100644 index 0000000000..b61605c028 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-prompt" +title: "getPrompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getPrompt" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getPrompt` + +## Signature + +```java +public Object getPrompt() +``` + +## Returns + +`Object` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 412. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-raw-prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-raw-prompt.mdx new file mode 100644 index 0000000000..e247c611fc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-raw-prompt.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-raw-prompt" +title: "getRawPrompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getRawPrompt" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getRawPrompt` + +Returns the raw prompt text whatever setPromptText stored, or null when +no raw prompt has been set. + +Distinct from getPrompt() which may return +a POM map when usePom is true. + +Mirrors Python's PromptManager.get\_raw\_prompt. + +## Signature + +```java +public String getRawPrompt() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 440. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-route.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-route.mdx new file mode 100644 index 0000000000..16aeb41319 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-route.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-route" +title: "getRoute" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getRoute" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getRoute` + +## Signature + +```java +public String getRoute() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1341. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-signing-key.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-signing-key.mdx new file mode 100644 index 0000000000..8971185d81 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-signing-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-signing-key" +title: "getSigningKey" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getSigningKey" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getSigningKey` + +## Signature + +```java +public String getSigningKey() +``` + +## Returns + +`String` — the configured Signing Key for SignalWire webhook signature validation (resolved from the builder or `SIGNALWIRE_SIGNING_KEY` env), or `null` when validation is disabled. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1353. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-sip-usernames.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-sip-usernames.mdx new file mode 100644 index 0000000000..667505a7fc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-sip-usernames.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-sip-usernames" +title: "getSipUsernames" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getSipUsernames" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getSipUsernames` + +## Signature + +```java +public Set getSipUsernames() +``` + +## Returns + +`Set` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1279. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-skill-manager.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-skill-manager.mdx new file mode 100644 index 0000000000..96b7533bf4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-skill-manager.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-skill-manager" +title: "getSkillManager" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getSkillManager" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getSkillManager` + +## Signature + +```java +public SkillManager getSkillManager() +``` + +## Returns + +`SkillManager` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1496. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-tools.mdx new file mode 100644 index 0000000000..0fc0348f9d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/get-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/get-tools" +title: "getTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.getTools" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `getTools` + +## Signature + +```java +public Map getTools() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 616. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/handle-mcp-request.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/handle-mcp-request.mdx new file mode 100644 index 0000000000..28f08a04b2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/handle-mcp-request.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/handle-mcp-request" +title: "handleMcpRequest" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.handleMcpRequest" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `handleMcpRequest` + +Handle an MCP JSON-RPC 2.0 request. + +Returns the response map. + +## Signature + +```java +public Map handleMcpRequest(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1182. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/has-skill.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/has-skill.mdx new file mode 100644 index 0000000000..95a64de6bc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/has-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/has-skill" +title: "hasSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.hasSkill" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `hasSkill` + +## Signature + +```java +public boolean hasSkill(String skillName) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1045. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/has-tool.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/has-tool.mdx new file mode 100644 index 0000000000..4bf6d0cc20 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/has-tool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/has-tool" +title: "hasTool" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.hasTool" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `hasTool` + +## Signature + +```java +public boolean hasTool(String name) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 620. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/index.mdx new file mode 100644 index 0000000000..4364f0488d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/index.mdx @@ -0,0 +1,339 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base" +title: "AgentBase" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase" + parent: "com.signalwire.sdk.agent" + module: "com.signalwire.sdk.agent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `AgentBase` + +Base class for all SignalWire AI agents. +Composes prompt management, tool registration, AI config, HTTP serving, +skills integration, and SWML rendering. + +Use the builder pattern: + +<pre> +var agent = AgentBase.builder() + .name("my-agent") + .route("/") + .port(3000) + .build(); +</pre> + +## Signature + +```java +public class AgentBase extends Service +``` + +## Inheritance + +**Extends:** [Service](/reference/java/com/signalwire/sdk/swml/swml/service) + +## Constants + + + The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. \

Any name outside this set is silently ignored by the runtime — \`#setInternalFillersMap(java.util.Map)\` and String, java.util.List) warn if you pass an unknown name. \

Notable absences: \`change\_step\`, \`gather\_submit\`, or arbitrary user-defined SWAIG function names are NOT supported. + + +## Methods + + + + + + + + + + + + Add internal fillers for a single internal function and language. <p>See `#setInternalFillersMap(java.util.Map)` for the complete list of supported function names and an explanation of what fillers do. + + + + Add a language configuration with an optional per-language `params` dict (engine-specific tuning, voice settings, etc.). + + + + Add an external MCP server for tool discovery and invocation. Tools are discovered via MCP protocol at session start and added to SWAIG. + + + + + + + + + + + + + + + + + + + + Build MCP tool list from registered tools. + + + + + + + + + + + + Create a deep copy of this agent for per-request customization. + + + + + + Mint a per-call SWAIG-function token via the agent's SessionManager. <p>Python parity: `state_mixin.StateMixin._create_tool_token`. Returns an empty string when the underlying SessionManager throws (Python catches all exceptions and returns "" on error). + + + + Define or return the ContextBuilder for this agent. + + + + Register a SWAIG tool (function) that the AI can invoke during a call. <h3>How this becomes a tool the model sees</h3> <p>A SWAIG function is <b>exactly the same concept</b> as a "tool" in native OpenAI / Anthropic tool calling. + + + + + + Resolve a base URL from environment variables alone (proxy or serverless platform). + + + + + + + + Expose this agent's tools as an MCP server endpoint at /mcp. Adds a JSON-RPC 2.0 endpoint that MCP clients can connect to. + + + + + + Extract the username portion from a SIP URI. <p> Handles formats: <ul> <li>`sip:user@host` -> `user`</li> <li>`sip:user@host:port` -> `user`</li> <li>`user@host` -> `user`</li> <li>`+15551234567` -> `+15551234567` (returned as-is)</li> </ul> + + + + + + + + Returns the contexts dictionary as serialised SWML, or null when no contexts have been defined yet. Mirrors Python's PromptManager.get\_contexts which returns the contexts dict or None. + + + + + + + + + + Read the per-language `params` dict for a previously-added language. Returns null when the code is unknown or params were never set. Mirrors Python's get\_language\_params. + + + + Get configured MCP servers (read-only). + + + + + + Return the agent's route normalised to an empty string for the root route or `"/"` otherwise. + + + + + + Read-only snapshot of the agent's POM as a typed `PromptObjectModel`. + + + + + + Returns the post-prompt text that was set via setPostPrompt, or null when none has been set. Mirrors Python's PromptManager.get\_post\_prompt / PromptMixin.get\_post\_prompt — used by SWML rendering when a post-prompt is configured. + + + + + + Returns the raw prompt text whatever setPromptText stored, or null when no raw prompt has been set. + + + + + + + + + + + + + + Handle an MCP JSON-RPC 2.0 request. + + + + + + + + Check if MCP server endpoint is enabled. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Render the complete SWML document. 5 phases: pre-answer, answer, post-answer, AI, post-AI + + + + Render SWML as a JSON string. + + + + Remove all contexts, returning the agent to a no-contexts state. This is a convenience wrapper around `defineContexts().reset()`. Use it in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + + + + Start the agent server. + + + + + + + + + + + + Set internal fillers for native SWAIG functions. <p>Internal fillers are short phrases the AI agent speaks (via TTS) while an internal/native function is running, so the caller doesn't hear dead air during transitions or background work. <p>Supported function names (match the SWAIGInternalFiller schema): `hangup`, `check_time`, `wait_for_user`, `wait_seconds`, `adjust_response_latency`, `next_step`, `change_context`, `get_visual_input`, `get_ideal_strategy`. + + + + Set (or replace) the per-language `params` dict on an already-added language. + + + + + + + + + + + + + + + + + + + + Sets the prompt as a list of POM section maps. + + + + + + + + + + + + Override the `Service` hook to enforce SignalWire webhook signature validation when a `#signingKey` is configured. + + + + Validate a per-call SWAIG-function token. + + + + Public delegate around `#validateSignedWebhook` so external front-doors (e.g. + + + +## Classes + + + + + +## Interfaces + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 53. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/is-mcp-server-enabled.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/is-mcp-server-enabled.mdx new file mode 100644 index 0000000000..2d4e1c8e34 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/is-mcp-server-enabled.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/is-mcp-server-enabled" +title: "isMcpServerEnabled" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.isMcpServerEnabled" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `isMcpServerEnabled` + +Check if MCP server endpoint is enabled. + +## Signature + +```java +public boolean isMcpServerEnabled() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1147. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/is-sip-routing-enabled.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/is-sip-routing-enabled.mdx new file mode 100644 index 0000000000..3f9275fdfa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/is-sip-routing-enabled.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/is-sip-routing-enabled" +title: "isSipRoutingEnabled" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.isSipRoutingEnabled" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `isSipRoutingEnabled` + +## Signature + +```java +public boolean isSipRoutingEnabled() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1278. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/is-trust-proxy-for-signature.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/is-trust-proxy-for-signature.mdx new file mode 100644 index 0000000000..f518fd8d4c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/is-trust-proxy-for-signature.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/is-trust-proxy-for-signature" +title: "isTrustProxyForSignature" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.isTrustProxyForSignature" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `isTrustProxyForSignature` + +## Signature + +```java +public boolean isTrustProxyForSignature() +``` + +## Returns + +`boolean` — whether webhook URL reconstruction trusts `X-Forwarded-Proto` / `X-Forwarded-Host` headers during signature validation. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1360. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/list-skills.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/list-skills.mdx new file mode 100644 index 0000000000..3b1d8b490c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/list-skills.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/list-skills" +title: "listSkills" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.listSkills" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `listSkills` + +## Signature + +```java +public List listSkills() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1041. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/manual-set-proxy-url.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..af15d31385 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/manual-set-proxy-url.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/manual-set-proxy-url" +title: "manualSetProxyUrl" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.manualSetProxyUrl" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `manualSetProxyUrl` + +## Signature + +```java +public AgentBase manualSetProxyUrl(String url) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1068. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/on-debug-event.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/on-debug-event.mdx new file mode 100644 index 0000000000..8541492df3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/on-debug-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/on-debug-event" +title: "onDebugEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.onDebugEvent" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `onDebugEvent` + +## Signature + +```java +public AgentBase onDebugEvent(Consumer> callback) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1331. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/on-function-call.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/on-function-call.mdx new file mode 100644 index 0000000000..1f8ce2ec4d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/on-function-call.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/on-function-call" +title: "onFunctionCall" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.onFunctionCall" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `onFunctionCall` + +## Signature + +```java +public FunctionResult onFunctionCall( + String name, + Map args, + Map rawData +) +``` + +## Parameters + + + + + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 591. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/on-summary.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/on-summary.mdx new file mode 100644 index 0000000000..5f8c1f349b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/on-summary.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/on-summary" +title: "onSummary" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.onSummary" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `onSummary` + +## Signature + +```java +public AgentBase onSummary( + BiConsumer,Map> callback +) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1326. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-section.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-section.mdx new file mode 100644 index 0000000000..53b7a2f903 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-section.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-section" +title: "promptAddSection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.promptAddSection" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `promptAddSection` + +## Signature + + + + ```java + public AgentBase promptAddSection( + String title, + String body, + List bullets + ) + ``` + + + + ```java + public AgentBase promptAddSection(String title, String body) + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`AgentBase` + +## Returns (Overload 2) + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 359. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-subsection.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-subsection.mdx new file mode 100644 index 0000000000..7ad743914c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-subsection.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-subsection" +title: "promptAddSubsection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.promptAddSubsection" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `promptAddSubsection` + +## Signature + +```java +public AgentBase promptAddSubsection( + String parentTitle, + String title, + String body +) +``` + +## Parameters + + + + + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 375. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-to-section.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-to-section.mdx new file mode 100644 index 0000000000..887fec45da --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-to-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-add-to-section" +title: "promptAddToSection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.promptAddToSection" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `promptAddToSection` + +## Signature + +```java +public AgentBase promptAddToSection(String title, List bullets) +``` + +## Parameters + + + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 391. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-has-section.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-has-section.mdx new file mode 100644 index 0000000000..e9e43c996a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-has-section.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/prompt-has-section" +title: "promptHasSection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.promptHasSection" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `promptHasSection` + +## Signature + +```java +public boolean promptHasSection(String title) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 403. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/register-additional-routes.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/register-additional-routes.mdx new file mode 100644 index 0000000000..4eb1751333 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/register-additional-routes.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/register-additional-routes" +title: "registerAdditionalRoutes" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.registerAdditionalRoutes" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "protected" +--- +# `registerAdditionalRoutes` + +**Decorators:** `@Override` + +## Signature + +```java +protected void registerAdditionalRoutes( + com.sun.net.httpserver.HttpServer server +) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1933. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/register-sip-username.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/register-sip-username.mdx new file mode 100644 index 0000000000..a76a2a3cff --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/register-sip-username.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/register-sip-username" +title: "registerSipUsername" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.registerSipUsername" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `registerSipUsername` + +## Signature + +```java +public AgentBase registerSipUsername(String username) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1269. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/register-swaig-function.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/register-swaig-function.mdx new file mode 100644 index 0000000000..4412c3792f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/register-swaig-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/register-swaig-function" +title: "registerSwaigFunction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.registerSwaigFunction" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `registerSwaigFunction` + +**Decorators:** `@Override` + +## Signature + +```java +public AgentBase registerSwaigFunction(Map swaigFunc) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 579. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/remove-skill.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/remove-skill.mdx new file mode 100644 index 0000000000..26d78d2fc8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/remove-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/remove-skill" +title: "removeSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.removeSkill" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `removeSkill` + +## Signature + +```java +public AgentBase removeSkill(String skillName) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1036. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/render-main-swml.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/render-main-swml.mdx new file mode 100644 index 0000000000..06866d26fa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/render-main-swml.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/render-main-swml" +title: "renderMainSwml" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.renderMainSwml" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "protected" +--- +# `renderMainSwml` + +**Decorators:** `@Override` + +## Signature + +```java +protected Map renderMainSwml(HttpExchange exchange) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1901. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/render-swml-json.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/render-swml-json.mdx new file mode 100644 index 0000000000..fa8d1566ed --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/render-swml-json.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/render-swml-json" +title: "renderSwmlJson" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.renderSwmlJson" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `renderSwmlJson` + +Render SWML as a JSON string. + +## Signature + +```java +public String renderSwmlJson(String baseUrl) +``` + +## Parameters + + + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1697. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/render-swml.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/render-swml.mdx new file mode 100644 index 0000000000..8a85e7834c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/render-swml.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/render-swml" +title: "renderSwml" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.renderSwml" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `renderSwml` + +Render the complete SWML document. +5 phases: pre-answer, answer, post-answer, AI, post-AI + +## Signature + +```java +public Map renderSwml(String baseUrl) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1506. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/reset-contexts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/reset-contexts.mdx new file mode 100644 index 0000000000..9d10396111 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/reset-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/reset-contexts" +title: "resetContexts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.resetContexts" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `resetContexts` + +Remove all contexts, returning the agent to a no-contexts state. +This is a convenience wrapper around `defineContexts().reset()`. +Use it in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```java +public AgentBase resetContexts() +``` + +## Returns + +`AgentBase` — this agent for chaining. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1020. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/run.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/run.mdx new file mode 100644 index 0000000000..99d7b8b232 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/run.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/run" +title: "run" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.run" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `run` + +Start the agent server. + +Equivalent to `#serve()` (inherited). + +## Signature + +```java +public void run() +``` + +## Throws + +- `IOException` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 2059. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..e0a15d560d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-dynamic-config-callback.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-dynamic-config-callback" +title: "setDynamicConfigCallback" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setDynamicConfigCallback" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setDynamicConfigCallback` + +## Signature + +```java +public AgentBase setDynamicConfigCallback(DynamicConfigCallback callback) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1053. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-function-includes.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-function-includes.mdx new file mode 100644 index 0000000000..ece64bb575 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-function-includes.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-function-includes" +title: "setFunctionIncludes" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setFunctionIncludes" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setFunctionIncludes` + +## Signature + +```java +public AgentBase setFunctionIncludes(List> includes) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 938. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-global-data.mdx new file mode 100644 index 0000000000..ab1412908e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-global-data" +title: "setGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setGlobalData" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setGlobalData` + +## Signature + +```java +public AgentBase setGlobalData(Map data) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 776. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-internal-fillers-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-internal-fillers-map.mdx new file mode 100644 index 0000000000..14d84aaa22 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-internal-fillers-map.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-internal-fillers-map" +title: "setInternalFillersMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setInternalFillersMap" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setInternalFillersMap` + +Set internal fillers for native SWAIG functions. + +<p>Internal fillers are short phrases the AI agent speaks (via TTS) +while an internal/native function is running, so the caller doesn't +hear dead air during transitions or background work. + +<p>Supported function names (match the SWAIGInternalFiller schema): +`hangup`, `check_time`, `wait_for_user`, +`wait_seconds`, `adjust_response_latency`, +`next_step`, `change_context`, `get_visual_input`, +`get_ideal_strategy`. + +See +`#SUPPORTED_INTERNAL_FILLER_NAMES`. + +<p>Notably NOT supported: `change_step`, `gather_submit`, or +arbitrary user-defined SWAIG function names. The runtime only honors +fillers for the names listed above; everything else is silently +ignored at the SWML level. This method warns at registration time if +you pass an unknown name so you catch the typo early. + +## Signature + +```java +public AgentBase setInternalFillersMap( + Map>> fillers +) +``` + +## Parameters + + + map of → language\_code → phrases. + + +## Returns + +`AgentBase` — this agent for chaining. + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 856. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-internal-fillers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-internal-fillers.mdx new file mode 100644 index 0000000000..1026fe41ff --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-internal-fillers.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-internal-fillers" +title: "setInternalFillers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setInternalFillers" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setInternalFillers` + +## Signature + +```java +public AgentBase setInternalFillers(List> fillers) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 827. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-language-params.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-language-params.mdx new file mode 100644 index 0000000000..e50d7f3e51 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-language-params.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-language-params" +title: "setLanguageParams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setLanguageParams" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setLanguageParams` + +Set (or replace) the per-language `params` dict on an already-added +language. + +Empty/null params removes the key. Unknown code is a no-op. +Returns self for chaining. Mirrors Python's set\_language\_params. + +## Signature + +```java +public AgentBase setLanguageParams(String code, Map params) +``` + +## Parameters + + + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 715. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-languages.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-languages.mdx new file mode 100644 index 0000000000..9fe4663e01 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-languages.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-languages" +title: "setLanguages" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setLanguages" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setLanguages` + +## Signature + +```java +public AgentBase setLanguages(List> langs) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 745. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-native-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-native-functions.mdx new file mode 100644 index 0000000000..dcf8ba37e5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-native-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-native-functions" +title: "setNativeFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setNativeFunctions" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setNativeFunctions` + +## Signature + +```java +public AgentBase setNativeFunctions(List funcs) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 791. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-param.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-param.mdx new file mode 100644 index 0000000000..34a0508f81 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-param.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-param" +title: "setParam" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setParam" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setParam` + +## Signature + +```java +public AgentBase setParam(String key, Object value) +``` + +## Parameters + + + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 766. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-params.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-params.mdx new file mode 100644 index 0000000000..afa922b953 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-params" +title: "setParams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setParams" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setParams` + +## Signature + +```java +public AgentBase setParams(Map newParams) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 771. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..0786017479 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt-llm-params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt-llm-params" +title: "setPostPromptLlmParams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setPostPromptLlmParams" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setPostPromptLlmParams` + +## Signature + +```java +public AgentBase setPostPromptLlmParams(Map llmParams) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 950. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt-url.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt-url.mdx new file mode 100644 index 0000000000..19a8a41b49 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt-url.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt-url" +title: "setPostPromptUrl" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setPostPromptUrl" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setPostPromptUrl` + +## Signature + +```java +public AgentBase setPostPromptUrl(String url) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1063. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt.mdx new file mode 100644 index 0000000000..98bee4888d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-post-prompt" +title: "setPostPrompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setPostPrompt" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setPostPrompt` + +## Signature + +```java +public AgentBase setPostPrompt(String text) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 354. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-llm-params.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..324e3daab2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-llm-params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-llm-params" +title: "setPromptLlmParams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setPromptLlmParams" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setPromptLlmParams` + +## Signature + +```java +public AgentBase setPromptLlmParams(Map llmParams) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 944. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-pom.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-pom.mdx new file mode 100644 index 0000000000..170a06693d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-pom.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-pom" +title: "setPromptPom" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setPromptPom" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setPromptPom` + +Sets the prompt as a list of POM section maps. + +Each section map +supports keys "title", "body", "bullets", "numbered", +"numbered\_bullets", and "subsections". Switches the agent to POM mode. + +Mirrors Python's PromptManager.set\_prompt\_pom — accepts a list of +section dicts and stores them in pomSections. + +## Signature + +```java +public AgentBase setPromptPom(List> pom) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 452. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-text.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-text.mdx new file mode 100644 index 0000000000..b86dc1560a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-text.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-prompt-text" +title: "setPromptText" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setPromptText" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setPromptText` + +## Signature + +```java +public AgentBase setPromptText(String text) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 348. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-pronunciations.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-pronunciations.mdx new file mode 100644 index 0000000000..5a407c47a2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-pronunciations.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-pronunciations" +title: "setPronunciations" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setPronunciations" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setPronunciations` + +## Signature + +```java +public AgentBase setPronunciations(List> prons) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 760. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-web-hook-url.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-web-hook-url.mdx new file mode 100644 index 0000000000..0e6e15b42b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/set-web-hook-url.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/set-web-hook-url" +title: "setWebHookUrl" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.setWebHookUrl" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `setWebHookUrl` + +## Signature + +```java +public AgentBase setWebHookUrl(String url) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1058. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/update-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/update-global-data.mdx new file mode 100644 index 0000000000..d0edd3230f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/update-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/update-global-data" +title: "updateGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.updateGlobalData" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `updateGlobalData` + +## Signature + +```java +public AgentBase updateGlobalData(Map data) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 782. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-signed-webhook.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-signed-webhook.mdx new file mode 100644 index 0000000000..54001a6ac5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-signed-webhook.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-signed-webhook" +title: "validateSignedWebhook" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.validateSignedWebhook" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "protected" +--- +# `validateSignedWebhook` + +Override the `Service` hook to enforce SignalWire webhook +signature validation when a `#signingKey` is configured. + +Returns +`true` (no-op) when `signingKey` is unset; per +porting-sdk/webhooks.md, the AgentBase MUST NOT silently reject +unsigned requests when no key is configured (a prominent startup +warning is the documented behavior instead — emitted in +`Builder#build()`). + +<p>The signature header is read from `X-SignalWire-Signature` +(or its `X-Twilio-Signature` legacy alias). The URL is +reconstructed from proxy headers / `SWML_PROXY_URL_BASE` / +the request itself, and the validator is called with the raw body +bytes the caller already captured. + +**Decorators:** `@Override` + +## Signature + +```java +protected boolean validateSignedWebhook( + com.sun.net.httpserver.HttpExchange exchange, + String rawBody +) +``` + +## Parameters + + + the inbound HttpExchange. + + + + the raw UTF-8 body string that was already read from the exchange. + + +## Returns + +`boolean` — `true` when validation passes (or no key is configured). + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1397. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-tool-token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-tool-token.mdx new file mode 100644 index 0000000000..e1974ead3c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-tool-token.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-tool-token" +title: "validateToolToken" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.validateToolToken" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `validateToolToken` + +Validate a per-call SWAIG-function token. + +Returns false when the +function is not registered, when the SessionManager rejects the +token, or on any underlying exception. + +<p>Python parity: `state_mixin.StateMixin.validate_tool_token` +— rejects unknown functions up-front and swallows exceptions. + +## Signature + +```java +public boolean validateToolToken( + String functionName, + String token, + String callId +) +``` + +## Parameters + + + + + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 647. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-webhook.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-webhook.mdx new file mode 100644 index 0000000000..c701258826 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-webhook.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent/agent-base/validate-webhook" +title: "validateWebhook" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.agent.AgentBase.validateWebhook" + parent: "com.signalwire.sdk.agent.AgentBase" + module: "com.signalwire.sdk.agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java" + visibility: "public" +--- +# `validateWebhook` + +Public delegate around `#validateSignedWebhook` so external +front-doors (e.g. + +`com.signalwire.sdk.server.AgentServer`, a +Lambda adapter, etc.) can run the same logic the in-process HTTP +server does. Mirrors the no-op-when-unset behavior described in +porting-sdk/webhooks.md. + +## Signature + +```java +public boolean validateWebhook( + com.sun.net.httpserver.HttpExchange exchange, + String rawBody +) +``` + +## Parameters + + + the inbound HttpExchange. + + + + raw UTF-8 body string. + + +## Returns + +`boolean` — `true` when validation passes (or no key is configured). + +## Source + +[`src/main/java/com/signalwire/sdk/agent/AgentBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/agent/AgentBase.java) + +Line 1373. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/index.mdx new file mode 100644 index 0000000000..bef97f06c5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/agent/agent/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/java/com/signalwire/sdk/agent/agent" +title: "agent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.agent" + module: "com.signalwire.sdk.agent" +--- +# `agent` + +## Signature + +```java +package com.signalwire.sdk.agent +``` + +## Classes + + + + Base class for all SignalWire AI agents. Composes prompt management, tool registration, AI config, HTTP serving, skills integration, and SWML rendering. Use the builder pattern: <pre> var agent = AgentBase.builder() .name("my-agent") .route("/") .port(3000) .build(); </pre> + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/index.mdx new file mode 100644 index 0000000000..6a2ba33617 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/cli" +title: "cli" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.cli" + module: "com.signalwire.sdk.cli" +--- +# `cli` + +## Signature + +```java +package com.signalwire.sdk.cli +``` + +## Classes + + + + CLI tool for testing SWAIG functions against an agent. <p> Uses only JDK classes (java.net.http.HttpClient) -- no external dependencies. <p> Two modes: <ul> <li><b>URL mode</b> — hit a running agent HTTP server.</li> <li><b>Simulation mode</b> — \ loads the agent class directly and routes invocation through the matching serverless adapter (e.g. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/index.mdx new file mode 100644 index 0000000000..4f417a679f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/cli/swaig-test" +title: "SwaigTest" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.cli.SwaigTest" + parent: "com.signalwire.sdk.cli" + module: "com.signalwire.sdk.cli" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/SwaigTest.java" + visibility: "public" +--- +# `SwaigTest` + +CLI tool for testing SWAIG functions against an agent. + +<p> +Uses only JDK classes (java.net.http.HttpClient) -- no external dependencies. +<p> +Two modes: +<ul> + <li><b>URL mode</b> — hit a running agent HTTP server.</li> + <li><b>Simulation mode</b> — <platform> loads the + agent class directly and routes invocation through the matching + serverless adapter (e.g. + +`LambdaAgentHandler`) instead of +the HTTP server. Uses an injected `EnvProvider` to mask the +real process env with simulated values, since Java cannot mutate +`System#getenv()`.</li> + +</ul> +<p> +Usage: +<pre> + swaig-test --url http://user:pass@localhost:3000 --list-tools + swaig-test --url http://user:pass@localhost:3000 --dump-swml + swaig-test --url http://user:pass@localhost:3000 --exec tool_name --param key=value + swaig-test <agent-class> --simulate-serverless lambda --dump-swml + swaig-test <agent-class> --simulate-serverless lambda --exec tool_name --param k=v + swaig-test <agent-class> --simulate-serverless lambda +</pre> + +## Signature + +```java +public class SwaigTest +``` + +## Methods + + + + + + + + Run the CLI and return the exit code. + + + +## Source + +[`src/main/java/com/signalwire/sdk/cli/SwaigTest.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/SwaigTest.java) + +Line 44. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/init.mdx new file mode 100644 index 0000000000..795adc5613 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/cli/swaig-test/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.SwaigTest." + parent: "com.signalwire.sdk.cli.SwaigTest" + module: "com.signalwire.sdk.cli.SwaigTest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/SwaigTest.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/cli/SwaigTest.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/SwaigTest.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/main.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/main.mdx new file mode 100644 index 0000000000..cc299325f0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/main.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/cli/swaig-test/main" +title: "main" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.SwaigTest.main" + parent: "com.signalwire.sdk.cli.SwaigTest" + module: "com.signalwire.sdk.cli.SwaigTest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/SwaigTest.java" + visibility: "public" +--- +# `main` + +**Modifiers:** `static` + +## Signature + +```java +public static void main(String[] args) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/cli/SwaigTest.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/SwaigTest.java) + +Line 75. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/run.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/run.mdx new file mode 100644 index 0000000000..89eae3032c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/cli/swaig-test/run.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/cli/swaig-test/run" +title: "run" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.SwaigTest.run" + parent: "com.signalwire.sdk.cli.SwaigTest" + module: "com.signalwire.sdk.cli.SwaigTest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/SwaigTest.java" + visibility: "public" +--- +# `run` + +Run the CLI and return the exit code. + +Extracted so tests can drive +`main` without calling `System#exit(int)`. + +**Modifiers:** `static` + +## Signature + + + + ```java + public static int run(String[] args) + ``` + + + + ```java + private void run() + ``` + + + +## Parameters (Overload 1) + + + command-line arguments. + + +## Returns (Overload 1) + +`int` — 0 on success, non-zero on error. + +## Source + +[`src/main/java/com/signalwire/sdk/cli/SwaigTest.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/SwaigTest.java) + +Line 87. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/index.mdx new file mode 100644 index 0000000000..49477240bb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation" +title: "simulation" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation" + module: "com.signalwire.sdk.cli.simulation" +--- +# `simulation` + +## Signature + +```java +package com.signalwire.sdk.cli.simulation +``` + +## Classes + + + + Build a layered `EnvProvider` that overlays simulated serverless environment values on top of the real process environment. <p>Java cannot mutate `System#getenv()` at runtime (the map it returns is an immutable snapshot of the OS env). + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/build-env-provider.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/build-env-provider.mdx new file mode 100644 index 0000000000..ad161b1c58 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/build-env-provider.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/build-env-provider" +title: "buildEnvProvider" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.buildEnvProvider" + parent: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + module: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `buildEnvProvider` + +Build the layered `EnvProvider`. + +Precedence is: + +<ol> + <li>masked keys — always return `null`.</li> + <li>simulated values — overlaid on the real env.</li> + <li>Real env — everything else passes through.</li> +</ol> + +## Signature + +```java +public EnvProvider buildEnvProvider() +``` + +## Returns + +`EnvProvider` — layered env provider. + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) + +Line 199. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-masked-keys.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-masked-keys.mdx new file mode 100644 index 0000000000..6c60a940b6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-masked-keys.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-masked-keys" +title: "getMaskedKeys" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.getMaskedKeys" + parent: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + module: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `getMaskedKeys` + +## Signature + +```java +public Set getMaskedKeys() +``` + +## Returns + +`Set` — an immutable view of the keys that are masked (returned as `null`) regardless of what the real env has for them. + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) + +Line 174. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-platform.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-platform.mdx new file mode 100644 index 0000000000..0dcaeace50 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-platform.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-platform" +title: "getPlatform" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.getPlatform" + parent: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + module: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `getPlatform` + +## Signature + +```java +public Platform getPlatform() +``` + +## Returns + +`Platform` — the simulated platform. + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) + +Line 158. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-simulated-env.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-simulated-env.mdx new file mode 100644 index 0000000000..112f637c00 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-simulated-env.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/get-simulated-env" +title: "getSimulatedEnv" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.getSimulatedEnv" + parent: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + module: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `getSimulatedEnv` + +## Signature + +```java +public Map getSimulatedEnv() +``` + +## Returns + +`Map` — the map of simulated values layered on top of the real env. The returned map is a defensive copy. + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) + +Line 166. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/index.mdx new file mode 100644 index 0000000000..f269406139 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/index.mdx @@ -0,0 +1,91 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator" +title: "ServerlessSimulator" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + parent: "com.signalwire.sdk.cli.simulation" + module: "com.signalwire.sdk.cli.simulation" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `ServerlessSimulator` + +Build a layered `EnvProvider` that overlays simulated serverless +environment values on top of the real process environment. + +<p>Java cannot mutate `System#getenv()` at runtime (the map it +returns is an immutable snapshot of the OS env). + +To implement the +\--simulate-serverless flag in the same spirit as +Python's `mock_env.py`, we therefore cannot "set env vars then +clean up" — we instead compose an injectable `EnvProvider` and +thread it through every code path in the SDK that reads env vars. + +<p>Accepts only the platforms the port actually implements. Ports that +add CGI / GCF / Azure support later should extend +`#presetFor(Platform)`. + +<p>Mirrors the clear-and-warn semantics of Python's +`_clear_conflicting_env`: `SWML_PROXY_URL_BASE` is masked +in the simulated view so that platform-specific URL generation is +actually exercised. If the caller's real OS env has +`SWML_PROXY_URL_BASE` set, the simulator does <b>not</b> mutate +the real env — it simply returns `null` for that key through the +layered `EnvProvider`. Callers that want to surface the mismatch +to the user can check `#proxyUrlBaseMaskedFromRealEnv()`. + +**Modifiers:** `final` + +## Signature + +```java +public final class ServerlessSimulator +``` + +## Methods + + + + Build a simulator for the given platform using the real process environment as the fallback layer. + + + + Build the layered `EnvProvider`. + + + + + + + + + + Parse the CLI-string form of a platform. + + + + Default env-var preset for a platform, mirroring Python's `ServerlessSimulator.PLATFORM_PRESETS`. + + + + + +## Enums + + + + Platforms the Java port supports simulating today. + + + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) + +Line 36. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/init.mdx new file mode 100644 index 0000000000..9121f59875 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/init.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator." + parent: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + module: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `` + +Build a simulator for the given platform using the real process +environment as the fallback layer. + +## Signature + + + + ```java + public (Platform platform) + ``` + + + + ```java + public ( + Platform platform, + EnvProvider realEnv, + Map overrides + ) + ``` + + + +## Parameters (Overload 1) + + + platform to simulate. + + +## Parameters (Overload 2) + + + platform to simulate. + + + + fallback env provider (usually `EnvProvider#SYSTEM`). + + + + user-supplied overrides on top of the platform preset. + + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) + +Line 100. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/parse-platform.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/parse-platform.mdx new file mode 100644 index 0000000000..f167677ff3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/parse-platform.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/parse-platform" +title: "parsePlatform" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.parsePlatform" + parent: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + module: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `parsePlatform` + +Parse the CLI-string form of a platform. + +Accepts only values this +port supports; unknown strings throw `IllegalArgumentException` +so the CLI can surface a clear error instead of silently falling +back. + +**Modifiers:** `static` + +## Signature + +```java +public static Platform parsePlatform(String s) +``` + +## Parameters + + + user-supplied platform string. + + +## Returns + +`Platform` — the matching `Platform`. + +## Throws + +- `IllegalArgumentException` — for unsupported platforms. + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) + +Line 80. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform/index.mdx new file mode 100644 index 0000000000..bb705efbfc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform" +title: "Platform" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "enum" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.Platform" + parent: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + module: "com.signalwire.sdk.cli.simulation" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `Platform` + +Platforms the Java port supports simulating today. + +## Signature + +```java +public enum Platform +``` + +## Variants + + + AWS Lambda. + + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) + +Line 39. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform/value-of.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform/value-of.mdx new file mode 100644 index 0000000000..9ca01d3ca0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform/value-of.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform/value-of" +title: "valueOf" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.Platform.valueOf" + parent: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.Platform" + module: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.Platform" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `valueOf` + +**Modifiers:** `static` + +## Signature + +```java +public static Platform valueOf(String name) +``` + +## Parameters + + + +## Returns + +`Platform` + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform/values.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform/values.mdx new file mode 100644 index 0000000000..6e00b272f9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform/values.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/platform/values" +title: "values" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.Platform.values" + parent: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.Platform" + module: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.Platform" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `values` + +**Modifiers:** `static` + +## Signature + +```java +public static Platform[] values() +``` + +## Returns + +`Platform[]` + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/preset-for.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/preset-for.mdx new file mode 100644 index 0000000000..14ed895ec5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/preset-for.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/preset-for" +title: "presetFor" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.presetFor" + parent: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + module: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `presetFor` + +Default env-var preset for a platform, mirroring Python's +`ServerlessSimulator.PLATFORM_PRESETS`. + +**Modifiers:** `static` + +## Signature + +```java +public static Map presetFor(Platform platform) +``` + +## Parameters + + + platform. + + +## Returns + +`Map` — the preset map (never null). + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) + +Line 142. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/proxy-url-base-masked-from-real-env.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/proxy-url-base-masked-from-real-env.mdx new file mode 100644 index 0000000000..40fdd1dfaf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/proxy-url-base-masked-from-real-env.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/cli/simulation/simulation/serverless-simulator/proxy-url-base-masked-from-real-env" +title: "proxyUrlBaseMaskedFromRealEnv" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.cli.simulation.ServerlessSimulator.proxyUrlBaseMaskedFromRealEnv" + parent: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + module: "com.signalwire.sdk.cli.simulation.ServerlessSimulator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java" + visibility: "public" +--- +# `proxyUrlBaseMaskedFromRealEnv` + +## Signature + +```java +public boolean proxyUrlBaseMaskedFromRealEnv() +``` + +## Returns + +`boolean` — `true` if the real process env has `SWML_PROXY_URL_BASE` set — i.e. the simulated view is hiding a real value the user might not have intended. The CLI uses this to print a warning that mirrors Python's behaviour. + +## Source + +[`src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/cli/simulation/ServerlessSimulator.java) + +Line 184. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/add-context.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/add-context.mdx new file mode 100644 index 0000000000..a9d5cf36f2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/add-context.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context-builder/add-context" +title: "addContext" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.ContextBuilder.addContext" + parent: "com.signalwire.sdk.contexts.ContextBuilder" + module: "com.signalwire.sdk.contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java" + visibility: "public" +--- +# `addContext` + +Add a new context. + +## Signature + +```java +public Context addContext(String name) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java) + +Line 105. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/attach-tool-name-supplier.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/attach-tool-name-supplier.mdx new file mode 100644 index 0000000000..b94211d7c2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/attach-tool-name-supplier.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context-builder/attach-tool-name-supplier" +title: "attachToolNameSupplier" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.ContextBuilder.attachToolNameSupplier" + parent: "com.signalwire.sdk.contexts.ContextBuilder" + module: "com.signalwire.sdk.contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java" + visibility: "public" +--- +# `attachToolNameSupplier` + +Attach a supplier that returns registered SWAIG tool names so +`#validate()` can check for collisions with +`#RESERVED_NATIVE_TOOL_NAMES`. + +Called internally by +`AgentBase.defineContexts()`. + +## Signature + +```java +public ContextBuilder attachToolNameSupplier( + java.util.function.Supplier> supplier +) +``` + +## Parameters + + + returns the current set of registered tool names. + + +## Returns + +`ContextBuilder` — this builder for chaining. + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java) + +Line 84. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/get-context.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/get-context.mdx new file mode 100644 index 0000000000..d22e187046 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/get-context.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context-builder/get-context" +title: "getContext" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.ContextBuilder.getContext" + parent: "com.signalwire.sdk.contexts.ContextBuilder" + module: "com.signalwire.sdk.contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java" + visibility: "public" +--- +# `getContext` + +Get an existing context by name. + +## Signature + +```java +public Context getContext(String name) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java) + +Line 121. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/index.mdx new file mode 100644 index 0000000000..2087ccbe1f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/index.mdx @@ -0,0 +1,97 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context-builder" +title: "ContextBuilder" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.ContextBuilder" + parent: "com.signalwire.sdk.contexts" + module: "com.signalwire.sdk.contexts" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java" + visibility: "public" +--- +# `ContextBuilder` + +Builder for multi-step, multi-context AI agent workflows. + +<p>A ContextBuilder owns one or more `Context`s; each context owns an +ordered list of `Step`s. + +Only one context and one step is active at a +time. Per chat turn, the runtime injects the current step's instructions as +a system message, then asks the LLM for a response. + +<h2>Native tools auto-injected by the runtime</h2> + +<p>When a step (or its enclosing context) declares valid_steps or +valid_contexts, the runtime auto-injects two native tools so the model can +navigate the flow: +<ul> + <li>enum) — present when valid_steps is set</li> + <li>enum) — present when valid_contexts is set</li> +</ul> + +<p>A third native tool — `gather_submit` — is injected during +gather_info questioning. These three names are <b>reserved</b>: +`#validate()` rejects any agent that defines a SWAIG tool with one of +these names. See `#RESERVED_NATIVE_TOOL_NAMES`. + +<h2>Function whitelisting (Step.setFunctions)</h2> + +<p>Each step may declare a functions whitelist. The whitelist is applied +in-memory at the start of each LLM turn. CRITICALLY: if a step does NOT +declare a functions field, it INHERITS the previous step's active set. +See `Step#setFunctions(Object)` for details and examples. + +## Signature + +```java +public class ContextBuilder +``` + +## Constants + + + Reserved tool names auto-injected by the runtime when contexts/steps are in use. User-defined SWAIG tools must not collide with these names. \

    \
  • \`next\_step\` / \`change\_context\` are injected when valid\_steps or valid\_contexts is set so the model can navigate the flow.\
  • \
  • \`gather\_submit\` is injected while a step's gather\_info is collecting answers.\
  • \
+
+ +## Methods + + + + + + Add a new context. + + + + Attach a supplier that returns registered SWAIG tool names so `#validate()` can check for collisions with `#RESERVED_NATIVE_TOOL_NAMES`. + + + + Get an existing context by name. + + + + + + Remove all contexts, returning the builder to its initial state. Use this in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + + + + Convert all contexts to a Map for SWML generation. Validates before converting. + + + + Validate the contexts configuration. + + + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java) + +Line 41. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/init.mdx new file mode 100644 index 0000000000..8b5d80379e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/init.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context-builder/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.ContextBuilder." + parent: "com.signalwire.sdk.contexts.ContextBuilder" + module: "com.signalwire.sdk.contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java) + +Line 70. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/is-empty.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/is-empty.mdx new file mode 100644 index 0000000000..698ce9630a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/is-empty.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context-builder/is-empty" +title: "isEmpty" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.ContextBuilder.isEmpty" + parent: "com.signalwire.sdk.contexts.ContextBuilder" + module: "com.signalwire.sdk.contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java" + visibility: "public" +--- +# `isEmpty` + +## Signature + +```java +public boolean isEmpty() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java) + +Line 125. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/reset.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/reset.mdx new file mode 100644 index 0000000000..2f70f5782a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/reset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context-builder/reset" +title: "reset" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.ContextBuilder.reset" + parent: "com.signalwire.sdk.contexts.ContextBuilder" + module: "com.signalwire.sdk.contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java" + visibility: "public" +--- +# `reset` + +Remove all contexts, returning the builder to its initial state. +Use this in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```java +public ContextBuilder reset() +``` + +## Returns + +`ContextBuilder` — this builder for chaining. + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java) + +Line 96. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/to-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/to-map.mdx new file mode 100644 index 0000000000..72df14013f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/to-map.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context-builder/to-map" +title: "toMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.ContextBuilder.toMap" + parent: "com.signalwire.sdk.contexts.ContextBuilder" + module: "com.signalwire.sdk.contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java" + visibility: "public" +--- +# `toMap` + +Convert all contexts to a Map for SWML generation. +Validates before converting. + +## Signature + +```java +public Map toMap() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java) + +Line 310. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/validate.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/validate.mdx new file mode 100644 index 0000000000..579127549f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context-builder/validate.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context-builder/validate" +title: "validate" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.ContextBuilder.validate" + parent: "com.signalwire.sdk.contexts.ContextBuilder" + module: "com.signalwire.sdk.contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java" + visibility: "public" +--- +# `validate` + +Validate the contexts configuration. + +## Signature + +```java +public void validate() +``` + +## Throws + +- `IllegalStateException` — if validation fails + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/ContextBuilder.java) + +Line 134. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-bullets.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-bullets.mdx new file mode 100644 index 0000000000..e41efabcbe --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-bullets.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/add-bullets" +title: "addBullets" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.addBullets" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `addBullets` + +## Signature + +```java +public Context addBullets(String title, List bullets) +``` + +## Parameters + + + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 205. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-enter-filler.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-enter-filler.mdx new file mode 100644 index 0000000000..cc41c58269 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-enter-filler.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/add-enter-filler" +title: "addEnterFiller" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.addEnterFiller" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `addEnterFiller` + +## Signature + +```java +public Context addEnterFiller(String languageCode, List fillers) +``` + +## Parameters + + + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 230. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-exit-filler.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-exit-filler.mdx new file mode 100644 index 0000000000..652cd82a7a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-exit-filler.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/add-exit-filler" +title: "addExitFiller" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.addExitFiller" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `addExitFiller` + +## Signature + +```java +public Context addExitFiller(String languageCode, List fillers) +``` + +## Parameters + + + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 238. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-section.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-section.mdx new file mode 100644 index 0000000000..2f996764eb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/add-section" +title: "addSection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.addSection" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `addSection` + +## Signature + +```java +public Context addSection(String title, String body) +``` + +## Parameters + + + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 194. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-step.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-step.mdx new file mode 100644 index 0000000000..2d7e4d5065 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/add-step.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/add-step" +title: "addStep" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.addStep" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `addStep` + +Add a new step to this context. + +## Signature + + + + ```java + public Step addStep(String stepName) + ``` + + + + ```java + public Step addStep( + String stepName, + String task, + List bullets, + String criteria, + Object functions, + List validSteps + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + + + + + + + + + +## Returns (Overload 1) + +`Step` + +## Returns (Overload 2) + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 57. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/get-name.mdx new file mode 100644 index 0000000000..c61055914d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.getName" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `getName` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 50. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/get-step.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/get-step.mdx new file mode 100644 index 0000000000..e41101dd62 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/get-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/get-step" +title: "getStep" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.getStep" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `getStep` + +## Signature + +```java +public Step getStep(String stepName) +``` + +## Parameters + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 84. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/index.mdx new file mode 100644 index 0000000000..5707e9cb99 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/index.mdx @@ -0,0 +1,89 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context" +title: "Context" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context" + parent: "com.signalwire.sdk.contexts" + module: "com.signalwire.sdk.contexts" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `Context` + +Represents a single context containing multiple steps. + +<p> +All setter methods return `this` for fluent chaining. + +## Signature + +```java +public class Context +``` + +## Methods + + + + + + + + + + + + + + Add a new step to this context. + + + + + + + + + + + + + + + + + + + + Set which step the context starts on when entered. <p>By default, a context starts on its first step (index 0). + + + + Mark this context as isolated — entering it wipes conversation history. <p>When `isolated=true` and the context is entered via change\_context, the runtime wipes the conversation array. + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 16. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/init.mdx new file mode 100644 index 0000000000..0d3677a51c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context." + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String name) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 43. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/move-step.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/move-step.mdx new file mode 100644 index 0000000000..ffc50e9a7d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/move-step.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/move-step" +title: "moveStep" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.moveStep" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `moveStep` + +## Signature + +```java +public Context moveStep(String stepName, int position) +``` + +## Parameters + + + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 96. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/remove-step.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/remove-step.mdx new file mode 100644 index 0000000000..5b23aa56ed --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/remove-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/remove-step" +title: "removeStep" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.removeStep" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `removeStep` + +## Signature + +```java +public Context removeStep(String stepName) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 88. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-consolidate.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-consolidate.mdx new file mode 100644 index 0000000000..d023e544ab --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-consolidate.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-consolidate" +title: "setConsolidate" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setConsolidate" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setConsolidate` + +## Signature + +```java +public Context setConsolidate(boolean consolidate) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 144. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-enter-fillers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-enter-fillers.mdx new file mode 100644 index 0000000000..50335ef46d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-enter-fillers.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-enter-fillers" +title: "setEnterFillers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setEnterFillers" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setEnterFillers` + +## Signature + +```java +public Context setEnterFillers(Map> fillers) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 216. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-exit-fillers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-exit-fillers.mdx new file mode 100644 index 0000000000..a0d77043ff --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-exit-fillers.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-exit-fillers" +title: "setExitFillers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setExitFillers" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setExitFillers` + +## Signature + +```java +public Context setExitFillers(Map> fillers) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 223. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-full-reset.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-full-reset.mdx new file mode 100644 index 0000000000..b23135cac6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-full-reset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-full-reset" +title: "setFullReset" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setFullReset" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setFullReset` + +## Signature + +```java +public Context setFullReset(boolean fullReset) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 149. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-initial-step.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-initial-step.mdx new file mode 100644 index 0000000000..a096da8bcd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-initial-step.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-initial-step" +title: "setInitialStep" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setInitialStep" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setInitialStep` + +Set which step the context starts on when entered. + +<p>By default, a context starts on its first step (index 0). + +Use this +to skip a preamble step on re-entry via `change_context`. + +## Signature + +```java +public Context setInitialStep(String stepName) +``` + +## Parameters + + + name of the step to start on (must exist in this context). + + +## Returns + +`Context` — this context for chaining. + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 114. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-isolated.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-isolated.mdx new file mode 100644 index 0000000000..aa924657eb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-isolated.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-isolated" +title: "setIsolated" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setIsolated" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setIsolated` + +Mark this context as isolated — entering it wipes conversation history. + +<p>When `isolated=true` and the context is entered via +change_context, the runtime wipes the conversation array. + +The model +starts fresh with only the new context's system\_prompt + step +instructions, with no memory of prior turns. + +<p><b>EXCEPTION — reset overrides the wipe:</b> If the context also has +a reset configuration (via `#setConsolidate(boolean)` or +`#setFullReset(boolean)`), the wipe is skipped in favor of the +reset behavior. Use reset with consolidate=true to summarize prior +history into a single message instead of dropping it entirely. + +<p>Use cases: switching to a sensitive billing flow that should not see +prior small-talk; handing off to a different agent persona; resetting +after a long off-topic detour. + +## Signature + +```java +public Context setIsolated(boolean isolated) +``` + +## Parameters + + + true to wipe conversation history on context entry (subject to the reset exception above). + + +## Returns + +`Context` — this context for chaining. + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 181. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-post-prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-post-prompt.mdx new file mode 100644 index 0000000000..5c1101921e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-post-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-post-prompt" +title: "setPostPrompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setPostPrompt" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setPostPrompt` + +## Signature + +```java +public Context setPostPrompt(String postPrompt) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 134. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-prompt.mdx new file mode 100644 index 0000000000..5100d245f7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-prompt" +title: "setPrompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setPrompt" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setPrompt` + +## Signature + +```java +public Context setPrompt(String prompt) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 186. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-system-prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-system-prompt.mdx new file mode 100644 index 0000000000..1a0043cd62 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-system-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-system-prompt" +title: "setSystemPrompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setSystemPrompt" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setSystemPrompt` + +## Signature + +```java +public Context setSystemPrompt(String systemPrompt) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 139. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-user-prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-user-prompt.mdx new file mode 100644 index 0000000000..b90c3f1df3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-user-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-user-prompt" +title: "setUserPrompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setUserPrompt" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setUserPrompt` + +## Signature + +```java +public Context setUserPrompt(String userPrompt) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 154. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-valid-contexts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-valid-contexts.mdx new file mode 100644 index 0000000000..3b7fe3d11f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-valid-contexts.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-valid-contexts" +title: "setValidContexts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setValidContexts" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setValidContexts` + +## Signature + +```java +public Context setValidContexts(List contexts) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 124. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-valid-steps.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-valid-steps.mdx new file mode 100644 index 0000000000..aaf49576a1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/set-valid-steps.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/set-valid-steps" +title: "setValidSteps" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.setValidSteps" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `setValidSteps` + +## Signature + +```java +public Context setValidSteps(List steps) +``` + +## Parameters + + + +## Returns + +`Context` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 129. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/to-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/to-map.mdx new file mode 100644 index 0000000000..c2bc8fb2f4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/context/to-map.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/context/to-map" +title: "toMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Context.toMap" + parent: "com.signalwire.sdk.contexts.Context" + module: "com.signalwire.sdk.contexts.Context" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java" + visibility: "public" +--- +# `toMap` + +## Signature + +```java +public Map toMap() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Context.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Context.java) + +Line 259. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/add-question.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/add-question.mdx new file mode 100644 index 0000000000..62f6768725 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/add-question.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/gather-info/add-question" +title: "addQuestion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.GatherInfo.addQuestion" + parent: "com.signalwire.sdk.contexts.GatherInfo" + module: "com.signalwire.sdk.contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java" + visibility: "public" +--- +# `addQuestion` + +Add a question to gather. + +## Signature + + + + ```java + public GatherInfo addQuestion( + String key, + String question, + String type, + boolean confirm, + String prompt, + List functions + ) + ``` + + + + ```java + public GatherInfo addQuestion(String key, String question) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + + + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`GatherInfo` + +## Returns (Overload 2) + +`GatherInfo` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/GatherInfo.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java) + +Line 38. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/get-completion-action.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/get-completion-action.mdx new file mode 100644 index 0000000000..19df725a7b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/get-completion-action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/gather-info/get-completion-action" +title: "getCompletionAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.GatherInfo.getCompletionAction" + parent: "com.signalwire.sdk.contexts.GatherInfo" + module: "com.signalwire.sdk.contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java" + visibility: "public" +--- +# `getCompletionAction` + +## Signature + +```java +public String getCompletionAction() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/GatherInfo.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java) + +Line 52. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/get-questions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/get-questions.mdx new file mode 100644 index 0000000000..e162a5fe5d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/get-questions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/gather-info/get-questions" +title: "getQuestions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.GatherInfo.getQuestions" + parent: "com.signalwire.sdk.contexts.GatherInfo" + module: "com.signalwire.sdk.contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java" + visibility: "public" +--- +# `getQuestions` + +## Signature + +```java +public List getQuestions() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/GatherInfo.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java) + +Line 48. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/index.mdx new file mode 100644 index 0000000000..2dc08b4717 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/gather-info" +title: "GatherInfo" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.GatherInfo" + parent: "com.signalwire.sdk.contexts" + module: "com.signalwire.sdk.contexts" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java" + visibility: "public" +--- +# `GatherInfo` + +Configuration for gathering information in a step via the C-side gather\_info system. + +<p> +This produces zero tool_call/tool_result entries in LLM-visible history, +instead using dynamic step instruction re-injection to present one question at a time. + +## Signature + +```java +public class GatherInfo +``` + +## Methods + + + + + + Add a question to gather. + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/GatherInfo.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java) + +Line 17. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/init.mdx new file mode 100644 index 0000000000..8f07c85e8e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/init.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/gather-info/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.GatherInfo." + parent: "com.signalwire.sdk.contexts.GatherInfo" + module: "com.signalwire.sdk.contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public (String outputKey, String completionAction, String prompt) + ``` + + + + ```java + public () + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/GatherInfo.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java) + +Line 24. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/to-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/to-map.mdx new file mode 100644 index 0000000000..9bd9387d06 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-info/to-map.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/gather-info/to-map" +title: "toMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.GatherInfo.toMap" + parent: "com.signalwire.sdk.contexts.GatherInfo" + module: "com.signalwire.sdk.contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java" + visibility: "public" +--- +# `toMap` + +## Signature + +```java +public Map toMap() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/GatherInfo.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherInfo.java) + +Line 56. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/get-key.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/get-key.mdx new file mode 100644 index 0000000000..9e843d0276 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/get-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/gather-question/get-key" +title: "getKey" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.GatherQuestion.getKey" + parent: "com.signalwire.sdk.contexts.GatherQuestion" + module: "com.signalwire.sdk.contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java" + visibility: "public" +--- +# `getKey` + +## Signature + +```java +public String getKey() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/index.mdx new file mode 100644 index 0000000000..906ceeea47 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/gather-question" +title: "GatherQuestion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.GatherQuestion" + parent: "com.signalwire.sdk.contexts" + module: "com.signalwire.sdk.contexts" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java" + visibility: "public" +--- +# `GatherQuestion` + +Represents a single question in a gather\_info configuration. + +## Signature + +```java +public class GatherQuestion +``` + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java) + +Line 14. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/init.mdx new file mode 100644 index 0000000000..109221d6a7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/init.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/gather-question/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.GatherQuestion." + parent: "com.signalwire.sdk.contexts.GatherQuestion" + module: "com.signalwire.sdk.contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public ( + String key, + String question, + String type, + boolean confirm, + String prompt, + List functions + ) + ``` + + + + ```java + public (String key, String question) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + + + + + +## Parameters (Overload 2) + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/to-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/to-map.mdx new file mode 100644 index 0000000000..7fb473be88 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/gather-question/to-map.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/gather-question/to-map" +title: "toMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.GatherQuestion.toMap" + parent: "com.signalwire.sdk.contexts.GatherQuestion" + module: "com.signalwire.sdk.contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java" + visibility: "public" +--- +# `toMap` + +## Signature + +```java +public Map toMap() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/GatherQuestion.java) + +Line 41. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/index.mdx new file mode 100644 index 0000000000..9647cd14dc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts" +title: "contexts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.contexts" + module: "com.signalwire.sdk.contexts" +--- +# `contexts` + +## Signature + +```java +package com.signalwire.sdk.contexts +``` + +## Classes + + + + Represents a single context containing multiple steps. <p> All setter methods return `this` for fluent chaining. + + + + Builder for multi-step, multi-context AI agent workflows. <p>A ContextBuilder owns one or more `Context`s; each context owns an ordered list of `Step`s. + + + + Configuration for gathering information in a step via the C-side gather\_info system. <p> This produces zero tool\_call/tool\_result entries in LLM-visible history, instead using dynamic step instruction re-injection to present one question at a time. + + + + Represents a single question in a gather\_info configuration. + + + + Represents a single step within a context. <p> Steps can use either raw text or POM-style sections for their prompt content. All setter methods return `this` for fluent chaining. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/add-bullets.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/add-bullets.mdx new file mode 100644 index 0000000000..3697b7231c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/add-bullets.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/add-bullets" +title: "addBullets" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.addBullets" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `addBullets` + +Add a POM section with bullet points. + +## Signature + +```java +public Step addBullets(String title, List bullets) +``` + +## Parameters + + + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 78. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/add-gather-question.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/add-gather-question.mdx new file mode 100644 index 0000000000..7fed03c238 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/add-gather-question.mdx @@ -0,0 +1,97 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/add-gather-question" +title: "addGatherQuestion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.addGatherQuestion" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `addGatherQuestion` + +Add a question to this step's gather\_info configuration. +String, String) must be called first. + +<p><b>IMPORTANT — gather mode locks function access:</b> While the model +is asking gather questions, the runtime forcibly deactivates ALL of the +step's other functions. + +The only callable tools during a gather +question are: + +<ul> + <li>`gather_submit` (the native answer-submission tool)</li> + <li>Whatever names you pass in this question's `functions` + argument</li> +</ul> + +<p>`next_step` and `change_context` are also filtered out — +the model cannot navigate away until the gather completes. This is by +design: it forces a tight ask → submit → next-question loop. + +<p>If a question needs to call out to a tool (e.g. validate an email, +geocode a ZIP), list that tool name in this question's `functions` +argument. Functions listed here are active ONLY for this question. + +## Signature + + + + ```java + public Step addGatherQuestion( + String key, + String question, + String type, + boolean confirm, + String prompt, + List functions + ) + ``` + + + + ```java + public Step addGatherQuestion(String key, String question) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + + + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Step` + +## Returns (Overload 2) + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 206. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/add-section.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/add-section.mdx new file mode 100644 index 0000000000..cdf223c4ec --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/add-section" +title: "addSection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.addSection" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `addSection` + +Add a POM section to the step. + +## Signature + +```java +public Step addSection(String title, String body) +``` + +## Parameters + + + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 63. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/clear-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/clear-sections.mdx new file mode 100644 index 0000000000..b924ba192b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/clear-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/clear-sections" +title: "clearSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.clearSections" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `clearSections` + +## Signature + +```java +public Step clearSections() +``` + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 219. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/get-name.mdx new file mode 100644 index 0000000000..b78fb3335d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.getName" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `getName` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 44. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/index.mdx new file mode 100644 index 0000000000..6ba6128159 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/index.mdx @@ -0,0 +1,92 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step" +title: "Step" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step" + parent: "com.signalwire.sdk.contexts" + module: "com.signalwire.sdk.contexts" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `Step` + +Represents a single step within a context. + +<p> +Steps can use either raw text or POM-style sections for their prompt content. +All setter methods return `this` for fluent chaining. + +## Signature + +```java +public class Step +``` + +## Methods + + + + + + Add a POM section with bullet points. + + + + Add a question to this step's gather\_info configuration. String, String) must be called first. <p><b>IMPORTANT — gather mode locks function access:</b> While the model is asking gather questions, the runtime forcibly deactivates ALL of the step's other functions. + + + + Add a POM section to the step. + + + + + + + + Mark this step as terminal for the step flow. <p><b>IMPORTANT:</b> `end=true` does NOT end the conversation or hang up the call. + + + + Set which non-internal functions are callable while this step is active. <p><b>IMPORTANT — inheritance behavior:</b> If you do NOT call this method, the step inherits whichever function set was active on the previous step (or the previous context's last step). + + + + Enable info gathering for this step. + + + + + + + + + + + + + + + + + + Set the step's prompt text directly. + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 17. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/init.mdx new file mode 100644 index 0000000000..507b002418 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step." + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String name) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 39. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-end.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-end.mdx new file mode 100644 index 0000000000..9fded91ebe --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-end.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-end" +title: "setEnd" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setEnd" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setEnd` + +Mark this step as terminal for the step flow. + +<p><b>IMPORTANT:</b> `end=true` does NOT end the conversation or +hang up the call. + +It exits step mode entirely after this step executes +— clearing the steps list, current step index, valid\_steps, and +valid\_contexts. The agent keeps running, but operates only under the +base system prompt and the context-level prompt; no more step +instructions are injected and no more `next_step` tool is offered. + +<p>To actually end the call, call a hangup tool or define a +hangup hook. + +## Signature + +```java +public Step setEnd(boolean end) +``` + +## Parameters + + + true to exit step mode after this step. + + +## Returns + +`Step` — this step for chaining. + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 161. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-functions.mdx new file mode 100644 index 0000000000..2a9f1058ff --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-functions.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-functions" +title: "setFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setFunctions" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setFunctions` + +Set which non-internal functions are callable while this step is active. + +<p><b>IMPORTANT — inheritance behavior:</b> If you do NOT call this method, +the step inherits whichever function set was active on the previous step +(or the previous context's last step). + +The server-side runtime only +resets the active set when a step explicitly declares its `functions` +field. This is the most common source of bugs in multi-step agents: +forgetting `setFunctions()` on a later step lets the previous step's +tools leak through. Best practice is to call `setFunctions()` +explicitly on every step that should differ from the previous one. + +<p>Keep the per-step active set small: LLM tool selection accuracy +degrades noticeably past ~7-8 simultaneously-active tools per call. +Use per-step whitelisting to partition large tool collections. + +<p>Accepts: +<ul> + <li>`List<String>` — whitelist of function names allowed in this + step. Functions not in the list become inactive.</li> + <li>`List.of()` (empty list) — explicit disable-all.</li> + <li>The string `"none"` — synonym for an empty list.</li> +</ul> + +<p>Internal functions (e.g. `gather_submit`, hangup hook) are +ALWAYS protected and cannot be deactivated by this whitelist. The native +navigation tools `next_step` and `change_context` are +injected automatically when `setValidSteps`/`setValidContexts` +is used; they are not affected by this list and do not need to appear in +it. + +## Signature + +```java +public Step setFunctions(Object functions) +``` + +## Parameters + + + a `List` whitelist, an empty list, or the string `"none"`. + + +## Returns + +`Step` — this step for chaining. + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 130. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-gather-info.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-gather-info.mdx new file mode 100644 index 0000000000..b1694e257c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-gather-info.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-gather-info" +title: "setGatherInfo" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setGatherInfo" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setGatherInfo` + +Enable info gathering for this step. + +## Signature + +```java +public Step setGatherInfo( + String outputKey, + String completionAction, + String prompt +) +``` + +## Parameters + + + + + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 179. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-consolidate.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-consolidate.mdx new file mode 100644 index 0000000000..46b5992d61 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-consolidate.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-consolidate" +title: "setResetConsolidate" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setResetConsolidate" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setResetConsolidate` + +## Signature + +```java +public Step setResetConsolidate(boolean consolidate) +``` + +## Parameters + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 235. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-full-reset.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-full-reset.mdx new file mode 100644 index 0000000000..63cab8011f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-full-reset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-full-reset" +title: "setResetFullReset" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setResetFullReset" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setResetFullReset` + +## Signature + +```java +public Step setResetFullReset(boolean fullReset) +``` + +## Parameters + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 240. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-system-prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-system-prompt.mdx new file mode 100644 index 0000000000..39a9773d37 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-system-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-system-prompt" +title: "setResetSystemPrompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setResetSystemPrompt" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setResetSystemPrompt` + +## Signature + +```java +public Step setResetSystemPrompt(String systemPrompt) +``` + +## Parameters + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 225. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-user-prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-user-prompt.mdx new file mode 100644 index 0000000000..9328111e77 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-user-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-reset-user-prompt" +title: "setResetUserPrompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setResetUserPrompt" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setResetUserPrompt` + +## Signature + +```java +public Step setResetUserPrompt(String userPrompt) +``` + +## Parameters + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 230. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-skip-to-next-step.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-skip-to-next-step.mdx new file mode 100644 index 0000000000..67e3fcc041 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-skip-to-next-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-skip-to-next-step" +title: "setSkipToNextStep" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setSkipToNextStep" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setSkipToNextStep` + +## Signature + +```java +public Step setSkipToNextStep(boolean skip) +``` + +## Parameters + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 171. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-skip-user-turn.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-skip-user-turn.mdx new file mode 100644 index 0000000000..ebbd7c0146 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-skip-user-turn.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-skip-user-turn" +title: "setSkipUserTurn" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setSkipUserTurn" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setSkipUserTurn` + +## Signature + +```java +public Step setSkipUserTurn(boolean skip) +``` + +## Parameters + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 166. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-step-criteria.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-step-criteria.mdx new file mode 100644 index 0000000000..1a6726184d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-step-criteria.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-step-criteria" +title: "setStepCriteria" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setStepCriteria" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setStepCriteria` + +## Signature + +```java +public Step setStepCriteria(String criteria) +``` + +## Parameters + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 90. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-text.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-text.mdx new file mode 100644 index 0000000000..44cc3bbd01 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-text.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-text" +title: "setText" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setText" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setText` + +Set the step's prompt text directly. + +## Signature + +```java +public Step setText(String text) +``` + +## Parameters + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 51. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-valid-contexts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-valid-contexts.mdx new file mode 100644 index 0000000000..52e2461d5f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-valid-contexts.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-valid-contexts" +title: "setValidContexts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setValidContexts" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setValidContexts` + +## Signature + +```java +public Step setValidContexts(List contexts) +``` + +## Parameters + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 140. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-valid-steps.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-valid-steps.mdx new file mode 100644 index 0000000000..d6e60c548b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/set-valid-steps.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/set-valid-steps" +title: "setValidSteps" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.setValidSteps" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `setValidSteps` + +## Signature + +```java +public Step setValidSteps(List steps) +``` + +## Parameters + + + +## Returns + +`Step` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 135. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/to-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/to-map.mdx new file mode 100644 index 0000000000..e223918b72 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/contexts/contexts/step/to-map.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/contexts/contexts/step/to-map" +title: "toMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.contexts.Step.toMap" + parent: "com.signalwire.sdk.contexts.Step" + module: "com.signalwire.sdk.contexts.Step" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java" + visibility: "public" +--- +# `toMap` + +## Signature + +```java +public Map toMap() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/contexts/Step.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/contexts/Step.java) + +Line 289. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/body.mdx new file mode 100644 index 0000000000..1c4132ba5a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/body.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/body" +title: "body" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.body" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `body` + +Set request body for the last added webhook (POST/PUT requests). + +## Signature + +```java +public DataMap body(Map data) +``` + +## Parameters + + + +## Returns + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 166. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/description.mdx new file mode 100644 index 0000000000..f14802e1a5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/description.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/description" +title: "description" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.description" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `description` + +Alias for `#purpose(String)`; sets the LLM-facing tool +description. + +This string is read by the model to decide WHEN to +call this tool. See `#purpose(String)` for bad-vs-good +examples. + +## Signature + +```java +public DataMap description(String description) +``` + +## Parameters + + + +## Returns + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 79. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/error-keys.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/error-keys.mdx new file mode 100644 index 0000000000..47b4701ec1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/error-keys.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/error-keys" +title: "errorKeys" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.errorKeys" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `errorKeys` + +Set error keys for the most recent webhook (if webhooks exist) or top-level. + +## Signature + +```java +public DataMap errorKeys(List keys) +``` + +## Parameters + + + +## Returns + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 218. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/expression.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/expression.mdx new file mode 100644 index 0000000000..24f5541b9d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/expression.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/expression" +title: "expression" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.expression" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `expression` + +Add an expression pattern for pattern-based responses. + +## Signature + + + + ```java + public DataMap expression( + String testValue, + String pattern, + FunctionResult output, + FunctionResult nomatchOutput + ) + ``` + + + + ```java + public DataMap expression( + String testValue, + String pattern, + FunctionResult output + ) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + +## Parameters (Overload 2) + + + + + + + +## Returns (Overload 1) + +`DataMap` + +## Returns (Overload 2) + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 128. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/fallback-output.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/fallback-output.mdx new file mode 100644 index 0000000000..d2d045533f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/fallback-output.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/fallback-output" +title: "fallbackOutput" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.fallbackOutput" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `fallbackOutput` + +Set a fallback output result at the top level (used when all webhooks fail). + +## Signature + +```java +public DataMap fallbackOutput(FunctionResult result) +``` + +## Parameters + + + +## Returns + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 210. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/foreach.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/foreach.mdx new file mode 100644 index 0000000000..ea8d32da64 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/foreach.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/foreach" +title: "foreach" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.foreach" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `foreach` + +Process an array from the webhook response using foreach mechanism. + +## Signature + +```java +public DataMap foreach(Map foreachConfig) +``` + +## Parameters + + + +## Returns + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 188. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/get-name.mdx new file mode 100644 index 0000000000..fc5a0d3a51 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.getName" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `getName` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 43. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/global-error-keys.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/global-error-keys.mdx new file mode 100644 index 0000000000..0dfb0d9e4b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/global-error-keys.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/global-error-keys" +title: "globalErrorKeys" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.globalErrorKeys" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `globalErrorKeys` + +Set top-level error keys (applies to all webhooks). + +## Signature + +```java +public DataMap globalErrorKeys(List keys) +``` + +## Parameters + + + +## Returns + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 230. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/index.mdx new file mode 100644 index 0000000000..7d3d672085 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/index.mdx @@ -0,0 +1,97 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map" +title: "DataMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap" + parent: "com.signalwire.sdk.datamap" + module: "com.signalwire.sdk.datamap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `DataMap` + +Fluent builder for creating SWAIG data\_map configurations. + +<p> +DataMap tools execute on SignalWire servers without requiring webhook endpoints. +Supports variable expansion: `${args.param`}, `${response.field`}, +`${global_data.key`}, `${foreach.item`}. +<p> +All methods return `this` for fluent chaining. + +## Signature + +```java +public class DataMap +``` + +## Methods + + + + + + Set request body for the last added webhook (POST/PUT requests). + + + + Alias for `#purpose(String)`; sets the LLM-facing tool description. + + + + Set error keys for the most recent webhook (if webhooks exist) or top-level. + + + + Add an expression pattern for pattern-based responses. + + + + Set a fallback output result at the top level (used when all webhooks fail). + + + + Process an array from the webhook response using foreach mechanism. + + + + + + Set top-level error keys (applies to all webhooks). + + + + Set the output result for the most recent webhook. + + + + Add a parameter to this data-map tool — the `description` is LLM-FACING. <p>Each parameter description is rendered into the OpenAI tool schema under `parameters.properties..description` and sent to the model. + + + + Set request params for the last added webhook. + + + + Set the LLM-facing tool description — this is PROMPT ENGINEERING, not developer documentation. <p>The description string is rendered into the OpenAI tool schema `description` field on every LLM turn. + + + + Convert this DataMap to a SWAIG function definition. + + + + Add a webhook API call. + + + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 22. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/init.mdx new file mode 100644 index 0000000000..2540821768 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap." + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String functionName) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 33. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/output.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/output.mdx new file mode 100644 index 0000000000..bf7b9fa957 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/output.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/output" +title: "output" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.output" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `output` + +Set the output result for the most recent webhook. + +## Signature + +```java +public DataMap output(FunctionResult result) +``` + +## Parameters + + + +## Returns + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 199. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/parameter.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/parameter.mdx new file mode 100644 index 0000000000..a4f13ca285 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/parameter.mdx @@ -0,0 +1,115 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/parameter" +title: "parameter" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.parameter" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `parameter` + +Add a parameter to this data-map tool — the `description` is +LLM-FACING. + +<p>Each parameter description is rendered into the OpenAI tool schema +under `parameters.properties.<name>.description` and sent to +the model. + +The model uses it to decide HOW to fill in the argument +from user speech. It is prompt engineering, not developer FYI. + +<h3>Bad vs good</h3> +<pre>: .parameter("city", "string", "the city", true, null) +GOOD: .parameter("city", "string", + "The name of the city to get weather for, e.g. " + + "\"San Francisco\". Ask the user if they did not " + + "provide one. Include the state or country if the " + + "city name is ambiguous.", true, null)</pre> + +## Signature + + + + ```java + public DataMap parameter( + String name, + String paramType, + String description, + boolean required, + List enumValues + ) + ``` + + + + ```java + public DataMap parameter( + String name, + String paramType, + String description, + boolean required + ) + ``` + + + + ```java + public DataMap parameter(String name, String paramType, String description) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + + + +## Parameters (Overload 2) + + + + + + + + + +## Parameters (Overload 3) + + + + + + + +## Returns (Overload 1) + +`DataMap` + +## Returns (Overload 2) + +`DataMap` + +## Returns (Overload 3) + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 102. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/params.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/params.mdx new file mode 100644 index 0000000000..e4173cd1d6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/params.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/params" +title: "params" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.params" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `params` + +Set request params for the last added webhook. + +## Signature + +```java +public DataMap params(Map data) +``` + +## Parameters + + + +## Returns + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 177. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/purpose.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/purpose.mdx new file mode 100644 index 0000000000..d86c1fbf30 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/purpose.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/purpose" +title: "purpose" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.purpose" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `purpose` + +Set the LLM-facing tool description — this is PROMPT ENGINEERING, +not developer documentation. + +<p>The description string is rendered into the OpenAI tool schema +`description` field on every LLM turn. + +The model reads it to +decide WHEN to call this tool. A vague `purpose()` is the #1 +cause of "the model has the right tool but doesn't call it" failures +with data-map tools. + +<h3>Bad vs good</h3> +<pre>: .purpose("weather api") +GOOD: .purpose("Get the current weather conditions and forecast " + + "for a specific city. Use this whenever the user " + + "asks about weather, temperature, rain, or similar " + + "conditions in a named location.")</pre> + +## Signature + +```java +public DataMap purpose(String description) +``` + +## Parameters + + + prompt-engineering description of when to call this tool. + + +## Returns + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 68. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/to-swaig-function.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/to-swaig-function.mdx new file mode 100644 index 0000000000..a733eaddd1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/to-swaig-function.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/to-swaig-function" +title: "toSwaigFunction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.toSwaigFunction" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `toSwaigFunction` + +Convert this DataMap to a SWAIG function definition. + +## Signature + +```java +public Map toSwaigFunction() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 238. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/webhook.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/webhook.mdx new file mode 100644 index 0000000000..4905018dab --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/data-map/webhook.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap/data-map/webhook" +title: "webhook" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.datamap.DataMap.webhook" + parent: "com.signalwire.sdk.datamap.DataMap" + module: "com.signalwire.sdk.datamap.DataMap" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java" + visibility: "public" +--- +# `webhook` + +Add a webhook API call. + +## Signature + + + + ```java + public DataMap webhook(String method, String url, Map headers) + ``` + + + + ```java + public DataMap webhook(String method, String url) + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`DataMap` + +## Returns (Overload 2) + +`DataMap` + +## Source + +[`src/main/java/com/signalwire/sdk/datamap/DataMap.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/datamap/DataMap.java) + +Line 148. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/index.mdx new file mode 100644 index 0000000000..833e7517e2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/datamap/datamap/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/java/com/signalwire/sdk/datamap/datamap" +title: "datamap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.datamap" + module: "com.signalwire.sdk.datamap" +--- +# `datamap` + +## Signature + +```java +package com.signalwire.sdk.datamap +``` + +## Classes + + + + Fluent builder for creating SWAIG data\_map configurations. <p> DataMap tools execute on SignalWire servers without requiring webhook endpoints. Supports variable expansion: `${args.param`\}, `${response.field`\}, `${global_data.key`\}, `${foreach.item`\}. <p> All methods return `this` for fluent chaining. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/index.mdx new file mode 100644 index 0000000000..d06a8510cb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging" +title: "logging" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.logging" + module: "com.signalwire.sdk.logging" +--- +# `logging` + +## Signature + +```java +package com.signalwire.sdk.logging +``` + +## Classes + + + + Simple logging system with level control via environment variables. <p> Levels: DEBUG, INFO, WARN, ERROR, OFF <p> Environment variables: <ul> <li>SIGNALWIRE\_LOG\_LEVEL - set log level (debug/info/warn/error/off)</li> <li>SIGNALWIRE\_LOG\_MODE - set to "off" to suppress all output</li> </ul> + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/debug.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/debug.mdx new file mode 100644 index 0000000000..22b38a6b45 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/debug.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/debug" +title: "debug" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.debug" + parent: "com.signalwire.sdk.logging.Logger" + module: "com.signalwire.sdk.logging.Logger" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `debug` + +## Signature + + + + ```java + public void debug(String message) + ``` + + + + ```java + public void debug(String format, Object args) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 87. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/error.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/error.mdx new file mode 100644 index 0000000000..77e36a28c4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/error.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/error" +title: "error" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.error" + parent: "com.signalwire.sdk.logging.Logger" + module: "com.signalwire.sdk.logging.Logger" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `error` + +## Signature + + + + ```java + public void error(String message) + ``` + + + + ```java + public void error(String format, Object args) + ``` + + + + ```java + public void error(String message, Throwable t) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Parameters (Overload 3) + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 111. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/get-global-level.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/get-global-level.mdx new file mode 100644 index 0000000000..dedb8cd0e6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/get-global-level.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/get-global-level" +title: "getGlobalLevel" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.getGlobalLevel" + parent: "com.signalwire.sdk.logging.Logger" + module: "com.signalwire.sdk.logging.Logger" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `getGlobalLevel` + +**Modifiers:** `static` + +## Signature + +```java +public static Level getGlobalLevel() +``` + +## Returns + +`Level` + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 79. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/get-logger.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/get-logger.mdx new file mode 100644 index 0000000000..7455d16fcd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/get-logger.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/get-logger" +title: "getLogger" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.getLogger" + parent: "com.signalwire.sdk.logging.Logger" + module: "com.signalwire.sdk.logging.Logger" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `getLogger` + +**Modifiers:** `static` + +## Signature + + + + ```java + public static Logger getLogger(String name) + ``` + + + + ```java + public static Logger getLogger(Class clazz) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Logger` + +## Returns (Overload 2) + +`Logger` + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 67. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/index.mdx new file mode 100644 index 0000000000..2df69ae43d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger" +title: "Logger" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger" + parent: "com.signalwire.sdk.logging" + module: "com.signalwire.sdk.logging" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `Logger` + +Simple logging system with level control via environment variables. + +<p> +Levels: DEBUG, INFO, WARN, ERROR, OFF +<p> +Environment variables: +<ul> + <li>SIGNALWIRE_LOG_LEVEL - set log level (debug/info/warn/error/off)</li> + <li>SIGNALWIRE_LOG_MODE - set to "off" to suppress all output</li> +</ul> + +**Modifiers:** `final` + +## Signature + +```java +public final class Logger +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Enums + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/info.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/info.mdx new file mode 100644 index 0000000000..b1f59d8ff1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/info.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/info" +title: "info" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.info" + parent: "com.signalwire.sdk.logging.Logger" + module: "com.signalwire.sdk.logging.Logger" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `info` + +## Signature + + + + ```java + public void info(String message) + ``` + + + + ```java + public void info(String format, Object args) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 95. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/init.mdx new file mode 100644 index 0000000000..2133672d18 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger." + parent: "com.signalwire.sdk.logging.Logger" + module: "com.signalwire.sdk.logging.Logger" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String name) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 63. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/is-enabled.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/is-enabled.mdx new file mode 100644 index 0000000000..d227004c84 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/is-enabled.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/is-enabled" +title: "isEnabled" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.isEnabled" + parent: "com.signalwire.sdk.logging.Logger" + module: "com.signalwire.sdk.logging.Logger" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `isEnabled` + +## Signature + +```java +public boolean isEnabled(Level level) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 83. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/get-value.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/get-value.mdx new file mode 100644 index 0000000000..1a541bdcdc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/get-value.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/level/get-value" +title: "getValue" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.Level.getValue" + parent: "com.signalwire.sdk.logging.Logger.Level" + module: "com.signalwire.sdk.logging.Logger.Level" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `getValue` + +## Signature + +```java +public int getValue() +``` + +## Returns + +`int` + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 31. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/index.mdx new file mode 100644 index 0000000000..be924fd691 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/level" +title: "Level" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "enum" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.Level" + parent: "com.signalwire.sdk.logging.Logger" + module: "com.signalwire.sdk.logging" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `Level` + +## Signature + +```java +public enum Level +``` + +## Variants + + + + + + + + + + + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 22. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/value-of.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/value-of.mdx new file mode 100644 index 0000000000..ef736616d7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/value-of.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/level/value-of" +title: "valueOf" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.Level.valueOf" + parent: "com.signalwire.sdk.logging.Logger.Level" + module: "com.signalwire.sdk.logging.Logger.Level" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `valueOf` + +**Modifiers:** `static` + +## Signature + +```java +public static Level valueOf(String name) +``` + +## Parameters + + + +## Returns + +`Level` + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/values.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/values.mdx new file mode 100644 index 0000000000..c8d34b78fc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/level/values.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/level/values" +title: "values" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.Level.values" + parent: "com.signalwire.sdk.logging.Logger.Level" + module: "com.signalwire.sdk.logging.Logger.Level" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `values` + +**Modifiers:** `static` + +## Signature + +```java +public static Level[] values() +``` + +## Returns + +`Level[]` + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/set-global-level.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/set-global-level.mdx new file mode 100644 index 0000000000..10a637adef --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/set-global-level.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/set-global-level" +title: "setGlobalLevel" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.setGlobalLevel" + parent: "com.signalwire.sdk.logging.Logger" + module: "com.signalwire.sdk.logging.Logger" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `setGlobalLevel` + +**Modifiers:** `static` + +## Signature + +```java +public static void setGlobalLevel(Level level) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 75. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/warn.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/warn.mdx new file mode 100644 index 0000000000..f043d1a435 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/logging/logging/logger/warn.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/logging/logging/logger/warn" +title: "warn" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.logging.Logger.warn" + parent: "com.signalwire.sdk.logging.Logger" + module: "com.signalwire.sdk.logging.Logger" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java" + visibility: "public" +--- +# `warn` + +## Signature + + + + ```java + public void warn(String message) + ``` + + + + ```java + public void warn(String format, Object args) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/logging/Logger.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/logging/Logger.java) + +Line 103. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/index.mdx new file mode 100644 index 0000000000..6341debf2a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/index.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom" +title: "pom" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.pom" + module: "com.signalwire.sdk.pom" +--- +# `pom` + +## Signature + +```java +package com.signalwire.sdk.pom +``` + +## Classes + + + + A structured data format for composing, organising, and rendering prompt instructions for large language models. + + + + Represents a section in the Prompt Object Model. <p>Each section contains a title, optional body text, optional bullet points, and can have any number of nested subsections. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/add-pom-as-subsection.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/add-pom-as-subsection.mdx new file mode 100644 index 0000000000..716786fa68 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/add-pom-as-subsection.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/add-pom-as-subsection" +title: "addPomAsSubsection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.addPomAsSubsection" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `addPomAsSubsection` + +Add another POM's top-level sections as subsections of an existing +section. + +Mirrors Python pom) where +`target` is either a title (String) or a `Section`. + +## Signature + +```java +public void addPomAsSubsection(Object target, PromptObjectModel pomToAdd) +``` + +## Parameters + + + + + +## Throws + +- `IllegalArgumentException` — when `target` is not a String or `Section`, or when the title is not found + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 200. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/add-section.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/add-section.mdx new file mode 100644 index 0000000000..b23dc8e680 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/add-section.mdx @@ -0,0 +1,110 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/add-section" +title: "addSection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.addSection" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `addSection` + +Add a top-level section. + +Mirrors Python `add_section(...)`. + +## Signature + + + + ```java + public Section addSection( + String title, + String body, + List bullets, + Boolean numbered, + boolean numberedBullets + ) + ``` + + + + ```java + public Section addSection(String title) + ``` + + + + ```java + public Section addSection(String title, String body) + ``` + + + + ```java + public Section addSection(String title, String body, List bullets) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + + + +## Parameters (Overload 2) + + + +## Parameters (Overload 3) + + + + + +## Parameters (Overload 4) + + + + + + + +## Returns (Overload 1) + +`Section` — the newly created `Section` + +## Returns (Overload 2) + +`Section` + +## Returns (Overload 3) + +`Section` + +## Returns (Overload 4) + +`Section` + +## Throws + +- `IllegalArgumentException` — if a null-title section is added after the first section + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 144. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/find-section.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/find-section.mdx new file mode 100644 index 0000000000..ae2d881866 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/find-section.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/find-section" +title: "findSection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.findSection" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `findSection` + +Recursively search for a section with the given title. + +Mirrors Python +`find_section(title)`. + +## Signature + +```java +public Optional
findSection(String title) +``` + +## Parameters + + + +## Returns + +`Optional
` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 175. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-json-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-json-map.mdx new file mode 100644 index 0000000000..8a1d27031b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-json-map.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-json-map" +title: "fromJsonMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.fromJsonMap" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `fromJsonMap` + +Build a model from an already-parsed list-of-maps. + +Mirrors Python's +dict-input branch of `from_json`. + +**Modifiers:** `static` + +## Signature + +```java +public static PromptObjectModel fromJsonMap(List> data) +``` + +## Parameters + + + +## Returns + +`PromptObjectModel` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 99. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-json.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-json.mdx new file mode 100644 index 0000000000..3bf82bfbfd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-json.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-json" +title: "fromJson" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.fromJson" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `fromJson` + +Parse a JSON string into a model. + +Mirrors Python +`PromptObjectModel.from_json(str)`. + +**Modifiers:** `static` + +## Signature + +```java +public static PromptObjectModel fromJson(String json) +``` + +## Parameters + + + +## Returns + +`PromptObjectModel` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 87. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-yaml-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-yaml-map.mdx new file mode 100644 index 0000000000..6a64ff178f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-yaml-map.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-yaml-map" +title: "fromYamlMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.fromYamlMap" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `fromYamlMap` + +Build a model from an already-parsed list-of-maps (YAML form). +Mirrors Python's dict-input branch of `from_yaml`. + +**Modifiers:** `static` + +## Signature + +```java +public static PromptObjectModel fromYamlMap(List> data) +``` + +## Parameters + + + +## Returns + +`PromptObjectModel` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 129. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-yaml.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-yaml.mdx new file mode 100644 index 0000000000..7ed53c98a3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-yaml.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/from-yaml" +title: "fromYaml" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.fromYaml" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `fromYaml` + +Parse a YAML string into a model. + +Mirrors Python `from_yaml(str)`. + +**Modifiers:** `static` + +## Signature + +```java +public static PromptObjectModel fromYaml(String yaml) +``` + +## Parameters + + + +## Returns + +`PromptObjectModel` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 108. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/get-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/get-sections.mdx new file mode 100644 index 0000000000..53078c7db5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/get-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/get-sections" +title: "getSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.getSections" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `getSections` + +## Signature + +```java +public List
getSections() +``` + +## Returns + +`List
` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 71. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/index.mdx new file mode 100644 index 0000000000..c49ba97393 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/index.mdx @@ -0,0 +1,109 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model" +title: "PromptObjectModel" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel" + parent: "com.signalwire.sdk.pom" + module: "com.signalwire.sdk.pom" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `PromptObjectModel` + +A structured data format for composing, organising, and rendering prompt +instructions for large language models. + +Java port of the Python reference +`signalwire.pom.pom.PromptObjectModel` (signalwire-python: +`pom/pom.py`). + +<p>The Prompt Object Model provides a tree-based representation of a prompt +document composed of nested `Section`s. Each section can include a +title, body text, bullet points, and arbitrarily nested subsections. + +<p>Idiom mapping: +<ul> + <li>Python `to_dict()` ↔ Java `#toMap()` (returns + `List<Map<String,Object>>`)</li> + <li>Python `from_json(str|dict)` ↔ Java `#fromJson(String)` + and `#fromJsonMap(List)`</li> + <li>Python `from_yaml(str|dict)` ↔ Java `#fromYaml(String)` + and `#fromYamlMap(List)`</li> +</ul> + +## Signature + +```java +public class PromptObjectModel +``` + +## Methods + + + + Empty model (Python parity: `PromptObjectModel()` with debug=False). + + + + Add another POM's top-level sections as subsections of an existing section. + + + + Add a top-level section. + + + + Recursively search for a section with the given title. + + + + Parse a JSON string into a model. + + + + Build a model from an already-parsed list-of-maps. + + + + Parse a YAML string into a model. + + + + Build a model from an already-parsed list-of-maps (YAML form). Mirrors Python's dict-input branch of `from_yaml`. + + + + + + + + Render the entire model as Markdown. + + + + Render the entire model as XML. + + + + Convert to a JSON string with 2-space indent. + + + + Convert the entire model to a list of maps. + + + + Convert to a YAML string. + + + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/init.mdx new file mode 100644 index 0000000000..3d5ca5b2e0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/init.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel." + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `` + +Empty model (Python parity: `PromptObjectModel()` with debug=False). + +## Signature + + + + ```java + public () + ``` + + + + ```java + public (boolean debug) + ``` + + + + ```java + public (List> data) + ``` + + + +## Parameters (Overload 2) + + + +## Parameters (Overload 3) + + + list of section maps (each entry is one top-level section) + + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 47. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/is-debug.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/is-debug.mdx new file mode 100644 index 0000000000..18d896b19a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/is-debug.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/is-debug" +title: "isDebug" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.isDebug" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `isDebug` + +## Signature + +```java +public boolean isDebug() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 75. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/render-markdown.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/render-markdown.mdx new file mode 100644 index 0000000000..838fc7125e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/render-markdown.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/render-markdown" +title: "renderMarkdown" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.renderMarkdown" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `renderMarkdown` + +Render the entire model as Markdown. + +Mirrors Python `render_markdown()`. + +## Signature + +```java +public String renderMarkdown() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 256. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/render-xml.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/render-xml.mdx new file mode 100644 index 0000000000..924f16729c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/render-xml.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/render-xml" +title: "renderXml" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.renderXml" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `renderXml` + +Render the entire model as XML. + +Mirrors Python `render_xml()`. + +## Signature + +```java +public String renderXml() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 285. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-json.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-json.mdx new file mode 100644 index 0000000000..87e822a8e7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-json.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-json" +title: "toJson" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.toJson" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `toJson` + +Convert to a JSON string with 2-space indent. + +Mirrors Python `to_json`. + +## Signature + +```java +public String toJson() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 235. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-map.mdx new file mode 100644 index 0000000000..5629edee4c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-map.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-map" +title: "toMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.toMap" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `toMap` + +Convert the entire model to a list of maps. + +Mirrors Python +`to_dict()` (named `toMap` here because the Java return +type is `List>`). + +## Signature + +```java +public List> toMap() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 226. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-yaml.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-yaml.mdx new file mode 100644 index 0000000000..1398cec1a3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-yaml.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/prompt-object-model/to-yaml" +title: "toYaml" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.PromptObjectModel.toYaml" + parent: "com.signalwire.sdk.pom.PromptObjectModel" + module: "com.signalwire.sdk.pom.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java" + visibility: "public" +--- +# `toYaml` + +Convert to a YAML string. + +Output matches Python's +default\_flow\_style=False, sort\_keys=False). + +## Signature + +```java +public String toYaml() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/PromptObjectModel.java) + +Line 243. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/add-body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/add-body.mdx new file mode 100644 index 0000000000..9d641167f9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/add-body.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/add-body" +title: "addBody" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.addBody" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `addBody` + +Add or replace the body text for this section. + +Mirrors Python +`Section.add_body`. + +## Signature + +```java +public void addBody(String body) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 103. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/add-bullets.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/add-bullets.mdx new file mode 100644 index 0000000000..5b5f231d4b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/add-bullets.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/add-bullets" +title: "addBullets" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.addBullets" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `addBullets` + +Append bullet points to this section. + +Mirrors Python +`Section.add_bullets` (which extends, not replaces). + +## Signature + +```java +public void addBullets(List bullets) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 111. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/add-subsection.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/add-subsection.mdx new file mode 100644 index 0000000000..d309475950 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/add-subsection.mdx @@ -0,0 +1,111 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/add-subsection" +title: "addSubsection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.addSubsection" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `addSubsection` + +Add a subsection to this section. + +Mirrors Python +`Section.add_subsection`. Subsections must have a title. + +## Signature + + + + ```java + public Section addSubsection( + String title, + String body, + List bullets, + Boolean numbered, + boolean numberedBullets + ) + ``` + + + + ```java + public Section addSubsection(String title) + ``` + + + + ```java + public Section addSubsection(String title, String body) + ``` + + + + ```java + public Section addSubsection(String title, String body, List bullets) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + + + +## Parameters (Overload 2) + + + +## Parameters (Overload 3) + + + + + +## Parameters (Overload 4) + + + + + + + +## Returns (Overload 1) + +`Section` — the newly created sub-`Section` + +## Returns (Overload 2) + +`Section` + +## Returns (Overload 3) + +`Section` + +## Returns (Overload 4) + +`Section` + +## Throws + +- `IllegalArgumentException` — if `title` is `null` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 123. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-body.mdx new file mode 100644 index 0000000000..f1cc22aa4e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/get-body" +title: "getBody" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.getBody" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `getBody` + +## Signature + +```java +public String getBody() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 79. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-bullets.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-bullets.mdx new file mode 100644 index 0000000000..560051449f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-bullets.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/get-bullets" +title: "getBullets" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.getBullets" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `getBullets` + +## Signature + +```java +public List getBullets() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 83. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-numbered.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-numbered.mdx new file mode 100644 index 0000000000..83badc546d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-numbered.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/get-numbered" +title: "getNumbered" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.getNumbered" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `getNumbered` + +## Signature + +```java +public Boolean getNumbered() +``` + +## Returns + +`Boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 91. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-subsections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-subsections.mdx new file mode 100644 index 0000000000..804b1e1b44 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-subsections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/get-subsections" +title: "getSubsections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.getSubsections" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `getSubsections` + +## Signature + +```java +public List
getSubsections() +``` + +## Returns + +`List
` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 87. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-title.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-title.mdx new file mode 100644 index 0000000000..79666f9daf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/get-title.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/get-title" +title: "getTitle" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.getTitle" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `getTitle` + +## Signature + +```java +public String getTitle() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 75. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/index.mdx new file mode 100644 index 0000000000..915c82ca5a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/index.mdx @@ -0,0 +1,93 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section" +title: "Section" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section" + parent: "com.signalwire.sdk.pom" + module: "com.signalwire.sdk.pom" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `Section` + +Represents a section in the Prompt Object Model. + +<p>Each section contains a title, optional body text, optional bullet points, +and can have any number of nested subsections. + +Mirrors the Python reference +`signalwire.pom.pom.Section` (see signalwire-python: pom/pom.py). + +<p>Idiom mapping: +<ul> + <li>Python `to_dict()` ↔ Java `#toMap()` (returns + `Map<String,Object>`)</li> + <li>Python section_number) ↔ Java + java.util.List)</li> + <li>Python section_number) ↔ Java + java.util.List)</li> +</ul> + +<p>Output format is byte-identical to Python's renderer so cross-port POMs +can round-trip through markdown/XML/JSON. + +## Signature + +```java +public class Section +``` + +## Methods + + + + Construct a section. + + + + Add or replace the body text for this section. + + + + Append bullet points to this section. + + + + Add a subsection to this section. + + + + + + + + + + + + + + + + Render this section and its subsections as Markdown. + + + + Render this section and its subsections as XML. + + + + Convert this section to an ordered `Map` for JSON / YAML serialisation. + + + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/init.mdx new file mode 100644 index 0000000000..167a7a1e8c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/init.mdx @@ -0,0 +1,105 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section." + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `` + +Construct a section. + +All parameters except `title` default to +empty/null. Mirrors Python's keyword-only constructor. + +## Signature + + + + ```java + public ( + String title, + String body, + List bullets, + Boolean numbered, + boolean numberedBullets + ) + ``` + + + + ```java + public (String title) + ``` + + + + ```java + public (String title, String body) + ``` + + + + ```java + public (String title, String body, List bullets) + ``` + + + +## Parameters (Overload 1) + + + section title (may be `null` for an unnamed root) + + + + body text (must not be `null`) + + + + bullet points (may be `null` → empty list) + + + + tri-state numbering flag (may be `null`) + + + + when `true`, bullets render as a numbered list + + +## Parameters (Overload 2) + + + +## Parameters (Overload 3) + + + + + +## Parameters (Overload 4) + + + + + + + +## Throws + +- `NullPointerException` — if `body` is `null` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 50. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/is-numbered-bullets.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/is-numbered-bullets.mdx new file mode 100644 index 0000000000..58dcd3a7be --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/is-numbered-bullets.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/is-numbered-bullets" +title: "isNumberedBullets" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.isNumberedBullets" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `isNumberedBullets` + +## Signature + +```java +public boolean isNumberedBullets() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 95. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/render-markdown.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/render-markdown.mdx new file mode 100644 index 0000000000..f633ea0358 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/render-markdown.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/render-markdown" +title: "renderMarkdown" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.renderMarkdown" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `renderMarkdown` + +Render this section and its subsections as Markdown. + +Mirrors Python +`Section.render_markdown`. + +## Signature + + + + ```java + public String renderMarkdown(int level, List sectionNumber) + ``` + + + + ```java + public String renderMarkdown() + ``` + + + +## Parameters (Overload 1) + + + heading level (default 2 → "##") + + + + current numbering breadcrumb (may be `null`) + + +## Returns (Overload 1) + +`String` + +## Returns (Overload 2) + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 188. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/render-xml.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/render-xml.mdx new file mode 100644 index 0000000000..7a7dcf7a16 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/render-xml.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/render-xml" +title: "renderXml" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.renderXml" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `renderXml` + +Render this section and its subsections as XML. + +Mirrors Python +`Section.render_xml`. + +## Signature + + + + ```java + public String renderXml(int indent, List sectionNumber) + ``` + + + + ```java + public String renderXml() + ``` + + + +## Parameters (Overload 1) + + + + + +## Returns (Overload 1) + +`String` + +## Returns (Overload 2) + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 259. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/to-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/to-map.mdx new file mode 100644 index 0000000000..bd975c2bb8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/pom/pom/section/to-map.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/pom/pom/section/to-map" +title: "toMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.pom.Section.toMap" + parent: "com.signalwire.sdk.pom.Section" + module: "com.signalwire.sdk.pom.Section" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java" + visibility: "public" +--- +# `toMap` + +Convert this section to an ordered `Map` for JSON / YAML +serialisation. + +Mirrors Python `Section.to_dict`: keys appear in +the same order (title, body, bullets, subsections, numbered, +numberedBullets) and empty/false values are omitted. + +## Signature + +```java +public Map toMap() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/pom/Section.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/pom/Section.java) + +Line 154. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/amenity.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/amenity.mdx new file mode 100644 index 0000000000..cd909c3243 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/amenity.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/amenity" +title: "amenity" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ConciergeAgent.amenity" + parent: "com.signalwire.sdk.prefabs.ConciergeAgent" + module: "com.signalwire.sdk.prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java" + visibility: "public" +--- +# `amenity` + +**Modifiers:** `static` + +## Signature + +```java +public static Map amenity( + String name, + String description, + String hours, + String location, + String price +) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java) + +Line 120. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/get-agent.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/get-agent.mdx new file mode 100644 index 0000000000..64b7480b99 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/get-agent.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/get-agent" +title: "getAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ConciergeAgent.getAgent" + parent: "com.signalwire.sdk.prefabs.ConciergeAgent" + module: "com.signalwire.sdk.prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java" + visibility: "public" +--- +# `getAgent` + +## Signature + +```java +public AgentBase getAgent() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java) + +Line 116. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/index.mdx new file mode 100644 index 0000000000..6b747a685a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent" +title: "ConciergeAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ConciergeAgent" + parent: "com.signalwire.sdk.prefabs" + module: "com.signalwire.sdk.prefabs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java" + visibility: "public" +--- +# `ConciergeAgent` + +Pre-built agent for venue concierge with amenity info and availability checking. + +## Signature + +```java +public class ConciergeAgent +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java) + +Line 12. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/init.mdx new file mode 100644 index 0000000000..1a45cc2405 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/init.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ConciergeAgent." + parent: "com.signalwire.sdk.prefabs.ConciergeAgent" + module: "com.signalwire.sdk.prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public ( + String name, + String venueName, + List> amenities + ) + ``` + + + + ```java + public ( + String name, + String venueName, + List> amenities, + String route, + int port + ) + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Parameters (Overload 2) + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java) + +Line 16. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/run.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/run.mdx new file mode 100644 index 0000000000..98aff3df66 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/run.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/run" +title: "run" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ConciergeAgent.run" + parent: "com.signalwire.sdk.prefabs.ConciergeAgent" + module: "com.signalwire.sdk.prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java" + visibility: "public" +--- +# `run` + +## Signature + +```java +public void run() +``` + +## Throws + +- `Exception` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java) + +Line 118. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/serve.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/serve.mdx new file mode 100644 index 0000000000..82c704e81d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/serve.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/concierge-agent/serve" +title: "serve" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ConciergeAgent.serve" + parent: "com.signalwire.sdk.prefabs.ConciergeAgent" + module: "com.signalwire.sdk.prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java" + visibility: "public" +--- +# `serve` + +## Signature + +```java +public void serve() +``` + +## Throws + +- `Exception` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ConciergeAgent.java) + +Line 117. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/faq.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/faq.mdx new file mode 100644 index 0000000000..fde78bbab1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/faq.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/faq" +title: "faq" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.FAQBotAgent.faq" + parent: "com.signalwire.sdk.prefabs.FAQBotAgent" + module: "com.signalwire.sdk.prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java" + visibility: "public" +--- +# `faq` + +**Modifiers:** `static` + +## Signature + +```java +public static Map faq( + String question, + String answer, + List keywords +) +``` + +## Parameters + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java) + +Line 115. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/get-agent.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/get-agent.mdx new file mode 100644 index 0000000000..8c606fea0a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/get-agent.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/get-agent" +title: "getAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.FAQBotAgent.getAgent" + parent: "com.signalwire.sdk.prefabs.FAQBotAgent" + module: "com.signalwire.sdk.prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java" + visibility: "public" +--- +# `getAgent` + +## Signature + +```java +public AgentBase getAgent() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java) + +Line 111. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/index.mdx new file mode 100644 index 0000000000..20658cdfbd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent" +title: "FAQBotAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.FAQBotAgent" + parent: "com.signalwire.sdk.prefabs" + module: "com.signalwire.sdk.prefabs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java" + visibility: "public" +--- +# `FAQBotAgent` + +Pre-built agent for keyword-based FAQ matching with optional related suggestions. + +## Signature + +```java +public class FAQBotAgent +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java) + +Line 12. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/init.mdx new file mode 100644 index 0000000000..b170bebd51 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/init.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.FAQBotAgent." + parent: "com.signalwire.sdk.prefabs.FAQBotAgent" + module: "com.signalwire.sdk.prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public (String name, List> faqs) + ``` + + + + ```java + public ( + String name, + List> faqs, + String route, + int port + ) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java) + +Line 16. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/run.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/run.mdx new file mode 100644 index 0000000000..99b0a50674 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/run.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/run" +title: "run" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.FAQBotAgent.run" + parent: "com.signalwire.sdk.prefabs.FAQBotAgent" + module: "com.signalwire.sdk.prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java" + visibility: "public" +--- +# `run` + +## Signature + +```java +public void run() +``` + +## Throws + +- `Exception` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java) + +Line 113. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/serve.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/serve.mdx new file mode 100644 index 0000000000..e4e83df99f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/serve.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/faq-bot-agent/serve" +title: "serve" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.FAQBotAgent.serve" + parent: "com.signalwire.sdk.prefabs.FAQBotAgent" + module: "com.signalwire.sdk.prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java" + visibility: "public" +--- +# `serve` + +## Signature + +```java +public void serve() +``` + +## Throws + +- `Exception` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/FAQBotAgent.java) + +Line 112. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/index.mdx new file mode 100644 index 0000000000..6ad513889d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs" +title: "prefabs" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs" + module: "com.signalwire.sdk.prefabs" +--- +# `prefabs` + +## Signature + +```java +package com.signalwire.sdk.prefabs +``` + +## Classes + + + + Pre-built agent for venue concierge with amenity info and availability checking. + + + + Pre-built agent for keyword-based FAQ matching with optional related suggestions. + + + + Pre-built agent for sequential question collection with key/value answers. Wraps the info\_gatherer skill with agent-level configuration. + + + + Pre-built agent for department routing with call transfer. Routes callers to appropriate departments via phone numbers or SWML URLs. + + + + Pre-built agent for conducting typed surveys. Supports rating, multiple\_choice, yes\_no, and open\_ended question types. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/get-agent.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/get-agent.mdx new file mode 100644 index 0000000000..b7befc1341 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/get-agent.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/get-agent" +title: "getAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.InfoGathererAgent.getAgent" + parent: "com.signalwire.sdk.prefabs.InfoGathererAgent" + module: "com.signalwire.sdk.prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java" + visibility: "public" +--- +# `getAgent` + +## Signature + +```java +public AgentBase getAgent() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java) + +Line 42. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/index.mdx new file mode 100644 index 0000000000..6b21506233 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent" +title: "InfoGathererAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.InfoGathererAgent" + parent: "com.signalwire.sdk.prefabs" + module: "com.signalwire.sdk.prefabs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java" + visibility: "public" +--- +# `InfoGathererAgent` + +Pre-built agent for sequential question collection with key/value answers. +Wraps the info\_gatherer skill with agent-level configuration. + +## Signature + +```java +public class InfoGathererAgent +``` + +## Methods + + + + + + + + Convenience builder for questions. + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java) + +Line 11. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/init.mdx new file mode 100644 index 0000000000..71b1af65cb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/init.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.InfoGathererAgent." + parent: "com.signalwire.sdk.prefabs.InfoGathererAgent" + module: "com.signalwire.sdk.prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public (String name, List> questions) + ``` + + + + ```java + public ( + String name, + List> questions, + String route, + int port + ) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/question.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/question.mdx new file mode 100644 index 0000000000..c72329118a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/question.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/question" +title: "question" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.InfoGathererAgent.question" + parent: "com.signalwire.sdk.prefabs.InfoGathererAgent" + module: "com.signalwire.sdk.prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java" + visibility: "public" +--- +# `question` + +Convenience builder for questions. + +**Modifiers:** `static` + +## Signature + + + + ```java + public static Map question(String keyName, String questionText) + ``` + + + + ```java + public static Map question( + String keyName, + String questionText, + boolean confirm, + String promptAdd + ) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + + + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java) + +Line 57. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/run.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/run.mdx new file mode 100644 index 0000000000..920caaec7f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/run.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/run" +title: "run" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.InfoGathererAgent.run" + parent: "com.signalwire.sdk.prefabs.InfoGathererAgent" + module: "com.signalwire.sdk.prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java" + visibility: "public" +--- +# `run` + +## Signature + +```java +public void run() +``` + +## Throws + +- `Exception` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java) + +Line 50. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/serve.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/serve.mdx new file mode 100644 index 0000000000..1ab897547c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/serve.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/info-gatherer-agent/serve" +title: "serve" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.InfoGathererAgent.serve" + parent: "com.signalwire.sdk.prefabs.InfoGathererAgent" + module: "com.signalwire.sdk.prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java" + visibility: "public" +--- +# `serve` + +## Signature + +```java +public void serve() +``` + +## Throws + +- `Exception` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/InfoGathererAgent.java) + +Line 46. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/get-agent.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/get-agent.mdx new file mode 100644 index 0000000000..b251d0d6cb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/get-agent.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/get-agent" +title: "getAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ReceptionistAgent.getAgent" + parent: "com.signalwire.sdk.prefabs.ReceptionistAgent" + module: "com.signalwire.sdk.prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java" + visibility: "public" +--- +# `getAgent` + +## Signature + +```java +public AgentBase getAgent() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java) + +Line 59. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/index.mdx new file mode 100644 index 0000000000..36c53c28d0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent" +title: "ReceptionistAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ReceptionistAgent" + parent: "com.signalwire.sdk.prefabs" + module: "com.signalwire.sdk.prefabs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java" + visibility: "public" +--- +# `ReceptionistAgent` + +Pre-built agent for department routing with call transfer. +Routes callers to appropriate departments via phone numbers or SWML URLs. + +## Signature + +```java +public class ReceptionistAgent +``` + +## Methods + + + + + + + + Create a phone-based department config. + + + + + + + + Create a SWML-based department config. + + + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java) + +Line 11. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/init.mdx new file mode 100644 index 0000000000..7ffca52876 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/init.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ReceptionistAgent." + parent: "com.signalwire.sdk.prefabs.ReceptionistAgent" + module: "com.signalwire.sdk.prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public ( + String name, + String greeting, + Map> departments + ) + ``` + + + + ```java + public ( + String name, + String greeting, + Map> departments, + String route, + int port + ) + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Parameters (Overload 2) + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/phone-department.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/phone-department.mdx new file mode 100644 index 0000000000..6f48aaf01e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/phone-department.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/phone-department" +title: "phoneDepartment" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ReceptionistAgent.phoneDepartment" + parent: "com.signalwire.sdk.prefabs.ReceptionistAgent" + module: "com.signalwire.sdk.prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java" + visibility: "public" +--- +# `phoneDepartment` + +Create a phone-based department config. + +**Modifiers:** `static` + +## Signature + +```java +public static Map phoneDepartment( + String description, + String phoneNumber +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java) + +Line 66. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/run.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/run.mdx new file mode 100644 index 0000000000..beaf4e2a09 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/run.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/run" +title: "run" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ReceptionistAgent.run" + parent: "com.signalwire.sdk.prefabs.ReceptionistAgent" + module: "com.signalwire.sdk.prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java" + visibility: "public" +--- +# `run` + +## Signature + +```java +public void run() +``` + +## Throws + +- `Exception` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java) + +Line 61. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/serve.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/serve.mdx new file mode 100644 index 0000000000..e29f3028b1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/serve.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/serve" +title: "serve" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ReceptionistAgent.serve" + parent: "com.signalwire.sdk.prefabs.ReceptionistAgent" + module: "com.signalwire.sdk.prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java" + visibility: "public" +--- +# `serve` + +## Signature + +```java +public void serve() +``` + +## Throws + +- `Exception` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java) + +Line 60. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/swml-department.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/swml-department.mdx new file mode 100644 index 0000000000..826352a432 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/swml-department.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/receptionist-agent/swml-department" +title: "swmlDepartment" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.ReceptionistAgent.swmlDepartment" + parent: "com.signalwire.sdk.prefabs.ReceptionistAgent" + module: "com.signalwire.sdk.prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java" + visibility: "public" +--- +# `swmlDepartment` + +Create a SWML-based department config. + +**Modifiers:** `static` + +## Signature + +```java +public static Map swmlDepartment( + String description, + String swmlUrl +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/ReceptionistAgent.java) + +Line 77. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/get-agent.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/get-agent.mdx new file mode 100644 index 0000000000..64a95e251c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/get-agent.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/get-agent" +title: "getAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.SurveyAgent.getAgent" + parent: "com.signalwire.sdk.prefabs.SurveyAgent" + module: "com.signalwire.sdk.prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java" + visibility: "public" +--- +# `getAgent` + +## Signature + +```java +public AgentBase getAgent() +``` + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java) + +Line 167. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/index.mdx new file mode 100644 index 0000000000..66cfd96220 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent" +title: "SurveyAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.SurveyAgent" + parent: "com.signalwire.sdk.prefabs" + module: "com.signalwire.sdk.prefabs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java" + visibility: "public" +--- +# `SurveyAgent` + +Pre-built agent for conducting typed surveys. +Supports rating, multiple\_choice, yes\_no, and open\_ended question types. + +## Signature + +```java +public class SurveyAgent +``` + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java) + +Line 13. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/init.mdx new file mode 100644 index 0000000000..bd51f7d256 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/init.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.SurveyAgent." + parent: "com.signalwire.sdk.prefabs.SurveyAgent" + module: "com.signalwire.sdk.prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public (String name, List> questions) + ``` + + + + ```java + public ( + String name, + List> questions, + String completionMessage, + String route, + int port + ) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/multiple-choice-question.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/multiple-choice-question.mdx new file mode 100644 index 0000000000..c65b0d8346 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/multiple-choice-question.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/multiple-choice-question" +title: "multipleChoiceQuestion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.SurveyAgent.multipleChoiceQuestion" + parent: "com.signalwire.sdk.prefabs.SurveyAgent" + module: "com.signalwire.sdk.prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java" + visibility: "public" +--- +# `multipleChoiceQuestion` + +**Modifiers:** `static` + +## Signature + +```java +public static Map multipleChoiceQuestion( + String question, + List options +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java) + +Line 175. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/open-ended-question.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/open-ended-question.mdx new file mode 100644 index 0000000000..e1d064771a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/open-ended-question.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/open-ended-question" +title: "openEndedQuestion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.SurveyAgent.openEndedQuestion" + parent: "com.signalwire.sdk.prefabs.SurveyAgent" + module: "com.signalwire.sdk.prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java" + visibility: "public" +--- +# `openEndedQuestion` + +**Modifiers:** `static` + +## Signature + +```java +public static Map openEndedQuestion(String question) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java) + +Line 183. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/rating-question.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/rating-question.mdx new file mode 100644 index 0000000000..e6a6198113 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/rating-question.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/rating-question" +title: "ratingQuestion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.SurveyAgent.ratingQuestion" + parent: "com.signalwire.sdk.prefabs.SurveyAgent" + module: "com.signalwire.sdk.prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java" + visibility: "public" +--- +# `ratingQuestion` + +**Modifiers:** `static` + +## Signature + +```java +public static Map ratingQuestion( + String question, + int min, + int max +) +``` + +## Parameters + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java) + +Line 171. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/run.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/run.mdx new file mode 100644 index 0000000000..0f9b314e86 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/run.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/run" +title: "run" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.SurveyAgent.run" + parent: "com.signalwire.sdk.prefabs.SurveyAgent" + module: "com.signalwire.sdk.prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java" + visibility: "public" +--- +# `run` + +## Signature + +```java +public void run() +``` + +## Throws + +- `Exception` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java) + +Line 169. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/serve.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/serve.mdx new file mode 100644 index 0000000000..b56b034066 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/serve.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/serve" +title: "serve" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.SurveyAgent.serve" + parent: "com.signalwire.sdk.prefabs.SurveyAgent" + module: "com.signalwire.sdk.prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java" + visibility: "public" +--- +# `serve` + +## Signature + +```java +public void serve() +``` + +## Throws + +- `Exception` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java) + +Line 168. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/yes-no-question.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/yes-no-question.mdx new file mode 100644 index 0000000000..a2eed0c12b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/yes-no-question.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/prefabs/prefabs/survey-agent/yes-no-question" +title: "yesNoQuestion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.prefabs.SurveyAgent.yesNoQuestion" + parent: "com.signalwire.sdk.prefabs.SurveyAgent" + module: "com.signalwire.sdk.prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java" + visibility: "public" +--- +# `yesNoQuestion` + +**Modifiers:** `static` + +## Signature + +```java +public static Map yesNoQuestion(String question) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/prefabs/SurveyAgent.java) + +Line 179. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/index.mdx new file mode 100644 index 0000000000..ad448cd6c3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/ai-action" +title: "AiAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.AiAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `AiAction` + +AI action with stop sub-command. + +**Modifiers:** `static` + +## Signature + +```java +public static class AiAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 427. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/init.mdx new file mode 100644 index 0000000000..9ce6ab8a82 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/ai-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.AiAction." + parent: "com.signalwire.sdk.relay.Action.AiAction" + module: "com.signalwire.sdk.relay.Action.AiAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 428. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/is-terminal.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/is-terminal.mdx new file mode 100644 index 0000000000..c4949199f3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/is-terminal.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/ai-action/is-terminal" +title: "isTerminal" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.AiAction.isTerminal" + parent: "com.signalwire.sdk.relay.Action.AiAction" + module: "com.signalwire.sdk.relay.Action.AiAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "protected" +--- +# `isTerminal` + +**Decorators:** `@Override` + +## Signature + +```java +protected boolean isTerminal(String actionState) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 432. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/stop.mdx new file mode 100644 index 0000000000..19481e9705 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/ai-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/ai-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.AiAction.stop" + parent: "com.signalwire.sdk.relay.Action.AiAction" + module: "com.signalwire.sdk.relay.Action.AiAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 438. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/index.mdx new file mode 100644 index 0000000000..f6b8ec6f2a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/collect-action" +title: "CollectAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.CollectAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `CollectAction` + +Collect action with stop and start\_input\_timers sub-commands. + +**Modifiers:** `static` + +## Signature + +```java +public static class CollectAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 247. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/init.mdx new file mode 100644 index 0000000000..2c161c0fee --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/collect-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.CollectAction." + parent: "com.signalwire.sdk.relay.Action.CollectAction" + module: "com.signalwire.sdk.relay.Action.CollectAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 248. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/start-input-timers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..1e82d76447 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/start-input-timers.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/collect-action/start-input-timers" +title: "startInputTimers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.CollectAction.startInputTimers" + parent: "com.signalwire.sdk.relay.Action.CollectAction" + module: "com.signalwire.sdk.relay.Action.CollectAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `startInputTimers` + +## Signature + +```java +public void startInputTimers() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 261. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/stop.mdx new file mode 100644 index 0000000000..8fed9943ad --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/collect-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/collect-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.CollectAction.stop" + parent: "com.signalwire.sdk.relay.Action.CollectAction" + module: "com.signalwire.sdk.relay.Action.CollectAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 252. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/detect-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/detect-action/index.mdx new file mode 100644 index 0000000000..1558f0d4af --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/detect-action/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/detect-action" +title: "DetectAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.DetectAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `DetectAction` + +Detect action with stop sub-command. + +**Modifiers:** `static` + +## Signature + +```java +public static class DetectAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 229. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/detect-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/detect-action/init.mdx new file mode 100644 index 0000000000..3f610237eb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/detect-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/detect-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.DetectAction." + parent: "com.signalwire.sdk.relay.Action.DetectAction" + module: "com.signalwire.sdk.relay.Action.DetectAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 230. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/detect-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/detect-action/stop.mdx new file mode 100644 index 0000000000..870dda2650 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/detect-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/detect-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.DetectAction.stop" + parent: "com.signalwire.sdk.relay.Action.DetectAction" + module: "com.signalwire.sdk.relay.Action.DetectAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 234. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-call.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-call.mdx new file mode 100644 index 0000000000..7da19325c4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/get-call" +title: "getCall" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.getCall" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `getCall` + +## Signature + +```java +public Call getCall() +``` + +## Returns + +`Call` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 51. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-control-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-control-id.mdx new file mode 100644 index 0000000000..ce7e3229fe --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/get-control-id" +title: "getControlId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.getControlId" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `getControlId` + +## Signature + +```java +public String getControlId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 47. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-result.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-result.mdx new file mode 100644 index 0000000000..1f9ba8e601 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/get-result" +title: "getResult" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.getResult" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `getResult` + +## Signature + +```java +public RelayEvent getResult() +``` + +## Returns + +`RelayEvent` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 59. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-state.mdx new file mode 100644 index 0000000000..2280949210 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/get-state" +title: "getState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.getState" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `getState` + +## Signature + +```java +public String getState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 55. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/index.mdx new file mode 100644 index 0000000000..42507392a6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/index.mdx @@ -0,0 +1,132 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action" +title: "Action" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action" + parent: "com.signalwire.sdk.relay" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `Action` + +Base class for long-running call actions tracked by `control_id`. + +<p> +Actions support three completion patterns: +<ol> + <li><b>Wait inline</b>: `action.waitForCompletion()` blocks until terminal</li> + <li><b>Fire and forget</b>: don't wait, check `isDone()` later</li> + <li><b>Callback</b>: pass an `onCompleted` callback that fires on terminal state</li> +</ol> +<p> +Subclasses add action-specific sub-commands (pause, resume, volume, etc.). + +## Signature + +```java +public class Action +``` + +## Methods + + + + + + + + + + + + + + + + Check if a state is terminal for this action type. Subclasses may override for custom terminal states. + + + + Resolve the action immediately (e.g., on call-gone 404/410). + + + + + + Stop the action. + + + + + + Update state from an incoming event. + + + + Block until the action reaches a terminal state. + + + +## Classes + + + + AI action with stop sub-command. + + + + Collect action with stop and start\_input\_timers sub-commands. + + + + Detect action with stop sub-command. + + + + Pay action with stop sub-command. + + + + Play action with pause, resume, volume, and stop sub-commands. + + + + Play-and-collect action. <p> Shares one `control_id` across both play and collect phases. Events arrive as BOTH `calling.call.play` and `calling.call.collect`. This action only resolves on collect events, NOT play events. + + + + Receive fax action with stop sub-command. + + + + Record action with pause, resume, and stop sub-commands. + + + + Send fax action with stop sub-command. + + + + Stream action with stop sub-command. + + + + Tap action with stop sub-command. + + + + Transcribe action with stop sub-command. + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 28. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/init.mdx new file mode 100644 index 0000000000..75d69c3a8e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action." + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 40. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/is-done.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/is-done.mdx new file mode 100644 index 0000000000..441bfb549e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/is-done" +title: "isDone" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.isDone" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `isDone` + +## Signature + +```java +public boolean isDone() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 63. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/is-terminal.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/is-terminal.mdx new file mode 100644 index 0000000000..a38111e848 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/is-terminal.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/is-terminal" +title: "isTerminal" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.isTerminal" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "protected" +--- +# `isTerminal` + +Check if a state is terminal for this action type. +Subclasses may override for custom terminal states. + +## Signature + +```java +protected boolean isTerminal(String actionState) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 132. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/pay-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/pay-action/index.mdx new file mode 100644 index 0000000000..a548e37547 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/pay-action/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/pay-action" +title: "PayAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PayAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `PayAction` + +Pay action with stop sub-command. + +**Modifiers:** `static` + +## Signature + +```java +public static class PayAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 304. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/pay-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/pay-action/init.mdx new file mode 100644 index 0000000000..ff75a476c0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/pay-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/pay-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PayAction." + parent: "com.signalwire.sdk.relay.Action.PayAction" + module: "com.signalwire.sdk.relay.Action.PayAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 305. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/pay-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/pay-action/stop.mdx new file mode 100644 index 0000000000..7cb7cf75ca --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/pay-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/pay-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PayAction.stop" + parent: "com.signalwire.sdk.relay.Action.PayAction" + module: "com.signalwire.sdk.relay.Action.PayAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 309. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/index.mdx new file mode 100644 index 0000000000..d330c777aa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/play-action" +title: "PlayAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PlayAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `PlayAction` + +Play action with pause, resume, volume, and stop sub-commands. + +**Modifiers:** `static` + +## Signature + +```java +public static class PlayAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 157. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/init.mdx new file mode 100644 index 0000000000..879e018db3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/play-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PlayAction." + parent: "com.signalwire.sdk.relay.Action.PlayAction" + module: "com.signalwire.sdk.relay.Action.PlayAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 158. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/pause.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/pause.mdx new file mode 100644 index 0000000000..eb34614eb8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/pause.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/play-action/pause" +title: "pause" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PlayAction.pause" + parent: "com.signalwire.sdk.relay.Action.PlayAction" + module: "com.signalwire.sdk.relay.Action.PlayAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `pause` + +## Signature + +```java +public void pause() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 167. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/resume.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/resume.mdx new file mode 100644 index 0000000000..74a5e4765d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/resume.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/play-action/resume" +title: "resume" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PlayAction.resume" + parent: "com.signalwire.sdk.relay.Action.PlayAction" + module: "com.signalwire.sdk.relay.Action.PlayAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `resume` + +## Signature + +```java +public void resume() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 171. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/stop.mdx new file mode 100644 index 0000000000..7f69eb22ae --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/play-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PlayAction.stop" + parent: "com.signalwire.sdk.relay.Action.PlayAction" + module: "com.signalwire.sdk.relay.Action.PlayAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 162. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/volume.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/volume.mdx new file mode 100644 index 0000000000..146228532e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-action/volume.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/play-action/volume" +title: "volume" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PlayAction.volume" + parent: "com.signalwire.sdk.relay.Action.PlayAction" + module: "com.signalwire.sdk.relay.Action.PlayAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `volume` + +## Signature + +```java +public void volume(double volumeDb) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 175. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/index.mdx new file mode 100644 index 0000000000..14a5d9adda --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action" +title: "PlayAndCollectAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PlayAndCollectAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `PlayAndCollectAction` + +Play-and-collect action. + +<p> +Shares one `control_id` across both play and collect phases. +Events arrive as BOTH `calling.call.play` and `calling.call.collect`. +This action only resolves on collect events, NOT play events. + +**Modifiers:** `static` + +## Signature + +```java +public static class PlayAndCollectAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 277. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/init.mdx new file mode 100644 index 0000000000..bdb261b43b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PlayAndCollectAction." + parent: "com.signalwire.sdk.relay.Action.PlayAndCollectAction" + module: "com.signalwire.sdk.relay.Action.PlayAndCollectAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 278. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/stop.mdx new file mode 100644 index 0000000000..6ae29c0dbc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PlayAndCollectAction.stop" + parent: "com.signalwire.sdk.relay.Action.PlayAndCollectAction" + module: "com.signalwire.sdk.relay.Action.PlayAndCollectAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 282. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/volume.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/volume.mdx new file mode 100644 index 0000000000..bccd60c675 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/volume.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/play-and-collect-action/volume" +title: "volume" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.PlayAndCollectAction.volume" + parent: "com.signalwire.sdk.relay.Action.PlayAndCollectAction" + module: "com.signalwire.sdk.relay.Action.PlayAndCollectAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `volume` + +## Signature + +```java +public void volume(double volumeDb) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 291. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action/index.mdx new file mode 100644 index 0000000000..857d277094 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action" +title: "ReceiveFaxAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.ReceiveFaxAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `ReceiveFaxAction` + +Receive fax action with stop sub-command. + +**Modifiers:** `static` + +## Signature + +```java +public static class ReceiveFaxAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 340. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action/init.mdx new file mode 100644 index 0000000000..e981ebe8c1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.ReceiveFaxAction." + parent: "com.signalwire.sdk.relay.Action.ReceiveFaxAction" + module: "com.signalwire.sdk.relay.Action.ReceiveFaxAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 341. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action/stop.mdx new file mode 100644 index 0000000000..d443d9cb2c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/receive-fax-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.ReceiveFaxAction.stop" + parent: "com.signalwire.sdk.relay.Action.ReceiveFaxAction" + module: "com.signalwire.sdk.relay.Action.ReceiveFaxAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 345. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/index.mdx new file mode 100644 index 0000000000..326e250d73 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/record-action" +title: "RecordAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.RecordAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `RecordAction` + +Record action with pause, resume, and stop sub-commands. + +**Modifiers:** `static` + +## Signature + +```java +public static class RecordAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 193. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/init.mdx new file mode 100644 index 0000000000..dc38a46391 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/record-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.RecordAction." + parent: "com.signalwire.sdk.relay.Action.RecordAction" + module: "com.signalwire.sdk.relay.Action.RecordAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 194. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/pause-with-behavior.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/pause-with-behavior.mdx new file mode 100644 index 0000000000..ea4e3248ba --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/pause-with-behavior.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/record-action/pause-with-behavior" +title: "pauseWithBehavior" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.RecordAction.pauseWithBehavior" + parent: "com.signalwire.sdk.relay.Action.RecordAction" + module: "com.signalwire.sdk.relay.Action.RecordAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `pauseWithBehavior` + +## Signature + +```java +public void pauseWithBehavior(String behavior) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 207. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/pause.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/pause.mdx new file mode 100644 index 0000000000..c75fd6429a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/pause.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/record-action/pause" +title: "pause" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.RecordAction.pause" + parent: "com.signalwire.sdk.relay.Action.RecordAction" + module: "com.signalwire.sdk.relay.Action.RecordAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `pause` + +## Signature + +```java +public void pause() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 203. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/resume.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/resume.mdx new file mode 100644 index 0000000000..86bc22a7c4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/resume.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/record-action/resume" +title: "resume" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.RecordAction.resume" + parent: "com.signalwire.sdk.relay.Action.RecordAction" + module: "com.signalwire.sdk.relay.Action.RecordAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `resume` + +## Signature + +```java +public void resume() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 213. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/stop.mdx new file mode 100644 index 0000000000..3bb3365daf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/record-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/record-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.RecordAction.stop" + parent: "com.signalwire.sdk.relay.Action.RecordAction" + module: "com.signalwire.sdk.relay.Action.RecordAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 198. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/resolve.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/resolve.mdx new file mode 100644 index 0000000000..0156163571 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/resolve.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/resolve" +title: "resolve" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.resolve" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `resolve` + +Resolve the action immediately (e.g., on call-gone 404/410). + +## Signature + +```java +public void resolve(RelayEvent event) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 119. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action/index.mdx new file mode 100644 index 0000000000..283b94dbcb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action" +title: "SendFaxAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.SendFaxAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `SendFaxAction` + +Send fax action with stop sub-command. + +**Modifiers:** `static` + +## Signature + +```java +public static class SendFaxAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 322. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action/init.mdx new file mode 100644 index 0000000000..507e1451b7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.SendFaxAction." + parent: "com.signalwire.sdk.relay.Action.SendFaxAction" + module: "com.signalwire.sdk.relay.Action.SendFaxAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 323. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action/stop.mdx new file mode 100644 index 0000000000..04cfb3c992 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/send-fax-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.SendFaxAction.stop" + parent: "com.signalwire.sdk.relay.Action.SendFaxAction" + module: "com.signalwire.sdk.relay.Action.SendFaxAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 327. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/set-on-completed.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/set-on-completed.mdx new file mode 100644 index 0000000000..32b2d3b8df --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/set-on-completed.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/set-on-completed" +title: "setOnCompleted" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.setOnCompleted" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `setOnCompleted` + +## Signature + +```java +public void setOnCompleted(Consumer onCompleted) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 67. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stop.mdx new file mode 100644 index 0000000000..2ff5ac3dab --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.stop" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +Stop the action. + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 101. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/index.mdx new file mode 100644 index 0000000000..f1ffa405d0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/stream-action" +title: "StreamAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.StreamAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `StreamAction` + +Stream action with stop sub-command. + +**Modifiers:** `static` + +## Signature + +```java +public static class StreamAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 381. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/init.mdx new file mode 100644 index 0000000000..ac9fe2fde7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/stream-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.StreamAction." + parent: "com.signalwire.sdk.relay.Action.StreamAction" + module: "com.signalwire.sdk.relay.Action.StreamAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 382. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/is-terminal.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/is-terminal.mdx new file mode 100644 index 0000000000..4d7f15945b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/is-terminal.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/stream-action/is-terminal" +title: "isTerminal" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.StreamAction.isTerminal" + parent: "com.signalwire.sdk.relay.Action.StreamAction" + module: "com.signalwire.sdk.relay.Action.StreamAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "protected" +--- +# `isTerminal` + +**Decorators:** `@Override` + +## Signature + +```java +protected boolean isTerminal(String actionState) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 386. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/stop.mdx new file mode 100644 index 0000000000..8e4efdfa42 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/stream-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/stream-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.StreamAction.stop" + parent: "com.signalwire.sdk.relay.Action.StreamAction" + module: "com.signalwire.sdk.relay.Action.StreamAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 391. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/index.mdx new file mode 100644 index 0000000000..03129de98e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/tap-action" +title: "TapAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.TapAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `TapAction` + +Tap action with stop sub-command. + +**Modifiers:** `static` + +## Signature + +```java +public static class TapAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 358. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/init.mdx new file mode 100644 index 0000000000..6392317c1b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/tap-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.TapAction." + parent: "com.signalwire.sdk.relay.Action.TapAction" + module: "com.signalwire.sdk.relay.Action.TapAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 359. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/is-terminal.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/is-terminal.mdx new file mode 100644 index 0000000000..296322ba95 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/is-terminal.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/tap-action/is-terminal" +title: "isTerminal" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.TapAction.isTerminal" + parent: "com.signalwire.sdk.relay.Action.TapAction" + module: "com.signalwire.sdk.relay.Action.TapAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "protected" +--- +# `isTerminal` + +**Decorators:** `@Override` + +## Signature + +```java +protected boolean isTerminal(String actionState) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 363. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/stop.mdx new file mode 100644 index 0000000000..2e7ea8744a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/tap-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/tap-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.TapAction.stop" + parent: "com.signalwire.sdk.relay.Action.TapAction" + module: "com.signalwire.sdk.relay.Action.TapAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 368. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/to-string.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/to-string.mdx new file mode 100644 index 0000000000..ba95925df0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/to-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/to-string" +title: "toString" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.toString" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `toString` + +**Decorators:** `@Override` + +## Signature + +```java +public String toString() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 146. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/index.mdx new file mode 100644 index 0000000000..3d6ce420c6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action" +title: "TranscribeAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.TranscribeAction" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `TranscribeAction` + +Transcribe action with stop sub-command. + +**Modifiers:** `static` + +## Signature + +```java +public static class TranscribeAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/java/com/signalwire/sdk/relay/relay/action) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 404. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/init.mdx new file mode 100644 index 0000000000..f7b88f5342 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.TranscribeAction." + parent: "com.signalwire.sdk.relay.Action.TranscribeAction" + module: "com.signalwire.sdk.relay.Action.TranscribeAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String controlId, Call call) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 405. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/is-terminal.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/is-terminal.mdx new file mode 100644 index 0000000000..17c150b64a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/is-terminal.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/is-terminal" +title: "isTerminal" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.TranscribeAction.isTerminal" + parent: "com.signalwire.sdk.relay.Action.TranscribeAction" + module: "com.signalwire.sdk.relay.Action.TranscribeAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "protected" +--- +# `isTerminal` + +**Decorators:** `@Override` + +## Signature + +```java +protected boolean isTerminal(String actionState) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 409. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/stop.mdx new file mode 100644 index 0000000000..34f606604e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/transcribe-action/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.TranscribeAction.stop" + parent: "com.signalwire.sdk.relay.Action.TranscribeAction" + module: "com.signalwire.sdk.relay.Action.TranscribeAction" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `stop` + +**Decorators:** `@Override` + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 414. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/update-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/update-state.mdx new file mode 100644 index 0000000000..329fe81142 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/update-state.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/update-state" +title: "updateState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.updateState" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `updateState` + +Update state from an incoming event. + +Resolves the completion future +when a terminal state is reached. + +## Signature + +```java +public void updateState(String newState, RelayEvent event) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 109. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/wait-for-completion.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/wait-for-completion.mdx new file mode 100644 index 0000000000..57da9643b2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/action/wait-for-completion.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/action/wait-for-completion" +title: "waitForCompletion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Action.waitForCompletion" + parent: "com.signalwire.sdk.relay.Action" + module: "com.signalwire.sdk.relay.Action" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java" + visibility: "public" +--- +# `waitForCompletion` + +Block until the action reaches a terminal state. + +## Signature + + + + ```java + public RelayEvent waitForCompletion() + ``` + + + + ```java + public RelayEvent waitForCompletion(long timeoutMs) + ``` + + + +## Parameters (Overload 2) + + + timeout in milliseconds + + +## Returns (Overload 1) + +`RelayEvent` — the terminal event + +## Returns (Overload 2) + +`RelayEvent` — the terminal event, or null on timeout + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Action.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Action.java) + +Line 76. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai-hold.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai-hold.mdx new file mode 100644 index 0000000000..c852fdd4ac --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai-hold.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/ai-hold" +title: "aiHold" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.aiHold" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `aiHold` + +Put AI on hold. + +## Signature + +```java +public Map aiHold(Map options) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 909. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai-message.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai-message.mdx new file mode 100644 index 0000000000..d8681723d7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai-message.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/ai-message" +title: "aiMessage" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.aiMessage" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `aiMessage` + +Send a message to an active AI session. + +## Signature + +```java +public Map aiMessage(Map messageConfig) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 898. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai-unhold.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai-unhold.mdx new file mode 100644 index 0000000000..3a3c966b3d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai-unhold.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/ai-unhold" +title: "aiUnhold" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.aiUnhold" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `aiUnhold` + +Resume AI from hold. + +## Signature + +```java +public Map aiUnhold(Map options) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 920. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai.mdx new file mode 100644 index 0000000000..133d69b2ad --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/ai.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/ai" +title: "ai" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.ai" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `ai` + +Start an AI agent on the call. + +## Signature + + + + ```java + public Action.AiAction ai(Map aiConfig) + ``` + + + + ```java + public Action.AiAction ai(Map prompt, String controlId) + ``` + + + +## Parameters (Overload 1) + + + AI configuration + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Action.AiAction` — an AiAction + +## Returns (Overload 2) + +`Action.AiAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 856. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/amazon-bedrock.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/amazon-bedrock.mdx new file mode 100644 index 0000000000..c13aff8e29 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/amazon-bedrock.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/amazon-bedrock" +title: "amazonBedrock" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.amazonBedrock" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `amazonBedrock` + +Start Amazon Bedrock AI on the call. + +## Signature + +```java +public Map amazonBedrock(Map config) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 887. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/answer.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/answer.mdx new file mode 100644 index 0000000000..fe4c2f4116 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/answer.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/answer" +title: "answer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.answer" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `answer` + +Answer the call. + +## Signature + +```java +public Map answer() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 195. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/bind-digit.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/bind-digit.mdx new file mode 100644 index 0000000000..c4809f5c51 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/bind-digit.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/bind-digit" +title: "bindDigit" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.bindDigit" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `bindDigit` + +Bind a digit sequence to a method. + +## Signature + +```java +public Map bindDigit( + String digits, + String bindMethod, + Map options +) +``` + +## Parameters + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 274. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/clear-digit-bindings.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/clear-digit-bindings.mdx new file mode 100644 index 0000000000..875df42d36 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/clear-digit-bindings.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/clear-digit-bindings" +title: "clearDigitBindings" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.clearDigitBindings" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `clearDigitBindings` + +Clear digit bindings. + +## Signature + + + + ```java + public Map clearDigitBindings() + ``` + + + + ```java + public Map clearDigitBindings(String realm) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 287. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/collect-digits.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/collect-digits.mdx new file mode 100644 index 0000000000..f4c4ac0281 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/collect-digits.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/collect-digits" +title: "collectDigits" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.collectDigits" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `collectDigits` + +Collect digits with an explicit control\_id (test helper). + +## Signature + + + + ```java + public Action.CollectAction collectDigits( + Map digitsConfig, + String controlId + ) + ``` + + + + ```java + public Action.CollectAction collectDigits( + Map digitsConfig, + boolean startInputTimers, + String controlId + ) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + + + + + +## Returns (Overload 1) + +`Action.CollectAction` + +## Returns (Overload 2) + +`Action.CollectAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 598. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/collect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/collect.mdx new file mode 100644 index 0000000000..d25c0fc043 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/collect.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/collect" +title: "collect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.collect" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `collect` + +Collect digits or speech input. + +## Signature + +```java +public Action.CollectAction collect( + Map collectConfig, + Map options +) +``` + +## Parameters + + + collect configuration + + + + optional parameters + + +## Returns + +`Action.CollectAction` — a CollectAction + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 576. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/connect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/connect.mdx new file mode 100644 index 0000000000..563b82e6b1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/connect.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/connect" +title: "connect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.connect" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `connect` + +Connect another device to this call. + +## Signature + +```java +public Map connect( + List>> devices, + Map options +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 362. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/denoise-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/denoise-stop.mdx new file mode 100644 index 0000000000..fd4ce3c6b3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/denoise-stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/denoise-stop" +title: "denoiseStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.denoiseStop" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `denoiseStop` + +Disable denoise on the call. + +## Signature + +```java +public Map denoiseStop() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 247. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/denoise.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/denoise.mdx new file mode 100644 index 0000000000..79f949d2e5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/denoise.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/denoise" +title: "denoise" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.denoise" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `denoise` + +Enable denoise on the call. + +## Signature + +```java +public Map denoise() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 240. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/detect-with.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/detect-with.mdx new file mode 100644 index 0000000000..3c031faaf7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/detect-with.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/detect-with" +title: "detectWith" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.detectWith" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `detectWith` + +Detect with an explicit control\_id (test helper). + +Wraps in <config>. + +## Signature + +```java +public Action.DetectAction detectWith( + Map detectConfig, + String controlId +) +``` + +## Parameters + + + + + +## Returns + +`Action.DetectAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 565. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/detect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/detect.mdx new file mode 100644 index 0000000000..afaa154c63 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/detect.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/detect" +title: "detect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.detect" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `detect` + +Detect answering machine, fax, or digits. + +## Signature + +```java +public Action.DetectAction detect( + Map detectConfig, + Map options +) +``` + +## Parameters + + + detect configuration + + + + optional parameters (timeout, etc.) + + +## Returns + +`Action.DetectAction` — a DetectAction + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 542. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/disconnect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/disconnect.mdx new file mode 100644 index 0000000000..87a9b66146 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/disconnect.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/disconnect" +title: "disconnect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.disconnect" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `disconnect` + +Disconnect all connected calls. + +## Signature + +```java +public Map disconnect() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 374. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/dispatch-event.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/dispatch-event.mdx new file mode 100644 index 0000000000..a71f0b8deb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/dispatch-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/dispatch-event" +title: "dispatchEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.dispatchEvent" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `dispatchEvent` + +Dispatch an event to this call. + +Routes action events by control\_id. + +## Signature + +```java +public void dispatchEvent(RelayEvent event) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 92. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/echo.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/echo.mdx new file mode 100644 index 0000000000..621c89db78 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/echo.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/echo" +title: "echo" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.echo" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `echo` + +Start echo on the call. + +## Signature + +```java +public Map echo(Map options) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 254. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-action.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-action.mdx new file mode 100644 index 0000000000..c0928fccbf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-action.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/get-action" +title: "getAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.getAction" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `getAction` + +Get an action by control\_id. + +## Signature + +```java +public Action getAction(String controlId) +``` + +## Parameters + + + +## Returns + +`Action` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 186. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-call-id.mdx new file mode 100644 index 0000000000..7b01308964 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.getCallId" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 60. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-device.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-device.mdx new file mode 100644 index 0000000000..d167f8c0c9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-device.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/get-device" +title: "getDevice" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.getDevice" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `getDevice` + +## Signature + +```java +public Map getDevice() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 66. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-direction.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-direction.mdx new file mode 100644 index 0000000000..d3ddcd6d34 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-direction.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/get-direction" +title: "getDirection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.getDirection" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `getDirection` + +## Signature + +```java +public String getDirection() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 64. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-end-reason.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-end-reason.mdx new file mode 100644 index 0000000000..98d2714f3a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-end-reason.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/get-end-reason" +title: "getEndReason" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.getEndReason" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `getEndReason` + +## Signature + +```java +public String getEndReason() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 63. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-node-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-node-id.mdx new file mode 100644 index 0000000000..996c66ba37 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/get-node-id" +title: "getNodeId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.getNodeId" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```java +public String getNodeId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 61. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-state.mdx new file mode 100644 index 0000000000..39502729e9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/get-state" +title: "getState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.getState" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `getState` + +## Signature + +```java +public String getState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 62. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-tag.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-tag.mdx new file mode 100644 index 0000000000..86dae90f74 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/get-tag.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/get-tag" +title: "getTag" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.getTag" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `getTag` + +## Signature + +```java +public String getTag() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 65. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/hangup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/hangup.mdx new file mode 100644 index 0000000000..e30d5eec95 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/hangup.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/hangup" +title: "hangup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.hangup" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `hangup` + +Hang up the call. + +## Signature + + + + ```java + public Map hangup() + ``` + + + + ```java + public Map hangup(String reason) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 203. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/hold.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/hold.mdx new file mode 100644 index 0000000000..bdae9d5915 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/hold.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/hold" +title: "hold" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.hold" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `hold` + +Put the call on hold. + +## Signature + +```java +public Map hold() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 226. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/index.mdx new file mode 100644 index 0000000000..84670fad6e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/index.mdx @@ -0,0 +1,276 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call" +title: "Call" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call" + parent: "com.signalwire.sdk.relay" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `Call` + +Represents a RELAY call with 30+ methods organized by category. + +<p> +Methods are grouped into: +<ul> + <li><b>Simple fire-and-response</b>: answer, hangup, pass, hold, etc.</li> + <li><b>Action-based</b>: play, record, detect, collect, etc. + +(return `Action`)</li> + + <li><b>Connection</b>: connect, disconnect, transfer</li> + <li><b>Conference</b>: joinConference, leaveConference</li> + <li><b>AI</b>: ai, aiMessage, aiHold, aiUnhold, amazonBedrock</li> +</ul> + +Event routing: the `RelayClient` routes events to calls by `call_id`. +Each call maintains an `actions` map keyed by `control_id` for action events. + +## Signature + +```java +public class Call +``` + +## Methods + + + + + + Start an AI agent on the call. + + + + Put AI on hold. + + + + Send a message to an active AI session. + + + + Resume AI from hold. + + + + Start Amazon Bedrock AI on the call. + + + + Answer the call. + + + + Bind a digit sequence to a method. + + + + Clear digit bindings. + + + + Collect digits or speech input. + + + + Collect digits with an explicit control\_id (test helper). + + + + Connect another device to this call. + + + + Enable denoise on the call. + + + + Disable denoise on the call. + + + + Detect answering machine, fax, or digits. + + + + Detect with an explicit control\_id (test helper). + + + + Disconnect all connected calls. + + + + Dispatch an event to this call. + + + + Start echo on the call. + + + + Get an action by control\_id. + + + + + + + + + + + + + + + + + + Hang up the call. + + + + Put the call on hold. + + + + + + Join a conference. + + + + Join a room. + + + + Leave a conference. + + + + Leave a room. + + + + Start live transcription. + + + + Start live translation. + + + + Register an event listener on this call. + + + + Pass on an inbound call offer. + + + + Process payment via DTMF. + + + + Play media on the call. + + + + Play media and collect input. + + + + Enter a queue. + + + + Leave a queue. + + + + Receive a fax. + + + + Record the call. + + + + Record with an explicit control\_id (test helper). + + + + SIP REFER transfer. + + + + Register an action by control\_id. + + + + Resolve all pending actions (e.g., on call ended or call-gone). + + + + Send DTMF digits. + + + + Send a fax. + + + + + + + + + + + + + + + + + + Start streaming audio from the call. + + + + Tap audio from the call. + + + + + + Start transcription on the call. + + + + Transfer the call. + + + + Take the call off hold. + + + + Send a user event. + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 31. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/init.mdx new file mode 100644 index 0000000000..5123c90e2d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call." + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String callId, String nodeId) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 52. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/is-ended.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/is-ended.mdx new file mode 100644 index 0000000000..2421ebfc58 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/is-ended.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/is-ended" +title: "isEnded" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.isEnded" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `isEnded` + +## Signature + +```java +public boolean isEnded() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 76. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/join-conference.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/join-conference.mdx new file mode 100644 index 0000000000..0d3daba7e1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/join-conference.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/join-conference" +title: "joinConference" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.joinConference" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `joinConference` + +Join a conference. + +## Signature + +```java +public Map joinConference( + String name, + Map options +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 383. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/join-room.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/join-room.mdx new file mode 100644 index 0000000000..01e53faf6e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/join-room.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/join-room" +title: "joinRoom" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.joinRoom" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `joinRoom` + +Join a room. + +## Signature + +```java +public Map joinRoom(String name, Map options) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 406. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/leave-conference.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/leave-conference.mdx new file mode 100644 index 0000000000..299114dad5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/leave-conference.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/leave-conference" +title: "leaveConference" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.leaveConference" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `leaveConference` + +Leave a conference. + +## Signature + +```java +public Map leaveConference(String conferenceId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 395. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/leave-room.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/leave-room.mdx new file mode 100644 index 0000000000..0c2d798404 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/leave-room.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/leave-room" +title: "leaveRoom" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.leaveRoom" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `leaveRoom` + +Leave a room. + +## Signature + +```java +public Map leaveRoom() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 418. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/live-transcribe.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/live-transcribe.mdx new file mode 100644 index 0000000000..fddad633ac --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/live-transcribe.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/live-transcribe" +title: "liveTranscribe" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.liveTranscribe" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `liveTranscribe` + +Start live transcription. + +## Signature + +```java +public Map liveTranscribe(Map action) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 316. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/live-translate.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/live-translate.mdx new file mode 100644 index 0000000000..41fbf4be1f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/live-translate.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/live-translate" +title: "liveTranslate" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.liveTranslate" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `liveTranslate` + +Start live translation. + +## Signature + +```java +public Map liveTranslate( + Map action, + Map options +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 325. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/on.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/on.mdx new file mode 100644 index 0000000000..686f9a68b5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/on.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/on" +title: "on" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.on" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `on` + +Register an event listener on this call. + +## Signature + +```java +public void on(Consumer listener) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 85. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/pass.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/pass.mdx new file mode 100644 index 0000000000..73a27bd79a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/pass.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/pass" +title: "pass" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.pass" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `pass` + +Pass on an inbound call offer. + +## Signature + +```java +public Map pass() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 219. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/pay.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/pay.mdx new file mode 100644 index 0000000000..128cc0527c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/pay.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/pay" +title: "pay" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.pay" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `pay` + +Process payment via DTMF. + +## Signature + + + + ```java + public Action.PayAction pay( + String paymentConnectorUrl, + Map options + ) + ``` + + + + ```java + public Action.PayAction pay(String paymentConnectorUrl, String controlId) + ``` + + + +## Parameters (Overload 1) + + + connector URL + + + + optional parameters + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Action.PayAction` — a PayAction + +## Returns (Overload 2) + +`Action.PayAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 660. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/play-and-collect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/play-and-collect.mdx new file mode 100644 index 0000000000..ac435bd3e1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/play-and-collect.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/play-and-collect" +title: "playAndCollect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.playAndCollect" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `playAndCollect` + +Play media and collect input. + +## Signature + + + + ```java + public Action.PlayAndCollectAction playAndCollect( + List> media, + Map collectConfig, + Map options + ) + ``` + + + + ```java + public Action.PlayAndCollectAction playAndCollect( + List> media, + Map collectConfig, + String controlId + ) + ``` + + + +## Parameters (Overload 1) + + + list of media objects + + + + collect configuration + + + + optional parameters + + +## Parameters (Overload 2) + + + + + + + +## Returns (Overload 1) + +`Action.PlayAndCollectAction` — a PlayAndCollectAction + +## Returns (Overload 2) + +`Action.PlayAndCollectAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 622. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/play.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/play.mdx new file mode 100644 index 0000000000..49cad007bb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/play.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/play" +title: "play" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.play" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `play` + +Play media on the call. + +## Signature + + + + ```java + public Action.PlayAction play( + List> media, + Map options + ) + ``` + + + + ```java + public Action.PlayAction play(List> media) + ``` + + + + ```java + public Action.PlayAction play(List> media, String controlId) + ``` + + + +## Parameters (Overload 1) + + + list of media objects + + + + optional parameters (volume, direction, loop, etc.) + + +## Parameters (Overload 2) + + + +## Parameters (Overload 3) + + + + + +## Returns (Overload 1) + +`Action.PlayAction` — a PlayAction that can be waited on, paused, resumed, stopped + +## Returns (Overload 2) + +`Action.PlayAction` + +## Returns (Overload 3) + +`Action.PlayAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 461. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/queue-enter.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/queue-enter.mdx new file mode 100644 index 0000000000..40fbc18266 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/queue-enter.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/queue-enter" +title: "queueEnter" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.queueEnter" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `queueEnter` + +Enter a queue. + +## Signature + +```java +public Map queueEnter( + String queueName, + Map options +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 427. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/queue-leave.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/queue-leave.mdx new file mode 100644 index 0000000000..6d02a3f4b4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/queue-leave.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/queue-leave" +title: "queueLeave" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.queueLeave" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `queueLeave` + +Leave a queue. + +## Signature + +```java +public Map queueLeave( + String queueName, + Map options +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 441. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/receive-fax.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/receive-fax.mdx new file mode 100644 index 0000000000..d6034f8056 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/receive-fax.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/receive-fax" +title: "receiveFax" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.receiveFax" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `receiveFax` + +Receive a fax. + +## Signature + + + + ```java + public Action.ReceiveFaxAction receiveFax(Map options) + ``` + + + + ```java + public Action.ReceiveFaxAction receiveFax(String controlId) + ``` + + + +## Parameters (Overload 1) + + + optional parameters + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Action.ReceiveFaxAction` — a ReceiveFaxAction + +## Returns (Overload 2) + +`Action.ReceiveFaxAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 724. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/record-audio.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/record-audio.mdx new file mode 100644 index 0000000000..451e2cde83 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/record-audio.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/record-audio" +title: "recordAudio" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.recordAudio" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `recordAudio` + +Record with an explicit control\_id (test helper). + +The `audioConfig` +is wrapped as \{audio: <config>\} on the wire to match the +Python control\_id=...) pattern. + +## Signature + +```java +public Action.RecordAction recordAudio( + Map audioConfig, + String controlId +) +``` + +## Parameters + + + + + +## Returns + +`Action.RecordAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 529. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/record.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/record.mdx new file mode 100644 index 0000000000..ba3caee16d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/record.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/record" +title: "record" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.record" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `record` + +Record the call. + +## Signature + +```java +public Action.RecordAction record( + Map recordConfig, + Map options +) +``` + +## Parameters + + + record configuration object + + + + optional parameters + + +## Returns + +`Action.RecordAction` — a RecordAction + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 505. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/refer.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/refer.mdx new file mode 100644 index 0000000000..9fd2bd3596 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/refer.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/refer" +title: "refer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.refer" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `refer` + +SIP REFER transfer. + +## Signature + +```java +public Map refer( + Map deviceSpec, + Map options +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 337. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/register-action.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/register-action.mdx new file mode 100644 index 0000000000..283a504c0d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/register-action.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/register-action" +title: "registerAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.registerAction" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `registerAction` + +Register an action by control\_id. + +## Signature + +```java +public void registerAction(Action action) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 179. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/resolve-all-actions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/resolve-all-actions.mdx new file mode 100644 index 0000000000..37ad50b236 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/resolve-all-actions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/resolve-all-actions" +title: "resolveAllActions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.resolveAllActions" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `resolveAllActions` + +Resolve all pending actions (e.g., on call ended or call-gone). + +## Signature + +```java +public void resolveAllActions(RelayEvent event) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 167. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/send-digits.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/send-digits.mdx new file mode 100644 index 0000000000..e8b42d4d42 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/send-digits.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/send-digits" +title: "sendDigits" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.sendDigits" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `sendDigits` + +Send DTMF digits. + +## Signature + +```java +public Map sendDigits(String digits) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 349. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/send-fax.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/send-fax.mdx new file mode 100644 index 0000000000..5d66334375 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/send-fax.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/send-fax" +title: "sendFax" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.sendFax" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `sendFax` + +Send a fax. + +## Signature + + + + ```java + public Action.SendFaxAction sendFax( + String documentUrl, + Map options + ) + ``` + + + + ```java + public Action.SendFaxAction sendFax( + String documentUrl, + String identity, + String controlId + ) + ``` + + + +## Parameters (Overload 1) + + + URL to PDF document + + + + optional parameters + + +## Parameters (Overload 2) + + + + + + + +## Returns (Overload 1) + +`Action.SendFaxAction` — a SendFaxAction + +## Returns (Overload 2) + +`Action.SendFaxAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 691. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-client.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-client.mdx new file mode 100644 index 0000000000..1e77bf6dc1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/set-client" +title: "setClient" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.setClient" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `setClient` + +## Signature + +```java +public void setClient(RelayClient client) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 74. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-device.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-device.mdx new file mode 100644 index 0000000000..f765b9b53c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-device.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/set-device" +title: "setDevice" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.setDevice" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `setDevice` + +## Signature + +```java +public void setDevice(Map device) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 73. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-direction.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-direction.mdx new file mode 100644 index 0000000000..f1bd2a2ab4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-direction.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/set-direction" +title: "setDirection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.setDirection" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `setDirection` + +## Signature + +```java +public void setDirection(String direction) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 71. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-end-reason.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-end-reason.mdx new file mode 100644 index 0000000000..bd196bc8d8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-end-reason.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/set-end-reason" +title: "setEndReason" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.setEndReason" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `setEndReason` + +## Signature + +```java +public void setEndReason(String endReason) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 70. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-node-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-node-id.mdx new file mode 100644 index 0000000000..8cdc095869 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/set-node-id" +title: "setNodeId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.setNodeId" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `setNodeId` + +## Signature + +```java +public void setNodeId(String nodeId) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 68. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-state.mdx new file mode 100644 index 0000000000..9e493c9393 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/set-state" +title: "setState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.setState" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `setState` + +## Signature + +```java +public void setState(String state) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 69. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-tag.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-tag.mdx new file mode 100644 index 0000000000..6055a820d7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/set-tag.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/set-tag" +title: "setTag" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.setTag" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `setTag` + +## Signature + +```java +public void setTag(String tag) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 72. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/stream.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/stream.mdx new file mode 100644 index 0000000000..d070908851 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/stream.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/stream" +title: "stream" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.stream" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `stream` + +Start streaming audio from the call. + +## Signature + + + + ```java + public Action.StreamAction stream(String url, Map options) + ``` + + + + ```java + public Action.StreamAction stream(String url, String controlId) + ``` + + + + ```java + public Action.StreamAction stream(String url, String codec, String controlId) + ``` + + + +## Parameters (Overload 1) + + + WebSocket URL + + + + optional parameters (name, codec, track, etc.) + + +## Parameters (Overload 2) + + + + + +## Parameters (Overload 3) + + + + + + + +## Returns (Overload 1) + +`Action.StreamAction` — a StreamAction + +## Returns (Overload 2) + +`Action.StreamAction` + +## Returns (Overload 3) + +`Action.StreamAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 787. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/tap.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/tap.mdx new file mode 100644 index 0000000000..4d069e0df8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/tap.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/tap" +title: "tap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.tap" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `tap` + +Tap audio from the call. + +## Signature + + + + ```java + public Action.TapAction tap( + Map tapConfig, + Map tapDevice, + Map options + ) + ``` + + + + ```java + public Action.TapAction tap( + Map tapConfig, + Map tapDevice, + String controlId + ) + ``` + + + +## Parameters (Overload 1) + + + tap configuration + + + + tap device (rtp or ws) + + + + optional parameters + + +## Parameters (Overload 2) + + + + + + + +## Returns (Overload 1) + +`Action.TapAction` — a TapAction + +## Returns (Overload 2) + +`Action.TapAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 755. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/to-string.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/to-string.mdx new file mode 100644 index 0000000000..655d821983 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/to-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/to-string" +title: "toString" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.toString" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `toString` + +**Decorators:** `@Override` + +## Signature + +```java +public String toString() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 979. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/transcribe.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/transcribe.mdx new file mode 100644 index 0000000000..5d0896dce1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/transcribe.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/transcribe" +title: "transcribe" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.transcribe" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `transcribe` + +Start transcription on the call. + +## Signature + + + + ```java + public Action.TranscribeAction transcribe(Map options) + ``` + + + + ```java + public Action.TranscribeAction transcribe(String controlId) + ``` + + + +## Parameters (Overload 1) + + + optional parameters + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Action.TranscribeAction` — a TranscribeAction + +## Returns (Overload 2) + +`Action.TranscribeAction` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 827. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/transfer.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/transfer.mdx new file mode 100644 index 0000000000..45db27fcab --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/transfer.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/transfer" +title: "transfer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.transfer" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `transfer` + +Transfer the call. + +## Signature + +```java +public Map transfer(String dest) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 265. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/unhold.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/unhold.mdx new file mode 100644 index 0000000000..173df53324 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/unhold.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/unhold" +title: "unhold" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.unhold" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `unhold` + +Take the call off hold. + +## Signature + +```java +public Map unhold() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 233. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/user-event.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/user-event.mdx new file mode 100644 index 0000000000..2a1eca63e6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/call/user-event.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/call/user-event" +title: "userEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Call.userEvent" + parent: "com.signalwire.sdk.relay.Call" + module: "com.signalwire.sdk.relay.Call" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java" + visibility: "public" +--- +# `userEvent` + +Send a user event. + +## Signature + +```java +public Map userEvent(String event) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Call.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Call.java) + +Line 305. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/index.mdx new file mode 100644 index 0000000000..03f6f55e85 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/index.mdx @@ -0,0 +1,332 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/constants" +title: "Constants" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Constants" + parent: "com.signalwire.sdk.relay" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Constants.java" + visibility: "public" +--- +# `Constants` + +Constants for the SignalWire RELAY protocol. + +<p> +Includes call states, end reasons, message states, event types, +and action terminal states used throughout the RELAY client. + +**Modifiers:** `final` + +## Signature + +```java +public final class Constants +``` + +## Constants + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + Check if an HTTP code indicates a "call gone" condition. + + + + Check if an action state is terminal (applies to play, record, etc.). + + + + Check if a call state is terminal. + + + + Check if a message state is terminal. + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Constants.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Constants.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-call-gone-code.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-call-gone-code.mdx new file mode 100644 index 0000000000..15e03d38d8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-call-gone-code.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/constants/is-call-gone-code" +title: "isCallGoneCode" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Constants.isCallGoneCode" + parent: "com.signalwire.sdk.relay.Constants" + module: "com.signalwire.sdk.relay.Constants" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Constants.java" + visibility: "public" +--- +# `isCallGoneCode` + +Check if an HTTP code indicates a "call gone" condition. + +**Modifiers:** `static` + +## Signature + +```java +public static boolean isCallGoneCode(String code) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Constants.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Constants.java) + +Line 221. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-action-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-action-state.mdx new file mode 100644 index 0000000000..5e5a482a21 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-action-state.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-action-state" +title: "isTerminalActionState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Constants.isTerminalActionState" + parent: "com.signalwire.sdk.relay.Constants" + module: "com.signalwire.sdk.relay.Constants" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Constants.java" + visibility: "public" +--- +# `isTerminalActionState` + +Check if an action state is terminal (applies to play, record, etc.). + +**Modifiers:** `static` + +## Signature + +```java +public static boolean isTerminalActionState(String state) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Constants.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Constants.java) + +Line 202. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-call-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-call-state.mdx new file mode 100644 index 0000000000..bd0c21f265 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-call-state.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-call-state" +title: "isTerminalCallState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Constants.isTerminalCallState" + parent: "com.signalwire.sdk.relay.Constants" + module: "com.signalwire.sdk.relay.Constants" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Constants.java" + visibility: "public" +--- +# `isTerminalCallState` + +Check if a call state is terminal. + +**Modifiers:** `static` + +## Signature + +```java +public static boolean isTerminalCallState(String state) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Constants.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Constants.java) + +Line 195. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-message-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-message-state.mdx new file mode 100644 index 0000000000..745dca2152 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-message-state.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/constants/is-terminal-message-state" +title: "isTerminalMessageState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Constants.isTerminalMessageState" + parent: "com.signalwire.sdk.relay.Constants" + module: "com.signalwire.sdk.relay.Constants" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Constants.java" + visibility: "public" +--- +# `isTerminalMessageState` + +Check if a message state is terminal. + +**Modifiers:** `static` + +## Signature + +```java +public static boolean isTerminalMessageState(String state) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Constants.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Constants.java) + +Line 212. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/index.mdx new file mode 100644 index 0000000000..d8d160a300 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay" +title: "relay" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.relay" + module: "com.signalwire.sdk.relay" +--- +# `relay` + +## Signature + +```java +package com.signalwire.sdk.relay +``` + +## Classes + + + + Base class for long-running call actions tracked by `control_id`. <p> Actions support three completion patterns: <ol> <li><b>Wait inline</b>: `action.waitForCompletion()` blocks until terminal</li> <li><b>Fire and forget</b>: don't wait, check `isDone()` later</li> <li><b>Callback</b>: pass an `onCompleted` callback that fires on terminal state</li> </ol> <p> Subclasses add action-specific sub-commands (pause, resume, volume, etc.). + + + + Represents a RELAY call with 30+ methods organized by category. <p> Methods are grouped into: <ul> <li><b>Simple fire-and-response</b>: answer, hangup, pass, hold, etc.</li> <li><b>Action-based</b>: play, record, detect, collect, etc. + + + + Constants for the SignalWire RELAY protocol. <p> Includes call states, end reasons, message states, event types, and action terminal states used throughout the RELAY client. + + + + Represents an SMS/MMS message with state tracking. <p> Messages are simpler than calls: they have a `message_id`, progress through states (queued, initiated, sent, delivered), and support completion waiting. <p> State progression: <ul> <li>Success: queued -> initiated -> sent -> delivered</li> <li>Failure: queued -> initiated -> failed/undelivered</li> </ul> Terminal states: delivered, undelivered, failed + + + + RELAY WebSocket connection manager. <p> Manages WebSocket connections to the SignalWire RELAY service using JSON-RPC 2.0. Implements the four correlation mechanisms: <ol> <li>JSON-RPC id -> CompletableFuture for RPC response matching</li> <li>call\_id -> Call for event routing</li> <li>control\_id -> Action per Call for action event routing</li> <li>tag -> CompletableFuture\ for dial correlation</li> </ol> <p> Also handles: <ul> <li>Event ACK for every `signalwire.event`</li> <li>Ping/pong for `signalwire.ping`</li> <li>Exponential backoff reconnection</li> <li>Authorization state for fast reconnection</li> <li>Server-initiated disconnect with restart flag</li> <li>Dynamic context subscription via receive/unreceive</li> <li>Message tracking by message\_id</li> </ul> <pre>client = RelayClient.builder() .project("project-id") .token("api-token") .space("example.signalwire.com") .contexts(List.of("default")) .build(); client.onCall(call -> \{ call.answer(); var action = call.play(List.of(Map.of("type", "tts", "params", Map.of("text", "Hello!")))); action.waitForCompletion(); call.hangup();); client.run(); \}</pre> + + + + Runtime exception for RELAY-level failures (dial timeout, dial failed, connect rejected, etc.). + + + + Base class for all RELAY events. <p> Events arrive as `signalwire.event` messages with nested params: <pre> \{ "params": \{ "event\_type": "calling.call.play", "timestamp": 123457.1234, "params": \{ "call\_id": "...", "control\_id": "...", "state": "finished" \} \} \} </pre> Subclasses provide typed access to specific event payloads. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/from-receive-event.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/from-receive-event.mdx new file mode 100644 index 0000000000..aa1b20047e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/from-receive-event.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/from-receive-event" +title: "fromReceiveEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.fromReceiveEvent" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `fromReceiveEvent` + +Create a Message from an inbound receive event. + +**Modifiers:** `static` + +## Signature + +```java +public static Message fromReceiveEvent(RelayEvent.MessagingReceiveEvent event) +``` + +## Parameters + + + +## Returns + +`Message` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 172. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-body.mdx new file mode 100644 index 0000000000..cb60b62bf8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-body" +title: "getBody" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getBody" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getBody` + +## Signature + +```java +public String getBody() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 66. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-context.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-context.mdx new file mode 100644 index 0000000000..e05f5afeaf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-context" +title: "getContext" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getContext" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getContext` + +## Signature + +```java +public String getContext() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 62. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-direction.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-direction.mdx new file mode 100644 index 0000000000..794bbf3d8e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-direction.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-direction" +title: "getDirection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getDirection" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getDirection` + +## Signature + +```java +public String getDirection() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 63. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-from-number.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-from-number.mdx new file mode 100644 index 0000000000..5b15001e4c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-from-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-from-number" +title: "getFromNumber" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getFromNumber" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getFromNumber` + +## Signature + +```java +public String getFromNumber() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 64. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-media.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-media.mdx new file mode 100644 index 0000000000..fd551ce970 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-media.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-media" +title: "getMedia" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getMedia" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getMedia` + +## Signature + +```java +public List getMedia() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 67. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-message-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-message-id.mdx new file mode 100644 index 0000000000..964547765b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-message-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-message-id" +title: "getMessageId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getMessageId" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getMessageId` + +## Signature + +```java +public String getMessageId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 61. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-reason.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-reason.mdx new file mode 100644 index 0000000000..2497be1aa6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-reason.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-reason" +title: "getReason" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getReason" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getReason` + +## Signature + +```java +public String getReason() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 70. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-result.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-result.mdx new file mode 100644 index 0000000000..7add82dd7d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-result" +title: "getResult" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getResult" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getResult` + +## Signature + +```java +public RelayEvent getResult() +``` + +## Returns + +`RelayEvent` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 73. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-segments.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-segments.mdx new file mode 100644 index 0000000000..947bafac8f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-segments.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-segments" +title: "getSegments" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getSegments" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getSegments` + +## Signature + +```java +public int getSegments() +``` + +## Returns + +`int` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 68. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-state.mdx new file mode 100644 index 0000000000..dc204b9ce3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-state" +title: "getState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getState" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getState` + +## Signature + +```java +public String getState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 69. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-tags.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-tags.mdx new file mode 100644 index 0000000000..dda6540f2f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-tags.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-tags" +title: "getTags" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getTags" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getTags` + +## Signature + +```java +public List getTags() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 71. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-to-number.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-to-number.mdx new file mode 100644 index 0000000000..4a1de489c9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/get-to-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/get-to-number" +title: "getToNumber" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.getToNumber" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `getToNumber` + +## Signature + +```java +public String getToNumber() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 65. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/index.mdx new file mode 100644 index 0000000000..102be979a3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/index.mdx @@ -0,0 +1,111 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message" +title: "Message" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message" + parent: "com.signalwire.sdk.relay" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `Message` + +Represents an SMS/MMS message with state tracking. + +<p> +Messages are simpler than calls: they have a `message_id`, progress through +states (queued, initiated, sent, delivered), and support completion waiting. +<p> +State progression: +<ul> + <li>Success: queued -> initiated -> sent -> delivered</li> + <li>Failure: queued -> initiated -> failed/undelivered</li> +</ul> +Terminal states: delivered, undelivered, failed + +## Signature + +```java +public class Message +``` + +## Methods + + + + + + Create a Message from an inbound receive event. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Register a state change listener. + + + + + + + + + + + + + + + + + + + + + + + + + + Update state from an incoming event. + + + + Block until the message reaches a terminal state. + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/init.mdx new file mode 100644 index 0000000000..8205f4f58d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message." + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String messageId) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 51. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/is-done.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/is-done.mdx new file mode 100644 index 0000000000..5319b9ddf8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/is-done" +title: "isDone" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.isDone" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `isDone` + +## Signature + +```java +public boolean isDone() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 72. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/on.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/on.mdx new file mode 100644 index 0000000000..a3de17f920 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/on.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/on" +title: "on" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.on" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `on` + +Register a state change listener. + +## Signature + +```java +public void on(Consumer listener) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 94. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-body.mdx new file mode 100644 index 0000000000..22f6f623e4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/set-body" +title: "setBody" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.setBody" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `setBody` + +## Signature + +```java +public void setBody(String body) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 81. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-context.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-context.mdx new file mode 100644 index 0000000000..1fe2ca33ab --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/set-context" +title: "setContext" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.setContext" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `setContext` + +## Signature + +```java +public void setContext(String context) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 77. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-direction.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-direction.mdx new file mode 100644 index 0000000000..491dceefd2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-direction.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/set-direction" +title: "setDirection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.setDirection" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `setDirection` + +## Signature + +```java +public void setDirection(String direction) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 78. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-from-number.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-from-number.mdx new file mode 100644 index 0000000000..a3c954ca82 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-from-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/set-from-number" +title: "setFromNumber" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.setFromNumber" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `setFromNumber` + +## Signature + +```java +public void setFromNumber(String fromNumber) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 79. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-media.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-media.mdx new file mode 100644 index 0000000000..2fb8b7383a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-media.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/set-media" +title: "setMedia" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.setMedia" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `setMedia` + +## Signature + +```java +public void setMedia(List media) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 82. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-on-completed.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-on-completed.mdx new file mode 100644 index 0000000000..c7405f9e91 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-on-completed.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/set-on-completed" +title: "setOnCompleted" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.setOnCompleted" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `setOnCompleted` + +## Signature + +```java +public void setOnCompleted(Consumer onCompleted) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 87. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-segments.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-segments.mdx new file mode 100644 index 0000000000..912e2ac341 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-segments.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/set-segments" +title: "setSegments" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.setSegments" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `setSegments` + +## Signature + +```java +public void setSegments(int segments) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 83. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-state.mdx new file mode 100644 index 0000000000..87392c2de1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/set-state" +title: "setState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.setState" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `setState` + +## Signature + +```java +public void setState(String state) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 85. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-tags.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-tags.mdx new file mode 100644 index 0000000000..c6f58a830a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-tags.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/set-tags" +title: "setTags" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.setTags" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `setTags` + +## Signature + +```java +public void setTags(List tags) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 84. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-to-number.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-to-number.mdx new file mode 100644 index 0000000000..b9cae1ca27 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/set-to-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/set-to-number" +title: "setToNumber" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.setToNumber" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `setToNumber` + +## Signature + +```java +public void setToNumber(String toNumber) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 80. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/to-string.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/to-string.mdx new file mode 100644 index 0000000000..c9946151af --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/to-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/to-string" +title: "toString" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.toString" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `toString` + +**Decorators:** `@Override` + +## Signature + +```java +public String toString() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 186. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/update-from-event.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/update-from-event.mdx new file mode 100644 index 0000000000..d05e3b4b5b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/update-from-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/update-from-event" +title: "updateFromEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.updateFromEvent" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `updateFromEvent` + +Update state from an incoming event. + +## Signature + +```java +public void updateFromEvent(RelayEvent event) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 101. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/wait-for-completion.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/wait-for-completion.mdx new file mode 100644 index 0000000000..b1ea39c780 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/message/wait-for-completion.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/message/wait-for-completion" +title: "waitForCompletion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.Message.waitForCompletion" + parent: "com.signalwire.sdk.relay.Message" + module: "com.signalwire.sdk.relay.Message" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java" + visibility: "public" +--- +# `waitForCompletion` + +Block until the message reaches a terminal state. + +## Signature + + + + ```java + public RelayEvent waitForCompletion() + ``` + + + + ```java + public RelayEvent waitForCompletion(long timeoutMs) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`RelayEvent` + +## Returns (Overload 2) + +`RelayEvent` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/Message.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/Message.java) + +Line 128. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder.mdx new file mode 100644 index 0000000000..b750828b42 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/builder" +title: "builder" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.builder" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `builder` + +**Modifiers:** `static` + +## Signature + +```java +public static Builder builder() +``` + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 127. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/build.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/build.mdx new file mode 100644 index 0000000000..6ae625e3b9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/build.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/build" +title: "build" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.Builder.build" + parent: "com.signalwire.sdk.relay.RelayClient.Builder" + module: "com.signalwire.sdk.relay.RelayClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `build` + +## Signature + +```java +public RelayClient build() +``` + +## Returns + +`RelayClient` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 145. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/contexts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/contexts.mdx new file mode 100644 index 0000000000..e2ea103de0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/contexts.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/contexts" +title: "contexts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.Builder.contexts" + parent: "com.signalwire.sdk.relay.RelayClient.Builder" + module: "com.signalwire.sdk.relay.RelayClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `contexts` + +## Signature + +```java +public Builder contexts(List contexts) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 143. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/host.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/host.mdx new file mode 100644 index 0000000000..e81e9e5c5c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/host.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/host" +title: "host" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.Builder.host" + parent: "com.signalwire.sdk.relay.RelayClient.Builder" + module: "com.signalwire.sdk.relay.RelayClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `host` + +## Signature + +```java +public Builder host(String host) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 142. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/index.mdx new file mode 100644 index 0000000000..a66745f8e6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/builder" +title: "Builder" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.Builder" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `Builder` + +**Modifiers:** `static` + +## Signature + +```java +public static class Builder +``` + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 131. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/init.mdx new file mode 100644 index 0000000000..2df0a2d7f9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.Builder." + parent: "com.signalwire.sdk.relay.RelayClient.Builder" + module: "com.signalwire.sdk.relay.RelayClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/jwt-token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/jwt-token.mdx new file mode 100644 index 0000000000..ad1a6e541d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/jwt-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/jwt-token" +title: "jwtToken" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.Builder.jwtToken" + parent: "com.signalwire.sdk.relay.RelayClient.Builder" + module: "com.signalwire.sdk.relay.RelayClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `jwtToken` + +## Signature + +```java +public Builder jwtToken(String jwtToken) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 140. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/project.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/project.mdx new file mode 100644 index 0000000000..bd0bcbfbcb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/project.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/project" +title: "project" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.Builder.project" + parent: "com.signalwire.sdk.relay.RelayClient.Builder" + module: "com.signalwire.sdk.relay.RelayClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `project` + +## Signature + +```java +public Builder project(String project) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 138. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/space.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/space.mdx new file mode 100644 index 0000000000..858ad61c6c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/space.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/space" +title: "space" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.Builder.space" + parent: "com.signalwire.sdk.relay.RelayClient.Builder" + module: "com.signalwire.sdk.relay.RelayClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `space` + +## Signature + +```java +public Builder space(String space) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 141. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/token.mdx new file mode 100644 index 0000000000..1cafe0edc2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/builder/token" +title: "token" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.Builder.token" + parent: "com.signalwire.sdk.relay.RelayClient.Builder" + module: "com.signalwire.sdk.relay.RelayClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `token` + +## Signature + +```java +public Builder token(String token) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 139. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/connect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/connect.mdx new file mode 100644 index 0000000000..e5f4cf29ba --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/connect.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/connect" +title: "connect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.connect" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `connect` + +Open the WebSocket connection and complete the signalwire.connect +handshake without blocking the caller. + +<p>Mirrors the Python `RelayClient.connect()` coroutine. + +Tests use +this directly; production code typically uses `#run()` instead. + +## Signature + + + + ```java + public void connect(long timeoutMs) + ``` + + + + ```java + public void connect() + ``` + + + +## Parameters (Overload 1) + + + how long to wait for the handshake to complete + + +## Throws + +- `RuntimeException` — if connect fails or times out + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 234. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/dial.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/dial.mdx new file mode 100644 index 0000000000..5e32e14700 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/dial.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/dial" +title: "dial" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.dial" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `dial` + +Dial an outbound call. + +## Signature + + + + ```java + public Call dial( + List>> devices, + Map options, + long timeout + ) + ``` + + + + ```java + public Call dial(List>> devices) + ``` + + + +## Parameters (Overload 1) + + + nested array: outer = sequential, inner = parallel + + + + optional parameters (region, max\_price\_per\_minute) + + + + timeout in milliseconds + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Call` — the answered Call + +## Returns (Overload 2) + +`Call` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 290. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/disconnect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/disconnect.mdx new file mode 100644 index 0000000000..cc326a8f3a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/disconnect.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/disconnect" +title: "disconnect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.disconnect" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `disconnect` + +Disconnect the client. + +## Signature + +```java +public void disconnect() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 255. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/execute.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/execute.mdx new file mode 100644 index 0000000000..4f15fee61a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/execute.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/execute" +title: "execute" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.execute" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `execute` + +Execute an RPC method and wait for the response. + +## Signature + +```java +public Map execute(String method, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 406. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-authorization-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-authorization-state.mdx new file mode 100644 index 0000000000..a9239d484a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-authorization-state.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/get-authorization-state" +title: "getAuthorizationState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.getAuthorizationState" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `getAuthorizationState` + +Returns the authorization state blob the server pushed via the +`signalwire.authorization.state` event, or null. + +## Signature + +```java +public String getAuthorizationState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 176. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-contexts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-contexts.mdx new file mode 100644 index 0000000000..9e933e937e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/get-contexts" +title: "getContexts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.getContexts" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `getContexts` + +## Signature + +```java +public List getContexts() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 161. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-project.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-project.mdx new file mode 100644 index 0000000000..1c535b69ed --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-project.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/get-project" +title: "getProject" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.getProject" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `getProject` + +## Signature + +```java +public String getProject() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 159. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-relay-protocol.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-relay-protocol.mdx new file mode 100644 index 0000000000..43abb1a1cb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-relay-protocol.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/get-relay-protocol" +title: "getRelayProtocol" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.getRelayProtocol" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `getRelayProtocol` + +Returns the protocol identifier issued by the server during the +signalwire.connect handshake. + +Empty string before connect completes. + +## Signature + +```java +public String getRelayProtocol() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 168. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-space.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-space.mdx new file mode 100644 index 0000000000..ab728e7c76 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/get-space.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/get-space" +title: "getSpace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.getSpace" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `getSpace` + +## Signature + +```java +public String getSpace() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 160. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/index.mdx new file mode 100644 index 0000000000..b6e49beacc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/index.mdx @@ -0,0 +1,148 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client" +title: "RelayClient" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient" + parent: "com.signalwire.sdk.relay" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `RelayClient` + +RELAY WebSocket connection manager. + +<p> +Manages WebSocket connections to the SignalWire RELAY service using JSON-RPC 2.0. +Implements the four correlation mechanisms: +<ol> + <li>JSON-RPC id -> CompletableFuture for RPC response matching</li> + <li>call_id -> Call for event routing</li> + <li>control_id -> Action per Call for action event routing</li> + <li>tag -> CompletableFuture<Call> for dial correlation</li> +</ol> +<p> +Also handles: +<ul> + <li>Event ACK for every `signalwire.event`</li> + <li>Ping/pong for `signalwire.ping`</li> + <li>Exponential backoff reconnection</li> + <li>Authorization state for fast reconnection</li> + <li>Server-initiated disconnect with restart flag</li> + <li>Dynamic context subscription via receive/unreceive</li> + <li>Message tracking by message_id</li> +</ul> + +<pre>client = RelayClient.builder() + .project("project-id") + .token("api-token") + .space("example.signalwire.com") + .contexts(List.of("default")) + .build(); + +client.onCall(call -> { + call.answer(); + var action = call.play(List.of(Map.of("type", "tts", + "params", Map.of("text", "Hello!")))); + action.waitForCompletion(); + call.hangup();); + +client.run(); +}</pre> + +## Signature + +```java +public class RelayClient +``` + +## Methods + + + + + + Open the WebSocket connection and complete the signalwire.connect handshake without blocking the caller. <p>Mirrors the Python `RelayClient.connect()` coroutine. + + + + Dial an outbound call. + + + + Disconnect the client. + + + + Execute an RPC method and wait for the response. + + + + Returns the authorization state blob the server pushed via the `signalwire.authorization.state` event, or null. + + + + + + + + Returns the protocol identifier issued by the server during the signalwire.connect handshake. + + + + + + + + Register a handler for inbound calls. + + + + Register a handler for all raw events. + + + + Register a handler for inbound messages. + + + + Subscribe to additional contexts dynamically. + + + + Connect and run the client. + + + + Send an outbound SMS/MMS. + + + + Send a raw JSON-RPC frame on the underlying socket. + + + + Test-only setter for the protocol — used by reconnect-with-protocol tests that simulate "I already have a session token from last time". + + + + Unsubscribe from contexts. + + + +## Classes + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 62. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/is-connected.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/is-connected.mdx new file mode 100644 index 0000000000..a4ab875f31 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/is-connected.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/is-connected" +title: "isConnected" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.isConnected" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `isConnected` + +## Signature + +```java +public boolean isConnected() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 162. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/on-call.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/on-call.mdx new file mode 100644 index 0000000000..8cdf8be64f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/on-call.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/on-call" +title: "onCall" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.onCall" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `onCall` + +Register a handler for inbound calls. + +## Signature + +```java +public void onCall(Consumer handler) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 191. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/on-event.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/on-event.mdx new file mode 100644 index 0000000000..2d2021cb2e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/on-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/on-event" +title: "onEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.onEvent" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `onEvent` + +Register a handler for all raw events. + +## Signature + +```java +public void onEvent(Consumer handler) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 205. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/on-message.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/on-message.mdx new file mode 100644 index 0000000000..ac78e45b10 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/on-message.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/on-message" +title: "onMessage" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.onMessage" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `onMessage` + +Register a handler for inbound messages. + +## Signature + +```java +public void onMessage(Consumer handler) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 198. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/receive.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/receive.mdx new file mode 100644 index 0000000000..dd54819452 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/receive.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/receive" +title: "receive" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.receive" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `receive` + +Subscribe to additional contexts dynamically. + +## Signature + +```java +public Map receive(List newContexts) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 267. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/run.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/run.mdx new file mode 100644 index 0000000000..64c32f182f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/run.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/run" +title: "run" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.run" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `run` + +Connect and run the client. + +Blocks until `#disconnect()` is called. + +## Signature + +```java +public void run() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 212. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/send-message.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/send-message.mdx new file mode 100644 index 0000000000..5b60420594 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/send-message.mdx @@ -0,0 +1,97 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/send-message" +title: "sendMessage" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.sendMessage" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `sendMessage` + +Send an outbound SMS/MMS. + +## Signature + + + + ```java + public Message sendMessage( + String context, + String fromNumber, + String toNumber, + String body, + List mediaUrls + ) + ``` + + + + ```java + public Message sendMessage( + String context, + String fromNumber, + String toNumber, + String body, + List mediaUrls, + List tags + ) + ``` + + + +## Parameters (Overload 1) + + + message context + + + + sender E.164 number + + + + recipient E.164 number + + + + message body (required if no media) + + + + media URLs (required if no body) + + +## Parameters (Overload 2) + + + + + + + + + + + + + +## Returns (Overload 1) + +`Message` — the Message object with message\_id for tracking + +## Returns (Overload 2) + +`Message` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 346. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/send-raw.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/send-raw.mdx new file mode 100644 index 0000000000..ac43ecb328 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/send-raw.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/send-raw" +title: "sendRaw" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.sendRaw" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `sendRaw` + +Send a raw JSON-RPC frame on the underlying socket. + +Production code +uses Map), which adds project\_id/protocol +automatically. This helper exists for the porting-sdk RELAY-handshake +audit harness, which has to emit a `method:"signalwire.event"` +frame from inside the on-event callback so the fixture's dispatch +counter fires (see SUBAGENT\_PLAYBOOK lesson on event-ACK semantics). + +## Signature + +```java +public void sendRaw(Map frame) +``` + +## Parameters + + + a Gson-serializable map representing the frame + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 848. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/set-relay-protocol.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/set-relay-protocol.mdx new file mode 100644 index 0000000000..91622b9221 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/set-relay-protocol.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/set-relay-protocol" +title: "setRelayProtocol" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.setRelayProtocol" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `setRelayProtocol` + +Test-only setter for the protocol — used by reconnect-with-protocol +tests that simulate "I already have a session token from last time". + +## Signature + +```java +public void setRelayProtocol(String protocol) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 184. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/unreceive.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/unreceive.mdx new file mode 100644 index 0000000000..497a54c3cc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-client/unreceive.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-client/unreceive" +title: "unreceive" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayClient.unreceive" + parent: "com.signalwire.sdk.relay.RelayClient" + module: "com.signalwire.sdk.relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java" + visibility: "public" +--- +# `unreceive` + +Unsubscribe from contexts. + +## Signature + +```java +public Map unreceive(List removeContexts) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayClient.java) + +Line 276. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-error/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-error/index.mdx new file mode 100644 index 0000000000..6ff93a5b51 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-error/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-error" +title: "RelayError" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayError" + parent: "com.signalwire.sdk.relay" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayError.java" + visibility: "public" +--- +# `RelayError` + +Runtime exception for RELAY-level failures (dial timeout, dial failed, +connect rejected, etc.). + +Mirrors the Python `RelayError` class. + +## Signature + +```java +public class RelayError extends RuntimeException +``` + +## Inheritance + +**Extends:** `RuntimeException` + +## Methods + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayError.java) + +Line 13. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-error/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-error/init.mdx new file mode 100644 index 0000000000..0e68e14ee8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-error/init.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-error/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayError." + parent: "com.signalwire.sdk.relay.RelayError" + module: "com.signalwire.sdk.relay.RelayError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayError.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public (String message) + ``` + + + + ```java + public (String message, Throwable cause) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayError.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event/get-authorization-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event/get-authorization-state.mdx new file mode 100644 index 0000000000..f21a606e86 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event/get-authorization-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event/get-authorization-state" +title: "getAuthorizationState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.AuthorizationStateEvent.getAuthorizationState" + parent: "com.signalwire.sdk.relay.RelayEvent.AuthorizationStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.AuthorizationStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getAuthorizationState` + +## Signature + +```java +public String getAuthorizationState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 440. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event/index.mdx new file mode 100644 index 0000000000..3d7d13ffa7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event" +title: "AuthorizationStateEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.AuthorizationStateEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `AuthorizationStateEvent` + +Authorization state event (`signalwire.authorization.state`). + +**Modifiers:** `static` + +## Signature + +```java +public static class AuthorizationStateEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 435. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event/init.mdx new file mode 100644 index 0000000000..cd679598fe --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/authorization-state-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.AuthorizationStateEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.AuthorizationStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.AuthorizationStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 436. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-call-id.mdx new file mode 100644 index 0000000000..ec4324f446 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 301. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-control-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-control-id.mdx new file mode 100644 index 0000000000..0e8b6ff891 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-control-id" +title: "getControlId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent.getControlId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getControlId` + +## Signature + +```java +public String getControlId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 302. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-result-type.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-result-type.mdx new file mode 100644 index 0000000000..676214818c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-result-type.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-result-type" +title: "getResultType" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent.getResultType" + parent: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getResultType` + +## Signature + +```java +public String getResultType() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 303. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-result.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-result.mdx new file mode 100644 index 0000000000..36e841a355 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/get-result" +title: "getResult" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent.getResult" + parent: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getResult` + +## Signature + +```java +public Map getResult() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 304. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/index.mdx new file mode 100644 index 0000000000..88eaee27d6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event" +title: "CallCollectEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallCollectEvent` + +Collect event (`calling.call.collect`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallCollectEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 296. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/init.mdx new file mode 100644 index 0000000000..5d4c0449ee --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-collect-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallCollectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 297. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/get-call-id.mdx new file mode 100644 index 0000000000..5405205d38 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallConnectEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallConnectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallConnectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 367. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/get-connect-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/get-connect-state.mdx new file mode 100644 index 0000000000..5382a7d26f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/get-connect-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/get-connect-state" +title: "getConnectState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallConnectEvent.getConnectState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallConnectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallConnectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getConnectState` + +## Signature + +```java +public String getConnectState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 368. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/index.mdx new file mode 100644 index 0000000000..d44c9c1742 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event" +title: "CallConnectEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallConnectEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallConnectEvent` + +Connect event (`calling.call.connect`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallConnectEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 362. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/init.mdx new file mode 100644 index 0000000000..1a964df3eb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-connect-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallConnectEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallConnectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallConnectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 363. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-call-id.mdx new file mode 100644 index 0000000000..68f54a3531 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 280. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-control-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-control-id.mdx new file mode 100644 index 0000000000..ff56350ba7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-control-id" +title: "getControlId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent.getControlId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getControlId` + +## Signature + +```java +public String getControlId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 281. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-detect-event.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-detect-event.mdx new file mode 100644 index 0000000000..beb8154e79 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-detect-event.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-detect-event" +title: "getDetectEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent.getDetectEvent" + parent: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getDetectEvent` + +## Signature + +```java +public String getDetectEvent() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 286. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-detect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-detect.mdx new file mode 100644 index 0000000000..7e74768790 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-detect.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/get-detect" +title: "getDetect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent.getDetect" + parent: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getDetect` + +Results are in detect.params.event, not a simple state field. + +## Signature + +```java +public Map getDetect() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 284. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/index.mdx new file mode 100644 index 0000000000..f1b7bbf963 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event" +title: "CallDetectEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallDetectEvent` + +Detect event (`calling.call.detect`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallDetectEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + Results are in detect.params.event, not a simple state field. + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 275. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/init.mdx new file mode 100644 index 0000000000..4c1ca8d2cc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-detect-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallDetectEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 276. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-call-id.mdx new file mode 100644 index 0000000000..aef1411a57 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 218. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-call-info.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-call-info.mdx new file mode 100644 index 0000000000..05d644df04 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-call-info.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-call-info" +title: "getCallInfo" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent.getCallInfo" + parent: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallInfo` + +## Signature + +```java +public Map getCallInfo() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 214. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-dial-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-dial-state.mdx new file mode 100644 index 0000000000..a286dc8c0c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-dial-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-dial-state" +title: "getDialState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent.getDialState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getDialState` + +## Signature + +```java +public String getDialState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 212. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-node-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-node-id.mdx new file mode 100644 index 0000000000..9e1d12f003 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-node-id" +title: "getNodeId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent.getNodeId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```java +public String getNodeId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 211. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-tag.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-tag.mdx new file mode 100644 index 0000000000..de5a663f34 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-tag.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/get-tag" +title: "getTag" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent.getTag" + parent: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getTag` + +## Signature + +```java +public String getTag() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 210. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/index.mdx new file mode 100644 index 0000000000..1f825750c5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event" +title: "CallDialEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallDialEvent` + +Dial completion event (`calling.call.dial`). + +<p> +Note: No top-level `call_id`. + +The call info is nested at `params.call`. + +**Modifiers:** `static` + +## Signature + +```java +public static class CallDialEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 205. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/init.mdx new file mode 100644 index 0000000000..c4b5a9c240 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-dial-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallDialEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 206. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-call-id.mdx new file mode 100644 index 0000000000..8453ef62e4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 315. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-control-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-control-id.mdx new file mode 100644 index 0000000000..7fcb0ac971 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-control-id" +title: "getControlId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent.getControlId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getControlId` + +## Signature + +```java +public String getControlId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 316. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-state.mdx new file mode 100644 index 0000000000..ebd30bba20 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/get-state" +title: "getState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent.getState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getState` + +## Signature + +```java +public String getState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 317. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/index.mdx new file mode 100644 index 0000000000..ad6008ab4a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event" +title: "CallFaxEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallFaxEvent` + +Fax event (`calling.call.fax`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallFaxEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 310. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/init.mdx new file mode 100644 index 0000000000..3443f177ef --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-fax-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallFaxEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 311. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-call-id.mdx new file mode 100644 index 0000000000..dec2e21489 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 403. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-control-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-control-id.mdx new file mode 100644 index 0000000000..14bcc32d96 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-control-id" +title: "getControlId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent.getControlId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getControlId` + +## Signature + +```java +public String getControlId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 404. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-state.mdx new file mode 100644 index 0000000000..1e5d7f6624 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/get-state" +title: "getState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent.getState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getState` + +## Signature + +```java +public String getState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 405. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/index.mdx new file mode 100644 index 0000000000..aa0fb8c753 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event" +title: "CallPayEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallPayEvent` + +Pay event (`calling.call.pay`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallPayEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 398. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/init.mdx new file mode 100644 index 0000000000..08f14c3857 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-pay-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallPayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 399. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-call-id.mdx new file mode 100644 index 0000000000..d03ba49237 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 231. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-control-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-control-id.mdx new file mode 100644 index 0000000000..cf901c830c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-control-id" +title: "getControlId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent.getControlId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getControlId` + +## Signature + +```java +public String getControlId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 232. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-state.mdx new file mode 100644 index 0000000000..c2182af0e5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/get-state" +title: "getState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent.getState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getState` + +## Signature + +```java +public String getState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 233. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/index.mdx new file mode 100644 index 0000000000..ab90827472 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event" +title: "CallPlayEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallPlayEvent` + +Play event (`calling.call.play`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallPlayEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 226. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/init.mdx new file mode 100644 index 0000000000..ccf9eecce9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-play-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallPlayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 227. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-call-id.mdx new file mode 100644 index 0000000000..669c8329f9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 193. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-call-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-call-state.mdx new file mode 100644 index 0000000000..3d35ee24ae --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-call-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-call-state" +title: "getCallState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent.getCallState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallState` + +## Signature + +```java +public String getCallState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 195. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-context.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-context.mdx new file mode 100644 index 0000000000..7966b2b645 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-context" +title: "getContext" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent.getContext" + parent: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getContext` + +## Signature + +```java +public String getContext() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 196. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-device.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-device.mdx new file mode 100644 index 0000000000..2208eef884 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-device.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-device" +title: "getDevice" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent.getDevice" + parent: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getDevice` + +## Signature + +```java +public Map getDevice() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 197. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-node-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-node-id.mdx new file mode 100644 index 0000000000..32c4cbaca6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/get-node-id" +title: "getNodeId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent.getNodeId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```java +public String getNodeId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 194. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/index.mdx new file mode 100644 index 0000000000..c3fea57092 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event" +title: "CallReceiveEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallReceiveEvent` + +Inbound call event (`calling.call.receive`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallReceiveEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 188. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/init.mdx new file mode 100644 index 0000000000..9d2d4a075b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-receive-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 189. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-call-id.mdx new file mode 100644 index 0000000000..c340eb7a36 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 244. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-control-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-control-id.mdx new file mode 100644 index 0000000000..c42dd10ecc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-control-id" +title: "getControlId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent.getControlId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getControlId` + +## Signature + +```java +public String getControlId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 245. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-duration.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-duration.mdx new file mode 100644 index 0000000000..d9a3feea98 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-duration.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-duration" +title: "getDuration" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent.getDuration" + parent: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getDuration` + +## Signature + +```java +public double getDuration() +``` + +## Returns + +`double` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 256. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-size.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-size.mdx new file mode 100644 index 0000000000..6009b3144a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-size.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-size" +title: "getSize" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent.getSize" + parent: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getSize` + +## Signature + +```java +public long getSize() +``` + +## Returns + +`long` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 263. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-state.mdx new file mode 100644 index 0000000000..c8567bdfe3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-state" +title: "getState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent.getState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getState` + +## Signature + +```java +public String getState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 246. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-url.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-url.mdx new file mode 100644 index 0000000000..555b686a84 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/get-url" +title: "getUrl" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent.getUrl" + parent: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getUrl` + +## Signature + +```java +public String getUrl() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 248. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/index.mdx new file mode 100644 index 0000000000..499cadcbcd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event" +title: "CallRecordEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallRecordEvent` + +Record event (`calling.call.record`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallRecordEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 239. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/init.mdx new file mode 100644 index 0000000000..a4d41e5ad7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-record-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallRecordEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 240. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/get-call-id.mdx new file mode 100644 index 0000000000..0749bedd37 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallReferEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallReferEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallReferEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 379. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/get-refer-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/get-refer-state.mdx new file mode 100644 index 0000000000..7bdbc4333b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/get-refer-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/get-refer-state" +title: "getReferState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallReferEvent.getReferState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallReferEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallReferEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getReferState` + +## Signature + +```java +public String getReferState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 380. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/index.mdx new file mode 100644 index 0000000000..45a7d843be --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event" +title: "CallReferEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallReferEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallReferEvent` + +Refer event (`calling.call.refer`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallReferEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 374. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/init.mdx new file mode 100644 index 0000000000..69b732d5b8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-refer-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallReferEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallReferEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallReferEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 375. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/get-call-id.mdx new file mode 100644 index 0000000000..28bed81201 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallSendDigitsEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallSendDigitsEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallSendDigitsEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 391. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/get-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/get-state.mdx new file mode 100644 index 0000000000..937100013b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/get-state" +title: "getState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallSendDigitsEvent.getState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallSendDigitsEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallSendDigitsEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getState` + +## Signature + +```java +public String getState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 392. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/index.mdx new file mode 100644 index 0000000000..5538c8e075 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event" +title: "CallSendDigitsEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallSendDigitsEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallSendDigitsEvent` + +Send digits event (`calling.call.send_digits`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallSendDigitsEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 386. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/init.mdx new file mode 100644 index 0000000000..8cc1630bc3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-send-digits-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallSendDigitsEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallSendDigitsEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallSendDigitsEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 387. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-call-id.mdx new file mode 100644 index 0000000000..6cf49175f2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 176. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-call-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-call-state.mdx new file mode 100644 index 0000000000..037d9954d8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-call-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-call-state" +title: "getCallState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent.getCallState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallState` + +## Signature + +```java +public String getCallState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 178. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-device.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-device.mdx new file mode 100644 index 0000000000..9d1699cc69 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-device.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-device" +title: "getDevice" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent.getDevice" + parent: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getDevice` + +## Signature + +```java +public Map getDevice() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 182. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-direction.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-direction.mdx new file mode 100644 index 0000000000..94de65308e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-direction.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-direction" +title: "getDirection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent.getDirection" + parent: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getDirection` + +## Signature + +```java +public String getDirection() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 181. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-end-reason.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-end-reason.mdx new file mode 100644 index 0000000000..8f2a50329b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-end-reason.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-end-reason" +title: "getEndReason" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent.getEndReason" + parent: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getEndReason` + +## Signature + +```java +public String getEndReason() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 179. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-node-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-node-id.mdx new file mode 100644 index 0000000000..cf0a2e0b36 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-node-id" +title: "getNodeId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent.getNodeId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```java +public String getNodeId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 177. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-tag.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-tag.mdx new file mode 100644 index 0000000000..76b6634922 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-tag.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/get-tag" +title: "getTag" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent.getTag" + parent: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getTag` + +## Signature + +```java +public String getTag() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 180. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/index.mdx new file mode 100644 index 0000000000..45d9c776f6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event" +title: "CallStateEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallStateEvent` + +Call state change event (`calling.call.state`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallStateEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 171. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/init.mdx new file mode 100644 index 0000000000..7fb710ffd9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-state-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 172. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-call-id.mdx new file mode 100644 index 0000000000..cf389de03e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 341. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-control-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-control-id.mdx new file mode 100644 index 0000000000..b9a8fc4406 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-control-id" +title: "getControlId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent.getControlId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getControlId` + +## Signature + +```java +public String getControlId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 342. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-state.mdx new file mode 100644 index 0000000000..ccbc431939 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/get-state" +title: "getState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent.getState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getState` + +## Signature + +```java +public String getState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 343. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/index.mdx new file mode 100644 index 0000000000..7e57c2ac4a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event" +title: "CallStreamEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallStreamEvent` + +Stream event (`calling.call.stream`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallStreamEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 336. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/init.mdx new file mode 100644 index 0000000000..f3e2a30c95 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-stream-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallStreamEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 337. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-call-id.mdx new file mode 100644 index 0000000000..c11340d7cc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 328. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-control-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-control-id.mdx new file mode 100644 index 0000000000..c6cc94a99f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-control-id" +title: "getControlId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent.getControlId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getControlId` + +## Signature + +```java +public String getControlId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 329. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-state.mdx new file mode 100644 index 0000000000..45a5d21e05 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/get-state" +title: "getState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent.getState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getState` + +## Signature + +```java +public String getState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 330. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/index.mdx new file mode 100644 index 0000000000..aaaf87faa7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event" +title: "CallTapEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallTapEvent` + +Tap event (`calling.call.tap`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallTapEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 323. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/init.mdx new file mode 100644 index 0000000000..c37f114db9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-tap-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallTapEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 324. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-call-id.mdx new file mode 100644 index 0000000000..cf7dca82a9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 354. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-control-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-control-id.mdx new file mode 100644 index 0000000000..88b0eef67a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-control-id" +title: "getControlId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent.getControlId" + parent: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getControlId` + +## Signature + +```java +public String getControlId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 355. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-state.mdx new file mode 100644 index 0000000000..9fd66dd941 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/get-state" +title: "getState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent.getState" + parent: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getState` + +## Signature + +```java +public String getState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 356. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/index.mdx new file mode 100644 index 0000000000..42d7200f9f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event" +title: "CallTranscribeEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `CallTranscribeEvent` + +Transcribe event (`calling.call.transcribe`). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallTranscribeEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 349. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/init.mdx new file mode 100644 index 0000000000..129145d326 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/call-transcribe-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent" + module: "com.signalwire.sdk.relay.RelayEvent.CallTranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 350. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/get-call-id.mdx new file mode 100644 index 0000000000..8e5bf96053 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.ConferenceEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.ConferenceEvent" + module: "com.signalwire.sdk.relay.RelayEvent.ConferenceEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 417. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/get-conference-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/get-conference-id.mdx new file mode 100644 index 0000000000..428d18b4fb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/get-conference-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/get-conference-id" +title: "getConferenceId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.ConferenceEvent.getConferenceId" + parent: "com.signalwire.sdk.relay.RelayEvent.ConferenceEvent" + module: "com.signalwire.sdk.relay.RelayEvent.ConferenceEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getConferenceId` + +## Signature + +```java +public String getConferenceId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 416. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/index.mdx new file mode 100644 index 0000000000..6c89bc2424 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event" +title: "ConferenceEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.ConferenceEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `ConferenceEvent` + +Conference event (`calling.conference`). + +**Modifiers:** `static` + +## Signature + +```java +public static class ConferenceEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 411. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/init.mdx new file mode 100644 index 0000000000..a531234ec1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/conference-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.ConferenceEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.ConferenceEvent" + module: "com.signalwire.sdk.relay.RelayEvent.ConferenceEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 412. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/from-raw-params.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/from-raw-params.mdx new file mode 100644 index 0000000000..0de0dcf837 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/from-raw-params.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/from-raw-params" +title: "fromRawParams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.fromRawParams" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `fromRawParams` + +Create the appropriate event subclass from raw JSON-RPC event params. + +**Modifiers:** `static` + +## Signature + +```java +public static RelayEvent fromRawParams(Map outerParams) +``` + +## Parameters + + + +## Returns + +`RelayEvent` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 65. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-event-type.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-event-type.mdx new file mode 100644 index 0000000000..f321bf1110 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-event-type.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/get-event-type" +title: "getEventType" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.getEventType" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getEventType` + +## Signature + +```java +public String getEventType() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 40. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-params.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-params.mdx new file mode 100644 index 0000000000..cdae7130fa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/get-params" +title: "getParams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.getParams" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getParams` + +## Signature + +```java +public Map getParams() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 48. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-string-param.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-string-param.mdx new file mode 100644 index 0000000000..c373b82a12 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-string-param.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/get-string-param" +title: "getStringParam" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.getStringParam" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getStringParam` + +## Signature + + + + ```java + public String getStringParam(String key) + ``` + + + + ```java + public String getStringParam(String key, String defaultValue) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`String` + +## Returns (Overload 2) + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 52. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-timestamp.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-timestamp.mdx new file mode 100644 index 0000000000..1edad9ba86 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/get-timestamp.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/get-timestamp" +title: "getTimestamp" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.getTimestamp" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getTimestamp` + +## Signature + +```java +public double getTimestamp() +``` + +## Returns + +`double` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 44. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/index.mdx new file mode 100644 index 0000000000..66bc532dab --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/index.mdx @@ -0,0 +1,147 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event" +title: "RelayEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent" + parent: "com.signalwire.sdk.relay" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `RelayEvent` + +Base class for all RELAY events. + +<p> +Events arrive as `signalwire.event` messages with nested params: +<pre> +{ + "params": { + "event_type": "calling.call.play", + "timestamp": 123457.1234, + "params": { "call_id": "...", "control_id": "...", "state": "finished" } + } +} +</pre> +Subclasses provide typed access to specific event payloads. + +## Signature + +```java +public class RelayEvent +``` + +## Methods + + + + + + Create the appropriate event subclass from raw JSON-RPC event params. + + + + + + + + + + + + + +## Classes + + + + Authorization state event (`signalwire.authorization.state`). + + + + Collect event (`calling.call.collect`). + + + + Connect event (`calling.call.connect`). + + + + Detect event (`calling.call.detect`). + + + + Dial completion event (`calling.call.dial`). <p> Note: No top-level `call_id`. + + + + Fax event (`calling.call.fax`). + + + + Pay event (`calling.call.pay`). + + + + Play event (`calling.call.play`). + + + + Inbound call event (`calling.call.receive`). + + + + Record event (`calling.call.record`). + + + + Refer event (`calling.call.refer`). + + + + Send digits event (`calling.call.send_digits`). + + + + Call state change event (`calling.call.state`). + + + + Stream event (`calling.call.stream`). + + + + Tap event (`calling.call.tap`). + + + + Transcribe event (`calling.call.transcribe`). + + + + Conference event (`calling.conference`). + + + + Inbound messaging event (`messaging.receive`). + + + + Outbound messaging state event (`messaging.state`). + + + + Queue event (`calling.queue`). + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 28. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/init.mdx new file mode 100644 index 0000000000..8614e4026e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent." + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-body.mdx new file mode 100644 index 0000000000..52a63f3f74 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-body" +title: "getBody" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent.getBody" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getBody` + +## Signature + +```java +public String getBody() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 458. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-context.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-context.mdx new file mode 100644 index 0000000000..c73f0fced5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-context" +title: "getContext" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent.getContext" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getContext` + +## Signature + +```java +public String getContext() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 454. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-direction.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-direction.mdx new file mode 100644 index 0000000000..addd777f94 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-direction.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-direction" +title: "getDirection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent.getDirection" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getDirection` + +## Signature + +```java +public String getDirection() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 455. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-from-number.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-from-number.mdx new file mode 100644 index 0000000000..b7abbe843a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-from-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-from-number" +title: "getFromNumber" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent.getFromNumber" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getFromNumber` + +## Signature + +```java +public String getFromNumber() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 456. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-media.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-media.mdx new file mode 100644 index 0000000000..07c3d0ce7f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-media.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-media" +title: "getMedia" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent.getMedia" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getMedia` + +## Signature + +```java +public List getMedia() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 459. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-message-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-message-id.mdx new file mode 100644 index 0000000000..6392d1525f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-message-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-message-id" +title: "getMessageId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent.getMessageId" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getMessageId` + +## Signature + +```java +public String getMessageId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 453. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-message-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-message-state.mdx new file mode 100644 index 0000000000..d5c466a391 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-message-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-message-state" +title: "getMessageState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent.getMessageState" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getMessageState` + +## Signature + +```java +public String getMessageState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 461. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-segments.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-segments.mdx new file mode 100644 index 0000000000..9752053afd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-segments.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-segments" +title: "getSegments" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent.getSegments" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getSegments` + +## Signature + +```java +public int getSegments() +``` + +## Returns + +`int` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 460. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-tags.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-tags.mdx new file mode 100644 index 0000000000..fca07c6606 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-tags.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-tags" +title: "getTags" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent.getTags" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getTags` + +## Signature + +```java +public List getTags() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 462. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-to-number.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-to-number.mdx new file mode 100644 index 0000000000..76c609b11a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-to-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/get-to-number" +title: "getToNumber" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent.getToNumber" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getToNumber` + +## Signature + +```java +public String getToNumber() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 457. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/index.mdx new file mode 100644 index 0000000000..ca8f147290 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event" +title: "MessagingReceiveEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `MessagingReceiveEvent` + +Inbound messaging event (`messaging.receive`). + +**Modifiers:** `static` + +## Signature + +```java +public static class MessagingReceiveEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 448. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/init.mdx new file mode 100644 index 0000000000..ff33e17b45 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-receive-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 449. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-body.mdx new file mode 100644 index 0000000000..0c5592766e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-body" +title: "getBody" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent.getBody" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getBody` + +## Signature + +```java +public String getBody() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 478. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-context.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-context.mdx new file mode 100644 index 0000000000..81b8627353 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-context" +title: "getContext" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent.getContext" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getContext` + +## Signature + +```java +public String getContext() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 474. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-direction.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-direction.mdx new file mode 100644 index 0000000000..2611e36e8b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-direction.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-direction" +title: "getDirection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent.getDirection" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getDirection` + +## Signature + +```java +public String getDirection() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 475. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-from-number.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-from-number.mdx new file mode 100644 index 0000000000..de3cebc2c6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-from-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-from-number" +title: "getFromNumber" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent.getFromNumber" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getFromNumber` + +## Signature + +```java +public String getFromNumber() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 476. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-media.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-media.mdx new file mode 100644 index 0000000000..6852fb2db8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-media.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-media" +title: "getMedia" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent.getMedia" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getMedia` + +## Signature + +```java +public List getMedia() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 479. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-message-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-message-id.mdx new file mode 100644 index 0000000000..285b6562d5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-message-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-message-id" +title: "getMessageId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent.getMessageId" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getMessageId` + +## Signature + +```java +public String getMessageId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 473. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-message-state.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-message-state.mdx new file mode 100644 index 0000000000..ec2da3eed7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-message-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-message-state" +title: "getMessageState" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent.getMessageState" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getMessageState` + +## Signature + +```java +public String getMessageState() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 481. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-reason.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-reason.mdx new file mode 100644 index 0000000000..b2219b2d29 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-reason.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-reason" +title: "getReason" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent.getReason" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getReason` + +## Signature + +```java +public String getReason() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 482. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-segments.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-segments.mdx new file mode 100644 index 0000000000..1d8373a3f0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-segments.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-segments" +title: "getSegments" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent.getSegments" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getSegments` + +## Signature + +```java +public int getSegments() +``` + +## Returns + +`int` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 480. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-tags.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-tags.mdx new file mode 100644 index 0000000000..bae1e039c6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-tags.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-tags" +title: "getTags" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent.getTags" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getTags` + +## Signature + +```java +public List getTags() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 483. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-to-number.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-to-number.mdx new file mode 100644 index 0000000000..9958606d6f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-to-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/get-to-number" +title: "getToNumber" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent.getToNumber" + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getToNumber` + +## Signature + +```java +public String getToNumber() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 477. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/index.mdx new file mode 100644 index 0000000000..3f97561cb4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/index.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event" +title: "MessagingStateEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `MessagingStateEvent` + +Outbound messaging state event (`messaging.state`). + +**Modifiers:** `static` + +## Signature + +```java +public static class MessagingStateEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 468. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/init.mdx new file mode 100644 index 0000000000..5da8ed9fe3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/messaging-state-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + module: "com.signalwire.sdk.relay.RelayEvent.MessagingStateEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 469. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/get-call-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/get-call-id.mdx new file mode 100644 index 0000000000..66e985e8a4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/get-call-id" +title: "getCallId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.QueueEvent.getCallId" + parent: "com.signalwire.sdk.relay.RelayEvent.QueueEvent" + module: "com.signalwire.sdk.relay.RelayEvent.QueueEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getCallId` + +## Signature + +```java +public String getCallId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 428. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/get-queue-id.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/get-queue-id.mdx new file mode 100644 index 0000000000..022d589224 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/get-queue-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/get-queue-id" +title: "getQueueId" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.QueueEvent.getQueueId" + parent: "com.signalwire.sdk.relay.RelayEvent.QueueEvent" + module: "com.signalwire.sdk.relay.RelayEvent.QueueEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `getQueueId` + +## Signature + +```java +public String getQueueId() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 429. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/index.mdx new file mode 100644 index 0000000000..43080beaec --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event" +title: "QueueEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.QueueEvent" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `QueueEvent` + +Queue event (`calling.queue`). + +**Modifiers:** `static` + +## Signature + +```java +public static class QueueEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/java/com/signalwire/sdk/relay/relay/relay-event) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 423. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/init.mdx new file mode 100644 index 0000000000..50cc1327dc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/queue-event/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.QueueEvent." + parent: "com.signalwire.sdk.relay.RelayEvent.QueueEvent" + module: "com.signalwire.sdk.relay.RelayEvent.QueueEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (String eventType, double timestamp, Map params) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 424. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/to-string.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/to-string.mdx new file mode 100644 index 0000000000..d7d9ba5a40 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/relay/relay/relay-event/to-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/relay/relay/relay-event/to-string" +title: "toString" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.relay.RelayEvent.toString" + parent: "com.signalwire.sdk.relay.RelayEvent" + module: "com.signalwire.sdk.relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java" + visibility: "public" +--- +# `toString` + +**Decorators:** `@Override` + +## Signature + +```java +public String toString() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/relay/RelayEvent.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/relay/RelayEvent.java) + +Line 116. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/create.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/create.mdx new file mode 100644 index 0000000000..7b7703e388 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/create" +title: "create" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.AddressesNamespace.create" + parent: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + module: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java" + visibility: "public" +--- +# `create` + +## Signature + +```java +public Map create(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java) + +Line 39. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/delete.mdx new file mode 100644 index 0000000000..3b4c0da565 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.AddressesNamespace.delete" + parent: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + module: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String addressId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java) + +Line 47. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/get-base-path.mdx new file mode 100644 index 0000000000..4c45a9eb1e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.AddressesNamespace.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + module: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/get.mdx new file mode 100644 index 0000000000..a789715da2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.AddressesNamespace.get" + parent: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + module: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String addressId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java) + +Line 43. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/index.mdx new file mode 100644 index 0000000000..48ac4797e4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace" +title: "AddressesNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java" + visibility: "public" +--- +# `AddressesNamespace` + +Address management namespace. + +<p>Mirrors `signalwire.rest.namespaces.addresses.AddressesResource`: +list / create / get / delete (no update endpoint exists for addresses). +Paths sit under `/api/relay/rest/addresses`. + +## Signature + +```java +public class AddressesNamespace +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/init.mdx new file mode 100644 index 0000000000..2b1961d8f3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.AddressesNamespace." + parent: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + module: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/list.mdx new file mode 100644 index 0000000000..be3f124693 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/addresses-namespace/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.AddressesNamespace.list" + parent: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + module: "com.signalwire.sdk.rest.namespaces.AddressesNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/AddressesNamespace.java) + +Line 31. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/index.mdx new file mode 100644 index 0000000000..d4e91903da --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace" +title: "BillingNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.BillingNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java" + visibility: "public" +--- +# `BillingNamespace` + +REST namespace for billing resources. + +## Signature + +```java +public class BillingNamespace +``` + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/init.mdx new file mode 100644 index 0000000000..7bf7474249 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.BillingNamespace." + parent: "com.signalwire.sdk.rest.namespaces.BillingNamespace" + module: "com.signalwire.sdk.rest.namespaces.BillingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/invoices.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/invoices.mdx new file mode 100644 index 0000000000..9a298a5166 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/invoices.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/invoices" +title: "invoices" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.BillingNamespace.invoices" + parent: "com.signalwire.sdk.rest.namespaces.BillingNamespace" + module: "com.signalwire.sdk.rest.namespaces.BillingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java" + visibility: "public" +--- +# `invoices` + +## Signature + +```java +public CrudResource invoices() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/usage.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/usage.mdx new file mode 100644 index 0000000000..fdec1636b1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/usage.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/billing-namespace/usage" +title: "usage" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.BillingNamespace.usage" + parent: "com.signalwire.sdk.rest.namespaces.BillingNamespace" + module: "com.signalwire.sdk.rest.namespaces.BillingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java" + visibility: "public" +--- +# `usage` + +## Signature + +```java +public CrudResource usage() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/BillingNamespace.java) + +Line 26. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-hold.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-hold.mdx new file mode 100644 index 0000000000..33112daa1f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-hold.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-hold" +title: "aiHold" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.aiHold" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `aiHold` + +## Signature + +```java +public Map aiHold(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 184. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-message.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-message.mdx new file mode 100644 index 0000000000..21adc345cd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-message.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-message" +title: "aiMessage" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.aiMessage" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `aiMessage` + +## Signature + +```java +public Map aiMessage(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 180. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-stop.mdx new file mode 100644 index 0000000000..dfa633db20 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-stop" +title: "aiStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.aiStop" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `aiStop` + +## Signature + +```java +public Map aiStop(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 192. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-unhold.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-unhold.mdx new file mode 100644 index 0000000000..ba4e67e74e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-unhold.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/ai-unhold" +title: "aiUnhold" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.aiUnhold" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `aiUnhold` + +## Signature + +```java +public Map aiUnhold(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 188. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/calls.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/calls.mdx new file mode 100644 index 0000000000..e1e8a2def9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/calls.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/calls" +title: "calls" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.calls" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `calls` + +## Signature + +```java +public CrudResource calls() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 35. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect-start-input-timers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect-start-input-timers.mdx new file mode 100644 index 0000000000..08ec07e71e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect-start-input-timers.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect-start-input-timers" +title: "collectStartInputTimers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.collectStartInputTimers" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `collectStartInputTimers` + +## Signature + +```java +public Map collectStartInputTimers( + String callId, + Map params +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 124. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect-stop.mdx new file mode 100644 index 0000000000..39d03117a2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect-stop" +title: "collectStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.collectStop" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `collectStop` + +## Signature + +```java +public Map collectStop(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 120. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect.mdx new file mode 100644 index 0000000000..30bacbd3ac --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/collect" +title: "collect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.collect" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `collect` + +## Signature + +```java +public Map collect(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 116. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/denoise-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/denoise-stop.mdx new file mode 100644 index 0000000000..5ac2977e5e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/denoise-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/denoise-stop" +title: "denoiseStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.denoiseStop" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `denoiseStop` + +## Signature + +```java +public Map denoiseStop(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 164. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/denoise.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/denoise.mdx new file mode 100644 index 0000000000..c98bca1185 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/denoise.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/denoise" +title: "denoise" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.denoise" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `denoise` + +## Signature + +```java +public Map denoise(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 160. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/detect-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/detect-stop.mdx new file mode 100644 index 0000000000..fdc120bd6c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/detect-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/detect-stop" +title: "detectStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.detectStop" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `detectStop` + +## Signature + +```java +public Map detectStop(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 134. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/detect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/detect.mdx new file mode 100644 index 0000000000..4684420b8f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/detect.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/detect" +title: "detect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.detect" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `detect` + +## Signature + +```java +public Map detect(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 130. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/dial.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/dial.mdx new file mode 100644 index 0000000000..9f07669fb5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/dial.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/dial" +title: "dial" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.dial" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `dial` + +## Signature + +```java +public Map dial(Map params) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 54. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/disconnect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/disconnect.mdx new file mode 100644 index 0000000000..3d1bb7ec78 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/disconnect.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/disconnect" +title: "disconnect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.disconnect" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `disconnect` + +## Signature + +```java +public Map disconnect(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 70. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/end.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/end.mdx new file mode 100644 index 0000000000..a8987fda66 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/end.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/end" +title: "end" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.end" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `end` + +## Signature + +```java +public Map end(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 62. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/index.mdx new file mode 100644 index 0000000000..9154a3cc88 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/index.mdx @@ -0,0 +1,119 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace" +title: "CallingNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `CallingNamespace` + +REST-based call control. + +All commands are dispatched as +/api/calling/calls with a `"command"` field that names +the operation, optionally an `"id"` field that names the target call, +and a `"params"` object containing keyword arguments. The mock +server (and the real Calling API) matches commands against the registered +routes via the `command` field. + +## Signature + +```java +public class CallingNamespace +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 24. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/init.mdx new file mode 100644 index 0000000000..38485871f6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace." + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/live-transcribe.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/live-transcribe.mdx new file mode 100644 index 0000000000..782d7ac8c9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/live-transcribe.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/live-transcribe" +title: "liveTranscribe" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.liveTranscribe" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `liveTranscribe` + +## Signature + +```java +public Map liveTranscribe( + String callId, + Map params +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 198. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/live-translate.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/live-translate.mdx new file mode 100644 index 0000000000..017ea1560c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/live-translate.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/live-translate" +title: "liveTranslate" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.liveTranslate" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `liveTranslate` + +## Signature + +```java +public Map liveTranslate( + String callId, + Map params +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 202. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-pause.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-pause.mdx new file mode 100644 index 0000000000..ae9941d5f4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-pause.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-pause" +title: "playPause" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.playPause" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `playPause` + +## Signature + +```java +public Map playPause(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 80. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-resume.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-resume.mdx new file mode 100644 index 0000000000..7403c3541d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-resume.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-resume" +title: "playResume" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.playResume" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `playResume` + +## Signature + +```java +public Map playResume(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 84. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-stop.mdx new file mode 100644 index 0000000000..d0c931ed83 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-stop" +title: "playStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.playStop" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `playStop` + +## Signature + +```java +public Map playStop(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 88. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-volume.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-volume.mdx new file mode 100644 index 0000000000..ecc9967939 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-volume.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play-volume" +title: "playVolume" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.playVolume" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `playVolume` + +## Signature + +```java +public Map playVolume(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 92. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play.mdx new file mode 100644 index 0000000000..26e330a125 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/play" +title: "play" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.play" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `play` + +## Signature + +```java +public Map play(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 76. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/receive-fax-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/receive-fax-stop.mdx new file mode 100644 index 0000000000..eff78f0cbc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/receive-fax-stop.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/receive-fax-stop" +title: "receiveFaxStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.receiveFaxStop" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `receiveFaxStop` + +## Signature + +```java +public Map receiveFaxStop( + String callId, + Map params +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 212. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-pause.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-pause.mdx new file mode 100644 index 0000000000..9060b4e3f4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-pause.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-pause" +title: "recordPause" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.recordPause" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `recordPause` + +## Signature + +```java +public Map recordPause(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 102. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-resume.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-resume.mdx new file mode 100644 index 0000000000..3199efd7e5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-resume.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-resume" +title: "recordResume" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.recordResume" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `recordResume` + +## Signature + +```java +public Map recordResume(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 106. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-stop.mdx new file mode 100644 index 0000000000..f15865fd83 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record-stop" +title: "recordStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.recordStop" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `recordStop` + +## Signature + +```java +public Map recordStop(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 110. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record.mdx new file mode 100644 index 0000000000..a378286965 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/record" +title: "record" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.record" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `record` + +## Signature + +```java +public Map record(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 98. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/refer.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/refer.mdx new file mode 100644 index 0000000000..0a0200603f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/refer.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/refer" +title: "refer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.refer" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `refer` + +## Signature + +```java +public Map refer(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 218. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/send-fax-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/send-fax-stop.mdx new file mode 100644 index 0000000000..c75e15b2d3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/send-fax-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/send-fax-stop" +title: "sendFaxStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.sendFaxStop" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `sendFaxStop` + +## Signature + +```java +public Map sendFaxStop(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 208. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/stream-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/stream-stop.mdx new file mode 100644 index 0000000000..7852a4c2bc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/stream-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/stream-stop" +title: "streamStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.streamStop" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `streamStop` + +## Signature + +```java +public Map streamStop(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 154. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/stream.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/stream.mdx new file mode 100644 index 0000000000..e49ff1787d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/stream.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/stream" +title: "stream" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.stream" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `stream` + +## Signature + +```java +public Map stream(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 150. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/tap-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/tap-stop.mdx new file mode 100644 index 0000000000..2f5a958fb3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/tap-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/tap-stop" +title: "tapStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.tapStop" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `tapStop` + +## Signature + +```java +public Map tapStop(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 144. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/tap.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/tap.mdx new file mode 100644 index 0000000000..edec465621 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/tap.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/tap" +title: "tap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.tap" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `tap` + +## Signature + +```java +public Map tap(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 140. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transcribe-stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transcribe-stop.mdx new file mode 100644 index 0000000000..a329154424 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transcribe-stop.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transcribe-stop" +title: "transcribeStop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.transcribeStop" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `transcribeStop` + +## Signature + +```java +public Map transcribeStop( + String callId, + Map params +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 174. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transcribe.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transcribe.mdx new file mode 100644 index 0000000000..f96cbbbfda --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transcribe.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transcribe" +title: "transcribe" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.transcribe" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `transcribe` + +## Signature + +```java +public Map transcribe(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 170. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transfer.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transfer.mdx new file mode 100644 index 0000000000..a26a0c5ba4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transfer.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/transfer" +title: "transfer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.transfer" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `transfer` + +## Signature + +```java +public Map transfer(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 66. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/update.mdx new file mode 100644 index 0000000000..ac9dc4abaf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/update.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.update" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(Map params) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 58. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/user-event.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/user-event.mdx new file mode 100644 index 0000000000..82e72debf3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/user-event.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/calling-namespace/user-event" +title: "userEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CallingNamespace.userEvent" + parent: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + module: "com.signalwire.sdk.rest.namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java" + visibility: "public" +--- +# `userEvent` + +## Signature + +```java +public Map userEvent(String callId, Map params) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CallingNamespace.java) + +Line 224. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/assignments.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/assignments.mdx new file mode 100644 index 0000000000..d993b17bd2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/assignments.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/assignments" +title: "assignments" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CampaignNamespace.assignments" + parent: "com.signalwire.sdk.rest.namespaces.CampaignNamespace" + module: "com.signalwire.sdk.rest.namespaces.CampaignNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java" + visibility: "public" +--- +# `assignments` + +## Signature + +```java +public CrudResource assignments() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java) + +Line 32. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/brands.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/brands.mdx new file mode 100644 index 0000000000..8a1ff377eb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/brands.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/brands" +title: "brands" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CampaignNamespace.brands" + parent: "com.signalwire.sdk.rest.namespaces.CampaignNamespace" + module: "com.signalwire.sdk.rest.namespaces.CampaignNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java" + visibility: "public" +--- +# `brands` + +## Signature + +```java +public CrudResource brands() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/campaigns.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/campaigns.mdx new file mode 100644 index 0000000000..a88352636d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/campaigns.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/campaigns" +title: "campaigns" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CampaignNamespace.campaigns" + parent: "com.signalwire.sdk.rest.namespaces.CampaignNamespace" + module: "com.signalwire.sdk.rest.namespaces.CampaignNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java" + visibility: "public" +--- +# `campaigns` + +## Signature + +```java +public CrudResource campaigns() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/index.mdx new file mode 100644 index 0000000000..374784a6ef --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace" +title: "CampaignNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CampaignNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java" + visibility: "public" +--- +# `CampaignNamespace` + +REST namespace for 10DLC campaign registration resources. + +## Signature + +```java +public class CampaignNamespace +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/init.mdx new file mode 100644 index 0000000000..c89dc2a769 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CampaignNamespace." + parent: "com.signalwire.sdk.rest.namespaces.CampaignNamespace" + module: "com.signalwire.sdk.rest.namespaces.CampaignNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java) + +Line 22. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/orders.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/orders.mdx new file mode 100644 index 0000000000..f1b5ebcf73 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/orders.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/campaign-namespace/orders" +title: "orders" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CampaignNamespace.orders" + parent: "com.signalwire.sdk.rest.namespaces.CampaignNamespace" + module: "com.signalwire.sdk.rest.namespaces.CampaignNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java" + visibility: "public" +--- +# `orders` + +## Signature + +```java +public CrudResource orders() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CampaignNamespace.java) + +Line 31. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/channels.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/channels.mdx new file mode 100644 index 0000000000..60d6d088b5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/channels.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/channels" +title: "channels" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ChatNamespace.channels" + parent: "com.signalwire.sdk.rest.namespaces.ChatNamespace" + module: "com.signalwire.sdk.rest.namespaces.ChatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java" + visibility: "public" +--- +# `channels` + +## Signature + +```java +public CrudResource channels() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/index.mdx new file mode 100644 index 0000000000..4b2d40526f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace" +title: "ChatNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ChatNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java" + visibility: "public" +--- +# `ChatNamespace` + +REST namespace for chat resources. + +## Signature + +```java +public class ChatNamespace +``` + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/init.mdx new file mode 100644 index 0000000000..47d98afa9a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ChatNamespace." + parent: "com.signalwire.sdk.rest.namespaces.ChatNamespace" + module: "com.signalwire.sdk.rest.namespaces.ChatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java) + +Line 21. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/members.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/members.mdx new file mode 100644 index 0000000000..3294b078dc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/members.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/members" +title: "members" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ChatNamespace.members" + parent: "com.signalwire.sdk.rest.namespaces.ChatNamespace" + module: "com.signalwire.sdk.rest.namespaces.ChatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java" + visibility: "public" +--- +# `members` + +## Signature + +```java +public CrudResource members() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/messages.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/messages.mdx new file mode 100644 index 0000000000..eaaf3b1f93 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/messages.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/chat-namespace/messages" +title: "messages" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ChatNamespace.messages" + parent: "com.signalwire.sdk.rest.namespaces.ChatNamespace" + module: "com.signalwire.sdk.rest.namespaces.ChatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java" + visibility: "public" +--- +# `messages` + +## Signature + +```java +public CrudResource messages() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ChatNamespace.java) + +Line 28. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/accounts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/accounts.mdx new file mode 100644 index 0000000000..550b4d8ab9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/accounts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/accounts" +title: "accounts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.accounts" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `accounts` + +## Signature + +```java +public CompatAccounts accounts() +``` + +## Returns + +`CompatAccounts` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 74. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/applications.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/applications.mdx new file mode 100644 index 0000000000..1f287d087c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/applications.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/applications" +title: "applications" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.applications" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `applications` + +## Signature + +```java +public CompatApplications applications() +``` + +## Returns + +`CompatApplications` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 77. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/calls.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/calls.mdx new file mode 100644 index 0000000000..5f2f7dc825 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/calls.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/calls" +title: "calls" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.calls" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `calls` + +## Signature + +```java +public CompatCalls calls() +``` + +## Returns + +`CompatCalls` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 68. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/create.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/create.mdx new file mode 100644 index 0000000000..6819927b60 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/create" +title: "create" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts.create" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `create` + +## Signature + +```java +public Map create(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 347. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/get-base-path.mdx new file mode 100644 index 0000000000..e4a0e0f6a5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 337. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/get.mdx new file mode 100644 index 0000000000..20cfa6e0e6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts.get" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String sid) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 351. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/index.mdx new file mode 100644 index 0000000000..0ae8d8fac4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts" +title: "CompatAccounts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatAccounts` + +Compat account / sub-project management. + +<p>Mirrors `signalwire.rest.namespaces.compat.CompatAccounts`: +accounts.create lives at the top-level `/Accounts` collection +(no AccountSid prefix); accounts.get/update operate on +`/Accounts/{sid`}. + +update is a Twilio-compat POST (not PATCH/PUT). + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatAccounts +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 328. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/init.mdx new file mode 100644 index 0000000000..ed5ec01ff1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 333. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/list.mdx new file mode 100644 index 0000000000..303a9f49fb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts.list" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 339. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/update.mdx new file mode 100644 index 0000000000..2135d02ce8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-accounts/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts.update" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatAccounts" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String sid, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 355. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications/index.mdx new file mode 100644 index 0000000000..e870e2ae26 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications" +title: "CompatApplications" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatApplications" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatApplications` + +Compat application management. + +Twilio-compat update is POST. + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatApplications extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 462. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications/init.mdx new file mode 100644 index 0000000000..5a0692d3b6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatApplications." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatApplications" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatApplications" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 464. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications/update.mdx new file mode 100644 index 0000000000..f6c4e77572 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-applications/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatApplications.update" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatApplications" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatApplications" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `update` + +**Decorators:** `@Override` + +## Signature + +```java +public Map update(String sid, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 468. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/index.mdx new file mode 100644 index 0000000000..40f079fc09 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls" +title: "CompatCalls" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatCalls` + +Compat call management with recording and stream sub-resources. + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatCalls extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 91. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/init.mdx new file mode 100644 index 0000000000..599471988a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 93. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/start-recording.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/start-recording.mdx new file mode 100644 index 0000000000..ee6da257a2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/start-recording.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/start-recording" +title: "startRecording" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls.startRecording" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `startRecording` + +## Signature + +```java +public Map startRecording( + String callSid, + Map body +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 101. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/start-stream.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/start-stream.mdx new file mode 100644 index 0000000000..c5b0da7e98 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/start-stream.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/start-stream" +title: "startStream" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls.startStream" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `startStream` + +## Signature + +```java +public Map startStream(String callSid, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 111. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/stop-stream.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/stop-stream.mdx new file mode 100644 index 0000000000..bad26f154e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/stop-stream.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/stop-stream" +title: "stopStream" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls.stopStream" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `stopStream` + +## Signature + +```java +public Map stopStream( + String callSid, + String streamSid, + Map body +) +``` + +## Parameters + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 115. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/update-recording.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/update-recording.mdx new file mode 100644 index 0000000000..615595c6ff --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/update-recording.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/update-recording" +title: "updateRecording" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls.updateRecording" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `updateRecording` + +## Signature + +```java +public Map updateRecording( + String callSid, + String recordingSid, + Map body +) +``` + +## Parameters + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 105. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/update.mdx new file mode 100644 index 0000000000..db416e775a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-calls/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls.update" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatCalls" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String sid, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 97. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/delete-recording.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/delete-recording.mdx new file mode 100644 index 0000000000..c2d740f32a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/delete-recording.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/delete-recording" +title: "deleteRecording" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.deleteRecording" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `deleteRecording` + +## Signature + +```java +public Map deleteRecording( + String conferenceSid, + String recordingSid +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 441. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-base-path.mdx new file mode 100644 index 0000000000..28c4d8fc54 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 374. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-participant.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-participant.mdx new file mode 100644 index 0000000000..74d8f72e7c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-participant.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-participant" +title: "getParticipant" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.getParticipant" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `getParticipant` + +## Signature + +```java +public Map getParticipant(String conferenceSid, String callSid) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 403. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-recording.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-recording.mdx new file mode 100644 index 0000000000..2c84498f68 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-recording.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get-recording" +title: "getRecording" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.getRecording" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `getRecording` + +## Signature + +```java +public Map getRecording( + String conferenceSid, + String recordingSid +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 430. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get.mdx new file mode 100644 index 0000000000..034afddfdb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.get" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String sid) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 384. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/index.mdx new file mode 100644 index 0000000000..83354494fa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences" +title: "CompatConferences" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatConferences` + +Compat conference management with participants, recordings, and +stream sub-resources. + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatConferences +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 364. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/init.mdx new file mode 100644 index 0000000000..313a37d723 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 369. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list-participants.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list-participants.mdx new file mode 100644 index 0000000000..04c655e3ae --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list-participants.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list-participants" +title: "listParticipants" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.listParticipants" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `listParticipants` + +## Signature + + + + ```java + public Map listParticipants(String conferenceSid) + ``` + + + + ```java + public Map listParticipants( + String conferenceSid, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 394. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list-recordings.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list-recordings.mdx new file mode 100644 index 0000000000..9d501b0e3b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list-recordings.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list-recordings" +title: "listRecordings" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.listRecordings" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `listRecordings` + +## Signature + + + + ```java + public Map listRecordings(String conferenceSid) + ``` + + + + ```java + public Map listRecordings( + String conferenceSid, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 421. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list.mdx new file mode 100644 index 0000000000..e56ca920f6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.list" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 376. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/remove-participant.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/remove-participant.mdx new file mode 100644 index 0000000000..fa88fb2df0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/remove-participant.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/remove-participant" +title: "removeParticipant" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.removeParticipant" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `removeParticipant` + +## Signature + +```java +public Map removeParticipant( + String conferenceSid, + String callSid +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 414. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/start-stream.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/start-stream.mdx new file mode 100644 index 0000000000..7c2a77eec7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/start-stream.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/start-stream" +title: "startStream" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.startStream" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `startStream` + +## Signature + +```java +public Map startStream( + String conferenceSid, + Map body +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 448. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/stop-stream.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/stop-stream.mdx new file mode 100644 index 0000000000..7e597bf2d4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/stop-stream.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/stop-stream" +title: "stopStream" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.stopStream" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `stopStream` + +## Signature + +```java +public Map stopStream( + String conferenceSid, + String streamSid, + Map body +) +``` + +## Parameters + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 452. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update-participant.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update-participant.mdx new file mode 100644 index 0000000000..29d7fc0014 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update-participant.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update-participant" +title: "updateParticipant" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.updateParticipant" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `updateParticipant` + +## Signature + +```java +public Map updateParticipant( + String conferenceSid, + String callSid, + Map body +) +``` + +## Parameters + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 408. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update-recording.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update-recording.mdx new file mode 100644 index 0000000000..a14306f2d8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update-recording.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update-recording" +title: "updateRecording" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.updateRecording" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `updateRecording` + +## Signature + +```java +public Map updateRecording( + String conferenceSid, + String recordingSid, + Map body +) +``` + +## Parameters + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 435. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update.mdx new file mode 100644 index 0000000000..ffb9498b18 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-conferences/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences.update" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String sid, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 388. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/delete-media.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/delete-media.mdx new file mode 100644 index 0000000000..68d74c13e8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/delete-media.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/delete-media" +title: "deleteMedia" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes.deleteMedia" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `deleteMedia` + +## Signature + +```java +public Map deleteMedia(String faxSid, String mediaSid) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 177. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/get-media.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/get-media.mdx new file mode 100644 index 0000000000..719ece18fa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/get-media.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/get-media" +title: "getMedia" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes.getMedia" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `getMedia` + +## Signature + +```java +public Map getMedia(String faxSid, String mediaSid) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 173. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/index.mdx new file mode 100644 index 0000000000..18f0e58036 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes" +title: "CompatFaxes" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatFaxes` + +Compat fax management with media sub-resources. + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatFaxes extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 155. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/init.mdx new file mode 100644 index 0000000000..fcdc5ff857 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 157. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/list-media.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/list-media.mdx new file mode 100644 index 0000000000..8763d1cfdb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/list-media.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/list-media" +title: "listMedia" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes.listMedia" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `listMedia` + +## Signature + + + + ```java + public Map listMedia(String faxSid) + ``` + + + + ```java + public Map listMedia( + String faxSid, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 165. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/update.mdx new file mode 100644 index 0000000000..defedb2be7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-faxes/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes.update" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatFaxes" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String sid, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 161. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins/index.mdx new file mode 100644 index 0000000000..2818008aeb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins" +title: "CompatLamlBins" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatLamlBins" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatLamlBins` + +Compat cXML/LaML script bin management. + +Twilio-compat update is POST. + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatLamlBins extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 477. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins/init.mdx new file mode 100644 index 0000000000..a2eeeefb5f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatLamlBins." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatLamlBins" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatLamlBins" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 479. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins/update.mdx new file mode 100644 index 0000000000..11eaec3ae3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-laml-bins/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatLamlBins.update" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatLamlBins" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatLamlBins" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `update` + +**Decorators:** `@Override` + +## Signature + +```java +public Map update(String sid, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 483. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/delete-media.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/delete-media.mdx new file mode 100644 index 0000000000..b9651c31d9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/delete-media.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/delete-media" +title: "deleteMedia" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages.deleteMedia" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `deleteMedia` + +## Signature + +```java +public Map deleteMedia(String messageSid, String mediaSid) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 147. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/get-media.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/get-media.mdx new file mode 100644 index 0000000000..984aa61c93 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/get-media.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/get-media" +title: "getMedia" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages.getMedia" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `getMedia` + +## Signature + +```java +public Map getMedia(String messageSid, String mediaSid) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 143. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/index.mdx new file mode 100644 index 0000000000..b14d59f727 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages" +title: "CompatMessages" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatMessages` + +Compat message management with media sub-resources. + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatMessages extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 125. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/init.mdx new file mode 100644 index 0000000000..99ef70e630 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 127. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/list-media.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/list-media.mdx new file mode 100644 index 0000000000..c869718500 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/list-media.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/list-media" +title: "listMedia" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages.listMedia" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `listMedia` + +## Signature + + + + ```java + public Map listMedia(String messageSid) + ``` + + + + ```java + public Map listMedia( + String messageSid, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 135. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/update.mdx new file mode 100644 index 0000000000..28ebb8169f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-messages/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages.update" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatMessages" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String sid, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 131. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/delete.mdx new file mode 100644 index 0000000000..469f21a407 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers.delete" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String sid) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 219. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/get-base-path.mdx new file mode 100644 index 0000000000..ba9735fd94 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 201. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/get.mdx new file mode 100644 index 0000000000..f358cb1228 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers.get" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String sid) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 211. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/import-number.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/import-number.mdx new file mode 100644 index 0000000000..fd3d197470 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/import-number.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/import-number" +title: "importNumber" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers.importNumber" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `importNumber` + +## Signature + +```java +public Map importNumber(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 227. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/index.mdx new file mode 100644 index 0000000000..1326b088c3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers" +title: "CompatPhoneNumbers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatPhoneNumbers` + +Compat IncomingPhoneNumbers + AvailablePhoneNumbers management. + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatPhoneNumbers +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 185. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/init.mdx new file mode 100644 index 0000000000..2431d49ea1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 192. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/list-available-countries.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/list-available-countries.mdx new file mode 100644 index 0000000000..5033950f88 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/list-available-countries.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/list-available-countries" +title: "listAvailableCountries" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers.listAvailableCountries" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `listAvailableCountries` + +## Signature + + + + ```java + public Map listAvailableCountries() + ``` + + + + ```java + public Map listAvailableCountries(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 231. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/list.mdx new file mode 100644 index 0000000000..9e2ef41467 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers.list" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 203. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/purchase.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/purchase.mdx new file mode 100644 index 0000000000..99aefaf478 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/purchase.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/purchase" +title: "purchase" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers.purchase" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `purchase` + +## Signature + +```java +public Map purchase(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 223. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/search-local.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/search-local.mdx new file mode 100644 index 0000000000..117f1c7e03 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/search-local.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/search-local" +title: "searchLocal" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers.searchLocal" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `searchLocal` + +## Signature + + + + ```java + public Map searchLocal(String country) + ``` + + + + ```java + public Map searchLocal( + String country, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 239. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/search-toll-free.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/search-toll-free.mdx new file mode 100644 index 0000000000..0b45638188 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/search-toll-free.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/search-toll-free" +title: "searchTollFree" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers.searchTollFree" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `searchTollFree` + +## Signature + + + + ```java + public Map searchTollFree(String country) + ``` + + + + ```java + public Map searchTollFree( + String country, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 247. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/update.mdx new file mode 100644 index 0000000000..52a56d7aa8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-phone-numbers/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers.update" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String sid, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 215. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/dequeue-member.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/dequeue-member.mdx new file mode 100644 index 0000000000..919a0a5559 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/dequeue-member.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/dequeue-member" +title: "dequeueMember" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues.dequeueMember" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `dequeueMember` + +## Signature + +```java +public Map dequeueMember( + String queueSid, + String callSid, + Map body +) +``` + +## Parameters + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 515. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/get-member.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/get-member.mdx new file mode 100644 index 0000000000..c7e215b32d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/get-member.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/get-member" +title: "getMember" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues.getMember" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `getMember` + +## Signature + +```java +public Map getMember(String queueSid, String callSid) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 511. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/index.mdx new file mode 100644 index 0000000000..a4a547f477 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues" +title: "CompatQueues" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatQueues` + +Compat queue management with member operations. + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatQueues extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 492. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/init.mdx new file mode 100644 index 0000000000..a2d9e333cf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 494. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/list-members.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/list-members.mdx new file mode 100644 index 0000000000..0b2c41cc0c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/list-members.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/list-members" +title: "listMembers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues.listMembers" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `listMembers` + +## Signature + + + + ```java + public Map listMembers(String queueSid) + ``` + + + + ```java + public Map listMembers( + String queueSid, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 503. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/update.mdx new file mode 100644 index 0000000000..12568202d1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-queues/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues.update" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatQueues" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `update` + +**Decorators:** `@Override` + +## Signature + +```java +public Map update(String sid, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 498. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/delete.mdx new file mode 100644 index 0000000000..39876db69f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings.delete" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String sid) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 283. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/get-base-path.mdx new file mode 100644 index 0000000000..d384bd7785 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 269. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/get.mdx new file mode 100644 index 0000000000..9e6800e901 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings.get" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String sid) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 279. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/index.mdx new file mode 100644 index 0000000000..928b544385 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings" +title: "CompatRecordings" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatRecordings` + +Compat recording management. + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatRecordings +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 259. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/init.mdx new file mode 100644 index 0000000000..c8c06468c1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 264. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/list.mdx new file mode 100644 index 0000000000..391aa5c08b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-recordings/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings.list" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatRecordings" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 271. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/create.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/create.mdx new file mode 100644 index 0000000000..d9e1836efe --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/create" +title: "create" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens.create" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `create` + +## Signature + +```java +public Map create(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 538. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/delete.mdx new file mode 100644 index 0000000000..016731806f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens.delete" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String tokenId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 546. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/get-base-path.mdx new file mode 100644 index 0000000000..cfbff88f9b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 536. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/index.mdx new file mode 100644 index 0000000000..bdb0ee6a45 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens" +title: "CompatTokens" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatTokens` + +Compat API token management. + +Note: update is PATCH (BaseResource style), +not POST. + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatTokens +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 526. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/init.mdx new file mode 100644 index 0000000000..9e96a78687 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 531. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/update.mdx new file mode 100644 index 0000000000..a68c1826f1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-tokens/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens.update" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String tokenId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 542. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/delete.mdx new file mode 100644 index 0000000000..0fa77cae45 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions.delete" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String sid) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 315. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/get-base-path.mdx new file mode 100644 index 0000000000..0f3e12fbe5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 301. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/get.mdx new file mode 100644 index 0000000000..e009b508ca --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions.get" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String sid) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 311. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/index.mdx new file mode 100644 index 0000000000..8c6e97746c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions" +title: "CompatTranscriptions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatTranscriptions` + +Compat transcription management. + +**Modifiers:** `static` + +## Signature + +```java +public static class CompatTranscriptions +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 291. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/init.mdx new file mode 100644 index 0000000000..d9529874de --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 296. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/list.mdx new file mode 100644 index 0000000000..249d0abb97 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/compat-transcriptions/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions.list" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace.CompatTranscriptions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 303. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/conferences.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/conferences.mdx new file mode 100644 index 0000000000..c4268b153b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/conferences.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/conferences" +title: "conferences" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.conferences" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `conferences` + +## Signature + +```java +public CompatConferences conferences() +``` + +## Returns + +`CompatConferences` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 76. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/faxes.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/faxes.mdx new file mode 100644 index 0000000000..0aeeddd5fb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/faxes.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/faxes" +title: "faxes" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.faxes" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `faxes` + +## Signature + +```java +public CompatFaxes faxes() +``` + +## Returns + +`CompatFaxes` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 70. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/index.mdx new file mode 100644 index 0000000000..f4e1761034 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/index.mdx @@ -0,0 +1,125 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace" +title: "CompatNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `CompatNamespace` + +REST namespace for compatibility (CXML/Twilio-compatible) resources. + +<p>The Twilio-compatible LAML API is mounted under +`/api/laml/2010-04-01/Accounts/{AccountSid`}. + +The trailing +`/api` prefix is added by `HttpClient`, so namespace base +paths here begin with `/laml/2010-04-01/Accounts/...`. + +## Signature + +```java +public class CompatNamespace +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Classes + + + + Compat account / sub-project management. <p>Mirrors `signalwire.rest.namespaces.compat.CompatAccounts`: accounts.create lives at the top-level `/Accounts` collection (no AccountSid prefix); accounts.get/update operate on `/Accounts/{sid`\}. + + + + Compat application management. + + + + Compat call management with recording and stream sub-resources. + + + + Compat conference management with participants, recordings, and stream sub-resources. + + + + Compat fax management with media sub-resources. + + + + Compat cXML/LaML script bin management. + + + + Compat message management with media sub-resources. + + + + Compat IncomingPhoneNumbers + AvailablePhoneNumbers management. + + + + Compat queue management with member operations. + + + + Compat recording management. + + + + Compat API token management. + + + + Compat transcription management. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 22. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/init.mdx new file mode 100644 index 0000000000..aaef805e52 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace." + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String accountSid) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 44. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/laml-bins.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/laml-bins.mdx new file mode 100644 index 0000000000..73e79c8793 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/laml-bins.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/laml-bins" +title: "lamlBins" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.lamlBins" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `lamlBins` + +## Signature + +```java +public CompatLamlBins lamlBins() +``` + +## Returns + +`CompatLamlBins` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 78. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/messages.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/messages.mdx new file mode 100644 index 0000000000..32266eea00 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/messages.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/messages" +title: "messages" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.messages" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `messages` + +## Signature + +```java +public CompatMessages messages() +``` + +## Returns + +`CompatMessages` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 69. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/phone-numbers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/phone-numbers.mdx new file mode 100644 index 0000000000..6852f35541 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/phone-numbers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/phone-numbers" +title: "phoneNumbers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.phoneNumbers" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `phoneNumbers` + +## Signature + +```java +public CompatPhoneNumbers phoneNumbers() +``` + +## Returns + +`CompatPhoneNumbers` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 71. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/queues.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/queues.mdx new file mode 100644 index 0000000000..0bba1a8d46 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/queues.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/queues" +title: "queues" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.queues" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `queues` + +## Signature + +```java +public CompatQueues queues() +``` + +## Returns + +`CompatQueues` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 75. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/recordings.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/recordings.mdx new file mode 100644 index 0000000000..dd856ba5bc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/recordings.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/recordings" +title: "recordings" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.recordings" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `recordings` + +## Signature + +```java +public CompatRecordings recordings() +``` + +## Returns + +`CompatRecordings` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 72. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-credential-lists.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-credential-lists.mdx new file mode 100644 index 0000000000..c97b28aec5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-credential-lists.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-credential-lists" +title: "sipCredentialLists" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.sipCredentialLists" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `sipCredentialLists` + +## Signature + +```java +public CrudResource sipCredentialLists() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 81. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-domains.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-domains.mdx new file mode 100644 index 0000000000..32a089d23b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-domains.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-domains" +title: "sipDomains" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.sipDomains" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `sipDomains` + +## Signature + +```java +public CrudResource sipDomains() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 80. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-ip-access-control-lists.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-ip-access-control-lists.mdx new file mode 100644 index 0000000000..77baf4d39d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-ip-access-control-lists.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/sip-ip-access-control-lists" +title: "sipIpAccessControlLists" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.sipIpAccessControlLists" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `sipIpAccessControlLists` + +## Signature + +```java +public CrudResource sipIpAccessControlLists() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 82. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/tokens.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/tokens.mdx new file mode 100644 index 0000000000..f8aba90977 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/tokens" +title: "tokens" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.tokens" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `tokens` + +## Signature + +```java +public CompatTokens tokens() +``` + +## Returns + +`CompatTokens` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 79. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/transcriptions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/transcriptions.mdx new file mode 100644 index 0000000000..0043b553b3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/transcriptions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compat-namespace/transcriptions" +title: "transcriptions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.CompatNamespace.transcriptions" + parent: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + module: "com.signalwire.sdk.rest.namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java" + visibility: "public" +--- +# `transcriptions` + +## Signature + +```java +public CompatTranscriptions transcriptions() +``` + +## Returns + +`CompatTranscriptions` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/CompatNamespace.java) + +Line 73. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/cnam-registrations.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/cnam-registrations.mdx new file mode 100644 index 0000000000..b036fc9069 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/cnam-registrations.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/cnam-registrations" +title: "cnamRegistrations" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ComplianceNamespace.cnamRegistrations" + parent: "com.signalwire.sdk.rest.namespaces.ComplianceNamespace" + module: "com.signalwire.sdk.rest.namespaces.ComplianceNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java" + visibility: "public" +--- +# `cnamRegistrations` + +## Signature + +```java +public CrudResource cnamRegistrations() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/index.mdx new file mode 100644 index 0000000000..eaef34a20b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace" +title: "ComplianceNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ComplianceNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java" + visibility: "public" +--- +# `ComplianceNamespace` + +REST namespace for compliance resources (CNAM, SHAKEN/STIR). + +## Signature + +```java +public class ComplianceNamespace +``` + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/init.mdx new file mode 100644 index 0000000000..37a73dba9b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ComplianceNamespace." + parent: "com.signalwire.sdk.rest.namespaces.ComplianceNamespace" + module: "com.signalwire.sdk.rest.namespaces.ComplianceNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/shaken-stir.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/shaken-stir.mdx new file mode 100644 index 0000000000..aca84d0c8a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/shaken-stir.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/compliance-namespace/shaken-stir" +title: "shakenStir" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ComplianceNamespace.shakenStir" + parent: "com.signalwire.sdk.rest.namespaces.ComplianceNamespace" + module: "com.signalwire.sdk.rest.namespaces.ComplianceNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java" + visibility: "public" +--- +# `shakenStir` + +## Signature + +```java +public CrudResource shakenStir() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ComplianceNamespace.java) + +Line 26. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/conferences.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/conferences.mdx new file mode 100644 index 0000000000..5c4b8dfd26 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/conferences.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/conferences" +title: "conferences" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ConferenceNamespace.conferences" + parent: "com.signalwire.sdk.rest.namespaces.ConferenceNamespace" + module: "com.signalwire.sdk.rest.namespaces.ConferenceNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java" + visibility: "public" +--- +# `conferences` + +## Signature + +```java +public CrudResource conferences() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/index.mdx new file mode 100644 index 0000000000..22c9099439 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace" +title: "ConferenceNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ConferenceNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java" + visibility: "public" +--- +# `ConferenceNamespace` + +REST namespace for conference resources. + +## Signature + +```java +public class ConferenceNamespace +``` + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/init.mdx new file mode 100644 index 0000000000..8a426300be --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ConferenceNamespace." + parent: "com.signalwire.sdk.rest.namespaces.ConferenceNamespace" + module: "com.signalwire.sdk.rest.namespaces.ConferenceNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/participants.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/participants.mdx new file mode 100644 index 0000000000..1b7a396eba --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/participants.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/conference-namespace/participants" +title: "participants" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ConferenceNamespace.participants" + parent: "com.signalwire.sdk.rest.namespaces.ConferenceNamespace" + module: "com.signalwire.sdk.rest.namespaces.ConferenceNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java" + visibility: "public" +--- +# `participants` + +## Signature + +```java +public CrudResource participants() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ConferenceNamespace.java) + +Line 26. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/delete-chunk.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/delete-chunk.mdx new file mode 100644 index 0000000000..33c4365c07 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/delete-chunk.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/delete-chunk" +title: "deleteChunk" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments.deleteChunk" + parent: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments" + module: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java" + visibility: "public" +--- +# `deleteChunk` + +## Signature + +```java +public Map deleteChunk(String documentId, String chunkId) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java) + +Line 70. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/get-chunk.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/get-chunk.mdx new file mode 100644 index 0000000000..7ea07762c4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/get-chunk.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/get-chunk" +title: "getChunk" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments.getChunk" + parent: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments" + module: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java" + visibility: "public" +--- +# `getChunk` + +## Signature + +```java +public Map getChunk(String documentId, String chunkId) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java) + +Line 66. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/index.mdx new file mode 100644 index 0000000000..40cda916ec --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents" +title: "DatasphereDocuments" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments" + parent: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java" + visibility: "public" +--- +# `DatasphereDocuments` + +Document management with search and chunk operations. + +**Modifiers:** `static` + +## Signature + +```java +public static class DatasphereDocuments extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java) + +Line 48. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/init.mdx new file mode 100644 index 0000000000..efc29b0626 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments." + parent: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments" + module: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java) + +Line 50. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/list-chunks.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/list-chunks.mdx new file mode 100644 index 0000000000..fefb88a050 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/list-chunks.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/list-chunks" +title: "listChunks" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments.listChunks" + parent: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments" + module: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java" + visibility: "public" +--- +# `listChunks` + +## Signature + + + + ```java + public Map listChunks(String documentId) + ``` + + + + ```java + public Map listChunks( + String documentId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java) + +Line 58. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/search.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/search.mdx new file mode 100644 index 0000000000..46245c4983 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/search.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/datasphere-documents/search" +title: "search" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments.search" + parent: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments" + module: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.DatasphereDocuments" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java" + visibility: "public" +--- +# `search` + +## Signature + +```java +public Map search(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java) + +Line 54. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/documents.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/documents.mdx new file mode 100644 index 0000000000..a65681e8d3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/documents.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/documents" +title: "documents" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.documents" + parent: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace" + module: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java" + visibility: "public" +--- +# `documents` + +## Signature + +```java +public DatasphereDocuments documents() +``` + +## Returns + +`DatasphereDocuments` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java) + +Line 31. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/index.mdx new file mode 100644 index 0000000000..7d92f8329b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace" +title: "DatasphereNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java" + visibility: "public" +--- +# `DatasphereNamespace` + +REST namespace for DataSphere (knowledge base) resources. + +<p>Mirrors `signalwire.rest.namespaces.datasphere.DatasphereNamespace`: +documents are CRUD-shaped, plus `search` (POST) and chunk-level +operations. + +## Signature + +```java +public class DatasphereNamespace +``` + +## Methods + + + + + + + + Legacy convenience for knowledge-base search; the canonical entry point is `DatasphereDocuments#search(Map)`. + + + +## Classes + + + + Document management with search and chunk operations. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java) + +Line 21. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/init.mdx new file mode 100644 index 0000000000..407c118184 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace." + parent: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace" + module: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java) + +Line 26. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/search.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/search.mdx new file mode 100644 index 0000000000..60c7e72274 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/search.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/datasphere-namespace/search" +title: "search" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace.search" + parent: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace" + module: "com.signalwire.sdk.rest.namespaces.DatasphereNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java" + visibility: "public" +--- +# `search` + +Legacy convenience for knowledge-base search; the canonical entry point +is `DatasphereDocuments#search(Map)`. + +## Signature + +```java +public Map search(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/DatasphereNamespace.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/addresses.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/addresses.mdx new file mode 100644 index 0000000000..fc29b263ed --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/addresses.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/addresses" +title: "addresses" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.addresses" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `addresses` + +## Signature + +```java +public FabricAddresses addresses() +``` + +## Returns + +`FabricAddresses` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 68. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/ai-agents.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/ai-agents.mdx new file mode 100644 index 0000000000..5677524caa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/ai-agents.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/ai-agents" +title: "aiAgents" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.aiAgents" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `aiAgents` + +## Signature + +```java +public CrudResource aiAgents() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 70. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/deploy-version.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/deploy-version.mdx new file mode 100644 index 0000000000..501cb04e4d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/deploy-version.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/deploy-version" +title: "deployVersion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource.deployVersion" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `deployVersion` + +## Signature + +```java +public Map deployVersion( + String resourceId, + Map body +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 208. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/index.mdx new file mode 100644 index 0000000000..f89ea9a342 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource" +title: "CallFlowsResource" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `CallFlowsResource` + +Call flows resource — uses PUT for update and rewrites the path +segment to singular `call_flow` for sub-collection paths +(per the API spec). + +**Modifiers:** `static` + +## Signature + +```java +public static class CallFlowsResource extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 175. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/init.mdx new file mode 100644 index 0000000000..27e30a430c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource." + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 177. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/list-addresses.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/list-addresses.mdx new file mode 100644 index 0000000000..0813ff2d04 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/list-addresses.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/list-addresses" +title: "listAddresses" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource.listAddresses" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `listAddresses` + +## Signature + + + + ```java + public Map listAddresses(String resourceId) + ``` + + + + ```java + public Map listAddresses( + String resourceId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 190. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/list-versions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/list-versions.mdx new file mode 100644 index 0000000000..e3b029549a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/list-versions.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/list-versions" +title: "listVersions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource.listVersions" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `listVersions` + +## Signature + + + + ```java + public Map listVersions(String resourceId) + ``` + + + + ```java + public Map listVersions( + String resourceId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 199. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/update.mdx new file mode 100644 index 0000000000..00daa58dd8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows-resource/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource.update" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CallFlowsResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `update` + +**Decorators:** `@Override` + +## Signature + +```java +public Map update(String resourceId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 181. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows.mdx new file mode 100644 index 0000000000..10bc2469e4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/call-flows" +title: "callFlows" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.callFlows" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `callFlows` + +## Signature + +```java +public CallFlowsResource callFlows() +``` + +## Returns + +`CallFlowsResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 71. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/index.mdx new file mode 100644 index 0000000000..154de6ebee --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource" +title: "ConferenceRoomsResource" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.ConferenceRoomsResource" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `ConferenceRoomsResource` + +Conference rooms — singular `conference_room` for sub-collections. + +**Modifiers:** `static` + +## Signature + +```java +public static class ConferenceRoomsResource extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 216. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/init.mdx new file mode 100644 index 0000000000..1b97141ea6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.ConferenceRoomsResource." + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.ConferenceRoomsResource" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.ConferenceRoomsResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 218. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/list-addresses.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/list-addresses.mdx new file mode 100644 index 0000000000..0c6cb6a71f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/list-addresses.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/list-addresses" +title: "listAddresses" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.ConferenceRoomsResource.listAddresses" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.ConferenceRoomsResource" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.ConferenceRoomsResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `listAddresses` + +## Signature + + + + ```java + public Map listAddresses(String resourceId) + ``` + + + + ```java + public Map listAddresses( + String resourceId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 231. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/update.mdx new file mode 100644 index 0000000000..4c20edae7f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms-resource/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.ConferenceRoomsResource.update" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.ConferenceRoomsResource" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.ConferenceRoomsResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `update` + +**Decorators:** `@Override` + +## Signature + +```java +public Map update(String resourceId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 222. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms.mdx new file mode 100644 index 0000000000..573ecf5d87 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/conference-rooms" +title: "conferenceRooms" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.conferenceRooms" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `conferenceRooms` + +## Signature + +```java +public ConferenceRoomsResource conferenceRooms() +``` + +## Returns + +`ConferenceRoomsResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 72. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/create.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/create.mdx new file mode 100644 index 0000000000..c36cf2f740 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/create" +title: "create" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CxmlApplicationsResource.create" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CxmlApplicationsResource" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CxmlApplicationsResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `create` + +**Decorators:** `@Override` + +## Signature + +```java +public Map create(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 251. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/index.mdx new file mode 100644 index 0000000000..af548761bc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource" +title: "CxmlApplicationsResource" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CxmlApplicationsResource" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `CxmlApplicationsResource` + +cXML applications — read/update/delete only (no create endpoint exists). +Calling `create` raises `UnsupportedOperationException`. + +**Modifiers:** `static` + +## Signature + +```java +public static class CxmlApplicationsResource extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 245. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/init.mdx new file mode 100644 index 0000000000..e89dbd3c7e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CxmlApplicationsResource." + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CxmlApplicationsResource" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CxmlApplicationsResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 247. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/update.mdx new file mode 100644 index 0000000000..3f33d48ca8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications-resource/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CxmlApplicationsResource.update" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CxmlApplicationsResource" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.CxmlApplicationsResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `update` + +**Decorators:** `@Override` + +## Signature + +```java +public Map update(String resourceId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 257. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications.mdx new file mode 100644 index 0000000000..eb11d28f0c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-applications" +title: "cxmlApplications" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.cxmlApplications" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `cxmlApplications` + +## Signature + +```java +public CxmlApplicationsResource cxmlApplications() +``` + +## Returns + +`CxmlApplicationsResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 73. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-scripts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-scripts.mdx new file mode 100644 index 0000000000..6ff5dc2912 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-scripts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-scripts" +title: "cxmlScripts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.cxmlScripts" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `cxmlScripts` + +## Signature + +```java +public CrudResource cxmlScripts() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 74. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-webhooks.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-webhooks.mdx new file mode 100644 index 0000000000..d7026e5b41 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-webhooks.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/cxml-webhooks" +title: "cxmlWebhooks" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.cxmlWebhooks" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `cxmlWebhooks` + +## Signature + +```java +public CrudResource cxmlWebhooks() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 75. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/get-base-path.mdx new file mode 100644 index 0000000000..b2e5e15bb5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 101. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/get.mdx new file mode 100644 index 0000000000..6660ee3a8e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses.get" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String addressId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 111. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/index.mdx new file mode 100644 index 0000000000..662c927a8b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses" +title: "FabricAddresses" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `FabricAddresses` + +Read-only fabric addresses collection (top-level). + +**Modifiers:** `static` + +## Signature + +```java +public static class FabricAddresses +``` + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 91. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/init.mdx new file mode 100644 index 0000000000..15b4c1a142 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses." + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 96. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/list.mdx new file mode 100644 index 0000000000..493110c4af --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-addresses/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses.list" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricAddresses" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 103. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/create-sip-endpoint.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/create-sip-endpoint.mdx new file mode 100644 index 0000000000..f84dc76d80 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/create-sip-endpoint.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/create-sip-endpoint" +title: "createSipEndpoint" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers.createSipEndpoint" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `createSipEndpoint` + +## Signature + +```java +public Map createSipEndpoint( + String subscriberId, + Map body +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 139. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/delete-sip-endpoint.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/delete-sip-endpoint.mdx new file mode 100644 index 0000000000..de3543b38e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/delete-sip-endpoint.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/delete-sip-endpoint" +title: "deleteSipEndpoint" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers.deleteSipEndpoint" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `deleteSipEndpoint` + +## Signature + +```java +public Map deleteSipEndpoint( + String subscriberId, + String endpointId +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 155. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/get-sip-endpoint.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/get-sip-endpoint.mdx new file mode 100644 index 0000000000..e3c9a1f64c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/get-sip-endpoint.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/get-sip-endpoint" +title: "getSipEndpoint" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers.getSipEndpoint" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `getSipEndpoint` + +## Signature + +```java +public Map getSipEndpoint(String subscriberId, String endpointId) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 144. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/index.mdx new file mode 100644 index 0000000000..27e30a79ea --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers" +title: "FabricSubscribers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `FabricSubscribers` + +Subscribers resource with SIP-endpoint sub-resource. + +Update uses PUT. + +**Modifiers:** `static` + +## Signature + +```java +public static class FabricSubscribers extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 119. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/init.mdx new file mode 100644 index 0000000000..917764b1e3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers." + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 121. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/list-addresses.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/list-addresses.mdx new file mode 100644 index 0000000000..88cbc765fd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/list-addresses.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/list-addresses" +title: "listAddresses" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers.listAddresses" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `listAddresses` + +## Signature + + + + ```java + public Map listAddresses(String subscriberId) + ``` + + + + ```java + public Map listAddresses( + String subscriberId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 160. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/list-sip-endpoints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/list-sip-endpoints.mdx new file mode 100644 index 0000000000..1f5044594c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/list-sip-endpoints.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/list-sip-endpoints" +title: "listSipEndpoints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers.listSipEndpoints" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `listSipEndpoints` + +## Signature + + + + ```java + public Map listSipEndpoints(String subscriberId) + ``` + + + + ```java + public Map listSipEndpoints( + String subscriberId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 130. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/update-sip-endpoint.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/update-sip-endpoint.mdx new file mode 100644 index 0000000000..6a21a1555a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/update-sip-endpoint.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/update-sip-endpoint" +title: "updateSipEndpoint" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers.updateSipEndpoint" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `updateSipEndpoint` + +## Signature + +```java +public Map updateSipEndpoint( + String subscriberId, + String endpointId, + Map body +) +``` + +## Parameters + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 149. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/update.mdx new file mode 100644 index 0000000000..a4b0f50f9d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-subscribers/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers.update" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricSubscribers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `update` + +**Decorators:** `@Override` + +## Signature + +```java +public Map update(String resourceId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 125. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-embed-token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-embed-token.mdx new file mode 100644 index 0000000000..3bbeb34b1c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-embed-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-embed-token" +title: "createEmbedToken" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens.createEmbedToken" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `createEmbedToken` + +## Signature + +```java +public Map createEmbedToken(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 336. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-guest-token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-guest-token.mdx new file mode 100644 index 0000000000..d0f5310f0d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-guest-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-guest-token" +title: "createGuestToken" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens.createGuestToken" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `createGuestToken` + +## Signature + +```java +public Map createGuestToken(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 332. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-invite-token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-invite-token.mdx new file mode 100644 index 0000000000..8c42373842 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-invite-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-invite-token" +title: "createInviteToken" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens.createInviteToken" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `createInviteToken` + +## Signature + +```java +public Map createInviteToken(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 328. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-subscriber-token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-subscriber-token.mdx new file mode 100644 index 0000000000..fe6c60654e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-subscriber-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/create-subscriber-token" +title: "createSubscriberToken" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens.createSubscriberToken" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `createSubscriberToken` + +## Signature + +```java +public Map createSubscriberToken(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 320. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/index.mdx new file mode 100644 index 0000000000..0c23cde79e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens" +title: "FabricTokens" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `FabricTokens` + +Subscriber, guest, invite, and embed token endpoints (all POST). + +**Modifiers:** `static` + +## Signature + +```java +public static class FabricTokens +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 312. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/init.mdx new file mode 100644 index 0000000000..2abe3efb58 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens." + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 316. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/refresh-subscriber-token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/refresh-subscriber-token.mdx new file mode 100644 index 0000000000..79c084877c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/refresh-subscriber-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/fabric-tokens/refresh-subscriber-token" +title: "refreshSubscriberToken" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens.refreshSubscriberToken" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `refreshSubscriberToken` + +## Signature + +```java +public Map refreshSubscriberToken(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 324. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/freeswitch-connectors.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/freeswitch-connectors.mdx new file mode 100644 index 0000000000..6c21c4a60d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/freeswitch-connectors.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/freeswitch-connectors" +title: "freeswitchConnectors" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.freeswitchConnectors" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `freeswitchConnectors` + +## Signature + +```java +public CrudResource freeswitchConnectors() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 76. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/assign-domain-application.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/assign-domain-application.mdx new file mode 100644 index 0000000000..59af638501 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/assign-domain-application.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/assign-domain-application" +title: "assignDomainApplication" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources.assignDomainApplication" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `assignDomainApplication` + +## Signature + +```java +public Map assignDomainApplication( + String resourceId, + Map body +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 303. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/delete.mdx new file mode 100644 index 0000000000..78da0ae61d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources.delete" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String resourceId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 291. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/get-base-path.mdx new file mode 100644 index 0000000000..d2767352bf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 277. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/get.mdx new file mode 100644 index 0000000000..7f1a6aceec --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources.get" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String resourceId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 287. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/index.mdx new file mode 100644 index 0000000000..d190b9bd6f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources" +title: "GenericResources" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `GenericResources` + +Generic operations against `/api/fabric/resources`: list, get, +delete, plus address listing and domain-application assignment. + +**Modifiers:** `static` + +## Signature + +```java +public static class GenericResources +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 267. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/init.mdx new file mode 100644 index 0000000000..e6466cf95c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources." + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 272. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/list-addresses.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/list-addresses.mdx new file mode 100644 index 0000000000..dd6b558c78 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/list-addresses.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/list-addresses" +title: "listAddresses" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources.listAddresses" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `listAddresses` + +## Signature + + + + ```java + public Map listAddresses(String resourceId) + ``` + + + + ```java + public Map listAddresses( + String resourceId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 295. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/list.mdx new file mode 100644 index 0000000000..d049bfca1b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/generic-resources/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources.list" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace.GenericResources" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 279. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/index.mdx new file mode 100644 index 0000000000..cf48367598 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/index.mdx @@ -0,0 +1,109 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace" +title: "FabricNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `FabricNamespace` + +REST namespace for SignalWire Fabric resources. + +<p>Mirrors `signalwire.rest.namespaces.fabric.FabricNamespace`: the +sub-resources expose typed access to addresses, generic resources, +subscribers (with sip-endpoint sub-resource ops), call-flow / conference-room +address sub-paths, cxml-applications (read-only), and tokens. + +The +`resources` entry-point handles cross-resource list/get/delete plus +domain-application assignment. + +## Signature + +```java +public class FabricNamespace +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Classes + + + + Call flows resource — uses PUT for update and rewrites the path segment to singular `call_flow` for sub-collection paths (per the API spec). + + + + Conference rooms — singular `conference_room` for sub-collections. + + + + cXML applications — read/update/delete only (no create endpoint exists). Calling `create` raises `UnsupportedOperationException`. + + + + Read-only fabric addresses collection (top-level). + + + + Subscribers resource with SIP-endpoint sub-resource. + + + + Subscriber, guest, invite, and embed token endpoints (all POST). + + + + Generic operations against `/api/fabric/resources`: list, get, delete, plus address listing and domain-application assignment. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 24. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/init.mdx new file mode 100644 index 0000000000..6761d53dc6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace." + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 43. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/relay-applications.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/relay-applications.mdx new file mode 100644 index 0000000000..812521083b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/relay-applications.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/relay-applications" +title: "relayApplications" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.relayApplications" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `relayApplications` + +## Signature + +```java +public CrudResource relayApplications() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 77. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/resources.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/resources.mdx new file mode 100644 index 0000000000..54826d7c23 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/resources.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/resources" +title: "resources" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.resources" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `resources` + +## Signature + +```java +public GenericResources resources() +``` + +## Returns + +`GenericResources` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 69. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/sip-endpoints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/sip-endpoints.mdx new file mode 100644 index 0000000000..6f62827f4b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/sip-endpoints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/sip-endpoints" +title: "sipEndpoints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.sipEndpoints" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `sipEndpoints` + +## Signature + +```java +public CrudResource sipEndpoints() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 78. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/sip-gateways.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/sip-gateways.mdx new file mode 100644 index 0000000000..bbfee018ba --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/sip-gateways.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/sip-gateways" +title: "sipGateways" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.sipGateways" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `sipGateways` + +## Signature + +```java +public CrudResource sipGateways() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 79. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/subscribers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/subscribers.mdx new file mode 100644 index 0000000000..581bb25eee --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/subscribers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/subscribers" +title: "subscribers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.subscribers" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `subscribers` + +## Signature + +```java +public FabricSubscribers subscribers() +``` + +## Returns + +`FabricSubscribers` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 67. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/swml-scripts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/swml-scripts.mdx new file mode 100644 index 0000000000..61e299f1c6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/swml-scripts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/swml-scripts" +title: "swmlScripts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.swmlScripts" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `swmlScripts` + +## Signature + +```java +public CrudResource swmlScripts() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 80. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/swml-webhooks.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/swml-webhooks.mdx new file mode 100644 index 0000000000..a21e54a79a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/swml-webhooks.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/swml-webhooks" +title: "swmlWebhooks" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.swmlWebhooks" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `swmlWebhooks` + +## Signature + +```java +public CrudResource swmlWebhooks() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 81. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/tokens.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/tokens.mdx new file mode 100644 index 0000000000..ad28010cd7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fabric-namespace/tokens" +title: "tokens" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FabricNamespace.tokens" + parent: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + module: "com.signalwire.sdk.rest.namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java" + visibility: "public" +--- +# `tokens` + +## Signature + +```java +public FabricTokens tokens() +``` + +## Returns + +`FabricTokens` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FabricNamespace.java) + +Line 82. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace/faxes.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace/faxes.mdx new file mode 100644 index 0000000000..5716e63afb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace/faxes.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace/faxes" +title: "faxes" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FaxNamespace.faxes" + parent: "com.signalwire.sdk.rest.namespaces.FaxNamespace" + module: "com.signalwire.sdk.rest.namespaces.FaxNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FaxNamespace.java" + visibility: "public" +--- +# `faxes` + +## Signature + +```java +public CrudResource faxes() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FaxNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FaxNamespace.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace/index.mdx new file mode 100644 index 0000000000..6e11a5dcd4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace" +title: "FaxNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FaxNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FaxNamespace.java" + visibility: "public" +--- +# `FaxNamespace` + +REST namespace for fax resources. + +## Signature + +```java +public class FaxNamespace +``` + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FaxNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FaxNamespace.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace/init.mdx new file mode 100644 index 0000000000..1f8f30a1f4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/fax-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.FaxNamespace." + parent: "com.signalwire.sdk.rest.namespaces.FaxNamespace" + module: "com.signalwire.sdk.rest.namespaces.FaxNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FaxNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/FaxNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/FaxNamespace.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/create.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/create.mdx new file mode 100644 index 0000000000..e34b1966ea --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/create" +title: "create" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ImportedNumbersNamespace.create" + parent: "com.signalwire.sdk.rest.namespaces.ImportedNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.ImportedNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java" + visibility: "public" +--- +# `create` + +## Signature + +```java +public Map create(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/get-base-path.mdx new file mode 100644 index 0000000000..bceaa09f0c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ImportedNumbersNamespace.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.ImportedNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.ImportedNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java) + +Line 28. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/index.mdx new file mode 100644 index 0000000000..99e3e3009b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace" +title: "ImportedNumbersNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ImportedNumbersNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java" + visibility: "public" +--- +# `ImportedNumbersNamespace` + +Imported Phone Numbers namespace — create-only. + +<p>Mirrors +`signalwire.rest.namespaces.imported_numbers.ImportedNumbersResource`. + +## Signature + +```java +public class ImportedNumbersNamespace +``` + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/init.mdx new file mode 100644 index 0000000000..2ef1012865 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/imported-numbers-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ImportedNumbersNamespace." + parent: "com.signalwire.sdk.rest.namespaces.ImportedNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.ImportedNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ImportedNumbersNamespace.java) + +Line 24. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/index.mdx new file mode 100644 index 0000000000..b23c75844e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/index.mdx @@ -0,0 +1,143 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces" +title: "namespaces" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" +--- +# `namespaces` + +## Signature + +```java +package com.signalwire.sdk.rest.namespaces +``` + +## Classes + + + + Address management namespace. <p>Mirrors `signalwire.rest.namespaces.addresses.AddressesResource`: list / create / get / delete (no update endpoint exists for addresses). Paths sit under `/api/relay/rest/addresses`. + + + + REST namespace for billing resources. + + + + REST-based call control. + + + + REST namespace for 10DLC campaign registration resources. + + + + REST namespace for chat resources. + + + + REST namespace for compatibility (CXML/Twilio-compatible) resources. <p>The Twilio-compatible LAML API is mounted under `/api/laml/2010-04-01/Accounts/{AccountSid`\}. + + + + REST namespace for compliance resources (CNAM, SHAKEN/STIR). + + + + REST namespace for conference resources. + + + + REST namespace for DataSphere (knowledge base) resources. <p>Mirrors `signalwire.rest.namespaces.datasphere.DatasphereNamespace`: documents are CRUD-shaped, plus `search` (POST) and chunk-level operations. + + + + REST namespace for SignalWire Fabric resources. <p>Mirrors `signalwire.rest.namespaces.fabric.FabricNamespace`: the sub-resources expose typed access to addresses, generic resources, subscribers (with sip-endpoint sub-resource ops), call-flow / conference-room address sub-paths, cxml-applications (read-only), and tokens. + + + + REST namespace for fax resources. + + + + Imported Phone Numbers namespace — create-only. <p>Mirrors `signalwire.rest.namespaces.imported_numbers.ImportedNumbersResource`. + + + + Logs namespace — message, voice, fax, and conference logs (read-only). <p>Mirrors `signalwire.rest.namespaces.logs.LogsNamespace`: each sub-resource fans out to a distinct sub-API root (message → /messaging/logs, voice → /voice/logs, fax → /fax/logs, conference → /logs/conferences). + + + + REST namespace for messaging (SMS/MMS) resources. + + + + MFA (Multi-Factor Authentication) namespace. <p>Mirrors `signalwire.rest.namespaces.mfa.MfaResource`: sms / call / verify endpoints. + + + + Number Groups namespace — full CRUD on number groups + membership ops. <p>Mirrors `signalwire.rest.namespaces.number_groups.NumberGroupsResource`: the group CRUD uses PUT for update; membership get/delete operate against a separate top-level `/api/relay/rest/number_group_memberships` collection (not a sub-collection of the group). + + + + REST namespace for number lookup (CNAM/carrier lookup) resources. + + + + REST namespace for phone number management. <p> Supports the standard CRUD surface plus typed helpers for binding an inbound call to a handler (SWML webhook, cXML webhook, AI agent, call flow, RELAY application/topic). + + + + REST namespace for project management resources. <p>Mirrors `signalwire.rest.namespaces.project.ProjectNamespace`: exposes `ProjectTokens` for API token CRUD (PATCH for update, DELETE for revoke). + + + + REST namespace for Pub/Sub resources. + + + + Queues namespace — full CRUD with member operations. <p>Mirrors `signalwire.rest.namespaces.queues.QueuesResource`: queue CRUD uses PUT for update; members are addressable both per-id and via the special `/next` endpoint. + + + + Recordings namespace — list / get / delete (no create/update). <p>Mirrors `signalwire.rest.namespaces.recordings.RecordingsResource`. Path: `/api/relay/rest/recordings`. + + + + 10DLC Campaign Registry namespace — brands, campaigns, orders, numbers. <p>Mirrors `signalwire.rest.namespaces.registry.RegistryNamespace`. All endpoints sit under `/api/relay/rest/registry/beta`. + + + + Short Codes namespace — list / get / update (PUT). + + + + REST namespace for SIP resources. + + + + SIP Profile namespace — get / update (PUT) the project's singleton SIP profile. <p>Mirrors `signalwire.rest.namespaces.sip_profile.SipProfileResource`. + + + + REST namespace for audio stream resources. + + + + REST namespace for SWML script resources. + + + + REST namespace for transcription resources. + + + + REST namespace for the Video API: rooms, room sessions/recordings, conferences, conference tokens, and individual streams. <p>Mirrors `signalwire.rest.namespaces.video.VideoNamespace`. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/get-base-path.mdx new file mode 100644 index 0000000000..d511defad7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.ConferenceLogs.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.ConferenceLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.ConferenceLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 140. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/index.mdx new file mode 100644 index 0000000000..498d644a33 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs" +title: "ConferenceLogs" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.ConferenceLogs" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `ConferenceLogs` + +Conference logs — list-only. + +**Modifiers:** `static` + +## Signature + +```java +public static class ConferenceLogs +``` + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 130. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/init.mdx new file mode 100644 index 0000000000..bd87bcc254 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.ConferenceLogs." + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.ConferenceLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.ConferenceLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 135. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/list.mdx new file mode 100644 index 0000000000..ea35fc73b9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conference-logs/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.ConferenceLogs.list" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.ConferenceLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.ConferenceLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 142. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conferences.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conferences.mdx new file mode 100644 index 0000000000..a3c6210c3f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conferences.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/conferences" +title: "conferences" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.conferences" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `conferences` + +## Signature + +```java +public ConferenceLogs conferences() +``` + +## Returns + +`ConferenceLogs` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/get-base-path.mdx new file mode 100644 index 0000000000..7c48aeb149 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 114. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/get.mdx new file mode 100644 index 0000000000..d035d6a971 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs.get" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String logId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 124. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/index.mdx new file mode 100644 index 0000000000..23b6f75625 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs" +title: "FaxLogs" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `FaxLogs` + +Fax logs — list + per-id get. + +**Modifiers:** `static` + +## Signature + +```java +public static class FaxLogs +``` + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 104. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/init.mdx new file mode 100644 index 0000000000..296671e674 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs." + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 109. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/list.mdx new file mode 100644 index 0000000000..41ff13bd61 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax-logs/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs.list" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.FaxLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 116. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax.mdx new file mode 100644 index 0000000000..255b7e6190 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/fax" +title: "fax" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.fax" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `fax` + +## Signature + +```java +public FaxLogs fax() +``` + +## Returns + +`FaxLogs` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 36. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/index.mdx new file mode 100644 index 0000000000..66cd05abeb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace" +title: "LogsNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `LogsNamespace` + +Logs namespace — message, voice, fax, and conference logs (read-only). + +<p>Mirrors `signalwire.rest.namespaces.logs.LogsNamespace`: each +sub-resource fans out to a distinct sub-API root (message → /messaging/logs, +voice → /voice/logs, fax → /fax/logs, conference → /logs/conferences). + +## Signature + +```java +public class LogsNamespace +``` + +## Methods + + + + + + + + + + + + + +## Classes + + + + Conference logs — list-only. + + + + Fax logs — list + per-id get. + + + + Read-only logs supporting list + per-id get. + + + + Voice logs add a per-id events sub-collection. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/init.mdx new file mode 100644 index 0000000000..9ceefd6f08 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace." + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/get-base-path.mdx new file mode 100644 index 0000000000..47c54bf091 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 54. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/get.mdx new file mode 100644 index 0000000000..76ea310d75 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs.get" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String logId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 64. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/index.mdx new file mode 100644 index 0000000000..4b7cbcdc4d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs" +title: "MessageLogs" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `MessageLogs` + +Read-only logs supporting list + per-id get. + +**Modifiers:** `static` + +## Signature + +```java +public static class MessageLogs +``` + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 44. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/init.mdx new file mode 100644 index 0000000000..52fcff088c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs." + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 49. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/list.mdx new file mode 100644 index 0000000000..f8d4abae7a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/message-logs/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs.list" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.MessageLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 56. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/messages.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/messages.mdx new file mode 100644 index 0000000000..4bbee41e49 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/messages.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/messages" +title: "messages" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.messages" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `messages` + +## Signature + +```java +public MessageLogs messages() +``` + +## Returns + +`MessageLogs` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/get-base-path.mdx new file mode 100644 index 0000000000..2324d1511f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 80. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/get.mdx new file mode 100644 index 0000000000..041a230f24 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs.get" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String logId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 90. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/index.mdx new file mode 100644 index 0000000000..ee89618da0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs" +title: "VoiceLogs" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `VoiceLogs` + +Voice logs add a per-id events sub-collection. + +**Modifiers:** `static` + +## Signature + +```java +public static class VoiceLogs +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 70. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/init.mdx new file mode 100644 index 0000000000..63b915f695 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs." + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 75. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/list-events.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/list-events.mdx new file mode 100644 index 0000000000..c8251c806b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/list-events.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/list-events" +title: "listEvents" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs.listEvents" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `listEvents` + +## Signature + + + + ```java + public Map listEvents(String logId) + ``` + + + + ```java + public Map listEvents( + String logId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 94. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/list.mdx new file mode 100644 index 0000000000..51e4949f75 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice-logs/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs.list" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace.VoiceLogs" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 82. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice.mdx new file mode 100644 index 0000000000..9262fe4f46 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/logs-namespace/voice" +title: "voice" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.LogsNamespace.voice" + parent: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + module: "com.signalwire.sdk.rest.namespaces.LogsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java" + visibility: "public" +--- +# `voice` + +## Signature + +```java +public VoiceLogs voice() +``` + +## Returns + +`VoiceLogs` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/LogsNamespace.java) + +Line 35. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/index.mdx new file mode 100644 index 0000000000..bb55f3d8ae --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace" +title: "MessagingNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.MessagingNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java" + visibility: "public" +--- +# `MessagingNamespace` + +REST namespace for messaging (SMS/MMS) resources. + +## Signature + +```java +public class MessagingNamespace +``` + +## Methods + + + + + + + + Send a message via REST. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java) + +Line 17. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/init.mdx new file mode 100644 index 0000000000..5e9f29cdd8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.MessagingNamespace." + parent: "com.signalwire.sdk.rest.namespaces.MessagingNamespace" + module: "com.signalwire.sdk.rest.namespaces.MessagingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java) + +Line 22. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/messages.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/messages.mdx new file mode 100644 index 0000000000..25bca4df6f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/messages.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/messages" +title: "messages" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.MessagingNamespace.messages" + parent: "com.signalwire.sdk.rest.namespaces.MessagingNamespace" + module: "com.signalwire.sdk.rest.namespaces.MessagingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java" + visibility: "public" +--- +# `messages` + +## Signature + +```java +public CrudResource messages() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/send.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/send.mdx new file mode 100644 index 0000000000..35a0550e15 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/send.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/messaging-namespace/send" +title: "send" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.MessagingNamespace.send" + parent: "com.signalwire.sdk.rest.namespaces.MessagingNamespace" + module: "com.signalwire.sdk.rest.namespaces.MessagingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java" + visibility: "public" +--- +# `send` + +Send a message via REST. + +## Signature + +```java +public Map send(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MessagingNamespace.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/call.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/call.mdx new file mode 100644 index 0000000000..003f4382f1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/call" +title: "call" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.MfaNamespace.call" + parent: "com.signalwire.sdk.rest.namespaces.MfaNamespace" + module: "com.signalwire.sdk.rest.namespaces.MfaNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java" + visibility: "public" +--- +# `call` + +## Signature + +```java +public Map call(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/get-base-path.mdx new file mode 100644 index 0000000000..173060c40d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.MfaNamespace.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.MfaNamespace" + module: "com.signalwire.sdk.rest.namespaces.MfaNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java) + +Line 28. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/index.mdx new file mode 100644 index 0000000000..4a3c60cf5e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace" +title: "MfaNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.MfaNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java" + visibility: "public" +--- +# `MfaNamespace` + +MFA (Multi-Factor Authentication) namespace. + +<p>Mirrors `signalwire.rest.namespaces.mfa.MfaResource`: +sms / call / verify endpoints. + +## Signature + +```java +public class MfaNamespace +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/init.mdx new file mode 100644 index 0000000000..999bcef151 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.MfaNamespace." + parent: "com.signalwire.sdk.rest.namespaces.MfaNamespace" + module: "com.signalwire.sdk.rest.namespaces.MfaNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java) + +Line 24. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/sms.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/sms.mdx new file mode 100644 index 0000000000..0dfeab4d2c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/sms.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/sms" +title: "sms" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.MfaNamespace.sms" + parent: "com.signalwire.sdk.rest.namespaces.MfaNamespace" + module: "com.signalwire.sdk.rest.namespaces.MfaNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java" + visibility: "public" +--- +# `sms` + +## Signature + +```java +public Map sms(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/verify.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/verify.mdx new file mode 100644 index 0000000000..c9662a64ce --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/verify.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/mfa-namespace/verify" +title: "verify" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.MfaNamespace.verify" + parent: "com.signalwire.sdk.rest.namespaces.MfaNamespace" + module: "com.signalwire.sdk.rest.namespaces.MfaNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java" + visibility: "public" +--- +# `verify` + +## Signature + +```java +public Map verify(String requestId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/MfaNamespace.java) + +Line 38. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/add-membership.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/add-membership.mdx new file mode 100644 index 0000000000..1c6d392339 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/add-membership.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/add-membership" +title: "addMembership" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace.addMembership" + parent: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `addMembership` + +## Signature + +```java +public Map addMembership(String groupId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 70. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/create.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/create.mdx new file mode 100644 index 0000000000..4560644014 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/create" +title: "create" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace.create" + parent: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `create` + +## Signature + +```java +public Map create(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 44. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/delete-membership.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/delete-membership.mdx new file mode 100644 index 0000000000..753aae2505 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/delete-membership.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/delete-membership" +title: "deleteMembership" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace.deleteMembership" + parent: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `deleteMembership` + +## Signature + +```java +public Map deleteMembership(String membershipId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 78. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/delete.mdx new file mode 100644 index 0000000000..07a1799055 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace.delete" + parent: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String groupId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 56. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get-base-path.mdx new file mode 100644 index 0000000000..0fe55af446 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 32. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get-membership.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get-membership.mdx new file mode 100644 index 0000000000..12f1765e9d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get-membership.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get-membership" +title: "getMembership" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace.getMembership" + parent: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `getMembership` + +## Signature + +```java +public Map getMembership(String membershipId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 74. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get.mdx new file mode 100644 index 0000000000..1e172858f3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace.get" + parent: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String groupId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 48. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/index.mdx new file mode 100644 index 0000000000..aa0dfe5aa4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace" +title: "NumberGroupsNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `NumberGroupsNamespace` + +Number Groups namespace — full CRUD on number groups + membership ops. + +<p>Mirrors +`signalwire.rest.namespaces.number_groups.NumberGroupsResource`: the +group CRUD uses PUT for update; membership get/delete operate against a +separate top-level `/api/relay/rest/number_group_memberships` +collection (not a sub-collection of the group). + +## Signature + +```java +public class NumberGroupsNamespace +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 22. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/init.mdx new file mode 100644 index 0000000000..e0da35e6bd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace." + parent: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 28. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/list-memberships.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/list-memberships.mdx new file mode 100644 index 0000000000..851ed97263 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/list-memberships.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/list-memberships" +title: "listMemberships" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace.listMemberships" + parent: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `listMemberships` + +## Signature + + + + ```java + public Map listMemberships(String groupId) + ``` + + + + ```java + public Map listMemberships( + String groupId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 62. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/list.mdx new file mode 100644 index 0000000000..b5fe7fd672 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace.list" + parent: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 36. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/update.mdx new file mode 100644 index 0000000000..4944182f5e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-groups-namespace/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace.update" + parent: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberGroupsNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String groupId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberGroupsNamespace.java) + +Line 52. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace/index.mdx new file mode 100644 index 0000000000..cfbd512e10 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace" +title: "NumberLookupNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberLookupNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberLookupNamespace.java" + visibility: "public" +--- +# `NumberLookupNamespace` + +REST namespace for number lookup (CNAM/carrier lookup) resources. + +## Signature + +```java +public class NumberLookupNamespace +``` + +## Methods + + + + + + Look up a phone number. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberLookupNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberLookupNamespace.java) + +Line 16. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace/init.mdx new file mode 100644 index 0000000000..7211d01d07 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberLookupNamespace." + parent: "com.signalwire.sdk.rest.namespaces.NumberLookupNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberLookupNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberLookupNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberLookupNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberLookupNamespace.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace/lookup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace/lookup.mdx new file mode 100644 index 0000000000..a2027a1611 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace/lookup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/number-lookup-namespace/lookup" +title: "lookup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.NumberLookupNamespace.lookup" + parent: "com.signalwire.sdk.rest.namespaces.NumberLookupNamespace" + module: "com.signalwire.sdk.rest.namespaces.NumberLookupNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberLookupNamespace.java" + visibility: "public" +--- +# `lookup` + +Look up a phone number. + +## Signature + +```java +public Map lookup(String phoneNumber) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/NumberLookupNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/NumberLookupNamespace.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/create.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/create.mdx new file mode 100644 index 0000000000..820da1dd0c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/create" +title: "create" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.create" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `create` + +Purchase a phone number. + +## Signature + +```java +public Map create(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 47. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/delete.mdx new file mode 100644 index 0000000000..bd9e7b7691 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/delete.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.delete" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `delete` + +Release a phone number. + +## Signature + +```java +public Map delete(String id) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 53. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/get-resource.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/get-resource.mdx new file mode 100644 index 0000000000..0894d7aee8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/get-resource.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/get-resource" +title: "getResource" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.getResource" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `getResource` + +Get the underlying CRUD resource. + +## Signature + +```java +public CrudResource getResource() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 61. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/get.mdx new file mode 100644 index 0000000000..b5d4604b9d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.get" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `get` + +Get a single phone number. + +## Signature + +```java +public Map get(String id) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 44. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/index.mdx new file mode 100644 index 0000000000..52537a7405 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/index.mdx @@ -0,0 +1,103 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace" +title: "PhoneNumbersNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `PhoneNumbersNamespace` + +REST namespace for phone number management. + +<p> +Supports the standard CRUD surface plus typed helpers for binding an +inbound call to a handler (SWML webhook, cXML webhook, AI agent, call +flow, RELAY application/topic). + +The binding model is: set +`call_handler` + the handler-specific companion field on the phone +number; the server auto-materializes the matching Fabric resource. +See `PhoneCallHandler` for the enum and `rest/docs/phone-binding.md` +for the full model. + +## Signature + +```java +public class PhoneNumbersNamespace +``` + +## Methods + + + + + + Purchase a phone number. + + + + Release a phone number. + + + + Get a single phone number. + + + + Get the underlying CRUD resource. + + + + List all phone numbers. + + + + Search available phone numbers. + + + + Route inbound calls to an AI Agent Fabric resource by ID. + + + + Route inbound calls to a Call Flow by ID (server default version). + + + + Route inbound calls to an existing cXML application by ID. + + + + Route inbound calls to a cXML (Twilio-compat / LAML) webhook. <p> Despite the wire value `laml_webhooks` being plural, this creates a single `cxml_webhook` Fabric resource. + + + + Route inbound calls to a named RELAY application. + + + + Route inbound calls to a RELAY topic (client subscription). + + + + Route inbound calls on this phone number to an SWML webhook URL. <p> Your backend returns an SWML document per call. + + + + Update a phone number. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/init.mdx new file mode 100644 index 0000000000..bfe12d1e52 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace." + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 32. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/list.mdx new file mode 100644 index 0000000000..1bbacb10e7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/list.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.list" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `list` + +List all phone numbers. + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 38. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/search.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/search.mdx new file mode 100644 index 0000000000..9ad4c25fcc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/search.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/search" +title: "search" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.search" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `search` + +Search available phone numbers. + +## Signature + +```java +public Map search(Map queryParams) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 56. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-ai-agent.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-ai-agent.mdx new file mode 100644 index 0000000000..ea577d3116 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-ai-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-ai-agent" +title: "setAiAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.setAiAgent" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `setAiAgent` + +Route inbound calls to an AI Agent Fabric resource by ID. + +## Signature + +```java +public Map setAiAgent(String id, String agentId) +``` + +## Parameters + + + phone number SID + + + + AI agent resource ID + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 156. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-call-flow.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-call-flow.mdx new file mode 100644 index 0000000000..af3942906b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-call-flow.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-call-flow" +title: "setCallFlow" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.setCallFlow" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `setCallFlow` + +Route inbound calls to a Call Flow by ID (server default version). + +## Signature + + + + ```java + public Map setCallFlow(String id, String flowId) + ``` + + + + ```java + public Map setCallFlow(String id, String flowId, String version) + ``` + + + +## Parameters (Overload 1) + + + phone number SID + + + + call-flow resource ID + + +## Parameters (Overload 2) + + + phone number SID + + + + call-flow resource ID + + + + `"working_copy"`, `"current_deployed"`, or `null` for the server default + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 169. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-application.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-application.mdx new file mode 100644 index 0000000000..10827ea75c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-application.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-application" +title: "setCxmlApplication" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.setCxmlApplication" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `setCxmlApplication` + +Route inbound calls to an existing cXML application by ID. + +## Signature + +```java +public Map setCxmlApplication(String id, String applicationId) +``` + +## Parameters + + + phone number SID + + + + cXML application ID + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 143. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-webhook.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-webhook.mdx new file mode 100644 index 0000000000..3f37f24db8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-webhook.mdx @@ -0,0 +1,113 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-cxml-webhook" +title: "setCxmlWebhook" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.setCxmlWebhook" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `setCxmlWebhook` + +Route inbound calls to a cXML (Twilio-compat / LAML) webhook. + +<p> +Despite the wire value `laml_webhooks` being plural, this +creates a single `cxml_webhook` Fabric resource. + +## Signature + + + + ```java + public Map setCxmlWebhook(String id, String url) + ``` + + + + ```java + public Map setCxmlWebhook( + String id, + String url, + String fallbackUrl + ) + ``` + + + + ```java + public Map setCxmlWebhook( + String id, + String url, + String fallbackUrl, + String statusCallbackUrl + ) + ``` + + + +## Parameters (Overload 1) + + + phone number SID + + + + primary cXML endpoint + + +## Parameters (Overload 2) + + + phone number SID + + + + primary cXML endpoint + + + + URL the server falls back to when the primary fails + + +## Parameters (Overload 3) + + + phone number SID + + + + primary cXML endpoint + + + + fallback URL (may be `null`) + + + + call-status callback (may be `null`) + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Returns (Overload 3) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 100. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-application.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-application.mdx new file mode 100644 index 0000000000..4b04339e94 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-application.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-application" +title: "setRelayApplication" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.setRelayApplication" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `setRelayApplication` + +Route inbound calls to a named RELAY application. + +## Signature + +```java +public Map setRelayApplication(String id, String name) +``` + +## Parameters + + + phone number SID + + + + RELAY application name + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 197. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-topic.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-topic.mdx new file mode 100644 index 0000000000..9f79fbc732 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-topic.mdx @@ -0,0 +1,76 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-relay-topic" +title: "setRelayTopic" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.setRelayTopic" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `setRelayTopic` + +Route inbound calls to a RELAY topic (client subscription). + +## Signature + + + + ```java + public Map setRelayTopic(String id, String topic) + ``` + + + + ```java + public Map setRelayTopic( + String id, + String topic, + String statusCallbackUrl + ) + ``` + + + +## Parameters (Overload 1) + + + phone number SID + + + + RELAY topic name + + +## Parameters (Overload 2) + + + phone number SID + + + + RELAY topic name + + + + call-status callback URL (may be `null`) + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 210. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-swml-webhook.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-swml-webhook.mdx new file mode 100644 index 0000000000..ffed311d00 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-swml-webhook.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/set-swml-webhook" +title: "setSwmlWebhook" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.setSwmlWebhook" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `setSwmlWebhook` + +Route inbound calls on this phone number to an SWML webhook URL. + +<p> +Your backend returns an SWML document per call. + +The server +auto-creates a `swml_webhook` Fabric resource keyed off this URL. + +## Signature + +```java +public Map setSwmlWebhook(String id, String url) +``` + +## Parameters + + + phone number SID + + + + SWML endpoint the server should fetch per call + + +## Returns + +`Map` — the updated phone number representation + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 84. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/update.mdx new file mode 100644 index 0000000000..38a82e3e49 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/phone-numbers-namespace/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace.update" + parent: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + module: "com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java" + visibility: "public" +--- +# `update` + +Update a phone number. + +## Signature + +```java +public Map update(String id, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PhoneNumbersNamespace.java) + +Line 50. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/create-token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/create-token.mdx new file mode 100644 index 0000000000..8e85a274cd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/create-token.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/create-token" +title: "createToken" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.createToken" + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + module: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `createToken` + +Create a project token (legacy single-method form). + +## Signature + +```java +public Map createToken(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 50. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/get.mdx new file mode 100644 index 0000000000..33a5745af8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/get.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.get" + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + module: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `get` + +Get project info. + +## Signature + +```java +public Map get() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 35. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/index.mdx new file mode 100644 index 0000000000..8619a67956 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace" +title: "ProjectNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `ProjectNamespace` + +REST namespace for project management resources. + +<p>Mirrors `signalwire.rest.namespaces.project.ProjectNamespace`: +exposes `ProjectTokens` for API token CRUD (PATCH for update, +DELETE for revoke). + +## Signature + +```java +public class ProjectNamespace +``` + +## Methods + + + + + + Create a project token (legacy single-method form). + + + + Get project info. + + + + List project tokens (legacy single-method form). + + + + + + Update project settings. + + + +## Classes + + + + Project API token management. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/init.mdx new file mode 100644 index 0000000000..28585403be --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace." + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + module: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/list-tokens.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/list-tokens.mdx new file mode 100644 index 0000000000..233a64bba1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/list-tokens.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/list-tokens" +title: "listTokens" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.listTokens" + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + module: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `listTokens` + +List project tokens (legacy single-method form). + +## Signature + +```java +public Map listTokens() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 45. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/create.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/create.mdx new file mode 100644 index 0000000000..bf56fe975d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/create" +title: "create" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens.create" + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens" + module: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `create` + +## Signature + +```java +public Map create(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 73. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/delete.mdx new file mode 100644 index 0000000000..ab29399b4b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens.delete" + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens" + module: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String tokenId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 81. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/get-base-path.mdx new file mode 100644 index 0000000000..6f9a292a28 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens" + module: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 71. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/index.mdx new file mode 100644 index 0000000000..fea8f1f9c6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens" +title: "ProjectTokens" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens" + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `ProjectTokens` + +Project API token management. + +Update is PATCH (matches Python's +-> http.patch); delete revokes the token. + +**Modifiers:** `static` + +## Signature + +```java +public static class ProjectTokens +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 62. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/init.mdx new file mode 100644 index 0000000000..1d8a628f4b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens." + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens" + module: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 67. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/update.mdx new file mode 100644 index 0000000000..942c79ec72 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/project-tokens/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens.update" + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens" + module: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.ProjectTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String tokenId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 77. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/tokens.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/tokens.mdx new file mode 100644 index 0000000000..f0569f0da5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/tokens" +title: "tokens" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.tokens" + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + module: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `tokens` + +## Signature + +```java +public ProjectTokens tokens() +``` + +## Returns + +`ProjectTokens` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/update.mdx new file mode 100644 index 0000000000..f81e16a385 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/project-namespace/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ProjectNamespace.update" + parent: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + module: "com.signalwire.sdk.rest.namespaces.ProjectNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java" + visibility: "public" +--- +# `update` + +Update project settings. + +## Signature + +```java +public Map update(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ProjectNamespace.java) + +Line 40. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/channels.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/channels.mdx new file mode 100644 index 0000000000..3557d69d58 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/channels.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/channels" +title: "channels" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PubSubNamespace.channels" + parent: "com.signalwire.sdk.rest.namespaces.PubSubNamespace" + module: "com.signalwire.sdk.rest.namespaces.PubSubNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java" + visibility: "public" +--- +# `channels` + +## Signature + +```java +public CrudResource channels() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/index.mdx new file mode 100644 index 0000000000..70ef9d49c1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace" +title: "PubSubNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PubSubNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java" + visibility: "public" +--- +# `PubSubNamespace` + +REST namespace for Pub/Sub resources. + +## Signature + +```java +public class PubSubNamespace +``` + +## Methods + + + + + + + + Publish a message to a channel. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java) + +Line 17. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/init.mdx new file mode 100644 index 0000000000..158bd4b4ae --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PubSubNamespace." + parent: "com.signalwire.sdk.rest.namespaces.PubSubNamespace" + module: "com.signalwire.sdk.rest.namespaces.PubSubNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java) + +Line 22. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/publish.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/publish.mdx new file mode 100644 index 0000000000..889ce1c927 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/publish.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/pub-sub-namespace/publish" +title: "publish" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.PubSubNamespace.publish" + parent: "com.signalwire.sdk.rest.namespaces.PubSubNamespace" + module: "com.signalwire.sdk.rest.namespaces.PubSubNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java" + visibility: "public" +--- +# `publish` + +Publish a message to a channel. + +## Signature + +```java +public Map publish(String channel, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/PubSubNamespace.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/create.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/create.mdx new file mode 100644 index 0000000000..c0c6576f9f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/create" +title: "create" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace.create" + parent: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + module: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" +--- +# `create` + +## Signature + +```java +public Map create(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 41. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/delete.mdx new file mode 100644 index 0000000000..02c25dcd7d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace.delete" + parent: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + module: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String queueId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 53. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-base-path.mdx new file mode 100644 index 0000000000..b77c8c5d89 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + module: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-member.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-member.mdx new file mode 100644 index 0000000000..2dce828c6d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-member.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-member" +title: "getMember" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace.getMember" + parent: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + module: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" +--- +# `getMember` + +## Signature + +```java +public Map getMember(String queueId, String memberId) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 71. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-next-member.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-next-member.mdx new file mode 100644 index 0000000000..fd16d1b882 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-next-member.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get-next-member" +title: "getNextMember" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace.getNextMember" + parent: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + module: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" +--- +# `getNextMember` + +## Signature + +```java +public Map getNextMember(String queueId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 67. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get.mdx new file mode 100644 index 0000000000..128b9b2115 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace.get" + parent: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + module: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String queueId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 45. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/index.mdx new file mode 100644 index 0000000000..318458185d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace" +title: "QueueNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" +--- +# `QueueNamespace` + +Queues namespace — full CRUD with member operations. + +<p>Mirrors `signalwire.rest.namespaces.queues.QueuesResource`: queue +CRUD uses PUT for update; members are addressable both per-id and via the +special `/next` endpoint. + +## Signature + +```java +public class QueueNamespace +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + Returns the legacy `com.signalwire.sdk.rest.CrudResource`-shaped accessor so older callers like `client.queues().queues()` keep compiling. + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/init.mdx new file mode 100644 index 0000000000..0678a09e2d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace." + parent: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + module: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/list-members.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/list-members.mdx new file mode 100644 index 0000000000..2b99ef38b5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/list-members.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/list-members" +title: "listMembers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace.listMembers" + parent: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + module: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" +--- +# `listMembers` + +## Signature + + + + ```java + public Map listMembers(String queueId) + ``` + + + + ```java + public Map listMembers( + String queueId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 59. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/list.mdx new file mode 100644 index 0000000000..75169d1a10 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace.list" + parent: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + module: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 33. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/queues.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/queues.mdx new file mode 100644 index 0000000000..dcb65f6151 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/queues.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/queues" +title: "queues" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace.queues" + parent: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + module: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" + deprecated: true +--- +# `queues` + + + **Deprecated.** direct calls on this namespace (`#list()`, `#get(String)` etc.) match Python parity. Prefer those. + + +Returns the legacy `com.signalwire.sdk.rest.CrudResource`-shaped +accessor so older callers like `client.queues().queues()` keep +compiling. + +The returned resource targets the same path as this +namespace (`/relay/rest/queues`). + +**Decorators:** `@Deprecated` + +## Signature + +```java +public com.signalwire.sdk.rest.CrudResource queues() +``` + +## Returns + +`com.signalwire.sdk.rest.CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 84. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/update.mdx new file mode 100644 index 0000000000..a5fc4fe49c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/queue-namespace/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.QueueNamespace.update" + parent: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + module: "com.signalwire.sdk.rest.namespaces.QueueNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String queueId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/QueueNamespace.java) + +Line 49. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/delete.mdx new file mode 100644 index 0000000000..e6681466ce --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RecordingNamespace.delete" + parent: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + module: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String recordingId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java) + +Line 42. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/get-base-path.mdx new file mode 100644 index 0000000000..1a84ffe57c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RecordingNamespace.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + module: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java) + +Line 28. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/get.mdx new file mode 100644 index 0000000000..933af8bf46 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RecordingNamespace.get" + parent: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + module: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String recordingId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java) + +Line 38. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/index.mdx new file mode 100644 index 0000000000..ba650ab7c3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace" +title: "RecordingNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java" + visibility: "public" +--- +# `RecordingNamespace` + +Recordings namespace — list / get / delete (no create/update). + +<p>Mirrors `signalwire.rest.namespaces.recordings.RecordingsResource`. +Path: `/api/relay/rest/recordings`. + +## Signature + +```java +public class RecordingNamespace +``` + +## Methods + + + + + + + + + + + + + + Legacy CRUD-shaped accessor for backwards compat with the previous Java surface (`client.recordings().recordings()`). + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/init.mdx new file mode 100644 index 0000000000..3ac0ba805c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RecordingNamespace." + parent: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + module: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java) + +Line 24. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/list.mdx new file mode 100644 index 0000000000..0b2562b84f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RecordingNamespace.list" + parent: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + module: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/recordings.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/recordings.mdx new file mode 100644 index 0000000000..466a66df1f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/recordings.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/recording-namespace/recordings" +title: "recordings" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RecordingNamespace.recordings" + parent: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + module: "com.signalwire.sdk.rest.namespaces.RecordingNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java" + visibility: "public" + deprecated: true +--- +# `recordings` + + + **Deprecated.** prefer the direct namespace methods which match Python. + + +Legacy CRUD-shaped accessor for backwards compat with the previous +Java surface (`client.recordings().recordings()`). + +Targets the +same path as this namespace. + +**Decorators:** `@Deprecated` + +## Signature + +```java +public com.signalwire.sdk.rest.CrudResource recordings() +``` + +## Returns + +`com.signalwire.sdk.rest.CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RecordingNamespace.java) + +Line 53. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/brands.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/brands.mdx new file mode 100644 index 0000000000..01f6fe78bb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/brands.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/brands" +title: "brands" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.brands" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `brands` + +## Signature + +```java +public RegistryBrands brands() +``` + +## Returns + +`RegistryBrands` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 35. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/campaigns.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/campaigns.mdx new file mode 100644 index 0000000000..dcc33c0d7e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/campaigns.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/campaigns" +title: "campaigns" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.campaigns" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `campaigns` + +## Signature + +```java +public RegistryCampaigns campaigns() +``` + +## Returns + +`RegistryCampaigns` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 36. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/index.mdx new file mode 100644 index 0000000000..d72b186600 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace" +title: "RegistryNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `RegistryNamespace` + +10DLC Campaign Registry namespace — brands, campaigns, orders, numbers. + +<p>Mirrors `signalwire.rest.namespaces.registry.RegistryNamespace`. +All endpoints sit under `/api/relay/rest/registry/beta`. + +## Signature + +```java +public class RegistryNamespace +``` + +## Methods + + + + + + + + + + + + + +## Classes + + + + 10DLC brand management — list / create / get plus brand-scoped campaign sub-resources. + + + + 10DLC campaign management — get / update (PUT) plus number / order sub-resources. + + + + 10DLC number-assignment management — release a number. + + + + 10DLC assignment-order management — read-only get. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/init.mdx new file mode 100644 index 0000000000..da8b933f01 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace." + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 28. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/numbers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/numbers.mdx new file mode 100644 index 0000000000..4b93b08bf9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/numbers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/numbers" +title: "numbers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.numbers" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `numbers` + +## Signature + +```java +public RegistryNumbers numbers() +``` + +## Returns + +`RegistryNumbers` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 38. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/orders.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/orders.mdx new file mode 100644 index 0000000000..56b4c11943 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/orders.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/orders" +title: "orders" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.orders" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `orders` + +## Signature + +```java +public RegistryOrders orders() +``` + +## Returns + +`RegistryOrders` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/create-campaign.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/create-campaign.mdx new file mode 100644 index 0000000000..b77ea6bd45 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/create-campaign.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/create-campaign" +title: "createCampaign" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands.createCampaign" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `createCampaign` + +## Signature + +```java +public Map createCampaign( + String brandId, + Map body +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 84. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/create.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/create.mdx new file mode 100644 index 0000000000..f043427259 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/create" +title: "create" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands.create" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `create` + +## Signature + +```java +public Map create(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 68. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/get-base-path.mdx new file mode 100644 index 0000000000..fad8172170 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 58. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/get.mdx new file mode 100644 index 0000000000..840d695d79 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands.get" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String brandId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 72. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/index.mdx new file mode 100644 index 0000000000..f3c7dfc56b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands" +title: "RegistryBrands" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `RegistryBrands` + +10DLC brand management — list / create / get plus brand-scoped +campaign sub-resources. + +**Modifiers:** `static` + +## Signature + +```java +public static class RegistryBrands +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 48. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/init.mdx new file mode 100644 index 0000000000..1db589353c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands." + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 53. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/list-campaigns.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/list-campaigns.mdx new file mode 100644 index 0000000000..5d44483224 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/list-campaigns.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/list-campaigns" +title: "listCampaigns" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands.listCampaigns" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `listCampaigns` + +## Signature + + + + ```java + public Map listCampaigns(String brandId) + ``` + + + + ```java + public Map listCampaigns( + String brandId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 76. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/list.mdx new file mode 100644 index 0000000000..90d0c9c2c0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-brands/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands.list" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 60. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/create-order.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/create-order.mdx new file mode 100644 index 0000000000..790d1ca222 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/create-order.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/create-order" +title: "createOrder" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns.createOrder" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `createOrder` + +## Signature + +```java +public Map createOrder( + String campaignId, + Map body +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 129. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/get-base-path.mdx new file mode 100644 index 0000000000..5edcf4b0ac --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 103. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/get.mdx new file mode 100644 index 0000000000..3b4b7347b6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns.get" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String campaignId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 105. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/index.mdx new file mode 100644 index 0000000000..ac77b90f4e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns" +title: "RegistryCampaigns" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `RegistryCampaigns` + +10DLC campaign management — get / update (PUT) plus number / order +sub-resources. + +**Modifiers:** `static` + +## Signature + +```java +public static class RegistryCampaigns +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 93. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/init.mdx new file mode 100644 index 0000000000..ca5ace768a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns." + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 98. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/list-numbers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/list-numbers.mdx new file mode 100644 index 0000000000..88b72a0337 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/list-numbers.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/list-numbers" +title: "listNumbers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns.listNumbers" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `listNumbers` + +## Signature + + + + ```java + public Map listNumbers(String campaignId) + ``` + + + + ```java + public Map listNumbers( + String campaignId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 113. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/list-orders.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/list-orders.mdx new file mode 100644 index 0000000000..2be9e665da --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/list-orders.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/list-orders" +title: "listOrders" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns.listOrders" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `listOrders` + +## Signature + + + + ```java + public Map listOrders(String campaignId) + ``` + + + + ```java + public Map listOrders( + String campaignId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 121. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/update.mdx new file mode 100644 index 0000000000..1aec0d0554 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-campaigns/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns.update" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String campaignId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 109. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/delete.mdx new file mode 100644 index 0000000000..e6c72ae8cb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryNumbers.delete" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryNumbers" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String numberId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 169. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/get-base-path.mdx new file mode 100644 index 0000000000..c7380dae2f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryNumbers.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryNumbers" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 167. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/index.mdx new file mode 100644 index 0000000000..efa3610f7a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers" +title: "RegistryNumbers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryNumbers" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `RegistryNumbers` + +10DLC number-assignment management — release a number. + +**Modifiers:** `static` + +## Signature + +```java +public static class RegistryNumbers +``` + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 157. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/init.mdx new file mode 100644 index 0000000000..5e63558f21 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-numbers/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryNumbers." + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryNumbers" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryNumbers" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 162. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/get-base-path.mdx new file mode 100644 index 0000000000..f29dc04834 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryOrders.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryOrders" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryOrders" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 147. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/get.mdx new file mode 100644 index 0000000000..401a0f13c5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryOrders.get" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryOrders" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryOrders" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String orderId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 149. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/index.mdx new file mode 100644 index 0000000000..558128823f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders" +title: "RegistryOrders" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryOrders" + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `RegistryOrders` + +10DLC assignment-order management — read-only get. + +**Modifiers:** `static` + +## Signature + +```java +public static class RegistryOrders +``` + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 137. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/init.mdx new file mode 100644 index 0000000000..70716c572d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/registry-namespace/registry-orders/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryOrders." + parent: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryOrders" + module: "com.signalwire.sdk.rest.namespaces.RegistryNamespace.RegistryOrders" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/RegistryNamespace.java) + +Line 142. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/get-base-path.mdx new file mode 100644 index 0000000000..27c9c7aec7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace" + module: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/get.mdx new file mode 100644 index 0000000000..900ac84fce --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace.get" + parent: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace" + module: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String shortCodeId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/index.mdx new file mode 100644 index 0000000000..0d833547fa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace" +title: "ShortCodesNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java" + visibility: "public" +--- +# `ShortCodesNamespace` + +Short Codes namespace — list / get / update (PUT). + +No create/delete. + +<p>Mirrors `signalwire.rest.namespaces.short_codes.ShortCodesResource`. + +## Signature + +```java +public class ShortCodesNamespace +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java) + +Line 18. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/init.mdx new file mode 100644 index 0000000000..8a85b7dd92 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace." + parent: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace" + module: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/list.mdx new file mode 100644 index 0000000000..984e110713 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace.list" + parent: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace" + module: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/update.mdx new file mode 100644 index 0000000000..ab785b1a2d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/short-codes-namespace/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace.update" + parent: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace" + module: "com.signalwire.sdk.rest.namespaces.ShortCodesNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String shortCodeId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/ShortCodesNamespace.java) + +Line 41. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/endpoints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/endpoints.mdx new file mode 100644 index 0000000000..e14eefbfde --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/endpoints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/endpoints" +title: "endpoints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SipNamespace.endpoints" + parent: "com.signalwire.sdk.rest.namespaces.SipNamespace" + module: "com.signalwire.sdk.rest.namespaces.SipNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java" + visibility: "public" +--- +# `endpoints` + +## Signature + +```java +public CrudResource endpoints() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/index.mdx new file mode 100644 index 0000000000..b09941138f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace" +title: "SipNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SipNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java" + visibility: "public" +--- +# `SipNamespace` + +REST namespace for SIP resources. + +## Signature + +```java +public class SipNamespace +``` + +## Methods + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/init.mdx new file mode 100644 index 0000000000..fe01076e7a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SipNamespace." + parent: "com.signalwire.sdk.rest.namespaces.SipNamespace" + module: "com.signalwire.sdk.rest.namespaces.SipNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/profiles.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/profiles.mdx new file mode 100644 index 0000000000..99ef9dcda4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/profiles.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-namespace/profiles" +title: "profiles" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SipNamespace.profiles" + parent: "com.signalwire.sdk.rest.namespaces.SipNamespace" + module: "com.signalwire.sdk.rest.namespaces.SipNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java" + visibility: "public" +--- +# `profiles` + +## Signature + +```java +public CrudResource profiles() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipNamespace.java) + +Line 26. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/get-base-path.mdx new file mode 100644 index 0000000000..1001b66128 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace" + module: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java) + +Line 28. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/get.mdx new file mode 100644 index 0000000000..2d1c856249 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace.get" + parent: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace" + module: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/index.mdx new file mode 100644 index 0000000000..36d38b3385 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace" +title: "SipProfileNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java" + visibility: "public" +--- +# `SipProfileNamespace` + +SIP Profile namespace — get / update (PUT) the project's singleton SIP +profile. + +<p>Mirrors `signalwire.rest.namespaces.sip_profile.SipProfileResource`. + +## Signature + +```java +public class SipProfileNamespace +``` + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/init.mdx new file mode 100644 index 0000000000..4aca06263e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace." + parent: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace" + module: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java) + +Line 24. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/update.mdx new file mode 100644 index 0000000000..bcd5c4088e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/update.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/sip-profile-namespace/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace.update" + parent: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace" + module: "com.signalwire.sdk.rest.namespaces.SipProfileNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SipProfileNamespace.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace/index.mdx new file mode 100644 index 0000000000..efbeb791d8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace" +title: "StreamNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.StreamNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/StreamNamespace.java" + visibility: "public" +--- +# `StreamNamespace` + +REST namespace for audio stream resources. + +## Signature + +```java +public class StreamNamespace +``` + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/StreamNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/StreamNamespace.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace/init.mdx new file mode 100644 index 0000000000..ff429fc0f7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.StreamNamespace." + parent: "com.signalwire.sdk.rest.namespaces.StreamNamespace" + module: "com.signalwire.sdk.rest.namespaces.StreamNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/StreamNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/StreamNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/StreamNamespace.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace/streams.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace/streams.mdx new file mode 100644 index 0000000000..ee92920d28 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace/streams.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/stream-namespace/streams" +title: "streams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.StreamNamespace.streams" + parent: "com.signalwire.sdk.rest.namespaces.StreamNamespace" + module: "com.signalwire.sdk.rest.namespaces.StreamNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/StreamNamespace.java" + visibility: "public" +--- +# `streams` + +## Signature + +```java +public CrudResource streams() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/StreamNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/StreamNamespace.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace/index.mdx new file mode 100644 index 0000000000..37c11f2ce9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace" +title: "SwmlNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SwmlNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SwmlNamespace.java" + visibility: "public" +--- +# `SwmlNamespace` + +REST namespace for SWML script resources. + +## Signature + +```java +public class SwmlNamespace +``` + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SwmlNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SwmlNamespace.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace/init.mdx new file mode 100644 index 0000000000..b9f054f963 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SwmlNamespace." + parent: "com.signalwire.sdk.rest.namespaces.SwmlNamespace" + module: "com.signalwire.sdk.rest.namespaces.SwmlNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SwmlNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SwmlNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SwmlNamespace.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace/scripts.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace/scripts.mdx new file mode 100644 index 0000000000..f20963a619 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace/scripts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/swml-namespace/scripts" +title: "scripts" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.SwmlNamespace.scripts" + parent: "com.signalwire.sdk.rest.namespaces.SwmlNamespace" + module: "com.signalwire.sdk.rest.namespaces.SwmlNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SwmlNamespace.java" + visibility: "public" +--- +# `scripts` + +## Signature + +```java +public CrudResource scripts() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/SwmlNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/SwmlNamespace.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace/index.mdx new file mode 100644 index 0000000000..e733adcd59 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace" +title: "TranscriptionNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.TranscriptionNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/TranscriptionNamespace.java" + visibility: "public" +--- +# `TranscriptionNamespace` + +REST namespace for transcription resources. + +## Signature + +```java +public class TranscriptionNamespace +``` + +## Methods + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/TranscriptionNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/TranscriptionNamespace.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace/init.mdx new file mode 100644 index 0000000000..9d43382f18 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.TranscriptionNamespace." + parent: "com.signalwire.sdk.rest.namespaces.TranscriptionNamespace" + module: "com.signalwire.sdk.rest.namespaces.TranscriptionNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/TranscriptionNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/TranscriptionNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/TranscriptionNamespace.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace/transcriptions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace/transcriptions.mdx new file mode 100644 index 0000000000..250c7669a7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace/transcriptions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/transcription-namespace/transcriptions" +title: "transcriptions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.TranscriptionNamespace.transcriptions" + parent: "com.signalwire.sdk.rest.namespaces.TranscriptionNamespace" + module: "com.signalwire.sdk.rest.namespaces.TranscriptionNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/TranscriptionNamespace.java" + visibility: "public" +--- +# `transcriptions` + +## Signature + +```java +public CrudResource transcriptions() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/TranscriptionNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/TranscriptionNamespace.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/conference-tokens.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/conference-tokens.mdx new file mode 100644 index 0000000000..77895c6766 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/conference-tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/conference-tokens" +title: "conferenceTokens" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.conferenceTokens" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `conferenceTokens` + +## Signature + +```java +public VideoConferenceTokens conferenceTokens() +``` + +## Returns + +`VideoConferenceTokens` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 49. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/conferences.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/conferences.mdx new file mode 100644 index 0000000000..3be3bae522 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/conferences.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/conferences" +title: "conferences" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.conferences" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `conferences` + +## Signature + +```java +public VideoConferences conferences() +``` + +## Returns + +`VideoConferences` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 48. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/index.mdx new file mode 100644 index 0000000000..85b5ca04b8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/index.mdx @@ -0,0 +1,90 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace" +title: "VideoNamespace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + parent: "com.signalwire.sdk.rest.namespaces" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `VideoNamespace` + +REST namespace for the Video API: rooms, room sessions/recordings, +conferences, conference tokens, and individual streams. + +<p>Mirrors `signalwire.rest.namespaces.video.VideoNamespace`. + +The +stream sub-resources hang off rooms and conferences; the top-level +`streams` resource exists for CRUD on individual streams keyed by +stream id. + +## Signature + +```java +public class VideoNamespace +``` + +## Methods + + + + + + + + + + Legacy alias for `#roomRecordings()`; previous releases of the Java port exposed video.recordings(). + + + + + + + + + + + + + +## Classes + + + + Video conferences with token + stream sub-collections. + + + + Video conference tokens (top-level): get + reset. + + + + Top-level video room recordings collection: list, get, delete, plus a per-recording events sub-collection. + + + + Video room management with stream sub-resources. + + + + Video room sessions: list, get, plus events / members / recordings sub-collections. + + + + Top-level streams resource (per stream id): get / update (PUT) / delete. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/init.mdx new file mode 100644 index 0000000000..7a00cff50a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace." + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 33. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/recordings.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/recordings.mdx new file mode 100644 index 0000000000..88ea12561a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/recordings.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/recordings" +title: "recordings" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.recordings" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `recordings` + +Legacy alias for `#roomRecordings()`; previous releases of the +Java port exposed video.recordings(). + +Kept for backwards compatibility. + +## Signature + +```java +public VideoRoomRecordings recordings() +``` + +## Returns + +`VideoRoomRecordings` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 56. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-recordings.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-recordings.mdx new file mode 100644 index 0000000000..86bb07456d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-recordings.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-recordings" +title: "roomRecordings" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.roomRecordings" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `roomRecordings` + +## Signature + +```java +public VideoRoomRecordings roomRecordings() +``` + +## Returns + +`VideoRoomRecordings` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 47. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-sessions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-sessions.mdx new file mode 100644 index 0000000000..9cf68749ec --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-sessions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-sessions" +title: "roomSessions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.roomSessions" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `roomSessions` + +## Signature + +```java +public VideoRoomSessions roomSessions() +``` + +## Returns + +`VideoRoomSessions` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 46. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-tokens.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-tokens.mdx new file mode 100644 index 0000000000..e044f90b50 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/room-tokens" +title: "roomTokens" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.roomTokens" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `roomTokens` + +## Signature + +```java +public CrudResource roomTokens() +``` + +## Returns + +`CrudResource` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 45. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/rooms.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/rooms.mdx new file mode 100644 index 0000000000..112c67b17d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/rooms.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/rooms" +title: "rooms" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.rooms" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `rooms` + +## Signature + +```java +public VideoRooms rooms() +``` + +## Returns + +`VideoRooms` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 44. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/streams.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/streams.mdx new file mode 100644 index 0000000000..9516abb254 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/streams.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/streams" +title: "streams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.streams" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `streams` + +## Signature + +```java +public VideoStreams streams() +``` + +## Returns + +`VideoStreams` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 50. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/get-base-path.mdx new file mode 100644 index 0000000000..37b82957e2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 236. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/get.mdx new file mode 100644 index 0000000000..e059332fb0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens.get" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String tokenId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 238. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/index.mdx new file mode 100644 index 0000000000..e4a0a64eef --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens" +title: "VideoConferenceTokens" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `VideoConferenceTokens` + +Video conference tokens (top-level): get + reset. + +**Modifiers:** `static` + +## Signature + +```java +public static class VideoConferenceTokens +``` + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 226. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/init.mdx new file mode 100644 index 0000000000..5f766023ec --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens." + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 231. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/reset.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/reset.mdx new file mode 100644 index 0000000000..c139b7809a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/reset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conference-tokens/reset" +title: "reset" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens.reset" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferenceTokens" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `reset` + +## Signature + +```java +public Map reset(String tokenId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 242. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/create-stream.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/create-stream.mdx new file mode 100644 index 0000000000..658fb2ff82 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/create-stream.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/create-stream" +title: "createStream" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences.createStream" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `createStream` + +## Signature + +```java +public Map createStream( + String conferenceId, + Map body +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 218. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/index.mdx new file mode 100644 index 0000000000..a99a1ab248 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences" +title: "VideoConferences" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `VideoConferences` + +Video conferences with token + stream sub-collections. + +Update uses PUT. + +**Modifiers:** `static` + +## Signature + +```java +public static class VideoConferences extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 186. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/init.mdx new file mode 100644 index 0000000000..22e385a2f2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences." + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 188. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/list-conference-tokens.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/list-conference-tokens.mdx new file mode 100644 index 0000000000..b28051da94 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/list-conference-tokens.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/list-conference-tokens" +title: "listConferenceTokens" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences.listConferenceTokens" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `listConferenceTokens` + +## Signature + + + + ```java + public Map listConferenceTokens(String conferenceId) + ``` + + + + ```java + public Map listConferenceTokens( + String conferenceId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 197. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/list-streams.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/list-streams.mdx new file mode 100644 index 0000000000..51b466c6b4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/list-streams.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/list-streams" +title: "listStreams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences.listStreams" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `listStreams` + +## Signature + + + + ```java + public Map listStreams(String conferenceId) + ``` + + + + ```java + public Map listStreams( + String conferenceId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 208. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/update.mdx new file mode 100644 index 0000000000..d94f9fe321 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-conferences/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences.update" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoConferences" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `update` + +**Decorators:** `@Override` + +## Signature + +```java +public Map update(String conferenceId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 192. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/delete.mdx new file mode 100644 index 0000000000..86f7334d25 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings.delete" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String recordingId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 170. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/get-base-path.mdx new file mode 100644 index 0000000000..43b470bcd6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 156. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/get.mdx new file mode 100644 index 0000000000..2297d9caae --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings.get" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String recordingId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 166. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/index.mdx new file mode 100644 index 0000000000..ad00ba4486 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings" +title: "VideoRoomRecordings" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `VideoRoomRecordings` + +Top-level video room recordings collection: list, get, delete, plus +a per-recording events sub-collection. + +**Modifiers:** `static` + +## Signature + +```java +public static class VideoRoomRecordings +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 146. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/init.mdx new file mode 100644 index 0000000000..98821351a6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings." + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 151. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/list-events.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/list-events.mdx new file mode 100644 index 0000000000..3c17229ea4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/list-events.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/list-events" +title: "listEvents" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings.listEvents" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `listEvents` + +## Signature + + + + ```java + public Map listEvents(String recordingId) + ``` + + + + ```java + public Map listEvents( + String recordingId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 174. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/list.mdx new file mode 100644 index 0000000000..0ae6799b90 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-recordings/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings.list" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomRecordings" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 158. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/get-base-path.mdx new file mode 100644 index 0000000000..5ab414fb72 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 103. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/get.mdx new file mode 100644 index 0000000000..0331c910c4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions.get" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String sessionId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 113. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/index.mdx new file mode 100644 index 0000000000..865f805527 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions" +title: "VideoRoomSessions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `VideoRoomSessions` + +Video room sessions: list, get, plus events / members / recordings +sub-collections. + +**Modifiers:** `static` + +## Signature + +```java +public static class VideoRoomSessions +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 93. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/init.mdx new file mode 100644 index 0000000000..4df4e9de4c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions." + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 98. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-events.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-events.mdx new file mode 100644 index 0000000000..6a329ec96d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-events.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-events" +title: "listEvents" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions.listEvents" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `listEvents` + +## Signature + + + + ```java + public Map listEvents(String sessionId) + ``` + + + + ```java + public Map listEvents( + String sessionId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 117. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-members.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-members.mdx new file mode 100644 index 0000000000..e047d2c1c1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-members.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-members" +title: "listMembers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions.listMembers" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `listMembers` + +## Signature + + + + ```java + public Map listMembers(String sessionId) + ``` + + + + ```java + public Map listMembers( + String sessionId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 125. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-recordings.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-recordings.mdx new file mode 100644 index 0000000000..a2e90022ea --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-recordings.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list-recordings" +title: "listRecordings" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions.listRecordings" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `listRecordings` + +## Signature + + + + ```java + public Map listRecordings(String sessionId) + ``` + + + + ```java + public Map listRecordings( + String sessionId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 133. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list.mdx new file mode 100644 index 0000000000..9aec20542b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-room-sessions/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions.list" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `list` + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 105. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/create-stream.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/create-stream.mdx new file mode 100644 index 0000000000..d7448f93c0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/create-stream.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/create-stream" +title: "createStream" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms.createStream" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `createStream` + +## Signature + +```java +public Map createStream(String roomId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 84. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/index.mdx new file mode 100644 index 0000000000..470002e73e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms" +title: "VideoRooms" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `VideoRooms` + +Video room management with stream sub-resources. + +Update uses PUT. + +**Modifiers:** `static` + +## Signature + +```java +public static class VideoRooms extends CrudResource +``` + +## Inheritance + +**Extends:** [CrudResource](/reference/java/com/signalwire/sdk/rest/rest/crud-resource) + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 65. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/init.mdx new file mode 100644 index 0000000000..c98f897569 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms." + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 67. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/list-streams.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/list-streams.mdx new file mode 100644 index 0000000000..265a67623c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/list-streams.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/list-streams" +title: "listStreams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms.listStreams" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `listStreams` + +## Signature + + + + ```java + public Map listStreams(String roomId) + ``` + + + + ```java + public Map listStreams( + String roomId, + Map queryParams + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 76. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/update.mdx new file mode 100644 index 0000000000..990c631da6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-rooms/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms.update" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoRooms" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `update` + +**Decorators:** `@Override` + +## Signature + +```java +public Map update(String roomId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 71. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/delete.mdx new file mode 100644 index 0000000000..858b65bc7d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams.delete" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `delete` + +## Signature + +```java +public Map delete(String streamId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 270. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/get-base-path.mdx new file mode 100644 index 0000000000..0051743468 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams.getBasePath" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 260. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/get.mdx new file mode 100644 index 0000000000..ed4c13ec46 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams.get" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `get` + +## Signature + +```java +public Map get(String streamId) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 262. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/index.mdx new file mode 100644 index 0000000000..b2781c44f6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams" +title: "VideoStreams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace" + module: "com.signalwire.sdk.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `VideoStreams` + +Top-level streams resource (per stream id): get / update (PUT) / delete. + +**Modifiers:** `static` + +## Signature + +```java +public static class VideoStreams +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 250. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/init.mdx new file mode 100644 index 0000000000..f817d23c48 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/init.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams." + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 255. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/update.mdx new file mode 100644 index 0000000000..fd4a3e4008 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/namespaces/namespaces/video-namespace/video-streams/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams.update" + parent: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams" + module: "com.signalwire.sdk.rest.namespaces.VideoNamespace.VideoStreams" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java" + visibility: "public" +--- +# `update` + +## Signature + +```java +public Map update(String streamId, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/namespaces/VideoNamespace.java) + +Line 266. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/create.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/create.mdx new file mode 100644 index 0000000000..ca371ff025 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/crud-resource/create" +title: "create" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.CrudResource.create" + parent: "com.signalwire.sdk.rest.CrudResource" + module: "com.signalwire.sdk.rest.CrudResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java" + visibility: "public" +--- +# `create` + +Create a new resource. + +## Signature + +```java +public Map create(Map body) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/CrudResource.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java) + +Line 64. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/delete.mdx new file mode 100644 index 0000000000..85c4fc722a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/delete.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/crud-resource/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.CrudResource.delete" + parent: "com.signalwire.sdk.rest.CrudResource" + module: "com.signalwire.sdk.rest.CrudResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java" + visibility: "public" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```java +public Map delete(String id) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/CrudResource.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java) + +Line 78. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/get-base-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/get-base-path.mdx new file mode 100644 index 0000000000..b5d037cfc7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/get-base-path.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/crud-resource/get-base-path" +title: "getBasePath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.CrudResource.getBasePath" + parent: "com.signalwire.sdk.rest.CrudResource" + module: "com.signalwire.sdk.rest.CrudResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java" + visibility: "public" +--- +# `getBasePath` + +Get the base path for this resource. + +## Signature + +```java +public String getBasePath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/CrudResource.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java) + +Line 85. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/get-http-client.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/get-http-client.mdx new file mode 100644 index 0000000000..49cac29eeb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/get-http-client.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/crud-resource/get-http-client" +title: "getHttpClient" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.CrudResource.getHttpClient" + parent: "com.signalwire.sdk.rest.CrudResource" + module: "com.signalwire.sdk.rest.CrudResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java" + visibility: "public" +--- +# `getHttpClient` + +Get the underlying HTTP client. + +## Signature + +```java +public HttpClient getHttpClient() +``` + +## Returns + +`HttpClient` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/CrudResource.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java) + +Line 92. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/get.mdx new file mode 100644 index 0000000000..eff4c6b3ae --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/crud-resource/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.CrudResource.get" + parent: "com.signalwire.sdk.rest.CrudResource" + module: "com.signalwire.sdk.rest.CrudResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java" + visibility: "public" +--- +# `get` + +Get a single resource by ID. + +## Signature + +```java +public Map get(String id) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/CrudResource.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java) + +Line 57. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/index.mdx new file mode 100644 index 0000000000..ef2cd5c603 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/crud-resource" +title: "CrudResource" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.CrudResource" + parent: "com.signalwire.sdk.rest" + module: "com.signalwire.sdk.rest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java" + visibility: "public" +--- +# `CrudResource` + +Generic CRUD resource for REST API namespaces. + +<p> +Provides standard list, get, create, update, and delete operations +against a base path. + +Used by namespace classes to avoid repetitive +HTTP boilerplate. + +<pre>numbers = new CrudResource(httpClient, "/phone_numbers"); +var all = numbers.list(); +var one = numbers.get("pn-abc-123");</pre> + +## Signature + +```java +public class CrudResource +``` + +## Methods + + + + Create a CRUD resource. + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Get a single resource by ID. + + + + Get the base path for this resource. + + + + Get the underlying HTTP client. + + + + List all resources. + + + + Update an existing resource by ID. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/CrudResource.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java) + +Line 24. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/init.mdx new file mode 100644 index 0000000000..ce5cedc9ba --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/init.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/crud-resource/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.CrudResource." + parent: "com.signalwire.sdk.rest.CrudResource" + module: "com.signalwire.sdk.rest.CrudResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java" + visibility: "public" +--- +# `` + +Create a CRUD resource. + +## Signature + +```java +public (HttpClient httpClient, String basePath) +``` + +## Parameters + + + the HTTP client + + + + base path for this resource (e.g., "/phone\_numbers") + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/CrudResource.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java) + +Line 35. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/list.mdx new file mode 100644 index 0000000000..782ce9d256 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/list.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/crud-resource/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.CrudResource.list" + parent: "com.signalwire.sdk.rest.CrudResource" + module: "com.signalwire.sdk.rest.CrudResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java" + visibility: "public" +--- +# `list` + +List all resources. + +## Signature + + + + ```java + public Map list() + ``` + + + + ```java + public Map list(Map queryParams) + ``` + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/CrudResource.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java) + +Line 43. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/update.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/update.mdx new file mode 100644 index 0000000000..92da16e68c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/crud-resource/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/crud-resource/update" +title: "update" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.CrudResource.update" + parent: "com.signalwire.sdk.rest.CrudResource" + module: "com.signalwire.sdk.rest.CrudResource" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java" + visibility: "public" +--- +# `update` + +Update an existing resource by ID. + +## Signature + +```java +public Map update(String id, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/CrudResource.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/CrudResource.java) + +Line 71. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/delete.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/delete.mdx new file mode 100644 index 0000000000..4d7f9e643d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/delete.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/http-client/delete" +title: "delete" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.HttpClient.delete" + parent: "com.signalwire.sdk.rest.HttpClient" + module: "com.signalwire.sdk.rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java" + visibility: "public" +--- +# `delete` + +DELETE request. + +## Signature + +```java +public Map delete(String path) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/HttpClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java) + +Line 144. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/get-base-url.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/get-base-url.mdx new file mode 100644 index 0000000000..31e12748d6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/get-base-url.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/http-client/get-base-url" +title: "getBaseUrl" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.HttpClient.getBaseUrl" + parent: "com.signalwire.sdk.rest.HttpClient" + module: "com.signalwire.sdk.rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java" + visibility: "public" +--- +# `getBaseUrl` + +Get the base URL. + +## Signature + +```java +public String getBaseUrl() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/HttpClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java) + +Line 155. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/get.mdx new file mode 100644 index 0000000000..8e0972c578 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/get.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/http-client/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.HttpClient.get" + parent: "com.signalwire.sdk.rest.HttpClient" + module: "com.signalwire.sdk.rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java" + visibility: "public" +--- +# `get` + +GET request, returns parsed JSON as a Map. + +## Signature + + + + ```java + public Map get(String path) + ``` + + + + ```java + public Map get(String path, Map queryParams) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`Map` + +## Returns (Overload 2) + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/HttpClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java) + +Line 86. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/index.mdx new file mode 100644 index 0000000000..e5e619d0e8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/http-client" +title: "HttpClient" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.HttpClient" + parent: "com.signalwire.sdk.rest" + module: "com.signalwire.sdk.rest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java" + visibility: "public" +--- +# `HttpClient` + +HTTP client for the SignalWire REST API. + +<p> +Uses `java.net.http.HttpClient` (JDK 11+ built-in) with Basic Auth +and JSON content types. + +Provides low-level GET, POST, PUT, DELETE methods +used by `CrudResource` and namespace classes. + +## Signature + +```java +public class HttpClient +``` + +## Methods + + + + Create an HTTP client. + + + + DELETE request. + + + + GET request, returns parsed JSON as a Map. + + + + Get the base URL. + + + + PATCH request with JSON body. + + + + POST request with JSON body. + + + + PUT request with JSON body. + + + + Create an HTTP client with an explicit base URL (e.g., plain HTTP for local integration tests, or to point a `RestClient` at an audit fixture). + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/HttpClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/init.mdx new file mode 100644 index 0000000000..7d9818fdee --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/init.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/http-client/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.HttpClient." + parent: "com.signalwire.sdk.rest.HttpClient" + module: "com.signalwire.sdk.rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java" + visibility: "public" +--- +# `` + +Create an HTTP client. + +## Signature + + + + ```java + public (String space, String project, String token) + ``` + + + + ```java + private (String baseUrl, String project, String token, Void marker) + ``` + + + +## Parameters (Overload 1) + + + SignalWire space (e.g., "example.signalwire.com") + + + + project ID used as Basic Auth username + + + + API token used as Basic Auth password + + +## Parameters (Overload 2) + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/HttpClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java) + +Line 46. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/patch.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/patch.mdx new file mode 100644 index 0000000000..c1906df902 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/patch.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/http-client/patch" +title: "patch" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.HttpClient.patch" + parent: "com.signalwire.sdk.rest.HttpClient" + module: "com.signalwire.sdk.rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java" + visibility: "public" +--- +# `patch` + +PATCH request with JSON body. + +java.net.http.HttpRequest doesn't have a +dedicated builder for PATCH, so use ...). + +## Signature + +```java +public Map patch(String path, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/HttpClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java) + +Line 131. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/post.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/post.mdx new file mode 100644 index 0000000000..98a6ee5239 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/post.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/http-client/post" +title: "post" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.HttpClient.post" + parent: "com.signalwire.sdk.rest.HttpClient" + module: "com.signalwire.sdk.rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java" + visibility: "public" +--- +# `post` + +POST request with JSON body. + +## Signature + +```java +public Map post(String path, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/HttpClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java) + +Line 104. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/put.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/put.mdx new file mode 100644 index 0000000000..e799582c8d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/put.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/http-client/put" +title: "put" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.HttpClient.put" + parent: "com.signalwire.sdk.rest.HttpClient" + module: "com.signalwire.sdk.rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java" + visibility: "public" +--- +# `put` + +PUT request with JSON body. + +## Signature + +```java +public Map put(String path, Map body) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/HttpClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java) + +Line 117. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/with-base-url.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/with-base-url.mdx new file mode 100644 index 0000000000..505db3320e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/http-client/with-base-url.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/http-client/with-base-url" +title: "withBaseUrl" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.HttpClient.withBaseUrl" + parent: "com.signalwire.sdk.rest.HttpClient" + module: "com.signalwire.sdk.rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java" + visibility: "public" +--- +# `withBaseUrl` + +Create an HTTP client with an explicit base URL (e.g., plain HTTP for +local integration tests, or to point a `RestClient` at an audit +fixture). + +Production callers use the project, token) +constructor instead. + +**Modifiers:** `static` + +## Signature + +```java +public static HttpClient withBaseUrl( + String baseUrl, + String project, + String token +) +``` + +## Parameters + + + fully qualified base URL ending in `/api` + + + + project ID used as Basic Auth username + + + + API token used as Basic Auth password + + +## Returns + +`HttpClient` — a configured HTTP client + +## Source + +[`src/main/java/com/signalwire/sdk/rest/HttpClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/HttpClient.java) + +Line 67. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/index.mdx new file mode 100644 index 0000000000..4519a8561b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest" +title: "rest" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.rest" + module: "com.signalwire.sdk.rest" +--- +# `rest` + +## Signature + +```java +package com.signalwire.sdk.rest +``` + +## Classes + + + + Generic CRUD resource for REST API namespaces. <p> Provides standard list, get, create, update, and delete operations against a base path. + + + + HTTP client for the SignalWire REST API. <p> Uses `java.net.http.HttpClient` (JDK 11+ built-in) with Basic Auth and JSON content types. + + + + Iterator that walks paged REST responses by following the `links.next` cursor. <p>Mirrors `signalwire.rest._pagination.PaginatedIterator`: the constructor records the `http` client, path, query params, and the data-list key without performing an HTTP fetch. + + + + SignalWire REST API client with all 21 namespaces. <p> Uses `java.net.http.HttpClient` with Basic Auth. + + + + Exception for SignalWire REST API errors. <p> Contains the HTTP status code and error message from the server. + + + +## Enums + + + + Values accepted for `call_handler` on java.util.Map) phoneNumbers().update. <p> Named `PhoneCallHandler` (not `CallHandler`) to avoid colliding with the RELAY client's inbound-call-handler callback type. <p> Setting a phone number's `call_handler` + the handler-specific companion field routes inbound calls and auto-materializes the matching Fabric resource on the server. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/has-next.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/has-next.mdx new file mode 100644 index 0000000000..15f08a9aa7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/has-next.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/has-next" +title: "hasNext" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.PaginatedIterator.hasNext" + parent: "com.signalwire.sdk.rest.PaginatedIterator" + module: "com.signalwire.sdk.rest.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java" + visibility: "public" +--- +# `hasNext` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean hasNext() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java) + +Line 67. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/index.mdx new file mode 100644 index 0000000000..2ffa78a653 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/paginated-iterator" +title: "PaginatedIterator" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.PaginatedIterator" + parent: "com.signalwire.sdk.rest" + module: "com.signalwire.sdk.rest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java" + visibility: "public" +--- +# `PaginatedIterator` + +Iterator that walks paged REST responses by following the +`links.next` cursor. + +<p>Mirrors `signalwire.rest._pagination.PaginatedIterator`: the +constructor records the `http` client, path, query params, and the +data-list key without performing an HTTP fetch. + +Each call to +`#next()` returns the next item from the buffered page; when the +buffer is exhausted the iterator follows `links.next`, parses the +URL query into the next request's params, and fetches the next page. + +<p>Iteration terminates when the buffer is empty and a fetched response +either lacks a `links.next` cursor or returns an empty data list. + +**Modifiers:** `final` + +## Signature + +```java +public final class PaginatedIterator implements Iterator>, Iterable> +``` + +## Inheritance + +**Implements:** `Iterator>`, `Iterable>` + +## Methods + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/init.mdx new file mode 100644 index 0000000000..7d29d83ece --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/init.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.PaginatedIterator." + parent: "com.signalwire.sdk.rest.PaginatedIterator" + module: "com.signalwire.sdk.rest.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public (HttpClient http, String path) + ``` + + + + ```java + public (HttpClient http, String path, Map params) + ``` + + + + ```java + public ( + HttpClient http, + String path, + Map params, + String dataKey + ) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + + + + + +## Parameters (Overload 3) + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java) + +Line 46. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/iterator.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/iterator.mdx new file mode 100644 index 0000000000..a848006520 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/iterator.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/iterator" +title: "iterator" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.PaginatedIterator.iterator" + parent: "com.signalwire.sdk.rest.PaginatedIterator" + module: "com.signalwire.sdk.rest.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java" + visibility: "public" +--- +# `iterator` + +**Decorators:** `@Override` + +## Signature + +```java +public PaginatedIterator iterator() +``` + +## Returns + +`PaginatedIterator` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java) + +Line 62. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/next.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/next.mdx new file mode 100644 index 0000000000..21826896bd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/next.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/paginated-iterator/next" +title: "next" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.PaginatedIterator.next" + parent: "com.signalwire.sdk.rest.PaginatedIterator" + module: "com.signalwire.sdk.rest.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java" + visibility: "public" +--- +# `next` + +**Decorators:** `@Override` + +## Signature + +```java +public Map next() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PaginatedIterator.java) + +Line 78. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/index.mdx new file mode 100644 index 0000000000..8ceac56bea --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/index.mdx @@ -0,0 +1,104 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/phone-call-handler" +title: "PhoneCallHandler" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "enum" + language: "java" + qualified_name: "com.signalwire.sdk.rest.PhoneCallHandler" + parent: "com.signalwire.sdk.rest" + module: "com.signalwire.sdk.rest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java" + visibility: "public" +--- +# `PhoneCallHandler` + +Values accepted for `call_handler` on +java.util.Map) phoneNumbers().update. + +<p> +Named `PhoneCallHandler` (not `CallHandler`) to avoid colliding +with the RELAY client's inbound-call-handler callback type. +<p> +Setting a phone number's `call_handler` + the handler-specific +companion field routes inbound calls and auto-materializes the matching +Fabric resource on the server. + +See the typed helpers on +`com.signalwire.sdk.rest.namespaces.PhoneNumbersNamespace` +(`setSwmlWebhook`, `setCxmlWebhook`, ...). + +<p>Binding table: +<pre> +Enum member Companion field (required) Auto-creates resource +----------------- -------------------------------- --------------------- +RELAY_SCRIPT call_relay_script_url swml_webhook +LAML_WEBHOOKS call_request_url cxml_webhook +LAML_APPLICATION call_laml_application_id cxml_application +AI_AGENT call_ai_agent_id ai_agent +CALL_FLOW call_flow_id call_flow +RELAY_APPLICATION call_relay_application relay_application +RELAY_TOPIC call_relay_topic (routes via RELAY) +RELAY_CONTEXT call_relay_context (legacy, prefer topic) +RELAY_CONNECTOR (connector config) (internal) +VIDEO_ROOM call_video_room_id (routes to Video API) +DIALOGFLOW call_dialogflow_agent_id (none) +</pre> + +<p>Note: `#LAML_WEBHOOKS` (wire value `laml_webhooks`) produces +a <b>cXML</b> handler, not a generic webhook. For SWML, use +`#RELAY_SCRIPT`. + +## Signature + +```java +public enum PhoneCallHandler +``` + +## Variants + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + Returns the wire value so this enum serializes transparently into request bodies without an explicit `.wireValue()` indirection. + + + + + + + + The wire value sent on the `call_handler` field. + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java) + +Line 43. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/to-string.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/to-string.mdx new file mode 100644 index 0000000000..2f6f3871e9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/to-string.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/to-string" +title: "toString" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.PhoneCallHandler.toString" + parent: "com.signalwire.sdk.rest.PhoneCallHandler" + module: "com.signalwire.sdk.rest.PhoneCallHandler" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java" + visibility: "public" +--- +# `toString` + +Returns the wire value so this enum serializes transparently into +request bodies without an explicit `.wireValue()` indirection. + +**Decorators:** `@Override` + +## Signature + +```java +public String toString() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java) + +Line 74. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/value-of.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/value-of.mdx new file mode 100644 index 0000000000..2486b49eb4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/value-of.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/value-of" +title: "valueOf" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.PhoneCallHandler.valueOf" + parent: "com.signalwire.sdk.rest.PhoneCallHandler" + module: "com.signalwire.sdk.rest.PhoneCallHandler" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java" + visibility: "public" +--- +# `valueOf` + +**Modifiers:** `static` + +## Signature + +```java +public static PhoneCallHandler valueOf(String name) +``` + +## Parameters + + + +## Returns + +`PhoneCallHandler` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/values.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/values.mdx new file mode 100644 index 0000000000..2e15178d83 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/values.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/values" +title: "values" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.PhoneCallHandler.values" + parent: "com.signalwire.sdk.rest.PhoneCallHandler" + module: "com.signalwire.sdk.rest.PhoneCallHandler" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java" + visibility: "public" +--- +# `values` + +**Modifiers:** `static` + +## Signature + +```java +public static PhoneCallHandler[] values() +``` + +## Returns + +`PhoneCallHandler[]` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/wire-value.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/wire-value.mdx new file mode 100644 index 0000000000..b7409503ed --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/wire-value.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/phone-call-handler/wire-value" +title: "wireValue" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.PhoneCallHandler.wireValue" + parent: "com.signalwire.sdk.rest.PhoneCallHandler" + module: "com.signalwire.sdk.rest.PhoneCallHandler" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java" + visibility: "public" +--- +# `wireValue` + +The wire value sent on the `call_handler` field. + +## Signature + +```java +public String wireValue() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/PhoneCallHandler.java) + +Line 66. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/addresses.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/addresses.mdx new file mode 100644 index 0000000000..9ad36508e7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/addresses.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/addresses" +title: "addresses" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.addresses" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `addresses` + +## Signature + +```java +public AddressesNamespace addresses() +``` + +## Returns + +`AddressesNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 254. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/billing.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/billing.mdx new file mode 100644 index 0000000000..d7eab58b6f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/billing.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/billing" +title: "billing" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.billing" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `billing` + +## Signature + +```java +public BillingNamespace billing() +``` + +## Returns + +`BillingNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 212. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder.mdx new file mode 100644 index 0000000000..e63408249f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/builder" +title: "builder" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.builder" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `builder` + +**Modifiers:** `static` + +## Signature + +```java +public static Builder builder() +``` + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 106. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/build.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/build.mdx new file mode 100644 index 0000000000..8ca5ac4664 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/build.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/build" +title: "build" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.Builder.build" + parent: "com.signalwire.sdk.rest.RestClient.Builder" + module: "com.signalwire.sdk.rest.RestClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `build` + +## Signature + +```java +public RestClient build() +``` + +## Returns + +`RestClient` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 126. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/index.mdx new file mode 100644 index 0000000000..5bbd50e53a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/builder" +title: "Builder" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.Builder" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `Builder` + +**Modifiers:** `static` + +## Signature + +```java +public static class Builder +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 110. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/init.mdx new file mode 100644 index 0000000000..e6eee23950 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.Builder." + parent: "com.signalwire.sdk.rest.RestClient.Builder" + module: "com.signalwire.sdk.rest.RestClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/project.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/project.mdx new file mode 100644 index 0000000000..d9878a9472 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/project.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/project" +title: "project" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.Builder.project" + parent: "com.signalwire.sdk.rest.RestClient.Builder" + module: "com.signalwire.sdk.rest.RestClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `project` + +## Signature + +```java +public Builder project(String project) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 116. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/space.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/space.mdx new file mode 100644 index 0000000000..10419f76e2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/space.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/space" +title: "space" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.Builder.space" + parent: "com.signalwire.sdk.rest.RestClient.Builder" + module: "com.signalwire.sdk.rest.RestClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `space` + +## Signature + +```java +public Builder space(String space) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 118. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/token.mdx new file mode 100644 index 0000000000..cbbe0d933f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/builder/token" +title: "token" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.Builder.token" + parent: "com.signalwire.sdk.rest.RestClient.Builder" + module: "com.signalwire.sdk.rest.RestClient.Builder" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `token` + +## Signature + +```java +public Builder token(String token) +``` + +## Parameters + + + +## Returns + +`Builder` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 117. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/calling.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/calling.mdx new file mode 100644 index 0000000000..a08e5743cd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/calling.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/calling" +title: "calling" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.calling" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `calling` + +## Signature + +```java +public CallingNamespace calling() +``` + +## Returns + +`CallingNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 147. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/campaign.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/campaign.mdx new file mode 100644 index 0000000000..a7f0ce54f8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/campaign.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/campaign" +title: "campaign" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.campaign" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `campaign` + +## Signature + +```java +public CampaignNamespace campaign() +``` + +## Returns + +`CampaignNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 202. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/chat.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/chat.mdx new file mode 100644 index 0000000000..af4c2bb093 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/chat.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/chat" +title: "chat" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.chat" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `chat` + +## Signature + +```java +public ChatNamespace chat() +``` + +## Returns + +`ChatNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 187. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/compat.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/compat.mdx new file mode 100644 index 0000000000..17614863cd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/compat.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/compat" +title: "compat" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.compat" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `compat` + +## Signature + +```java +public CompatNamespace compat() +``` + +## Returns + +`CompatNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 167. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/compliance.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/compliance.mdx new file mode 100644 index 0000000000..ec93f4846f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/compliance.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/compliance" +title: "compliance" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.compliance" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `compliance` + +## Signature + +```java +public ComplianceNamespace compliance() +``` + +## Returns + +`ComplianceNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 207. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/conferences.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/conferences.mdx new file mode 100644 index 0000000000..bbeaecf15d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/conferences.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/conferences" +title: "conferences" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.conferences" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `conferences` + +## Signature + +```java +public ConferenceNamespace conferences() +``` + +## Returns + +`ConferenceNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 232. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/datasphere.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/datasphere.mdx new file mode 100644 index 0000000000..848924c65b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/datasphere.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/datasphere" +title: "datasphere" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.datasphere" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `datasphere` + +## Signature + +```java +public DatasphereNamespace datasphere() +``` + +## Returns + +`DatasphereNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 157. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/fabric.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/fabric.mdx new file mode 100644 index 0000000000..089689d303 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/fabric.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/fabric" +title: "fabric" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.fabric" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `fabric` + +## Signature + +```java +public FabricNamespace fabric() +``` + +## Returns + +`FabricNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 142. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/fax.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/fax.mdx new file mode 100644 index 0000000000..058bcf682e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/fax.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/fax" +title: "fax" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.fax" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `fax` + +## Signature + +```java +public FaxNamespace fax() +``` + +## Returns + +`FaxNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 182. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/get-http-client.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/get-http-client.mdx new file mode 100644 index 0000000000..006c233d56 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/get-http-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/get-http-client" +title: "getHttpClient" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.getHttpClient" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `getHttpClient` + +## Signature + +```java +public HttpClient getHttpClient() +``` + +## Returns + +`HttpClient` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 138. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/get-project.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/get-project.mdx new file mode 100644 index 0000000000..a85d8a6462 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/get-project.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/get-project" +title: "getProject" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.getProject" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `getProject` + +## Signature + +```java +public String getProject() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 136. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/get-space.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/get-space.mdx new file mode 100644 index 0000000000..cc1827b550 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/get-space.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/get-space" +title: "getSpace" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.getSpace" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `getSpace` + +## Signature + +```java +public String getSpace() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 137. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/imported-numbers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/imported-numbers.mdx new file mode 100644 index 0000000000..2935886d1e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/imported-numbers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/imported-numbers" +title: "importedNumbers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.importedNumbers" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `importedNumbers` + +## Signature + +```java +public ImportedNumbersNamespace importedNumbers() +``` + +## Returns + +`ImportedNumbersNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 264. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/index.mdx new file mode 100644 index 0000000000..62584166dd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/index.mdx @@ -0,0 +1,127 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client" +title: "RestClient" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient" + parent: "com.signalwire.sdk.rest" + module: "com.signalwire.sdk.rest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `RestClient` + +SignalWire REST API client with all 21 namespaces. + +<p> +Uses `java.net.http.HttpClient` with Basic Auth. + +Each namespace +provides typed access to a group of API resources. + +<pre>client = RestClient.builder() + .project("project-id") + .token("api-token") + .space("example.signalwire.com") + .build(); + +var numbers = client.phoneNumbers().list(); +var docs = client.datasphere().documents().list();</pre> + +## Signature + +```java +public class RestClient +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Build a `RestClient` pointed at an explicit base URL — typically a loopback fixture used by the porting-sdk's REST-transport audit. + + + +## Classes + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/logs.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/logs.mdx new file mode 100644 index 0000000000..eff37c7b62 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/logs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/logs" +title: "logs" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.logs" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `logs` + +## Signature + +```java +public LogsNamespace logs() +``` + +## Returns + +`LogsNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 289. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/messaging.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/messaging.mdx new file mode 100644 index 0000000000..58719f3afa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/messaging.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/messaging" +title: "messaging" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.messaging" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `messaging` + +## Signature + +```java +public MessagingNamespace messaging() +``` + +## Returns + +`MessagingNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 172. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/mfa.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/mfa.mdx new file mode 100644 index 0000000000..ee65955816 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/mfa.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/mfa" +title: "mfa" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.mfa" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `mfa` + +## Signature + +```java +public MfaNamespace mfa() +``` + +## Returns + +`MfaNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 269. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/number-groups.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/number-groups.mdx new file mode 100644 index 0000000000..b6e569e6e3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/number-groups.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/number-groups" +title: "numberGroups" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.numberGroups" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `numberGroups` + +## Signature + +```java +public NumberGroupsNamespace numberGroups() +``` + +## Returns + +`NumberGroupsNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 279. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/number-lookup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/number-lookup.mdx new file mode 100644 index 0000000000..c52a396e3b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/number-lookup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/number-lookup" +title: "numberLookup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.numberLookup" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `numberLookup` + +## Signature + +```java +public NumberLookupNamespace numberLookup() +``` + +## Returns + +`NumberLookupNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 227. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/phone-numbers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/phone-numbers.mdx new file mode 100644 index 0000000000..0fe0b1743b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/phone-numbers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/phone-numbers" +title: "phoneNumbers" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.phoneNumbers" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `phoneNumbers` + +## Signature + +```java +public PhoneNumbersNamespace phoneNumbers() +``` + +## Returns + +`PhoneNumbersNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 152. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/project.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/project.mdx new file mode 100644 index 0000000000..52daf689fe --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/project.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/project" +title: "project" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.project" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `project` + +## Signature + +```java +public ProjectNamespace project() +``` + +## Returns + +`ProjectNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 217. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/pub-sub.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/pub-sub.mdx new file mode 100644 index 0000000000..388271318b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/pub-sub.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/pub-sub" +title: "pubSub" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.pubSub" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `pubSub` + +## Signature + +```java +public PubSubNamespace pubSub() +``` + +## Returns + +`PubSubNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 192. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/queues.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/queues.mdx new file mode 100644 index 0000000000..05ddc9f8e9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/queues.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/queues" +title: "queues" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.queues" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `queues` + +## Signature + +```java +public QueueNamespace queues() +``` + +## Returns + +`QueueNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 237. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/recordings.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/recordings.mdx new file mode 100644 index 0000000000..985317d885 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/recordings.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/recordings" +title: "recordings" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.recordings" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `recordings` + +## Signature + +```java +public RecordingNamespace recordings() +``` + +## Returns + +`RecordingNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 242. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/registry.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/registry.mdx new file mode 100644 index 0000000000..0d64c9e018 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/registry.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/registry" +title: "registry" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.registry" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `registry` + +## Signature + +```java +public RegistryNamespace registry() +``` + +## Returns + +`RegistryNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 284. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/short-codes.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/short-codes.mdx new file mode 100644 index 0000000000..41bcdc5248 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/short-codes.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/short-codes" +title: "shortCodes" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.shortCodes" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `shortCodes` + +## Signature + +```java +public ShortCodesNamespace shortCodes() +``` + +## Returns + +`ShortCodesNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 259. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/sip-profile.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/sip-profile.mdx new file mode 100644 index 0000000000..2df53450a1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/sip-profile.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/sip-profile" +title: "sipProfile" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.sipProfile" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `sipProfile` + +## Signature + +```java +public SipProfileNamespace sipProfile() +``` + +## Returns + +`SipProfileNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 274. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/sip.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/sip.mdx new file mode 100644 index 0000000000..43e9fe0a78 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/sip.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/sip" +title: "sip" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.sip" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `sip` + +## Signature + +```java +public SipNamespace sip() +``` + +## Returns + +`SipNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 177. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/streams.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/streams.mdx new file mode 100644 index 0000000000..1d008050eb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/streams.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/streams" +title: "streams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.streams" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `streams` + +## Signature + +```java +public StreamNamespace streams() +``` + +## Returns + +`StreamNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 222. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/swml.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/swml.mdx new file mode 100644 index 0000000000..813725cb42 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/swml.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/swml" +title: "swml" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.swml" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `swml` + +## Signature + +```java +public SwmlNamespace swml() +``` + +## Returns + +`SwmlNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 197. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/transcriptions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/transcriptions.mdx new file mode 100644 index 0000000000..be9f814590 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/transcriptions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/transcriptions" +title: "transcriptions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.transcriptions" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `transcriptions` + +## Signature + +```java +public TranscriptionNamespace transcriptions() +``` + +## Returns + +`TranscriptionNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 247. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/video.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/video.mdx new file mode 100644 index 0000000000..5488d136f8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/video.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/video" +title: "video" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.video" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `video` + +## Signature + +```java +public VideoNamespace video() +``` + +## Returns + +`VideoNamespace` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 162. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/with-base-url.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/with-base-url.mdx new file mode 100644 index 0000000000..fd38c0465f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-client/with-base-url.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-client/with-base-url" +title: "withBaseUrl" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestClient.withBaseUrl" + parent: "com.signalwire.sdk.rest.RestClient" + module: "com.signalwire.sdk.rest.RestClient" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java" + visibility: "public" +--- +# `withBaseUrl` + +Build a `RestClient` pointed at an explicit base URL — typically +a loopback fixture used by the porting-sdk's REST-transport audit. + +The +returned client signs requests with the given `project`/`token` +pair via Basic Auth and routes every namespace's HTTP through the +fixture instead of the live SignalWire space. + +**Modifiers:** `static` + +## Signature + +```java +public static RestClient withBaseUrl( + String baseUrl, + String project, + String token +) +``` + +## Parameters + + + fully qualified base URL (e.g. `"http://127.0.0.1:NNNN/api"`); `"/api"` is appended if not already present + + + + project ID used as the Basic Auth username + + + + API token used as the Basic Auth password + + +## Returns + +`RestClient` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestClient.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestClient.java) + +Line 89. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-method.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-method.mdx new file mode 100644 index 0000000000..414d2af1d1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-error/get-method" +title: "getMethod" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestError.getMethod" + parent: "com.signalwire.sdk.rest.RestError" + module: "com.signalwire.sdk.rest.RestError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java" + visibility: "public" +--- +# `getMethod` + +## Signature + +```java +public String getMethod() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java) + +Line 41. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-path.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-path.mdx new file mode 100644 index 0000000000..8c21f58bba --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-error/get-path" +title: "getPath" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestError.getPath" + parent: "com.signalwire.sdk.rest.RestError" + module: "com.signalwire.sdk.rest.RestError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java" + visibility: "public" +--- +# `getPath` + +## Signature + +```java +public String getPath() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java) + +Line 45. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-response-body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-response-body.mdx new file mode 100644 index 0000000000..7284ff1da1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-response-body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-error/get-response-body" +title: "getResponseBody" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestError.getResponseBody" + parent: "com.signalwire.sdk.rest.RestError" + module: "com.signalwire.sdk.rest.RestError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java" + visibility: "public" +--- +# `getResponseBody` + +## Signature + +```java +public String getResponseBody() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java) + +Line 49. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-status-code.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-status-code.mdx new file mode 100644 index 0000000000..7ad645f269 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/get-status-code.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-error/get-status-code" +title: "getStatusCode" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestError.getStatusCode" + parent: "com.signalwire.sdk.rest.RestError" + module: "com.signalwire.sdk.rest.RestError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java" + visibility: "public" +--- +# `getStatusCode` + +## Signature + +```java +public int getStatusCode() +``` + +## Returns + +`int` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/index.mdx new file mode 100644 index 0000000000..049a185ec6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-error" +title: "RestError" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestError" + parent: "com.signalwire.sdk.rest" + module: "com.signalwire.sdk.rest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java" + visibility: "public" +--- +# `RestError` + +Exception for SignalWire REST API errors. + +<p> +Contains the HTTP status code and error message from the server. + +## Signature + +```java +public class RestError extends RuntimeException +``` + +## Inheritance + +**Extends:** `RuntimeException` + +## Methods + + + + + + + + + + + + + + Whether the error is a client error (4xx). + + + + Whether the resource was not found (404). + + + + Whether the error is a server error (5xx). + + + + Whether access was denied (401 or 403). + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java) + +Line 14. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/init.mdx new file mode 100644 index 0000000000..a2fbf30419 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/init.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-error/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestError." + parent: "com.signalwire.sdk.rest.RestError" + module: "com.signalwire.sdk.rest.RestError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public (int statusCode, String method, String path, String responseBody) + ``` + + + + ```java + public ( + int statusCode, + String method, + String path, + String responseBody, + Throwable cause + ) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + +## Parameters (Overload 2) + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java) + +Line 21. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-client-error.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-client-error.mdx new file mode 100644 index 0000000000..a284636f42 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-client-error.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-error/is-client-error" +title: "isClientError" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestError.isClientError" + parent: "com.signalwire.sdk.rest.RestError" + module: "com.signalwire.sdk.rest.RestError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java" + visibility: "public" +--- +# `isClientError` + +Whether the error is a client error (4xx). + +## Signature + +```java +public boolean isClientError() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java) + +Line 56. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-not-found.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-not-found.mdx new file mode 100644 index 0000000000..c0b6610ff1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-not-found.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-error/is-not-found" +title: "isNotFound" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestError.isNotFound" + parent: "com.signalwire.sdk.rest.RestError" + module: "com.signalwire.sdk.rest.RestError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java" + visibility: "public" +--- +# `isNotFound` + +Whether the resource was not found (404). + +## Signature + +```java +public boolean isNotFound() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java) + +Line 70. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-server-error.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-server-error.mdx new file mode 100644 index 0000000000..20e71f4b83 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-server-error.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-error/is-server-error" +title: "isServerError" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestError.isServerError" + parent: "com.signalwire.sdk.rest.RestError" + module: "com.signalwire.sdk.rest.RestError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java" + visibility: "public" +--- +# `isServerError` + +Whether the error is a server error (5xx). + +## Signature + +```java +public boolean isServerError() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java) + +Line 63. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-unauthorized.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-unauthorized.mdx new file mode 100644 index 0000000000..dca8d75326 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/rest/rest/rest-error/is-unauthorized.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/rest/rest/rest-error/is-unauthorized" +title: "isUnauthorized" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.rest.RestError.isUnauthorized" + parent: "com.signalwire.sdk.rest.RestError" + module: "com.signalwire.sdk.rest.RestError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java" + visibility: "public" +--- +# `isUnauthorized` + +Whether access was denied (401 or 403). + +## Signature + +```java +public boolean isUnauthorized() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/rest/RestError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/rest/RestError.java) + +Line 77. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/index.mdx new file mode 100644 index 0000000000..8261515f60 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/index.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda" +title: "lambda" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda" + module: "com.signalwire.sdk.runtime.lambda" +--- +# `lambda` + +## Signature + +```java +package com.signalwire.sdk.runtime.lambda +``` + +## Classes + + + + AWS Lambda adapter for a SignalWire `AgentBase`. <p>Translates API Gateway (REST v1 or HTTP v2) / Lambda Function URL events into the same dispatch logic the in-process HTTP server uses, without depending on the `aws-lambda-java-events` typed models at runtime (the handler accepts plain Object> so the SDK stays dependency-light). <p><b>Usage</b> — in your Lambda handler class: <pre>class MyHandler implements RequestHandler\, Map\> \{ private final LambdaAgentHandler delegate; public MyHandler() \{ AgentBase agent = AgentBase.builder() .name("my-agent") .route("/") .build(); agent.setPromptText("You are helpful."); this.delegate = new LambdaAgentHandler(agent); public Map\ handleRequest(Map\ event, Context ctx) \{ return delegate.handle(event).toMap(); \} \} \}</pre> <p>The adapter dispatches based on the request path and the agent's configured route: <ul> <li>/<route> → returns rendered SWML</li> <li>/<route>/swaig → executes the named SWAIG tool</li> <li>/<route>/post\_prompt → invokes the summary callback</li> <li>/<route>/mcp → JSON-RPC 2.0 (if MCP enabled)</li> <li>/health, `/ready` → health probes</li> </ul> <p>All webhook URLs generated inside the SWML document are built from the Lambda's Function URL (via `LambdaUrlResolver`) or the `SWML_PROXY_URL_BASE` override, with the agent's route always layered on top. + + + + Response shape returned by `LambdaAgentHandler` and compatible with AWS API Gateway (REST v1 and HTTP v2) and Lambda Function URL response envelopes. <p>The fields map 1:1 to `APIGatewayProxyResponseEvent`: `statusCode`, `headers`, `body`, `isBase64Encoded`. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler/handle.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler/handle.mdx new file mode 100644 index 0000000000..7109a32a2c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler/handle.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler/handle" +title: "handle" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda.LambdaAgentHandler.handle" + parent: "com.signalwire.sdk.runtime.lambda.LambdaAgentHandler" + module: "com.signalwire.sdk.runtime.lambda.LambdaAgentHandler" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaAgentHandler.java" + visibility: "public" +--- +# `handle` + +Handle a single invocation. + +## Signature + +```java +public LambdaResponse handle(Map event) +``` + +## Parameters + + + the raw Lambda event (API Gateway v1, v2, or Function URL payload). Null events are treated as a root GET. + + +## Returns + +`LambdaResponse` — response envelope ready to convert to `APIGatewayProxyResponseEvent` or equivalent. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/lambda/LambdaAgentHandler.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaAgentHandler.java) + +Line 106. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler/index.mdx new file mode 100644 index 0000000000..e73240650a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler/index.mdx @@ -0,0 +1,89 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler" +title: "LambdaAgentHandler" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda.LambdaAgentHandler" + parent: "com.signalwire.sdk.runtime.lambda" + module: "com.signalwire.sdk.runtime.lambda" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaAgentHandler.java" + visibility: "public" +--- +# `LambdaAgentHandler` + +AWS Lambda adapter for a SignalWire `AgentBase`. + +<p>Translates API Gateway (REST v1 or HTTP v2) / Lambda Function URL +events into the same dispatch logic the in-process HTTP server uses, +without depending on the `aws-lambda-java-events` typed models +at runtime (the handler accepts plain Object> so +the SDK stays dependency-light). + +<p><b>Usage</b> — in your Lambda handler class: +<pre>class MyHandler implements RequestHandler<Map<String, Object>, Map<String, Object>> { + private final LambdaAgentHandler delegate; + +``` +public MyHandler() { + AgentBase agent = AgentBase.builder() + .name("my-agent") + .route("/") + .build(); + agent.setPromptText("You are helpful."); + this.delegate = new LambdaAgentHandler(agent); + +public Map handleRequest(Map event, Context ctx) { + return delegate.handle(event).toMap(); +} +``` + +\} +\}</pre> + +<p>The adapter dispatches based on the request path and the agent's +configured route: +<ul> + <li>/<route> → returns rendered SWML</li> + <li>/<route>/swaig → executes the named SWAIG tool</li> + <li>/<route>/post_prompt → invokes the summary callback</li> + <li>/<route>/mcp → JSON-RPC 2.0 (if MCP enabled)</li> + <li>/health, `/ready` → health probes</li> +</ul> + +<p>All webhook URLs generated inside the SWML document are built from +the Lambda's Function URL (via `LambdaUrlResolver`) or the +`SWML_PROXY_URL_BASE` override, with the agent's route always +layered on top. + +This is the same invariant the HTTP server path +enforces. + +**Modifiers:** `final` + +## Signature + +```java +public final class LambdaAgentHandler +``` + +## Methods + + + + Create a handler for the given agent using the real process environment. + + + + Handle a single invocation. + + + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/lambda/LambdaAgentHandler.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaAgentHandler.java) + +Line 65. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler/init.mdx new file mode 100644 index 0000000000..32ae063087 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler/init.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-agent-handler/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda.LambdaAgentHandler." + parent: "com.signalwire.sdk.runtime.lambda.LambdaAgentHandler" + module: "com.signalwire.sdk.runtime.lambda.LambdaAgentHandler" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaAgentHandler.java" + visibility: "public" +--- +# `` + +Create a handler for the given agent using the real process +environment. + +## Signature + + + + ```java + public (AgentBase agent) + ``` + + + + ```java + public (AgentBase agent, EnvProvider env) + ``` + + + +## Parameters (Overload 1) + + + the configured agent. + + +## Parameters (Overload 2) + + + the configured agent. + + + + environment variable source. + + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/lambda/LambdaAgentHandler.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaAgentHandler.java) + +Line 80. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-body.mdx new file mode 100644 index 0000000000..117fde51d8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-body" +title: "getBody" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda.LambdaResponse.getBody" + parent: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + module: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java" + visibility: "public" +--- +# `getBody` + +## Signature + +```java +public String getBody() +``` + +## Returns + +`String` — response body. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java) + +Line 48. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-headers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-headers.mdx new file mode 100644 index 0000000000..4eaf3787bb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-headers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-headers" +title: "getHeaders" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda.LambdaResponse.getHeaders" + parent: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + module: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java" + visibility: "public" +--- +# `getHeaders` + +## Signature + +```java +public Map getHeaders() +``` + +## Returns + +`Map` — response headers. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java) + +Line 45. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-status-code.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-status-code.mdx new file mode 100644 index 0000000000..16f9edbb17 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-status-code.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/get-status-code" +title: "getStatusCode" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda.LambdaResponse.getStatusCode" + parent: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + module: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java" + visibility: "public" +--- +# `getStatusCode` + +## Signature + +```java +public int getStatusCode() +``` + +## Returns + +`int` — HTTP status code. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java) + +Line 42. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/index.mdx new file mode 100644 index 0000000000..66d89e71b7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response" +title: "LambdaResponse" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + parent: "com.signalwire.sdk.runtime.lambda" + module: "com.signalwire.sdk.runtime.lambda" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java" + visibility: "public" +--- +# `LambdaResponse` + +Response shape returned by `LambdaAgentHandler` and compatible +with AWS API Gateway (REST v1 and HTTP v2) and Lambda Function URL +response envelopes. + +<p>The fields map 1:1 to `APIGatewayProxyResponseEvent`: +`statusCode`, `headers`, `body`, +`isBase64Encoded`. + +Returned as a plain `Map` so the SDK +does not require a runtime dependency on `aws-lambda-java-events`. +Users who want the typed variant can trivially copy the fields over. + +**Modifiers:** `final` + +## Signature + +```java +public final class LambdaResponse +``` + +## Methods + + + + Create a Lambda response with the given fields. + + + + + + + + + + + + Convenience builder for a 200 JSON response. + + + + Serialise this response into the AWS Lambda Function URL / API Gateway payload format (v1 and v2 are structurally identical for response shape). + + + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java) + +Line 17. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/init.mdx new file mode 100644 index 0000000000..1cfc17c2d1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/init.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda.LambdaResponse." + parent: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + module: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java" + visibility: "public" +--- +# `` + +Create a Lambda response with the given fields. + +## Signature + +```java +public ( + int statusCode, + Map headers, + String body, + boolean isBase64Encoded +) +``` + +## Parameters + + + HTTP status code. + + + + response headers (must not be null — pass an empty map for no headers). + + + + raw response body as a string. + + + + whether the body is base64-encoded binary. + + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java) + +Line 33. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/is-base64-encoded.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/is-base64-encoded.mdx new file mode 100644 index 0000000000..11846d0b95 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/is-base64-encoded.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/is-base64-encoded" +title: "isBase64Encoded" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda.LambdaResponse.isBase64Encoded" + parent: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + module: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java" + visibility: "public" +--- +# `isBase64Encoded` + +## Signature + +```java +public boolean isBase64Encoded() +``` + +## Returns + +`boolean` — whether the body is base64-encoded. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java) + +Line 51. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/json.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/json.mdx new file mode 100644 index 0000000000..fcb08d1cec --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/json.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/json" +title: "json" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda.LambdaResponse.json" + parent: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + module: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java" + visibility: "public" +--- +# `json` + +Convenience builder for a 200 JSON response. + +**Modifiers:** `static` + +## Signature + + + + ```java + public static LambdaResponse json(String body) + ``` + + + + ```java + public static LambdaResponse json(int statusCode, String body) + ``` + + + +## Parameters (Overload 1) + + + raw JSON string. + + +## Parameters (Overload 2) + + + HTTP status. + + + + raw JSON string. + + +## Returns (Overload 1) + +`LambdaResponse` — LambdaResponse. + +## Returns (Overload 2) + +`LambdaResponse` — LambdaResponse. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java) + +Line 75. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/to-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/to-map.mdx new file mode 100644 index 0000000000..226e8007ed --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/to-map.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/lambda/lambda/lambda-response/to-map" +title: "toMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.lambda.LambdaResponse.toMap" + parent: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + module: "com.signalwire.sdk.runtime.lambda.LambdaResponse" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java" + visibility: "public" +--- +# `toMap` + +Serialise this response into the AWS Lambda Function URL / +API Gateway payload format (v1 and v2 are structurally identical +for response shape). + +## Signature + +```java +public Map toMap() +``` + +## Returns + +`Map` — a Map suitable for returning from a Lambda handler. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/lambda/LambdaResponse.java) + +Line 60. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/env-provider/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/env-provider/get.mdx new file mode 100644 index 0000000000..ad9a795135 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/env-provider/get.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/env-provider/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.EnvProvider.get" + parent: "com.signalwire.sdk.runtime.EnvProvider" + module: "com.signalwire.sdk.runtime.EnvProvider" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/EnvProvider.java" + visibility: "public" +--- +# `get` + +Return the value of the given environment variable, or `null` if +it is not set. + +## Signature + +```java +String get(String name) +``` + +## Parameters + + + the environment variable name. + + +## Returns + +`String` — the value, or `null`. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/EnvProvider.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/EnvProvider.java) + +Line 22. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/env-provider/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/env-provider/index.mdx new file mode 100644 index 0000000000..062c70901a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/env-provider/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/env-provider" +title: "EnvProvider" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "interface" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.EnvProvider" + parent: "com.signalwire.sdk.runtime" + module: "com.signalwire.sdk.runtime" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/EnvProvider.java" + visibility: "public" +--- +# `EnvProvider` + +Simple read-only view of process environment variables. + +<p>Extracted as an interface so tests can inject a deterministic map +instead of relying on actual OS environment variables (which Java +cannot mutate at runtime without native hackery). + +<p>The default implementation delegates to `System#getenv(String)`. + +**Decorators:** `@FunctionalInterface` + +## Signature + +```java +public interface EnvProvider +``` + +## Constants + + + Default provider backed by `System#getenv(String)`. + + +## Methods + + + + Return the value of the given environment variable, or `null` if it is not set. + + + + Return true iff the env var is set and non-empty. + + + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/EnvProvider.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/EnvProvider.java) + +Line 12. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/env-provider/is-set.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/env-provider/is-set.mdx new file mode 100644 index 0000000000..537b1c5904 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/env-provider/is-set.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/env-provider/is-set" +title: "isSet" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.EnvProvider.isSet" + parent: "com.signalwire.sdk.runtime.EnvProvider" + module: "com.signalwire.sdk.runtime.EnvProvider" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/EnvProvider.java" + visibility: "public" +--- +# `isSet` + +Return true iff the env var is set and non-empty. + +**Modifiers:** `default` + +## Signature + +```java +default boolean isSet(String name) +``` + +## Parameters + + + the environment variable name. + + +## Returns + +`boolean` — true if the value is set and non-empty. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/EnvProvider.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/EnvProvider.java) + +Line 33. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/detect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/detect.mdx new file mode 100644 index 0000000000..0358403738 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/detect.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/detect" +title: "detect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.ExecutionMode.detect" + parent: "com.signalwire.sdk.runtime.ExecutionMode" + module: "com.signalwire.sdk.runtime.ExecutionMode" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java" + visibility: "public" +--- +# `detect` + +Detect the execution mode from the real process environment. + +**Modifiers:** `static` + +## Signature + + + + ```java + public static ExecutionMode detect() + ``` + + + + ```java + public static ExecutionMode detect(EnvProvider env) + ``` + + + +## Parameters (Overload 2) + + + environment variable source (injectable for tests). + + +## Returns (Overload 1) + +`ExecutionMode` — the detected mode, or `#SERVER` as fallback. + +## Returns (Overload 2) + +`ExecutionMode` — the detected mode. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java) + +Line 35. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/get-execution-mode.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/get-execution-mode.mdx new file mode 100644 index 0000000000..1c32310464 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/get-execution-mode.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/get-execution-mode" +title: "getExecutionMode" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.ExecutionMode.getExecutionMode" + parent: "com.signalwire.sdk.runtime.ExecutionMode" + module: "com.signalwire.sdk.runtime.ExecutionMode" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java" + visibility: "public" +--- +# `getExecutionMode` + +Cross-language SDK contract: return the execution mode as the +canonical lower-case-with-underscores string used by every port. +Mirrors `signalwire.core.logging_config.get_execution_mode` +in Python: one of `"cgi"`, `"lambda"`, +`"google_cloud_function"`, `"azure_function"`, or +`"server"`. + +**Modifiers:** `static` + +## Signature + + + + ```java + public static String getExecutionMode() + ``` + + + + ```java + public static String getExecutionMode(EnvProvider env) + ``` + + + +## Parameters (Overload 2) + + + environment variable source (injectable for tests). + + +## Returns (Overload 1) + +`String` — canonical mode string detected from the process environment + +## Returns (Overload 2) + +`String` — canonical mode string. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java) + +Line 81. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/index.mdx new file mode 100644 index 0000000000..83d887d609 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/execution-mode" +title: "ExecutionMode" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "enum" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.ExecutionMode" + parent: "com.signalwire.sdk.runtime" + module: "com.signalwire.sdk.runtime" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java" + visibility: "public" +--- +# `ExecutionMode` + +Runtime deployment environments the SDK knows about. + +<p>Detected from well-known environment variables set by the hosting +platform. + +Mirrors `get_execution_mode()` in the Python SDK and +`detectPlatform()` in the TypeScript SDK. + +<p>Use `#detect()` to read the actual process environment, or +`#detect(EnvProvider)` to pass a test double. + +## Signature + +```java +public enum ExecutionMode +``` + +## Variants + + + Azure Functions. + + + + Legacy CGI script behind a web server. + + + + Google Cloud Functions (1st or 2nd gen / Cloud Run). + + + + AWS Lambda function (container or zip deployment). + + + + Normal long-running HTTP server process (the default). + + +## Methods + + + + Detect the execution mode from the real process environment. + + + + Cross-language SDK contract: return the execution mode as the canonical lower-case-with-underscores string used by every port. Mirrors `signalwire.core.logging_config.get_execution_mode` in Python: one of `"cgi"`, `"lambda"`, `"google_cloud_function"`, `"azure_function"`, or `"server"`. + + + + Cross-language SDK contract: true when the process is running inside any serverless / short-lived environment (i.e. + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java) + +Line 13. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/is-serverless-mode.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/is-serverless-mode.mdx new file mode 100644 index 0000000000..3accf13b18 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/is-serverless-mode.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/is-serverless-mode" +title: "isServerlessMode" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.ExecutionMode.isServerlessMode" + parent: "com.signalwire.sdk.runtime.ExecutionMode" + module: "com.signalwire.sdk.runtime.ExecutionMode" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java" + visibility: "public" +--- +# `isServerlessMode` + +Cross-language SDK contract: true when the process is running +inside any serverless / short-lived environment (i.e. + +anything +other than `"server"`). Mirrors +`signalwire.utils.is_serverless_mode` in Python. + +**Modifiers:** `static` + +## Signature + + + + ```java + public static boolean isServerlessMode() + ``` + + + + ```java + public static boolean isServerlessMode(EnvProvider env) + ``` + + + +## Parameters (Overload 2) + + + environment variable source (injectable for tests). + + +## Returns (Overload 1) + +`boolean` — `true` unless the detected mode is `"server"`. + +## Returns (Overload 2) + +`boolean` — true unless the detected mode is `"server"`. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java) + +Line 112. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/value-of.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/value-of.mdx new file mode 100644 index 0000000000..586d89c72e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/value-of.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/value-of" +title: "valueOf" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.ExecutionMode.valueOf" + parent: "com.signalwire.sdk.runtime.ExecutionMode" + module: "com.signalwire.sdk.runtime.ExecutionMode" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java" + visibility: "public" +--- +# `valueOf` + +**Modifiers:** `static` + +## Signature + +```java +public static ExecutionMode valueOf(String name) +``` + +## Parameters + + + +## Returns + +`ExecutionMode` + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/values.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/values.mdx new file mode 100644 index 0000000000..3cd65dcc03 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/values.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/execution-mode/values" +title: "values" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.ExecutionMode.values" + parent: "com.signalwire.sdk.runtime.ExecutionMode" + module: "com.signalwire.sdk.runtime.ExecutionMode" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java" + visibility: "public" +--- +# `values` + +**Modifiers:** `static` + +## Signature + +```java +public static ExecutionMode[] values() +``` + +## Returns + +`ExecutionMode[]` + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/ExecutionMode.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/index.mdx new file mode 100644 index 0000000000..f507081e42 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime" +title: "runtime" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.runtime" + module: "com.signalwire.sdk.runtime" +--- +# `runtime` + +## Signature + +```java +package com.signalwire.sdk.runtime +``` + +## Classes + + + + Resolve the base URL of a SignalWire agent running as an AWS Lambda function, from standard Lambda environment variables. <p>Precedence — highest first: <ol> <li>`AWS_LAMBDA_FUNCTION_URL` — the Function URL explicitly assigned to this Lambda (the only variant that is guaranteed correct; synthetic fallbacks below assume the Function URL service was used and the function name matches the public subdomain, which is typically true but not guaranteed).</li> <li>Synthesised `https://{AWS_LAMBDA_FUNCTION_NAME`.lambda-url.\{AWS\_REGION\}.on.aws\} — built when the Function URL env var is not present but the standard Lambda identity variables are.</li> </ol> <p>This class returns a bare origin (scheme + host). + + + +## Interfaces + + + + Simple read-only view of process environment variables. <p>Extracted as an interface so tests can inject a deterministic map instead of relying on actual OS environment variables (which Java cannot mutate at runtime without native hackery). <p>The default implementation delegates to `System#getenv(String)`. + + + +## Enums + + + + Runtime deployment environments the SDK knows about. <p>Detected from well-known environment variables set by the hosting platform. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver/index.mdx new file mode 100644 index 0000000000..969f24db27 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver" +title: "LambdaUrlResolver" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.LambdaUrlResolver" + parent: "com.signalwire.sdk.runtime" + module: "com.signalwire.sdk.runtime" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/LambdaUrlResolver.java" + visibility: "public" +--- +# `LambdaUrlResolver` + +Resolve the base URL of a SignalWire agent running as an AWS Lambda +function, from standard Lambda environment variables. + +<p>Precedence — highest first: +<ol> + <li>`AWS_LAMBDA_FUNCTION_URL` — the Function URL explicitly + assigned to this Lambda (the only variant that is guaranteed + correct; synthetic fallbacks below assume the Function URL + service was used and the function name matches the public + subdomain, which is typically true but not guaranteed).</li> + <li>Synthesised `https://{AWS_LAMBDA_FUNCTION_NAME`.lambda-url.{AWS_REGION}.on.aws} + — built when the Function URL env var is not present but the + standard Lambda identity variables are.</li> +</ol> + +<p>This class returns a bare origin (scheme + host). + +It intentionally +does NOT append any route — callers (e.g. `AgentBase.buildWebhookUrl`) +are responsible for appending the agent's route + endpoint path. This +keeps the route-preservation invariant intact regardless of which +source produced the base URL. + +<p>Mirrors the Lambda branch of `get_full_url()` in the Python SDK. + +**Modifiers:** `final` + +## Signature + +```java +public final class LambdaUrlResolver +``` + +## Methods + + + + Create a resolver backed by the real process environment. + + + + Return the base URL for the Lambda, without any trailing slash. <p>Returns `null` if none of the expected env vars are set (which typically means we're not actually running on Lambda). + + + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/LambdaUrlResolver.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/LambdaUrlResolver.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver/init.mdx new file mode 100644 index 0000000000..24a29da3c7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver/init.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.LambdaUrlResolver." + parent: "com.signalwire.sdk.runtime.LambdaUrlResolver" + module: "com.signalwire.sdk.runtime.LambdaUrlResolver" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/LambdaUrlResolver.java" + visibility: "public" +--- +# `` + +Create a resolver backed by the real process environment. + +## Signature + + + + ```java + public () + ``` + + + + ```java + public (EnvProvider env) + ``` + + + +## Parameters (Overload 2) + + + environment variable source. + + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/LambdaUrlResolver.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/LambdaUrlResolver.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver/resolve-base-url.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver/resolve-base-url.mdx new file mode 100644 index 0000000000..1e4dfbf670 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver/resolve-base-url.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/runtime/runtime/lambda-url-resolver/resolve-base-url" +title: "resolveBaseUrl" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.runtime.LambdaUrlResolver.resolveBaseUrl" + parent: "com.signalwire.sdk.runtime.LambdaUrlResolver" + module: "com.signalwire.sdk.runtime.LambdaUrlResolver" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/LambdaUrlResolver.java" + visibility: "public" +--- +# `resolveBaseUrl` + +Return the base URL for the Lambda, without any trailing slash. + +<p>Returns `null` if none of the expected env vars are set +(which typically means we're not actually running on Lambda). + +The +caller should then fall back to its normal base-URL detection. + +## Signature + +```java +public String resolveBaseUrl() +``` + +## Returns + +`String` — bare origin (e.g. `https://xyz.lambda-url.us-east-1.on.aws`), or `null`. + +## Source + +[`src/main/java/com/signalwire/sdk/runtime/LambdaUrlResolver.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/runtime/LambdaUrlResolver.java) + +Line 58. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/index.mdx new file mode 100644 index 0000000000..3eb6d27323 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/java/com/signalwire/sdk/sdk" +title: "sdk" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk" + module: "com.signalwire.sdk" +--- +# `sdk` + +## Signature + +```java +package com.signalwire.sdk +``` + +## Classes + + + + Top-level convenience entry points — mirror Python's `signalwire/__init__.py` package-level helpers (`RestClient`, `register_skill`, `add_skill_directory`, `list_skills_with_params`). <p>This is a static-only utility class; it cannot be instantiated. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/add-skill-directory.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/add-skill-directory.mdx new file mode 100644 index 0000000000..3b41bfd736 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/add-skill-directory.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/sdk/signalwire/add-skill-directory" +title: "addSkillDirectory" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.Signalwire.addSkillDirectory" + parent: "com.signalwire.sdk.Signalwire" + module: "com.signalwire.sdk.Signalwire" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/Signalwire.java" + visibility: "public" +--- +# `addSkillDirectory` + +Add a directory to search for skills. + +<p>Mirrors Python's `signalwire.add_skill_directory(path)` — +delegates to the singleton `SkillRegistry` instance so +third-party skill collections can be registered by path. +Subsequent calls accumulate (de-duplicated) into a shared +external paths list. + +**Modifiers:** `static` + +## Signature + +```java +public static void addSkillDirectory(String path) +``` + +## Parameters + + + absolute or relative path to a directory containing skill subdirectories + + +## Throws + +- `IllegalArgumentException` — when the path doesn't exist or isn't a directory + +## Source + +[`src/main/java/com/signalwire/sdk/Signalwire.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/Signalwire.java) + +Line 177. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/index.mdx new file mode 100644 index 0000000000..0e9dbe16d6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/java/com/signalwire/sdk/sdk/signalwire" +title: "Signalwire" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.Signalwire" + parent: "com.signalwire.sdk" + module: "com.signalwire.sdk" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/Signalwire.java" + visibility: "public" +--- +# `Signalwire` + +Top-level convenience entry points — mirror Python's +`signalwire/__init__.py` package-level helpers +(`RestClient`, `register_skill`, +`add_skill_directory`, `list_skills_with_params`). + +<p>This is a static-only utility class; it cannot be instantiated. + +The +helpers delegate to the underlying classes (RestClient, SkillRegistry) +so they're a strict thin layer. + +<p>The audit projects each method onto the canonical Python +`signalwire.<name>` free-function path via a per-port +`FREE_FUNCTION_PROJECTIONS` entry in +`scripts/enumerate_signatures.py`. + +**Modifiers:** `final` + +## Signature + +```java +public final class Signalwire +``` + +## Methods + + + + Add a directory to search for skills. <p>Mirrors Python's `signalwire.add_skill_directory(path)` — delegates to the singleton `SkillRegistry` instance so third-party skill collections can be registered by path. Subsequent calls accumulate (de-duplicated) into a shared external paths list. + + + + Get complete schema for all available skills. <p>Mirrors Python's `signalwire.list_skills_with_params()`. Returns a map keyed by skill name where each value contains parameter metadata. + + + + Register a custom skill class with the global `SkillRegistry`. <p>Mirrors Python's `signalwire.register_skill(skill_class)`. Java skills are constructed via a no-arg constructor (the registry stores `Supplier` factories), so we adapt the supplied class reference into a factory using reflection. + + + + Construct a `RestClient` from positional or keyword credentials. <p>Mirrors Python's top-level \*\*kwargs) factory. + + + +## Source + +[`src/main/java/com/signalwire/sdk/Signalwire.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/Signalwire.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/list-skills-with-params.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/list-skills-with-params.mdx new file mode 100644 index 0000000000..6fdcc467a5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/list-skills-with-params.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/sdk/signalwire/list-skills-with-params" +title: "listSkillsWithParams" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.Signalwire.listSkillsWithParams" + parent: "com.signalwire.sdk.Signalwire" + module: "com.signalwire.sdk.Signalwire" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/Signalwire.java" + visibility: "public" +--- +# `listSkillsWithParams` + +Get complete schema for all available skills. + +<p>Mirrors Python's `signalwire.list_skills_with_params()`. +Returns a map keyed by skill name where each value contains +parameter metadata. + +Useful for GUI configuration tools, API +documentation, or programmatic skill discovery. + +<p>Java skills don't carry rich Python-style parameter +introspection in v1, so each entry contains the skill name and an +empty parameter map; built-in skills that expose +`parameterSchema()` get richer detail. + +**Modifiers:** `static` + +## Signature + +```java +public static Map> listSkillsWithParams() +``` + +## Returns + +`Map>` — map of skill name to schema metadata + +## Source + +[`src/main/java/com/signalwire/sdk/Signalwire.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/Signalwire.java) + +Line 196. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/register-skill.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/register-skill.mdx new file mode 100644 index 0000000000..68ffd51b58 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/register-skill.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/sdk/signalwire/register-skill" +title: "registerSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.Signalwire.registerSkill" + parent: "com.signalwire.sdk.Signalwire" + module: "com.signalwire.sdk.Signalwire" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/Signalwire.java" + visibility: "public" +--- +# `registerSkill` + +Register a custom skill class with the global `SkillRegistry`. + +<p>Mirrors Python's `signalwire.register_skill(skill_class)`. +Java skills are constructed via a no-arg constructor (the +registry stores `Supplier<SkillBase>` factories), so we +adapt the supplied class reference into a factory using +reflection. + +Throws `IllegalArgumentException` when the +class can't be instantiated reflectively or when its skill name +cannot be derived. + +**Modifiers:** `static` + +## Signature + +```java +public static void registerSkill(Class skillClass) +``` + +## Parameters + + + a `SkillBase` subclass + + +## Source + +[`src/main/java/com/signalwire/sdk/Signalwire.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/Signalwire.java) + +Line 129. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/rest-client.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/rest-client.mdx new file mode 100644 index 0000000000..7eb024b652 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/sdk/signalwire/rest-client.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/java/com/signalwire/sdk/sdk/signalwire/rest-client" +title: "RestClient" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.Signalwire.RestClient" + parent: "com.signalwire.sdk.Signalwire" + module: "com.signalwire.sdk.Signalwire" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/Signalwire.java" + visibility: "public" +--- +# `RestClient` + +Construct a `RestClient` from positional or keyword +credentials. + +<p>Mirrors Python's top-level **kwargs) factory. + +Supports two call shapes: + +<ul> + <li>token, space) — three positional + strings, mapping straight onto the Java builder.</li> + <li>kwargs) — variadic-shaped form + matching Python's signature exactly. `args` is an + array of three strings (project/token/space) or empty; + `kwargs` carries the same fields by name.</li> +</ul> + +<p>The audit projects this method onto Python's +**kwargs) via +`FREE_FUNCTION_PROJECTIONS`. + +**Modifiers:** `static` + +## Signature + +```java +public static RestClient RestClient( + List args, + Map kwargs +) +``` + +## Parameters + + + positional credentials — empty or token, space] + + + + keyword credentials — recognised keys are `project` / `project_id`, `token`, and `space` / `host` + + +## Returns + +`RestClient` — a fully wired `RestClient` instance + +## Source + +[`src/main/java/com/signalwire/sdk/Signalwire.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/Signalwire.java) + +Line 87. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/index.mdx new file mode 100644 index 0000000000..7490cdc8a8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security" +title: "security" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.security" + module: "com.signalwire.sdk.security" +--- +# `security` + +## Signature + +```java +package com.signalwire.sdk.security +``` + +## Classes + + + + Session manager for HMAC-SHA256 signed tool tokens. Stub for the security module being built by another agent. + + + + Servlet filter that enforces SignalWire webhook signature validation on incoming requests. <p>Wraps the request in a body-caching wrapper before reading the body so that downstream handlers (including framework parsers) can re-read the same raw bytes. + + + + Webhook signature validation for SignalWire-signed HTTP requests. <p>Implements both schemes from `porting-sdk/webhooks.md`: <ul> <li><b>Scheme A</b> (RELAY/SWML/JSON): url + rawBody)).</li> <li><b>Scheme B</b> (Compat/cXML form): url + sortedFormParams)) with optional `bodySHA256` query-param fallback for JSON-on-compat-surface.</li> </ul> <p>All signature comparisons use byte\[]) (constant-time) so the secret cannot be leaked through timing differences. <p>Public API: <ul> <li>String, String, String) — combined entry point.</li> <li>String, String, Object) — legacy `@signalwire/compatibility-api` drop-in alias.</li> </ul> <p>This is a stateless utility — every method is static and the class is not intended to be instantiated. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/create-token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/create-token.mdx new file mode 100644 index 0000000000..0a72f1694f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/create-token.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/session-manager/create-token" +title: "createToken" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.SessionManager.createToken" + parent: "com.signalwire.sdk.security.SessionManager" + module: "com.signalwire.sdk.security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/SessionManager.java" + visibility: "public" +--- +# `createToken` + +Create a signed token for a function + callID. + +## Signature + + + + ```java + public String createToken(String functionName, String callId) + ``` + + + + ```java + public String createToken(String functionName, String callId, int expirySeconds) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + + + + + +## Returns (Overload 1) + +`String` + +## Returns (Overload 2) + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/security/SessionManager.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/SessionManager.java) + +Line 32. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/index.mdx new file mode 100644 index 0000000000..7acb65091e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/session-manager" +title: "SessionManager" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.security.SessionManager" + parent: "com.signalwire.sdk.security" + module: "com.signalwire.sdk.security" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/SessionManager.java" + visibility: "public" +--- +# `SessionManager` + +Session manager for HMAC-SHA256 signed tool tokens. +Stub for the security module being built by another agent. + +## Signature + +```java +public class SessionManager +``` + +## Methods + + + + + + Create a signed token for a function + callID. + + + + Validate a signed token. + + + +## Source + +[`src/main/java/com/signalwire/sdk/security/SessionManager.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/SessionManager.java) + +Line 14. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/init.mdx new file mode 100644 index 0000000000..4aa7df1ea5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/init.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/session-manager/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.SessionManager." + parent: "com.signalwire.sdk.security.SessionManager" + module: "com.signalwire.sdk.security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/SessionManager.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public () + ``` + + + + ```java + public (int defaultExpiry) + ``` + + + +## Parameters (Overload 2) + + + +## Source + +[`src/main/java/com/signalwire/sdk/security/SessionManager.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/SessionManager.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/validate-token.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/validate-token.mdx new file mode 100644 index 0000000000..66dab84489 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/session-manager/validate-token.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/session-manager/validate-token" +title: "validateToken" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.SessionManager.validateToken" + parent: "com.signalwire.sdk.security.SessionManager" + module: "com.signalwire.sdk.security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/SessionManager.java" + visibility: "public" +--- +# `validateToken` + +Validate a signed token. + +## Signature + +```java +public boolean validateToken(String token, String functionName, String callId) +``` + +## Parameters + + + + + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/security/SessionManager.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/SessionManager.java) + +Line 48. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-cached-body-as-string.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-cached-body-as-string.mdx new file mode 100644 index 0000000000..f8bd4cc258 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-cached-body-as-string.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-cached-body-as-string" +title: "getCachedBodyAsString" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest.getCachedBodyAsString" + parent: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest" + module: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java" + visibility: "public" +--- +# `getCachedBodyAsString` + +Cached body decoded as UTF-8 (or the request's declared charset). + +## Signature + +```java +public String getCachedBodyAsString() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookFilter.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java) + +Line 213. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-cached-body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-cached-body.mdx new file mode 100644 index 0000000000..2e510b2939 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-cached-body.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-cached-body" +title: "getCachedBody" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest.getCachedBody" + parent: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest" + module: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java" + visibility: "public" +--- +# `getCachedBody` + +Snapshot of the cached body bytes. + +Defensive copy. + +## Signature + +```java +public byte[] getCachedBody() +``` + +## Returns + +`byte[]` + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookFilter.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java) + +Line 208. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-input-stream.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-input-stream.mdx new file mode 100644 index 0000000000..5c40abaae9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-input-stream.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-input-stream" +title: "getInputStream" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest.getInputStream" + parent: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest" + module: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java" + visibility: "public" +--- +# `getInputStream` + +**Decorators:** `@Override` + +## Signature + +```java +public ServletInputStream getInputStream() +``` + +## Returns + +`ServletInputStream` + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookFilter.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java) + +Line 221. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-reader.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-reader.mdx new file mode 100644 index 0000000000..e9de5b54fb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-reader.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/get-reader" +title: "getReader" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest.getReader" + parent: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest" + module: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java" + visibility: "public" +--- +# `getReader` + +**Decorators:** `@Override` + +## Signature + +```java +public BufferedReader getReader() +``` + +## Returns + +`BufferedReader` + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookFilter.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java) + +Line 256. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/index.mdx new file mode 100644 index 0000000000..d7ecfa08cf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request" +title: "CachedBodyHttpServletRequest" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest" + parent: "com.signalwire.sdk.security.WebhookFilter" + module: "com.signalwire.sdk.security" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java" + visibility: "public" +--- +# `CachedBodyHttpServletRequest` + +`HttpServletRequestWrapper` that buffers the request body so it +can be read multiple times (once by the filter for signature +validation, once by the downstream handler for parsing). + +**Modifiers:** `static` `final` + +## Signature + +```java +public static final class CachedBodyHttpServletRequest extends HttpServletRequestWrapper +``` + +## Inheritance + +**Extends:** `HttpServletRequestWrapper` + +## Methods + + + + + + Snapshot of the cached body bytes. + + + + Cached body decoded as UTF-8 (or the request's declared charset). + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookFilter.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java) + +Line 195. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/init.mdx new file mode 100644 index 0000000000..c0af599a12 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-filter/cached-body-http-servlet-request/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest." + parent: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest" + module: "com.signalwire.sdk.security.WebhookFilter.CachedBodyHttpServletRequest" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (HttpServletRequest request) +``` + +## Parameters + + + +## Throws + +- `IOException` + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookFilter.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java) + +Line 199. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/destroy.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/destroy.mdx new file mode 100644 index 0000000000..c600fb9cb6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/destroy.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-filter/destroy" +title: "destroy" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookFilter.destroy" + parent: "com.signalwire.sdk.security.WebhookFilter" + module: "com.signalwire.sdk.security.WebhookFilter" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java" + visibility: "public" +--- +# `destroy` + +**Decorators:** `@Override` + +## Signature + +```java +public void destroy() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookFilter.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java) + +Line 102. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/do-filter.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/do-filter.mdx new file mode 100644 index 0000000000..21e1b7bf01 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/do-filter.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-filter/do-filter" +title: "doFilter" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookFilter.doFilter" + parent: "com.signalwire.sdk.security.WebhookFilter" + module: "com.signalwire.sdk.security.WebhookFilter" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java" + visibility: "public" +--- +# `doFilter` + +**Decorators:** `@Override` + +## Signature + +```java +public void doFilter( + ServletRequest request, + ServletResponse response, + FilterChain chain +) +``` + +## Parameters + + + + + + + +## Throws + +- `IOException` +- `ServletException` + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookFilter.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java) + +Line 107. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/index.mdx new file mode 100644 index 0000000000..bd3917aa61 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/index.mdx @@ -0,0 +1,91 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-filter" +title: "WebhookFilter" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookFilter" + parent: "com.signalwire.sdk.security" + module: "com.signalwire.sdk.security" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java" + visibility: "public" +--- +# `WebhookFilter` + +Servlet filter that enforces SignalWire webhook signature validation on +incoming requests. + +<p>Wraps the request in a body-caching wrapper before reading the body so +that downstream handlers (including framework parsers) can re-read the same +raw bytes. + +This is the canonical Java framework adapter described in the +"Framework adapter" section of `porting-sdk/webhooks.md`. + +<p>Behavior: + +<ol> + <li>Read the raw request body once and cache it.</li> + <li>Extract `X-SignalWire-Signature` (or `X-Twilio-Signature`) + from the request headers.</li> + <li>Reconstruct the public URL — uses `X-Forwarded-Proto` / + `X-Forwarded-Host` when `trustProxy` is set, otherwise + falls back to `HttpServletRequest#getRequestURL()` + + `HttpServletRequest#getQueryString()`.</li> + <li>Call String, String, String).</li> + <li>On invalid: respond Forbidden and do <b>not</b> call + `chain.doFilter`.</li> + <li>On valid: forward via `chain.doFilter` with the body-caching + request wrapper so downstream handlers can re-read the body.</li> +</ol> + +<p>The filter intentionally does <b>not</b> log the signing key, the +incoming signature, or which scheme branch tripped — disclosing those +weakens the constant-time defense and gives attackers data to differentiate +scheme branches with. + +<p>Note: this class targets the `javax.servlet` API (Servlet 4.x / +Tomcat 9 / Jetty 9). Apps on Servlet 5.x / Jakarta EE 9+ should bridge via +a → jakarta shim or copy this class into their codebase +with the import package swapped. + +## Signature + +```java +public class WebhookFilter implements Filter +``` + +## Inheritance + +**Implements:** `Filter` + +## Methods + + + + Construct a filter with proxy trust disabled. + + + + + + + + + +## Classes + + + + `HttpServletRequestWrapper` that buffers the request body so it can be read multiple times (once by the filter for signature validation, once by the downstream handler for parsing). + + + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookFilter.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java) + +Line 63. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/init.mdx new file mode 100644 index 0000000000..3a8114e524 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/init.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-filter/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookFilter." + parent: "com.signalwire.sdk.security.WebhookFilter" + module: "com.signalwire.sdk.security.WebhookFilter" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java" + visibility: "public" +--- +# `` + +Construct a filter with proxy trust disabled. + +## Signature + + + + ```java + public (String signingKey) + ``` + + + + ```java + public (String signingKey, boolean trustProxy) + ``` + + + +## Parameters (Overload 1) + + + customer's Signing Key. Must be non-empty; an empty value is a programming error and the constructor throws `IllegalArgumentException`. + + +## Parameters (Overload 2) + + + customer's Signing Key. Required. + + + + when `true`, honor `X-Forwarded-Proto` / `X-Forwarded-Host` for URL reconstruction. `false` by default since proxy headers are spoofable; only enable when you control the proxy chain. + + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookFilter.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java) + +Line 75. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/init__2.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/init__2.mdx new file mode 100644 index 0000000000..0e5ce66582 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-filter/init__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-filter/init__2" +title: "init" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookFilter.init" + parent: "com.signalwire.sdk.security.WebhookFilter" + module: "com.signalwire.sdk.security.WebhookFilter" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java" + visibility: "public" +--- +# `init` + +**Decorators:** `@Override` + +## Signature + +```java +public void init(FilterConfig filterConfig) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookFilter.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookFilter.java) + +Line 97. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-validator/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-validator/index.mdx new file mode 100644 index 0000000000..3c896fcc8a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-validator/index.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-validator" +title: "WebhookValidator" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookValidator" + parent: "com.signalwire.sdk.security" + module: "com.signalwire.sdk.security" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookValidator.java" + visibility: "public" +--- +# `WebhookValidator` + +Webhook signature validation for SignalWire-signed HTTP requests. + +<p>Implements both schemes from `porting-sdk/webhooks.md`: + +<ul> + <li><b>Scheme A</b> (RELAY/SWML/JSON): url + rawBody)).</li> + <li><b>Scheme B</b> (Compat/cXML form): url + sortedFormParams)) + with optional `bodySHA256` query-param fallback for JSON-on-compat-surface.</li> +</ul> + +<p>All signature comparisons use byte[]) +(constant-time) so the secret cannot be leaked through timing differences. + +<p>Public API: +<ul> + <li>String, String, String) — combined entry point.</li> + <li>String, String, Object) — legacy + `@signalwire/compatibility-api` drop-in alias.</li> +</ul> + +<p>This is a stateless utility — every method is static and the class is +not intended to be instantiated. + +**Modifiers:** `final` + +## Signature + +```java +public final class WebhookValidator +``` + +## Constants + + + Header name that carries the signature on every signed SignalWire request. + + + + Legacy alias accepted by the cXML/Compatibility surface. + + +## Methods + + + + Legacy `@signalwire/compatibility-api` drop-in entry point. <p>Dispatches on the runtime type of `paramsOrRawBody`: <ul> <li>`String` → delegates to String, String, String).</li> <li>`Map` or any `Iterable` of `Map.Entry` (or 2-element arrays / lists) → treats the value as pre-parsed form params and runs Scheme B directly with URL port normalization.</li> <li>`null` → treated as an empty params map (Scheme B).</li> <li>Anything else → `IllegalArgumentException`.</li> </ul> + + + + Validate a SignalWire webhook signature against both schemes. <p>Tries Scheme A (hex HMAC-SHA1 over + rawBody) first; on miss, tries Scheme B (base64 HMAC-SHA1 over + sortedFormParams) with both port-normalization variants of the URL and an optional `bodySHA256` fallback for JSON-on-compat-surface. + + + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookValidator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookValidator.java) + +Line 50. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-validator/validate-request.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-validator/validate-request.mdx new file mode 100644 index 0000000000..651e5a27a3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-validator/validate-request.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-validator/validate-request" +title: "validateRequest" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookValidator.validateRequest" + parent: "com.signalwire.sdk.security.WebhookValidator" + module: "com.signalwire.sdk.security.WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookValidator.java" + visibility: "public" +--- +# `validateRequest` + +Legacy `@signalwire/compatibility-api` drop-in entry point. + +<p>Dispatches on the runtime type of `paramsOrRawBody`: +<ul> + <li>`String` → delegates to + String, String, String).</li> + <li>`Map` or any `Iterable` of `Map.Entry` (or + 2-element arrays / lists) → treats the value as pre-parsed form + params and runs Scheme B directly with URL port normalization.</li> + <li>`null` → treated as an empty params map (Scheme B).</li> + <li>Anything else → `IllegalArgumentException`.</li> +</ul> + +**Modifiers:** `static` + +## Signature + +```java +public static boolean validateRequest( + String signingKey, + String signature, + String url, + Object paramsOrRawBody +) +``` + +## Parameters + + + customer's Signing Key. Non-empty. + + + + header value. `null` / empty returns `false`. + + + + full URL SignalWire POSTed to. + + + + `String` raw body OR pre-parsed form params. + + +## Returns + +`boolean` — `true` on match, `false` otherwise. + +## Throws + +- `IllegalArgumentException` — when `signingKey` is empty or `paramsOrRawBody` is of an unsupported type. + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookValidator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookValidator.java) + +Line 171. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-validator/validate-webhook-signature.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-validator/validate-webhook-signature.mdx new file mode 100644 index 0000000000..25932575ed --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/security/security/webhook-validator/validate-webhook-signature.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/java/com/signalwire/sdk/security/security/webhook-validator/validate-webhook-signature" +title: "validateWebhookSignature" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.security.WebhookValidator.validateWebhookSignature" + parent: "com.signalwire.sdk.security.WebhookValidator" + module: "com.signalwire.sdk.security.WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookValidator.java" + visibility: "public" +--- +# `validateWebhookSignature` + +Validate a SignalWire webhook signature against both schemes. + +<p>Tries Scheme A (hex HMAC-SHA1 over + rawBody) first; on +miss, tries Scheme B (base64 HMAC-SHA1 over + sortedFormParams) +with both port-normalization variants of the URL and an optional +`bodySHA256` fallback for JSON-on-compat-surface. + +**Modifiers:** `static` + +## Signature + +```java +public static boolean validateWebhookSignature( + String signingKey, + String signature, + String url, + String rawBody +) +``` + +## Parameters + + + customer's Signing Key from the Dashboard. Must be non-null and non-empty; otherwise an `IllegalArgumentException` is thrown — that's a programming error, not a validation failure. + + + + the `X-SignalWire-Signature` header value (or the `X-Twilio-Signature` alias). `null` or empty returns `false` without throwing. + + + + the full URL SignalWire POSTed to (scheme, host, optional port, path, query). Must match what the platform saw — see the URL reconstruction section of `porting-sdk/webhooks.md`. + + + + the raw UTF-8 request body bytes as a string, <b>before</b> any JSON / form parsing. May be empty but must not be `null` — pass `""` when the body was empty. + + +## Returns + +`boolean` — `true` when the signature matches either scheme, otherwise `false`. + +## Throws + +- `IllegalArgumentException` — when `signingKey` is `null` or empty, or when `rawBody` is `null`. + +## Source + +[`src/main/java/com/signalwire/sdk/security/WebhookValidator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/security/WebhookValidator.java) + +Line 94. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/get-agent.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/get-agent.mdx new file mode 100644 index 0000000000..812796f45a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/get-agent.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server/get-agent" +title: "getAgent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer.getAgent" + parent: "com.signalwire.sdk.server.AgentServer" + module: "com.signalwire.sdk.server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `getAgent` + +Get agent for a route. + +## Signature + +```java +public AgentBase getAgent(String route) +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 111. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/get-routes.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/get-routes.mdx new file mode 100644 index 0000000000..dc2b93d9e5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/get-routes.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server/get-routes" +title: "getRoutes" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer.getRoutes" + parent: "com.signalwire.sdk.server.AgentServer" + module: "com.signalwire.sdk.server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `getRoutes` + +List all registered routes. + +## Signature + +```java +public Set getRoutes() +``` + +## Returns + +`Set` + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 118. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/get-sip-route.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/get-sip-route.mdx new file mode 100644 index 0000000000..2cf3cbc8c3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/get-sip-route.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server/get-sip-route" +title: "getSipRoute" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer.getSipRoute" + parent: "com.signalwire.sdk.server.AgentServer" + module: "com.signalwire.sdk.server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `getSipRoute` + +Get route for a SIP username. + +## Signature + +```java +public String getSipRoute(String username) +``` + +## Parameters + + + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 158. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/index.mdx new file mode 100644 index 0000000000..c5a2751e30 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server" +title: "AgentServer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer" + parent: "com.signalwire.sdk.server" + module: "com.signalwire.sdk.server" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `AgentServer` + +Multi-agent hosting server. +Registers multiple agents on different routes and dispatches requests accordingly. + +## Signature + +```java +public class AgentServer +``` + +## Methods + + + + + + Get agent for a route. + + + + List all registered routes. + + + + Get route for a SIP username. + + + + Register an agent at a specific route. + + + + Register a SIP username to route to a specific agent. + + + + Start the multi-agent server. + + + + Serve static files from a directory at a specific route. + + + + Set directory for serving static files at /static route. + + + + Stop the server. + + + + Unregister an agent from a route. + + + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/init.mdx new file mode 100644 index 0000000000..1cf31fa6b5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/init.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer." + parent: "com.signalwire.sdk.server.AgentServer" + module: "com.signalwire.sdk.server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public () + ``` + + + + ```java + public (int port) + ``` + + + + ```java + public (String host, int port) + ``` + + + +## Parameters (Overload 2) + + + +## Parameters (Overload 3) + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 43. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/register-sip-route.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/register-sip-route.mdx new file mode 100644 index 0000000000..7b43db9380 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/register-sip-route.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server/register-sip-route" +title: "registerSipRoute" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer.registerSipRoute" + parent: "com.signalwire.sdk.server.AgentServer" + module: "com.signalwire.sdk.server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `registerSipRoute` + +Register a SIP username to route to a specific agent. + +## Signature + +```java +public AgentServer registerSipRoute(String username, String route) +``` + +## Parameters + + + + + +## Returns + +`AgentServer` + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 150. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/register.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/register.mdx new file mode 100644 index 0000000000..bad793d86f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/register.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server/register" +title: "register" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer.register" + parent: "com.signalwire.sdk.server.AgentServer" + module: "com.signalwire.sdk.server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `register` + +Register an agent at a specific route. + +## Signature + + + + ```java + public AgentServer register(AgentBase agent, String route) + ``` + + + + ```java + public AgentServer register(AgentBase agent) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`AgentServer` + +## Returns (Overload 2) + +`AgentServer` + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 72. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/run.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/run.mdx new file mode 100644 index 0000000000..18d116beee --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/run.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server/run" +title: "run" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer.run" + parent: "com.signalwire.sdk.server.AgentServer" + module: "com.signalwire.sdk.server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `run` + +Start the multi-agent server. + +## Signature + +```java +public void run() +``` + +## Throws + +- `IOException` + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 169. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/serve-static-files.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/serve-static-files.mdx new file mode 100644 index 0000000000..7dfbcd70c5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/serve-static-files.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server/serve-static-files" +title: "serveStaticFiles" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer.serveStaticFiles" + parent: "com.signalwire.sdk.server.AgentServer" + module: "com.signalwire.sdk.server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `serveStaticFiles` + +Serve static files from a directory at a specific route. + +## Signature + +```java +public AgentServer serveStaticFiles(String directory, String route) +``` + +## Parameters + + + Filesystem path to the directory containing static files + + + + URL route prefix (e.g., "/static" or "/assets") + + +## Returns + +`AgentServer` + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 137. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/set-static-files-dir.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/set-static-files-dir.mdx new file mode 100644 index 0000000000..27d7a9fce4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/set-static-files-dir.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server/set-static-files-dir" +title: "setStaticFilesDir" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer.setStaticFilesDir" + parent: "com.signalwire.sdk.server.AgentServer" + module: "com.signalwire.sdk.server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `setStaticFilesDir` + +Set directory for serving static files at /static route. + +## Signature + +```java +public AgentServer setStaticFilesDir(String dir) +``` + +## Parameters + + + +## Returns + +`AgentServer` + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 125. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/stop.mdx new file mode 100644 index 0000000000..34990accee --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer.stop" + parent: "com.signalwire.sdk.server.AgentServer" + module: "com.signalwire.sdk.server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `stop` + +Stop the server. + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 546. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/unregister.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/unregister.mdx new file mode 100644 index 0000000000..4e480d3d7b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/agent-server/unregister.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server/agent-server/unregister" +title: "unregister" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.server.AgentServer.unregister" + parent: "com.signalwire.sdk.server.AgentServer" + module: "com.signalwire.sdk.server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java" + visibility: "public" +--- +# `unregister` + +Unregister an agent from a route. + +## Signature + +```java +public AgentServer unregister(String route) +``` + +## Parameters + + + +## Returns + +`AgentServer` + +## Source + +[`src/main/java/com/signalwire/sdk/server/AgentServer.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/server/AgentServer.java) + +Line 97. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/index.mdx new file mode 100644 index 0000000000..24424613ce --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/server/server/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/java/com/signalwire/sdk/server/server" +title: "server" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.server" + module: "com.signalwire.sdk.server" +--- +# `server` + +## Signature + +```java +package com.signalwire.sdk.server +``` + +## Classes + + + + Multi-agent hosting server. Registers multiple agents on different routes and dispatches requests accordingly. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-description.mdx new file mode 100644 index 0000000000..2fd86666c5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + module: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-name.mdx new file mode 100644 index 0000000000..d42166f9aa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + module: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java) + +Line 22. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-swaig-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-swaig-functions.mdx new file mode 100644 index 0000000000..f0305be979 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-swaig-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/get-swaig-functions" +title: "getSwaigFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill.getSwaigFunctions" + parent: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + module: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java" + visibility: "public" +--- +# `getSwaigFunctions` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getSwaigFunctions() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java) + +Line 42. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/index.mdx new file mode 100644 index 0000000000..c674e6a26e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill" +title: "ApiNinjaTriviaSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java" + visibility: "public" +--- +# `ApiNinjaTriviaSkill` + +## Signature + +```java +public class ApiNinjaTriviaSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java) + +Line 10. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/init.mdx new file mode 100644 index 0000000000..8945a8746f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill." + parent: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + module: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/register-tools.mdx new file mode 100644 index 0000000000..f3dc5c6c25 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + module: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/setup.mdx new file mode 100644 index 0000000000..a6b79c13b6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + module: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java) + +Line 26. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..ba37cdfa30 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/api-ninja-trivia-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + module: "com.signalwire.sdk.skills.builtin.ApiNinjaTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ApiNinjaTriviaSkill.java) + +Line 24. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-description.mdx new file mode 100644 index 0000000000..2605c5b9d4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-hints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-hints.mdx new file mode 100644 index 0000000000..cb5045d88c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-hints" +title: "getHints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill.getHints" + parent: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java" + visibility: "public" +--- +# `getHints` + +**Decorators:** `@Override` + +## Signature + +```java +public List getHints() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java) + +Line 109. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-name.mdx new file mode 100644 index 0000000000..22935760b8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java) + +Line 28. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..7c9551a1ad --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java) + +Line 114. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/index.mdx new file mode 100644 index 0000000000..082cb2ef05 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill" +title: "ClaudeSkillsSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java" + visibility: "public" +--- +# `ClaudeSkillsSkill` + +Load SKILL.md files as agent tools. +Reads .md files from a directory, extracts YAML frontmatter, and creates tools. + +## Signature + +```java +public class ClaudeSkillsSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java) + +Line 18. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/init.mdx new file mode 100644 index 0000000000..65b696e997 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill." + parent: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/register-tools.mdx new file mode 100644 index 0000000000..118fb69db3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java) + +Line 104. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/setup.mdx new file mode 100644 index 0000000000..dea9edab72 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java) + +Line 32. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..9c26453352 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/claude-skills-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/ClaudeSkillsSkill.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/get-description.mdx new file mode 100644 index 0000000000..7b899c2339 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java) + +Line 17. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/get-name.mdx new file mode 100644 index 0000000000..37d9d1338d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java) + +Line 16. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/index.mdx new file mode 100644 index 0000000000..5006daf924 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill" +title: "CustomSkillsSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java" + visibility: "public" +--- +# `CustomSkillsSkill` + +Register user-defined custom tools from configuration. + +## Signature + +```java +public class CustomSkillsSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java) + +Line 12. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/init.mdx new file mode 100644 index 0000000000..81d6c351cc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill." + parent: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/register-tools.mdx new file mode 100644 index 0000000000..870aa9adc7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java) + +Line 44. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/setup.mdx new file mode 100644 index 0000000000..93d754ba7d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..e0bdda0300 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/custom-skills-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + module: "com.signalwire.sdk.skills.builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/CustomSkillsSkill.java) + +Line 18. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-description.mdx new file mode 100644 index 0000000000..6100aab804 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java) + +Line 22. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-global-data.mdx new file mode 100644 index 0000000000..46096c2b5a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-global-data" +title: "getGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill.getGlobalData" + parent: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java" + visibility: "public" +--- +# `getGlobalData` + +**Decorators:** `@Override` + +## Signature + +```java +public Map getGlobalData() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java) + +Line 78. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-name.mdx new file mode 100644 index 0000000000..3a813fc3be --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java) + +Line 21. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..7d9655c6f0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java) + +Line 66. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-swaig-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-swaig-functions.mdx new file mode 100644 index 0000000000..cc7bbdcc51 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-swaig-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/get-swaig-functions" +title: "getSwaigFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill.getSwaigFunctions" + parent: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java" + visibility: "public" +--- +# `getSwaigFunctions` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getSwaigFunctions() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java) + +Line 42. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/index.mdx new file mode 100644 index 0000000000..cb64dc6030 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill" +title: "DatasphereServerlessSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java" + visibility: "public" +--- +# `DatasphereServerlessSkill` + +## Signature + +```java +public class DatasphereServerlessSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java) + +Line 11. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/init.mdx new file mode 100644 index 0000000000..94c5c5b4bb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill." + parent: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/register-tools.mdx new file mode 100644 index 0000000000..abd458264a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/setup.mdx new file mode 100644 index 0000000000..d2f0b63cee --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..e8a44fbf2d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-serverless-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereServerlessSkill.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-description.mdx new file mode 100644 index 0000000000..d92a6c3736 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java) + +Line 31. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-global-data.mdx new file mode 100644 index 0000000000..46cf84863e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-global-data" +title: "getGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereSkill.getGlobalData" + parent: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java" + visibility: "public" +--- +# `getGlobalData` + +**Decorators:** `@Override` + +## Signature + +```java +public Map getGlobalData() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java) + +Line 144. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-name.mdx new file mode 100644 index 0000000000..0a0c3540f6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..0f1b3b7516 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereSkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java) + +Line 131. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/index.mdx new file mode 100644 index 0000000000..f207dd3c83 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill" +title: "DatasphereSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java" + visibility: "public" +--- +# `DatasphereSkill` + +## Signature + +```java +public class DatasphereSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java) + +Line 17. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/init.mdx new file mode 100644 index 0000000000..c8306547d0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereSkill." + parent: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/register-tools.mdx new file mode 100644 index 0000000000..94e59d8e6d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java) + +Line 48. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/setup.mdx new file mode 100644 index 0000000000..a4a057e37a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..2044243509 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datasphere-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatasphereSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + module: "com.signalwire.sdk.skills.builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatasphereSkill.java) + +Line 32. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-description.mdx new file mode 100644 index 0000000000..a8ba3b50bf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatetimeSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + module: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-name.mdx new file mode 100644 index 0000000000..d974727156 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatetimeSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + module: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java) + +Line 14. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..fdfc71b5da --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatetimeSkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + module: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java) + +Line 66. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/index.mdx new file mode 100644 index 0000000000..3523c9ef91 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill" +title: "DatetimeSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java" + visibility: "public" +--- +# `DatetimeSkill` + +## Signature + +```java +public class DatetimeSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java) + +Line 12. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/init.mdx new file mode 100644 index 0000000000..4d4aac9407 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatetimeSkill." + parent: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + module: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/register-tools.mdx new file mode 100644 index 0000000000..f91c2c80a6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatetimeSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + module: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/setup.mdx new file mode 100644 index 0000000000..94a9bdde2f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatetimeSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + module: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java) + +Line 18. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..3a1379e0d0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/datetime-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.DatetimeSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + module: "com.signalwire.sdk.skills.builtin.DatetimeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/DatetimeSkill.java) + +Line 16. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-description.mdx new file mode 100644 index 0000000000..8e1f4f1329 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + module: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-hints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-hints.mdx new file mode 100644 index 0000000000..1f9e3da9c9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-hints" +title: "getHints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill.getHints" + parent: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + module: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java" + visibility: "public" +--- +# `getHints` + +**Decorators:** `@Override` + +## Signature + +```java +public List getHints() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java) + +Line 123. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-name.mdx new file mode 100644 index 0000000000..7ae224dd29 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + module: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java) + +Line 26. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..c1b0aaf0d1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + module: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java) + +Line 128. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/index.mdx new file mode 100644 index 0000000000..5995710aaf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill" +title: "GoogleMapsSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java" + visibility: "public" +--- +# `GoogleMapsSkill` + +## Signature + +```java +public class GoogleMapsSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java) + +Line 18. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/init.mdx new file mode 100644 index 0000000000..fdd8c3a5df --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill." + parent: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + module: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/register-tools.mdx new file mode 100644 index 0000000000..303a7543f6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + module: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/setup.mdx new file mode 100644 index 0000000000..271bcf48b7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/google-maps-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + module: "com.signalwire.sdk.skills.builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/GoogleMapsSkill.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/index.mdx new file mode 100644 index 0000000000..08c0d85261 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin" +title: "builtin" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" +--- +# `builtin` + +## Signature + +```java +package com.signalwire.sdk.skills.builtin +``` + +## Classes + + + + + + Load SKILL.md files as agent tools. Reads .md files from a directory, extracts YAML frontmatter, and creates tools. + + + + Register user-defined custom tools from configuration. + + + + + + + + + + + + + + + + + + Bridge MCP (Model Context Protocol) servers with SWAIG functions. + + + + Native vector search skill - supports remote mode only (network API). Local .swsearch file support is skipped per porting guide. + + + + + + + + + + + + + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-description.mdx new file mode 100644 index 0000000000..cbbd2e3706 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.InfoGathererSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + module: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java) + +Line 17. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-global-data.mdx new file mode 100644 index 0000000000..e721768ec2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-global-data" +title: "getGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.InfoGathererSkill.getGlobalData" + parent: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + module: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java" + visibility: "public" +--- +# `getGlobalData` + +**Decorators:** `@Override` + +## Signature + +```java +public Map getGlobalData() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java) + +Line 130. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-name.mdx new file mode 100644 index 0000000000..3ce4d7cee5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.InfoGathererSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + module: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java) + +Line 16. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..18f1981d56 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.InfoGathererSkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + module: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java) + +Line 116. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/index.mdx new file mode 100644 index 0000000000..34f1d3b02f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill" +title: "InfoGathererSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java" + visibility: "public" +--- +# `InfoGathererSkill` + +## Signature + +```java +public class InfoGathererSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java) + +Line 9. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/init.mdx new file mode 100644 index 0000000000..1342867d36 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.InfoGathererSkill." + parent: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + module: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/register-tools.mdx new file mode 100644 index 0000000000..d06896932e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.InfoGathererSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + module: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/setup.mdx new file mode 100644 index 0000000000..060aac3a31 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.InfoGathererSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + module: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..1555fff09e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/info-gatherer-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.InfoGathererSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + module: "com.signalwire.sdk.skills.builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/InfoGathererSkill.java) + +Line 18. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-description.mdx new file mode 100644 index 0000000000..bb4dad22dc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.JokeSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.JokeSkill" + module: "com.signalwire.sdk.skills.builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java) + +Line 16. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-global-data.mdx new file mode 100644 index 0000000000..6ed3afbb7e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-global-data" +title: "getGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.JokeSkill.getGlobalData" + parent: "com.signalwire.sdk.skills.builtin.JokeSkill" + module: "com.signalwire.sdk.skills.builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java" + visibility: "public" +--- +# `getGlobalData` + +**Decorators:** `@Override` + +## Signature + +```java +public Map getGlobalData() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java) + +Line 59. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-name.mdx new file mode 100644 index 0000000000..0c23053f81 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.JokeSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.JokeSkill" + module: "com.signalwire.sdk.skills.builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..3d2f3e947b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.JokeSkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.JokeSkill" + module: "com.signalwire.sdk.skills.builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java) + +Line 47. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-swaig-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-swaig-functions.mdx new file mode 100644 index 0000000000..42fe8e06c2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-swaig-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/get-swaig-functions" +title: "getSwaigFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.JokeSkill.getSwaigFunctions" + parent: "com.signalwire.sdk.skills.builtin.JokeSkill" + module: "com.signalwire.sdk.skills.builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java" + visibility: "public" +--- +# `getSwaigFunctions` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getSwaigFunctions() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java) + +Line 33. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/index.mdx new file mode 100644 index 0000000000..dda4109d37 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill" +title: "JokeSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.JokeSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java" + visibility: "public" +--- +# `JokeSkill` + +## Signature + +```java +public class JokeSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java) + +Line 10. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/init.mdx new file mode 100644 index 0000000000..ad3536c9ec --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.JokeSkill." + parent: "com.signalwire.sdk.skills.builtin.JokeSkill" + module: "com.signalwire.sdk.skills.builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/register-tools.mdx new file mode 100644 index 0000000000..0595b36065 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.JokeSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.JokeSkill" + module: "com.signalwire.sdk.skills.builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/setup.mdx new file mode 100644 index 0000000000..31ac10aef5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/joke-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.JokeSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.JokeSkill" + module: "com.signalwire.sdk.skills.builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/JokeSkill.java) + +Line 18. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-description.mdx new file mode 100644 index 0000000000..9c4cf82ba3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.MathSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.MathSkill" + module: "com.signalwire.sdk.skills.builtin.MathSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java) + +Line 12. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-name.mdx new file mode 100644 index 0000000000..b592fa49d8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.MathSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.MathSkill" + module: "com.signalwire.sdk.skills.builtin.MathSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java) + +Line 11. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..242472b53e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.MathSkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.MathSkill" + module: "com.signalwire.sdk.skills.builtin.MathSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java) + +Line 138. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/index.mdx new file mode 100644 index 0000000000..32510484c0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill" +title: "MathSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.MathSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java" + visibility: "public" +--- +# `MathSkill` + +## Signature + +```java +public class MathSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java) + +Line 9. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/init.mdx new file mode 100644 index 0000000000..4a6c7ed3be --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.MathSkill." + parent: "com.signalwire.sdk.skills.builtin.MathSkill" + module: "com.signalwire.sdk.skills.builtin.MathSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/register-tools.mdx new file mode 100644 index 0000000000..eedb56fd53 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.MathSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.MathSkill" + module: "com.signalwire.sdk.skills.builtin.MathSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/setup.mdx new file mode 100644 index 0000000000..e3945857a4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.MathSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.MathSkill" + module: "com.signalwire.sdk.skills.builtin.MathSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..4e8d2b1b23 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/math-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.MathSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.MathSkill" + module: "com.signalwire.sdk.skills.builtin.MathSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/MathSkill.java) + +Line 13. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-description.mdx new file mode 100644 index 0000000000..5b58f03214 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.McpGatewaySkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + module: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java) + +Line 36. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-global-data.mdx new file mode 100644 index 0000000000..4e052a6ea0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-global-data" +title: "getGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.McpGatewaySkill.getGlobalData" + parent: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + module: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java" + visibility: "public" +--- +# `getGlobalData` + +**Decorators:** `@Override` + +## Signature + +```java +public Map getGlobalData() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java) + +Line 142. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-hints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-hints.mdx new file mode 100644 index 0000000000..b9997f8554 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-hints" +title: "getHints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.McpGatewaySkill.getHints" + parent: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + module: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java" + visibility: "public" +--- +# `getHints` + +**Decorators:** `@Override` + +## Signature + +```java +public List getHints() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java) + +Line 127. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-name.mdx new file mode 100644 index 0000000000..4dc71ebc86 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.McpGatewaySkill.getName" + parent: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + module: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java) + +Line 35. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..dea2d603ef --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.McpGatewaySkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + module: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java) + +Line 134. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/index.mdx new file mode 100644 index 0000000000..158c6b4913 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill" +title: "McpGatewaySkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java" + visibility: "public" +--- +# `McpGatewaySkill` + +Bridge MCP (Model Context Protocol) servers with SWAIG functions. + +## Signature + +```java +public class McpGatewaySkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java) + +Line 21. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/init.mdx new file mode 100644 index 0000000000..4fc9b3506a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.McpGatewaySkill." + parent: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + module: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/register-tools.mdx new file mode 100644 index 0000000000..8bd8a1a7a2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.McpGatewaySkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + module: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java) + +Line 122. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/setup.mdx new file mode 100644 index 0000000000..e4ae2c0c19 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/mcp-gateway-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.McpGatewaySkill.setup" + parent: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + module: "com.signalwire.sdk.skills.builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/McpGatewaySkill.java) + +Line 38. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-description.mdx new file mode 100644 index 0000000000..e2caef1312 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + module: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java) + +Line 32. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-hints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-hints.mdx new file mode 100644 index 0000000000..578d4fe4e0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-hints" +title: "getHints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill.getHints" + parent: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + module: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java" + visibility: "public" +--- +# `getHints` + +**Decorators:** `@Override` + +## Signature + +```java +public List getHints() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java) + +Line 102. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-name.mdx new file mode 100644 index 0000000000..dc36f357f0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + module: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java) + +Line 31. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/index.mdx new file mode 100644 index 0000000000..209450bf79 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill" +title: "NativeVectorSearchSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java" + visibility: "public" +--- +# `NativeVectorSearchSkill` + +Native vector search skill - supports remote mode only (network API). +Local .swsearch file support is skipped per porting guide. + +## Signature + +```java +public class NativeVectorSearchSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/init.mdx new file mode 100644 index 0000000000..6d3e4a2935 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill." + parent: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + module: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/register-tools.mdx new file mode 100644 index 0000000000..01b02be716 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + module: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java) + +Line 47. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/setup.mdx new file mode 100644 index 0000000000..7ad2ce01a1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + module: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java) + +Line 35. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..b89e1ac985 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/native-vector-search-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + module: "com.signalwire.sdk.skills.builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/NativeVectorSearchSkill.java) + +Line 33. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-description.mdx new file mode 100644 index 0000000000..a6dd7f648f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + module: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java) + +Line 16. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-name.mdx new file mode 100644 index 0000000000..b3b5130952 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + module: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-swaig-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-swaig-functions.mdx new file mode 100644 index 0000000000..b5073f733f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-swaig-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/get-swaig-functions" +title: "getSwaigFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill.getSwaigFunctions" + parent: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + module: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java" + visibility: "public" +--- +# `getSwaigFunctions` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getSwaigFunctions() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/index.mdx new file mode 100644 index 0000000000..b6b2c95fd9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill" +title: "PlayBackgroundFileSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java" + visibility: "public" +--- +# `PlayBackgroundFileSkill` + +## Signature + +```java +public class PlayBackgroundFileSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java) + +Line 10. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/init.mdx new file mode 100644 index 0000000000..c4054bcae9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill." + parent: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + module: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/register-tools.mdx new file mode 100644 index 0000000000..47c02d9306 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + module: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/setup.mdx new file mode 100644 index 0000000000..633c06a95b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + module: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..7353876cef --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/play-background-file-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + module: "com.signalwire.sdk.skills.builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/PlayBackgroundFileSkill.java) + +Line 17. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-description.mdx new file mode 100644 index 0000000000..c77c8d4b97 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SpiderSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.SpiderSkill" + module: "com.signalwire.sdk.skills.builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java) + +Line 24. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-hints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-hints.mdx new file mode 100644 index 0000000000..6cc858f45b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-hints" +title: "getHints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SpiderSkill.getHints" + parent: "com.signalwire.sdk.skills.builtin.SpiderSkill" + module: "com.signalwire.sdk.skills.builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java" + visibility: "public" +--- +# `getHints` + +**Decorators:** `@Override` + +## Signature + +```java +public List getHints() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java) + +Line 120. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-name.mdx new file mode 100644 index 0000000000..419992d526 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SpiderSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.SpiderSkill" + module: "com.signalwire.sdk.skills.builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/index.mdx new file mode 100644 index 0000000000..d0f4417d17 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill" +title: "SpiderSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SpiderSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java" + visibility: "public" +--- +# `SpiderSkill` + +## Signature + +```java +public class SpiderSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java) + +Line 15. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/init.mdx new file mode 100644 index 0000000000..4a5b53267a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SpiderSkill." + parent: "com.signalwire.sdk.skills.builtin.SpiderSkill" + module: "com.signalwire.sdk.skills.builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/register-tools.mdx new file mode 100644 index 0000000000..1ccbad41b8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SpiderSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.SpiderSkill" + module: "com.signalwire.sdk.skills.builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java) + +Line 35. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/setup.mdx new file mode 100644 index 0000000000..f49ab29bf1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SpiderSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.SpiderSkill" + module: "com.signalwire.sdk.skills.builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..cae3949025 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/spider-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SpiderSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.SpiderSkill" + module: "com.signalwire.sdk.skills.builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SpiderSkill.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-description.mdx new file mode 100644 index 0000000000..dfbd09e947 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + module: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-hints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-hints.mdx new file mode 100644 index 0000000000..b620fe50d1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-hints" +title: "getHints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill.getHints" + parent: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + module: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java" + visibility: "public" +--- +# `getHints` + +**Decorators:** `@Override` + +## Signature + +```java +public List getHints() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java) + +Line 82. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-name.mdx new file mode 100644 index 0000000000..b67356f676 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + module: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..d8aeebb702 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + module: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java) + +Line 91. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-swaig-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-swaig-functions.mdx new file mode 100644 index 0000000000..6f7c636f86 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-swaig-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/get-swaig-functions" +title: "getSwaigFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill.getSwaigFunctions" + parent: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + module: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java" + visibility: "public" +--- +# `getSwaigFunctions` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getSwaigFunctions() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java) + +Line 42. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/index.mdx new file mode 100644 index 0000000000..45d0e046fe --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill" +title: "SwmlTransferSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java" + visibility: "public" +--- +# `SwmlTransferSkill` + +## Signature + +```java +public class SwmlTransferSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java) + +Line 10. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/init.mdx new file mode 100644 index 0000000000..8073f8ccd3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill." + parent: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + module: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/register-tools.mdx new file mode 100644 index 0000000000..3fb0652b26 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + module: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/setup.mdx new file mode 100644 index 0000000000..f02521ac9e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + module: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..74a6f34a96 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/swml-transfer-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + module: "com.signalwire.sdk.skills.builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/SwmlTransferSkill.java) + +Line 21. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-description.mdx new file mode 100644 index 0000000000..9ab1bd7397 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WeatherApiSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + module: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java) + +Line 17. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-name.mdx new file mode 100644 index 0000000000..deff53cf41 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WeatherApiSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + module: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java) + +Line 16. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-swaig-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-swaig-functions.mdx new file mode 100644 index 0000000000..182a5a8bc0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-swaig-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/get-swaig-functions" +title: "getSwaigFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WeatherApiSkill.getSwaigFunctions" + parent: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + module: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java" + visibility: "public" +--- +# `getSwaigFunctions` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getSwaigFunctions() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java) + +Line 36. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/index.mdx new file mode 100644 index 0000000000..b4d509ed12 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill" +title: "WeatherApiSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java" + visibility: "public" +--- +# `WeatherApiSkill` + +## Signature + +```java +public class WeatherApiSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java) + +Line 10. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/init.mdx new file mode 100644 index 0000000000..4a49ae626b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WeatherApiSkill." + parent: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + module: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/register-tools.mdx new file mode 100644 index 0000000000..c6c12390f3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WeatherApiSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + module: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java) + +Line 31. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/setup.mdx new file mode 100644 index 0000000000..28daf7b967 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/weather-api-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WeatherApiSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + module: "com.signalwire.sdk.skills.builtin.WeatherApiSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WeatherApiSkill.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-description.mdx new file mode 100644 index 0000000000..af76f58f54 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WebSearchSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java) + +Line 35. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..063aac8d8e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-global-data" +title: "getGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WebSearchSkill.getGlobalData" + parent: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java" + visibility: "public" +--- +# `getGlobalData` + +**Decorators:** `@Override` + +## Signature + +```java +public Map getGlobalData() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java) + +Line 163. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-name.mdx new file mode 100644 index 0000000000..c14578ccb6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WebSearchSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..0011c4aa76 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WebSearchSkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java) + +Line 150. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-version.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-version.mdx new file mode 100644 index 0000000000..fd42b114cf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-version.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/get-version" +title: "getVersion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WebSearchSkill.getVersion" + parent: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java" + visibility: "public" +--- +# `getVersion` + +**Decorators:** `@Override` + +## Signature + +```java +public String getVersion() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java) + +Line 36. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/index.mdx new file mode 100644 index 0000000000..7b2eb4bf41 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill" +title: "WebSearchSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java" + visibility: "public" +--- +# `WebSearchSkill` + +## Signature + +```java +public class WebSearchSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java) + +Line 18. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/init.mdx new file mode 100644 index 0000000000..40b6854a46 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WebSearchSkill." + parent: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/register-tools.mdx new file mode 100644 index 0000000000..d39d8f3ce4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WebSearchSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java) + +Line 60. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/setup.mdx new file mode 100644 index 0000000000..a793497e6b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WebSearchSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java) + +Line 39. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..6b78b8d6f9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/web-search-skill/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WebSearchSkill.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WebSearchSkill.java) + +Line 37. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-description.mdx new file mode 100644 index 0000000000..64a7317b7e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill.getDescription" + parent: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java" + visibility: "public" +--- +# `getDescription` + +**Decorators:** `@Override` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java) + +Line 26. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-name.mdx new file mode 100644 index 0000000000..685e209d9b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill.getName" + parent: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java" + visibility: "public" +--- +# `getName` + +**Decorators:** `@Override` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..3eba0fe74a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill.getPromptSections" + parent: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java" + visibility: "public" +--- +# `getPromptSections` + +**Decorators:** `@Override` + +## Signature + +```java +public List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java) + +Line 106. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/index.mdx new file mode 100644 index 0000000000..da9442076a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill" +title: "WikipediaSearchSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + parent: "com.signalwire.sdk.skills.builtin" + module: "com.signalwire.sdk.skills.builtin" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java" + visibility: "public" +--- +# `WikipediaSearchSkill` + +## Signature + +```java +public class WikipediaSearchSkill implements SkillBase +``` + +## Inheritance + +**Implements:** [SkillBase](/reference/java/com/signalwire/sdk/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java) + +Line 18. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/init.mdx new file mode 100644 index 0000000000..88e48f0913 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/init.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill." + parent: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java) diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/register-tools.mdx new file mode 100644 index 0000000000..ed03126579 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill.registerTools" + parent: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java" + visibility: "public" +--- +# `registerTools` + +**Decorators:** `@Override` `@SuppressWarnings` + +## Signature + +```java +public List registerTools() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java) + +Line 40. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/setup.mdx new file mode 100644 index 0000000000..df4a87ce71 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/builtin/builtin/wikipedia-search-skill/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill.setup" + parent: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + module: "com.signalwire.sdk.skills.builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java" + visibility: "public" +--- +# `setup` + +**Decorators:** `@Override` + +## Signature + +```java +public boolean setup(Map params) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/builtin/WikipediaSearchSkill.java) + +Line 28. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/index.mdx new file mode 100644 index 0000000000..c3423bec48 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills" +title: "skills" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.skills" + module: "com.signalwire.sdk.skills" +--- +# `skills` + +## Signature + +```java +package com.signalwire.sdk.skills +``` + +## Classes + + + + Manages skill lifecycle: instantiation, validation, registration with the agent. + + + + Static registry of all available skills. Skills are registered by name and can be instantiated on demand. <p>The class also exposes a small per-instance surface for Python-parity: an instance constructor and `#addSkillDirectory(String)` mirror Python's `SkillRegistry().add_skill_directory(path)`. + + + +## Interfaces + + + + Interface for all skills. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/cleanup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/cleanup.mdx new file mode 100644 index 0000000000..edd8299296 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/cleanup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/cleanup" +title: "cleanup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.cleanup" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `cleanup` + +Cleanup resources. + +**Modifiers:** `default` + +## Signature + +```java +default void cleanup() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 68. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-description.mdx new file mode 100644 index 0000000000..fb8d40d000 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getDescription" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getDescription` + +Human-readable description. + +## Signature + +```java +String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 17. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-extra-fields.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-extra-fields.mdx new file mode 100644 index 0000000000..0f30935e5a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-extra-fields.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-extra-fields" +title: "getExtraFields" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getExtraFields" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getExtraFields` + +Get extra fields to merge into all tool definitions (e.g., fillers). + +**Modifiers:** `default` + +## Signature + +```java +default Map getExtraFields() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 83. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-global-data.mdx new file mode 100644 index 0000000000..41dba47f00 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-global-data" +title: "getGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getGlobalData" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getGlobalData` + +Get global data to merge into the agent. + +**Modifiers:** `default` + +## Signature + +```java +default Map getGlobalData() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 52. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-hints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-hints.mdx new file mode 100644 index 0000000000..8151bba3b1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-hints" +title: "getHints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getHints" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getHints` + +Get speech recognition hints for this skill. + +**Modifiers:** `default` + +## Signature + +```java +default List getHints() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 47. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-instance-key.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-instance-key.mdx new file mode 100644 index 0000000000..45fda9d01e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-instance-key.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-instance-key" +title: "getInstanceKey" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getInstanceKey" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getInstanceKey` + +Get unique instance key (for multi-instance skills). + +**Modifiers:** `default` + +## Signature + +```java +default String getInstanceKey() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 78. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-name.mdx new file mode 100644 index 0000000000..50e83e4e6f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getName" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getName` + +Unique skill name. + +## Signature + +```java +String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 14. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-parameter-schema.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-parameter-schema.mdx new file mode 100644 index 0000000000..13fb9d0832 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getParameterSchema" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getParameterSchema` + +Get parameter schema for GUI tools. + +**Modifiers:** `default` + +## Signature + +```java +default Map getParameterSchema() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 73. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-prompt-sections.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-prompt-sections.mdx new file mode 100644 index 0000000000..4eb2f3decb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-prompt-sections.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-prompt-sections" +title: "getPromptSections" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getPromptSections" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent. +Each section is a map with: title, body, bullets (optional) + +**Modifiers:** `default` + +## Signature + +```java +default List> getPromptSections() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 58. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-required-env-vars.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-required-env-vars.mdx new file mode 100644 index 0000000000..61af1cff3a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-required-env-vars.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getRequiredEnvVars" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getRequiredEnvVars` + +Required environment variables. + +**Modifiers:** `default` + +## Signature + +```java +default List getRequiredEnvVars() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 26. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-required-packages.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-required-packages.mdx new file mode 100644 index 0000000000..173dd0864c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-required-packages.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-required-packages" +title: "getRequiredPackages" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getRequiredPackages" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getRequiredPackages` + +Required packages (informational). + +**Modifiers:** `default` + +## Signature + +```java +default List getRequiredPackages() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-swaig-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-swaig-functions.mdx new file mode 100644 index 0000000000..49a42f9b04 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-swaig-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-swaig-functions" +title: "getSwaigFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getSwaigFunctions" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getSwaigFunctions` + +Get SWAIG functions (for DataMap-based skills that bypass handlers). + +**Modifiers:** `default` + +## Signature + +```java +default List> getSwaigFunctions() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 63. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-version.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-version.mdx new file mode 100644 index 0000000000..209492ab7f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/get-version.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/get-version" +title: "getVersion" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.getVersion" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `getVersion` + +Semantic version string. + +**Modifiers:** `default` + +## Signature + +```java +default String getVersion() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/index.mdx new file mode 100644 index 0000000000..5e94e65f09 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/index.mdx @@ -0,0 +1,101 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base" +title: "SkillBase" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "interface" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase" + parent: "com.signalwire.sdk.skills" + module: "com.signalwire.sdk.skills" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `SkillBase` + +Interface for all skills. + +Skills are modular capabilities that can be +added to agents to provide tools, prompts, hints, and global data. + +## Signature + +```java +public interface SkillBase +``` + +## Methods + + + + Cleanup resources. + + + + Human-readable description. + + + + Get extra fields to merge into all tool definitions (e.g., fillers). + + + + Get global data to merge into the agent. + + + + Get speech recognition hints for this skill. + + + + Get unique instance key (for multi-instance skills). + + + + Unique skill name. + + + + Get parameter schema for GUI tools. + + + + Get prompt sections to inject into the agent. Each section is a map with: title, body, bullets (optional) + + + + Required environment variables. + + + + Required packages (informational). + + + + Get SWAIG functions (for DataMap-based skills that bypass handlers). + + + + Semantic version string. + + + + Register tools with the agent. + + + + Initialize the skill with parameters. + + + + Whether multiple instances can be loaded with different configs. + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 11. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/register-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/register-tools.mdx new file mode 100644 index 0000000000..9504a59831 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/register-tools" +title: "registerTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.registerTools" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `registerTools` + +Register tools with the agent. + +## Signature + +```java +List registerTools() +``` + +## Returns + +`List` — List of tool definitions to register + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 42. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/setup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/setup.mdx new file mode 100644 index 0000000000..81c023efb3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/setup.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/setup" +title: "setup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.setup" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `setup` + +Initialize the skill with parameters. + +## Signature + +```java +boolean setup(Map params) +``` + +## Parameters + + + Configuration parameters + + +## Returns + +`boolean` — true if setup succeeded + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 36. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/supports-multiple-instances.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/supports-multiple-instances.mdx new file mode 100644 index 0000000000..8ee4b2f71c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-base/supports-multiple-instances.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-base/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillBase.supportsMultipleInstances" + parent: "com.signalwire.sdk.skills.SkillBase" + module: "com.signalwire.sdk.skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java" + visibility: "public" +--- +# `supportsMultipleInstances` + +Whether multiple instances can be loaded with different configs. + +**Modifiers:** `default` + +## Signature + +```java +default boolean supportsMultipleInstances() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillBase.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillBase.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/add-skill.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/add-skill.mdx new file mode 100644 index 0000000000..2b9571e0ba --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/add-skill.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-manager/add-skill" +title: "addSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillManager.addSkill" + parent: "com.signalwire.sdk.skills.SkillManager" + module: "com.signalwire.sdk.skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java" + visibility: "public" +--- +# `addSkill` + +Add a skill to the agent. +1\. + +Get skill factory from registry +2\. Create instance +3\. Check for duplicates +4\. Validate env vars +5\. Call setup() +6\. Register tools +7\. Merge hints +8\. Merge global data +9\. Add prompt sections + +## Signature + +```java +public void addSkill(String skillName, Map params) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillManager.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java) + +Line 35. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/cleanup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/cleanup.mdx new file mode 100644 index 0000000000..5832a20715 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/cleanup.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-manager/cleanup" +title: "cleanup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillManager.cleanup" + parent: "com.signalwire.sdk.skills.SkillManager" + module: "com.signalwire.sdk.skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java" + visibility: "public" +--- +# `cleanup` + +Cleanup all skills. + +## Signature + +```java +public void cleanup() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillManager.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java) + +Line 159. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/has-skill.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/has-skill.mdx new file mode 100644 index 0000000000..ce455565b1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/has-skill.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-manager/has-skill" +title: "hasSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillManager.hasSkill" + parent: "com.signalwire.sdk.skills.SkillManager" + module: "com.signalwire.sdk.skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java" + visibility: "public" +--- +# `hasSkill` + +Check if a skill is active. + +## Signature + +```java +public boolean hasSkill(String skillName) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillManager.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java) + +Line 152. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/index.mdx new file mode 100644 index 0000000000..780a82e3f0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-manager" +title: "SkillManager" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillManager" + parent: "com.signalwire.sdk.skills" + module: "com.signalwire.sdk.skills" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java" + visibility: "public" +--- +# `SkillManager` + +Manages skill lifecycle: instantiation, validation, registration with the agent. + +## Signature + +```java +public class SkillManager +``` + +## Methods + + + + + + Add a skill to the agent. 1. + + + + Cleanup all skills. + + + + Check if a skill is active. + + + + List active skill instance keys. + + + + Remove a skill from the agent. + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillManager.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java) + +Line 12. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/init.mdx new file mode 100644 index 0000000000..075130723b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/init.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-manager/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillManager." + parent: "com.signalwire.sdk.skills.SkillManager" + module: "com.signalwire.sdk.skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public (AgentBase agent) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillManager.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/list-skills.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/list-skills.mdx new file mode 100644 index 0000000000..03f8e6d084 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/list-skills.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-manager/list-skills" +title: "listSkills" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillManager.listSkills" + parent: "com.signalwire.sdk.skills.SkillManager" + module: "com.signalwire.sdk.skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java" + visibility: "public" +--- +# `listSkills` + +List active skill instance keys. + +## Signature + +```java +public List listSkills() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillManager.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java) + +Line 145. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/remove-skill.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/remove-skill.mdx new file mode 100644 index 0000000000..27220704b2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-manager/remove-skill.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-manager/remove-skill" +title: "removeSkill" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillManager.removeSkill" + parent: "com.signalwire.sdk.skills.SkillManager" + module: "com.signalwire.sdk.skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java" + visibility: "public" +--- +# `removeSkill` + +Remove a skill from the agent. + +## Signature + +```java +public void removeSkill(String skillName) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillManager.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillManager.java) + +Line 134. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/add-skill-directory.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/add-skill-directory.mdx new file mode 100644 index 0000000000..9da5b0f00f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/add-skill-directory.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-registry/add-skill-directory" +title: "addSkillDirectory" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillRegistry.addSkillDirectory" + parent: "com.signalwire.sdk.skills.SkillRegistry" + module: "com.signalwire.sdk.skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java" + visibility: "public" +--- +# `addSkillDirectory` + +Add a directory to search for skills. + +<p>Mirrors Python's +`signalwire.skills.registry.SkillRegistry.add_skill_directory`: +validate that the path exists and is a directory, then append it +(de-duplicated) to `externalPaths`. + +Throws +`IllegalArgumentException` (the Java analog of Python's +`ValueError`) for non-existent paths or non-directories. + +**Modifiers:** `synchronized` + +## Signature + +```java +public synchronized void addSkillDirectory(String path) +``` + +## Parameters + + + absolute or relative path to a directory containing skill subdirectories + + +## Throws + +- `IllegalArgumentException` — when the path doesn't exist or isn't a directory. + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillRegistry.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java) + +Line 110. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/get-all-skills-schema.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/get-all-skills-schema.mdx new file mode 100644 index 0000000000..269b99a30c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/get-all-skills-schema.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-registry/get-all-skills-schema" +title: "getAllSkillsSchema" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillRegistry.getAllSkillsSchema" + parent: "com.signalwire.sdk.skills.SkillRegistry" + module: "com.signalwire.sdk.skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java" + visibility: "public" +--- +# `getAllSkillsSchema` + +Get complete schema for all registered skills. + +<p>Mirrors Python's instance-method +`SkillRegistry.get_all_skills_schema()` — returns a map +keyed by skill name where each value contains parameter metadata. +Java skills don't carry rich Python-style parameter introspection +in v1, so the value defaults to a minimal shape with the skill +name; built-in skills that expose `getSkillDescription` / +`getSkillVersion` get those merged in. + +## Signature + +```java +public Map> getAllSkillsSchema() +``` + +## Returns + +`Map>` — ordered map of skill name to schema metadata + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillRegistry.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java) + +Line 146. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/get-external-paths.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/get-external-paths.mdx new file mode 100644 index 0000000000..921cbeb845 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/get-external-paths.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-registry/get-external-paths" +title: "getExternalPaths" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillRegistry.getExternalPaths" + parent: "com.signalwire.sdk.skills.SkillRegistry" + module: "com.signalwire.sdk.skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java" + visibility: "public" +--- +# `getExternalPaths` + +Returns an immutable copy of the registered external skill +directories. + +Parity surface for Python's `_external_paths`. + +**Modifiers:** `synchronized` + +## Signature + +```java +public synchronized List getExternalPaths() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillRegistry.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java) + +Line 129. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/get.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/get.mdx new file mode 100644 index 0000000000..dc3884b485 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/get.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-registry/get" +title: "get" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillRegistry.get" + parent: "com.signalwire.sdk.skills.SkillRegistry" + module: "com.signalwire.sdk.skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java" + visibility: "public" +--- +# `get` + +Get a new instance of a skill by name. + +**Modifiers:** `static` + +## Signature + +```java +public static SkillBase get(String name) +``` + +## Parameters + + + +## Returns + +`SkillBase` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillRegistry.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java) + +Line 66. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/has.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/has.mdx new file mode 100644 index 0000000000..c00bb648de --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/has.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-registry/has" +title: "has" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillRegistry.has" + parent: "com.signalwire.sdk.skills.SkillRegistry" + module: "com.signalwire.sdk.skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java" + visibility: "public" +--- +# `has` + +Check if a skill is registered. + +**Modifiers:** `static` + +## Signature + +```java +public static boolean has(String name) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillRegistry.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java) + +Line 77. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/index.mdx new file mode 100644 index 0000000000..f53e231256 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-registry" +title: "SkillRegistry" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillRegistry" + parent: "com.signalwire.sdk.skills" + module: "com.signalwire.sdk.skills" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java" + visibility: "public" +--- +# `SkillRegistry` + +Static registry of all available skills. +Skills are registered by name and can be instantiated on demand. + +<p>The class also exposes a small per-instance surface for +Python-parity: an instance constructor and `#addSkillDirectory(String)` +mirror Python's `SkillRegistry().add_skill_directory(path)`. + +The +static registry is kept for the existing Java idiom; instance state is +limited to the external skill directories list. + +**Modifiers:** `final` + +## Signature + +```java +public final class SkillRegistry +``` + +## Methods + + + + Public no-arg constructor so callers can manage their own external-paths list. + + + + Add a directory to search for skills. <p>Mirrors Python's `signalwire.skills.registry.SkillRegistry.add_skill_directory`: validate that the path exists and is a directory, then append it (de-duplicated) to `externalPaths`. + + + + Get a new instance of a skill by name. + + + + Get complete schema for all registered skills. <p>Mirrors Python's instance-method `SkillRegistry.get_all_skills_schema()` — returns a map keyed by skill name where each value contains parameter metadata. Java skills don't carry rich Python-style parameter introspection in v1, so the value defaults to a minimal shape with the skill name; built-in skills that expose `getSkillDescription` / `getSkillVersion` get those merged in. + + + + Returns an immutable copy of the registered external skill directories. + + + + Check if a skill is registered. + + + + List all registered skill names. + + + + Register a skill factory. + + + + Unregister a skill (for testing). + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillRegistry.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java) + +Line 21. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/init.mdx new file mode 100644 index 0000000000..dd5f453553 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-registry/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillRegistry." + parent: "com.signalwire.sdk.skills.SkillRegistry" + module: "com.signalwire.sdk.skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java" + visibility: "public" +--- +# `` + +Public no-arg constructor so callers can manage their own +external-paths list. + +The static registry is unaffected. + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillRegistry.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java) + +Line 53. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/list.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/list.mdx new file mode 100644 index 0000000000..1c86685ee2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-registry/list" +title: "list" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillRegistry.list" + parent: "com.signalwire.sdk.skills.SkillRegistry" + module: "com.signalwire.sdk.skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java" + visibility: "public" +--- +# `list` + +List all registered skill names. + +**Modifiers:** `static` + +## Signature + +```java +public static Set list() +``` + +## Returns + +`Set` + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillRegistry.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java) + +Line 84. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/register.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/register.mdx new file mode 100644 index 0000000000..7b83f021aa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/register.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-registry/register" +title: "register" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillRegistry.register" + parent: "com.signalwire.sdk.skills.SkillRegistry" + module: "com.signalwire.sdk.skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java" + visibility: "public" +--- +# `register` + +Register a skill factory. + +**Modifiers:** `static` + +## Signature + +```java +public static void register(String name, Supplier factory) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillRegistry.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java) + +Line 58. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/unregister.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/unregister.mdx new file mode 100644 index 0000000000..238361ae4f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/skills/skills/skill-registry/unregister.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/skills/skills/skill-registry/unregister" +title: "unregister" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.skills.SkillRegistry.unregister" + parent: "com.signalwire.sdk.skills.SkillRegistry" + module: "com.signalwire.sdk.skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java" + visibility: "public" +--- +# `unregister` + +Unregister a skill (for testing). + +**Modifiers:** `static` + +## Signature + +```java +public static void unregister(String name) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/skills/SkillRegistry.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/skills/SkillRegistry.java) + +Line 91. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-action.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-action.mdx new file mode 100644 index 0000000000..9f8292fedd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-action.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-action" +title: "addAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.addAction" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `addAction` + +Add a single action to the response. + +## Signature + +```java +public FunctionResult addAction(String name, Object data) +``` + +## Parameters + + + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 63. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-actions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-actions.mdx new file mode 100644 index 0000000000..59329b2c77 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-actions.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-actions" +title: "addActions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.addActions" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `addActions` + +Add multiple actions. + +## Signature + +```java +public FunctionResult addActions(List> actionList) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 73. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-dynamic-hints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-dynamic-hints.mdx new file mode 100644 index 0000000000..b7f5d8d8aa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-dynamic-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/add-dynamic-hints" +title: "addDynamicHints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.addDynamicHints" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `addDynamicHints` + +## Signature + +```java +public FunctionResult addDynamicHints(List hints) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 316. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/clear-dynamic-hints.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/clear-dynamic-hints.mdx new file mode 100644 index 0000000000..5a68c1cffa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/clear-dynamic-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/clear-dynamic-hints" +title: "clearDynamicHints" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.clearDynamicHints" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `clearDynamicHints` + +## Signature + +```java +public FunctionResult clearDynamicHints() +``` + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 320. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/connect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/connect.mdx new file mode 100644 index 0000000000..1c4079c5fe --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/connect.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/connect" +title: "connect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.connect" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `connect` + +Connect/transfer the call to another destination via SWML connect verb. + +## Signature + + + + ```java + public FunctionResult connect(String destination, boolean isFinal, String from) + ``` + + + + ```java + public FunctionResult connect(String destination, boolean isFinal) + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`FunctionResult` + +## Returns (Overload 2) + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 83. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-action.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-action.mdx new file mode 100644 index 0000000000..23dcda8467 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-action.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-action" +title: "createPaymentAction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.createPaymentAction" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `createPaymentAction` + +**Modifiers:** `static` + +## Signature + +```java +public static Map createPaymentAction( + String actionType, + String phrase +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 579. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-parameter.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-parameter.mdx new file mode 100644 index 0000000000..4804e4ceac --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-parameter.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-parameter" +title: "createPaymentParameter" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.createPaymentParameter" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `createPaymentParameter` + +**Modifiers:** `static` + +## Signature + +```java +public static Map createPaymentParameter( + String name, + String value +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 583. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-prompt.mdx new file mode 100644 index 0000000000..c59b60ad96 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-prompt.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/create-payment-prompt" +title: "createPaymentPrompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.createPaymentPrompt" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `createPaymentPrompt` + +**Modifiers:** `static` + +## Signature + +```java +public static Map createPaymentPrompt( + String forSituation, + List> payActions, + String cardType, + String errorType +) +``` + +## Parameters + + + + + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 568. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/enable-extensive-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/enable-extensive-data.mdx new file mode 100644 index 0000000000..9d033aeef2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/enable-extensive-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/enable-extensive-data" +title: "enableExtensiveData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.enableExtensiveData" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `enableExtensiveData` + +## Signature + +```java +public FunctionResult enableExtensiveData(boolean enabled) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 343. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/enable-functions-on-timeout.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/enable-functions-on-timeout.mdx new file mode 100644 index 0000000000..c681dac064 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/enable-functions-on-timeout.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/enable-functions-on-timeout" +title: "enableFunctionsOnTimeout" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.enableFunctionsOnTimeout" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `enableFunctionsOnTimeout` + +## Signature + +```java +public FunctionResult enableFunctionsOnTimeout(boolean enabled) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 339. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/execute-rpc.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/execute-rpc.mdx new file mode 100644 index 0000000000..0fde90694c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/execute-rpc.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/execute-rpc" +title: "executeRpc" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.executeRpc" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `executeRpc` + +Execute an RPC method via SWML. + +## Signature + + + + ```java + public FunctionResult executeRpc( + String method, + Map params, + String callId, + String nodeId + ) + ``` + + + + ```java + public FunctionResult executeRpc(String method, Map params) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + +## Parameters (Overload 2) + + + + + +## Returns (Overload 1) + +`FunctionResult` + +## Returns (Overload 2) + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 513. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/execute-swml.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/execute-swml.mdx new file mode 100644 index 0000000000..7c570cc693 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/execute-swml.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/execute-swml" +title: "executeSwml" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.executeSwml" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `executeSwml` + +Execute SWML content with optional transfer behavior. + +## Signature + + + + ```java + public FunctionResult executeSwml(Object swmlContent, boolean transfer) + ``` + + + + ```java + public FunctionResult executeSwml(Object swmlContent) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`FunctionResult` + +## Returns (Overload 2) + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 359. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/get-actions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/get-actions.mdx new file mode 100644 index 0000000000..20d5e67c42 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/get-actions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/get-actions" +title: "getActions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.getActions" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `getActions` + +## Signature + +```java +public List> getActions() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 622. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/get-response.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/get-response.mdx new file mode 100644 index 0000000000..5bcf189ee3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/get-response.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/get-response" +title: "getResponse" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.getResponse" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `getResponse` + +## Signature + +```java +public String getResponse() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 618. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/hangup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/hangup.mdx new file mode 100644 index 0000000000..8be528811d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/hangup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/hangup" +title: "hangup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.hangup" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `hangup` + +Hangup the call. + +## Signature + +```java +public FunctionResult hangup() +``` + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 124. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/hold.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/hold.mdx new file mode 100644 index 0000000000..588badb42c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/hold.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/hold" +title: "hold" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.hold" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `hold` + +Put the call on hold (timeout clamped 0-900). + +## Signature + +```java +public FunctionResult hold(int timeout) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 131. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/index.mdx new file mode 100644 index 0000000000..11ea0ec47c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/index.mdx @@ -0,0 +1,222 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result" +title: "FunctionResult" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult" + parent: "com.signalwire.sdk.swaig" + module: "com.signalwire.sdk.swaig" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `FunctionResult` + +SwaigFunctionResult - the response builder returned by tool handlers. + +<p> +Every method returns `this` for fluent chaining. + +Contains 40+ action methods +covering call control, state management, media, speech/AI config, and advanced features. + +<p> +Serialization rules: +<ul> + <li>response - always included (string)</li> + <li>action - only included if at least one action exists (array of objects)</li> + <li>post_process - only included if true and actions exist (boolean)</li> +</ul> + +## Signature + +```java +public class FunctionResult +``` + +## Methods + + + + + + Add a single action to the response. + + + + Add multiple actions. + + + + + + + + Connect/transfer the call to another destination via SWML connect verb. + + + + + + + + + + + + + + Execute an RPC method via SWML. + + + + Execute SWML content with optional transfer behavior. + + + + + + + + Hangup the call. + + + + Put the call on hold (timeout clamped 0-900). + + + + + + Join a conference via SWML. + + + + Join a RELAY room. + + + + Process payment via SWML pay action. + + + + Play audio file in background. + + + + Start background call recording via SWML. + + + + + + + + Replace tool\_call+result pair in conversation history. + + + + Inject a message into an AI agent on another call. + + + + Unhold another call. + + + + Dial out to a number with a destination SWML URL. + + + + + + Send SMS via SWML. + + + + + + + + + + + + + + Queue simulated user input. + + + + Send SIP REFER. + + + + Stop the agent execution. + + + + + + Stop an active background call recording. + + + + Stop a tap stream. + + + + Switch context with optional reset parameters. + + + + Change the conversation context. + + + + Change the conversation step. + + + + SWML transfer with AI response setup. + + + + Send a user event through SWML. + + + + Start call tap. + + + + Toggle specific SWAIG functions on/off. + + + + Render as JSON string. + + + + Convert to the Map structure expected by SWAIG. + + + + + + Update agent runtime settings (temperature, top\_p, etc.). + + + + Control how agent waits for user input. + + + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 26. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/init.mdx new file mode 100644 index 0000000000..48287f2137 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/init.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult." + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public () + ``` + + + + ```java + public (String response) + ``` + + + + ```java + public (String response, boolean postProcess) + ``` + + + +## Parameters (Overload 2) + + + +## Parameters (Overload 3) + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/is-post-process.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/is-post-process.mdx new file mode 100644 index 0000000000..d04471b7b2 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/is-post-process.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/is-post-process" +title: "isPostProcess" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.isPostProcess" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `isPostProcess` + +## Signature + +```java +public boolean isPostProcess() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 626. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/join-conference.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/join-conference.mdx new file mode 100644 index 0000000000..cf7e921b8b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/join-conference.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/join-conference" +title: "joinConference" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.joinConference" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `joinConference` + +Join a conference via SWML. + +## Signature + + + + ```java + public FunctionResult joinConference( + String name, + boolean muted, + String beep, + String holdAudio + ) + ``` + + + + ```java + public FunctionResult joinConference(String name) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`FunctionResult` + +## Returns (Overload 2) + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 390. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/join-room.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/join-room.mdx new file mode 100644 index 0000000000..864fbf2684 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/join-room.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/join-room" +title: "joinRoom" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.joinRoom" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `joinRoom` + +Join a RELAY room. + +## Signature + +```java +public FunctionResult joinRoom(String name) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 415. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/pay.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/pay.mdx new file mode 100644 index 0000000000..dd00871969 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/pay.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/pay" +title: "pay" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.pay" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `pay` + +Process payment via SWML pay action. + +## Signature + +```java +public FunctionResult pay( + String connectorUrl, + String inputMethod, + String statusUrl, + int timeout, + int maxAttempts +) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 488. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/play-background-file.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/play-background-file.mdx new file mode 100644 index 0000000000..5a7d3451f4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/play-background-file.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/play-background-file" +title: "playBackgroundFile" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.playBackgroundFile" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `playBackgroundFile` + +Play audio file in background. + +## Signature + + + + ```java + public FunctionResult playBackgroundFile(String filename, boolean wait) + ``` + + + + ```java + public FunctionResult playBackgroundFile(String filename) + ``` + + + +## Parameters (Overload 1) + + + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`FunctionResult` + +## Returns (Overload 2) + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 257. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/record-call.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/record-call.mdx new file mode 100644 index 0000000000..6281b2ca37 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/record-call.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/record-call" +title: "recordCall" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.recordCall" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `recordCall` + +Start background call recording via SWML. + +## Signature + + + + ```java + public FunctionResult recordCall( + String controlId, + boolean stereo, + String format, + String direction + ) + ``` + + + + ```java + public FunctionResult recordCall() + ``` + + + +## Parameters (Overload 1) + + + + + + + + + +## Returns (Overload 1) + +`FunctionResult` + +## Returns (Overload 2) + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 278. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/remove-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/remove-global-data.mdx new file mode 100644 index 0000000000..a2cdcadd29 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/remove-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/remove-global-data" +title: "removeGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.removeGlobalData" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `removeGlobalData` + +## Signature + +```java +public FunctionResult removeGlobalData(Object keys) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 169. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/remove-metadata.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/remove-metadata.mdx new file mode 100644 index 0000000000..23ebccae84 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/remove-metadata.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/remove-metadata" +title: "removeMetadata" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.removeMetadata" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `removeMetadata` + +## Signature + +```java +public FunctionResult removeMetadata(Object keys) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 177. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/replace-in-history.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/replace-in-history.mdx new file mode 100644 index 0000000000..6592ac6b7b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/replace-in-history.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/replace-in-history" +title: "replaceInHistory" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.replaceInHistory" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `replaceInHistory` + +Replace tool\_call+result pair in conversation history. + +## Signature + + + + ```java + public FunctionResult replaceInHistory(String text) + ``` + + + + ```java + public FunctionResult replaceInHistory(boolean summary) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`FunctionResult` + +## Returns (Overload 2) + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 240. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-ai-message.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-ai-message.mdx new file mode 100644 index 0000000000..096dee677e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-ai-message.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-ai-message" +title: "rpcAiMessage" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.rpcAiMessage" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `rpcAiMessage` + +Inject a message into an AI agent on another call. + +## Signature + +```java +public FunctionResult rpcAiMessage(String callId, String messageText) +``` + +## Parameters + + + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 546. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-ai-unhold.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-ai-unhold.mdx new file mode 100644 index 0000000000..ed0a9f4245 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-ai-unhold.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-ai-unhold" +title: "rpcAiUnhold" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.rpcAiUnhold" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `rpcAiUnhold` + +Unhold another call. + +## Signature + +```java +public FunctionResult rpcAiUnhold(String callId) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 555. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-dial.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-dial.mdx new file mode 100644 index 0000000000..54c8810a02 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-dial.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/rpc-dial" +title: "rpcDial" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.rpcDial" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `rpcDial` + +Dial out to a number with a destination SWML URL. + +## Signature + +```java +public FunctionResult rpcDial( + String toNumber, + String fromNumber, + String destSwml +) +``` + +## Parameters + + + + + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 533. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/say.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/say.mdx new file mode 100644 index 0000000000..8044f0e03d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/say.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/say" +title: "say" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.say" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `say` + +## Signature + +```java +public FunctionResult say(String text) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 250. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/send-sms.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/send-sms.mdx new file mode 100644 index 0000000000..759a215c54 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/send-sms.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/send-sms" +title: "sendSms" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.sendSms" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `sendSms` + +Send SMS via SWML. + +## Signature + +```java +public FunctionResult sendSms( + String toNumber, + String fromNumber, + String body, + List media, + List tags +) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 468. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-end-of-speech-timeout.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-end-of-speech-timeout.mdx new file mode 100644 index 0000000000..f51843e5a5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-end-of-speech-timeout.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-end-of-speech-timeout" +title: "setEndOfSpeechTimeout" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.setEndOfSpeechTimeout" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `setEndOfSpeechTimeout` + +## Signature + +```java +public FunctionResult setEndOfSpeechTimeout(int milliseconds) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 324. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-metadata.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-metadata.mdx new file mode 100644 index 0000000000..0d5db9f7e7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-metadata.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-metadata" +title: "setMetadata" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.setMetadata" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `setMetadata` + +## Signature + +```java +public FunctionResult setMetadata(Map data) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 173. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-post-process.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-post-process.mdx new file mode 100644 index 0000000000..20cc1bd428 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-post-process.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-post-process" +title: "setPostProcess" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.setPostProcess" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `setPostProcess` + +## Signature + +```java +public FunctionResult setPostProcess(boolean postProcess) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 55. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-response.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-response.mdx new file mode 100644 index 0000000000..bfcff61dae --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-response.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-response" +title: "setResponse" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.setResponse" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `setResponse` + +## Signature + +```java +public FunctionResult setResponse(String response) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 50. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-speech-event-timeout.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-speech-event-timeout.mdx new file mode 100644 index 0000000000..4de77c3269 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-speech-event-timeout.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/set-speech-event-timeout" +title: "setSpeechEventTimeout" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.setSpeechEventTimeout" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `setSpeechEventTimeout` + +## Signature + +```java +public FunctionResult setSpeechEventTimeout(int milliseconds) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 328. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/simulate-user-input.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/simulate-user-input.mdx new file mode 100644 index 0000000000..b2ec0473b6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/simulate-user-input.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/simulate-user-input" +title: "simulateUserInput" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.simulateUserInput" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `simulateUserInput` + +Queue simulated user input. + +## Signature + +```java +public FunctionResult simulateUserInput(String text) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 562. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/sip-refer.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/sip-refer.mdx new file mode 100644 index 0000000000..e84ea0e378 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/sip-refer.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/sip-refer" +title: "sipRefer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.sipRefer" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `sipRefer` + +Send SIP REFER. + +## Signature + +```java +public FunctionResult sipRefer(String toUri) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 425. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-background-file.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-background-file.mdx new file mode 100644 index 0000000000..264741b983 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-background-file.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-background-file" +title: "stopBackgroundFile" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.stopBackgroundFile" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `stopBackgroundFile` + +## Signature + +```java +public FunctionResult stopBackgroundFile() +``` + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 271. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-record-call.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-record-call.mdx new file mode 100644 index 0000000000..bc146d7069 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-record-call.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-record-call" +title: "stopRecordCall" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.stopRecordCall" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `stopRecordCall` + +Stop an active background call recording. + +## Signature + + + + ```java + public FunctionResult stopRecordCall(String controlId) + ``` + + + + ```java + public FunctionResult stopRecordCall() + ``` + + + +## Parameters (Overload 1) + + + +## Returns (Overload 1) + +`FunctionResult` + +## Returns (Overload 2) + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 299. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-tap.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-tap.mdx new file mode 100644 index 0000000000..15c06e66dd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-tap.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop-tap" +title: "stopTap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.stopTap" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `stopTap` + +Stop a tap stream. + +## Signature + + + + ```java + public FunctionResult stopTap(String controlId) + ``` + + + + ```java + public FunctionResult stopTap() + ``` + + + +## Parameters (Overload 1) + + + +## Returns (Overload 1) + +`FunctionResult` + +## Returns (Overload 2) + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 450. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop.mdx new file mode 100644 index 0000000000..3e497b78a0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.stop" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `stop` + +Stop the agent execution. + +## Signature + +```java +public FunctionResult stop() +``` + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 159. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/switch-context.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/switch-context.mdx new file mode 100644 index 0000000000..66d58604fd --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/switch-context.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/switch-context" +title: "switchContext" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.switchContext" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `switchContext` + +Switch context with optional reset parameters. + +## Signature + + + + ```java + public FunctionResult switchContext( + String systemPrompt, + String userPrompt, + boolean consolidate, + boolean fullReset + ) + ``` + + + + ```java + public FunctionResult switchContext(String systemPrompt) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`FunctionResult` + +## Returns (Overload 2) + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 210. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-change-context.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-change-context.mdx new file mode 100644 index 0000000000..8d65446a9a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-change-context.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-change-context" +title: "swmlChangeContext" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.swmlChangeContext" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `swmlChangeContext` + +Change the conversation context. + +## Signature + +```java +public FunctionResult swmlChangeContext(String contextName) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 203. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-change-step.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-change-step.mdx new file mode 100644 index 0000000000..fb2362d98c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-change-step.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-change-step" +title: "swmlChangeStep" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.swmlChangeStep" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `swmlChangeStep` + +Change the conversation step. + +## Signature + +```java +public FunctionResult swmlChangeStep(String stepName) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 196. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-transfer.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-transfer.mdx new file mode 100644 index 0000000000..6d154290f1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-transfer.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-transfer" +title: "swmlTransfer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.swmlTransfer" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `swmlTransfer` + +SWML transfer with AI response setup. + +## Signature + +```java +public FunctionResult swmlTransfer( + String dest, + String aiResponse, + boolean isFinal +) +``` + +## Parameters + + + + + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 107. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-user-event.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-user-event.mdx new file mode 100644 index 0000000000..c03e49b537 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-user-event.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/swml-user-event" +title: "swmlUserEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.swmlUserEvent" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `swmlUserEvent` + +Send a user event through SWML. + +## Signature + +```java +public FunctionResult swmlUserEvent(Map eventData) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 184. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/tap.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/tap.mdx new file mode 100644 index 0000000000..fce0c6470d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/tap.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/tap" +title: "tap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.tap" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `tap` + +Start call tap. + +## Signature + +```java +public FunctionResult tap( + String uri, + String controlId, + String direction, + String codec +) +``` + +## Parameters + + + + + + + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 435. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/to-json.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/to-json.mdx new file mode 100644 index 0000000000..be15ee0acc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/to-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/to-json" +title: "toJson" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.toJson" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `toJson` + +Render as JSON string. + +## Signature + +```java +public String toJson() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 612. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/to-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/to-map.mdx new file mode 100644 index 0000000000..ea6a283a3e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/to-map.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/to-map" +title: "toMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.toMap" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `toMap` + +Convert to the Map structure expected by SWAIG. + +## Signature + +```java +public Map toMap() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 592. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/toggle-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/toggle-functions.mdx new file mode 100644 index 0000000000..d1f3636d44 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/toggle-functions.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/toggle-functions" +title: "toggleFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.toggleFunctions" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `toggleFunctions` + +Toggle specific SWAIG functions on/off. + +## Signature + +```java +public FunctionResult toggleFunctions(List> toggles) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 335. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/update-global-data.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/update-global-data.mdx new file mode 100644 index 0000000000..c19f5d6451 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/update-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/update-global-data" +title: "updateGlobalData" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.updateGlobalData" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `updateGlobalData` + +## Signature + +```java +public FunctionResult updateGlobalData(Map data) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 165. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/update-settings.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/update-settings.mdx new file mode 100644 index 0000000000..6e319d77cb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/update-settings.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/update-settings" +title: "updateSettings" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.updateSettings" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `updateSettings` + +Update agent runtime settings (temperature, top\_p, etc.). + +## Signature + +```java +public FunctionResult updateSettings(Map settings) +``` + +## Parameters + + + +## Returns + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 350. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/wait-for-user.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/wait-for-user.mdx new file mode 100644 index 0000000000..4ce09fd23b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/function-result/wait-for-user.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/function-result/wait-for-user" +title: "waitForUser" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.FunctionResult.waitForUser" + parent: "com.signalwire.sdk.swaig.FunctionResult" + module: "com.signalwire.sdk.swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java" + visibility: "public" +--- +# `waitForUser` + +Control how agent waits for user input. + +## Signature + + + + ```java + public FunctionResult waitForUser( + Boolean enabled, + Integer timeout, + boolean answerFirst + ) + ``` + + + + ```java + public FunctionResult waitForUser() + ``` + + + +## Parameters (Overload 1) + + + + + + + +## Returns (Overload 1) + +`FunctionResult` + +## Returns (Overload 2) + +`FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/FunctionResult.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/FunctionResult.java) + +Line 138. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/index.mdx new file mode 100644 index 0000000000..94c82e147d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig" +title: "swaig" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.swaig" + module: "com.signalwire.sdk.swaig" +--- +# `swaig` + +## Signature + +```java +package com.signalwire.sdk.swaig +``` + +## Classes + + + + SwaigFunctionResult - the response builder returned by tool handlers. <p> Every method returns `this` for fluent chaining. + + + + Defines a SWAIG tool with its name, description, parameters, and handler. + + + +## Interfaces + + + + Functional interface for SWAIG tool handlers. Called when the platform invokes a tool during a conversation. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-description.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-description.mdx new file mode 100644 index 0000000000..7e05cd6c44 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-description" +title: "getDescription" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition.getDescription" + parent: "com.signalwire.sdk.swaig.ToolDefinition" + module: "com.signalwire.sdk.swaig.ToolDefinition" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `getDescription` + +## Signature + +```java +public String getDescription() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 24. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-extra-fields.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-extra-fields.mdx new file mode 100644 index 0000000000..827d45b987 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-extra-fields.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-extra-fields" +title: "getExtraFields" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition.getExtraFields" + parent: "com.signalwire.sdk.swaig.ToolDefinition" + module: "com.signalwire.sdk.swaig.ToolDefinition" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `getExtraFields` + +## Signature + +```java +public Map getExtraFields() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 39. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-handler.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-handler.mdx new file mode 100644 index 0000000000..2234e36322 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-handler.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-handler" +title: "getHandler" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition.getHandler" + parent: "com.signalwire.sdk.swaig.ToolDefinition" + module: "com.signalwire.sdk.swaig.ToolDefinition" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `getHandler` + +## Signature + +```java +public ToolHandler getHandler() +``` + +## Returns + +`ToolHandler` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 26. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-name.mdx new file mode 100644 index 0000000000..26bda0dbde --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-name" +title: "getName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition.getName" + parent: "com.signalwire.sdk.swaig.ToolDefinition" + module: "com.signalwire.sdk.swaig.ToolDefinition" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `getName` + +## Signature + +```java +public String getName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 23. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-parameters.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-parameters.mdx new file mode 100644 index 0000000000..4fac42f8b7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-parameters.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/get-parameters" +title: "getParameters" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition.getParameters" + parent: "com.signalwire.sdk.swaig.ToolDefinition" + module: "com.signalwire.sdk.swaig.ToolDefinition" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `getParameters` + +## Signature + +```java +public Map getParameters() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 25. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/has-handler.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/has-handler.mdx new file mode 100644 index 0000000000..85e0c8b731 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/has-handler.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/has-handler" +title: "hasHandler" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition.hasHandler" + parent: "com.signalwire.sdk.swaig.ToolDefinition" + module: "com.signalwire.sdk.swaig.ToolDefinition" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `hasHandler` + +Check if this tool has a handler (as opposed to DataMap tools which don't). + +## Signature + +```java +public boolean hasHandler() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 68. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/index.mdx new file mode 100644 index 0000000000..05cdab2dfa --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition" +title: "ToolDefinition" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition" + parent: "com.signalwire.sdk.swaig" + module: "com.signalwire.sdk.swaig" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `ToolDefinition` + +Defines a SWAIG tool with its name, description, parameters, and handler. + +## Signature + +```java +public class ToolDefinition +``` + +## Methods + + + + + + + + + + + + + + + + Check if this tool has a handler (as opposed to DataMap tools which don't). + + + + + + + + + + Serialize to SWAIG function format for SWML. + + + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 8. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/init.mdx new file mode 100644 index 0000000000..cd4fb968a9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/init.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition." + parent: "com.signalwire.sdk.swaig.ToolDefinition" + module: "com.signalwire.sdk.swaig.ToolDefinition" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public ( + String name, + String description, + Map parameters, + ToolHandler handler +) +``` + +## Parameters + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 16. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/is-secure.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/is-secure.mdx new file mode 100644 index 0000000000..42230f3192 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/is-secure.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/is-secure" +title: "isSecure" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition.isSecure" + parent: "com.signalwire.sdk.swaig.ToolDefinition" + module: "com.signalwire.sdk.swaig.ToolDefinition" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `isSecure` + +## Signature + +```java +public boolean isSecure() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/set-extra-fields.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/set-extra-fields.mdx new file mode 100644 index 0000000000..90d03491f0 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/set-extra-fields.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/set-extra-fields" +title: "setExtraFields" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition.setExtraFields" + parent: "com.signalwire.sdk.swaig.ToolDefinition" + module: "com.signalwire.sdk.swaig.ToolDefinition" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `setExtraFields` + +## Signature + +```java +public ToolDefinition setExtraFields(Map extraFields) +``` + +## Parameters + + + +## Returns + +`ToolDefinition` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 34. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/set-secure.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/set-secure.mdx new file mode 100644 index 0000000000..88d980d58a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/set-secure.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/set-secure" +title: "setSecure" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition.setSecure" + parent: "com.signalwire.sdk.swaig.ToolDefinition" + module: "com.signalwire.sdk.swaig.ToolDefinition" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `setSecure` + +## Signature + +```java +public ToolDefinition setSecure(boolean secure) +``` + +## Parameters + + + +## Returns + +`ToolDefinition` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 29. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/to-swaig-function.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/to-swaig-function.mdx new file mode 100644 index 0000000000..3f3641e01f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/to-swaig-function.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-definition/to-swaig-function" +title: "toSwaigFunction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolDefinition.toSwaigFunction" + parent: "com.signalwire.sdk.swaig.ToolDefinition" + module: "com.signalwire.sdk.swaig.ToolDefinition" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java" + visibility: "public" +--- +# `toSwaigFunction` + +Serialize to SWAIG function format for SWML. + +## Signature + +```java +public Map toSwaigFunction( + String webhookUrl, + String metaDataToken +) +``` + +## Parameters + + + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolDefinition.java) + +Line 46. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-handler/handle.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-handler/handle.mdx new file mode 100644 index 0000000000..7b7cf69bec --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-handler/handle.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-handler/handle" +title: "handle" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolHandler.handle" + parent: "com.signalwire.sdk.swaig.ToolHandler" + module: "com.signalwire.sdk.swaig.ToolHandler" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolHandler.java" + visibility: "public" +--- +# `handle` + +Handle a SWAIG tool invocation. + +## Signature + +```java +FunctionResult handle(Map args, Map rawData) +``` + +## Parameters + + + Parsed arguments from the tool call + + + + Full raw request payload for accessing call info, global data, etc. + + +## Returns + +`FunctionResult` — A FunctionResult with the response text and optional actions + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolHandler.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolHandler.java) + +Line 19. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-handler/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-handler/index.mdx new file mode 100644 index 0000000000..371d5e49c9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swaig/swaig/tool-handler/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swaig/swaig/tool-handler" +title: "ToolHandler" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "interface" + language: "java" + qualified_name: "com.signalwire.sdk.swaig.ToolHandler" + parent: "com.signalwire.sdk.swaig" + module: "com.signalwire.sdk.swaig" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolHandler.java" + visibility: "public" +--- +# `ToolHandler` + +Functional interface for SWAIG tool handlers. +Called when the platform invokes a tool during a conversation. + +**Decorators:** `@FunctionalInterface` + +## Signature + +```java +public interface ToolHandler +``` + +## Methods + + + + Handle a SWAIG tool invocation. + + + +## Source + +[`src/main/java/com/signalwire/sdk/swaig/ToolHandler.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swaig/ToolHandler.java) + +Line 10. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/add-section.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/add-section.mdx new file mode 100644 index 0000000000..a908beef9f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document/add-section" +title: "addSection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document.addSection" + parent: "com.signalwire.sdk.swml.Document" + module: "com.signalwire.sdk.swml.Document" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `addSection` + +Add a named section. + +If the section already exists, returns the existing list. + +## Signature + +```java +public List> addSection(String name) +``` + +## Parameters + + + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 45. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/add-verb-to-section.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/add-verb-to-section.mdx new file mode 100644 index 0000000000..cf59dca017 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/add-verb-to-section.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document/add-verb-to-section" +title: "addVerbToSection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document.addVerbToSection" + parent: "com.signalwire.sdk.swml.Document" + module: "com.signalwire.sdk.swml.Document" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `addVerbToSection` + +Add a verb to a named section. + +## Signature + +```java +public void addVerbToSection( + String sectionName, + String verbName, + Object verbData +) +``` + +## Parameters + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 68. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/add-verb.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/add-verb.mdx new file mode 100644 index 0000000000..585bee775a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/add-verb.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document/add-verb" +title: "addVerb" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document.addVerb" + parent: "com.signalwire.sdk.swml.Document" + module: "com.signalwire.sdk.swml.Document" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `addVerb` + +Add a verb to the main section. + +## Signature + +```java +public void addVerb(String verbName, Object verbData) +``` + +## Parameters + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 59. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/get-section-verbs.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/get-section-verbs.mdx new file mode 100644 index 0000000000..99894e7d66 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/get-section-verbs.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document/get-section-verbs" +title: "getSectionVerbs" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document.getSectionVerbs" + parent: "com.signalwire.sdk.swml.Document" + module: "com.signalwire.sdk.swml.Document" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `getSectionVerbs` + +Get verbs for a named section. + +## Signature + +```java +public List> getSectionVerbs(String name) +``` + +## Parameters + + + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 85. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/get-verbs.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/get-verbs.mdx new file mode 100644 index 0000000000..78a9bc408b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/get-verbs.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document/get-verbs" +title: "getVerbs" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document.getVerbs" + parent: "com.signalwire.sdk.swml.Document" + module: "com.signalwire.sdk.swml.Document" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `getVerbs` + +Get the main verbs list. + +## Signature + +```java +public List> getVerbs() +``` + +## Returns + +`List>` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 78. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/has-section.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/has-section.mdx new file mode 100644 index 0000000000..b6b0f8bea5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/has-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document/has-section" +title: "hasSection" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document.hasSection" + parent: "com.signalwire.sdk.swml.Document" + module: "com.signalwire.sdk.swml.Document" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `hasSection` + +Check whether a section exists. + +## Signature + +```java +public boolean hasSection(String name) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 52. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/index.mdx new file mode 100644 index 0000000000..dc3272c1a7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/index.mdx @@ -0,0 +1,80 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document" +title: "Document" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document" + parent: "com.signalwire.sdk.swml" + module: "com.signalwire.sdk.swml" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `Document` + +SWML Document model. + +<p> +A document has a version, sections (each a list of verbs), and a top-level +verbs list that maps to the "main" section. + +## Signature + +```java +public class Document +``` + +## Methods + + + + + + Add a named section. + + + + Add a verb to the main section. + + + + Add a verb to a named section. + + + + Get verbs for a named section. + + + + Get the main verbs list. + + + + Check whether a section exists. + + + + Render as compact JSON. + + + + Render as pretty-printed JSON. + + + + Reset document to empty state. + + + + Convert to a Map suitable for JSON serialization. + + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 20. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/init.mdx new file mode 100644 index 0000000000..81bc3b0c90 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/init.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document." + parent: "com.signalwire.sdk.swml.Document" + module: "com.signalwire.sdk.swml.Document" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `` + +## Signature + +```java +public () +``` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 27. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/render-pretty.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/render-pretty.mdx new file mode 100644 index 0000000000..bf62b3899a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/render-pretty.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document/render-pretty" +title: "renderPretty" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document.renderPretty" + parent: "com.signalwire.sdk.swml.Document" + module: "com.signalwire.sdk.swml.Document" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `renderPretty` + +Render as pretty-printed JSON. + +## Signature + +```java +public String renderPretty() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 109. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/render.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/render.mdx new file mode 100644 index 0000000000..d9149b459b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/render.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document/render" +title: "render" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document.render" + parent: "com.signalwire.sdk.swml.Document" + module: "com.signalwire.sdk.swml.Document" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `render` + +Render as compact JSON. + +## Signature + +```java +public String render() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 102. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/reset.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/reset.mdx new file mode 100644 index 0000000000..a99bf2b73e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/reset.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document/reset" +title: "reset" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document.reset" + parent: "com.signalwire.sdk.swml.Document" + module: "com.signalwire.sdk.swml.Document" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `reset` + +Reset document to empty state. + +## Signature + +```java +public void reset() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 36. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/to-map.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/to-map.mdx new file mode 100644 index 0000000000..a4df970e69 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/document/to-map.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/document/to-map" +title: "toMap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Document.toMap" + parent: "com.signalwire.sdk.swml.Document" + module: "com.signalwire.sdk.swml.Document" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java" + visibility: "public" +--- +# `toMap` + +Convert to a Map suitable for JSON serialization. + +## Signature + +```java +public Map toMap() +``` + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Document.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Document.java) + +Line 92. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/index.mdx new file mode 100644 index 0000000000..1054a4875c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml" +title: "swml" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.swml" + module: "com.signalwire.sdk.swml" +--- +# `swml` + +## Signature + +```java +package com.signalwire.sdk.swml +``` + +## Classes + + + + SWML Document model. <p> A document has a version, sections (each a list of verbs), and a top-level verbs list that maps to the "main" section. + + + + Singleton that loads schema.json from resources and extracts the 38 SWML verb definitions. <p> The extraction algorithm: <ol> <li>Parse schema.json</li> <li>For each entry in $defs.SWMLMethod.anyOf, get the $ref</li> <li>Look up the definition in $defs</li> <li>The actual verb name is the first key in properties</li> </ol> + + + + SchemaUtils — Java port of `signalwire.utils.schema_utils.SchemaUtils`. <p>Loads the SWML JSON Schema, extracts verb metadata, and validates either a single verb config or a complete SWML document.</p> <p>Construction rules mirror Python:</p> <ul> <li>Pass `schemaPath=null` to use the embedded `schema.json`.</li> <li>`schemaValidation=false` disables validation (returns valid=true for every `validateVerb` call).</li> <li>The env var `SWML_SKIP_SCHEMA_VALIDATION=1/true/yes` also disables validation regardless of the constructor argument.</li> </ul> <p>The Java port currently ships only the lightweight validator (verb existence + required-property check). + + + + SchemaValidationError — Java port of `signalwire.utils.schema_utils.SchemaValidationError`. <p>Raised when SWML schema validation of a verb config fails.</p> + + + + Base SWML service with an embedded HTTP server, basic auth, security headers, and explicit methods for all 38 schema-driven verbs. <p> Uses JDK built-in com.sun.net.httpserver.HttpServer with virtual threads. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/generate-method-body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/generate-method-body.mdx new file mode 100644 index 0000000000..73d2df38f8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/generate-method-body.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/generate-method-body" +title: "generateMethodBody" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils.generateMethodBody" + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `generateMethodBody` + +Generate a Python-style method body string for a verb. +Mirrors Python's `generate_method_body(verb_name)`. + +## Signature + +```java +public String generateMethodBody(String verbName) +``` + +## Parameters + + + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 329. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/generate-method-signature.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/generate-method-signature.mdx new file mode 100644 index 0000000000..d8954a1ca4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/generate-method-signature.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/generate-method-signature" +title: "generateMethodSignature" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils.generateMethodSignature" + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `generateMethodSignature` + +Generate a Python-style method signature string for a verb. +Mirrors Python's `generate_method_signature(verb_name)`. + +## Signature + +```java +public String generateMethodSignature(String verbName) +``` + +## Parameters + + + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 292. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-all-verb-names.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-all-verb-names.mdx new file mode 100644 index 0000000000..cf497424ff --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-all-verb-names.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-all-verb-names" +title: "getAllVerbNames" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils.getAllVerbNames" + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `getAllVerbNames` + +Sorted list of all known verb names. +Mirrors Python's `get_all_verb_names()`. + +## Signature + +```java +public List getAllVerbNames() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 178. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-parameters.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-parameters.mdx new file mode 100644 index 0000000000..65a00595e4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-parameters.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-parameters" +title: "getVerbParameters" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils.getVerbParameters" + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `getVerbParameters` + +Parameter-definition block used by code-gen tooling. +Mirrors Python's `get_verb_parameters(verb_name)`. + +## Signature + +```java +public Map getVerbParameters(String verbName) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 226. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-properties.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-properties.mdx new file mode 100644 index 0000000000..305f8e0a6f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-properties.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-properties" +title: "getVerbProperties" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils.getVerbProperties" + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `getVerbProperties` + +The `properties[verb_name]` block for a verb, or an empty map when +the verb is unknown. +Mirrors Python's `get_verb_properties(verb_name)`. + +## Signature + +```java +public Map getVerbProperties(String verbName) +``` + +## Parameters + + + +## Returns + +`Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 187. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-required-properties.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-required-properties.mdx new file mode 100644 index 0000000000..d30cc98799 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-required-properties.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/get-verb-required-properties" +title: "getVerbRequiredProperties" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils.getVerbRequiredProperties" + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `getVerbRequiredProperties` + +The `required` list for a verb, or an empty list when the verb is +unknown or has no required properties. +Mirrors Python's `get_verb_required_properties(verb_name)`. + +## Signature + +```java +public List getVerbRequiredProperties(String verbName) +``` + +## Parameters + + + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 202. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/index.mdx new file mode 100644 index 0000000000..b75058e35f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/index.mdx @@ -0,0 +1,105 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils" +title: "SchemaUtils" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils" + parent: "com.signalwire.sdk.swml" + module: "com.signalwire.sdk.swml" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `SchemaUtils` + +SchemaUtils — Java port of `signalwire.utils.schema_utils.SchemaUtils`. + +<p>Loads the SWML JSON Schema, extracts verb metadata, and validates either a +single verb config or a complete SWML document.</p> + +<p>Construction rules mirror Python:</p> +<ul> + <li>Pass `schemaPath=null` to use the embedded `schema.json`.</li> + <li>`schemaValidation=false` disables validation (returns valid=true + for every `validateVerb` call).</li> + <li>The env var `SWML_SKIP_SCHEMA_VALIDATION=1/true/yes` also disables + validation regardless of the constructor argument.</li> +</ul> + +<p>The Java port currently ships only the lightweight validator (verb existence ++ required-property check). + +Full JSON Schema validation can be wired in by +extending `#initFullValidator()`. The lightweight contract matches +Python's `_validate_verb_lightweight()` exactly.</p> + +## Signature + +```java +public class SchemaUtils +``` + +## Methods + + + + Construct a SchemaUtils. Mirrors Python's schema\_validation=True). + + + + Generate a Python-style method body string for a verb. Mirrors Python's `generate_method_body(verb_name)`. + + + + Generate a Python-style method signature string for a verb. Mirrors Python's `generate_method_signature(verb_name)`. + + + + Sorted list of all known verb names. Mirrors Python's `get_all_verb_names()`. + + + + Parameter-definition block used by code-gen tooling. Mirrors Python's `get_verb_parameters(verb_name)`. + + + + The `properties[verb_name]` block for a verb, or an empty map when the verb is unknown. Mirrors Python's `get_verb_properties(verb_name)`. + + + + The `required` list for a verb, or an empty list when the verb is unknown or has no required properties. Mirrors Python's `get_verb_required_properties(verb_name)`. + + + + Whether full JSON Schema validation is wired up. Mirrors Python's `full_validation_available` property. + + + + Read and parse the JSON Schema. Mirrors Python's `load_schema()`. + + + + Validate a complete SWML document. Mirrors Python's `validate_document(document)`. + + + + Validate a verb config against the schema. Mirrors Python's verb\_config). + + + +## Classes + + + + A verb extracted from the schema. + + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 51. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/init.mdx new file mode 100644 index 0000000000..84b317dfea --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/init.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils." + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `` + +Construct a SchemaUtils. +Mirrors Python's schema\_validation=True). + +## Signature + +```java +public (String schemaPath, boolean schemaValidation) +``` + +## Parameters + + + optional path to a schema.json file; pass null to use the embedded resource bundled with the SDK jar. + + + + enables/disables schema validation. Honors `SWML_SKIP_SCHEMA_VALIDATION=1` env override. + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 83. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/is-full-validation-available.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/is-full-validation-available.mdx new file mode 100644 index 0000000000..023e69422d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/is-full-validation-available.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/is-full-validation-available" +title: "isFullValidationAvailable" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils.isFullValidationAvailable" + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `isFullValidationAvailable` + +Whether full JSON Schema validation is wired up. +Mirrors Python's `full_validation_available` property. + +## Signature + +```java +public boolean isFullValidationAvailable() +``` + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 170. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/load-schema.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/load-schema.mdx new file mode 100644 index 0000000000..ad88586c8c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/load-schema.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/load-schema" +title: "loadSchema" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils.loadSchema" + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `loadSchema` + +Read and parse the JSON Schema. +Mirrors Python's `load_schema()`. + +## Signature + +```java +public JsonObject loadSchema() +``` + +## Returns + +`JsonObject` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 105. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/validate-document.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/validate-document.mdx new file mode 100644 index 0000000000..7d2b2b6d99 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/validate-document.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/validate-document" +title: "validateDocument" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils.validateDocument" + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `validateDocument` + +Validate a complete SWML document. +Mirrors Python's `validate_document(document)`. + +Returns +\["Schema validator not initialized"]) when no full +validator is wired in — same contract as Python. + +## Signature + +```java +public Map.Entry> validateDocument( + Map document +) +``` + +## Parameters + + + +## Returns + +`Map.Entry>` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 279. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/validate-verb.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/validate-verb.mdx new file mode 100644 index 0000000000..863c0ce673 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/validate-verb.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/validate-verb" +title: "validateVerb" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils.validateVerb" + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `validateVerb` + +Validate a verb config against the schema. +Mirrors Python's verb\_config). + +## Signature + +```java +public Map.Entry> validateVerb( + String verbName, + Map verbConfig +) +``` + +## Parameters + + + + + +## Returns + +`Map.Entry>` — (`valid`, `errors`) entry; mirrors Python's List\[str]] return. + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 244. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/verb-info/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/verb-info/index.mdx new file mode 100644 index 0000000000..5e0e141740 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-utils/verb-info/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-utils/verb-info" +title: "VerbInfo" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaUtils.VerbInfo" + parent: "com.signalwire.sdk.swml.SchemaUtils" + module: "com.signalwire.sdk.swml" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java" + visibility: "public" +--- +# `VerbInfo` + +A verb extracted from the schema. + +**Modifiers:** `static` `final` + +## Signature + +```java +public static final class VerbInfo +``` + +## Properties + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaUtils.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaUtils.java) + +Line 62. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/get-errors.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/get-errors.mdx new file mode 100644 index 0000000000..742b6875f5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/get-errors.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/get-errors" +title: "getErrors" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaValidationError.getErrors" + parent: "com.signalwire.sdk.swml.SchemaValidationError" + module: "com.signalwire.sdk.swml.SchemaValidationError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java" + visibility: "public" +--- +# `getErrors` + +## Signature + +```java +public List getErrors() +``` + +## Returns + +`List` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java) + +Line 44. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/get-verb-name.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/get-verb-name.mdx new file mode 100644 index 0000000000..9a684fae25 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/get-verb-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/get-verb-name" +title: "getVerbName" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaValidationError.getVerbName" + parent: "com.signalwire.sdk.swml.SchemaValidationError" + module: "com.signalwire.sdk.swml.SchemaValidationError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java" + visibility: "public" +--- +# `getVerbName` + +## Signature + +```java +public String getVerbName() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java) + +Line 40. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/index.mdx new file mode 100644 index 0000000000..524ca2d098 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-validation-error" +title: "SchemaValidationError" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaValidationError" + parent: "com.signalwire.sdk.swml" + module: "com.signalwire.sdk.swml" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java" + visibility: "public" +--- +# `SchemaValidationError` + +SchemaValidationError — Java port of +`signalwire.utils.schema_utils.SchemaValidationError`. + +<p>Raised when SWML schema validation of a verb config fails.</p> + +## Signature + +```java +public class SchemaValidationError extends RuntimeException +``` + +## Inheritance + +**Extends:** `RuntimeException` + +## Methods + + + + Construct a SchemaValidationError. + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java) + +Line 18. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/init.mdx new file mode 100644 index 0000000000..503558bea7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/init.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema-validation-error/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.SchemaValidationError." + parent: "com.signalwire.sdk.swml.SchemaValidationError" + module: "com.signalwire.sdk.swml.SchemaValidationError" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java" + visibility: "public" +--- +# `` + +Construct a SchemaValidationError. + +Mirrors Python's +errors) signature. + +## Signature + +```java +public (String verbName, List errors) +``` + +## Parameters + + + the verb whose validation failed + + + + the list of human-readable error messages + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/SchemaValidationError.java) + +Line 32. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/get-instance.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/get-instance.mdx new file mode 100644 index 0000000000..37a5b8e516 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/get-instance.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema/get-instance" +title: "getInstance" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Schema.getInstance" + parent: "com.signalwire.sdk.swml.Schema" + module: "com.signalwire.sdk.swml.Schema" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java" + visibility: "public" +--- +# `getInstance` + +**Modifiers:** `static` + +## Signature + +```java +public static Schema getInstance() +``` + +## Returns + +`Schema` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Schema.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java) + +Line 44. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/get-verb-names.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/get-verb-names.mdx new file mode 100644 index 0000000000..29baffd6f1 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/get-verb-names.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema/get-verb-names" +title: "getVerbNames" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Schema.getVerbNames" + parent: "com.signalwire.sdk.swml.Schema" + module: "com.signalwire.sdk.swml.Schema" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java" + visibility: "public" +--- +# `getVerbNames` + +Get all verb names. + +## Signature + +```java +public Set getVerbNames() +``` + +## Returns + +`Set` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Schema.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java) + +Line 118. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/get-verb.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/get-verb.mdx new file mode 100644 index 0000000000..03e045cf0e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/get-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema/get-verb" +title: "getVerb" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Schema.getVerb" + parent: "com.signalwire.sdk.swml.Schema" + module: "com.signalwire.sdk.swml.Schema" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java" + visibility: "public" +--- +# `getVerb` + +Get the full definition for a verb. + +## Signature + +```java +public JsonObject getVerb(String name) +``` + +## Parameters + + + +## Returns + +`JsonObject` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Schema.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java) + +Line 125. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/index.mdx new file mode 100644 index 0000000000..b34a651bfc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema" +title: "Schema" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Schema" + parent: "com.signalwire.sdk.swml" + module: "com.signalwire.sdk.swml" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java" + visibility: "public" +--- +# `Schema` + +Singleton that loads schema.json from resources and extracts the 38 SWML verb definitions. + +<p> +The extraction algorithm: +<ol> + <li>Parse schema.json</li> + <li>For each entry in $defs.SWMLMethod.anyOf, get the $ref</li> + <li>Look up the definition in $defs</li> + <li>The actual verb name is the first key in properties</li> +</ol> + +**Modifiers:** `final` + +## Signature + +```java +public final class Schema +``` + +## Methods + + + + + + Get the full definition for a verb. + + + + Get all verb names. + + + + Check if a verb name is valid. + + + + Get the number of loaded verb definitions. + + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Schema.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/is-valid-verb.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/is-valid-verb.mdx new file mode 100644 index 0000000000..3b7811f9c4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/is-valid-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema/is-valid-verb" +title: "isValidVerb" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Schema.isValidVerb" + parent: "com.signalwire.sdk.swml.Schema" + module: "com.signalwire.sdk.swml.Schema" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java" + visibility: "public" +--- +# `isValidVerb` + +Check if a verb name is valid. + +## Signature + +```java +public boolean isValidVerb(String name) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Schema.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java) + +Line 111. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/verb-count.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/verb-count.mdx new file mode 100644 index 0000000000..6f250c632b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/schema/verb-count.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/schema/verb-count" +title: "verbCount" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Schema.verbCount" + parent: "com.signalwire.sdk.swml.Schema" + module: "com.signalwire.sdk.swml.Schema" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java" + visibility: "public" +--- +# `verbCount` + +Get the number of loaded verb definitions. + +## Signature + +```java +public int verbCount() +``` + +## Returns + +`int` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Schema.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Schema.java) + +Line 132. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/add-security-headers.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/add-security-headers.mdx new file mode 100644 index 0000000000..06415c91bb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/add-security-headers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/add-security-headers" +title: "addSecurityHeaders" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.addSecurityHeaders" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `addSecurityHeaders` + +Add security headers to every authenticated response. + +## Signature + +```java +protected void addSecurityHeaders(HttpExchange exchange) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 411. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/ai.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/ai.mdx new file mode 100644 index 0000000000..6993dd1e37 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/ai.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/ai" +title: "ai" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.ai" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `ai` + +## Signature + +```java +public Service ai(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 445. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/amazon-bedrock.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/amazon-bedrock.mdx new file mode 100644 index 0000000000..c393ad5e3a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/amazon-bedrock.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/amazon-bedrock" +title: "amazonBedrock" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.amazonBedrock" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `amazonBedrock` + +## Signature + +```java +public Service amazonBedrock(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 450. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/answer.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/answer.mdx new file mode 100644 index 0000000000..51472ee2bf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/answer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/answer" +title: "answer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.answer" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `answer` + +## Signature + +```java +public Service answer(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 440. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/cond.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/cond.mdx new file mode 100644 index 0000000000..aa3e5c6514 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/cond.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/cond" +title: "cond" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.cond" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `cond` + +## Signature + +```java +public Service cond(List> conditions) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 455. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/connect.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/connect.mdx new file mode 100644 index 0000000000..f2d1e18095 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/connect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/connect" +title: "connect" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.connect" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `connect` + +## Signature + +```java +public Service connect(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 460. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/define-tool.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/define-tool.mdx new file mode 100644 index 0000000000..f0be5767b7 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/define-tool.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/define-tool" +title: "defineTool" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.defineTool" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `defineTool` + +Define a SWAIG function the AI can call. + +Tool descriptions and +parameter descriptions are LLM-facing prompt engineering — see +PORTING\_GUIDE for guidance on writing them. + +## Signature + + + + ```java + public Service defineTool( + String name, + String description, + java.util.Map parameters, + com.signalwire.sdk.swaig.ToolHandler handler + ) + ``` + + + + ```java + public Service defineTool(com.signalwire.sdk.swaig.ToolDefinition toolDef) + ``` + + + +## Parameters (Overload 1) + + + + + + + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`Service` + +## Returns (Overload 2) + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 219. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/define-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/define-tools.mdx new file mode 100644 index 0000000000..13c49f3c85 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/define-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/define-tools" +title: "defineTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.defineTools" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `defineTools` + +Register multiple tool definitions at once. + +## Signature + +```java +public Service defineTools( + java.util.List toolDefs +) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 239. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/denoise.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/denoise.mdx new file mode 100644 index 0000000000..d89c04287b --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/denoise.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/denoise" +title: "denoise" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.denoise" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `denoise` + +## Signature + +```java +public Service denoise(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 465. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/detect-machine.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/detect-machine.mdx new file mode 100644 index 0000000000..b0f7667c96 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/detect-machine.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/detect-machine" +title: "detectMachine" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.detectMachine" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `detectMachine` + +## Signature + +```java +public Service detectMachine(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 470. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/enter-queue.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/enter-queue.mdx new file mode 100644 index 0000000000..dad0add8d4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/enter-queue.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/enter-queue" +title: "enterQueue" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.enterQueue" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `enterQueue` + +## Signature + +```java +public Service enterQueue(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 475. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/execute.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/execute.mdx new file mode 100644 index 0000000000..f2446f0a75 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/execute.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/execute" +title: "execute" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.execute" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `execute` + +## Signature + +```java +public Service execute(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 480. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/generate-password.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/generate-password.mdx new file mode 100644 index 0000000000..eab45d42c9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/generate-password.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/generate-password" +title: "generatePassword" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.generatePassword" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `generatePassword` + +**Modifiers:** `static` + +## Signature + +```java +protected static String generatePassword() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 116. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-all-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-all-functions.mdx new file mode 100644 index 0000000000..c74bc44cbb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-all-functions.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/get-all-functions" +title: "getAllFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.getAllFunctions" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `getAllFunctions` + +Snapshot of all registered SWAIG functions keyed by name. +(Python parity: `ToolRegistry.get_all_functions`.) + +## Signature + +```java +public java.util.Map getAllFunctions() +``` + +## Returns + +`java.util.Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 277. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-auth-password.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-auth-password.mdx new file mode 100644 index 0000000000..7a2fcd7efc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-auth-password.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/get-auth-password" +title: "getAuthPassword" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.getAuthPassword" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `getAuthPassword` + +## Signature + +```java +public String getAuthPassword() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 129. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-auth-user.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-auth-user.mdx new file mode 100644 index 0000000000..249ff087c9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-auth-user.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/get-auth-user" +title: "getAuthUser" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.getAuthUser" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `getAuthUser` + +## Signature + +```java +public String getAuthUser() +``` + +## Returns + +`String` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 125. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-basic-auth-credentials-with-source.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-basic-auth-credentials-with-source.mdx new file mode 100644 index 0000000000..a8e4df0876 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-basic-auth-credentials-with-source.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/get-basic-auth-credentials-with-source" +title: "getBasicAuthCredentialsWithSource" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.getBasicAuthCredentialsWithSource" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `getBasicAuthCredentialsWithSource` + +Get (user, password, source) where source is "provided", +"environment", or "generated". + +(Python parity: +`AuthMixin.get_basic_auth_credentials(include_source=True)`.) + +## Signature + +```java +public String[] getBasicAuthCredentialsWithSource() +``` + +## Returns + +`String[]` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 155. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..9b4ffacc11 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-basic-auth-credentials.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/get-basic-auth-credentials" +title: "getBasicAuthCredentials" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.getBasicAuthCredentials" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `getBasicAuthCredentials` + +Get the configured (user, password) pair as a String\[2] tuple. +(Python parity: `AuthMixin.get_basic_auth_credentials`.) + +## Signature + +```java +public String[] getBasicAuthCredentials() +``` + +## Returns + +`String[]` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 148. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-document.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-document.mdx new file mode 100644 index 0000000000..81e03b0e56 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-document.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/get-document" +title: "getDocument" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.getDocument" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `getDocument` + +## Signature + +```java +public Document getDocument() +``` + +## Returns + +`Document` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 420. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-function.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-function.mdx new file mode 100644 index 0000000000..54083f75b6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/get-function" +title: "getFunction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.getFunction" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `getFunction` + +Get a registered SWAIG function by name, or null when absent. +(Python parity: `ToolRegistry.get_function`.) + +## Signature + +```java +public com.signalwire.sdk.swaig.ToolDefinition getFunction(String name) +``` + +## Parameters + + + +## Returns + +`com.signalwire.sdk.swaig.ToolDefinition` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 271. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-registered-swaig-functions.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-registered-swaig-functions.mdx new file mode 100644 index 0000000000..0ec8314aa5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-registered-swaig-functions.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/get-registered-swaig-functions" +title: "getRegisteredSwaigFunctions" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.getRegisteredSwaigFunctions" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `getRegisteredSwaigFunctions` + +Read-only view of the raw SWAIG function entries registered via +`#registerSwaigFunction(java.util.Map)`. + +These are typically +DataMap or schema-only tools that don't have a Java `com.signalwire.sdk.swaig.ToolHandler`. +Each entry is a defensive copy of the original map; the outer list +is unmodifiable. + +## Signature + +```java +public java.util.List> getRegisteredSwaigFunctions() +``` + +## Returns + +`java.util.List>` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 306. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-registered-tools.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-registered-tools.mdx new file mode 100644 index 0000000000..29b1c61811 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-registered-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/get-registered-tools" +title: "getRegisteredTools" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.getRegisteredTools" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `getRegisteredTools` + +Public, read-only view of the registered SWAIG tool registry. +Returned in insertion order; the map and its definitions are +unmodifiable. + +Used by introspection callers (CLI `--list-tools` +file-loader path, tests, audit tooling) that need name + description + +parameters without going through `/swaig` HTTP. + +## Signature + +```java +public java.util.Map getRegisteredTools() +``` + +## Returns + +`java.util.Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 295. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-schema-utils.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-schema-utils.mdx new file mode 100644 index 0000000000..eb1246eb67 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/get-schema-utils.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/get-schema-utils" +title: "getSchemaUtils" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.getSchemaUtils" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `getSchemaUtils` + +SchemaUtils helper bound to this Service. + +Mirrors Python's +`self.schema_utils` public instance attribute on +`SWMLService`. Built lazily on first access. + +## Signature + +```java +public SchemaUtils getSchemaUtils() +``` + +## Returns + +`SchemaUtils` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 429. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/goto-label.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/goto-label.mdx new file mode 100644 index 0000000000..8ac473b451 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/goto-label.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/goto-label" +title: "gotoLabel" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.gotoLabel" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `gotoLabel` + +## Signature + +```java +public Service gotoLabel(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 485. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/hangup.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/hangup.mdx new file mode 100644 index 0000000000..7d0dad930c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/hangup.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/hangup" +title: "hangup" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.hangup" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `hangup` + +## Signature + + + + ```java + public Service hangup(Map params) + ``` + + + + ```java + public Service hangup() + ``` + + + +## Parameters (Overload 1) + + + +## Returns (Overload 1) + +`Service` + +## Returns (Overload 2) + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 490. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/has-function.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/has-function.mdx new file mode 100644 index 0000000000..b87471e385 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/has-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/has-function" +title: "hasFunction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.hasFunction" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `hasFunction` + +Whether a SWAIG function with the given name is registered. +(Python parity: `ToolRegistry.has_function`.) + +## Signature + +```java +public boolean hasFunction(String name) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 265. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/index.mdx new file mode 100644 index 0000000000..af41d0df30 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/index.mdx @@ -0,0 +1,274 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service" +title: "Service" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service" + parent: "com.signalwire.sdk.swml" + module: "com.signalwire.sdk.swml" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `Service` + +Base SWML service with an embedded HTTP server, basic auth, security headers, +and explicit methods for all 38 schema-driven verbs. + +<p> +Uses JDK built-in com.sun.net.httpserver.HttpServer with virtual threads. + +## Signature + +```java +public class Service +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + +## Constants + + + HttpExchange attribute key under which the raw POST body is stashed by `#serve()` when reading it up-front for signature validation. Subclasses (notably `com.signalwire.sdk.agent.AgentBase`) check this attribute in `renderMainSwml` so they can re-use the cached body without re-reading the (already-consumed) request stream. + + +## Methods + + + + + + Add security headers to every authenticated response. + + + + + + + + + + + + + + Define a SWAIG function the AI can call. + + + + Register multiple tool definitions at once. + + + + + + + + + + + + + + Snapshot of all registered SWAIG functions keyed by name. (Python parity: `ToolRegistry.get_all_functions`.) + + + + + + + + Get the configured (user, password) pair as a String\[2] tuple. (Python parity: `AuthMixin.get_basic_auth_credentials`.) + + + + Get (user, password, source) where source is "provided", "environment", or "generated". + + + + + + Get a registered SWAIG function by name, or null when absent. (Python parity: `ToolRegistry.get_function`.) + + + + Read-only view of the raw SWAIG function entries registered via `#registerSwaigFunction(java.util.Map)`. + + + + Public, read-only view of the registered SWAIG tool registry. Returned in insertion order; the map and its definitions are unmodifiable. + + + + SchemaUtils helper bound to this Service. + + + + + + + + Whether a SWAIG function with the given name is registered. (Python parity: `ToolRegistry.has_function`.) + + + + + + + + + + List registered SWAIG tool names in insertion order. + + + + + + + + Dispatch a function call to the registered handler. + + + + Customization hook called when SWML is requested. + + + + Customization point for subclasses to modify SWML based on request data. + + + + + + + + + + Read request body with size limit. + + + + + + + + + + Extension point: register additional HTTP routes after Service mounts /health, /ready, /swaig and the main route. + + + + Register a raw SWAIG function definition (e.g. + + + + Remove a registered SWAIG function. + + + + Extension point: render the SWML document for the main path or for GET /swaig. + + + + + + + + + + + + + + Send a JSON response. + + + + Send a 413 Payload Too Large response. + + + + + + Send a 401 Unauthorized response. + + + + Start the HTTP server with health, ready, /swaig, and main SWML endpoint. Subclasses (AgentBase) add additional routes via `#registerAdditionalRoutes(HttpServer)` and customize SWML rendering via `#renderMainSwml(HttpExchange)`. + + + + + + + + Sleep takes an integer (milliseconds), not a map. + + + + Stop the HTTP server. + + + + + + + + + + Extension point: invoked between argument parsing and function dispatch. + + + + + + + + + + + + + + Timing-safe basic auth validation using MessageDigest.isEqual. + + + + Validate provided basic-auth credentials against the configured ones using a constant-time comparison. + + + + Extension hook invoked between raw-body capture and JSON parsing on signed POST routes (`/`, `/swaig`, `/post_prompt`). Subclasses (AgentBase) override to enforce SignalWire webhook signature validation when a signing key is configured. + + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 31. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/init.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/init.mdx new file mode 100644 index 0000000000..bb6fbc1ef5 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/init.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/init" +title: "" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service." + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `` + +## Signature + + + + ```java + public (String name) + ``` + + + + ```java + public (String name, String route) + ``` + + + + ```java + public ( + String name, + String route, + String host, + int port, + String authUser, + String authPassword + ) + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + + + +## Parameters (Overload 3) + + + + + + + + + + + + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 74. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/join-conference.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/join-conference.mdx new file mode 100644 index 0000000000..c0f50cfa0c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/join-conference.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/join-conference" +title: "joinConference" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.joinConference" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `joinConference` + +## Signature + +```java +public Service joinConference(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 500. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/join-room.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/join-room.mdx new file mode 100644 index 0000000000..ce379c6fc8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/join-room.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/join-room" +title: "joinRoom" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.joinRoom" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `joinRoom` + +## Signature + +```java +public Service joinRoom(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 505. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/label.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/label.mdx new file mode 100644 index 0000000000..42f62059bf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/label.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/label" +title: "label" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.label" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `label` + +## Signature + +```java +public Service label(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 510. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/list-tool-names.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/list-tool-names.mdx new file mode 100644 index 0000000000..876d32120a --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/list-tool-names.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/list-tool-names" +title: "listToolNames" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.listToolNames" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `listToolNames` + +List registered SWAIG tool names in insertion order. + +## Signature + +```java +public java.util.List listToolNames() +``` + +## Returns + +`java.util.List` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 259. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/live-transcribe.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/live-transcribe.mdx new file mode 100644 index 0000000000..ff0dec3917 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/live-transcribe.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/live-transcribe" +title: "liveTranscribe" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.liveTranscribe" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `liveTranscribe` + +## Signature + +```java +public Service liveTranscribe(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 515. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/live-translate.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/live-translate.mdx new file mode 100644 index 0000000000..b222d477fb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/live-translate.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/live-translate" +title: "liveTranslate" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.liveTranslate" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `liveTranslate` + +## Signature + +```java +public Service liveTranslate(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 520. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/on-function-call.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/on-function-call.mdx new file mode 100644 index 0000000000..0587ca873c --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/on-function-call.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/on-function-call" +title: "onFunctionCall" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.onFunctionCall" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `onFunctionCall` + +Dispatch a function call to the registered handler. + +## Signature + +```java +public com.signalwire.sdk.swaig.FunctionResult onFunctionCall( + String funcName, + java.util.Map args, + java.util.Map rawData +) +``` + +## Parameters + + + + + + + +## Returns + +`com.signalwire.sdk.swaig.FunctionResult` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 247. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/on-request.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/on-request.mdx new file mode 100644 index 0000000000..dc4f826228 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/on-request.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/on-request" +title: "onRequest" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.onRequest" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `onRequest` + +Customization hook called when SWML is requested. + +Default +delegates to String) and +returns its result. Subclasses typically override +`onSwmlRequest` rather than this method. + +<p>Returning `null` uses the default rendered SWML; +returning a non-null map merges the entries as modifications. + +<p>Python parity: callback_path). The Python third `request` parameter is +FastAPI-specific and intentionally not mirrored. + +## Signature + +```java +public java.util.Map onRequest( + java.util.Map requestData, + String callbackPath +) +``` + +## Parameters + + + parsed request body, or `null` + + + + optional callback sub-path, or `null` + + +## Returns + +`java.util.Map` — modifications map, or `null` for default rendering + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 360. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/on-swml-request.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/on-swml-request.mdx new file mode 100644 index 0000000000..c112184720 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/on-swml-request.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/on-swml-request" +title: "onSwmlRequest" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.onSwmlRequest" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `onSwmlRequest` + +Customization point for subclasses to modify SWML based on +request data. + +The default implementation returns `null` +(no modification). Subclasses override to inspect the body or +callback path and return a map of SWML overrides. + +<p>Python parity: callback_path). The Python third `request` parameter is +FastAPI-specific and intentionally not mirrored. + +## Signature + +```java +public java.util.Map onSwmlRequest( + java.util.Map requestData, + String callbackPath +) +``` + +## Parameters + + + parsed request body, or `null` + + + + optional callback sub-path, or `null` + + +## Returns + +`java.util.Map` — modifications map, or `null` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 380. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/pay.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/pay.mdx new file mode 100644 index 0000000000..4d17c64f23 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/pay.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/pay" +title: "pay" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.pay" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `pay` + +## Signature + +```java +public Service pay(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 525. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/play.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/play.mdx new file mode 100644 index 0000000000..be366029dc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/play.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/play" +title: "play" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.play" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `play` + +## Signature + +```java +public Service play(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 530. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/prompt.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/prompt.mdx new file mode 100644 index 0000000000..f842596a67 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/prompt" +title: "prompt" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.prompt" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `prompt` + +## Signature + +```java +public Service prompt(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 535. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/read-body.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/read-body.mdx new file mode 100644 index 0000000000..7321be0fbf --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/read-body.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/read-body" +title: "readBody" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.readBody" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `readBody` + +Read request body with size limit. + +## Signature + +```java +protected String readBody(HttpExchange exchange) +``` + +## Parameters + + + +## Returns + +`String` + +## Throws + +- `IOException` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 643. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/receive-fax.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/receive-fax.mdx new file mode 100644 index 0000000000..43a062c079 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/receive-fax.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/receive-fax" +title: "receiveFax" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.receiveFax" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `receiveFax` + +## Signature + +```java +public Service receiveFax(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 540. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/record-call.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/record-call.mdx new file mode 100644 index 0000000000..9a957b9edc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/record-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/record-call" +title: "recordCall" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.recordCall" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `recordCall` + +## Signature + +```java +public Service recordCall(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 550. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/record.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/record.mdx new file mode 100644 index 0000000000..413822b8e8 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/record.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/record" +title: "record" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.record" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `record` + +## Signature + +```java +public Service record(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 545. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/register-additional-routes.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/register-additional-routes.mdx new file mode 100644 index 0000000000..7c78194af9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/register-additional-routes.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/register-additional-routes" +title: "registerAdditionalRoutes" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.registerAdditionalRoutes" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `registerAdditionalRoutes` + +Extension point: register additional HTTP routes after Service +mounts /health, /ready, /swaig and the main route. + +AgentBase uses +this to add /post\_prompt and /mcp. + +## Signature + +```java +protected void registerAdditionalRoutes(HttpServer server) +``` + +## Parameters + + + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 340. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/register-swaig-function.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/register-swaig-function.mdx new file mode 100644 index 0000000000..2716a2c406 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/register-swaig-function.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/register-swaig-function" +title: "registerSwaigFunction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.registerSwaigFunction" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `registerSwaigFunction` + +Register a raw SWAIG function definition (e.g. + +DataMap tools). + +## Signature + +```java +public Service registerSwaigFunction(java.util.Map swaigFunc) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 233. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/remove-function.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/remove-function.mdx new file mode 100644 index 0000000000..cf0fd1ef87 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/remove-function.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/remove-function" +title: "removeFunction" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.removeFunction" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `removeFunction` + +Remove a registered SWAIG function. + +Returns true when removed, +false when the function was not registered. +(Python parity: `ToolRegistry.remove_function`.) + +## Signature + +```java +public boolean removeFunction(String name) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 284. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/render-main-swml.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/render-main-swml.mdx new file mode 100644 index 0000000000..44ac0ca737 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/render-main-swml.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/render-main-swml" +title: "renderMainSwml" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.renderMainSwml" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `renderMainSwml` + +Extension point: render the SWML document for the main path or for +GET /swaig. + +Default returns the currently-built Document. AgentBase +overrides to emit prompt + AI verb at request time. + +## Signature + +```java +protected java.util.Map renderMainSwml(HttpExchange exchange) +``` + +## Parameters + + + +## Returns + +`java.util.Map` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 331. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/request.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/request.mdx new file mode 100644 index 0000000000..4bdc130d1d --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/request.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/request" +title: "request" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.request" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `request` + +## Signature + +```java +public Service request(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 555. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/resolve-port.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/resolve-port.mdx new file mode 100644 index 0000000000..3294770156 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/resolve-port.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/resolve-port" +title: "resolvePort" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.resolvePort" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `resolvePort` + +**Modifiers:** `static` + +## Signature + +```java +protected static int resolvePort() +``` + +## Returns + +`int` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 105. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/return-verb.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/return-verb.mdx new file mode 100644 index 0000000000..c87d9eddbb --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/return-verb.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/return-verb" +title: "returnVerb" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.returnVerb" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `returnVerb` + +## Signature + +```java +public Service returnVerb(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 560. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-digits.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-digits.mdx new file mode 100644 index 0000000000..a720b96c66 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-digits.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/send-digits" +title: "sendDigits" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.sendDigits" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `sendDigits` + +## Signature + +```java +public Service sendDigits(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 570. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-fax.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-fax.mdx new file mode 100644 index 0000000000..ac314c280e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-fax.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/send-fax" +title: "sendFax" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.sendFax" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `sendFax` + +## Signature + +```java +public Service sendFax(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 575. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-json.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-json.mdx new file mode 100644 index 0000000000..ca437fad72 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-json.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/send-json" +title: "sendJson" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.sendJson" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `sendJson` + +Send a JSON response. + +## Signature + +```java +protected void sendJson(HttpExchange exchange, int status, Object body) +``` + +## Parameters + + + + + + + +## Throws + +- `IOException` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 661. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-payload-too-large.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-payload-too-large.mdx new file mode 100644 index 0000000000..6a98f63464 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-payload-too-large.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/send-payload-too-large" +title: "sendPayloadTooLarge" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.sendPayloadTooLarge" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `sendPayloadTooLarge` + +Send a 413 Payload Too Large response. + +## Signature + +```java +protected void sendPayloadTooLarge(HttpExchange exchange) +``` + +## Parameters + + + +## Throws + +- `IOException` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 683. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-sms.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-sms.mdx new file mode 100644 index 0000000000..90a48ea719 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-sms.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/send-sms" +title: "sendSms" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.sendSms" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `sendSms` + +## Signature + +```java +public Service sendSms(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 580. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-unauthorized.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-unauthorized.mdx new file mode 100644 index 0000000000..68c1e658e6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/send-unauthorized.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/send-unauthorized" +title: "sendUnauthorized" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.sendUnauthorized" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `sendUnauthorized` + +Send a 401 Unauthorized response. + +## Signature + +```java +protected void sendUnauthorized(HttpExchange exchange) +``` + +## Parameters + + + +## Throws + +- `IOException` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 674. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/serve.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/serve.mdx new file mode 100644 index 0000000000..e449e3dd6e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/serve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/serve" +title: "serve" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.serve" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `serve` + +Start the HTTP server with health, ready, /swaig, and main SWML endpoint. +Subclasses (AgentBase) add additional routes via +`#registerAdditionalRoutes(HttpServer)` and customize SWML +rendering via `#renderMainSwml(HttpExchange)`. + +## Signature + +```java +public void serve() +``` + +## Throws + +- `IOException` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 694. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/set.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/set.mdx new file mode 100644 index 0000000000..4668694751 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/set.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/set" +title: "set" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.set" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `set` + +## Signature + +```java +public Service set(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 585. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/sip-refer.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/sip-refer.mdx new file mode 100644 index 0000000000..b036b6edb9 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/sip-refer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/sip-refer" +title: "sipRefer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.sipRefer" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `sipRefer` + +## Signature + +```java +public Service sipRefer(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 565. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/sleep.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/sleep.mdx new file mode 100644 index 0000000000..6981a0979f --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/sleep.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/sleep" +title: "sleep" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.sleep" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `sleep` + +Sleep takes an integer (milliseconds), not a map. + +## Signature + +```java +public Service sleep(int milliseconds) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 593. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop-denoise.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop-denoise.mdx new file mode 100644 index 0000000000..700ea225dc --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop-denoise.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/stop-denoise" +title: "stopDenoise" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.stopDenoise" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `stopDenoise` + +## Signature + +```java +public Service stopDenoise(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 598. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop-record-call.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop-record-call.mdx new file mode 100644 index 0000000000..e6566dec47 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop-record-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/stop-record-call" +title: "stopRecordCall" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.stopRecordCall" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `stopRecordCall` + +## Signature + +```java +public Service stopRecordCall(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 603. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop-tap.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop-tap.mdx new file mode 100644 index 0000000000..5ba9c3d00e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop-tap.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/stop-tap" +title: "stopTap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.stopTap" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `stopTap` + +## Signature + +```java +public Service stopTap(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 608. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop.mdx new file mode 100644 index 0000000000..11e7f3d520 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/stop" +title: "stop" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.stop" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `stop` + +Stop the HTTP server. + +## Signature + +```java +public void stop() +``` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 887. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..82c6611766 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/swaig-pre-dispatch.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/swaig-pre-dispatch" +title: "swaigPreDispatch" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.swaigPreDispatch" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `swaigPreDispatch` + +Extension point: invoked between argument parsing and function +dispatch. + +Returns a 2-element array: \[target Service, shortCircuit Map]. +If shortCircuit is non-null, it's returned as the SWAIG response +without calling onFunctionCall. AgentBase may override to add +session-token validation or ephemeral dynamic-config copies. + +## Signature + +```java +protected Object[] swaigPreDispatch( + java.util.Map requestData, + String funcName +) +``` + +## Parameters + + + + + +## Returns + +`Object[]` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 321. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/switch-verb.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/switch-verb.mdx new file mode 100644 index 0000000000..7005e0d303 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/switch-verb.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/switch-verb" +title: "switchVerb" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.switchVerb" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `switchVerb` + +## Signature + +```java +public Service switchVerb(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 613. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/tap.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/tap.mdx new file mode 100644 index 0000000000..fb65ec09d4 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/tap.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/tap" +title: "tap" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.tap" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `tap` + +## Signature + +```java +public Service tap(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 618. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/transfer.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/transfer.mdx new file mode 100644 index 0000000000..15f2a0b349 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/transfer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/transfer" +title: "transfer" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.transfer" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `transfer` + +## Signature + +```java +public Service transfer(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 623. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/unset.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/unset.mdx new file mode 100644 index 0000000000..9dd2cf833e --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/unset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/unset" +title: "unset" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.unset" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `unset` + +## Signature + +```java +public Service unset(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 628. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/user-event.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/user-event.mdx new file mode 100644 index 0000000000..e5ec859a99 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/user-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/user-event" +title: "userEvent" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.userEvent" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `userEvent` + +## Signature + +```java +public Service userEvent(Map params) +``` + +## Parameters + + + +## Returns + +`Service` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 633. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/validate-auth.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/validate-auth.mdx new file mode 100644 index 0000000000..0693b32770 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/validate-auth.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/validate-auth" +title: "validateAuth" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.validateAuth" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `validateAuth` + +Timing-safe basic auth validation using MessageDigest.isEqual. + +## Signature + +```java +protected boolean validateAuth(HttpExchange exchange) +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 176. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/validate-basic-auth.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/validate-basic-auth.mdx new file mode 100644 index 0000000000..9bdfe06125 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/validate-basic-auth.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/validate-basic-auth" +title: "validateBasicAuth" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.validateBasicAuth" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "public" +--- +# `validateBasicAuth` + +Validate provided basic-auth credentials against the configured ones +using a constant-time comparison. + +(Python parity: +`AuthMixin.validate_basic_auth(username, password)`.) + +## Signature + +```java +public boolean validateBasicAuth(String username, String password) +``` + +## Parameters + + + + + +## Returns + +`boolean` + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 136. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/validate-signed-webhook.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/validate-signed-webhook.mdx new file mode 100644 index 0000000000..cd2b44a0df --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/swml/swml/service/validate-signed-webhook.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/java/com/signalwire/sdk/swml/swml/service/validate-signed-webhook" +title: "validateSignedWebhook" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.swml.Service.validateSignedWebhook" + parent: "com.signalwire.sdk.swml.Service" + module: "com.signalwire.sdk.swml.Service" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java" + visibility: "protected" +--- +# `validateSignedWebhook` + +Extension hook invoked between raw-body capture and JSON parsing on +signed POST routes (`/`, `/swaig`, `/post_prompt`). +Subclasses (AgentBase) override to enforce SignalWire webhook signature +validation when a signing key is configured. + +Default returns +`true` (no validation). + +<p>Returning `false` signals "signature invalid"; the caller +sends Forbidden and stops dispatch. Per +porting-sdk/webhooks.md the response body must NOT disclose which +branch failed. + +## Signature + +```java +protected boolean validateSignedWebhook(HttpExchange exchange, String rawBody) +``` + +## Parameters + + + the HTTP exchange. + + + + the raw UTF-8 body string already read from the exchange. Pass through to `com.signalwire.sdk.security.WebhookValidator`. + + +## Returns + +`boolean` — `true` when validation passes (or is disabled); `false` to short-circuit with a 403. + +## Source + +[`src/main/java/com/signalwire/sdk/swml/Service.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/swml/Service.java) + +Line 404. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/utils/utils/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/utils/utils/index.mdx new file mode 100644 index 0000000000..d495cd28a6 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/utils/utils/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/java/com/signalwire/sdk/utils/utils" +title: "utils" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "module" + language: "java" + qualified_name: "com.signalwire.sdk.utils" + module: "com.signalwire.sdk.utils" +--- +# `utils` + +## Signature + +```java +package com.signalwire.sdk.utils +``` + +## Classes + + + + SSRF-prevention guard for user-supplied URLs. <p> Mirrors Python's <code>signalwire.utils.url\_validator.validate\_url</code>: rejects non-http(s) schemes, missing hostnames, and any URL whose hostname resolves to a private / loopback / link-local / cloud-metadata IP. + + diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/utils/utils/url-validator/index.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/utils/utils/url-validator/index.mdx new file mode 100644 index 0000000000..1e9ee70b22 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/utils/utils/url-validator/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/java/com/signalwire/sdk/utils/utils/url-validator" +title: "UrlValidator" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "class" + language: "java" + qualified_name: "com.signalwire.sdk.utils.UrlValidator" + parent: "com.signalwire.sdk.utils" + module: "com.signalwire.sdk.utils" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/utils/UrlValidator.java" + visibility: "public" +--- +# `UrlValidator` + +SSRF-prevention guard for user-supplied URLs. + +<p> +Mirrors Python's <code>signalwire.utils.url_validator.validate_url</code>: +rejects non-http(s) schemes, missing hostnames, and any URL whose +hostname resolves to a private / loopback / link-local / cloud-metadata +IP. + +The `allowPrivate` parameter (or the +`SWML_ALLOW_PRIVATE_URLS` env var with value "1", "true" or "yes", +case-insensitive) bypasses the IP-blocklist check. + +<p> +Projected onto the Python free function name `validate_url` via +scripts/enumerate_signatures.py. + +**Modifiers:** `final` + +## Signature + +```java +public final class UrlValidator +``` + +## Methods + + + + Validate that a URL is safe to fetch. + + + +## Source + +[`src/main/java/com/signalwire/sdk/utils/UrlValidator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/utils/UrlValidator.java) + +Line 30. diff --git a/fern/products/sdk-reference/java/com/signalwire/sdk/utils/utils/url-validator/validate-url.mdx b/fern/products/sdk-reference/java/com/signalwire/sdk/utils/utils/url-validator/validate-url.mdx new file mode 100644 index 0000000000..ea5637bfb3 --- /dev/null +++ b/fern/products/sdk-reference/java/com/signalwire/sdk/utils/utils/url-validator/validate-url.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/java/com/signalwire/sdk/utils/utils/url-validator/validate-url" +title: "validateUrl" +sdk_label: "Java SDK" +icon: "java" +lustri: + auto_generated: true + kind: "method" + language: "java" + qualified_name: "com.signalwire.sdk.utils.UrlValidator.validateUrl" + parent: "com.signalwire.sdk.utils.UrlValidator" + module: "com.signalwire.sdk.utils.UrlValidator" + source_url: "https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/utils/UrlValidator.java" + visibility: "public" +--- +# `validateUrl` + +Validate that a URL is safe to fetch. + +**Modifiers:** `static` + +## Signature + +```java +public static boolean validateUrl(String url, boolean allowPrivate) +``` + +## Parameters + + + URL string to validate. + + + + when true, bypass the IP-blocklist check. + + +## Returns + +`boolean` — true when the URL is safe to fetch, false otherwise. + +## Source + +[`src/main/java/com/signalwire/sdk/utils/UrlValidator.java`](https://github.com/signalwire/signalwire-java/blob/main/src/main/java/com/signalwire/sdk/utils/UrlValidator.java) + +Line 73. diff --git a/fern/products/sdk-reference/java/index.mdx b/fern/products/sdk-reference/java/index.mdx new file mode 100644 index 0000000000..e33a38895a --- /dev/null +++ b/fern/products/sdk-reference/java/index.mdx @@ -0,0 +1,34 @@ +--- +title: "Java SDK" +slug: "/reference/java" +lustri: + auto_generated: true + language: "java" + kind: "sdk" +--- +# Java SDK Reference + +## Modules + +- [`agent`](/reference/java/com/signalwire/sdk/agent/agent) +- [`builtin`](/reference/java/com/signalwire/sdk/skills/builtin/builtin) +- [`cli`](/reference/java/com/signalwire/sdk/cli/cli) +- [`contexts`](/reference/java/com/signalwire/sdk/contexts/contexts) +- [`datamap`](/reference/java/com/signalwire/sdk/datamap/datamap) +- [`lambda`](/reference/java/com/signalwire/sdk/runtime/lambda/lambda) +- [`logging`](/reference/java/com/signalwire/sdk/logging/logging) +- [`namespaces`](/reference/java/com/signalwire/sdk/rest/namespaces/namespaces) +- [`pom`](/reference/java/com/signalwire/sdk/pom/pom) +- [`prefabs`](/reference/java/com/signalwire/sdk/prefabs/prefabs) +- [`relay`](/reference/java/com/signalwire/sdk/relay/relay) +- [`rest`](/reference/java/com/signalwire/sdk/rest/rest) +- [`runtime`](/reference/java/com/signalwire/sdk/runtime/runtime) +- [`sdk`](/reference/java/com/signalwire/sdk/sdk) +- [`security`](/reference/java/com/signalwire/sdk/security/security) +- [`server`](/reference/java/com/signalwire/sdk/server/server) +- [`simulation`](/reference/java/com/signalwire/sdk/cli/simulation/simulation) +- [`skills`](/reference/java/com/signalwire/sdk/skills/skills) +- [`swaig`](/reference/java/com/signalwire/sdk/swaig/swaig) +- [`swml`](/reference/java/com/signalwire/sdk/swml/swml) +- [`utils`](/reference/java/com/signalwire/sdk/utils/utils) + diff --git a/fern/products/sdk-reference/perl/_meta.json b/fern/products/sdk-reference/perl/_meta.json new file mode 100644 index 0000000000..9a0883a324 --- /dev/null +++ b/fern/products/sdk-reference/perl/_meta.json @@ -0,0 +1,10 @@ +{ + "language": "perl", + "sdk_name": "perl-sdk", + "version": "2.0.1", + "source_repo": "https://github.com/signalwire/signalwire-perl", + "format": "mdx", + "platform": "fern", + "base_slug": "/reference/perl", + "item_count": 776 +} \ No newline at end of file diff --git a/fern/products/sdk-reference/perl/index.mdx b/fern/products/sdk-reference/perl/index.mdx new file mode 100644 index 0000000000..16f4b2d160 --- /dev/null +++ b/fern/products/sdk-reference/perl/index.mdx @@ -0,0 +1,76 @@ +--- +title: "Perl SDK" +slug: "/reference/perl" +lustri: + auto_generated: true + language: "perl" + kind: "sdk" +--- +# Perl SDK Reference +Version: **2.0.1** + +## Modules + +- [`Action`](/reference/perl/signal-wire/relay/action/action) +- [`AgentBase`](/reference/perl/signal-wire/agent/agent-base/agent-base) +- [`AgentServer`](/reference/perl/signal-wire/server/agent-server/agent-server) +- [`ApiNinjasTrivia`](/reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia) +- [`Base`](/reference/perl/signal-wire/rest/namespaces/base/base) +- [`Call`](/reference/perl/signal-wire/relay/call/call) +- [`Calling`](/reference/perl/signal-wire/rest/namespaces/calling/calling) +- [`Chat`](/reference/perl/signal-wire/rest/namespaces/chat/chat) +- [`ClaudeSkills`](/reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills) +- [`Client`](/reference/perl/signal-wire/relay/client/client) +- [`Compat`](/reference/perl/signal-wire/rest/namespaces/compat/compat) +- [`Concierge`](/reference/perl/signal-wire/prefabs/concierge/concierge) +- [`Constants`](/reference/perl/signal-wire/relay/constants/constants) +- [`CustomSkills`](/reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills) +- [`Datasphere`](/reference/perl/signal-wire/skills/builtin/datasphere/datasphere) +- [`Datasphere`](/reference/perl/signal-wire/rest/namespaces/datasphere/datasphere) +- [`DatasphereServerless`](/reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless) +- [`Datetime`](/reference/perl/signal-wire/skills/builtin/datetime/datetime) +- [`Document`](/reference/perl/signal-wire/swml/document/document) +- [`Event`](/reference/perl/signal-wire/relay/event/event) +- [`Fabric`](/reference/perl/signal-wire/rest/namespaces/fabric/fabric) +- [`FAQBot`](/reference/perl/signal-wire/prefabs/faq-bot/faq-bot) +- [`FunctionResult`](/reference/perl/signal-wire/swaig/function-result/function-result) +- [`GoogleMaps`](/reference/perl/signal-wire/skills/builtin/google-maps/google-maps) +- [`HttpClient`](/reference/perl/signal-wire/rest/http-client/http-client) +- [`InfoGatherer`](/reference/perl/signal-wire/prefabs/info-gatherer/info-gatherer) +- [`InfoGatherer`](/reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer) +- [`Joke`](/reference/perl/signal-wire/skills/builtin/joke/joke) +- [`LoggingConfig`](/reference/perl/signal-wire/core/logging-config/logging-config) +- [`Logs`](/reference/perl/signal-wire/rest/namespaces/logs/logs) +- [`Math`](/reference/perl/signal-wire/skills/builtin/math/math) +- [`McpGateway`](/reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway) +- [`Message`](/reference/perl/signal-wire/relay/message/message) +- [`NativeVectorSearch`](/reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search) +- [`Pagination`](/reference/perl/signal-wire/rest/pagination/pagination) +- [`PhoneCallHandler`](/reference/perl/signal-wire/rest/phone-call-handler/phone-call-handler) +- [`PhoneNumbers`](/reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers) +- [`PlayBackgroundFile`](/reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file) +- [`Project`](/reference/perl/signal-wire/rest/namespaces/project/project) +- [`PromptObjectModel`](/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model) +- [`PubSub`](/reference/perl/signal-wire/rest/namespaces/pub-sub/pub-sub) +- [`Receptionist`](/reference/perl/signal-wire/prefabs/receptionist/receptionist) +- [`Registry`](/reference/perl/signal-wire/rest/namespaces/registry/registry) +- [`Resources`](/reference/perl/signal-wire/rest/namespaces/resources/resources) +- [`RestClient`](/reference/perl/signal-wire/rest/rest-client/rest-client) +- [`Schema`](/reference/perl/signal-wire/swml/schema/schema) +- [`Section`](/reference/perl/signal-wire/pom/section/section) +- [`Service`](/reference/perl/signal-wire/swml/service/service) +- [`SessionManager`](/reference/perl/signal-wire/security/session-manager/session-manager) +- [`SignalWire`](/reference/perl/signal-wire/signal-wire) +- [`SkillBase`](/reference/perl/signal-wire/skills/skill-base/skill-base) +- [`SkillManager`](/reference/perl/signal-wire/skills/skill-manager/skill-manager) +- [`SkillRegistry`](/reference/perl/signal-wire/skills/skill-registry/skill-registry) +- [`Spider`](/reference/perl/signal-wire/skills/builtin/spider/spider) +- [`Survey`](/reference/perl/signal-wire/prefabs/survey/survey) +- [`SwmlTransfer`](/reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer) +- [`Video`](/reference/perl/signal-wire/rest/namespaces/video/video) +- [`WeatherApi`](/reference/perl/signal-wire/skills/builtin/weather-api/weather-api) +- [`WebhookMiddleware`](/reference/perl/signal-wire/security/webhook-middleware/webhook-middleware) +- [`WebhookValidator`](/reference/perl/signal-wire/security/webhook-validator/webhook-validator) +- [`WebSearch`](/reference/perl/signal-wire/skills/builtin/web-search/web-search) +- [`WikipediaSearch`](/reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search) + diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-function-include.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-function-include.mdx new file mode 100644 index 0000000000..7af9b27feb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-function-include.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-function-include" +title: "add_function_include" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_function_include" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_function_include` + +## Signature + +```perl +sub add_function_include($include) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 659. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-hint.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-hint.mdx new file mode 100644 index 0000000000..16083ee14c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-hint.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-hint" +title: "add_hint" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_hint" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_hint` + +## Signature + +```perl +sub add_hint($hint) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 415. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-hints.mdx new file mode 100644 index 0000000000..fff3b85f13 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-hints" +title: "add_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_hints" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_hints` + +## Signature + +```perl +sub add_hints($hints) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 421. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-internal-filler.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-internal-filler.mdx new file mode 100644 index 0000000000..1669183ffa --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-internal-filler.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-internal-filler" +title: "add_internal_filler" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_internal_filler" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_internal_filler` + +## Signature + +```perl +sub add_internal_filler(@args) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 616. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-language.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-language.mdx new file mode 100644 index 0000000000..962761e77c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-language.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-language" +title: "add_language" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_language" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_language` + +## Signature + +```perl +sub add_language(@lang) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 447. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-mcp-server.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-mcp-server.mdx new file mode 100644 index 0000000000..da0c9fbd4a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-mcp-server.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-mcp-server" +title: "add_mcp_server" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_mcp_server" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_mcp_server` + +## Signature + +```perl +sub add_mcp_server($url, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 899. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-pattern-hint.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-pattern-hint.mdx new file mode 100644 index 0000000000..999546ae0b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-pattern-hint.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-pattern-hint" +title: "add_pattern_hint" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_pattern_hint" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_pattern_hint` + +## Signature + +```perl +sub add_pattern_hint($pattern) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 441. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-post-ai-verb.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-post-ai-verb.mdx new file mode 100644 index 0000000000..a711640470 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-post-ai-verb.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-post-ai-verb" +title: "add_post_ai_verb" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_post_ai_verb" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_post_ai_verb` + +## Signature + +```perl +sub add_post_ai_verb($verb_name, $verb_config) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 697. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-post-answer-verb.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-post-answer-verb.mdx new file mode 100644 index 0000000000..51d9f2fd81 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-post-answer-verb.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-post-answer-verb" +title: "add_post_answer_verb" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_post_answer_verb" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_post_answer_verb` + +## Signature + +```perl +sub add_post_answer_verb($verb_name, $verb_config) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 691. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-pre-answer-verb.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..3217fa9b53 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-pre-answer-verb.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-pre-answer-verb" +title: "add_pre_answer_verb" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_pre_answer_verb" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_pre_answer_verb` + +## Signature + +```perl +sub add_pre_answer_verb($verb_name, $verb_config) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 685. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-pronunciation.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-pronunciation.mdx new file mode 100644 index 0000000000..bb567f2a88 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-pronunciation.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-pronunciation" +title: "add_pronunciation" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_pronunciation" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_pronunciation` + +## Signature + +```perl +sub add_pronunciation(@pron) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 500. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-skill.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-skill.mdx new file mode 100644 index 0000000000..46b9c4ac69 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-skill.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-skill" +title: "add_skill" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_skill" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_skill` + +## Signature + +```perl +sub add_skill($skill_name, $params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 807. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-swaig-query-params.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-swaig-query-params.mdx new file mode 100644 index 0000000000..390ef70ad2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/add-swaig-query-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/add-swaig-query-params" +title: "add_swaig_query_params" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::add_swaig_query_params" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `add_swaig_query_params` + +## Signature + +```perl +sub add_swaig_query_params(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 854. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/build.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/build.mdx new file mode 100644 index 0000000000..4c18b6a9ad --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/build.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/build" +title: "BUILD" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::BUILD" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `BUILD` + +## Signature + +```perl +sub BUILD() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 161. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..06c5dcca47 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-post-ai-verbs.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/clear-post-ai-verbs" +title: "clear_post_ai_verbs" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::clear_post_ai_verbs" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `clear_post_ai_verbs` + +## Signature + +```perl +sub clear_post_ai_verbs() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 715. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..730887c54d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-post-answer-verbs.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/clear-post-answer-verbs" +title: "clear_post_answer_verbs" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::clear_post_answer_verbs" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `clear_post_answer_verbs` + +## Signature + +```perl +sub clear_post_answer_verbs() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 709. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..fadee31b56 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-pre-answer-verbs.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/clear-pre-answer-verbs" +title: "clear_pre_answer_verbs" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::clear_pre_answer_verbs" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `clear_pre_answer_verbs` + +## Signature + +```perl +sub clear_pre_answer_verbs() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 703. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-swaig-query-params.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..ea025c271d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/clear-swaig-query-params.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/clear-swaig-query-params" +title: "clear_swaig_query_params" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::clear_swaig_query_params" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `clear_swaig_query_params` + +## Signature + +```perl +sub clear_swaig_query_params() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 860. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/contexts.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/contexts.mdx new file mode 100644 index 0000000000..ce87a40682 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/contexts.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/contexts" +title: "contexts" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::contexts" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `contexts` + +## Signature + +```perl +sub contexts() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 800. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/create-tool-token.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/create-tool-token.mdx new file mode 100644 index 0000000000..7f9ba87f2a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/create-tool-token.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/create-tool-token" +title: "create_tool_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::create_tool_token" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `create_tool_token` + +## Signature + +```perl +sub create_tool_token($tool_name, $call_id) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 378. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/define-contexts.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/define-contexts.mdx new file mode 100644 index 0000000000..49074da2bf --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/define-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/define-contexts" +title: "define_contexts" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::define_contexts" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `define_contexts` + +## Signature + +```perl +sub define_contexts($contexts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 735. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/enable-debug-events.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/enable-debug-events.mdx new file mode 100644 index 0000000000..b0322c94ce --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/enable-debug-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/enable-debug-events" +title: "enable_debug_events" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::enable_debug_events" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `enable_debug_events` + +## Signature + +```perl +sub enable_debug_events($level) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 652. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/enable-mcp-server.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/enable-mcp-server.mdx new file mode 100644 index 0000000000..f8a8ae913f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/enable-mcp-server.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/enable-mcp-server" +title: "enable_mcp_server" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::enable_mcp_server" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `enable_mcp_server` + +## Signature + +```perl +sub enable_mcp_server() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 909. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/extract-sip-username.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/extract-sip-username.mdx new file mode 100644 index 0000000000..3510836526 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/extract-sip-username.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/extract-sip-username" +title: "extract_sip_username" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::extract_sip_username" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `extract_sip_username` + +## Signature + +```perl +sub extract_sip_username($class_or_self, $body) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 1659. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-contexts.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-contexts.mdx new file mode 100644 index 0000000000..41ab8ab327 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-contexts.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/get-contexts" +title: "get_contexts" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::get_contexts" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `get_contexts` + +## Signature + +```perl +sub get_contexts() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 311. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-full-url.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-full-url.mdx new file mode 100644 index 0000000000..713ea177ac --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-full-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/get-full-url" +title: "get_full_url" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::get_full_url" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `get_full_url` + +## Signature + +```perl +sub get_full_url(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 1096. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-language-params.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-language-params.mdx new file mode 100644 index 0000000000..fb86163274 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-language-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/get-language-params" +title: "get_language_params" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::get_language_params" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `get_language_params` + +## Signature + +```perl +sub get_language_params($code) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 491. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-post-prompt.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-post-prompt.mdx new file mode 100644 index 0000000000..b2333668ec --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-post-prompt.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/get-post-prompt" +title: "get_post_prompt" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::get_post_prompt" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `get_post_prompt` + +## Signature + +```perl +sub get_post_prompt() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 276. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-prompt.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-prompt.mdx new file mode 100644 index 0000000000..e138322209 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-prompt.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/get-prompt" +title: "get_prompt" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::get_prompt" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `get_prompt` + +## Signature + +```perl +sub get_prompt() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 240. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-raw-prompt.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-raw-prompt.mdx new file mode 100644 index 0000000000..42abc4c1d5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/get-raw-prompt.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/get-raw-prompt" +title: "get_raw_prompt" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::get_raw_prompt" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `get_raw_prompt` + +## Signature + +```perl +sub get_raw_prompt() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 286. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/has-skill.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/has-skill.mdx new file mode 100644 index 0000000000..28b84186c0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/has-skill.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/has-skill" +title: "has_skill" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::has_skill" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `has_skill` + +## Signature + +```perl +sub has_skill($skill_name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 823. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/index.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/index.mdx new file mode 100644 index 0000000000..fc394e1fc3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/index.mdx @@ -0,0 +1,168 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base" +title: "AgentBase" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" +--- +# `AgentBase` + +## Signature + +```perl +package SignalWire::Agent::AgentBase +``` + +## Inheritance + +**Extends:** [SignalWire::SWML::Service](/reference/perl/signal-wire/swml/service/service) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/list-skills.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/list-skills.mdx new file mode 100644 index 0000000000..c333d2919b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/list-skills.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/list-skills" +title: "list_skills" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::list_skills" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `list_skills` + +## Signature + +```perl +sub list_skills() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 818. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/list-tool-names.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/list-tool-names.mdx new file mode 100644 index 0000000000..cd2490a72d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/list-tool-names.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/list-tool-names" +title: "list_tool_names" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::list_tool_names" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `list_tool_names` + +## Signature + +```perl +sub list_tool_names() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 795. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/manual-set-proxy-url.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..b6e93c2163 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/manual-set-proxy-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/manual-set-proxy-url" +title: "manual_set_proxy_url" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::manual_set_proxy_url" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `manual_set_proxy_url` + +## Signature + +```perl +sub manual_set_proxy_url($url) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 848. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/on-debug-event.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/on-debug-event.mdx new file mode 100644 index 0000000000..2743a4fa10 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/on-debug-event.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/on-debug-event" +title: "on_debug_event" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::on_debug_event" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `on_debug_event` + +## Signature + +```perl +sub on_debug_event($cb) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 891. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/on-summary.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/on-summary.mdx new file mode 100644 index 0000000000..f4b0d3acf5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/on-summary.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/on-summary" +title: "on_summary" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::on_summary" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `on_summary` + +## Signature + +```perl +sub on_summary($summary, $raw_data) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 866. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/pom.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/pom.mdx new file mode 100644 index 0000000000..f5df71d87e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/pom.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/pom" +title: "pom" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::pom" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `pom` + +## Signature + +```perl +sub pom() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 257. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-section.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-section.mdx new file mode 100644 index 0000000000..50490f5ba3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-section.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-section" +title: "prompt_add_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::prompt_add_section" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `prompt_add_section` + +## Signature + +```perl +sub prompt_add_section($title, $body, %opts) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 190. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-subsection.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-subsection.mdx new file mode 100644 index 0000000000..e5df80a51e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-subsection.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-subsection" +title: "prompt_add_subsection" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::prompt_add_subsection" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `prompt_add_subsection` + +## Signature + +```perl +sub prompt_add_subsection($parent_title, $title, $body, %opts) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 201. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-to-section.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-to-section.mdx new file mode 100644 index 0000000000..bb839cc4b8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-to-section.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/prompt-add-to-section" +title: "prompt_add_to_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::prompt_add_to_section" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `prompt_add_to_section` + +## Signature + +```perl +sub prompt_add_to_section($title, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 215. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-has-section.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-has-section.mdx new file mode 100644 index 0000000000..79ec15f2dd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/prompt-has-section.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/prompt-has-section" +title: "prompt_has_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::prompt_has_section" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `prompt_has_section` + +## Signature + +```perl +sub prompt_has_section($title) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 232. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/psgi-app.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/psgi-app.mdx new file mode 100644 index 0000000000..6a6c3f6d8d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/psgi-app.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/psgi-app" +title: "psgi_app" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::psgi_app" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `psgi_app` + +## Signature + +```perl +sub psgi_app() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 1271. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/remove-skill.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/remove-skill.mdx new file mode 100644 index 0000000000..feb88b23ae --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/remove-skill.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/remove-skill" +title: "remove_skill" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::remove_skill" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `remove_skill` + +## Signature + +```perl +sub remove_skill($skill_name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 813. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/render-swml.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/render-swml.mdx new file mode 100644 index 0000000000..a7204207a6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/render-swml.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/render-swml" +title: "render_swml" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::render_swml" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `render_swml` + +## Signature + +```perl +sub render_swml($request_env) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 1111. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/reset-contexts.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/reset-contexts.mdx new file mode 100644 index 0000000000..08b8d6d9d6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/reset-contexts.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/reset-contexts" +title: "reset_contexts" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::reset_contexts" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `reset_contexts` + +## Signature + +```perl +sub reset_contexts() +``` + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 782. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/run.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/run.mdx new file mode 100644 index 0000000000..6148d6a885 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/run.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/run" +title: "run" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::run" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `run` + +## Signature + +```perl +sub run(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 1620. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/serve.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/serve.mdx new file mode 100644 index 0000000000..c0aa46871a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/serve.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/serve" +title: "serve" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::serve" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `serve` + +## Signature + +```perl +sub serve(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 1625. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-answer-config.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-answer-config.mdx new file mode 100644 index 0000000000..f39b904f63 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-answer-config.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-answer-config" +title: "set_answer_config" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_answer_config" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_answer_config` + +## Signature + +```perl +sub set_answer_config($config) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 721. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..e6d22d15ff --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-dynamic-config-callback.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-dynamic-config-callback" +title: "set_dynamic_config_callback" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_dynamic_config_callback" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_dynamic_config_callback` + +## Signature + +```perl +sub set_dynamic_config_callback($cb) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 830. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-function-includes.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-function-includes.mdx new file mode 100644 index 0000000000..ec77e4ef3e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-function-includes.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-function-includes" +title: "set_function_includes" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_function_includes" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_function_includes` + +## Signature + +```perl +sub set_function_includes($includes) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 665. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-global-data.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-global-data.mdx new file mode 100644 index 0000000000..61f579c1de --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-global-data" +title: "set_global_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_global_data" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_global_data` + +## Signature + +```perl +sub set_global_data($data) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 524. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-internal-fillers.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-internal-fillers.mdx new file mode 100644 index 0000000000..bea6d53996 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-internal-fillers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-internal-fillers" +title: "set_internal_fillers" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_internal_fillers" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_internal_fillers` + +## Signature + +```perl +sub set_internal_fillers($fillers) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 584. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-language-params.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-language-params.mdx new file mode 100644 index 0000000000..da5a58c3a9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-language-params.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-language-params" +title: "set_language_params" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_language_params" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_language_params` + +## Signature + +```perl +sub set_language_params($code, $params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 474. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-languages.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-languages.mdx new file mode 100644 index 0000000000..96a07889fe --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-languages.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-languages" +title: "set_languages" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_languages" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_languages` + +## Signature + +```perl +sub set_languages($langs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 464. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-native-functions.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-native-functions.mdx new file mode 100644 index 0000000000..6545082fec --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-native-functions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-native-functions" +title: "set_native_functions" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_native_functions" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_native_functions` + +## Signature + +```perl +sub set_native_functions($funcs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 536. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-param.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-param.mdx new file mode 100644 index 0000000000..040b812ccc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-param.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-param" +title: "set_param" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_param" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_param` + +## Signature + +```perl +sub set_param($key, $value) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 512. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-params.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-params.mdx new file mode 100644 index 0000000000..c6c3b3211a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-params" +title: "set_params" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_params" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_params` + +## Signature + +```perl +sub set_params($p) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 518. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..72bbb8c2fe --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt-llm-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt-llm-params" +title: "set_post_prompt_llm_params" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_post_prompt_llm_params" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_post_prompt_llm_params` + +## Signature + +```perl +sub set_post_prompt_llm_params(@p) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 677. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt-url.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt-url.mdx new file mode 100644 index 0000000000..911b86232b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt-url" +title: "set_post_prompt_url" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_post_prompt_url" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_post_prompt_url` + +## Signature + +```perl +sub set_post_prompt_url($url) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 842. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt.mdx new file mode 100644 index 0000000000..ad082fb956 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-post-prompt" +title: "set_post_prompt" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_post_prompt" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_post_prompt` + +## Signature + +```perl +sub set_post_prompt($text) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 184. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-llm-params.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..5f9c3e7992 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-llm-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-llm-params" +title: "set_prompt_llm_params" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_prompt_llm_params" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_prompt_llm_params` + +## Signature + +```perl +sub set_prompt_llm_params(@p) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 671. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-pom.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-pom.mdx new file mode 100644 index 0000000000..2bf132ea72 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-pom.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-pom" +title: "set_prompt_pom" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_prompt_pom" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_prompt_pom` + +## Signature + +```perl +sub set_prompt_pom($pom) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 298. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-text.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-text.mdx new file mode 100644 index 0000000000..40755c36fc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-text.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-prompt-text" +title: "set_prompt_text" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_prompt_text" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_prompt_text` + +## Signature + +```perl +sub set_prompt_text($text) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 178. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-pronunciations.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-pronunciations.mdx new file mode 100644 index 0000000000..7d3583e13e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-pronunciations.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-pronunciations" +title: "set_pronunciations" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_pronunciations" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_pronunciations` + +## Signature + +```perl +sub set_pronunciations($prons) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 506. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-web-hook-url.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-web-hook-url.mdx new file mode 100644 index 0000000000..62689bf168 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/set-web-hook-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/set-web-hook-url" +title: "set_web_hook_url" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::set_web_hook_url" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `set_web_hook_url` + +## Signature + +```perl +sub set_web_hook_url($url) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 836. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/update-global-data.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/update-global-data.mdx new file mode 100644 index 0000000000..02183c0d85 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/update-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/update-global-data" +title: "update_global_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::update_global_data" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `update_global_data` + +## Signature + +```perl +sub update_global_data($data) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 530. diff --git a/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/validate-tool-token.mdx b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/validate-tool-token.mdx new file mode 100644 index 0000000000..3c07629b8b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/agent/agent-base/agent-base/validate-tool-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/agent/agent-base/agent-base/validate-tool-token" +title: "validate_tool_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Agent::AgentBase::validate_tool_token" + parent: "SignalWire::Agent::AgentBase" + module: "SignalWire.Agent.AgentBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm" + visibility: "public" +--- +# `validate_tool_token` + +## Signature + +```perl +sub validate_tool_token($function_name, $token, $call_id) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/Agent/AgentBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Agent/AgentBase.pm) + +Line 396. diff --git a/fern/products/sdk-reference/perl/signal-wire/core/logging-config/logging-config/get-execution-mode.mdx b/fern/products/sdk-reference/perl/signal-wire/core/logging-config/logging-config/get-execution-mode.mdx new file mode 100644 index 0000000000..d78d2a0810 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/core/logging-config/logging-config/get-execution-mode.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/core/logging-config/logging-config/get-execution-mode" +title: "get_execution_mode" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Core::LoggingConfig::get_execution_mode" + parent: "SignalWire::Core::LoggingConfig" + module: "SignalWire.Core.LoggingConfig" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Core/LoggingConfig.pm" + visibility: "public" +--- +# `get_execution_mode` + +## Signature + +```perl +sub get_execution_mode() +``` + +## Source + +[`lib/SignalWire/Core/LoggingConfig.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Core/LoggingConfig.pm) + +Line 33. diff --git a/fern/products/sdk-reference/perl/signal-wire/core/logging-config/logging-config/get-logger.mdx b/fern/products/sdk-reference/perl/signal-wire/core/logging-config/logging-config/get-logger.mdx new file mode 100644 index 0000000000..54f96eb6ca --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/core/logging-config/logging-config/get-logger.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/core/logging-config/logging-config/get-logger" +title: "get_logger" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Core::LoggingConfig::get_logger" + parent: "SignalWire::Core::LoggingConfig" + module: "SignalWire.Core.LoggingConfig" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Core/LoggingConfig.pm" + visibility: "public" +--- +# `get_logger` + +## Signature + +```perl +sub get_logger($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Core/LoggingConfig.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Core/LoggingConfig.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/core/logging-config/logging-config/index.mdx b/fern/products/sdk-reference/perl/signal-wire/core/logging-config/logging-config/index.mdx new file mode 100644 index 0000000000..42327ce75c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/core/logging-config/logging-config/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/core/logging-config/logging-config" +title: "LoggingConfig" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Core::LoggingConfig" + module: "SignalWire.Core.LoggingConfig" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Core/LoggingConfig.pm" +--- +# `LoggingConfig` + +## Signature + +```perl +package SignalWire::Core::LoggingConfig +``` + +## Methods + + + + + + + +## Source + +[`lib/SignalWire/Core/LoggingConfig.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Core/LoggingConfig.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/add-pom-as-subsection.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/add-pom-as-subsection.mdx new file mode 100644 index 0000000000..a6f76a2179 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/add-pom-as-subsection.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/add-pom-as-subsection" +title: "add_pom_as_subsection" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::PromptObjectModel::add_pom_as_subsection" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm" + visibility: "public" +--- +# `add_pom_as_subsection` + +## Signature + +```perl +sub add_pom_as_subsection($target, $pom_to_add) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/POM/PromptObjectModel.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm) + +Line 322. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/add-section.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/add-section.mdx new file mode 100644 index 0000000000..2b1d9d33b5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/add-section.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/add-section" +title: "add_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::PromptObjectModel::add_section" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm" + visibility: "public" +--- +# `add_section` + +## Signature + +```perl +sub add_section(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/POM/PromptObjectModel.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm) + +Line 169. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/find-section.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/find-section.mdx new file mode 100644 index 0000000000..08feb03d6b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/find-section.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/find-section" +title: "find_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::PromptObjectModel::find_section" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm" + visibility: "public" +--- +# `find_section` + +## Signature + +```perl +sub find_section($title) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/POM/PromptObjectModel.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm) + +Line 198. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/from-json.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/from-json.mdx new file mode 100644 index 0000000000..edddf7d448 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/from-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/from-json" +title: "from_json" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::PromptObjectModel::from_json" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm" + visibility: "public" +--- +# `from_json` + +## Signature + +```perl +sub from_json($class_or_self, $json_data) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/POM/PromptObjectModel.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm) + +Line 48. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/from-yaml.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/from-yaml.mdx new file mode 100644 index 0000000000..95bc259c59 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/from-yaml.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/from-yaml" +title: "from_yaml" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::PromptObjectModel::from_yaml" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm" + visibility: "public" +--- +# `from_yaml` + +## Signature + +```perl +sub from_yaml($class_or_self, $yaml_data) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/POM/PromptObjectModel.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm) + +Line 67. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/index.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/index.mdx new file mode 100644 index 0000000000..a43c454e8a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/index.mdx @@ -0,0 +1,86 @@ +--- +slug: "/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model" +title: "PromptObjectModel" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm" +--- +# `PromptObjectModel` + +[SignalWire::POM::PromptObjectModel](SignalWire::POM::PromptObjectModel) is a Perl port of `signalwire.pom.pom.PromptObjectModel` from the Python SignalWire SDK. It owns an ordered list of [SignalWire::POM::Section](SignalWire::POM::Section) objects and provides JSON / YAML serialisation, Markdown / XML rendering, recursive title-based search, and POM-merging via `add_pom_as_subsection`. + +The serialised form is byte-for-byte identical to the Python reference; prompts authored in either language can be loaded by the other. + +**Synopsis** + +```perl +use SignalWire::POM::PromptObjectModel; +``` + +```perl +my $pom = SignalWire::POM::PromptObjectModel->new; +my $sec = $pom->add_section( + title => 'Greeting', + body => 'You are a helpful assistant.', +); +$sec->add_subsection( + title => 'Tone', + body => 'Speak warmly.', +); +``` + +```perl +print $pom->render_markdown; +print $pom->render_xml; +``` + +```perl +my $json = $pom->to_json; +my $back = SignalWire::POM::PromptObjectModel->from_json($json); +``` + +## Signature + +```perl +package SignalWire::POM::PromptObjectModel +``` + +## See Also + +- \[[SignalWire::POM::Section](SignalWire::POM::Section)]\(xref://[SignalWire::POM::Section](SignalWire::POM::Section)) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/POM/PromptObjectModel.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/render-markdown.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/render-markdown.mdx new file mode 100644 index 0000000000..7ee284eb50 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/render-markdown.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/render-markdown" +title: "render_markdown" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::PromptObjectModel::render_markdown" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm" + visibility: "public" +--- +# `render_markdown` + +## Signature + +```perl +sub render_markdown() +``` + +## Source + +[`lib/SignalWire/POM/PromptObjectModel.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm) + +Line 254. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/render-xml.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/render-xml.mdx new file mode 100644 index 0000000000..3c1b825beb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/render-xml.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/render-xml" +title: "render_xml" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::PromptObjectModel::render_xml" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm" + visibility: "public" +--- +# `render_xml` + +## Signature + +```perl +sub render_xml() +``` + +## Source + +[`lib/SignalWire/POM/PromptObjectModel.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm) + +Line 285. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-hash.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-hash.mdx new file mode 100644 index 0000000000..4b83eb9c95 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-hash.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-hash" +title: "to_hash" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::PromptObjectModel::to_hash" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm" + visibility: "public" +--- +# `to_hash` + +## Signature + +```perl +sub to_hash() +``` + +## Source + +[`lib/SignalWire/POM/PromptObjectModel.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm) + +Line 246. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-json.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-json.mdx new file mode 100644 index 0000000000..905a2f1806 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-json" +title: "to_json" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::PromptObjectModel::to_json" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm" + visibility: "public" +--- +# `to_json` + +## Signature + +```perl +sub to_json() +``` + +## Source + +[`lib/SignalWire/POM/PromptObjectModel.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm) + +Line 217. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-yaml.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-yaml.mdx new file mode 100644 index 0000000000..5a6f1e15c8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-yaml.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/pom/prompt-object-model/prompt-object-model/to-yaml" +title: "to_yaml" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::PromptObjectModel::to_yaml" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm" + visibility: "public" +--- +# `to_yaml` + +## Signature + +```perl +sub to_yaml() +``` + +## Source + +[`lib/SignalWire/POM/PromptObjectModel.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/PromptObjectModel.pm) + +Line 232. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/section/section/add-body.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/add-body.mdx new file mode 100644 index 0000000000..6757f9c5f6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/add-body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/pom/section/section/add-body" +title: "add_body" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::Section::add_body" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm" + visibility: "public" +--- +# `add_body` + +## Signature + +```perl +sub add_body($body) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/POM/Section.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm) + +Line 81. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/section/section/add-bullets.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/add-bullets.mdx new file mode 100644 index 0000000000..dd4f0c1b3c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/add-bullets.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/pom/section/section/add-bullets" +title: "add_bullets" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::Section::add_bullets" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm" + visibility: "public" +--- +# `add_bullets` + +## Signature + +```perl +sub add_bullets($bullets) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/POM/Section.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm) + +Line 89. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/section/section/add-subsection.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/add-subsection.mdx new file mode 100644 index 0000000000..08b62bd2de --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/add-subsection.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/pom/section/section/add-subsection" +title: "add_subsection" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::Section::add_subsection" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm" + visibility: "public" +--- +# `add_subsection` + +## Signature + +```perl +sub add_subsection(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/POM/Section.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm) + +Line 100. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/section/section/build.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/build.mdx new file mode 100644 index 0000000000..230a31cf12 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/build.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/pom/section/section/build" +title: "BUILD" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::Section::BUILD" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm" + visibility: "public" +--- +# `BUILD` + +## Signature + +```perl +sub BUILD($args) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/POM/Section.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm) + +Line 63. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/section/section/index.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/index.mdx new file mode 100644 index 0000000000..cf5cf0dfcb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/index.mdx @@ -0,0 +1,76 @@ +--- +slug: "/reference/perl/signal-wire/pom/section/section" +title: "Section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm" +--- +# `Section` + +[SignalWire::POM::Section](SignalWire::POM::Section) is a Perl port of `signalwire.pom.pom.Section` from the Python SignalWire SDK. Both implementations render byte-for-byte identical Markdown/XML/JSON output so prompts authored in either language can be consumed interchangeably. + +**Synopsis** + +```perl +use SignalWire::POM::Section; +``` + +```perl +my $section = SignalWire::POM::Section->new( + title => 'Greeting', + body => 'You are a helpful assistant.', + bullets => ['Be polite', 'Be concise'], +); +``` + +```perl +my $sub = $section->add_subsection( + title => 'Tone', + body => 'Speak warmly.', +); +``` + +```perl +print $section->render_markdown; +print $section->render_xml; +``` + +## Signature + +```perl +package SignalWire::POM::Section +``` + +## See Also + +- [SignalWire::POM::PromptObjectModel](SignalWire::POM::PromptObjectModel) — the top-level container that holds a list of Sections. + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/POM/Section.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/section/section/render-markdown.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/render-markdown.mdx new file mode 100644 index 0000000000..428df4d4dd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/render-markdown.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/pom/section/section/render-markdown" +title: "render_markdown" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::Section::render_markdown" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm" + visibility: "public" +--- +# `render_markdown` + +## Signature + +```perl +sub render_markdown($level, $section_number) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/POM/Section.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm) + +Line 150. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/section/section/render-xml.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/render-xml.mdx new file mode 100644 index 0000000000..a552516987 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/render-xml.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/pom/section/section/render-xml" +title: "render_xml" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::Section::render_xml" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm" + visibility: "public" +--- +# `render_xml` + +## Signature + +```perl +sub render_xml($indent, $section_number) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/POM/Section.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm) + +Line 219. diff --git a/fern/products/sdk-reference/perl/signal-wire/pom/section/section/to-hash.mdx b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/to-hash.mdx new file mode 100644 index 0000000000..539fdbc2cc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/pom/section/section/to-hash.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/pom/section/section/to-hash" +title: "to_hash" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::POM::Section::to_hash" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm" + visibility: "public" +--- +# `to_hash` + +## Signature + +```perl +sub to_hash() +``` + +## Source + +[`lib/SignalWire/POM/Section.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/POM/Section.pm) + +Line 120. diff --git a/fern/products/sdk-reference/perl/signal-wire/prefabs/concierge/concierge/build.mdx b/fern/products/sdk-reference/perl/signal-wire/prefabs/concierge/concierge/build.mdx new file mode 100644 index 0000000000..d1f5ce738a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/prefabs/concierge/concierge/build.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/prefabs/concierge/concierge/build" +title: "BUILD" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Prefabs::Concierge::BUILD" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Concierge.pm" + visibility: "public" +--- +# `BUILD` + +## Signature + +```perl +sub BUILD($args) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Prefabs/Concierge.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Concierge.pm) + +Line 18. diff --git a/fern/products/sdk-reference/perl/signal-wire/prefabs/concierge/concierge/index.mdx b/fern/products/sdk-reference/perl/signal-wire/prefabs/concierge/concierge/index.mdx new file mode 100644 index 0000000000..f29d9ed0ba --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/prefabs/concierge/concierge/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/prefabs/concierge/concierge" +title: "Concierge" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Concierge.pm" +--- +# `Concierge` + +## Signature + +```perl +package SignalWire::Prefabs::Concierge +``` + +## Inheritance + +**Extends:** [SignalWire::Agent::AgentBase](/reference/perl/signal-wire/agent/agent-base/agent-base) + +## Methods + + + + + +## Source + +[`lib/SignalWire/Prefabs/Concierge.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Concierge.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/prefabs/faq-bot/faq-bot/build.mdx b/fern/products/sdk-reference/perl/signal-wire/prefabs/faq-bot/faq-bot/build.mdx new file mode 100644 index 0000000000..1c259b0e97 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/prefabs/faq-bot/faq-bot/build.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/prefabs/faq-bot/faq-bot/build" +title: "BUILD" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Prefabs::FAQBot::BUILD" + parent: "SignalWire::Prefabs::FAQBot" + module: "SignalWire.Prefabs.FAQBot" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/FAQBot.pm" + visibility: "public" +--- +# `BUILD` + +## Signature + +```perl +sub BUILD($args) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Prefabs/FAQBot.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/FAQBot.pm) + +Line 15. diff --git a/fern/products/sdk-reference/perl/signal-wire/prefabs/faq-bot/faq-bot/index.mdx b/fern/products/sdk-reference/perl/signal-wire/prefabs/faq-bot/faq-bot/index.mdx new file mode 100644 index 0000000000..718338fcbc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/prefabs/faq-bot/faq-bot/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/prefabs/faq-bot/faq-bot" +title: "FAQBot" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Prefabs::FAQBot" + module: "SignalWire.Prefabs.FAQBot" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/FAQBot.pm" +--- +# `FAQBot` + +## Signature + +```perl +package SignalWire::Prefabs::FAQBot +``` + +## Inheritance + +**Extends:** [SignalWire::Agent::AgentBase](/reference/perl/signal-wire/agent/agent-base/agent-base) + +## Methods + + + + + +## Source + +[`lib/SignalWire/Prefabs/FAQBot.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/FAQBot.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/prefabs/info-gatherer/info-gatherer/build.mdx b/fern/products/sdk-reference/perl/signal-wire/prefabs/info-gatherer/info-gatherer/build.mdx new file mode 100644 index 0000000000..d2d9526567 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/prefabs/info-gatherer/info-gatherer/build.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/prefabs/info-gatherer/info-gatherer/build" +title: "BUILD" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Prefabs::InfoGatherer::BUILD" + parent: "SignalWire::Prefabs::InfoGatherer" + module: "SignalWire.Prefabs.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/InfoGatherer.pm" + visibility: "public" +--- +# `BUILD` + +## Signature + +```perl +sub BUILD($args) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Prefabs/InfoGatherer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/InfoGatherer.pm) + +Line 13. diff --git a/fern/products/sdk-reference/perl/signal-wire/prefabs/info-gatherer/info-gatherer/index.mdx b/fern/products/sdk-reference/perl/signal-wire/prefabs/info-gatherer/info-gatherer/index.mdx new file mode 100644 index 0000000000..a809bc8a99 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/prefabs/info-gatherer/info-gatherer/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/prefabs/info-gatherer/info-gatherer" +title: "InfoGatherer" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Prefabs::InfoGatherer" + module: "SignalWire.Prefabs.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/InfoGatherer.pm" +--- +# `InfoGatherer` + +## Signature + +```perl +package SignalWire::Prefabs::InfoGatherer +``` + +## Inheritance + +**Extends:** [SignalWire::Agent::AgentBase](/reference/perl/signal-wire/agent/agent-base/agent-base) + +## Methods + + + + + +## Source + +[`lib/SignalWire/Prefabs/InfoGatherer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/InfoGatherer.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/prefabs/receptionist/receptionist/build.mdx b/fern/products/sdk-reference/perl/signal-wire/prefabs/receptionist/receptionist/build.mdx new file mode 100644 index 0000000000..ea38b5a534 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/prefabs/receptionist/receptionist/build.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/prefabs/receptionist/receptionist/build" +title: "BUILD" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Prefabs::Receptionist::BUILD" + parent: "SignalWire::Prefabs::Receptionist" + module: "SignalWire.Prefabs.Receptionist" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Receptionist.pm" + visibility: "public" +--- +# `BUILD` + +## Signature + +```perl +sub BUILD($args) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Prefabs/Receptionist.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Receptionist.pm) + +Line 15. diff --git a/fern/products/sdk-reference/perl/signal-wire/prefabs/receptionist/receptionist/index.mdx b/fern/products/sdk-reference/perl/signal-wire/prefabs/receptionist/receptionist/index.mdx new file mode 100644 index 0000000000..d2a9f41f01 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/prefabs/receptionist/receptionist/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/prefabs/receptionist/receptionist" +title: "Receptionist" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Prefabs::Receptionist" + module: "SignalWire.Prefabs.Receptionist" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Receptionist.pm" +--- +# `Receptionist` + +## Signature + +```perl +package SignalWire::Prefabs::Receptionist +``` + +## Inheritance + +**Extends:** [SignalWire::Agent::AgentBase](/reference/perl/signal-wire/agent/agent-base/agent-base) + +## Methods + + + + + +## Source + +[`lib/SignalWire/Prefabs/Receptionist.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Receptionist.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/prefabs/survey/survey/build.mdx b/fern/products/sdk-reference/perl/signal-wire/prefabs/survey/survey/build.mdx new file mode 100644 index 0000000000..a9e2d4f820 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/prefabs/survey/survey/build.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/prefabs/survey/survey/build" +title: "BUILD" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Prefabs::Survey::BUILD" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Survey.pm" + visibility: "public" +--- +# `BUILD` + +## Signature + +```perl +sub BUILD($args) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Prefabs/Survey.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Survey.pm) + +Line 18. diff --git a/fern/products/sdk-reference/perl/signal-wire/prefabs/survey/survey/index.mdx b/fern/products/sdk-reference/perl/signal-wire/prefabs/survey/survey/index.mdx new file mode 100644 index 0000000000..38a6f5f05c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/prefabs/survey/survey/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/prefabs/survey/survey" +title: "Survey" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Survey.pm" +--- +# `Survey` + +## Signature + +```perl +package SignalWire::Prefabs::Survey +``` + +## Inheritance + +**Extends:** [SignalWire::Agent::AgentBase](/reference/perl/signal-wire/agent/agent-base/agent-base) + +## Methods + + + + + +## Source + +[`lib/SignalWire/Prefabs/Survey.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Prefabs/Survey.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/collect-result.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/collect-result.mdx new file mode 100644 index 0000000000..83eef9ddb4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/collect-result.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/collect-result" +title: "collect_result" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::collect_result" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `collect_result` + +## Signature + +```perl +sub collect_result() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 197. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/detect-result.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/detect-result.mdx new file mode 100644 index 0000000000..1f2d3d9cd3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/detect-result.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/detect-result" +title: "detect_result" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::detect_result" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `detect_result` + +## Signature + +```perl +sub detect_result() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 164. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/duration.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/duration.mdx new file mode 100644 index 0000000000..92354cbe72 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/duration.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/duration" +title: "duration" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::duration" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `duration` + +## Signature + +```perl +sub duration() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 154. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/fax-result.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/fax-result.mdx new file mode 100644 index 0000000000..ce6c0c4e2e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/fax-result.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/fax-result" +title: "fax_result" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::fax_result" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `fax_result` + +## Signature + +```perl +sub fax_result() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 255. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/index.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/index.mdx new file mode 100644 index 0000000000..03c9daebc8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action" +title: "Action" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" +--- +# `Action` + +## Signature + +```perl +package SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/perl/signal-wire/relay/action/action), `SignalWire::Relay::Action::Collect` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/is-done.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/is-done.mdx new file mode 100644 index 0000000000..c9a122f749 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/is-done.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/is-done" +title: "is_done" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::is_done" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `is_done` + +## Signature + +```perl +sub is_done() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 37. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/on-completed.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/on-completed.mdx new file mode 100644 index 0000000000..f4d17bdaaf --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/on-completed.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/on-completed" +title: "on_completed" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::on_completed" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `on_completed` + +## Signature + +```perl +sub on_completed($cb) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 22. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/pause.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/pause.mdx new file mode 100644 index 0000000000..ed9b878c70 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/pause.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/pause" +title: "pause" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::pause" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `pause` + +## Signature + +```perl +sub pause() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 105. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/pause__2.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/pause__2.mdx new file mode 100644 index 0000000000..0cc587c964 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/pause__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/pause__2" +title: "pause" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::pause" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `pause` + +## Signature + +```perl +sub pause(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 134. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/pay-result.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/pay-result.mdx new file mode 100644 index 0000000000..917f72440c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/pay-result.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/pay-result" +title: "pay_result" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::pay_result" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `pay_result` + +## Signature + +```perl +sub pay_result() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 278. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/resume.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/resume.mdx new file mode 100644 index 0000000000..e2242ca443 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/resume.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/resume" +title: "resume" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::resume" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `resume` + +## Signature + +```perl +sub resume() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 110. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/resume__2.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/resume__2.mdx new file mode 100644 index 0000000000..f32f95211c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/resume__2.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/resume__2" +title: "resume" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::resume" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `resume` + +## Signature + +```perl +sub resume() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 147. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/size.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/size.mdx new file mode 100644 index 0000000000..fe4e08b6db --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/size.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/size" +title: "size" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::size" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `size` + +## Signature + +```perl +sub size() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 155. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/start-input-timers.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/start-input-timers.mdx new file mode 100644 index 0000000000..66b181c51f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/start-input-timers.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/start-input-timers" +title: "start_input_timers" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::start_input_timers" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `start_input_timers` + +## Signature + +```perl +sub start_input_timers() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 192. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/stop.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/stop.mdx new file mode 100644 index 0000000000..b3e6b54959 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/stop" +title: "stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::stop" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `stop` + +## Signature + +```perl +sub stop() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 89. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/url.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/url.mdx new file mode 100644 index 0000000000..32e1a4f78e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/url.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/url" +title: "url" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::url" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `url` + +## Signature + +```perl +sub url() +``` + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 153. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/volume.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/volume.mdx new file mode 100644 index 0000000000..35e454ccec --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/volume.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/volume" +title: "volume" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::volume" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `volume` + +## Signature + +```perl +sub volume($vol) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 115. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/action/action/wait.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/wait.mdx new file mode 100644 index 0000000000..0f3bd65e5c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/action/action/wait.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/action/action/wait" +title: "wait" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Action::wait" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm" + visibility: "public" +--- +# `wait` + +## Signature + +```perl +sub wait(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Action.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Action.pm) + +Line 43. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai-hold.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai-hold.mdx new file mode 100644 index 0000000000..797c3be376 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai-hold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/ai-hold" +title: "ai_hold" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::ai_hold" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `ai_hold` + +## Signature + +```perl +sub ai_hold(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 265. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai-message.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai-message.mdx new file mode 100644 index 0000000000..99e9492765 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai-message.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/ai-message" +title: "ai_message" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::ai_message" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `ai_message` + +## Signature + +```perl +sub ai_message(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 260. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai-unhold.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai-unhold.mdx new file mode 100644 index 0000000000..b924f869f9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai-unhold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/ai-unhold" +title: "ai_unhold" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::ai_unhold" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `ai_unhold` + +## Signature + +```perl +sub ai_unhold(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 270. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai.mdx new file mode 100644 index 0000000000..f3e5cac575 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/ai.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/ai" +title: "ai" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::ai" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `ai` + +## Signature + +```perl +sub ai(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 378. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/amazon-bedrock.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/amazon-bedrock.mdx new file mode 100644 index 0000000000..f8f47a0456 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/amazon-bedrock.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/amazon-bedrock" +title: "amazon_bedrock" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::amazon_bedrock" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `amazon_bedrock` + +## Signature + +```perl +sub amazon_bedrock(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 255. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/answer.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/answer.mdx new file mode 100644 index 0000000000..2c206f0582 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/answer.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/answer" +title: "answer" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::answer" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `answer` + +## Signature + +```perl +sub answer(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 157. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/bind-digit.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/bind-digit.mdx new file mode 100644 index 0000000000..82614e4e6e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/bind-digit.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/bind-digit" +title: "bind_digit" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::bind_digit" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `bind_digit` + +## Signature + +```perl +sub bind_digit(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 222. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/clear-digit-bindings.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/clear-digit-bindings.mdx new file mode 100644 index 0000000000..86877ed7d8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/clear-digit-bindings.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/clear-digit-bindings" +title: "clear_digit_bindings" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::clear_digit_bindings" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `clear_digit_bindings` + +## Signature + +```perl +sub clear_digit_bindings(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 227. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/collect.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/collect.mdx new file mode 100644 index 0000000000..cf61932aca --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/collect.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/collect" +title: "collect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::collect" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `collect` + +## Signature + +```perl +sub collect(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 317. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/connect.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/connect.mdx new file mode 100644 index 0000000000..59b0530a60 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/connect.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/connect" +title: "connect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::connect" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `connect` + +## Signature + +```perl +sub connect(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 172. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/denoise-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/denoise-stop.mdx new file mode 100644 index 0000000000..daeb631ef6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/denoise-stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/denoise-stop" +title: "denoise_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::denoise_stop" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `denoise_stop` + +## Signature + +```perl +sub denoise_stop() +``` + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 197. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/denoise.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/denoise.mdx new file mode 100644 index 0000000000..584f68395f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/denoise.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/denoise" +title: "denoise" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::denoise" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `denoise` + +## Signature + +```perl +sub denoise() +``` + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 192. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/detect.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/detect.mdx new file mode 100644 index 0000000000..03106e5431 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/detect.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/detect" +title: "detect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::detect" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `detect` + +## Signature + +```perl +sub detect(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 312. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/disconnect.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/disconnect.mdx new file mode 100644 index 0000000000..f34f87f15f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/disconnect.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/disconnect" +title: "disconnect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::disconnect" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `disconnect` + +## Signature + +```perl +sub disconnect() +``` + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 177. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/dispatch-event.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/dispatch-event.mdx new file mode 100644 index 0000000000..4144a96cd2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/dispatch-event.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/dispatch-event" +title: "dispatch_event" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::dispatch_event" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `dispatch_event` + +## Signature + +```perl +sub dispatch_event($event) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 81. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/echo.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/echo.mdx new file mode 100644 index 0000000000..763799d025 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/echo.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/echo" +title: "echo" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::echo" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `echo` + +## Signature + +```perl +sub echo(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 217. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/hangup.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/hangup.mdx new file mode 100644 index 0000000000..11e88dc85b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/hangup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/hangup" +title: "hangup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::hangup" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `hangup` + +## Signature + +```perl +sub hangup(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 162. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/hold.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/hold.mdx new file mode 100644 index 0000000000..1e2849276e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/hold.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/hold" +title: "hold" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::hold" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `hold` + +## Signature + +```perl +sub hold() +``` + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 182. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/index.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/index.mdx new file mode 100644 index 0000000000..9d8e2554d5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/index.mdx @@ -0,0 +1,114 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call" +title: "Call" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" +--- +# `Call` + +## Signature + +```perl +package SignalWire::Relay::Call +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/join-conference.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/join-conference.mdx new file mode 100644 index 0000000000..83fd5211bd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/join-conference.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/join-conference" +title: "join_conference" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::join_conference" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `join_conference` + +## Signature + +```perl +sub join_conference(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 207. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/join-room.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/join-room.mdx new file mode 100644 index 0000000000..17471bddc0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/join-room.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/join-room" +title: "join_room" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::join_room" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `join_room` + +## Signature + +```perl +sub join_room(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 242. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/leave-conference.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/leave-conference.mdx new file mode 100644 index 0000000000..51aacaf23c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/leave-conference.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/leave-conference" +title: "leave_conference" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::leave_conference" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `leave_conference` + +## Signature + +```perl +sub leave_conference(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 212. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/leave-room.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/leave-room.mdx new file mode 100644 index 0000000000..b260ad3437 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/leave-room.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/leave-room" +title: "leave_room" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::leave_room" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `leave_room` + +## Signature + +```perl +sub leave_room(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 247. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/live-transcribe.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/live-transcribe.mdx new file mode 100644 index 0000000000..ac1f7209de --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/live-transcribe.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/live-transcribe" +title: "live_transcribe" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::live_transcribe" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `live_transcribe` + +## Signature + +```perl +sub live_transcribe(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 232. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/live-translate.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/live-translate.mdx new file mode 100644 index 0000000000..d342e16b0d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/live-translate.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/live-translate" +title: "live_translate" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::live_translate" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `live_translate` + +## Signature + +```perl +sub live_translate(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 237. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/on.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/on.mdx new file mode 100644 index 0000000000..dbf762f421 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/on.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/on" +title: "on" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::on" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `on` + +## Signature + +```perl +sub on($cb) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 140. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/pass.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/pass.mdx new file mode 100644 index 0000000000..eb33f0d1bb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/pass.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/pass" +title: "pass" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::pass" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `pass` + +## Signature + +```perl +sub pass() +``` + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 167. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/pay.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/pay.mdx new file mode 100644 index 0000000000..26613329b7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/pay.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/pay" +title: "pay" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::pay" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `pay` + +## Signature + +```perl +sub pay(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 368. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/play-and-collect.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/play-and-collect.mdx new file mode 100644 index 0000000000..998c9c1d1e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/play-and-collect.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/play-and-collect" +title: "play_and_collect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::play_and_collect" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `play_and_collect` + +## Signature + +```perl +sub play_and_collect(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 322. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/play.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/play.mdx new file mode 100644 index 0000000000..f18276ac68 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/play.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/play" +title: "play" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::play" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `play` + +## Signature + +```perl +sub play(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 302. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/queue-enter.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/queue-enter.mdx new file mode 100644 index 0000000000..58d3eb9acb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/queue-enter.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/queue-enter" +title: "queue_enter" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::queue_enter" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `queue_enter` + +## Signature + +```perl +sub queue_enter(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 280. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/queue-leave.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/queue-leave.mdx new file mode 100644 index 0000000000..3a2bf75533 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/queue-leave.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/queue-leave" +title: "queue_leave" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::queue_leave" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `queue_leave` + +## Signature + +```perl +sub queue_leave(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 285. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/receive-fax.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/receive-fax.mdx new file mode 100644 index 0000000000..1fae62aa3b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/receive-fax.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/receive-fax" +title: "receive_fax" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::receive_fax" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `receive_fax` + +## Signature + +```perl +sub receive_fax(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 333. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/record.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/record.mdx new file mode 100644 index 0000000000..265337e27c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/record.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/record" +title: "record" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::record" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `record` + +## Signature + +```perl +sub record(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 307. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/refer.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/refer.mdx new file mode 100644 index 0000000000..eb664f107d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/refer.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/refer" +title: "refer" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::refer" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `refer` + +## Signature + +```perl +sub refer(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 290. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/send-digits.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/send-digits.mdx new file mode 100644 index 0000000000..159f076165 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/send-digits.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/send-digits" +title: "send_digits" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::send_digits" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `send_digits` + +## Signature + +```perl +sub send_digits(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 295. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/send-fax.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/send-fax.mdx new file mode 100644 index 0000000000..114f3e0fb1 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/send-fax.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/send-fax" +title: "send_fax" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::send_fax" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `send_fax` + +## Signature + +```perl +sub send_fax(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 327. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/stream.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/stream.mdx new file mode 100644 index 0000000000..1d844ec324 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/stream.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/stream" +title: "stream" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::stream" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `stream` + +## Signature + +```perl +sub stream(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 363. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/tap.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/tap.mdx new file mode 100644 index 0000000000..4f2fefd20a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/tap.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/tap" +title: "tap" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::tap" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `tap` + +## Signature + +```perl +sub tap(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 358. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/transcribe.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/transcribe.mdx new file mode 100644 index 0000000000..548543d417 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/transcribe.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/transcribe" +title: "transcribe" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::transcribe" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `transcribe` + +## Signature + +```perl +sub transcribe(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 373. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/transfer.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/transfer.mdx new file mode 100644 index 0000000000..63161c3f66 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/transfer.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/transfer" +title: "transfer" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::transfer" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `transfer` + +## Signature + +```perl +sub transfer(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 202. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/unhold.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/unhold.mdx new file mode 100644 index 0000000000..13b75bc337 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/unhold.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/unhold" +title: "unhold" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::unhold" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `unhold` + +## Signature + +```perl +sub unhold() +``` + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 187. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/call/call/user-event.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/user-event.mdx new file mode 100644 index 0000000000..b906c38a6a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/call/call/user-event.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/call/call/user-event" +title: "user_event" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Call::user_event" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm" + visibility: "public" +--- +# `user_event` + +## Signature + +```perl +sub user_event(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Call.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Call.pm) + +Line 275. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/authenticate.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/authenticate.mdx new file mode 100644 index 0000000000..6c09e719bd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/authenticate.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/authenticate" +title: "authenticate" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::authenticate" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `authenticate` + +## Signature + +```perl +sub authenticate() +``` + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 213. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/connect-ws.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/connect-ws.mdx new file mode 100644 index 0000000000..784cb20c3a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/connect-ws.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/connect-ws" +title: "connect_ws" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::connect_ws" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `connect_ws` + +## Signature + +```perl +sub connect_ws() +``` + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 125. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/connect.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/connect.mdx new file mode 100644 index 0000000000..a64ea7b1df --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/connect.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/connect" +title: "connect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::connect" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `connect` + +## Signature + +```perl +sub connect() +``` + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 109. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/dial.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/dial.mdx new file mode 100644 index 0000000000..c01ef824ae --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/dial.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/dial" +title: "dial" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::dial" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `dial` + +## Signature + +```perl +sub dial(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 395. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/disconnect-ws.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/disconnect-ws.mdx new file mode 100644 index 0000000000..f9df81f205 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/disconnect-ws.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/disconnect-ws" +title: "disconnect_ws" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::disconnect_ws" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `disconnect_ws` + +## Signature + +```perl +sub disconnect_ws() +``` + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 760. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/disconnect.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/disconnect.mdx new file mode 100644 index 0000000000..b7e318453b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/disconnect.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/disconnect" +title: "disconnect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::disconnect" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `disconnect` + +## Signature + +```perl +sub disconnect() +``` + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 120. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/execute.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/execute.mdx new file mode 100644 index 0000000000..44348bcb34 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/execute.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/execute" +title: "execute" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::execute" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `execute` + +## Signature + +```perl +sub execute($method, $params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 266. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/index.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/index.mdx new file mode 100644 index 0000000000..0dd7d1fb20 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client" +title: "Client" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" +--- +# `Client` + +## Signature + +```perl +package SignalWire::Relay::Client +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/on-call.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/on-call.mdx new file mode 100644 index 0000000000..40a7a33233 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/on-call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/on-call" +title: "on_call" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::on_call" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `on_call` + +## Signature + +```perl +sub on_call($cb) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 86. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/on-event.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/on-event.mdx new file mode 100644 index 0000000000..f0e3059d76 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/on-event.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/on-event" +title: "on_event" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::on_event" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `on_event` + +## Signature + +```perl +sub on_event($cb) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 98. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/on-message.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/on-message.mdx new file mode 100644 index 0000000000..96756f02d3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/on-message.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/on-message" +title: "on_message" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::on_message" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `on_message` + +## Signature + +```perl +sub on_message($cb) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 92. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/receive.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/receive.mdx new file mode 100644 index 0000000000..7a0d7b8e2a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/receive.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/receive" +title: "receive" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::receive" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `receive` + +## Signature + +```perl +sub receive($contexts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 362. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/reconnect.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/reconnect.mdx new file mode 100644 index 0000000000..d2f9578f72 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/reconnect.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/reconnect" +title: "reconnect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::reconnect" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `reconnect` + +## Signature + +```perl +sub reconnect() +``` + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 726. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/relay-protocol.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/relay-protocol.mdx new file mode 100644 index 0000000000..9df93275b8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/relay-protocol.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/relay-protocol" +title: "relay_protocol" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::relay_protocol" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `relay_protocol` + +## Signature + +```perl +sub relay_protocol() +``` + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 47. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/run.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/run.mdx new file mode 100644 index 0000000000..be9329c325 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/run.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/run" +title: "run" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::run" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `run` + +## Signature + +```perl +sub run() +``` + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 772. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/send-message.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/send-message.mdx new file mode 100644 index 0000000000..3c7df29e9d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/send-message.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/send-message" +title: "send_message" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::send_message" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `send_message` + +## Signature + +```perl +sub send_message(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 313. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/client/client/unreceive.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/unreceive.mdx new file mode 100644 index 0000000000..9df5740074 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/client/client/unreceive.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/client/client/unreceive" +title: "unreceive" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Client::unreceive" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm" + visibility: "public" +--- +# `unreceive` + +## Signature + +```perl +sub unreceive($contexts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Client.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Client.pm) + +Line 379. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/constants/constants/index.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/constants/constants/index.mdx new file mode 100644 index 0000000000..7505ceee74 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/constants/constants/index.mdx @@ -0,0 +1,76 @@ +--- +slug: "/reference/perl/signal-wire/relay/constants/constants" +title: "Constants" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Relay::Constants" + module: "SignalWire.Relay.Constants" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Constants.pm" +--- +# `Constants` + +## Signature + +```perl +package SignalWire::Relay::Constants +``` + +## Constants + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Relay/Constants.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Constants.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/event/event/index.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/event/event/index.mdx new file mode 100644 index 0000000000..75e1b6dfa9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/event/event/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/relay/event/event" +title: "Event" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Relay::Event" + module: "SignalWire.Relay.Event" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Event.pm" +--- +# `Event` + +## Signature + +```perl +package SignalWire::Relay::Event +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Event](/reference/perl/signal-wire/relay/event/event) + +## Methods + + + + + +## Source + +[`lib/SignalWire/Relay/Event.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Event.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/event/event/parse-event.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/event/event/parse-event.mdx new file mode 100644 index 0000000000..8c09d68061 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/event/event/parse-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/relay/event/event/parse-event" +title: "parse_event" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Event::parse_event" + parent: "SignalWire::Relay::Event" + module: "SignalWire.Relay.Event" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Event.pm" + visibility: "public" +--- +# `parse_event` + +## Signature + +```perl +sub parse_event($class_or_self, $event_type, $params) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/Relay/Event.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Event.pm) + +Line 253. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/message/message/dispatch-event.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/dispatch-event.mdx new file mode 100644 index 0000000000..b17979561b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/dispatch-event.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/message/message/dispatch-event" +title: "dispatch_event" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Message::dispatch_event" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm" + visibility: "public" +--- +# `dispatch_event` + +## Signature + +```perl +sub dispatch_event($event) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Message.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm) + +Line 65. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/message/message/index.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/index.mdx new file mode 100644 index 0000000000..a9e76c48b0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/perl/signal-wire/relay/message/message" +title: "Message" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm" +--- +# `Message` + +## Signature + +```perl +package SignalWire::Relay::Message +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Relay/Message.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/message/message/is-done.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/is-done.mdx new file mode 100644 index 0000000000..4adaf816f6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/is-done.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/relay/message/message/is-done" +title: "is_done" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Message::is_done" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm" + visibility: "public" +--- +# `is_done` + +## Signature + +```perl +sub is_done() +``` + +## Source + +[`lib/SignalWire/Relay/Message.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm) + +Line 27. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/message/message/on-completed.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/on-completed.mdx new file mode 100644 index 0000000000..846101b0cd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/on-completed.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/message/message/on-completed" +title: "on_completed" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Message::on_completed" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm" + visibility: "public" +--- +# `on_completed` + +## Signature + +```perl +sub on_completed($cb) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Message.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm) + +Line 33. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/message/message/on.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/on.mdx new file mode 100644 index 0000000000..de8d11e155 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/on.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/message/message/on" +title: "on" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Message::on" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm" + visibility: "public" +--- +# `on` + +## Signature + +```perl +sub on($cb) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Message.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm) + +Line 47. diff --git a/fern/products/sdk-reference/perl/signal-wire/relay/message/message/wait.mdx b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/wait.mdx new file mode 100644 index 0000000000..cd0c381436 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/relay/message/message/wait.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/relay/message/message/wait" +title: "wait" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Relay::Message::wait" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm" + visibility: "public" +--- +# `wait` + +## Signature + +```perl +sub wait(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Relay/Message.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Relay/Message.pm) + +Line 54. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/delete-request.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/delete-request.mdx new file mode 100644 index 0000000000..75f7647f8e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/delete-request.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/http-client/http-client/delete-request" +title: "delete_request" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::HttpClient::delete_request" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm" + visibility: "public" +--- +# `delete_request` + +## Signature + +```perl +sub delete_request($path) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/HttpClient.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm) + +Line 121. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/get.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/get.mdx new file mode 100644 index 0000000000..a84fa345b3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/get.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/http-client/http-client/get" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::HttpClient::get" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($path, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/HttpClient.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm) + +Line 101. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/index.mdx new file mode 100644 index 0000000000..0dd1c2eb6e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/perl/signal-wire/rest/http-client/http-client" +title: "HttpClient" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm" +--- +# `HttpClient` + +## Signature + +```perl +package SignalWire::REST::HttpClient +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/HttpClient.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/patch.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/patch.mdx new file mode 100644 index 0000000000..523bcb6795 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/patch.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/http-client/http-client/patch" +title: "patch" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::HttpClient::patch" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm" + visibility: "public" +--- +# `patch` + +## Signature + +```perl +sub patch($path, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/HttpClient.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm) + +Line 116. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/post.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/post.mdx new file mode 100644 index 0000000000..6fc0fdda54 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/post.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/http-client/http-client/post" +title: "post" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::HttpClient::post" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm" + visibility: "public" +--- +# `post` + +## Signature + +```perl +sub post($path, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/HttpClient.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm) + +Line 106. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/put.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/put.mdx new file mode 100644 index 0000000000..08e72f3951 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/http-client/http-client/put.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/http-client/http-client/put" +title: "put" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::HttpClient::put" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm" + visibility: "public" +--- +# `put` + +## Signature + +```perl +sub put($path, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/HttpClient.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/HttpClient.pm) + +Line 111. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/create.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/create.mdx new file mode 100644 index 0000000000..725cb1b9bc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/base/base/create" +title: "create" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Base::create" + parent: "SignalWire::REST::Namespaces::Base" + module: "SignalWire.REST.Namespaces.Base" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm" + visibility: "public" +--- +# `create` + +## Signature + +```perl +sub create(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Base.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm) + +Line 29. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/delete-resource.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/delete-resource.mdx new file mode 100644 index 0000000000..9106a467f7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/delete-resource.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/base/base/delete-resource" +title: "delete_resource" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Base::delete_resource" + parent: "SignalWire::REST::Namespaces::Base" + module: "SignalWire.REST.Namespaces.Base" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm" + visibility: "public" +--- +# `delete_resource` + +## Signature + +```perl +sub delete_resource($resource_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Base.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm) + +Line 45. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/get.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/get.mdx new file mode 100644 index 0000000000..067642b928 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/base/base/get" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Base::get" + parent: "SignalWire::REST::Namespaces::Base" + module: "SignalWire.REST.Namespaces.Base" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($resource_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Base.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm) + +Line 34. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/index.mdx new file mode 100644 index 0000000000..ac44d6fca6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/base/base" +title: "Base" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Base" + module: "SignalWire.REST.Namespaces.Base" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm" +--- +# `Base` + +## Signature + +```perl +package SignalWire::REST::Namespaces::Base +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::Base](/reference/perl/signal-wire/rest/namespaces/base/base) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Base.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/list.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/list.mdx new file mode 100644 index 0000000000..7892fdd101 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/base/base/list" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Base::list" + parent: "SignalWire::REST::Namespaces::Base" + module: "SignalWire.REST.Namespaces.Base" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Base.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm) + +Line 23. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/update.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/update.mdx new file mode 100644 index 0000000000..cf241a5a83 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/base/base/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/base/base/update" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Base::update" + parent: "SignalWire::REST::Namespaces::Base" + module: "SignalWire.REST.Namespaces.Base" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($resource_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Base.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Base.pm) + +Line 39. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-hold.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-hold.mdx new file mode 100644 index 0000000000..3416f15563 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-hold.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/ai-hold" +title: "ai_hold" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::ai_hold" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `ai_hold` + +## Signature + +```perl +sub ai_hold($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 71. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-message.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-message.mdx new file mode 100644 index 0000000000..e185fa3050 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/ai-message" +title: "ai_message" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::ai_message" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `ai_message` + +## Signature + +```perl +sub ai_message($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 70. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-stop.mdx new file mode 100644 index 0000000000..2f1cd05a7d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/ai-stop" +title: "ai_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::ai_stop" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `ai_stop` + +## Signature + +```perl +sub ai_stop($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 73. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-unhold.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-unhold.mdx new file mode 100644 index 0000000000..6dd8292d8f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/ai-unhold.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/ai-unhold" +title: "ai_unhold" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::ai_unhold" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `ai_unhold` + +## Signature + +```perl +sub ai_unhold($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 72. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/build.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/build.mdx new file mode 100644 index 0000000000..d5bd15715e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/build.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/build" +title: "BUILD" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::BUILD" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `BUILD` + +## Signature + +```perl +sub BUILD() +``` + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 9. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/collect-start-input-timers.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/collect-start-input-timers.mdx new file mode 100644 index 0000000000..956f9f5831 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/collect-start-input-timers.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/collect-start-input-timers" +title: "collect_start_input_timers" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::collect_start_input_timers" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `collect_start_input_timers` + +## Signature + +```perl +sub collect_start_input_timers($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 47. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/collect-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/collect-stop.mdx new file mode 100644 index 0000000000..64a40b8442 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/collect-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/collect-stop" +title: "collect_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::collect_stop" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `collect_stop` + +## Signature + +```perl +sub collect_stop($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 46. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/collect.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/collect.mdx new file mode 100644 index 0000000000..ab9d6770c0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/collect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/collect" +title: "collect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::collect" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `collect` + +## Signature + +```perl +sub collect($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 45. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/denoise-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/denoise-stop.mdx new file mode 100644 index 0000000000..43b5342e28 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/denoise-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/denoise-stop" +title: "denoise_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::denoise_stop" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `denoise_stop` + +## Signature + +```perl +sub denoise_stop($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 63. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/denoise.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/denoise.mdx new file mode 100644 index 0000000000..045251e508 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/denoise.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/denoise" +title: "denoise" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::denoise" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `denoise` + +## Signature + +```perl +sub denoise($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 62. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/detect-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/detect-stop.mdx new file mode 100644 index 0000000000..5681891fe3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/detect-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/detect-stop" +title: "detect_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::detect_stop" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `detect_stop` + +## Signature + +```perl +sub detect_stop($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 51. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/detect.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/detect.mdx new file mode 100644 index 0000000000..bff36fbcc9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/detect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/detect" +title: "detect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::detect" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `detect` + +## Signature + +```perl +sub detect($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 50. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/dial.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/dial.mdx new file mode 100644 index 0000000000..8780719e81 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/dial.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/dial" +title: "dial" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::dial" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `dial` + +## Signature + +```perl +sub dial($s, @p) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 22. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/disconnect.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/disconnect.mdx new file mode 100644 index 0000000000..5e124fd873 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/disconnect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/disconnect" +title: "disconnect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::disconnect" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `disconnect` + +## Signature + +```perl +sub disconnect($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 29. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/end.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/end.mdx new file mode 100644 index 0000000000..ba0b7a8472 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/end.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/end" +title: "end" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::end" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `end` + +## Signature + +```perl +sub end($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 27. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/index.mdx new file mode 100644 index 0000000000..b6bac27fb5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/index.mdx @@ -0,0 +1,112 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling" +title: "Calling" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" +--- +# `Calling` + +## Signature + +```perl +package SignalWire::REST::Namespaces::Calling +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::Base](/reference/perl/signal-wire/rest/namespaces/base/base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/live-transcribe.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/live-transcribe.mdx new file mode 100644 index 0000000000..d8bb084c54 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/live-transcribe.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/live-transcribe" +title: "live_transcribe" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::live_transcribe" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `live_transcribe` + +## Signature + +```perl +sub live_transcribe($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 76. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/live-translate.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/live-translate.mdx new file mode 100644 index 0000000000..704b51affd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/live-translate.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/live-translate" +title: "live_translate" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::live_translate" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `live_translate` + +## Signature + +```perl +sub live_translate($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 77. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-pause.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-pause.mdx new file mode 100644 index 0000000000..8948cdd288 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-pause.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/play-pause" +title: "play_pause" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::play_pause" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `play_pause` + +## Signature + +```perl +sub play_pause($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 33. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-resume.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-resume.mdx new file mode 100644 index 0000000000..d3a243d8d8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-resume.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/play-resume" +title: "play_resume" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::play_resume" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `play_resume` + +## Signature + +```perl +sub play_resume($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 34. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-stop.mdx new file mode 100644 index 0000000000..2a436ca6f3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/play-stop" +title: "play_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::play_stop" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `play_stop` + +## Signature + +```perl +sub play_stop($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 35. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-volume.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-volume.mdx new file mode 100644 index 0000000000..a9902d3047 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play-volume.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/play-volume" +title: "play_volume" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::play_volume" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `play_volume` + +## Signature + +```perl +sub play_volume($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 36. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play.mdx new file mode 100644 index 0000000000..fb0c47e139 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/play.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/play" +title: "play" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::play" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `play` + +## Signature + +```perl +sub play($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 32. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/receive-fax-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/receive-fax-stop.mdx new file mode 100644 index 0000000000..6de09bb1dd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/receive-fax-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/receive-fax-stop" +title: "receive_fax_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::receive_fax_stop" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `receive_fax_stop` + +## Signature + +```perl +sub receive_fax_stop($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 81. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record-pause.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record-pause.mdx new file mode 100644 index 0000000000..deaa3e3259 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record-pause.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/record-pause" +title: "record_pause" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::record_pause" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `record_pause` + +## Signature + +```perl +sub record_pause($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 40. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record-resume.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record-resume.mdx new file mode 100644 index 0000000000..203346ce63 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record-resume.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/record-resume" +title: "record_resume" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::record_resume" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `record_resume` + +## Signature + +```perl +sub record_resume($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 41. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record-stop.mdx new file mode 100644 index 0000000000..c75f20a14b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/record-stop" +title: "record_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::record_stop" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `record_stop` + +## Signature + +```perl +sub record_stop($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 42. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record.mdx new file mode 100644 index 0000000000..64a1557c73 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/record.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/record" +title: "record" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::record" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `record` + +## Signature + +```perl +sub record($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 39. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/refer.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/refer.mdx new file mode 100644 index 0000000000..874e4ac842 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/refer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/refer" +title: "refer" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::refer" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `refer` + +## Signature + +```perl +sub refer($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 84. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/send-fax-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/send-fax-stop.mdx new file mode 100644 index 0000000000..869ca8e74c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/send-fax-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/send-fax-stop" +title: "send_fax_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::send_fax_stop" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `send_fax_stop` + +## Signature + +```perl +sub send_fax_stop($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 80. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/stream-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/stream-stop.mdx new file mode 100644 index 0000000000..9690f467a7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/stream-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/stream-stop" +title: "stream_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::stream_stop" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `stream_stop` + +## Signature + +```perl +sub stream_stop($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 59. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/stream.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/stream.mdx new file mode 100644 index 0000000000..783373cdca --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/stream.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/stream" +title: "stream" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::stream" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `stream` + +## Signature + +```perl +sub stream($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 58. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/tap-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/tap-stop.mdx new file mode 100644 index 0000000000..3cd93fbbc9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/tap-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/tap-stop" +title: "tap_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::tap_stop" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `tap_stop` + +## Signature + +```perl +sub tap_stop($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 55. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/tap.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/tap.mdx new file mode 100644 index 0000000000..63d1b79e22 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/tap.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/tap" +title: "tap" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::tap" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `tap` + +## Signature + +```perl +sub tap($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 54. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/transcribe-stop.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/transcribe-stop.mdx new file mode 100644 index 0000000000..bb8f335cfc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/transcribe-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/transcribe-stop" +title: "transcribe_stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::transcribe_stop" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `transcribe_stop` + +## Signature + +```perl +sub transcribe_stop($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 67. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/transcribe.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/transcribe.mdx new file mode 100644 index 0000000000..821e6bd9a1 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/transcribe.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/transcribe" +title: "transcribe" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::transcribe" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `transcribe` + +## Signature + +```perl +sub transcribe($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 66. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/transfer.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/transfer.mdx new file mode 100644 index 0000000000..7bec4036bc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/transfer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/transfer" +title: "transfer" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::transfer" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `transfer` + +## Signature + +```perl +sub transfer($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 28. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/update-call.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/update-call.mdx new file mode 100644 index 0000000000..2b5586dfbb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/update-call.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/update-call" +title: "update_call" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::update_call" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `update_call` + +## Signature + +```perl +sub update_call($s, @p) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 26. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/update.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/update.mdx new file mode 100644 index 0000000000..8f451693a2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/update" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::update" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($s, @p) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 25. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/user-event.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/user-event.mdx new file mode 100644 index 0000000000..9d133f66d9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/calling/calling/user-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/calling/calling/user-event" +title: "user_event" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Calling::user_event" + parent: "SignalWire::REST::Namespaces::Calling" + module: "SignalWire.REST.Namespaces.Calling" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm" + visibility: "public" +--- +# `user_event` + +## Signature + +```perl +sub user_event($s, $id, @p) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Calling.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Calling.pm) + +Line 87. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/chat/chat/create-token.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/chat/chat/create-token.mdx new file mode 100644 index 0000000000..a97ca44054 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/chat/chat/create-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/chat/chat/create-token" +title: "create_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Chat::create_token" + parent: "SignalWire::REST::Namespaces::Chat" + module: "SignalWire.REST.Namespaces.Chat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Chat.pm" + visibility: "public" +--- +# `create_token` + +## Signature + +```perl +sub create_token(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Chat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Chat.pm) + +Line 7. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/chat/chat/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/chat/chat/index.mdx new file mode 100644 index 0000000000..0f49551272 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/chat/chat/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/chat/chat" +title: "Chat" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Chat" + module: "SignalWire.REST.Namespaces.Chat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Chat.pm" +--- +# `Chat` + +## Signature + +```perl +package SignalWire::REST::Namespaces::Chat +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::Base](/reference/perl/signal-wire/rest/namespaces/base/base) + +## Methods + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Chat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Chat.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/create.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/create.mdx new file mode 100644 index 0000000000..943ade2f88 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/create" +title: "create" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::create" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `create` + +## Signature + +```perl +sub create(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 17. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/create__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/create__2.mdx new file mode 100644 index 0000000000..3762144110 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/create__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/create__2" +title: "create" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::create" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `create` + +## Signature + +```perl +sub create(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 361. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-media.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-media.mdx new file mode 100644 index 0000000000..25a51338a4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-media.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/delete-media" +title: "delete_media" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::delete_media" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `delete_media` + +## Signature + +```perl +sub delete_media($message_sid, $media_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 83. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-media__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-media__2.mdx new file mode 100644 index 0000000000..54cbc7ab7b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-media__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/delete-media__2" +title: "delete_media" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::delete_media" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `delete_media` + +## Signature + +```perl +sub delete_media($fax_sid, $media_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 109. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-number.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-number.mdx new file mode 100644 index 0000000000..6cfc47124c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/delete-number" +title: "delete_number" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::delete_number" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `delete_number` + +## Signature + +```perl +sub delete_number($sid) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 221. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-recording.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-recording.mdx new file mode 100644 index 0000000000..9cc68a5a96 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-recording.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/delete-recording" +title: "delete_recording" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::delete_recording" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `delete_recording` + +## Signature + +```perl +sub delete_recording($conference_sid, $recording_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 172. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-recording__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-recording__2.mdx new file mode 100644 index 0000000000..7b00196169 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-recording__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/delete-recording__2" +title: "delete_recording" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::delete_recording" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `delete_recording` + +## Signature + +```perl +sub delete_recording($sid) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 318. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-token.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-token.mdx new file mode 100644 index 0000000000..498b48dfd6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/delete-token" +title: "delete_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::delete_token" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `delete_token` + +## Signature + +```perl +sub delete_token($token_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 371. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-transcription.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-transcription.mdx new file mode 100644 index 0000000000..42da38c2bd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete-transcription.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/delete-transcription" +title: "delete_transcription" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::delete_transcription" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `delete_transcription` + +## Signature + +```perl +sub delete_transcription($sid) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 345. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete.mdx new file mode 100644 index 0000000000..538f0730d1 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/delete" +title: "delete" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::delete" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `delete` + +## Signature + +```perl +sub delete($sid) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 227. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete__2.mdx new file mode 100644 index 0000000000..82d0c7cdcd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/delete__2" +title: "delete" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::delete" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `delete` + +## Signature + +```perl +sub delete($sid) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 324. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete__3.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete__3.mdx new file mode 100644 index 0000000000..f2b83a4490 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete__3.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/delete__3" +title: "delete" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::delete" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `delete` + +## Signature + +```perl +sub delete($sid) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 351. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete__4.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete__4.mdx new file mode 100644 index 0000000000..a4af275d12 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/delete__4.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/delete__4" +title: "delete" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::delete" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `delete` + +## Signature + +```perl +sub delete($token_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 377. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/dequeue-member.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/dequeue-member.mdx new file mode 100644 index 0000000000..e292a7e599 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/dequeue-member.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/dequeue-member" +title: "dequeue_member" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::dequeue_member" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `dequeue_member` + +## Signature + +```perl +sub dequeue_member($queue_sid, $call_sid, %kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 297. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-media.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-media.mdx new file mode 100644 index 0000000000..8bd4c9873b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-media.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/get-media" +title: "get_media" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::get_media" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `get_media` + +## Signature + +```perl +sub get_media($message_sid, $media_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 78. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-media__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-media__2.mdx new file mode 100644 index 0000000000..04726bec5c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-media__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/get-media__2" +title: "get_media" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::get_media" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `get_media` + +## Signature + +```perl +sub get_media($fax_sid, $media_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 104. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-member.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-member.mdx new file mode 100644 index 0000000000..d01cf46a55 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-member.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/get-member" +title: "get_member" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::get_member" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `get_member` + +## Signature + +```perl +sub get_member($queue_sid, $call_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 292. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-participant.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-participant.mdx new file mode 100644 index 0000000000..a195c87c2d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-participant.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/get-participant" +title: "get_participant" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::get_participant" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `get_participant` + +## Signature + +```perl +sub get_participant($conference_sid, $call_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 141. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-recording.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-recording.mdx new file mode 100644 index 0000000000..b12ac9fe0d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get-recording.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/get-recording" +title: "get_recording" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::get_recording" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `get_recording` + +## Signature + +```perl +sub get_recording($conference_sid, $recording_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 162. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get.mdx new file mode 100644 index 0000000000..4e8c13eb42 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/get" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::get" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($sid) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 22. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__2.mdx new file mode 100644 index 0000000000..8692898260 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/get__2" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::get" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($sid) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 125. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__3.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__3.mdx new file mode 100644 index 0000000000..d7674c9f4a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__3.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/get__3" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::get" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($sid) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 211. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__4.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__4.mdx new file mode 100644 index 0000000000..b9823a915f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__4.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/get__4" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::get" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($sid) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 313. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__5.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__5.mdx new file mode 100644 index 0000000000..2bc78338f6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/get__5.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/get__5" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::get" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($sid) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 340. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/import-number.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/import-number.mdx new file mode 100644 index 0000000000..7f48ba383c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/import-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/import-number" +title: "import_number" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::import_number" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `import_number` + +## Signature + +```perl +sub import_number(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 232. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/index.mdx new file mode 100644 index 0000000000..579e8472ff --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/index.mdx @@ -0,0 +1,150 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat" +title: "Compat" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" +--- +# `Compat` + +## Signature + +```perl +package SignalWire::REST::Namespaces::Compat +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::Base](/reference/perl/signal-wire/rest/namespaces/base/base), `SignalWire::REST::Namespaces::CrudResource` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-available-countries.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-available-countries.mdx new file mode 100644 index 0000000000..851804736f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-available-countries.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/list-available-countries" +title: "list_available_countries" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::list_available_countries" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `list_available_countries` + +## Signature + +```perl +sub list_available_countries(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 238. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-media.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-media.mdx new file mode 100644 index 0000000000..ab4687ab62 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-media.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/list-media" +title: "list_media" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::list_media" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `list_media` + +## Signature + +```perl +sub list_media($message_sid, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 72. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-media__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-media__2.mdx new file mode 100644 index 0000000000..cf39b98405 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-media__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/list-media__2" +title: "list_media" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::list_media" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `list_media` + +## Signature + +```perl +sub list_media($fax_sid, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 98. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-members.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-members.mdx new file mode 100644 index 0000000000..e8f9e96536 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-members.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/list-members" +title: "list_members" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::list_members" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `list_members` + +## Signature + +```perl +sub list_members($queue_sid, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 286. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-participants.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-participants.mdx new file mode 100644 index 0000000000..19ea162c51 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-participants.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/list-participants" +title: "list_participants" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::list_participants" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `list_participants` + +## Signature + +```perl +sub list_participants($conference_sid, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 135. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-recordings.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-recordings.mdx new file mode 100644 index 0000000000..2b4c74fe80 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list-recordings.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/list-recordings" +title: "list_recordings" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::list_recordings" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `list_recordings` + +## Signature + +```perl +sub list_recordings($conference_sid, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 156. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list.mdx new file mode 100644 index 0000000000..12bb69e0b9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/list" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::list" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 11. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__2.mdx new file mode 100644 index 0000000000..c544458e07 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/list__2" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::list" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 119. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__3.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__3.mdx new file mode 100644 index 0000000000..3f360c8a16 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__3.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/list__3" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::list" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 200. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__4.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__4.mdx new file mode 100644 index 0000000000..8e79998632 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__4.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/list__4" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::list" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 307. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__5.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__5.mdx new file mode 100644 index 0000000000..5f461e7c38 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/list__5.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/list__5" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::list" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 334. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/purchase.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/purchase.mdx new file mode 100644 index 0000000000..ff77fb7854 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/purchase.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/purchase" +title: "purchase" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::purchase" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `purchase` + +## Signature + +```perl +sub purchase(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 206. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/remove-participant.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/remove-participant.mdx new file mode 100644 index 0000000000..830d1bbd48 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/remove-participant.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/remove-participant" +title: "remove_participant" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::remove_participant" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `remove_participant` + +## Signature + +```perl +sub remove_participant($conference_sid, $call_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 151. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/search-local.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/search-local.mdx new file mode 100644 index 0000000000..9e9e29a8b8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/search-local.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/search-local" +title: "search_local" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::search_local" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `search_local` + +## Signature + +```perl +sub search_local($country, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 244. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/search-toll-free.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/search-toll-free.mdx new file mode 100644 index 0000000000..cbc69871dd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/search-toll-free.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/search-toll-free" +title: "search_toll_free" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::search_toll_free" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `search_toll_free` + +## Signature + +```perl +sub search_toll_free($country, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 250. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/start-recording.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/start-recording.mdx new file mode 100644 index 0000000000..47ae7131ee --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/start-recording.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/start-recording" +title: "start_recording" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::start_recording" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `start_recording` + +## Signature + +```perl +sub start_recording($call_sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 42. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/start-stream.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/start-stream.mdx new file mode 100644 index 0000000000..e2dce30385 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/start-stream.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/start-stream" +title: "start_stream" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::start_stream" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `start_stream` + +## Signature + +```perl +sub start_stream($call_sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 52. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/start-stream__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/start-stream__2.mdx new file mode 100644 index 0000000000..e3f9883573 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/start-stream__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/start-stream__2" +title: "start_stream" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::start_stream" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `start_stream` + +## Signature + +```perl +sub start_stream($conference_sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 177. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/stop-stream.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/stop-stream.mdx new file mode 100644 index 0000000000..746f610c21 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/stop-stream.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/stop-stream" +title: "stop_stream" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::stop_stream" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `stop_stream` + +## Signature + +```perl +sub stop_stream($call_sid, $stream_sid, %kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 57. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/stop-stream__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/stop-stream__2.mdx new file mode 100644 index 0000000000..755b732297 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/stop-stream__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/stop-stream__2" +title: "stop_stream" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::stop_stream" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `stop_stream` + +## Signature + +```perl +sub stop_stream($conference_sid, $stream_sid, %kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 182. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update-participant.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update-participant.mdx new file mode 100644 index 0000000000..407134f4cc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update-participant.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update-participant" +title: "update_participant" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update_participant" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update_participant` + +## Signature + +```perl +sub update_participant($conference_sid, $call_sid, %kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 146. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update-recording.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update-recording.mdx new file mode 100644 index 0000000000..808afb627d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update-recording.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update-recording" +title: "update_recording" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update_recording" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update_recording` + +## Signature + +```perl +sub update_recording($call_sid, $recording_sid, %kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 47. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update-recording__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update-recording__2.mdx new file mode 100644 index 0000000000..a059745ebc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update-recording__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update-recording__2" +title: "update_recording" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update_recording" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update_recording` + +## Signature + +```perl +sub update_recording($conference_sid, $recording_sid, %kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 167. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update.mdx new file mode 100644 index 0000000000..f8f64efb48 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 27. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__10.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__10.mdx new file mode 100644 index 0000000000..a7f0deb5d5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__10.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update__10" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($token_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 366. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__2.mdx new file mode 100644 index 0000000000..fa01267e54 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update__2" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 37. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__3.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__3.mdx new file mode 100644 index 0000000000..b63b391702 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__3.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update__3" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 67. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__4.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__4.mdx new file mode 100644 index 0000000000..9d573ec5c3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__4.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update__4" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 93. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__5.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__5.mdx new file mode 100644 index 0000000000..342b443869 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__5.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update__5" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 130. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__6.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__6.mdx new file mode 100644 index 0000000000..5fbee63423 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__6.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update__6" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 216. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__7.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__7.mdx new file mode 100644 index 0000000000..faca365bef --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__7.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update__7" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 261. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__8.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__8.mdx new file mode 100644 index 0000000000..7c0d607ca5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__8.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update__8" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 271. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__9.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__9.mdx new file mode 100644 index 0000000000..7af10af7e0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/compat/compat/update__9.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/compat/compat/update__9" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Compat::update" + parent: "SignalWire::REST::Namespaces::Compat" + module: "SignalWire.REST.Namespaces.Compat" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($sid, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Compat.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Compat.pm) + +Line 281. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/delete-chunk.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/delete-chunk.mdx new file mode 100644 index 0000000000..4f3931689a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/delete-chunk.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/delete-chunk" +title: "delete_chunk" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Datasphere::delete_chunk" + parent: "SignalWire::REST::Namespaces::Datasphere" + module: "SignalWire.REST.Namespaces.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Datasphere.pm" + visibility: "public" +--- +# `delete_chunk` + +## Signature + +```perl +sub delete_chunk($document_id, $chunk_id) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Datasphere.pm) + +Line 27. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/get-chunk.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/get-chunk.mdx new file mode 100644 index 0000000000..310d4525a4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/get-chunk.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/get-chunk" +title: "get_chunk" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Datasphere::get_chunk" + parent: "SignalWire::REST::Namespaces::Datasphere" + module: "SignalWire.REST.Namespaces.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Datasphere.pm" + visibility: "public" +--- +# `get_chunk` + +## Signature + +```perl +sub get_chunk($document_id, $chunk_id) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Datasphere.pm) + +Line 22. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/index.mdx new file mode 100644 index 0000000000..e600184498 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/datasphere/datasphere" +title: "Datasphere" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Datasphere" + module: "SignalWire.REST.Namespaces.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Datasphere.pm" +--- +# `Datasphere` + +## Signature + +```perl +package SignalWire::REST::Namespaces::Datasphere +``` + +## Inheritance + +**Extends:** `SignalWire::REST::Namespaces::CrudResource` + +## Methods + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Datasphere.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/list-chunks.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/list-chunks.mdx new file mode 100644 index 0000000000..3d6fae3039 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/list-chunks.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/list-chunks" +title: "list_chunks" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Datasphere::list_chunks" + parent: "SignalWire::REST::Namespaces::Datasphere" + module: "SignalWire.REST.Namespaces.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Datasphere.pm" + visibility: "public" +--- +# `list_chunks` + +## Signature + +```perl +sub list_chunks($document_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Datasphere.pm) + +Line 16. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/search.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/search.mdx new file mode 100644 index 0000000000..e148d1ce0a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/search.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/datasphere/datasphere/search" +title: "search" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Datasphere::search" + parent: "SignalWire::REST::Namespaces::Datasphere" + module: "SignalWire.REST.Namespaces.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Datasphere.pm" + visibility: "public" +--- +# `search` + +## Signature + +```perl +sub search(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Datasphere.pm) + +Line 11. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/assign-domain-application.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/assign-domain-application.mdx new file mode 100644 index 0000000000..f66876b973 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/assign-domain-application.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/assign-domain-application" +title: "assign_domain_application" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::assign_domain_application" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `assign_domain_application` + +## Signature + +```perl +sub assign_domain_application($resource_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 189. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/assign-phone-route.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/assign-phone-route.mdx new file mode 100644 index 0000000000..140edee172 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/assign-phone-route.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/assign-phone-route" +title: "assign_phone_route" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::assign_phone_route" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `assign_phone_route` + +## Signature + +```perl +sub assign_phone_route($resource_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 177. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-embed-token.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-embed-token.mdx new file mode 100644 index 0000000000..15f72fc20d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-embed-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-embed-token" +title: "create_embed_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::create_embed_token" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `create_embed_token` + +## Signature + +```perl +sub create_embed_token(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 235. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-guest-token.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-guest-token.mdx new file mode 100644 index 0000000000..a0c0fcaf9b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-guest-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-guest-token" +title: "create_guest_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::create_guest_token" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `create_guest_token` + +## Signature + +```perl +sub create_guest_token(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 230. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-invite-token.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-invite-token.mdx new file mode 100644 index 0000000000..f6492754d7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-invite-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-invite-token" +title: "create_invite_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::create_invite_token" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `create_invite_token` + +## Signature + +```perl +sub create_invite_token(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 225. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-sip-endpoint.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-sip-endpoint.mdx new file mode 100644 index 0000000000..b80bc05290 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-sip-endpoint.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-sip-endpoint" +title: "create_sip_endpoint" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::create_sip_endpoint" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `create_sip_endpoint` + +## Signature + +```perl +sub create_sip_endpoint($subscriber_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 114. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-subscriber-token.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-subscriber-token.mdx new file mode 100644 index 0000000000..0447093c75 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-subscriber-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/create-subscriber-token" +title: "create_subscriber_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::create_subscriber_token" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `create_subscriber_token` + +## Signature + +```perl +sub create_subscriber_token(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 215. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create.mdx new file mode 100644 index 0000000000..b46088a486 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/create" +title: "create" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::create" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `create` + +## Signature + +```perl +sub create(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 32. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create__2.mdx new file mode 100644 index 0000000000..7e3ddd4dce --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/create__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/create__2" +title: "create" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::create" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `create` + +## Signature + +```perl +sub create(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 139. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete-resource.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete-resource.mdx new file mode 100644 index 0000000000..11aa1816cb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete-resource.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete-resource" +title: "delete_resource" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::delete_resource" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `delete_resource` + +## Signature + +```perl +sub delete_resource($resource_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 160. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete-sip-endpoint.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete-sip-endpoint.mdx new file mode 100644 index 0000000000..927e92c289 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete-sip-endpoint.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete-sip-endpoint" +title: "delete_sip_endpoint" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::delete_sip_endpoint" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `delete_sip_endpoint` + +## Signature + +```perl +sub delete_sip_endpoint($subscriber_id, $endpoint_id) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 129. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete.mdx new file mode 100644 index 0000000000..87287c7873 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/delete" +title: "delete" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::delete" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `delete` + +## Signature + +```perl +sub delete($resource_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 166. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/deploy-version.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/deploy-version.mdx new file mode 100644 index 0000000000..61b573a4f6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/deploy-version.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/deploy-version" +title: "deploy_version" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::deploy_version" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `deploy_version` + +## Signature + +```perl +sub deploy_version($resource_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 85. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/get-sip-endpoint.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/get-sip-endpoint.mdx new file mode 100644 index 0000000000..918b8c5cf9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/get-sip-endpoint.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/get-sip-endpoint" +title: "get_sip_endpoint" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::get_sip_endpoint" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `get_sip_endpoint` + +## Signature + +```perl +sub get_sip_endpoint($subscriber_id, $endpoint_id) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 119. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/get.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/get.mdx new file mode 100644 index 0000000000..a7f654f3d8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/get" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::get" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($resource_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 155. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/get__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/get__2.mdx new file mode 100644 index 0000000000..3962b69116 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/get__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/get__2" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::get" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($address_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 205. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/index.mdx new file mode 100644 index 0000000000..d7b5b1e7ee --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/index.mdx @@ -0,0 +1,86 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric" +title: "Fabric" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" +--- +# `Fabric` + +## Signature + +```perl +package SignalWire::REST::Namespaces::Fabric +``` + +## Inheritance + +**Extends:** `SignalWire::REST::Namespaces::CrudResource`, `SignalWire::REST::Namespaces::Fabric::Resource`, `SignalWire::REST::Namespaces::Fabric::AutoMaterializedWebhook`, `SignalWire::REST::Namespaces::Fabric::ResourcePUT`, [SignalWire::REST::Namespaces::Base](/reference/perl/signal-wire/rest/namespaces/base/base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses.mdx new file mode 100644 index 0000000000..ba40dfd10d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses" +title: "list_addresses" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::list_addresses" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `list_addresses` + +## Signature + +```perl +sub list_addresses($resource_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 12. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__2.mdx new file mode 100644 index 0000000000..4513496db6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__2" +title: "list_addresses" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::list_addresses" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `list_addresses` + +## Signature + +```perl +sub list_addresses($resource_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 71. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__3.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__3.mdx new file mode 100644 index 0000000000..09a17d0928 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__3.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__3" +title: "list_addresses" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::list_addresses" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `list_addresses` + +## Signature + +```perl +sub list_addresses($resource_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 96. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__4.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__4.mdx new file mode 100644 index 0000000000..348e941056 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__4.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-addresses__4" +title: "list_addresses" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::list_addresses" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `list_addresses` + +## Signature + +```perl +sub list_addresses($resource_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 171. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-sip-endpoints.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-sip-endpoints.mdx new file mode 100644 index 0000000000..480c3c73dc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-sip-endpoints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-sip-endpoints" +title: "list_sip_endpoints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::list_sip_endpoints" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `list_sip_endpoints` + +## Signature + +```perl +sub list_sip_endpoints($subscriber_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 108. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-versions.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-versions.mdx new file mode 100644 index 0000000000..1e80c364e4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-versions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/list-versions" +title: "list_versions" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::list_versions" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `list_versions` + +## Signature + +```perl +sub list_versions($resource_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 78. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list.mdx new file mode 100644 index 0000000000..bcae21e445 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/list" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::list" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 149. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list__2.mdx new file mode 100644 index 0000000000..7e6583a40b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/list__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/list__2" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::list" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 199. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/refresh-subscriber-token.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/refresh-subscriber-token.mdx new file mode 100644 index 0000000000..0f2db74bbd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/refresh-subscriber-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/refresh-subscriber-token" +title: "refresh_subscriber_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::refresh_subscriber_token" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `refresh_subscriber_token` + +## Signature + +```perl +sub refresh_subscriber_token(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 220. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/update-sip-endpoint.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/update-sip-endpoint.mdx new file mode 100644 index 0000000000..08e252ef2e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/fabric/fabric/update-sip-endpoint.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/fabric/fabric/update-sip-endpoint" +title: "update_sip_endpoint" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Fabric::update_sip_endpoint" + parent: "SignalWire::REST::Namespaces::Fabric" + module: "SignalWire.REST.Namespaces.Fabric" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm" + visibility: "public" +--- +# `update_sip_endpoint` + +## Signature + +```perl +sub update_sip_endpoint($subscriber_id, $endpoint_id, %kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Fabric.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Fabric.pm) + +Line 124. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/get.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/get.mdx new file mode 100644 index 0000000000..126373fa98 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/logs/logs/get" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Logs::get" + parent: "SignalWire::REST::Namespaces::Logs" + module: "SignalWire.REST.Namespaces.Logs" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($log_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Logs.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm) + +Line 17. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/get__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/get__2.mdx new file mode 100644 index 0000000000..02c3125023 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/get__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/logs/logs/get__2" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Logs::get" + parent: "SignalWire::REST::Namespaces::Logs" + module: "SignalWire.REST.Namespaces.Logs" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($log_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Logs.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm) + +Line 33. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/get__3.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/get__3.mdx new file mode 100644 index 0000000000..5cb8284e87 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/get__3.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/logs/logs/get__3" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Logs::get" + parent: "SignalWire::REST::Namespaces::Logs" + module: "SignalWire.REST.Namespaces.Logs" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($log_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Logs.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm) + +Line 55. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/index.mdx new file mode 100644 index 0000000000..54058f78d7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/logs/logs" +title: "Logs" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Logs" + module: "SignalWire.REST.Namespaces.Logs" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm" +--- +# `Logs` + +## Signature + +```perl +package SignalWire::REST::Namespaces::Logs +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::Base](/reference/perl/signal-wire/rest/namespaces/base/base) + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Logs.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list-events.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list-events.mdx new file mode 100644 index 0000000000..dc86cac4ef --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list-events.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/logs/logs/list-events" +title: "list_events" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Logs::list_events" + parent: "SignalWire::REST::Namespaces::Logs" + module: "SignalWire.REST.Namespaces.Logs" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm" + visibility: "public" +--- +# `list_events` + +## Signature + +```perl +sub list_events($log_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Logs.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm) + +Line 38. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list.mdx new file mode 100644 index 0000000000..064eb76b49 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/logs/logs/list" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Logs::list" + parent: "SignalWire::REST::Namespaces::Logs" + module: "SignalWire.REST.Namespaces.Logs" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Logs.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm) + +Line 11. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list__2.mdx new file mode 100644 index 0000000000..e376787b38 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/logs/logs/list__2" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Logs::list" + parent: "SignalWire::REST::Namespaces::Logs" + module: "SignalWire.REST.Namespaces.Logs" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Logs.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm) + +Line 27. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list__3.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list__3.mdx new file mode 100644 index 0000000000..aeda2fff8b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list__3.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/logs/logs/list__3" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Logs::list" + parent: "SignalWire::REST::Namespaces::Logs" + module: "SignalWire.REST.Namespaces.Logs" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Logs.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm) + +Line 49. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list__4.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list__4.mdx new file mode 100644 index 0000000000..ee2e2e84e2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/logs/logs/list__4.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/logs/logs/list__4" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Logs::list" + parent: "SignalWire::REST::Namespaces::Logs" + module: "SignalWire.REST.Namespaces.Logs" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Logs.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Logs.pm) + +Line 65. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/index.mdx new file mode 100644 index 0000000000..188d44af3f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/index.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers" +title: "PhoneNumbers" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbers" + module: "SignalWire.REST.Namespaces.PhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm" +--- +# `PhoneNumbers` + +Supports the standard CRUD surface plus typed helpers for binding an inbound call to a handler (SWML webhook, cXML webhook, AI agent, call flow, RELAY application/topic). The binding model is: set `call_handler` plus the handler-specific companion field on the phone number; the server auto-materializes the matching Fabric resource. See [SignalWire::REST::PhoneCallHandler](SignalWire::REST::PhoneCallHandler) for the enum. + +**HELPERS** + +- set\_swml\_webhook($sid, url => $url) + + Route inbound calls to an SWML webhook URL. Your backend returns an SWML document per call. The server auto-creates a `swml_webhook` Fabric resource keyed off this URL. + +- set\_cxml\_webhook($sid, url => $url, fallback\_url => $f?, status\_callback\_url => $s?) + + Route inbound calls to a cXML (Twilio-compat / LAML) webhook. Despite the wire value `laml_webhooks` being plural, this creates a single `cxml_webhook` Fabric resource. + +- set\_cxml\_application($sid, application\_id => $id) + + Route inbound calls to an existing cXML application by ID. + +- set\_ai\_agent($sid, agent\_id => $id) + + Route inbound calls to an AI Agent Fabric resource by ID. + +- set\_call\_flow($sid, flow\_id => $id, version => $v?) + + Route inbound calls to a Call Flow by ID. `version` accepts `working_copy` or `current_deployed` (server default when omitted). + +- set\_relay\_application($sid, name => $name) + + Route inbound calls to a named RELAY application. + +- set\_relay\_topic($sid, topic => $topic, status\_callback\_url => $s?) + + Route inbound calls to a RELAY topic (client subscription). + +## Signature + +```perl +package SignalWire::REST::Namespaces::PhoneNumbers +``` + +## Inheritance + +**Extends:** `SignalWire::REST::Namespaces::CrudResource` + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/PhoneNumbers.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/search.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/search.mdx new file mode 100644 index 0000000000..9023fbe093 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/search.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/search" +title: "search" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbers::search" + parent: "SignalWire::REST::Namespaces::PhoneNumbers" + module: "SignalWire.REST.Namespaces.PhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm" + visibility: "public" +--- +# `search` + +## Signature + +```perl +sub search(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/PhoneNumbers.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm) + +Line 11. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-ai-agent.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-ai-agent.mdx new file mode 100644 index 0000000000..c389d12b54 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-ai-agent.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-ai-agent" +title: "set_ai_agent" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbers::set_ai_agent" + parent: "SignalWire::REST::Namespaces::PhoneNumbers" + module: "SignalWire.REST.Namespaces.PhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm" + visibility: "public" +--- +# `set_ai_agent` + +## Signature + +```perl +sub set_ai_agent($resource_id, @args) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/PhoneNumbers.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm) + +Line 65. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-call-flow.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-call-flow.mdx new file mode 100644 index 0000000000..651f1d13f0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-call-flow.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-call-flow" +title: "set_call_flow" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbers::set_call_flow" + parent: "SignalWire::REST::Namespaces::PhoneNumbers" + module: "SignalWire.REST.Namespaces.PhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm" + visibility: "public" +--- +# `set_call_flow` + +## Signature + +```perl +sub set_call_flow($resource_id, @args) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/PhoneNumbers.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm) + +Line 77. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-cxml-application.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-cxml-application.mdx new file mode 100644 index 0000000000..36dbf48f73 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-cxml-application.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-cxml-application" +title: "set_cxml_application" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbers::set_cxml_application" + parent: "SignalWire::REST::Namespaces::PhoneNumbers" + module: "SignalWire.REST.Namespaces.PhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm" + visibility: "public" +--- +# `set_cxml_application` + +## Signature + +```perl +sub set_cxml_application($resource_id, @args) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/PhoneNumbers.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm) + +Line 53. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-cxml-webhook.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-cxml-webhook.mdx new file mode 100644 index 0000000000..25772f55e1 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-cxml-webhook.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-cxml-webhook" +title: "set_cxml_webhook" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbers::set_cxml_webhook" + parent: "SignalWire::REST::Namespaces::PhoneNumbers" + module: "SignalWire.REST.Namespaces.PhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm" + visibility: "public" +--- +# `set_cxml_webhook` + +## Signature + +```perl +sub set_cxml_webhook($resource_id, @args) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/PhoneNumbers.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm) + +Line 36. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-relay-application.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-relay-application.mdx new file mode 100644 index 0000000000..ef3428c423 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-relay-application.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-relay-application" +title: "set_relay_application" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbers::set_relay_application" + parent: "SignalWire::REST::Namespaces::PhoneNumbers" + module: "SignalWire.REST.Namespaces.PhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm" + visibility: "public" +--- +# `set_relay_application` + +## Signature + +```perl +sub set_relay_application($resource_id, @args) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/PhoneNumbers.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm) + +Line 92. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-relay-topic.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-relay-topic.mdx new file mode 100644 index 0000000000..9636ff15b3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-relay-topic.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-relay-topic" +title: "set_relay_topic" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbers::set_relay_topic" + parent: "SignalWire::REST::Namespaces::PhoneNumbers" + module: "SignalWire.REST.Namespaces.PhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm" + visibility: "public" +--- +# `set_relay_topic` + +## Signature + +```perl +sub set_relay_topic($resource_id, @args) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/PhoneNumbers.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm) + +Line 104. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-swml-webhook.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-swml-webhook.mdx new file mode 100644 index 0000000000..4b14db9e71 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-swml-webhook.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/phone-numbers/phone-numbers/set-swml-webhook" +title: "set_swml_webhook" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbers::set_swml_webhook" + parent: "SignalWire::REST::Namespaces::PhoneNumbers" + module: "SignalWire.REST.Namespaces.PhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm" + visibility: "public" +--- +# `set_swml_webhook` + +## Signature + +```perl +sub set_swml_webhook($resource_id, @args) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/PhoneNumbers.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PhoneNumbers.pm) + +Line 24. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/create.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/create.mdx new file mode 100644 index 0000000000..345ee1cba7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/project/project/create" +title: "create" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Project::create" + parent: "SignalWire::REST::Namespaces::Project" + module: "SignalWire.REST.Namespaces.Project" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Project.pm" + visibility: "public" +--- +# `create` + +## Signature + +```perl +sub create(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Project.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Project.pm) + +Line 11. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/delete-token.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/delete-token.mdx new file mode 100644 index 0000000000..f3905c998f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/delete-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/project/project/delete-token" +title: "delete_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Project::delete_token" + parent: "SignalWire::REST::Namespaces::Project" + module: "SignalWire.REST.Namespaces.Project" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Project.pm" + visibility: "public" +--- +# `delete_token` + +## Signature + +```perl +sub delete_token($token_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Project.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Project.pm) + +Line 21. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/delete.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/delete.mdx new file mode 100644 index 0000000000..49a5aac96c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/project/project/delete" +title: "delete" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Project::delete" + parent: "SignalWire::REST::Namespaces::Project" + module: "SignalWire.REST.Namespaces.Project" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Project.pm" + visibility: "public" +--- +# `delete` + +## Signature + +```perl +sub delete($token_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Project.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Project.pm) + +Line 27. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/index.mdx new file mode 100644 index 0000000000..2725629260 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/project/project" +title: "Project" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Project" + module: "SignalWire.REST.Namespaces.Project" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Project.pm" +--- +# `Project` + +## Signature + +```perl +package SignalWire::REST::Namespaces::Project +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::Base](/reference/perl/signal-wire/rest/namespaces/base/base) + +## Methods + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Project.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Project.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/update.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/update.mdx new file mode 100644 index 0000000000..cbce4d005b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/project/project/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/project/project/update" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Project::update" + parent: "SignalWire::REST::Namespaces::Project" + module: "SignalWire.REST.Namespaces.Project" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Project.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($token_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Project.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Project.pm) + +Line 16. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/pub-sub/pub-sub/create-token.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/pub-sub/pub-sub/create-token.mdx new file mode 100644 index 0000000000..5f82e6c5f4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/pub-sub/pub-sub/create-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/pub-sub/pub-sub/create-token" +title: "create_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::PubSub::create_token" + parent: "SignalWire::REST::Namespaces::PubSub" + module: "SignalWire.REST.Namespaces.PubSub" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PubSub.pm" + visibility: "public" +--- +# `create_token` + +## Signature + +```perl +sub create_token(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/PubSub.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PubSub.pm) + +Line 7. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/pub-sub/pub-sub/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/pub-sub/pub-sub/index.mdx new file mode 100644 index 0000000000..85e1c3a8f7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/pub-sub/pub-sub/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/pub-sub/pub-sub" +title: "PubSub" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::PubSub" + module: "SignalWire.REST.Namespaces.PubSub" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PubSub.pm" +--- +# `PubSub` + +## Signature + +```perl +package SignalWire::REST::Namespaces::PubSub +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::Base](/reference/perl/signal-wire/rest/namespaces/base/base) + +## Methods + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/PubSub.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/PubSub.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/create-campaign.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/create-campaign.mdx new file mode 100644 index 0000000000..11068eb233 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/create-campaign.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/create-campaign" +title: "create_campaign" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::create_campaign" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `create_campaign` + +## Signature + +```perl +sub create_campaign($brand_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 33. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/create-order.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/create-order.mdx new file mode 100644 index 0000000000..23ebf9c880 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/create-order.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/create-order" +title: "create_order" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::create_order" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `create_order` + +## Signature + +```perl +sub create_order($campaign_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 65. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/create.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/create.mdx new file mode 100644 index 0000000000..13797cba09 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/create" +title: "create" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::create" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `create` + +## Signature + +```perl +sub create(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 17. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/delete-number.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/delete-number.mdx new file mode 100644 index 0000000000..f9aa1af4ef --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/delete-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/delete-number" +title: "delete_number" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::delete_number" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `delete_number` + +## Signature + +```perl +sub delete_number($number_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 85. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/delete.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/delete.mdx new file mode 100644 index 0000000000..19ed8c1e0c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/delete" +title: "delete" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::delete" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `delete` + +## Signature + +```perl +sub delete($number_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 91. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/get.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/get.mdx new file mode 100644 index 0000000000..0f984762c2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/get" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::get" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($brand_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 22. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/get__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/get__2.mdx new file mode 100644 index 0000000000..5df2797388 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/get__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/get__2" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::get" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($campaign_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 43. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/get__3.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/get__3.mdx new file mode 100644 index 0000000000..3e1a64561c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/get__3.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/get__3" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::get" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($order_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 75. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/index.mdx new file mode 100644 index 0000000000..95b62ef6d9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry" +title: "Registry" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" +--- +# `Registry` + +## Signature + +```perl +package SignalWire::REST::Namespaces::Registry +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::Base](/reference/perl/signal-wire/rest/namespaces/base/base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list-campaigns.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list-campaigns.mdx new file mode 100644 index 0000000000..7fae12e229 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list-campaigns.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/list-campaigns" +title: "list_campaigns" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::list_campaigns" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `list_campaigns` + +## Signature + +```perl +sub list_campaigns($brand_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 27. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list-numbers.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list-numbers.mdx new file mode 100644 index 0000000000..5ef9aac8c3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list-numbers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/list-numbers" +title: "list_numbers" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::list_numbers" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `list_numbers` + +## Signature + +```perl +sub list_numbers($campaign_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 53. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list-orders.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list-orders.mdx new file mode 100644 index 0000000000..4034e453cb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list-orders.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/list-orders" +title: "list_orders" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::list_orders" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `list_orders` + +## Signature + +```perl +sub list_orders($campaign_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 59. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list.mdx new file mode 100644 index 0000000000..4ca3665b7e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/list" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::list" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 11. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/update.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/update.mdx new file mode 100644 index 0000000000..94ae857a04 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/registry/registry/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/registry/registry/update" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Registry::update" + parent: "SignalWire::REST::Namespaces::Registry" + module: "SignalWire.REST.Namespaces.Registry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($campaign_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Registry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Registry.pm) + +Line 48. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/add-membership.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/add-membership.mdx new file mode 100644 index 0000000000..bac7afe489 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/add-membership.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/add-membership" +title: "add_membership" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::add_membership" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `add_membership` + +## Signature + +```perl +sub add_membership($group_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 93. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/call.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/call.mdx new file mode 100644 index 0000000000..5856aba4e8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/call" +title: "call" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::call" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `call` + +## Signature + +```perl +sub call(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 191. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/create.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/create.mdx new file mode 100644 index 0000000000..71afbea1df --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/create" +title: "create" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::create" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `create` + +## Signature + +```perl +sub create(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 17. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/create__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/create__2.mdx new file mode 100644 index 0000000000..c25a35abd4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/create__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/create__2" +title: "create" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::create" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `create` + +## Signature + +```perl +sub create(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 176. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete-membership.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete-membership.mdx new file mode 100644 index 0000000000..6494c74554 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete-membership.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/delete-membership" +title: "delete_membership" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::delete_membership" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `delete_membership` + +## Signature + +```perl +sub delete_membership($membership_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 103. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete-recording.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete-recording.mdx new file mode 100644 index 0000000000..d05fb1872d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete-recording.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/delete-recording" +title: "delete_recording" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::delete_recording" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `delete_recording` + +## Signature + +```perl +sub delete_recording($recording_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 70. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete.mdx new file mode 100644 index 0000000000..b72f37c85b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/delete" +title: "delete" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::delete" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `delete` + +## Signature + +```perl +sub delete($address_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 27. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete__2.mdx new file mode 100644 index 0000000000..96d8c07637 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/delete__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/delete__2" +title: "delete" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::delete" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `delete` + +## Signature + +```perl +sub delete($recording_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 76. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get-member.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get-member.mdx new file mode 100644 index 0000000000..ad544d8c09 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get-member.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/get-member" +title: "get_member" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::get_member" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `get_member` + +## Signature + +```perl +sub get_member($queue_id, $member_id) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 49. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get-membership.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get-membership.mdx new file mode 100644 index 0000000000..07e37ec1c8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get-membership.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/get-membership" +title: "get_membership" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::get_membership" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `get_membership` + +## Signature + +```perl +sub get_membership($membership_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 98. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get-next-member.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get-next-member.mdx new file mode 100644 index 0000000000..de85032115 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get-next-member.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/get-next-member" +title: "get_next_member" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::get_next_member" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `get_next_member` + +## Signature + +```perl +sub get_next_member($queue_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 44. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get.mdx new file mode 100644 index 0000000000..8d05353e35 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/get" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::get" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($address_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 22. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get__2.mdx new file mode 100644 index 0000000000..3a396f8b24 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/get__2" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::get" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($recording_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 65. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get__3.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get__3.mdx new file mode 100644 index 0000000000..a54e3cd03f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get__3.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/get__3" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::get" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get() +``` + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 129. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get__4.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get__4.mdx new file mode 100644 index 0000000000..d573313162 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/get__4.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/get__4" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::get" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($short_code_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 161. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/index.mdx new file mode 100644 index 0000000000..02064b49fb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/index.mdx @@ -0,0 +1,88 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources" +title: "Resources" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" +--- +# `Resources` + +## Signature + +```perl +package SignalWire::REST::Namespaces::Resources +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::Base](/reference/perl/signal-wire/rest/namespaces/base/base), `SignalWire::REST::Namespaces::CrudResource` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list-members.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list-members.mdx new file mode 100644 index 0000000000..109d8d0759 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list-members.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/list-members" +title: "list_members" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::list_members" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `list_members` + +## Signature + +```perl +sub list_members($queue_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 38. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list-memberships.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list-memberships.mdx new file mode 100644 index 0000000000..d359229037 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list-memberships.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/list-memberships" +title: "list_memberships" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::list_memberships" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `list_memberships` + +## Signature + +```perl +sub list_memberships($group_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 87. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list.mdx new file mode 100644 index 0000000000..587d760f1b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/list" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::list" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 11. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list__2.mdx new file mode 100644 index 0000000000..35691947fe --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/list__2" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::list" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 59. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list__3.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list__3.mdx new file mode 100644 index 0000000000..783a13f626 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/list__3.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/list__3" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::list" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 155. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/phone-number.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/phone-number.mdx new file mode 100644 index 0000000000..35588b122c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/phone-number.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/phone-number" +title: "phone_number" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::phone_number" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `phone_number` + +## Signature + +```perl +sub phone_number($e164, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 144. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/redial-verification.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/redial-verification.mdx new file mode 100644 index 0000000000..7c0985b685 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/redial-verification.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/redial-verification" +title: "redial_verification" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::redial_verification" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `redial_verification` + +## Signature + +```perl +sub redial_verification($caller_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 114. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/sms.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/sms.mdx new file mode 100644 index 0000000000..2bd1a52611 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/sms.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/sms" +title: "sms" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::sms" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `sms` + +## Signature + +```perl +sub sms(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 186. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/submit-verification.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/submit-verification.mdx new file mode 100644 index 0000000000..594183d45b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/submit-verification.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/submit-verification" +title: "submit_verification" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::submit_verification" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `submit_verification` + +## Signature + +```perl +sub submit_verification($caller_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 119. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/update.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/update.mdx new file mode 100644 index 0000000000..a047a39353 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/update.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/update" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::update" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 134. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/update__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/update__2.mdx new file mode 100644 index 0000000000..32ab37d490 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/update__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/update__2" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::update" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($short_code_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 166. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/verify.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/verify.mdx new file mode 100644 index 0000000000..af1406d91d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/resources/resources/verify.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/resources/resources/verify" +title: "verify" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Resources::verify" + parent: "SignalWire::REST::Namespaces::Resources" + module: "SignalWire.REST.Namespaces.Resources" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm" + visibility: "public" +--- +# `verify` + +## Signature + +```perl +sub verify($request_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Resources.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Resources.pm) + +Line 196. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/create-stream.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/create-stream.mdx new file mode 100644 index 0000000000..dd5937a97d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/create-stream.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/create-stream" +title: "create_stream" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::create_stream" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `create_stream` + +## Signature + +```perl +sub create_stream($room_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 18. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/create-stream__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/create-stream__2.mdx new file mode 100644 index 0000000000..bb7be992aa --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/create-stream__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/create-stream__2" +title: "create_stream" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::create_stream" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `create_stream` + +## Signature + +```perl +sub create_stream($conference_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 118. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/create.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/create.mdx new file mode 100644 index 0000000000..488db532ac --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/create" +title: "create" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::create" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `create` + +## Signature + +```perl +sub create(%kwargs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 28. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete-recording.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete-recording.mdx new file mode 100644 index 0000000000..9c40301a24 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete-recording.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/delete-recording" +title: "delete_recording" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::delete_recording" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `delete_recording` + +## Signature + +```perl +sub delete_recording($recording_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 83. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete-stream.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete-stream.mdx new file mode 100644 index 0000000000..48634a9bad --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete-stream.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/delete-stream" +title: "delete_stream" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::delete_stream" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `delete_stream` + +## Signature + +```perl +sub delete_stream($stream_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 153. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete.mdx new file mode 100644 index 0000000000..44933da151 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/delete" +title: "delete" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::delete" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `delete` + +## Signature + +```perl +sub delete($recording_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 89. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete__2.mdx new file mode 100644 index 0000000000..cfb6b19720 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/delete__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/delete__2" +title: "delete" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::delete" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `delete` + +## Signature + +```perl +sub delete($stream_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 159. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get.mdx new file mode 100644 index 0000000000..2b3fb8e1ee --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/get" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::get" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($session_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 44. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get__2.mdx new file mode 100644 index 0000000000..d8806a148f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/get__2" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::get" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($recording_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 78. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get__3.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get__3.mdx new file mode 100644 index 0000000000..21b62cd56f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get__3.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/get__3" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::get" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($token_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 128. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get__4.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get__4.mdx new file mode 100644 index 0000000000..72d4ca54fb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/get__4.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/get__4" +title: "get" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::get" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `get` + +## Signature + +```perl +sub get($stream_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 143. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/index.mdx new file mode 100644 index 0000000000..d0b5286bf3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/index.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video" +title: "Video" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" +--- +# `Video` + +## Signature + +```perl +package SignalWire::REST::Namespaces::Video +``` + +## Inheritance + +**Extends:** `SignalWire::REST::Namespaces::CrudResource`, [SignalWire::REST::Namespaces::Base](/reference/perl/signal-wire/rest/namespaces/base/base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-conference-tokens.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-conference-tokens.mdx new file mode 100644 index 0000000000..a6de53246c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-conference-tokens.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/list-conference-tokens" +title: "list_conference_tokens" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::list_conference_tokens" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `list_conference_tokens` + +## Signature + +```perl +sub list_conference_tokens($conference_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 106. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-events.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-events.mdx new file mode 100644 index 0000000000..9a2d18cf08 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-events.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/list-events" +title: "list_events" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::list_events" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `list_events` + +## Signature + +```perl +sub list_events($session_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 49. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-events__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-events__2.mdx new file mode 100644 index 0000000000..4c9ba4787b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-events__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/list-events__2" +title: "list_events" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::list_events" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `list_events` + +## Signature + +```perl +sub list_events($recording_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 94. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-members.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-members.mdx new file mode 100644 index 0000000000..14c14d11a7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-members.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/list-members" +title: "list_members" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::list_members" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `list_members` + +## Signature + +```perl +sub list_members($session_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 55. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-recordings.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-recordings.mdx new file mode 100644 index 0000000000..e42b456974 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-recordings.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/list-recordings" +title: "list_recordings" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::list_recordings" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `list_recordings` + +## Signature + +```perl +sub list_recordings($session_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 61. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-streams.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-streams.mdx new file mode 100644 index 0000000000..673020a9b5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-streams.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/list-streams" +title: "list_streams" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::list_streams" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `list_streams` + +## Signature + +```perl +sub list_streams($room_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 12. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-streams__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-streams__2.mdx new file mode 100644 index 0000000000..d4bcae9930 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list-streams__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/list-streams__2" +title: "list_streams" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::list_streams" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `list_streams` + +## Signature + +```perl +sub list_streams($conference_id, @params) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 112. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list.mdx new file mode 100644 index 0000000000..85d2f45bef --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/list" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::list" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 38. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list__2.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list__2.mdx new file mode 100644 index 0000000000..8f076e16f6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/list__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/list__2" +title: "list" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::list" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `list` + +## Signature + +```perl +sub list(@params) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 72. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/reset.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/reset.mdx new file mode 100644 index 0000000000..9b3df08c2e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/reset" +title: "reset" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::reset" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `reset` + +## Signature + +```perl +sub reset($token_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 133. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/update.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/update.mdx new file mode 100644 index 0000000000..070b3e09cb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/namespaces/video/video/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/rest/namespaces/video/video/update" +title: "update" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Namespaces::Video::update" + parent: "SignalWire::REST::Namespaces::Video" + module: "SignalWire.REST.Namespaces.Video" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm" + visibility: "public" +--- +# `update` + +## Signature + +```perl +sub update($stream_id, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/REST/Namespaces/Video.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Namespaces/Video.pm) + +Line 148. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/pagination/pagination/all.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/pagination/pagination/all.mdx new file mode 100644 index 0000000000..bf83495b3f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/pagination/pagination/all.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/rest/pagination/pagination/all" +title: "all" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Pagination::all" + parent: "SignalWire::REST::Pagination" + module: "SignalWire.REST.Pagination" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Pagination.pm" + visibility: "public" +--- +# `all` + +## Signature + +```perl +sub all() +``` + +## Source + +[`lib/SignalWire/REST/Pagination.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Pagination.pm) + +Line 85. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/pagination/pagination/build.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/pagination/pagination/build.mdx new file mode 100644 index 0000000000..4ef0ab7e98 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/pagination/pagination/build.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/rest/pagination/pagination/build" +title: "BUILD" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::Pagination::BUILD" + parent: "SignalWire::REST::Pagination" + module: "SignalWire.REST.Pagination" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Pagination.pm" + visibility: "public" +--- +# `BUILD` + +## Signature + +```perl +sub BUILD() +``` + +## Source + +[`lib/SignalWire/REST/Pagination.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Pagination.pm) + +Line 39. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/pagination/pagination/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/pagination/pagination/index.mdx new file mode 100644 index 0000000000..f97a731276 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/pagination/pagination/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/perl/signal-wire/rest/pagination/pagination" +title: "Pagination" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::Pagination" + module: "SignalWire.REST.Pagination" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Pagination.pm" +--- +# `Pagination` + +Mirrors the Python `signalwire.rest._pagination.PaginatedIterator`. Walks the `links.next` cursor until no further page is advertised. Each fetch is performed via the SDK's [SignalWire::REST::HttpClient](SignalWire::REST::HttpClient) so authentication and base-URL handling is shared with the rest of the SDK. + +**Synopsis** + +```perl +use SignalWire::REST::Pagination; +``` + +```perl +my $it = SignalWire::REST::Pagination::PaginatedIterator->new( + http => $client->_http, + path => '/api/fabric/addresses', + params => { page_size => 25 }, + data_key => 'data', +); +while (defined(my $item = $it->next)) { + ... +} +``` + +## Signature + +```perl +package SignalWire::REST::Pagination +``` + +## Methods + + + + + + + +## Source + +[`lib/SignalWire/REST/Pagination.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/Pagination.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/phone-call-handler/phone-call-handler/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/phone-call-handler/phone-call-handler/index.mdx new file mode 100644 index 0000000000..cddf243ddd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/phone-call-handler/phone-call-handler/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/perl/signal-wire/rest/phone-call-handler/phone-call-handler" +title: "PhoneCallHandler" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::PhoneCallHandler" + module: "SignalWire.REST.PhoneCallHandler" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/PhoneCallHandler.pm" +--- +# `PhoneCallHandler` + +## Signature + +```perl +package SignalWire::REST::PhoneCallHandler +``` + +## Constants + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + +## Source + +[`lib/SignalWire/REST/PhoneCallHandler.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/PhoneCallHandler.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/phone-call-handler/phone-call-handler/values.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/phone-call-handler/phone-call-handler/values.mdx new file mode 100644 index 0000000000..37f9b8632a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/phone-call-handler/phone-call-handler/values.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/rest/phone-call-handler/phone-call-handler/values" +title: "values" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::REST::PhoneCallHandler::values" + parent: "SignalWire::REST::PhoneCallHandler" + module: "SignalWire.REST.PhoneCallHandler" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/PhoneCallHandler.pm" + visibility: "public" +--- +# `values` + +## Signature + +```perl +sub values() +``` + +## Source + +[`lib/SignalWire/REST/PhoneCallHandler.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/PhoneCallHandler.pm) + +Line 69. diff --git a/fern/products/sdk-reference/perl/signal-wire/rest/rest-client/rest-client/index.mdx b/fern/products/sdk-reference/perl/signal-wire/rest/rest-client/rest-client/index.mdx new file mode 100644 index 0000000000..29f400c970 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/rest/rest-client/rest-client/index.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/perl/signal-wire/rest/rest-client/rest-client" +title: "RestClient" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/RestClient.pm" +--- +# `RestClient` + +## Signature + +```perl +package SignalWire::REST::RestClient +``` + +## Source + +[`lib/SignalWire/REST/RestClient.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/REST/RestClient.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/activate-session.mdx b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/activate-session.mdx new file mode 100644 index 0000000000..19d914db31 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/activate-session.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/security/session-manager/session-manager/activate-session" +title: "activate_session" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::SessionManager::activate_session" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm" + visibility: "public" +--- +# `activate_session` + +## Signature + +```perl +sub activate_session($call_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Security/SessionManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm) + +Line 127. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/create-session.mdx b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/create-session.mdx new file mode 100644 index 0000000000..7c16c92f6b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/create-session.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/security/session-manager/session-manager/create-session" +title: "create_session" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::SessionManager::create_session" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm" + visibility: "public" +--- +# `create_session` + +## Signature + +```perl +sub create_session($call_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Security/SessionManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm) + +Line 50. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/create-tool-token.mdx b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/create-tool-token.mdx new file mode 100644 index 0000000000..6bfa9b8f39 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/create-tool-token.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/security/session-manager/session-manager/create-tool-token" +title: "create_tool_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::SessionManager::create_tool_token" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm" + visibility: "public" +--- +# `create_tool_token` + +## Signature + +```perl +sub create_tool_token($function_name, $call_id) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Security/SessionManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm) + +Line 69. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/debug-token.mdx b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/debug-token.mdx new file mode 100644 index 0000000000..a381f6c847 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/debug-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/security/session-manager/session-manager/debug-token" +title: "debug_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::SessionManager::debug_token" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm" + visibility: "public" +--- +# `debug_token` + +## Signature + +```perl +sub debug_token($token) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Security/SessionManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm) + +Line 147. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/end-session.mdx b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/end-session.mdx new file mode 100644 index 0000000000..208ec7b209 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/end-session.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/security/session-manager/session-manager/end-session" +title: "end_session" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::SessionManager::end_session" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm" + visibility: "public" +--- +# `end_session` + +## Signature + +```perl +sub end_session($call_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Security/SessionManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm) + +Line 132. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/generate-token.mdx b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/generate-token.mdx new file mode 100644 index 0000000000..a6362385e7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/generate-token.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/security/session-manager/session-manager/generate-token" +title: "generate_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::SessionManager::generate_token" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm" + visibility: "public" +--- +# `generate_token` + +## Signature + +```perl +sub generate_token($function_name, $call_id) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Security/SessionManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm) + +Line 56. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/get-session-metadata.mdx b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/get-session-metadata.mdx new file mode 100644 index 0000000000..b69220bd78 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/get-session-metadata.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/security/session-manager/session-manager/get-session-metadata" +title: "get_session_metadata" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::SessionManager::get_session_metadata" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm" + visibility: "public" +--- +# `get_session_metadata` + +## Signature + +```perl +sub get_session_metadata($call_id) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Security/SessionManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm) + +Line 137. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/index.mdx b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/index.mdx new file mode 100644 index 0000000000..a97a2501c3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/perl/signal-wire/security/session-manager/session-manager" +title: "SessionManager" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm" +--- +# `SessionManager` + +## Signature + +```perl +package SignalWire::Security::SessionManager +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Security/SessionManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/set-session-metadata.mdx b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/set-session-metadata.mdx new file mode 100644 index 0000000000..6498f81399 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/set-session-metadata.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/security/session-manager/session-manager/set-session-metadata" +title: "set_session_metadata" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::SessionManager::set_session_metadata" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm" + visibility: "public" +--- +# `set_session_metadata` + +## Signature + +```perl +sub set_session_metadata($call_id, $key, $value) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/Security/SessionManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm) + +Line 142. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/validate-token.mdx b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/validate-token.mdx new file mode 100644 index 0000000000..51c81fcaa3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/validate-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/security/session-manager/session-manager/validate-token" +title: "validate_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::SessionManager::validate_token" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm" + visibility: "public" +--- +# `validate_token` + +## Signature + +```perl +sub validate_token($call_id, $function_name, $token) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/Security/SessionManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm) + +Line 83. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/validate-tool-token.mdx b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/validate-tool-token.mdx new file mode 100644 index 0000000000..8fb03ddefe --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/session-manager/session-manager/validate-tool-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/security/session-manager/session-manager/validate-tool-token" +title: "validate_tool_token" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::SessionManager::validate_tool_token" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm" + visibility: "public" +--- +# `validate_tool_token` + +## Signature + +```perl +sub validate_tool_token($function_name, $token, $call_id) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/Security/SessionManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/SessionManager.pm) + +Line 119. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/webhook-middleware/webhook-middleware/index.mdx b/fern/products/sdk-reference/perl/signal-wire/security/webhook-middleware/webhook-middleware/index.mdx new file mode 100644 index 0000000000..c1305d50f3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/webhook-middleware/webhook-middleware/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/perl/signal-wire/security/webhook-middleware/webhook-middleware" +title: "WebhookMiddleware" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Security::WebhookMiddleware" + module: "SignalWire.Security.WebhookMiddleware" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/WebhookMiddleware.pm" +--- +# `WebhookMiddleware` + +Wraps a PSGI app so that incoming POST requests must carry a valid `X-SignalWire-Signature` header (or the legacy `X-Twilio-Signature`) matching the configured signing key. Invalid or missing signatures produce a 403 without ever invoking the wrapped app. + +The raw body is captured before validation and stashed on the env as `signalwire.raw_body`; `psgi.input` is rewound (or replaced with a buffer) so downstream handlers can re-read. + +**Synopsis** + +```perl +use SignalWire::Security::WebhookMiddleware; +``` + +```perl +my $wrapped = SignalWire::Security::WebhookMiddleware->wrap( + app => $psgi_app, + signing_key => $ENV{SIGNALWIRE_SIGNING_KEY}, + paths => [ '/', '/swaig', '/post_prompt' ], + trust_proxy => 1, +); +``` + +## Signature + +```perl +package SignalWire::Security::WebhookMiddleware +``` + +## Methods + + + + + +## Source + +[`lib/SignalWire/Security/WebhookMiddleware.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/WebhookMiddleware.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/webhook-middleware/webhook-middleware/wrap.mdx b/fern/products/sdk-reference/perl/signal-wire/security/webhook-middleware/webhook-middleware/wrap.mdx new file mode 100644 index 0000000000..bc0c83edbd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/webhook-middleware/webhook-middleware/wrap.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/security/webhook-middleware/webhook-middleware/wrap" +title: "wrap" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::WebhookMiddleware::wrap" + parent: "SignalWire::Security::WebhookMiddleware" + module: "SignalWire.Security.WebhookMiddleware" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/WebhookMiddleware.pm" + visibility: "public" +--- +# `wrap` + +## Signature + +```perl +sub wrap($class, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Security/WebhookMiddleware.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/WebhookMiddleware.pm) + +Line 63. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/webhook-validator/webhook-validator/index.mdx b/fern/products/sdk-reference/perl/signal-wire/security/webhook-validator/webhook-validator/index.mdx new file mode 100644 index 0000000000..3558482e03 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/webhook-validator/webhook-validator/index.mdx @@ -0,0 +1,80 @@ +--- +slug: "/reference/perl/signal-wire/security/webhook-validator/webhook-validator" +title: "WebhookValidator" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Security::WebhookValidator" + module: "SignalWire.Security.WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/WebhookValidator.pm" +--- +# `WebhookValidator` + +Implements both signature schemes from porting-sdk/webhooks.md: + +- Scheme A (RELAY / SWML / JSON) + + `lower_hex(HMAC-SHA1(key, url + raw_body))` + +- Scheme B (Compat / cXML form) + + `base64(HMAC-SHA1(key, url + sorted_concat_form_params))`, with URL port normalization (try both with / without `:443` / `:80`) and an optional `bodySHA256` query-param fallback for JSON-on-compat. + +The combined entry point tries Scheme A first, then Scheme B in all URL / param-shape variants. All signature comparisons use a constant-time compare so the secret is not leaked across repeated requests. + +**ERROR MODES** + +- Valid signature -> returns `1` + +- Invalid signature -> returns `0` + +- Missing `$signature` -> returns `0` (never throws) + +- Missing `$signing_key` -> croaks (programming error) + +- Reference passed as `$raw_body` -> croaks + +**Synopsis** + +```perl +use SignalWire::Security::WebhookValidator qw( + validate_webhook_signature validate_request +); +``` + +```perl +# JSON / RELAY / SWML callbacks +if (validate_webhook_signature($signing_key, $sig_header, $url, $raw_body)) { + # request is genuine +} +``` + +```perl +# Legacy compat-api drop-in +if (validate_request($signing_key, $sig_header, $url, \%params)) { + # cXML / form-encoded request is genuine +} +``` + +## Signature + +```perl +package SignalWire::Security::WebhookValidator +``` + +## Methods + + + + + + + +## Source + +[`lib/SignalWire/Security/WebhookValidator.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/WebhookValidator.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/webhook-validator/webhook-validator/validate-request.mdx b/fern/products/sdk-reference/perl/signal-wire/security/webhook-validator/webhook-validator/validate-request.mdx new file mode 100644 index 0000000000..e4a8d62490 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/webhook-validator/webhook-validator/validate-request.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/perl/signal-wire/security/webhook-validator/webhook-validator/validate-request" +title: "validate_request" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::WebhookValidator::validate_request" + parent: "SignalWire::Security::WebhookValidator" + module: "SignalWire.Security.WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/WebhookValidator.pm" + visibility: "public" +--- +# `validate_request` + +## Signature + +```perl +sub validate_request($signing_key, $signature, $url, $params_or_raw_body) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/SignalWire/Security/WebhookValidator.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/WebhookValidator.pm) + +Line 309. diff --git a/fern/products/sdk-reference/perl/signal-wire/security/webhook-validator/webhook-validator/validate-webhook-signature.mdx b/fern/products/sdk-reference/perl/signal-wire/security/webhook-validator/webhook-validator/validate-webhook-signature.mdx new file mode 100644 index 0000000000..fdbbac956d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/security/webhook-validator/webhook-validator/validate-webhook-signature.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/perl/signal-wire/security/webhook-validator/webhook-validator/validate-webhook-signature" +title: "validate_webhook_signature" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Security::WebhookValidator::validate_webhook_signature" + parent: "SignalWire::Security::WebhookValidator" + module: "SignalWire.Security.WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/WebhookValidator.pm" + visibility: "public" +--- +# `validate_webhook_signature` + +## Signature + +```perl +sub validate_webhook_signature($signing_key, $signature, $url, $raw_body) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/SignalWire/Security/WebhookValidator.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Security/WebhookValidator.pm) + +Line 260. diff --git a/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/get-agent.mdx b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/get-agent.mdx new file mode 100644 index 0000000000..7e8c9e6dc0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/get-agent.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/server/agent-server/agent-server/get-agent" +title: "get_agent" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Server::AgentServer::get_agent" + parent: "SignalWire::Server::AgentServer" + module: "SignalWire.Server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm" + visibility: "public" +--- +# `get_agent` + +## Signature + +```perl +sub get_agent($route) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Server/AgentServer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm) + +Line 53. diff --git a/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/index.mdx b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/index.mdx new file mode 100644 index 0000000000..c640046f73 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/perl/signal-wire/server/agent-server/agent-server" +title: "AgentServer" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Server::AgentServer" + module: "SignalWire.Server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm" +--- +# `AgentServer` + +## Signature + +```perl +package SignalWire::Server::AgentServer +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Server/AgentServer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/list-agents.mdx b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/list-agents.mdx new file mode 100644 index 0000000000..d2ed579abb --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/list-agents.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/server/agent-server/agent-server/list-agents" +title: "list_agents" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Server::AgentServer::list_agents" + parent: "SignalWire::Server::AgentServer" + module: "SignalWire.Server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm" + visibility: "public" +--- +# `list_agents` + +## Signature + +```perl +sub list_agents() +``` + +## Source + +[`lib/SignalWire/Server/AgentServer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm) + +Line 48. diff --git a/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/psgi-app.mdx b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/psgi-app.mdx new file mode 100644 index 0000000000..689b67286d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/psgi-app.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/server/agent-server/agent-server/psgi-app" +title: "psgi_app" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Server::AgentServer::psgi_app" + parent: "SignalWire::Server::AgentServer" + module: "SignalWire.Server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm" + visibility: "public" +--- +# `psgi_app` + +## Signature + +```perl +sub psgi_app() +``` + +## Source + +[`lib/SignalWire/Server/AgentServer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm) + +Line 73. diff --git a/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/register.mdx b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/register.mdx new file mode 100644 index 0000000000..753153550d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/register.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/server/agent-server/agent-server/register" +title: "register" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Server::AgentServer::register" + parent: "SignalWire::Server::AgentServer" + module: "SignalWire.Server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm" + visibility: "public" +--- +# `register` + +## Signature + +```perl +sub register($agent, $route) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Server/AgentServer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm) + +Line 24. diff --git a/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/run.mdx b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/run.mdx new file mode 100644 index 0000000000..8ed2057c3e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/run.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/server/agent-server/agent-server/run" +title: "run" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Server::AgentServer::run" + parent: "SignalWire::Server::AgentServer" + module: "SignalWire.Server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm" + visibility: "public" +--- +# `run` + +## Signature + +```perl +sub run(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Server/AgentServer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm) + +Line 218. diff --git a/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/serve-static-files.mdx b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/serve-static-files.mdx new file mode 100644 index 0000000000..83e172f00b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/serve-static-files.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/server/agent-server/agent-server/serve-static-files" +title: "serve_static_files" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Server::AgentServer::serve_static_files" + parent: "SignalWire::Server::AgentServer" + module: "SignalWire.Server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm" + visibility: "public" +--- +# `serve_static_files` + +## Signature + +```perl +sub serve_static_files($directory, $route) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Server/AgentServer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm) + +Line 58. diff --git a/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/unregister.mdx b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/unregister.mdx new file mode 100644 index 0000000000..241c98d879 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/server/agent-server/agent-server/unregister.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/server/agent-server/agent-server/unregister" +title: "unregister" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Server::AgentServer::unregister" + parent: "SignalWire::Server::AgentServer" + module: "SignalWire.Server.AgentServer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm" + visibility: "public" +--- +# `unregister` + +## Signature + +```perl +sub unregister($route) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Server/AgentServer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Server/AgentServer.pm) + +Line 40. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/add-skill-directory.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/add-skill-directory.mdx new file mode 100644 index 0000000000..2bd16be405 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/add-skill-directory.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/add-skill-directory" +title: "add_skill_directory" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::add_skill_directory" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire.pm" + visibility: "public" +--- +# `add_skill_directory` + +## Signature + +```perl +sub add_skill_directory($path) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire.pm) + +Line 97. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-bullets.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-bullets.mdx new file mode 100644 index 0000000000..11173a3039 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-bullets.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-bullets" +title: "add_bullets" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_bullets" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_bullets` + +## Signature + +```perl +sub add_bullets($title, $bullets) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 123. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-bullets__2.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-bullets__2.mdx new file mode 100644 index 0000000000..83ebcc4eca --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-bullets__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-bullets__2" +title: "add_bullets" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_bullets" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_bullets` + +## Signature + +```perl +sub add_bullets($title, $bullets) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 517. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-context.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-context.mdx new file mode 100644 index 0000000000..cd8ee79f49 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-context" +title: "add_context" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_context" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_context` + +## Signature + +```perl +sub add_context($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 681. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-enter-filler.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-enter-filler.mdx new file mode 100644 index 0000000000..c72102ee91 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-enter-filler.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-enter-filler" +title: "add_enter_filler" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_enter_filler" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_enter_filler` + +## Signature + +```perl +sub add_enter_filler($lang, $fillers) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 537. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-exit-filler.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-exit-filler.mdx new file mode 100644 index 0000000000..df007b4357 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-exit-filler.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-exit-filler" +title: "add_exit_filler" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_exit_filler" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_exit_filler` + +## Signature + +```perl +sub add_exit_filler($lang, $fillers) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 546. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-gather-question.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-gather-question.mdx new file mode 100644 index 0000000000..6c8fb94812 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-gather-question.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-gather-question" +title: "add_gather_question" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_gather_question" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_gather_question` + +## Signature + +```perl +sub add_gather_question(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 245. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-question.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-question.mdx new file mode 100644 index 0000000000..56710592ee --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-question.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-question" +title: "add_question" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_question" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_question` + +## Signature + +```perl +sub add_question(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 59. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-section.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-section.mdx new file mode 100644 index 0000000000..770303feb7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-section.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-section" +title: "add_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_section" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_section` + +## Signature + +```perl +sub add_section($title, $body) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 115. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-section__2.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-section__2.mdx new file mode 100644 index 0000000000..12d58bd684 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-section__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-section__2" +title: "add_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_section" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_section` + +## Signature + +```perl +sub add_section($title, $body) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 509. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-step.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-step.mdx new file mode 100644 index 0000000000..172c2fcfe5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-step.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-step" +title: "add_step" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_step" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_step` + +## Signature + +```perl +sub add_step($name, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 360. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-system-bullets.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-system-bullets.mdx new file mode 100644 index 0000000000..9ae805777c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-system-bullets.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-system-bullets" +title: "add_system_bullets" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_system_bullets" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_system_bullets` + +## Signature + +```perl +sub add_system_bullets($title, $bullets) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 493. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-system-section.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-system-section.mdx new file mode 100644 index 0000000000..88f1646997 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/add-system-section.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/add-system-section" +title: "add_system_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::add_system_section" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `add_system_section` + +## Signature + +```perl +sub add_system_section($title, $body) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 485. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/attach-agent.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/attach-agent.mdx new file mode 100644 index 0000000000..f8a6b71209 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/attach-agent.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/attach-agent" +title: "attach_agent" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::attach_agent" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `attach_agent` + +## Signature + +```perl +sub attach_agent($agent) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 667. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/clear-sections.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/clear-sections.mdx new file mode 100644 index 0000000000..8658d720b5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/clear-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/clear-sections" +title: "clear_sections" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::clear_sections" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `clear_sections` + +## Signature + +```perl +sub clear_sections() +``` + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 253. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/context-builder/index.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/context-builder/index.mdx new file mode 100644 index 0000000000..d9917151b4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/context-builder/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/context-builder" +title: "ContextBuilder" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Contexts::ContextBuilder" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts/ContextBuilder.pm" +--- +# `ContextBuilder` + +## Signature + +```perl +package SignalWire::Contexts::ContextBuilder +``` + +## Source + +[`lib/SignalWire/Contexts/ContextBuilder.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts/ContextBuilder.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/create-simple-context.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/create-simple-context.mdx new file mode 100644 index 0000000000..7fb0529f57 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/create-simple-context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/create-simple-context" +title: "create_simple_context" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::create_simple_context" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `create_simple_context` + +## Signature + +```perl +sub create_simple_context($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 859. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/get-context.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/get-context.mdx new file mode 100644 index 0000000000..963f7819d6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/get-context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/get-context" +title: "get_context" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::get_context" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `get_context` + +## Signature + +```perl +sub get_context($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 693. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/get-step.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/get-step.mdx new file mode 100644 index 0000000000..d9ffdbc9b3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/get-step.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/get-step" +title: "get_step" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::get_step" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `get_step` + +## Signature + +```perl +sub get_step($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 380. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/has-contexts.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/has-contexts.mdx new file mode 100644 index 0000000000..828fad03ac --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/has-contexts.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/has-contexts" +title: "has_contexts" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::has_contexts" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `has_contexts` + +## Signature + +```perl +sub has_contexts() +``` + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 698. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/index.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/index.mdx new file mode 100644 index 0000000000..d5cd495269 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/index.mdx @@ -0,0 +1,141 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts" +title: "Contexts" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Contexts" + parent: "SignalWire" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" +--- +# `Contexts` + +## Signature + +```perl +package SignalWire::Contexts +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Modules + + + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/move-step.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/move-step.mdx new file mode 100644 index 0000000000..247a1373ae --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/move-step.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/move-step" +title: "move_step" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::move_step" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `move_step` + +## Signature + +```perl +sub move_step($name, $position) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 394. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/remove-step.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/remove-step.mdx new file mode 100644 index 0000000000..79d999e232 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/remove-step.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/remove-step" +title: "remove_step" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::remove_step" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `remove_step` + +## Signature + +```perl +sub remove_step($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 385. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/reset.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/reset.mdx new file mode 100644 index 0000000000..34e6712af8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/reset.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/reset" +title: "reset" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::reset" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `reset` + +## Signature + +```perl +sub reset() +``` + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 674. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-consolidate.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-consolidate.mdx new file mode 100644 index 0000000000..fbfc08da38 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-consolidate.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-consolidate" +title: "set_consolidate" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_consolidate" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_consolidate` + +## Signature + +```perl +sub set_consolidate($c) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 442. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-end.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-end.mdx new file mode 100644 index 0000000000..8b547b6685 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-end.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-end" +title: "set_end" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_end" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_end` + +## Signature + +```perl +sub set_end($end) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 197. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-enter-fillers.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-enter-fillers.mdx new file mode 100644 index 0000000000..eba2c8af73 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-enter-fillers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-enter-fillers" +title: "set_enter_fillers" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_enter_fillers" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_enter_fillers` + +## Signature + +```perl +sub set_enter_fillers($fillers) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 525. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-exit-fillers.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-exit-fillers.mdx new file mode 100644 index 0000000000..0749b56ac4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-exit-fillers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-exit-fillers" +title: "set_exit_fillers" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_exit_fillers" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_exit_fillers` + +## Signature + +```perl +sub set_exit_fillers($fillers) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 531. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-full-reset.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-full-reset.mdx new file mode 100644 index 0000000000..10f06a5cc6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-full-reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-full-reset" +title: "set_full_reset" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_full_reset" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_full_reset` + +## Signature + +```perl +sub set_full_reset($fr) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 448. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-functions.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-functions.mdx new file mode 100644 index 0000000000..654d47259d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-functions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-functions" +title: "set_functions" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_functions" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_functions` + +## Signature + +```perl +sub set_functions($functions) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 167. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-gather-info.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-gather-info.mdx new file mode 100644 index 0000000000..11ab1486ff --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-gather-info.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-gather-info" +title: "set_gather_info" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_gather_info" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_gather_info` + +## Signature + +```perl +sub set_gather_info(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 215. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-initial-step.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-initial-step.mdx new file mode 100644 index 0000000000..ddeb01c622 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-initial-step.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-initial-step" +title: "set_initial_step" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_initial_step" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_initial_step` + +## Signature + +```perl +sub set_initial_step($step_name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 410. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-isolated.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-isolated.mdx new file mode 100644 index 0000000000..49a7446f52 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-isolated.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-isolated" +title: "set_isolated" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_isolated" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_isolated` + +## Signature + +```perl +sub set_isolated($iso) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 479. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-post-prompt.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-post-prompt.mdx new file mode 100644 index 0000000000..5d9ae967fa --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-post-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-post-prompt" +title: "set_post_prompt" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_post_prompt" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_post_prompt` + +## Signature + +```perl +sub set_post_prompt($pp) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 428. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-prompt.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-prompt.mdx new file mode 100644 index 0000000000..01ce0c7984 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-prompt" +title: "set_prompt" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_prompt" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_prompt` + +## Signature + +```perl +sub set_prompt($prompt) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 501. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-consolidate.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-consolidate.mdx new file mode 100644 index 0000000000..5a76834131 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-consolidate.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-reset-consolidate" +title: "set_reset_consolidate" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_reset_consolidate" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_reset_consolidate` + +## Signature + +```perl +sub set_reset_consolidate($c) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 272. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-full-reset.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-full-reset.mdx new file mode 100644 index 0000000000..c11cb11f4e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-full-reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-reset-full-reset" +title: "set_reset_full_reset" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_reset_full_reset" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_reset_full_reset` + +## Signature + +```perl +sub set_reset_full_reset($fr) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 278. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-system-prompt.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-system-prompt.mdx new file mode 100644 index 0000000000..6994a40947 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-system-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-reset-system-prompt" +title: "set_reset_system_prompt" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_reset_system_prompt" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_reset_system_prompt` + +## Signature + +```perl +sub set_reset_system_prompt($sp) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 260. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-user-prompt.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-user-prompt.mdx new file mode 100644 index 0000000000..84f8c49bb5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-reset-user-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-reset-user-prompt" +title: "set_reset_user_prompt" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_reset_user_prompt" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_reset_user_prompt` + +## Signature + +```perl +sub set_reset_user_prompt($up) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 266. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-skip-to-next-step.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-skip-to-next-step.mdx new file mode 100644 index 0000000000..b85c66ee1f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-skip-to-next-step.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-skip-to-next-step" +title: "set_skip_to_next_step" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_skip_to_next_step" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_skip_to_next_step` + +## Signature + +```perl +sub set_skip_to_next_step($skip) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 209. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-skip-user-turn.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-skip-user-turn.mdx new file mode 100644 index 0000000000..fe79d3f3c7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-skip-user-turn.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-skip-user-turn" +title: "set_skip_user_turn" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_skip_user_turn" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_skip_user_turn` + +## Signature + +```perl +sub set_skip_user_turn($skip) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 203. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-step-criteria.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-step-criteria.mdx new file mode 100644 index 0000000000..898a87c613 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-step-criteria.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-step-criteria" +title: "set_step_criteria" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_step_criteria" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_step_criteria` + +## Signature + +```perl +sub set_step_criteria($criteria) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 131. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-system-prompt.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-system-prompt.mdx new file mode 100644 index 0000000000..abca791e3a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-system-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-system-prompt" +title: "set_system_prompt" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_system_prompt" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_system_prompt` + +## Signature + +```perl +sub set_system_prompt($sp) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 434. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-text.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-text.mdx new file mode 100644 index 0000000000..03337f9999 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-text.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-text" +title: "set_text" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_text" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_text` + +## Signature + +```perl +sub set_text($text) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 107. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-user-prompt.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-user-prompt.mdx new file mode 100644 index 0000000000..c06fadb846 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-user-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-user-prompt" +title: "set_user_prompt" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_user_prompt" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_user_prompt` + +## Signature + +```perl +sub set_user_prompt($up) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 454. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-contexts.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-contexts.mdx new file mode 100644 index 0000000000..6c1af06a39 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-valid-contexts" +title: "set_valid_contexts" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_valid_contexts" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_valid_contexts` + +## Signature + +```perl +sub set_valid_contexts($contexts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 179. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-contexts__2.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-contexts__2.mdx new file mode 100644 index 0000000000..8c3b8bb356 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-contexts__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-valid-contexts__2" +title: "set_valid_contexts" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_valid_contexts" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_valid_contexts` + +## Signature + +```perl +sub set_valid_contexts($contexts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 416. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-steps.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-steps.mdx new file mode 100644 index 0000000000..b1a882ee38 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-steps.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-valid-steps" +title: "set_valid_steps" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_valid_steps" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_valid_steps` + +## Signature + +```perl +sub set_valid_steps($steps) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 173. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-steps__2.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-steps__2.mdx new file mode 100644 index 0000000000..71c66b4957 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/set-valid-steps__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/set-valid-steps__2" +title: "set_valid_steps" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::set_valid_steps" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `set_valid_steps` + +## Signature + +```perl +sub set_valid_steps($steps) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 422. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash.mdx new file mode 100644 index 0000000000..03fee23dd7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/to-hash" +title: "to_hash" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::to_hash" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `to_hash` + +## Signature + +```perl +sub to_hash() +``` + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 38. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__2.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__2.mdx new file mode 100644 index 0000000000..ac6d946509 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__2.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/to-hash__2" +title: "to_hash" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::to_hash" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `to_hash` + +## Signature + +```perl +sub to_hash() +``` + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 73. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__3.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__3.mdx new file mode 100644 index 0000000000..b00c90edd9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__3.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/to-hash__3" +title: "to_hash" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::to_hash" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `to_hash` + +## Signature + +```perl +sub to_hash() +``` + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 307. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__4.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__4.mdx new file mode 100644 index 0000000000..15d5d6557e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__4.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/to-hash__4" +title: "to_hash" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::to_hash" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `to_hash` + +## Signature + +```perl +sub to_hash() +``` + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 587. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__5.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__5.mdx new file mode 100644 index 0000000000..bb0ab20b36 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/to-hash__5.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/to-hash__5" +title: "to_hash" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::to_hash" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `to_hash` + +## Signature + +```perl +sub to_hash() +``` + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 840. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/validate.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/validate.mdx new file mode 100644 index 0000000000..802088dd70 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/contexts/validate.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/contexts/validate" +title: "validate" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Contexts::validate" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm" + visibility: "public" +--- +# `validate` + +## Signature + +```perl +sub validate() +``` + +## Source + +[`lib/SignalWire/Contexts.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Contexts.pm) + +Line 703. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/body.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/body.mdx new file mode 100644 index 0000000000..903af1e995 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/body" +title: "body" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::body" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `body` + +## Signature + +```perl +sub body($data) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 180. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/description.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/description.mdx new file mode 100644 index 0000000000..189a72dad6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/description" +title: "description" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::description" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `description` + +## Signature + +```perl +sub description($desc) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 85. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/error-keys.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/error-keys.mdx new file mode 100644 index 0000000000..03b6f08cdf --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/error-keys.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/error-keys" +title: "error_keys" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::error_keys" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `error_keys` + +## Signature + +```perl +sub error_keys($keys) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 225. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/expression.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/expression.mdx new file mode 100644 index 0000000000..b3c6a6c8b6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/expression.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/expression" +title: "expression" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::expression" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `expression` + +## Signature + +```perl +sub expression($test_value, $pattern, $output, %opts) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 129. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/fallback-output.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/fallback-output.mdx new file mode 100644 index 0000000000..ec3754e472 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/fallback-output.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/fallback-output" +title: "fallback_output" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::fallback_output" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `fallback_output` + +## Signature + +```perl +sub fallback_output($result) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 219. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/foreach.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/foreach.mdx new file mode 100644 index 0000000000..311c88c347 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/foreach.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/foreach" +title: "foreach" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::foreach" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `foreach` + +## Signature + +```perl +sub foreach($config) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 196. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/global-error-keys.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/global-error-keys.mdx new file mode 100644 index 0000000000..f2b35854f2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/global-error-keys.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/global-error-keys" +title: "global_error_keys" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::global_error_keys" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `global_error_keys` + +## Signature + +```perl +sub global_error_keys($keys) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 235. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/index.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/index.mdx new file mode 100644 index 0000000000..1ed0f2ebfc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map" +title: "DataMap" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::DataMap" + parent: "SignalWire" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" +--- +# `DataMap` + +## Signature + +```perl +package SignalWire::DataMap +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/output.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/output.mdx new file mode 100644 index 0000000000..bca28a19b3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/output.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/output" +title: "output" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::output" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `output` + +## Signature + +```perl +sub output($result) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 211. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/parameter.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/parameter.mdx new file mode 100644 index 0000000000..33f9943763 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/parameter.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/parameter" +title: "parameter" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::parameter" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `parameter` + +## Signature + +```perl +sub parameter($name, $type, $description, %opts) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 108. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/params.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/params.mdx new file mode 100644 index 0000000000..f9e605a251 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/params" +title: "params" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::params" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `params` + +## Signature + +```perl +sub params($data) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 188. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/purpose.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/purpose.mdx new file mode 100644 index 0000000000..8403a0b208 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/purpose.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/purpose" +title: "purpose" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::purpose" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `purpose` + +## Signature + +```perl +sub purpose($desc) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 74. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/to-swaig-function.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/to-swaig-function.mdx new file mode 100644 index 0000000000..0a4e793511 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/to-swaig-function.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/to-swaig-function" +title: "to_swaig_function" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::to_swaig_function" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `to_swaig_function` + +## Signature + +```perl +sub to_swaig_function() +``` + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 241. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/webhook-expressions.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/webhook-expressions.mdx new file mode 100644 index 0000000000..1251fc8ee2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/webhook-expressions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/webhook-expressions" +title: "webhook_expressions" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::webhook_expressions" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `webhook_expressions` + +## Signature + +```perl +sub webhook_expressions($expressions) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 172. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/webhook.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/webhook.mdx new file mode 100644 index 0000000000..4751bf2868 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/data-map/webhook.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/data-map/webhook" +title: "webhook" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::DataMap::webhook" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm" + visibility: "public" +--- +# `webhook` + +## Signature + +```perl +sub webhook($method, $url, %opts) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/DataMap.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/DataMap.pm) + +Line 152. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/index.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/index.mdx new file mode 100644 index 0000000000..7c090ff34c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/index.mdx @@ -0,0 +1,219 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire" +title: "SignalWire" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire.pm" +--- +# `SignalWire` + +SignalWire is the Perl port of the SignalWire AI Agents SDK. It provides a framework for building, deploying, and managing AI agents as self-contained web applications that expose HTTP endpoints to interact with the SignalWire platform. + +**CORE MODULES** + +- [SignalWire::Agent::AgentBase](SignalWire::Agent::AgentBase) - Base class for all AI agents + +- [SignalWire::SWML::Service](SignalWire::SWML::Service) - SWML document management + +- [SignalWire::SWAIG::FunctionResult](SignalWire::SWAIG::FunctionResult) - Tool response builder with actions + +- [SignalWire::DataMap](SignalWire::DataMap) - Declarative server-side API tools + +- [SignalWire::Contexts](SignalWire::Contexts) - Workflow context management + +- [SignalWire::Server::AgentServer](SignalWire::Server::AgentServer) - Multi-agent HTTP server + +- [SignalWire::Relay::Client](SignalWire::Relay::Client) - WebSocket-based call control + +- [SignalWire::REST::RestClient](SignalWire::REST::RestClient) - REST API client + +**DATAMAP TOOLS** + +Declarative API calls evaluated server-side, no webhook required: + +```perl +use SignalWire::DataMap; +``` + +```perl +my $tool = SignalWire::DataMap->new('get_weather') + ->description('Get weather for a location') + ->parameter('city', 'string', 'City name', required => 1) + ->webhook('GET', 'https://api.weather.com/v1?q=${args.city}') + ->output(SignalWire::SWAIG::FunctionResult->new( + 'Weather: ${response.temp}°F' + )); +``` + +```perl +$agent->register_swaig_function($tool->to_swaig_function); +``` + +**ENVIRONMENT VARIABLES** + +- `SWML_BASIC_AUTH_USER` / `SWML_BASIC_AUTH_PASSWORD` - Override auto-generated basic auth credentials + +- `SIGNALWIRE_PROJECT_ID` - Project ID for Relay and REST clients + +- `SIGNALWIRE_API_TOKEN` - API token for Relay and REST clients + +- `SIGNALWIRE_SPACE` - SignalWire space hostname + +**KEY FEATURES** + +- **Prompt Object Model** - Structured, section-based prompt management + +- **Local Tools** - Define tool handlers that execute in your agent process + +- **DataMap Tools** - Server-side API integration without webhooks + +- **Skills System** - Modular, reusable capabilities (datetime, math, web search, etc.) + +- **Contexts** - Branching workflow management for multi-step conversations + +- **Prefabs** - Ready-made agent types (InfoGatherer, Survey, Receptionist, etc.) + +- **Multi-Agent Server** - Host multiple agents in a single process + +- **RELAY Client** - Real-time WebSocket call control + +- **REST Client** - Synchronous HTTP API for SignalWire resources + +**LICENSE** + +This is free software licensed under the MIT License. + +**LOCAL TOOLS** + +Handler subroutines that execute within your agent process: + +```perl +$agent->define_tool( + name => 'lookup_order', + description => 'Look up an order by ID', + parameters => { + type => 'object', + properties => { + order_id => { type => 'string', description => 'Order ID' }, + }, + required => ['order_id'], + }, + handler => sub { + my ($args, $raw) = @_; + my $order = get_order($args->{order_id}); + return SignalWire::SWAIG::FunctionResult->new( + "Order status: $order->{status}" + ); + }, +); +``` + +**SKILLS** + +Pre-built capabilities added with a single call: + +```perl +$agent->add_skill('datetime'); +$agent->add_skill('math'); +$agent->add_skill('web_search', { + api_key => $ENV{GOOGLE_SEARCH_API_KEY}, + search_engine_id => $ENV{GOOGLE_SEARCH_ENGINE_ID}, +}); +``` + +**SOURCE** + +[https://github.com/signalwire/signalwire-agents-perl](https://github.com/signalwire/signalwire-agents-perl) + +**Synopsis** + +```perl +use SignalWire::Agent::AgentBase; +``` + +```perl +my $agent = SignalWire::Agent::AgentBase->new( + name => 'my_agent', + route => '/agent', + host => '0.0.0.0', + port => 3000, +); +``` + +```perl +# Build structured prompts +$agent->prompt_add_section('Role', 'You are a helpful assistant.'); +$agent->prompt_add_section('Rules', + body => ['Be concise', 'Be friendly'], + bullet => '*', +); +``` + +```perl +# Define tools with local handlers +$agent->define_tool( + name => 'get_time', + description => 'Get the current time', + parameters => { type => 'object', properties => {} }, + handler => sub { + my ($args, $raw) = @_; + require SignalWire::SWAIG::FunctionResult; + return SignalWire::SWAIG::FunctionResult->new( + "The time is " . localtime + ); + }, +); +``` + +```perl +# Add built-in skills +$agent->add_skill('datetime'); +$agent->add_skill('math'); +``` + +```perl +# Start the HTTP server +$agent->run(); +``` + +## Signature + +```perl +package SignalWire +``` + +## Methods + + + + + + + + + + + +## Modules + + + + + + + + + + + +## Source + +[`lib/SignalWire.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/list-skills-with-params.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/list-skills-with-params.mdx new file mode 100644 index 0000000000..77ccc98b7f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/list-skills-with-params.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/list-skills-with-params" +title: "list_skills_with_params" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::list_skills_with_params" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire.pm" + visibility: "public" +--- +# `list_skills_with_params` + +## Signature + +```perl +sub list_skills_with_params() +``` + +## Source + +[`lib/SignalWire.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire.pm) + +Line 108. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/debug.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/debug.mdx new file mode 100644 index 0000000000..4d348ef162 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/debug.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/logging/debug" +title: "debug" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Logging::debug" + parent: "SignalWire::Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm" + visibility: "public" +--- +# `debug` + +## Signature + +```perl +sub debug() +``` + +## Source + +[`lib/SignalWire/Logging.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm) + +Line 53. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/error.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/error.mdx new file mode 100644 index 0000000000..7031fcfcb3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/error.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/logging/error" +title: "error" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Logging::error" + parent: "SignalWire::Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm" + visibility: "public" +--- +# `error` + +## Signature + +```perl +sub error() +``` + +## Source + +[`lib/SignalWire/Logging.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm) + +Line 56. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/get-logger.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/get-logger.mdx new file mode 100644 index 0000000000..a7330f6ad5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/get-logger.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/logging/get-logger" +title: "get_logger" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Logging::get_logger" + parent: "SignalWire::Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm" + visibility: "public" +--- +# `get_logger` + +## Signature + +```perl +sub get_logger($class, $name) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Logging.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm) + +Line 67. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/index.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/index.mdx new file mode 100644 index 0000000000..0fff8a033d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/logging" +title: "Logging" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Logging" + parent: "SignalWire" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm" +--- +# `Logging` + +## Signature + +```perl +package SignalWire::Logging +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Logging.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/info.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/info.mdx new file mode 100644 index 0000000000..f79edd66ed --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/info.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/logging/info" +title: "info" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Logging::info" + parent: "SignalWire::Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm" + visibility: "public" +--- +# `info` + +## Signature + +```perl +sub info() +``` + +## Source + +[`lib/SignalWire/Logging.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm) + +Line 54. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/warn.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/warn.mdx new file mode 100644 index 0000000000..f418ebc651 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/logging/warn.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/logging/warn" +title: "warn" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Logging::warn" + parent: "SignalWire::Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm" + visibility: "public" +--- +# `warn` + +## Signature + +```perl +sub warn() +``` + +## Source + +[`lib/SignalWire/Logging.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Logging.pm) + +Line 55. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/register-skill.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/register-skill.mdx new file mode 100644 index 0000000000..5acd3c4a9e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/register-skill.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/register-skill" +title: "register_skill" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::register_skill" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire.pm" + visibility: "public" +--- +# `register_skill` + +## Signature + +```perl +sub register_skill($skill_class) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire.pm) + +Line 75. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/rest-client.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/rest-client.mdx new file mode 100644 index 0000000000..bace9c573a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/rest-client.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/rest-client" +title: "RestClient" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::RestClient" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire.pm" + visibility: "public" +--- +# `RestClient` + +## Signature + +```perl +sub RestClient(@args, %kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire.pm) + +Line 49. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/index.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/index.mdx new file mode 100644 index 0000000000..6f903ae5d0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/utils" +title: "Utils" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Utils" + parent: "SignalWire" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Utils.pm" +--- +# `Utils` + +## Signature + +```perl +package SignalWire::Utils +``` + +## Methods + + + + + +## Modules + + + + + +## Source + +[`lib/SignalWire/Utils.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Utils.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/is-serverless-mode.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/is-serverless-mode.mdx new file mode 100644 index 0000000000..0839a0a165 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/is-serverless-mode.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/utils/is-serverless-mode" +title: "is_serverless_mode" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Utils::is_serverless_mode" + parent: "SignalWire::Utils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Utils.pm" + visibility: "public" +--- +# `is_serverless_mode` + +## Signature + +```perl +sub is_serverless_mode() +``` + +## Source + +[`lib/SignalWire/Utils.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Utils.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/url-validator/index.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/url-validator/index.mdx new file mode 100644 index 0000000000..b4b5db1030 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/url-validator/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/utils/url-validator" +title: "UrlValidator" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Utils::UrlValidator" + parent: "SignalWire::Utils" + module: "SignalWire.Utils.UrlValidator" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Utils/UrlValidator.pm" +--- +# `UrlValidator` + +## Signature + +```perl +package SignalWire::Utils::UrlValidator +``` + +## Methods + + + + + +## Source + +[`lib/SignalWire/Utils/UrlValidator.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Utils/UrlValidator.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/url-validator/validate-url.mdx b/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/url-validator/validate-url.mdx new file mode 100644 index 0000000000..387f5577e2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/signal-wire/utils/url-validator/validate-url.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/signal-wire/utils/url-validator/validate-url" +title: "validate_url" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Utils::UrlValidator::validate_url" + parent: "SignalWire::Utils::UrlValidator" + module: "SignalWire.Utils.UrlValidator" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Utils/UrlValidator.pm" + visibility: "public" +--- +# `validate_url` + +## Signature + +```perl +sub validate_url($url, $allow_private) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Utils/UrlValidator.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Utils/UrlValidator.pm) + +Line 47. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/get-parameter-schema.mdx new file mode 100644 index 0000000000..171046b3f4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTrivia::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin.ApiNinjasTrivia" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm) + +Line 95. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/index.mdx new file mode 100644 index 0000000000..e7be4ab78f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia" +title: "ApiNinjasTrivia" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin.ApiNinjasTrivia" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm" +--- +# `ApiNinjasTrivia` + +## Signature + +```perl +package SignalWire::Skills::Builtin::ApiNinjasTrivia +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/register-tools.mdx new file mode 100644 index 0000000000..dd40708c58 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTrivia::register_tools" + parent: "SignalWire::Skills::Builtin::ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin.ApiNinjasTrivia" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm) + +Line 48. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/setup.mdx new file mode 100644 index 0000000000..846d53e772 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTrivia::setup" + parent: "SignalWire::Skills::Builtin::ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin.ApiNinjasTrivia" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ApiNinjasTrivia.pm) + +Line 46. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/get-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/get-hints.mdx new file mode 100644 index 0000000000..7ee9862209 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/get-hints" +title: "get_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkills::get_hints" + parent: "SignalWire::Skills::Builtin::ClaudeSkills" + module: "SignalWire.Skills.Builtin.ClaudeSkills" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ClaudeSkills.pm" + visibility: "public" +--- +# `get_hints` + +## Signature + +```perl +sub get_hints() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/ClaudeSkills.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ClaudeSkills.pm) + +Line 41. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/get-parameter-schema.mdx new file mode 100644 index 0000000000..ef8e3d8297 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkills::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::ClaudeSkills" + module: "SignalWire.Skills.Builtin.ClaudeSkills" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ClaudeSkills.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/ClaudeSkills.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ClaudeSkills.pm) + +Line 46. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/index.mdx new file mode 100644 index 0000000000..fdb7226f56 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills" +title: "ClaudeSkills" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkills" + module: "SignalWire.Skills.Builtin.ClaudeSkills" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ClaudeSkills.pm" +--- +# `ClaudeSkills` + +## Signature + +```perl +package SignalWire::Skills::Builtin::ClaudeSkills +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/ClaudeSkills.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ClaudeSkills.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/register-tools.mdx new file mode 100644 index 0000000000..1f2b312047 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkills::register_tools" + parent: "SignalWire::Skills::Builtin::ClaudeSkills" + module: "SignalWire.Skills.Builtin.ClaudeSkills" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ClaudeSkills.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/ClaudeSkills.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ClaudeSkills.pm) + +Line 16. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/setup.mdx new file mode 100644 index 0000000000..4a1f1049ee --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/claude-skills/claude-skills/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkills::setup" + parent: "SignalWire::Skills::Builtin::ClaudeSkills" + module: "SignalWire.Skills.Builtin.ClaudeSkills" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ClaudeSkills.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/ClaudeSkills.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/ClaudeSkills.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/get-parameter-schema.mdx new file mode 100644 index 0000000000..bd6ca5590a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::CustomSkills::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::CustomSkills" + module: "SignalWire.Skills.Builtin.CustomSkills" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/CustomSkills.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/CustomSkills.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/CustomSkills.pm) + +Line 30. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/index.mdx new file mode 100644 index 0000000000..79ff8ad51a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills" +title: "CustomSkills" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::CustomSkills" + module: "SignalWire.Skills.Builtin.CustomSkills" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/CustomSkills.pm" +--- +# `CustomSkills` + +## Signature + +```perl +package SignalWire::Skills::Builtin::CustomSkills +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/CustomSkills.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/CustomSkills.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/register-tools.mdx new file mode 100644 index 0000000000..a36c766d58 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::CustomSkills::register_tools" + parent: "SignalWire::Skills::Builtin::CustomSkills" + module: "SignalWire.Skills.Builtin.CustomSkills" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/CustomSkills.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/CustomSkills.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/CustomSkills.pm) + +Line 16. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/setup.mdx new file mode 100644 index 0000000000..af5a3e789e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/custom-skills/custom-skills/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::CustomSkills::setup" + parent: "SignalWire::Skills::Builtin::CustomSkills" + module: "SignalWire.Skills.Builtin.CustomSkills" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/CustomSkills.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/CustomSkills.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/CustomSkills.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-global-data.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-global-data.mdx new file mode 100644 index 0000000000..b0620b70d7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-global-data" +title: "get_global_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerless::get_global_data" + parent: "SignalWire::Skills::Builtin::DatasphereServerless" + module: "SignalWire.Skills.Builtin.DatasphereServerless" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```perl +sub get_global_data() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/DatasphereServerless.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm) + +Line 47. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-hints.mdx new file mode 100644 index 0000000000..bc27084711 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-hints" +title: "get_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerless::get_hints" + parent: "SignalWire::Skills::Builtin::DatasphereServerless" + module: "SignalWire.Skills.Builtin.DatasphereServerless" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm" + visibility: "public" +--- +# `get_hints` + +## Signature + +```perl +sub get_hints() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/DatasphereServerless.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm) + +Line 45. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-parameter-schema.mdx new file mode 100644 index 0000000000..421e569556 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerless::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::DatasphereServerless" + module: "SignalWire.Skills.Builtin.DatasphereServerless" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/DatasphereServerless.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm) + +Line 67. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/index.mdx new file mode 100644 index 0000000000..2120a35b79 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless" +title: "DatasphereServerless" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerless" + module: "SignalWire.Skills.Builtin.DatasphereServerless" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm" +--- +# `DatasphereServerless` + +## Signature + +```perl +package SignalWire::Skills::Builtin::DatasphereServerless +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/DatasphereServerless.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/register-tools.mdx new file mode 100644 index 0000000000..4d064994d0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerless::register_tools" + parent: "SignalWire::Skills::Builtin::DatasphereServerless" + module: "SignalWire.Skills.Builtin.DatasphereServerless" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/DatasphereServerless.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm) + +Line 17. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/setup.mdx new file mode 100644 index 0000000000..bee55130a0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere-serverless/datasphere-serverless/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerless::setup" + parent: "SignalWire::Skills::Builtin::DatasphereServerless" + module: "SignalWire.Skills.Builtin.DatasphereServerless" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/DatasphereServerless.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/DatasphereServerless.pm) + +Line 15. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-global-data.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-global-data.mdx new file mode 100644 index 0000000000..03aa21e358 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-global-data" +title: "get_global_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Datasphere::get_global_data" + parent: "SignalWire::Skills::Builtin::Datasphere" + module: "SignalWire.Skills.Builtin.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```perl +sub get_global_data() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm) + +Line 183. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-hints.mdx new file mode 100644 index 0000000000..da80cb39d1 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-hints" +title: "get_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Datasphere::get_hints" + parent: "SignalWire::Skills::Builtin::Datasphere" + module: "SignalWire.Skills.Builtin.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm" + visibility: "public" +--- +# `get_hints` + +## Signature + +```perl +sub get_hints() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm) + +Line 181. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-parameter-schema.mdx new file mode 100644 index 0000000000..2e7f5c41e2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere/datasphere/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Datasphere::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::Datasphere" + module: "SignalWire.Skills.Builtin.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm) + +Line 203. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/index.mdx new file mode 100644 index 0000000000..272a96f9b1 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere/datasphere" +title: "Datasphere" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Datasphere" + module: "SignalWire.Skills.Builtin.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm" +--- +# `Datasphere` + +## Signature + +```perl +package SignalWire::Skills::Builtin::Datasphere +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/register-tools.mdx new file mode 100644 index 0000000000..291a3522d2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere/datasphere/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Datasphere::register_tools" + parent: "SignalWire::Skills::Builtin::Datasphere" + module: "SignalWire.Skills.Builtin.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm) + +Line 63. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/search-knowledge.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/search-knowledge.mdx new file mode 100644 index 0000000000..5d10ba9a68 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/search-knowledge.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere/datasphere/search-knowledge" +title: "search_knowledge" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Datasphere::search_knowledge" + parent: "SignalWire::Skills::Builtin::Datasphere" + module: "SignalWire.Skills.Builtin.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm" + visibility: "public" +--- +# `search_knowledge` + +## Signature + +```perl +sub search_knowledge($query) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Skills/Builtin/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm) + +Line 107. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/setup.mdx new file mode 100644 index 0000000000..4ec5dd6b7e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datasphere/datasphere/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datasphere/datasphere/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Datasphere::setup" + parent: "SignalWire::Skills::Builtin::Datasphere" + module: "SignalWire.Skills.Builtin.Datasphere" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Datasphere.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datasphere.pm) + +Line 54. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/get-parameter-schema.mdx new file mode 100644 index 0000000000..04a0a8ec52 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datetime/datetime/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Datetime::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::Datetime" + module: "SignalWire.Skills.Builtin.Datetime" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datetime.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Datetime.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datetime.pm) + +Line 78. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/index.mdx new file mode 100644 index 0000000000..529e5fbddc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datetime/datetime" +title: "Datetime" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Datetime" + module: "SignalWire.Skills.Builtin.Datetime" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datetime.pm" +--- +# `Datetime` + +## Signature + +```perl +package SignalWire::Skills::Builtin::Datetime +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/Datetime.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datetime.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/register-tools.mdx new file mode 100644 index 0000000000..649469c819 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datetime/datetime/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Datetime::register_tools" + parent: "SignalWire::Skills::Builtin::Datetime" + module: "SignalWire.Skills.Builtin.Datetime" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datetime.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Datetime.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datetime.pm) + +Line 17. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/setup.mdx new file mode 100644 index 0000000000..3865915358 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/datetime/datetime/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/datetime/datetime/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Datetime::setup" + parent: "SignalWire::Skills::Builtin::Datetime" + module: "SignalWire.Skills.Builtin.Datetime" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datetime.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Datetime.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Datetime.pm) + +Line 15. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/get-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/get-hints.mdx new file mode 100644 index 0000000000..bb8e38936f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/google-maps/google-maps/get-hints" +title: "get_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::GoogleMaps::get_hints" + parent: "SignalWire::Skills::Builtin::GoogleMaps" + module: "SignalWire.Skills.Builtin.GoogleMaps" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/GoogleMaps.pm" + visibility: "public" +--- +# `get_hints` + +## Signature + +```perl +sub get_hints() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/GoogleMaps.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/GoogleMaps.pm) + +Line 65. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/get-parameter-schema.mdx new file mode 100644 index 0000000000..6c91b57c01 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/google-maps/google-maps/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::GoogleMaps::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::GoogleMaps" + module: "SignalWire.Skills.Builtin.GoogleMaps" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/GoogleMaps.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/GoogleMaps.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/GoogleMaps.pm) + +Line 80. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/index.mdx new file mode 100644 index 0000000000..a9eedb5538 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/google-maps/google-maps" +title: "GoogleMaps" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::GoogleMaps" + module: "SignalWire.Skills.Builtin.GoogleMaps" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/GoogleMaps.pm" +--- +# `GoogleMaps` + +## Signature + +```perl +package SignalWire::Skills::Builtin::GoogleMaps +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/GoogleMaps.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/GoogleMaps.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/register-tools.mdx new file mode 100644 index 0000000000..4ebe257ddc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/google-maps/google-maps/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::GoogleMaps::register_tools" + parent: "SignalWire::Skills::Builtin::GoogleMaps" + module: "SignalWire.Skills.Builtin.GoogleMaps" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/GoogleMaps.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/GoogleMaps.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/GoogleMaps.pm) + +Line 16. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/setup.mdx new file mode 100644 index 0000000000..10a63c9068 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/google-maps/google-maps/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/google-maps/google-maps/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::GoogleMaps::setup" + parent: "SignalWire::Skills::Builtin::GoogleMaps" + module: "SignalWire.Skills.Builtin.GoogleMaps" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/GoogleMaps.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/GoogleMaps.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/GoogleMaps.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/get-global-data.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/get-global-data.mdx new file mode 100644 index 0000000000..8230a74a3a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/get-global-data" +title: "get_global_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::InfoGatherer::get_global_data" + parent: "SignalWire::Skills::Builtin::InfoGatherer" + module: "SignalWire.Skills.Builtin.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/InfoGatherer.pm" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```perl +sub get_global_data() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/InfoGatherer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/InfoGatherer.pm) + +Line 60. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/get-parameter-schema.mdx new file mode 100644 index 0000000000..ed352d37c2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::InfoGatherer::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::InfoGatherer" + module: "SignalWire.Skills.Builtin.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/InfoGatherer.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/InfoGatherer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/InfoGatherer.pm) + +Line 86. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/index.mdx new file mode 100644 index 0000000000..5fb8af228b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer" +title: "InfoGatherer" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::InfoGatherer" + module: "SignalWire.Skills.Builtin.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/InfoGatherer.pm" +--- +# `InfoGatherer` + +## Signature + +```perl +package SignalWire::Skills::Builtin::InfoGatherer +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/InfoGatherer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/InfoGatherer.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/register-tools.mdx new file mode 100644 index 0000000000..0245e5e7a8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::InfoGatherer::register_tools" + parent: "SignalWire::Skills::Builtin::InfoGatherer" + module: "SignalWire.Skills.Builtin.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/InfoGatherer.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/InfoGatherer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/InfoGatherer.pm) + +Line 17. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/setup.mdx new file mode 100644 index 0000000000..7965d67db6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/info-gatherer/info-gatherer/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::InfoGatherer::setup" + parent: "SignalWire::Skills::Builtin::InfoGatherer" + module: "SignalWire.Skills.Builtin.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/InfoGatherer.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/InfoGatherer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/InfoGatherer.pm) + +Line 15. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/get-global-data.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/get-global-data.mdx new file mode 100644 index 0000000000..fe682e13be --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/joke/joke/get-global-data" +title: "get_global_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Joke::get_global_data" + parent: "SignalWire::Skills::Builtin::Joke" + module: "SignalWire.Skills.Builtin.Joke" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Joke.pm" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```perl +sub get_global_data() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Joke.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Joke.pm) + +Line 49. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/get-parameter-schema.mdx new file mode 100644 index 0000000000..3a3bb85c72 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/joke/joke/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Joke::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::Joke" + module: "SignalWire.Skills.Builtin.Joke" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Joke.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Joke.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Joke.pm) + +Line 64. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/index.mdx new file mode 100644 index 0000000000..7eaab75edf --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/joke/joke" +title: "Joke" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Joke" + module: "SignalWire.Skills.Builtin.Joke" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Joke.pm" +--- +# `Joke` + +## Signature + +```perl +package SignalWire::Skills::Builtin::Joke +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/Joke.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Joke.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/register-tools.mdx new file mode 100644 index 0000000000..aaf10087d8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/joke/joke/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Joke::register_tools" + parent: "SignalWire::Skills::Builtin::Joke" + module: "SignalWire.Skills.Builtin.Joke" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Joke.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Joke.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Joke.pm) + +Line 17. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/setup.mdx new file mode 100644 index 0000000000..572cfe6624 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/joke/joke/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/joke/joke/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Joke::setup" + parent: "SignalWire::Skills::Builtin::Joke" + module: "SignalWire.Skills.Builtin.Joke" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Joke.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Joke.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Joke.pm) + +Line 15. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/get-parameter-schema.mdx new file mode 100644 index 0000000000..70615de31c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/math/math/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Math::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::Math" + module: "SignalWire.Skills.Builtin.Math" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Math.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Math.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Math.pm) + +Line 62. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/index.mdx new file mode 100644 index 0000000000..c96462f7d1 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/math/math" +title: "Math" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Math" + module: "SignalWire.Skills.Builtin.Math" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Math.pm" +--- +# `Math` + +## Signature + +```perl +package SignalWire::Skills::Builtin::Math +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/Math.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Math.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/register-tools.mdx new file mode 100644 index 0000000000..35c4f6e6ec --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/math/math/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Math::register_tools" + parent: "SignalWire::Skills::Builtin::Math" + module: "SignalWire.Skills.Builtin.Math" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Math.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Math.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Math.pm) + +Line 16. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/setup.mdx new file mode 100644 index 0000000000..5e14adaed4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/math/math/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/math/math/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Math::setup" + parent: "SignalWire::Skills::Builtin::Math" + module: "SignalWire.Skills.Builtin.Math" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Math.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Math.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Math.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-global-data.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-global-data.mdx new file mode 100644 index 0000000000..13a9303240 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-global-data" +title: "get_global_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::McpGateway::get_global_data" + parent: "SignalWire::Skills::Builtin::McpGateway" + module: "SignalWire.Skills.Builtin.McpGateway" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```perl +sub get_global_data() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/McpGateway.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm) + +Line 54. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-hints.mdx new file mode 100644 index 0000000000..a536083157 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-hints" +title: "get_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::McpGateway::get_hints" + parent: "SignalWire::Skills::Builtin::McpGateway" + module: "SignalWire.Skills.Builtin.McpGateway" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm" + visibility: "public" +--- +# `get_hints` + +## Signature + +```perl +sub get_hints() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/McpGateway.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm) + +Line 45. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-parameter-schema.mdx new file mode 100644 index 0000000000..a55100ac16 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::McpGateway::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::McpGateway" + module: "SignalWire.Skills.Builtin.McpGateway" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/McpGateway.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm) + +Line 71. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/index.mdx new file mode 100644 index 0000000000..ac9e428bcd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway" +title: "McpGateway" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::McpGateway" + module: "SignalWire.Skills.Builtin.McpGateway" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm" +--- +# `McpGateway` + +## Signature + +```perl +package SignalWire::Skills::Builtin::McpGateway +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/McpGateway.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/register-tools.mdx new file mode 100644 index 0000000000..ce3e3d0e85 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::McpGateway::register_tools" + parent: "SignalWire::Skills::Builtin::McpGateway" + module: "SignalWire.Skills.Builtin.McpGateway" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/McpGateway.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm) + +Line 16. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/setup.mdx new file mode 100644 index 0000000000..9b5f8c3274 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/mcp-gateway/mcp-gateway/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::McpGateway::setup" + parent: "SignalWire::Skills::Builtin::McpGateway" + module: "SignalWire.Skills.Builtin.McpGateway" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/McpGateway.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/McpGateway.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/get-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/get-hints.mdx new file mode 100644 index 0000000000..a89e392eb8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/get-hints" +title: "get_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearch::get_hints" + parent: "SignalWire::Skills::Builtin::NativeVectorSearch" + module: "SignalWire.Skills.Builtin.NativeVectorSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm" + visibility: "public" +--- +# `get_hints` + +## Signature + +```perl +sub get_hints() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm) + +Line 42. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/get-parameter-schema.mdx new file mode 100644 index 0000000000..0e966954d3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearch::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::NativeVectorSearch" + module: "SignalWire.Skills.Builtin.NativeVectorSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm) + +Line 57. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/index.mdx new file mode 100644 index 0000000000..56a26a9115 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search" +title: "NativeVectorSearch" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearch" + module: "SignalWire.Skills.Builtin.NativeVectorSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm" +--- +# `NativeVectorSearch` + +## Signature + +```perl +package SignalWire::Skills::Builtin::NativeVectorSearch +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/register-tools.mdx new file mode 100644 index 0000000000..6302482d04 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearch::register_tools" + parent: "SignalWire::Skills::Builtin::NativeVectorSearch" + module: "SignalWire.Skills.Builtin.NativeVectorSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm) + +Line 16. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/setup.mdx new file mode 100644 index 0000000000..b12bf4ccc2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/native-vector-search/native-vector-search/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearch::setup" + parent: "SignalWire::Skills::Builtin::NativeVectorSearch" + module: "SignalWire.Skills.Builtin.NativeVectorSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/NativeVectorSearch.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/get-parameter-schema.mdx new file mode 100644 index 0000000000..f75d3f920e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFile::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::PlayBackgroundFile" + module: "SignalWire.Skills.Builtin.PlayBackgroundFile" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm) + +Line 57. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/index.mdx new file mode 100644 index 0000000000..7a96a07980 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file" +title: "PlayBackgroundFile" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFile" + module: "SignalWire.Skills.Builtin.PlayBackgroundFile" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm" +--- +# `PlayBackgroundFile` + +## Signature + +```perl +package SignalWire::Skills::Builtin::PlayBackgroundFile +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/register-tools.mdx new file mode 100644 index 0000000000..c0a9e10d8d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFile::register_tools" + parent: "SignalWire::Skills::Builtin::PlayBackgroundFile" + module: "SignalWire.Skills.Builtin.PlayBackgroundFile" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm) + +Line 16. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/setup.mdx new file mode 100644 index 0000000000..4f21ce4a2b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/play-background-file/play-background-file/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFile::setup" + parent: "SignalWire::Skills::Builtin::PlayBackgroundFile" + module: "SignalWire.Skills.Builtin.PlayBackgroundFile" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/PlayBackgroundFile.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/get-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/get-hints.mdx new file mode 100644 index 0000000000..657435218f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/spider/spider/get-hints" +title: "get_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Spider::get_hints" + parent: "SignalWire::Skills::Builtin::Spider" + module: "SignalWire.Skills.Builtin.Spider" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm" + visibility: "public" +--- +# `get_hints` + +## Signature + +```perl +sub get_hints() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Spider.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm) + +Line 180. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/get-parameter-schema.mdx new file mode 100644 index 0000000000..3914db1540 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/spider/spider/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Spider::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::Spider" + module: "SignalWire.Skills.Builtin.Spider" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Spider.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm) + +Line 184. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/index.mdx new file mode 100644 index 0000000000..a7eda8984f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/spider/spider" +title: "Spider" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Spider" + module: "SignalWire.Skills.Builtin.Spider" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm" +--- +# `Spider` + +## Signature + +```perl +package SignalWire::Skills::Builtin::Spider +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/Spider.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/register-tools.mdx new file mode 100644 index 0000000000..2046d1de57 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/spider/spider/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Spider::register_tools" + parent: "SignalWire::Skills::Builtin::Spider" + module: "SignalWire.Skills.Builtin.Spider" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Spider.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm) + +Line 50. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/scrape-url.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/scrape-url.mdx new file mode 100644 index 0000000000..805c05263a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/scrape-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/spider/spider/scrape-url" +title: "scrape_url" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Spider::scrape_url" + parent: "SignalWire::Skills::Builtin::Spider" + module: "SignalWire.Skills.Builtin.Spider" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm" + visibility: "public" +--- +# `scrape_url` + +## Signature + +```perl +sub scrape_url($url) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Skills/Builtin/Spider.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm) + +Line 119. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/setup.mdx new file mode 100644 index 0000000000..8fa09e1236 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/spider/spider/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/spider/spider/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::Spider::setup" + parent: "SignalWire::Skills::Builtin::Spider" + module: "SignalWire.Skills.Builtin.Spider" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/Spider.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/Spider.pm) + +Line 48. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/get-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/get-hints.mdx new file mode 100644 index 0000000000..f249871adc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/get-hints" +title: "get_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransfer::get_hints" + parent: "SignalWire::Skills::Builtin::SwmlTransfer" + module: "SignalWire.Skills.Builtin.SwmlTransfer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/SwmlTransfer.pm" + visibility: "public" +--- +# `get_hints` + +## Signature + +```perl +sub get_hints() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/SwmlTransfer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/SwmlTransfer.pm) + +Line 57. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/get-parameter-schema.mdx new file mode 100644 index 0000000000..c98022351e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransfer::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::SwmlTransfer" + module: "SignalWire.Skills.Builtin.SwmlTransfer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/SwmlTransfer.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/SwmlTransfer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/SwmlTransfer.pm) + +Line 82. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/index.mdx new file mode 100644 index 0000000000..612b395f3d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer" +title: "SwmlTransfer" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransfer" + module: "SignalWire.Skills.Builtin.SwmlTransfer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/SwmlTransfer.pm" +--- +# `SwmlTransfer` + +## Signature + +```perl +package SignalWire::Skills::Builtin::SwmlTransfer +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/SwmlTransfer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/SwmlTransfer.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/register-tools.mdx new file mode 100644 index 0000000000..e31dde8517 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransfer::register_tools" + parent: "SignalWire::Skills::Builtin::SwmlTransfer" + module: "SignalWire.Skills.Builtin.SwmlTransfer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/SwmlTransfer.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/SwmlTransfer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/SwmlTransfer.pm) + +Line 16. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/setup.mdx new file mode 100644 index 0000000000..00a237c10d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/swml-transfer/swml-transfer/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransfer::setup" + parent: "SignalWire::Skills::Builtin::SwmlTransfer" + module: "SignalWire.Skills.Builtin.SwmlTransfer" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/SwmlTransfer.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/SwmlTransfer.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/SwmlTransfer.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/get-parameter-schema.mdx new file mode 100644 index 0000000000..0c175a7426 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/weather-api/weather-api/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WeatherApi::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::WeatherApi" + module: "SignalWire.Skills.Builtin.WeatherApi" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WeatherApi.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/WeatherApi.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WeatherApi.pm) + +Line 67. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/index.mdx new file mode 100644 index 0000000000..19b47863f7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/weather-api/weather-api" +title: "WeatherApi" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WeatherApi" + module: "SignalWire.Skills.Builtin.WeatherApi" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WeatherApi.pm" +--- +# `WeatherApi` + +## Signature + +```perl +package SignalWire::Skills::Builtin::WeatherApi +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/WeatherApi.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WeatherApi.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/register-tools.mdx new file mode 100644 index 0000000000..02a779116b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/weather-api/weather-api/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WeatherApi::register_tools" + parent: "SignalWire::Skills::Builtin::WeatherApi" + module: "SignalWire.Skills.Builtin.WeatherApi" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WeatherApi.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/WeatherApi.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WeatherApi.pm) + +Line 16. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/setup.mdx new file mode 100644 index 0000000000..7a0e86d8ef --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/weather-api/weather-api/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/weather-api/weather-api/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WeatherApi::setup" + parent: "SignalWire::Skills::Builtin::WeatherApi" + module: "SignalWire.Skills.Builtin.WeatherApi" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WeatherApi.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/WeatherApi.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WeatherApi.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/get-global-data.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/get-global-data.mdx new file mode 100644 index 0000000000..0ea0668be7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/web-search/web-search/get-global-data" +title: "get_global_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WebSearch::get_global_data" + parent: "SignalWire::Skills::Builtin::WebSearch" + module: "SignalWire.Skills.Builtin.WebSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```perl +sub get_global_data() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/WebSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm) + +Line 157. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/get-parameter-schema.mdx new file mode 100644 index 0000000000..78903d8938 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/web-search/web-search/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WebSearch::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::WebSearch" + module: "SignalWire.Skills.Builtin.WebSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/WebSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm) + +Line 176. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/index.mdx new file mode 100644 index 0000000000..eb3e9cfbb8 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/web-search/web-search" +title: "WebSearch" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WebSearch" + module: "SignalWire.Skills.Builtin.WebSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm" +--- +# `WebSearch` + +## Signature + +```perl +package SignalWire::Skills::Builtin::WebSearch +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/WebSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/register-tools.mdx new file mode 100644 index 0000000000..6939b398dc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/web-search/web-search/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WebSearch::register_tools" + parent: "SignalWire::Skills::Builtin::WebSearch" + module: "SignalWire.Skills.Builtin.WebSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/WebSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm) + +Line 66. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/search-web.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/search-web.mdx new file mode 100644 index 0000000000..83a48dd03c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/search-web.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/web-search/web-search/search-web" +title: "search_web" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WebSearch::search_web" + parent: "SignalWire::Skills::Builtin::WebSearch" + module: "SignalWire.Skills.Builtin.WebSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm" + visibility: "public" +--- +# `search_web` + +## Signature + +```perl +sub search_web($query) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Skills/Builtin/WebSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm) + +Line 95. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/setup.mdx new file mode 100644 index 0000000000..823710564d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/web-search/web-search/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/web-search/web-search/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WebSearch::setup" + parent: "SignalWire::Skills::Builtin::WebSearch" + module: "SignalWire.Skills.Builtin.WebSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/WebSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WebSearch.pm) + +Line 64. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/get-parameter-schema.mdx new file mode 100644 index 0000000000..b459080d62 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearch::get_parameter_schema" + parent: "SignalWire::Skills::Builtin::WikipediaSearch" + module: "SignalWire.Skills.Builtin.WikipediaSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WikipediaSearch.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/WikipediaSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WikipediaSearch.pm) + +Line 189. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/index.mdx new file mode 100644 index 0000000000..183d795e5f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search" +title: "WikipediaSearch" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearch" + module: "SignalWire.Skills.Builtin.WikipediaSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WikipediaSearch.pm" +--- +# `WikipediaSearch` + +## Signature + +```perl +package SignalWire::Skills::Builtin::WikipediaSearch +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/perl/signal-wire/skills/skill-base/skill-base) + +## Methods + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/Builtin/WikipediaSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WikipediaSearch.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/register-tools.mdx new file mode 100644 index 0000000000..55e47f6e1d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearch::register_tools" + parent: "SignalWire::Skills::Builtin::WikipediaSearch" + module: "SignalWire.Skills.Builtin.WikipediaSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WikipediaSearch.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/WikipediaSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WikipediaSearch.pm) + +Line 77. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/search-wiki.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/search-wiki.mdx new file mode 100644 index 0000000000..036810886d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/search-wiki.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/search-wiki" +title: "search_wiki" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearch::search_wiki" + parent: "SignalWire::Skills::Builtin::WikipediaSearch" + module: "SignalWire.Skills.Builtin.WikipediaSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WikipediaSearch.pm" + visibility: "public" +--- +# `search_wiki` + +## Signature + +```perl +sub search_wiki($query) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Skills/Builtin/WikipediaSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WikipediaSearch.pm) + +Line 112. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/setup.mdx new file mode 100644 index 0000000000..b496c0a42f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/builtin/wikipedia-search/wikipedia-search/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearch::setup" + parent: "SignalWire::Skills::Builtin::WikipediaSearch" + module: "SignalWire.Skills.Builtin.WikipediaSearch" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WikipediaSearch.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/Builtin/WikipediaSearch.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/Builtin/WikipediaSearch.pm) + +Line 64. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/build.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/build.mdx new file mode 100644 index 0000000000..77f55e468e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/build.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base/build" +title: "BUILD" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase::BUILD" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" + visibility: "public" +--- +# `BUILD` + +## Signature + +```perl +sub BUILD() +``` + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 27. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/cleanup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/cleanup.mdx new file mode 100644 index 0000000000..b43c4a9405 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base/cleanup" +title: "cleanup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase::cleanup" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" + visibility: "public" +--- +# `cleanup` + +## Signature + +```perl +sub cleanup() +``` + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 74. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/define-tool.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/define-tool.mdx new file mode 100644 index 0000000000..8071a1f744 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/define-tool.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base/define-tool" +title: "define_tool" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase::define_tool" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" + visibility: "public" +--- +# `define_tool` + +## Signature + +```perl +sub define_tool(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 49. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-global-data.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-global-data.mdx new file mode 100644 index 0000000000..8ad7726aef --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base/get-global-data" +title: "get_global_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase::get_global_data" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```perl +sub get_global_data() +``` + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 60. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-hints.mdx new file mode 100644 index 0000000000..5571161d6c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base/get-hints" +title: "get_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase::get_hints" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" + visibility: "public" +--- +# `get_hints` + +## Signature + +```perl +sub get_hints() +``` + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 56. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-instance-key.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-instance-key.mdx new file mode 100644 index 0000000000..57b112c1f0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base/get-instance-key" +title: "get_instance_key" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase::get_instance_key" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" + visibility: "public" +--- +# `get_instance_key` + +## Signature + +```perl +sub get_instance_key() +``` + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 94. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-parameter-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-parameter-schema.mdx new file mode 100644 index 0000000000..0274c396b5 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase::get_parameter_schema" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```perl +sub get_parameter_schema() +``` + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 86. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-prompt-sections.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-prompt-sections.mdx new file mode 100644 index 0000000000..f7648f4c7e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase::get_prompt_sections" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```perl +sub get_prompt_sections() +``` + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 64. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/index.mdx new file mode 100644 index 0000000000..b2ee2b78e3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base" +title: "SkillBase" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" +--- +# `SkillBase` + +## Signature + +```perl +package SignalWire::Skills::SkillBase +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/register-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/register-tools.mdx new file mode 100644 index 0000000000..7a747d083c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base/register-tools" +title: "register_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase::register_tools" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" + visibility: "public" +--- +# `register_tools` + +## Signature + +```perl +sub register_tools() +``` + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 42. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/setup.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/setup.mdx new file mode 100644 index 0000000000..f981d18eed --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base/setup" +title: "setup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase::setup" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" + visibility: "public" +--- +# `setup` + +## Signature + +```perl +sub setup() +``` + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 37. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/validate-env-vars.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/validate-env-vars.mdx new file mode 100644 index 0000000000..5e8965e68c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-base/skill-base/validate-env-vars.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-base/skill-base/validate-env-vars" +title: "validate_env_vars" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillBase::validate_env_vars" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm" + visibility: "public" +--- +# `validate_env_vars` + +## Signature + +```perl +sub validate_env_vars() +``` + +## Source + +[`lib/SignalWire/Skills/SkillBase.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillBase.pm) + +Line 78. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/has-skill.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/has-skill.mdx new file mode 100644 index 0000000000..14e603ed24 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/has-skill.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-manager/skill-manager/has-skill" +title: "has_skill" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillManager::has_skill" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillManager.pm" + visibility: "public" +--- +# `has_skill` + +## Signature + +```perl +sub has_skill($key) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Skills/SkillManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillManager.pm) + +Line 108. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/index.mdx new file mode 100644 index 0000000000..ab07271be2 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-manager/skill-manager" +title: "SkillManager" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillManager.pm" +--- +# `SkillManager` + +## Signature + +```perl +package SignalWire::Skills::SkillManager +``` + +## Methods + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/SkillManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillManager.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/list-skills.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/list-skills.mdx new file mode 100644 index 0000000000..da1942b684 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/list-skills.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-manager/skill-manager/list-skills" +title: "list_skills" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillManager::list_skills" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillManager.pm" + visibility: "public" +--- +# `list_skills` + +## Signature + +```perl +sub list_skills() +``` + +## Source + +[`lib/SignalWire/Skills/SkillManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillManager.pm) + +Line 103. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/load-skill.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/load-skill.mdx new file mode 100644 index 0000000000..aa86bca876 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/load-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-manager/skill-manager/load-skill" +title: "load_skill" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillManager::load_skill" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillManager.pm" + visibility: "public" +--- +# `load_skill` + +## Signature + +```perl +sub load_skill($skill_name, $skill_class, $params) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/Skills/SkillManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillManager.pm) + +Line 13. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/unload-skill.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/unload-skill.mdx new file mode 100644 index 0000000000..20745bd0f3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-manager/skill-manager/unload-skill.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-manager/skill-manager/unload-skill" +title: "unload_skill" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillManager::unload_skill" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillManager.pm" + visibility: "public" +--- +# `unload_skill` + +## Signature + +```perl +sub unload_skill($key) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Skills/SkillManager.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillManager.pm) + +Line 93. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/add-skill-directory.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/add-skill-directory.mdx new file mode 100644 index 0000000000..e4af30b4dc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/add-skill-directory.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-registry/skill-registry/add-skill-directory" +title: "add_skill_directory" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillRegistry::add_skill_directory" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm" + visibility: "public" +--- +# `add_skill_directory` + +## Signature + +```perl +sub add_skill_directory($class, $path) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Skills/SkillRegistry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm) + +Line 118. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/clear-registry.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/clear-registry.mdx new file mode 100644 index 0000000000..04108da507 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/clear-registry.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-registry/skill-registry/clear-registry" +title: "clear_registry" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillRegistry::clear_registry" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm" + visibility: "public" +--- +# `clear_registry` + +## Signature + +```perl +sub clear_registry() +``` + +## Source + +[`lib/SignalWire/Skills/SkillRegistry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm) + +Line 106. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/get-all-skills-schema.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/get-all-skills-schema.mdx new file mode 100644 index 0000000000..145f2cee2d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/get-all-skills-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-registry/skill-registry/get-all-skills-schema" +title: "get_all_skills_schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillRegistry::get_all_skills_schema" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm" + visibility: "public" +--- +# `get_all_skills_schema` + +## Signature + +```perl +sub get_all_skills_schema() +``` + +## Source + +[`lib/SignalWire/Skills/SkillRegistry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm) + +Line 54. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/get-factory.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/get-factory.mdx new file mode 100644 index 0000000000..f4b794ecfd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/get-factory.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-registry/skill-registry/get-factory" +title: "get_factory" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillRegistry::get_factory" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm" + visibility: "public" +--- +# `get_factory` + +## Signature + +```perl +sub get_factory($class, $skill_name) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/Skills/SkillRegistry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm) + +Line 19. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/index.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/index.mdx new file mode 100644 index 0000000000..eafad88ec7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-registry/skill-registry" +title: "SkillRegistry" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm" +--- +# `SkillRegistry` + +## Signature + +```perl +package SignalWire::Skills::SkillRegistry +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/Skills/SkillRegistry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/list-skills.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/list-skills.mdx new file mode 100644 index 0000000000..5aa20f7956 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/list-skills.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-registry/skill-registry/list-skills" +title: "list_skills" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillRegistry::list_skills" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm" + visibility: "public" +--- +# `list_skills` + +## Signature + +```perl +sub list_skills($class) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/Skills/SkillRegistry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm) + +Line 39. diff --git a/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/register-skill.mdx b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/register-skill.mdx new file mode 100644 index 0000000000..f471f31ab9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/skills/skill-registry/skill-registry/register-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/skills/skill-registry/skill-registry/register-skill" +title: "register_skill" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::Skills::SkillRegistry::register_skill" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm" + visibility: "public" +--- +# `register_skill` + +## Signature + +```perl +sub register_skill($class, $skill_name, $skill_class) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/Skills/SkillRegistry.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/Skills/SkillRegistry.pm) + +Line 14. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/add-action.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/add-action.mdx new file mode 100644 index 0000000000..080d9d72e6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/add-action.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/add-action" +title: "add_action" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::add_action" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `add_action` + +## Signature + +```perl +sub add_action($name, $data) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 49. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/add-actions.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/add-actions.mdx new file mode 100644 index 0000000000..8a2638354e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/add-actions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/add-actions" +title: "add_actions" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::add_actions" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `add_actions` + +## Signature + +```perl +sub add_actions($actions) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 55. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/add-dynamic-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/add-dynamic-hints.mdx new file mode 100644 index 0000000000..a1dc7e7d3a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/add-dynamic-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/add-dynamic-hints" +title: "add_dynamic_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::add_dynamic_hints" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `add_dynamic_hints` + +## Signature + +```perl +sub add_dynamic_hints($hints) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 274. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/clear-dynamic-hints.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/clear-dynamic-hints.mdx new file mode 100644 index 0000000000..9d6e27a097 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/clear-dynamic-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/clear-dynamic-hints" +title: "clear_dynamic_hints" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::clear_dynamic_hints" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `clear_dynamic_hints` + +## Signature + +```perl +sub clear_dynamic_hints() +``` + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 279. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/connect.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/connect.mdx new file mode 100644 index 0000000000..89007b5b0f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/connect.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/connect" +title: "connect" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::connect" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `connect` + +## Signature + +```perl +sub connect($destination, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 63. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/create-payment-action.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/create-payment-action.mdx new file mode 100644 index 0000000000..96a97cdddc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/create-payment-action.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/create-payment-action" +title: "create_payment_action" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::create_payment_action" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `create_payment_action` + +## Signature + +```perl +sub create_payment_action($class_or_self, $action_type, $phrase) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 595. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/create-payment-parameter.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/create-payment-parameter.mdx new file mode 100644 index 0000000000..ed97038caa --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/create-payment-parameter.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/create-payment-parameter" +title: "create_payment_parameter" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::create_payment_parameter" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `create_payment_parameter` + +## Signature + +```perl +sub create_payment_parameter($class_or_self, $name, $value) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 600. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/create-payment-prompt.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/create-payment-prompt.mdx new file mode 100644 index 0000000000..74f5fb7c6b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/create-payment-prompt.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/create-payment-prompt" +title: "create_payment_prompt" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::create_payment_prompt" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `create_payment_prompt` + +## Signature + +```perl +sub create_payment_prompt($class_or_self, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 578. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/enable-extensive-data.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/enable-extensive-data.mdx new file mode 100644 index 0000000000..dcbedbab0c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/enable-extensive-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/enable-extensive-data" +title: "enable_extensive_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::enable_extensive_data" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `enable_extensive_data` + +## Signature + +```perl +sub enable_extensive_data($enabled) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 306. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/enable-functions-on-timeout.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/enable-functions-on-timeout.mdx new file mode 100644 index 0000000000..ada003b29a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/enable-functions-on-timeout.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/enable-functions-on-timeout" +title: "enable_functions_on_timeout" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::enable_functions_on_timeout" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `enable_functions_on_timeout` + +## Signature + +```perl +sub enable_functions_on_timeout($enabled) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 300. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/execute-rpc.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/execute-rpc.mdx new file mode 100644 index 0000000000..80bff8eb3e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/execute-rpc.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/execute-rpc" +title: "execute_rpc" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::execute_rpc" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `execute_rpc` + +## Signature + +```perl +sub execute_rpc(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 503. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/execute-swml.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/execute-swml.mdx new file mode 100644 index 0000000000..b03ea298d7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/execute-swml.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/execute-swml" +title: "execute_swml" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::execute_swml" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `execute_swml` + +## Signature + +```perl +sub execute_swml($swml_content, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 319. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/hangup.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/hangup.mdx new file mode 100644 index 0000000000..f5b8952fbc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/hangup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/hangup" +title: "hangup" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::hangup" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `hangup` + +## Signature + +```perl +sub hangup() +``` + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 106. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/hold.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/hold.mdx new file mode 100644 index 0000000000..ebe5ce7414 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/hold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/hold" +title: "hold" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::hold" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `hold` + +## Signature + +```perl +sub hold($timeout) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 111. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/index.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/index.mdx new file mode 100644 index 0000000000..00b8ced1a0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/index.mdx @@ -0,0 +1,130 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result" +title: "FunctionResult" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" +--- +# `FunctionResult` + +## Signature + +```perl +package SignalWire::SWAIG::FunctionResult +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/join-conference.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/join-conference.mdx new file mode 100644 index 0000000000..ec5266aa26 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/join-conference.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/join-conference" +title: "join_conference" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::join_conference" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `join_conference` + +## Signature + +```perl +sub join_conference($name, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 346. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/join-room.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/join-room.mdx new file mode 100644 index 0000000000..d1f22b0873 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/join-room.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/join-room" +title: "join_room" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::join_room" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `join_room` + +## Signature + +```perl +sub join_room($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 373. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/pay.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/pay.mdx new file mode 100644 index 0000000000..8891f3350f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/pay.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/pay" +title: "pay" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::pay" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `pay` + +## Signature + +```perl +sub pay(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 454. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/play-background-file.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/play-background-file.mdx new file mode 100644 index 0000000000..f54a99287c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/play-background-file.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/play-background-file" +title: "play_background_file" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::play_background_file" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `play_background_file` + +## Signature + +```perl +sub play_background_file($filename, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 220. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/record-call.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/record-call.mdx new file mode 100644 index 0000000000..b43a2e947c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/record-call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/record-call" +title: "record_call" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::record_call" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `record_call` + +## Signature + +```perl +sub record_call(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 234. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/remove-global-data.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/remove-global-data.mdx new file mode 100644 index 0000000000..f02040bf87 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/remove-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/remove-global-data" +title: "remove_global_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::remove_global_data" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `remove_global_data` + +## Signature + +```perl +sub remove_global_data($keys) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 150. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/remove-metadata.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/remove-metadata.mdx new file mode 100644 index 0000000000..b9eb2ae273 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/remove-metadata.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/remove-metadata" +title: "remove_metadata" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::remove_metadata" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `remove_metadata` + +## Signature + +```perl +sub remove_metadata($keys) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 160. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/replace-in-history.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/replace-in-history.mdx new file mode 100644 index 0000000000..b6d68df4ea --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/replace-in-history.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/replace-in-history" +title: "replace_in_history" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::replace_in_history" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `replace_in_history` + +## Signature + +```perl +sub replace_in_history($text) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 207. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/rpc-ai-message.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/rpc-ai-message.mdx new file mode 100644 index 0000000000..28dd32be35 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/rpc-ai-message.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/rpc-ai-message" +title: "rpc_ai_message" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::rpc_ai_message" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `rpc_ai_message` + +## Signature + +```perl +sub rpc_ai_message(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 544. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/rpc-ai-unhold.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/rpc-ai-unhold.mdx new file mode 100644 index 0000000000..4f3aad7a63 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/rpc-ai-unhold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/rpc-ai-unhold" +title: "rpc_ai_unhold" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::rpc_ai_unhold" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `rpc_ai_unhold` + +## Signature + +```perl +sub rpc_ai_unhold(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 560. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/rpc-dial.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/rpc-dial.mdx new file mode 100644 index 0000000000..657cd4bc51 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/rpc-dial.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/rpc-dial" +title: "rpc_dial" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::rpc_dial" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `rpc_dial` + +## Signature + +```perl +sub rpc_dial(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 522. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/say.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/say.mdx new file mode 100644 index 0000000000..c65e5ed2c6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/say.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/say" +title: "say" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::say" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `say` + +## Signature + +```perl +sub say($text) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 215. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/send-sms.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/send-sms.mdx new file mode 100644 index 0000000000..5f25154be0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/send-sms.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/send-sms" +title: "send_sms" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::send_sms" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `send_sms` + +## Signature + +```perl +sub send_sms(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 427. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-end-of-speech-timeout.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-end-of-speech-timeout.mdx new file mode 100644 index 0000000000..8c8120964a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-end-of-speech-timeout.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/set-end-of-speech-timeout" +title: "set_end_of_speech_timeout" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::set_end_of_speech_timeout" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `set_end_of_speech_timeout` + +## Signature + +```perl +sub set_end_of_speech_timeout($ms) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 285. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-metadata.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-metadata.mdx new file mode 100644 index 0000000000..b9bf47143b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-metadata.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/set-metadata" +title: "set_metadata" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::set_metadata" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `set_metadata` + +## Signature + +```perl +sub set_metadata($data) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 155. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-post-process.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-post-process.mdx new file mode 100644 index 0000000000..7d2fcc78cd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-post-process.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/set-post-process" +title: "set_post_process" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::set_post_process" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `set_post_process` + +## Signature + +```perl +sub set_post_process($post_process) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 43. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-response.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-response.mdx new file mode 100644 index 0000000000..35a9fad239 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-response.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/set-response" +title: "set_response" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::set_response" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `set_response` + +## Signature + +```perl +sub set_response($response) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 37. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-speech-event-timeout.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-speech-event-timeout.mdx new file mode 100644 index 0000000000..321c481388 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/set-speech-event-timeout.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/set-speech-event-timeout" +title: "set_speech_event_timeout" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::set_speech_event_timeout" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `set_speech_event_timeout` + +## Signature + +```perl +sub set_speech_event_timeout($ms) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 290. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/simulate-user-input.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/simulate-user-input.mdx new file mode 100644 index 0000000000..36717399d1 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/simulate-user-input.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/simulate-user-input" +title: "simulate_user_input" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::simulate_user_input" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `simulate_user_input` + +## Signature + +```perl +sub simulate_user_input($text) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 571. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/sip-refer.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/sip-refer.mdx new file mode 100644 index 0000000000..13ee92b23c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/sip-refer.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/sip-refer" +title: "sip_refer" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::sip_refer" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `sip_refer` + +## Signature + +```perl +sub sip_refer($to_uri) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 382. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop-background-file.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop-background-file.mdx new file mode 100644 index 0000000000..ec18577bdc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop-background-file.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/stop-background-file" +title: "stop_background_file" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::stop_background_file" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `stop_background_file` + +## Signature + +```perl +sub stop_background_file() +``` + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 229. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop-record-call.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop-record-call.mdx new file mode 100644 index 0000000000..3f2ba1e14f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop-record-call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/stop-record-call" +title: "stop_record_call" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::stop_record_call" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `stop_record_call` + +## Signature + +```perl +sub stop_record_call(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 259. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop-tap.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop-tap.mdx new file mode 100644 index 0000000000..66ef1067c9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop-tap.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/stop-tap" +title: "stop_tap" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::stop_tap" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `stop_tap` + +## Signature + +```perl +sub stop_tap(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 414. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop.mdx new file mode 100644 index 0000000000..44470fd725 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/stop" +title: "stop" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::stop" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `stop` + +## Signature + +```perl +sub stop() +``` + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 138. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/switch-context.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/switch-context.mdx new file mode 100644 index 0000000000..95739b407e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/switch-context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/switch-context" +title: "switch_context" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::switch_context" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `switch_context` + +## Signature + +```perl +sub switch_context(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 188. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-change-context.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-change-context.mdx new file mode 100644 index 0000000000..c051dc2013 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-change-context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/swml-change-context" +title: "swml_change_context" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::swml_change_context" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `swml_change_context` + +## Signature + +```perl +sub swml_change_context($context_name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 183. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-change-step.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-change-step.mdx new file mode 100644 index 0000000000..969ad7a921 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-change-step.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/swml-change-step" +title: "swml_change_step" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::swml_change_step" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `swml_change_step` + +## Signature + +```perl +sub swml_change_step($step_name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 178. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-transfer.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-transfer.mdx new file mode 100644 index 0000000000..6f602223a4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-transfer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/swml-transfer" +title: "swml_transfer" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::swml_transfer" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `swml_transfer` + +## Signature + +```perl +sub swml_transfer($dest, $ai_response, %opts) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 85. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-user-event.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-user-event.mdx new file mode 100644 index 0000000000..d0404331df --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/swml-user-event.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/swml-user-event" +title: "swml_user_event" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::swml_user_event" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `swml_user_event` + +## Signature + +```perl +sub swml_user_event($event_data) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 165. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/tap.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/tap.mdx new file mode 100644 index 0000000000..065e7e09cd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/tap.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/tap" +title: "tap" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::tap" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `tap` + +## Signature + +```perl +sub tap($uri, %opts) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 391. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/to-hash.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/to-hash.mdx new file mode 100644 index 0000000000..4828102293 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/to-hash.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/to-hash" +title: "to_hash" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::to_hash" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `to_hash` + +## Signature + +```perl +sub to_hash() +``` + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 607. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/to-json.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/to-json.mdx new file mode 100644 index 0000000000..731971b4c4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/to-json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/to-json" +title: "to_json" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::to_json" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `to_json` + +## Signature + +```perl +sub to_json() +``` + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 626. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/toggle-functions.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/toggle-functions.mdx new file mode 100644 index 0000000000..dc19e6957a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/toggle-functions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/toggle-functions" +title: "toggle_functions" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::toggle_functions" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `toggle_functions` + +## Signature + +```perl +sub toggle_functions($toggles) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 295. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/update-global-data.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/update-global-data.mdx new file mode 100644 index 0000000000..bcd40448f1 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/update-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/update-global-data" +title: "update_global_data" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::update_global_data" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `update_global_data` + +## Signature + +```perl +sub update_global_data($data) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 145. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/update-settings.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/update-settings.mdx new file mode 100644 index 0000000000..d33d387698 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/update-settings.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/update-settings" +title: "update_settings" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::update_settings" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `update_settings` + +## Signature + +```perl +sub update_settings($settings) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 312. diff --git a/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/wait-for-user.mdx b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/wait-for-user.mdx new file mode 100644 index 0000000000..8cc8aeb69b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swaig/function-result/function-result/wait-for-user.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swaig/function-result/function-result/wait-for-user" +title: "wait_for_user" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWAIG::FunctionResult::wait_for_user" + parent: "SignalWire::SWAIG::FunctionResult" + module: "SignalWire.SWAIG.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm" + visibility: "public" +--- +# `wait_for_user` + +## Signature + +```perl +sub wait_for_user(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWAIG/FunctionResult.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWAIG/FunctionResult.pm) + +Line 119. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/document/document/add-raw-verb.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/add-raw-verb.mdx new file mode 100644 index 0000000000..8eae59449d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/add-raw-verb.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swml/document/document/add-raw-verb" +title: "add_raw_verb" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Document::add_raw_verb" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm" + visibility: "public" +--- +# `add_raw_verb` + +## Signature + +```perl +sub add_raw_verb($section_name, $verb_hash) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWML/Document.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm) + +Line 30. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/document/document/add-section.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/add-section.mdx new file mode 100644 index 0000000000..2db7f1ac7f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/add-section.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/document/document/add-section" +title: "add_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Document::add_section" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm" + visibility: "public" +--- +# `add_section` + +## Signature + +```perl +sub add_section($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Document.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm) + +Line 17. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/document/document/add-verb.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/add-verb.mdx new file mode 100644 index 0000000000..3bb12b95cc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/add-verb.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/swml/document/document/add-verb" +title: "add_verb" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Document::add_verb" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm" + visibility: "public" +--- +# `add_verb` + +## Signature + +```perl +sub add_verb($section_name, $verb_name, $verb_data) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/SWML/Document.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm) + +Line 23. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/document/document/clear-section.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/clear-section.mdx new file mode 100644 index 0000000000..3e7b6e018c --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/clear-section.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/document/document/clear-section" +title: "clear_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Document::clear_section" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm" + visibility: "public" +--- +# `clear_section` + +## Signature + +```perl +sub clear_section($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Document.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm) + +Line 47. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/document/document/get-section.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/get-section.mdx new file mode 100644 index 0000000000..b333609266 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/get-section.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/document/document/get-section" +title: "get_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Document::get_section" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm" + visibility: "public" +--- +# `get_section` + +## Signature + +```perl +sub get_section($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Document.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm) + +Line 37. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/document/document/has-section.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/has-section.mdx new file mode 100644 index 0000000000..b824a14476 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/has-section.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/document/document/has-section" +title: "has_section" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Document::has_section" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm" + visibility: "public" +--- +# `has_section` + +## Signature + +```perl +sub has_section($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Document.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm) + +Line 42. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/document/document/index.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/index.mdx new file mode 100644 index 0000000000..b7fc9ef914 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/perl/signal-wire/swml/document/document" +title: "Document" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm" +--- +# `Document` + +## Signature + +```perl +package SignalWire::SWML::Document +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/SWML/Document.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/document/document/to-hash.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/to-hash.mdx new file mode 100644 index 0000000000..43776aef39 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/to-hash.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swml/document/document/to-hash" +title: "to_hash" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Document::to_hash" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm" + visibility: "public" +--- +# `to_hash` + +## Signature + +```perl +sub to_hash() +``` + +## Source + +[`lib/SignalWire/SWML/Document.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm) + +Line 53. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/document/document/to-json.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/to-json.mdx new file mode 100644 index 0000000000..74df2b8cf3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/to-json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swml/document/document/to-json" +title: "to_json" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Document::to_json" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm" + visibility: "public" +--- +# `to_json` + +## Signature + +```perl +sub to_json() +``` + +## Source + +[`lib/SignalWire/SWML/Document.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm) + +Line 61. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/document/document/to-pretty-json.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/to-pretty-json.mdx new file mode 100644 index 0000000000..ec238c1382 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/document/document/to-pretty-json.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swml/document/document/to-pretty-json" +title: "to_pretty_json" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Document::to_pretty_json" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm" + visibility: "public" +--- +# `to_pretty_json` + +## Signature + +```perl +sub to_pretty_json() +``` + +## Source + +[`lib/SignalWire/SWML/Document.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Document.pm) + +Line 66. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/build.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/build.mdx new file mode 100644 index 0000000000..9a3328759f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/build.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swml/schema/schema/build" +title: "BUILD" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Schema::BUILD" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm" + visibility: "public" +--- +# `BUILD` + +## Signature + +```perl +sub BUILD() +``` + +## Source + +[`lib/SignalWire/SWML/Schema.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm) + +Line 21. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/get-verb-names.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/get-verb-names.mdx new file mode 100644 index 0000000000..f462161c3b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/get-verb-names.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swml/schema/schema/get-verb-names" +title: "get_verb_names" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Schema::get_verb_names" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm" + visibility: "public" +--- +# `get_verb_names` + +## Signature + +```perl +sub get_verb_names() +``` + +## Source + +[`lib/SignalWire/SWML/Schema.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm) + +Line 73. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/get-verb.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/get-verb.mdx new file mode 100644 index 0000000000..d291757906 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/get-verb.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/schema/schema/get-verb" +title: "get_verb" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Schema::get_verb" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm" + visibility: "public" +--- +# `get_verb` + +## Signature + +```perl +sub get_verb($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Schema.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm) + +Line 83. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/has-verb.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/has-verb.mdx new file mode 100644 index 0000000000..8d65e0cad0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/has-verb.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/schema/schema/has-verb" +title: "has_verb" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Schema::has_verb" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm" + visibility: "public" +--- +# `has_verb` + +## Signature + +```perl +sub has_verb($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Schema.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm) + +Line 78. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/index.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/index.mdx new file mode 100644 index 0000000000..a263770edd --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/perl/signal-wire/swml/schema/schema" +title: "Schema" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm" +--- +# `Schema` + +## Signature + +```perl +package SignalWire::SWML::Schema +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/SWML/Schema.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/instance.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/instance.mdx new file mode 100644 index 0000000000..9fc031c671 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/instance.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/schema/schema/instance" +title: "instance" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Schema::instance" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm" + visibility: "public" +--- +# `instance` + +## Signature + +```perl +sub instance($class) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Schema.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm) + +Line 67. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/verb-count.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/verb-count.mdx new file mode 100644 index 0000000000..ee2efc7a50 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/schema/schema/verb-count.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swml/schema/schema/verb-count" +title: "verb_count" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Schema::verb_count" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm" + visibility: "public" +--- +# `verb_count` + +## Signature + +```perl +sub verb_count() +``` + +## Source + +[`lib/SignalWire/SWML/Schema.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Schema.pm) + +Line 88. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/can.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/can.mdx new file mode 100644 index 0000000000..cca98fd718 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/can.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/can" +title: "can" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::can" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `can` + +## Signature + +```perl +sub can($method) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 146. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/define-tool.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/define-tool.mdx new file mode 100644 index 0000000000..5df91faf38 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/define-tool.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/define-tool" +title: "define_tool" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::define_tool" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `define_tool` + +## Signature + +```perl +sub define_tool(%opts) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 402. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/define-tools.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/define-tools.mdx new file mode 100644 index 0000000000..c858793883 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/define-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/define-tools" +title: "define_tools" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::define_tools" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `define_tools` + +## Signature + +```perl +sub define_tools(@tool_defs) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 468. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/extract-sip-username.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/extract-sip-username.mdx new file mode 100644 index 0000000000..c4d7f1d5ed --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/extract-sip-username.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/extract-sip-username" +title: "extract_sip_username" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::extract_sip_username" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `extract_sip_username` + +## Signature + +```perl +sub extract_sip_username($class_or_self, $request_body) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 235. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-all-functions.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-all-functions.mdx new file mode 100644 index 0000000000..d9f8aea7a7 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-all-functions.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/get-all-functions" +title: "get_all_functions" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::get_all_functions" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `get_all_functions` + +## Signature + +```perl +sub get_all_functions() +``` + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 452. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-basic-auth-credentials-with-source.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-basic-auth-credentials-with-source.mdx new file mode 100644 index 0000000000..b2c8fe48cc --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-basic-auth-credentials-with-source.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/get-basic-auth-credentials-with-source" +title: "get_basic_auth_credentials_with_source" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::get_basic_auth_credentials_with_source" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `get_basic_auth_credentials_with_source` + +## Signature + +```perl +sub get_basic_auth_credentials_with_source() +``` + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 219. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..90b280247b --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-basic-auth-credentials.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/get-basic-auth-credentials" +title: "get_basic_auth_credentials" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::get_basic_auth_credentials" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `get_basic_auth_credentials` + +## Signature + +```perl +sub get_basic_auth_credentials($include_source) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 199. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-function.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-function.mdx new file mode 100644 index 0000000000..4492898f6e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/get-function.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/get-function" +title: "get_function" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::get_function" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `get_function` + +## Signature + +```perl +sub get_function($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 445. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/handle-additional-route.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/handle-additional-route.mdx new file mode 100644 index 0000000000..036b1cbf6d --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/handle-additional-route.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/handle-additional-route" +title: "handle_additional_route" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::handle_additional_route" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `handle_additional_route` + +## Signature + +```perl +sub handle_additional_route($sub_path, $request_data, $env) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 509. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/has-function.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/has-function.mdx new file mode 100644 index 0000000000..adf259c746 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/has-function.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/has-function" +title: "has_function" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::has_function" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `has_function` + +## Signature + +```perl +sub has_function($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 438. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/index.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/index.mdx new file mode 100644 index 0000000000..6804b4171e --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service" +title: "Service" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "module" + language: "perl" + qualified_name: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" +--- +# `Service` + +## Signature + +```perl +package SignalWire::SWML::Service +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 1. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/list-tool-names.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/list-tool-names.mdx new file mode 100644 index 0000000000..0e6068ec6a --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/list-tool-names.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/list-tool-names" +title: "list_tool_names" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::list_tool_names" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `list_tool_names` + +## Signature + +```perl +sub list_tool_names() +``` + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 492. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/on-function-call.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/on-function-call.mdx new file mode 100644 index 0000000000..7bf127c8c3 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/on-function-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/on-function-call" +title: "on_function_call" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::on_function_call" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `on_function_call` + +## Signature + +```perl +sub on_function_call($name, $args, $raw_data) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 484. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/on-request.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/on-request.mdx new file mode 100644 index 0000000000..f917db7f16 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/on-request.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/on-request" +title: "on_request" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::on_request" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `on_request` + +## Signature + +```perl +sub on_request($request_data, $callback_path) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 377. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/on-swml-request.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/on-swml-request.mdx new file mode 100644 index 0000000000..564b7437e9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/on-swml-request.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/on-swml-request" +title: "on_swml_request" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::on_swml_request" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `on_swml_request` + +## Signature + +```perl +sub on_swml_request($request_data, $callback_path, $request) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 390. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/register-routing-callback.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/register-routing-callback.mdx new file mode 100644 index 0000000000..223c5074f4 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/register-routing-callback.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/register-routing-callback" +title: "register_routing_callback" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::register_routing_callback" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `register_routing_callback` + +## Signature + +```perl +sub register_routing_callback($path, $cb) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 515. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/register-swaig-function.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/register-swaig-function.mdx new file mode 100644 index 0000000000..ff27853fb6 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/register-swaig-function.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/register-swaig-function" +title: "register_swaig_function" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::register_swaig_function" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `register_swaig_function` + +## Signature + +```perl +sub register_swaig_function($func_def) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 427. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/remove-function.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/remove-function.mdx new file mode 100644 index 0000000000..c5f6177201 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/remove-function.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/remove-function" +title: "remove_function" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::remove_function" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `remove_function` + +## Signature + +```perl +sub remove_function($name) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 459. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/render-main-swml.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/render-main-swml.mdx new file mode 100644 index 0000000000..7de2560508 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/render-main-swml.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/render-main-swml" +title: "render_main_swml" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::render_main_swml" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `render_main_swml` + +## Signature + +```perl +sub render_main_swml($env) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 356. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/render-swml.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/render-swml.mdx new file mode 100644 index 0000000000..8a72238df0 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/render-swml.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/render-swml" +title: "render_swml" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::render_swml" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `render_swml` + +## Signature + +```perl +sub render_swml($env) +``` + +## Parameters + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 362. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..6f7a47fa3f --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/swaig-pre-dispatch.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/swaig-pre-dispatch" +title: "swaig_pre_dispatch" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::swaig_pre_dispatch" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `swaig_pre_dispatch` + +## Signature + +```perl +sub swaig_pre_dispatch($request_data, $func_name, $env) +``` + +## Parameters + + + + + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 501. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/to-psgi-app.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/to-psgi-app.mdx new file mode 100644 index 0000000000..fbba0f53f9 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/to-psgi-app.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/to-psgi-app" +title: "to_psgi_app" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::to_psgi_app" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `to_psgi_app` + +## Signature + +```perl +sub to_psgi_app() +``` + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 299. diff --git a/fern/products/sdk-reference/perl/signal-wire/swml/service/service/validate-basic-auth.mdx b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/validate-basic-auth.mdx new file mode 100644 index 0000000000..bce1d63732 --- /dev/null +++ b/fern/products/sdk-reference/perl/signal-wire/swml/service/service/validate-basic-auth.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/perl/signal-wire/swml/service/service/validate-basic-auth" +title: "validate_basic_auth" +sdk_label: "Perl SDK" +icon: "perl" +lustri: + auto_generated: true + kind: "method" + language: "perl" + qualified_name: "SignalWire::SWML::Service::validate_basic_auth" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm" + visibility: "public" +--- +# `validate_basic_auth` + +## Signature + +```perl +sub validate_basic_auth($username, $password) +``` + +## Parameters + + + + + +## Source + +[`lib/SignalWire/SWML/Service.pm`](https://github.com/signalwire/signalwire-perl/blob/main/lib/SignalWire/SWML/Service.pm) + +Line 186. diff --git a/fern/products/sdk-reference/php/_meta.json b/fern/products/sdk-reference/php/_meta.json new file mode 100644 index 0000000000..5f7cd786e7 --- /dev/null +++ b/fern/products/sdk-reference/php/_meta.json @@ -0,0 +1,10 @@ +{ + "language": "php", + "sdk_name": "php-sdk", + "version": null, + "source_repo": "https://github.com/signalwire/signalwire-php", + "format": "mdx", + "platform": "fern", + "base_slug": "/reference/php", + "item_count": 1401 +} \ No newline at end of file diff --git a/fern/products/sdk-reference/php/index.mdx b/fern/products/sdk-reference/php/index.mdx new file mode 100644 index 0000000000..c87555c7fc --- /dev/null +++ b/fern/products/sdk-reference/php/index.mdx @@ -0,0 +1,29 @@ +--- +title: "PHP SDK" +slug: "/reference/php" +lustri: + auto_generated: true + language: "php" + kind: "sdk" +--- +# PHP SDK Reference + +## Modules + +- [`Builtin`](/reference/php/signal-wire/skills/builtin/builtin) +- [`Contexts`](/reference/php/signal-wire/contexts/contexts) +- [`DataMap`](/reference/php/signal-wire/data-map/data-map) +- [`Logging`](/reference/php/signal-wire/logging/logging) +- [`Namespaces`](/reference/php/signal-wire/rest/namespaces/namespaces) +- [`POM`](/reference/php/signal-wire/pom/pom) +- [`Relay`](/reference/php/signal-wire/relay/relay) +- [`REST`](/reference/php/signal-wire/rest/rest) +- [`Security`](/reference/php/signal-wire/security/security) +- [`Server`](/reference/php/signal-wire/server/server) +- [`Serverless`](/reference/php/signal-wire/serverless/serverless) +- [`SignalWire`](/reference/php/signal-wire/signal-wire) +- [`Skills`](/reference/php/signal-wire/skills/skills) +- [`SWAIG`](/reference/php/signal-wire/swaig/swaig) +- [`SWML`](/reference/php/signal-wire/swml/swml) +- [`Utils`](/reference/php/signal-wire/utils/utils) + diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/add-context.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/add-context.mdx new file mode 100644 index 0000000000..36d611f49f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/add-context.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context-builder/add-context" +title: "addContext" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\ContextBuilder::addContext" + parent: "SignalWire\\Contexts\\ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addContext` + +Add a new context and return it for further configuration. + +## Signature + +```php +public function addContext(string $name): SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 1128. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/attach-tool-name-supplier.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/attach-tool-name-supplier.mdx new file mode 100644 index 0000000000..987bdadf3f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/attach-tool-name-supplier.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context-builder/attach-tool-name-supplier" +title: "attachToolNameSupplier" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\ContextBuilder::attachToolNameSupplier" + parent: "SignalWire\\Contexts\\ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `attachToolNameSupplier` + +Attach a callable that returns registered SWAIG tool names so + +validate() can check them against RESERVED\_NATIVE\_TOOL\_NAMES. +Called internally by AgentBase::defineContexts(). + +## Signature + +```php +public function attachToolNameSupplier( + callable $supplier +): SignalWire\Contexts\ContextBuilder +``` + +## Parameters + + + () => array<string> + + +## Returns + +`SignalWire\Contexts\ContextBuilder` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 1107. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/construct.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/construct.mdx new file mode 100644 index 0000000000..65ad5c3bca --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/construct.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context-builder/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\ContextBuilder::__construct" + parent: "SignalWire\\Contexts\\ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `__construct` + +Construct a builder. The optional $agent reference mirrors Python's + +ContextBuilder(agent) so callers (typically AgentBase) can hand the +builder a reference to the owning agent for tool-name collision +checks during validate(). + +If $agent has a method named getRegisteredToolNames() returning an +array of strings, validate() will use it automatically — no +separate attachToolNameSupplier() call required. + +## Signature + +```php +public function __construct(?object $agent = NULL) +``` + +## Parameters + + + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 1090. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/create-simple-context.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/create-simple-context.mdx new file mode 100644 index 0000000000..8492753ba0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/create-simple-context.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context-builder/create-simple-context" +title: "createSimpleContext" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\ContextBuilder::createSimpleContext" + parent: "SignalWire\\Contexts\\ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `createSimpleContext` + +Create a builder pre-populated with a single named context. + +**Modifiers:** `static` + +## Signature + +```php +public static function createSimpleContext(string $name): SignalWire\Contexts\ContextBuilder +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\ContextBuilder` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 1343. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/get-context.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/get-context.mdx new file mode 100644 index 0000000000..5957bcdb7e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/get-context.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context-builder/get-context" +title: "getContext" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\ContextBuilder::getContext" + parent: "SignalWire\\Contexts\\ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getContext` + +Get an existing context by name, or null if not found. + +## Signature + +```php +public function getContext(string $name): ?SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`?SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 1149. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/has-contexts.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/has-contexts.mdx new file mode 100644 index 0000000000..c7cdbfaed9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/has-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context-builder/has-contexts" +title: "hasContexts" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\ContextBuilder::hasContexts" + parent: "SignalWire\\Contexts\\ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `hasContexts` + +## Signature + +```php +public function hasContexts(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 1154. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/index.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/index.mdx new file mode 100644 index 0000000000..edf15defe5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/index.mdx @@ -0,0 +1,93 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context-builder" +title: "ContextBuilder" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Contexts\\ContextBuilder" + parent: "SignalWire\\Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" +--- +# `ContextBuilder` + +Builder for multi-step, multi-context AI agent workflows. + +A ContextBuilder owns one or more Contexts; each Context owns an +ordered list of Steps. Only one context and one step is active at a +time. Per chat turn, the runtime injects the current step's +instructions as a system message, then asks the LLM for a response. + +## Native tools auto-injected by the runtime + +When a step (or its enclosing context) declares valid\_steps or +valid\_contexts, the runtime auto-injects two native tools so the +model can navigate the flow: + +- next\_step(step: enum) — present when valid\_steps is set +- change\_context(context: enum) — present when valid\_contexts is set + +A third native tool — gather\_submit — is injected during gather\_info +questioning. These three names are reserved: validate() rejects any +agent that defines a SWAIG tool with one of them. See the +RESERVED\_NATIVE\_TOOL\_NAMES constant. + +## Function whitelisting (Step::setFunctions) + +Each step may declare a functions whitelist. The whitelist is +applied in-memory at the start of each LLM turn. CRITICALLY: if a +step does NOT declare a functions field, it INHERITS the previous +step's active set. See Step::setFunctions for details and examples. + +## Signature + +```php +class ContextBuilder +``` + +## Methods + + + + Construct a builder. The optional $agent reference mirrors Python's + + + + Add a new context and return it for further configuration. + + + + Attach a callable that returns registered SWAIG tool names so + + + + Create a builder pre-populated with a single named context. + + + + Get an existing context by name, or null if not found. + + + + + + Remove all contexts, returning the builder to its initial state. + + + + Serialize all contexts in order. Validates before converting. + + + + Validate the contexts configuration. + + + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 1058. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/reset.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/reset.mdx new file mode 100644 index 0000000000..84556eb9ec --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/reset.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context-builder/reset" +title: "reset" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\ContextBuilder::reset" + parent: "SignalWire\\Contexts\\ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `reset` + +Remove all contexts, returning the builder to its initial state. + +Use this in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```php +public function reset(): SignalWire\Contexts\ContextBuilder +``` + +## Returns + +`SignalWire\Contexts\ContextBuilder` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 1118. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/to-array.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/to-array.mdx new file mode 100644 index 0000000000..d4121b6f2a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/to-array.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context-builder/to-array" +title: "toArray" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\ContextBuilder::toArray" + parent: "SignalWire\\Contexts\\ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `toArray` + +Serialize all contexts in order. Validates before converting. + +## Signature + +```php +public function toArray(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 1323. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/validate.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/validate.mdx new file mode 100644 index 0000000000..4d9c495853 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context-builder/validate.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context-builder/validate" +title: "validate" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\ContextBuilder::validate" + parent: "SignalWire\\Contexts\\ContextBuilder" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `validate` + +Validate the contexts configuration. + +## Signature + +```php +public function validate(): array +``` + +## Returns + +`array` — Array of error strings (empty if valid) + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 1164. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-bullets.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-bullets.mdx new file mode 100644 index 0000000000..87590c6603 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-bullets.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/add-bullets" +title: "addBullets" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::addBullets" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addBullets` + +## Signature + +```php +public function addBullets(string $title, array $bullets): SignalWire\Contexts\Context +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 715. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-enter-filler.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-enter-filler.mdx new file mode 100644 index 0000000000..9f4fe9da29 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-enter-filler.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/add-enter-filler" +title: "addEnterFiller" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::addEnterFiller" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addEnterFiller` + +Add enter fillers for a specific language. + +Mirrors Python's Context.add\_enter\_filler(language\_code: str, fillers: +List\[str]) — pass a list of phrases to associate with this language code. + +## Signature + +```php +public function addEnterFiller( + string $language_code, + array $fillers +): SignalWire\Contexts\Context +``` + +## Parameters + + + Language code (e.g. "en-US", "es") or "default" for catch-all. + + + + List of filler phrases. + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 880. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-exit-filler.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-exit-filler.mdx new file mode 100644 index 0000000000..d77cc81d87 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-exit-filler.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/add-exit-filler" +title: "addExitFiller" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::addExitFiller" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addExitFiller` + +Add exit fillers for a specific language. + +Mirrors Python's Context.add\_exit\_filler(language\_code: str, fillers: +List\[str]) — pass a list of phrases to associate with this language code. + +## Signature + +```php +public function addExitFiller( + string $language_code, + array $fillers +): SignalWire\Contexts\Context +``` + +## Parameters + + + Language code (e.g. "en-US", "es") or "default" for catch-all. + + + + List of filler phrases. + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 902. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-section.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-section.mdx new file mode 100644 index 0000000000..f61a34ebf6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/add-section" +title: "addSection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::addSection" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addSection` + +## Signature + +```php +public function addSection(string $title, string $body): SignalWire\Contexts\Context +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 704. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-step.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-step.mdx new file mode 100644 index 0000000000..3626fbd5f7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-step.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/add-step" +title: "addStep" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::addStep" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addStep` + +Add a new step to this context. + +When called with only $name the returned Step can be configured with +the usual method-chaining API. When the optional keyword arguments are +supplied the step is fully configured in one call: + +## Signature + +```php +public function addStep( + string $name, + ?string $task = NULL, + ?array $bullets = NULL, + ?string $criteria = NULL, + $functions = NULL, + ?array $valid_steps = NULL +): SignalWire\Contexts\Step +``` + +## Parameters + + + Step name (must be unique within the context). + + + + Text for the "Task" section (≡ addSection("Task", $task)). + + + + List of bullet strings for the "Process" section (≡ addBullets("Process", $bullets)). Requires $task to also be set. + + + + Step-completion criteria (≡ setStepCriteria()). + + + + Tool names the step may call, or 'none' (≡ setFunctions()). + + + + Names of steps the agent may transition to (≡ setValidSteps()). + + +## Returns + +`SignalWire\Contexts\Step` — The configured Step object for optional further chaining. + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 619. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-system-bullets.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-system-bullets.mdx new file mode 100644 index 0000000000..4344f6c36b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-system-bullets.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/add-system-bullets" +title: "addSystemBullets" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::addSystemBullets" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addSystemBullets` + +## Signature + +```php +public function addSystemBullets( + string $title, + array $bullets +): SignalWire\Contexts\Context +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 750. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-system-section.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-system-section.mdx new file mode 100644 index 0000000000..4e763315f0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/add-system-section.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/add-system-section" +title: "addSystemSection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::addSystemSection" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addSystemSection` + +## Signature + +```php +public function addSystemSection( + string $title, + string $body +): SignalWire\Contexts\Context +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 739. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/construct.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/construct.mdx new file mode 100644 index 0000000000..8999fb7ef2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::__construct" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(string $name) +``` + +## Parameters + + + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 587. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-initial-step.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-initial-step.mdx new file mode 100644 index 0000000000..c69bf09a51 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-initial-step.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/get-initial-step" +title: "getInitialStep" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::getInitialStep" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getInitialStep` + +## Signature + +```php +public function getInitialStep(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 777. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-name.mdx new file mode 100644 index 0000000000..adf28bc0ad --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::getName" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 592. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-step-order.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-step-order.mdx new file mode 100644 index 0000000000..367f6f4653 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-step-order.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/get-step-order" +title: "getStepOrder" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::getStepOrder" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getStepOrder` + +## Signature + +```php +public function getStepOrder(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 927. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-step.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-step.mdx new file mode 100644 index 0000000000..2e00c6c8ff --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/get-step" +title: "getStep" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::getStep" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getStep` + +## Signature + +```php +public function getStep(string $name): ?SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`?SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 659. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-steps.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-steps.mdx new file mode 100644 index 0000000000..5d47491f98 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-steps.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/get-steps" +title: "getSteps" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::getSteps" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getSteps` + +## Signature + +```php +public function getSteps(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 919. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-valid-contexts.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-valid-contexts.mdx new file mode 100644 index 0000000000..3757a85e41 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/get-valid-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/get-valid-contexts" +title: "getValidContexts" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::getValidContexts" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getValidContexts` + +## Signature + +```php +public function getValidContexts(): ?array +``` + +## Returns + +`?array` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 932. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/index.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/index.mdx new file mode 100644 index 0000000000..188bab8444 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/index.mdx @@ -0,0 +1,103 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context" +title: "Context" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context" + parent: "SignalWire\\Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" +--- +# `Context` + +## Signature + +```php +class Context +``` + +## Methods + + + + + + + + Add enter fillers for a specific language. + + + + Add exit fillers for a specific language. + + + + + + Add a new step to this context. + + + + + + + + + + + + + + + + + + + + + + + + + + Set fillers played by the AI when entering this context. + + + + Set fillers played by the AI when leaving this context. + + + + + + Set which step the context starts on when entered. + + + + Mark this context as isolated — entering it wipes conversation + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 546. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/move-step.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/move-step.mdx new file mode 100644 index 0000000000..c2052c1d58 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/move-step.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/move-step" +title: "moveStep" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::moveStep" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `moveStep` + +## Signature + +```php +public function moveStep(string $name, int $position): SignalWire\Contexts\Context +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 676. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/remove-step.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/remove-step.mdx new file mode 100644 index 0000000000..f34730444d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/remove-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/remove-step" +title: "removeStep" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::removeStep" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `removeStep` + +## Signature + +```php +public function removeStep(string $name): SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 664. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-consolidate.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-consolidate.mdx new file mode 100644 index 0000000000..5afa1316fc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-consolidate.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-consolidate" +title: "setConsolidate" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setConsolidate" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setConsolidate` + +## Signature + +```php +public function setConsolidate(bool $consolidate): SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 800. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-enter-fillers.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-enter-fillers.mdx new file mode 100644 index 0000000000..730c1a599d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-enter-fillers.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-enter-fillers" +title: "setEnterFillers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setEnterFillers" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setEnterFillers` + +Set fillers played by the AI when entering this context. + +## Signature + +```php +public function setEnterFillers(array $enter_fillers): SignalWire\Contexts\Context +``` + +## Parameters + + + Map of language code ("en-US" / "default") to a list of phrases. + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 852. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-exit-fillers.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-exit-fillers.mdx new file mode 100644 index 0000000000..2c30d2b74d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-exit-fillers.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-exit-fillers" +title: "setExitFillers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setExitFillers" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setExitFillers` + +Set fillers played by the AI when leaving this context. + +## Signature + +```php +public function setExitFillers(array $exit_fillers): SignalWire\Contexts\Context +``` + +## Parameters + + + Map of language code ("en-US" / "default") to a list of phrases. + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 864. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-full-reset.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-full-reset.mdx new file mode 100644 index 0000000000..001d1a1ae0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-full-reset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-full-reset" +title: "setFullReset" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setFullReset" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setFullReset` + +## Signature + +```php +public function setFullReset(bool $fullReset): SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 806. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-initial-step.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-initial-step.mdx new file mode 100644 index 0000000000..ff84bcd030 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-initial-step.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-initial-step" +title: "setInitialStep" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setInitialStep" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setInitialStep` + +Set which step the context starts on when entered. + +By default, a context starts on its first step (index 0). Use +this to skip a preamble step on re-entry via change\_context. + +## Signature + +```php +public function setInitialStep(string $stepName): SignalWire\Contexts\Context +``` + +## Parameters + + + name of the step to start on. + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 771. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-isolated.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-isolated.mdx new file mode 100644 index 0000000000..fcbbb19346 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-isolated.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-isolated" +title: "setIsolated" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setIsolated" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setIsolated` + +Mark this context as isolated — entering it wipes conversation + +history. + +When $isolated = true and the context is entered via +change\_context, the runtime wipes the conversation array. The +model starts fresh with only the new context's system\_prompt + +step instructions, with no memory of prior turns. + +EXCEPTION — reset overrides the wipe: +If the context also has a reset configuration (via +setConsolidate or setFullReset), the wipe is skipped in +favor of the reset behavior. Use reset with consolidate=true +to summarize prior history into a single message instead of +dropping it entirely. + +Use cases: switching to a sensitive billing flow that should +not see prior small-talk; handing off to a different agent +persona; resetting after a long off-topic detour. + +## Signature + +```php +public function setIsolated(bool $isolated): SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 838. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-post-prompt.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-post-prompt.mdx new file mode 100644 index 0000000000..0af819f384 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-post-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-post-prompt" +title: "setPostPrompt" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setPostPrompt" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setPostPrompt` + +## Signature + +```php +public function setPostPrompt(string $postPrompt): SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 794. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-prompt.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-prompt.mdx new file mode 100644 index 0000000000..502783d879 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-prompt" +title: "setPrompt" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setPrompt" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setPrompt` + +## Signature + +```php +public function setPrompt(string $prompt): SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 693. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-system-prompt.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-system-prompt.mdx new file mode 100644 index 0000000000..883dd46476 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-system-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-system-prompt" +title: "setSystemPrompt" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setSystemPrompt" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setSystemPrompt` + +## Signature + +```php +public function setSystemPrompt(string $systemPrompt): SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 728. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-user-prompt.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-user-prompt.mdx new file mode 100644 index 0000000000..19deb4a9d2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-user-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-user-prompt" +title: "setUserPrompt" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setUserPrompt" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setUserPrompt` + +## Signature + +```php +public function setUserPrompt(string $userPrompt): SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 812. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-valid-contexts.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-valid-contexts.mdx new file mode 100644 index 0000000000..a030016321 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-valid-contexts.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-valid-contexts" +title: "setValidContexts" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setValidContexts" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setValidContexts` + +## Signature + +```php +public function setValidContexts(array $contexts): SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 782. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-valid-steps.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-valid-steps.mdx new file mode 100644 index 0000000000..54866d3ebe --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/set-valid-steps.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/set-valid-steps" +title: "setValidSteps" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::setValidSteps" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setValidSteps` + +## Signature + +```php +public function setValidSteps(array $steps): SignalWire\Contexts\Context +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Context` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 788. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/to-array.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/to-array.mdx new file mode 100644 index 0000000000..052354611d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/context/to-array.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/context/to-array" +title: "toArray" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Context::toArray" + parent: "SignalWire\\Contexts\\Context" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `toArray` + +## Signature + +```php +public function toArray(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 965. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/add-question.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/add-question.mdx new file mode 100644 index 0000000000..acd573c4f5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/add-question.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/gather-info/add-question" +title: "addQuestion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\GatherInfo::addQuestion" + parent: "SignalWire\\Contexts\\GatherInfo" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addQuestion` + +Add a question to gather. + +## Signature + +```php +public function addQuestion( + string $key, + string $question, + array $kwargs = array ( +) +): SignalWire\Contexts\GatherInfo +``` + +## Parameters + + + Key name for storing the answer in global\_data. + + + + The question text to ask. + + + + Optional named arguments forwarded to GatherQuestion. + + +## Returns + +`SignalWire\Contexts\GatherInfo` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 117. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/construct.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/construct.mdx new file mode 100644 index 0000000000..77182ba105 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/gather-info/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\GatherInfo::__construct" + parent: "SignalWire\\Contexts\\GatherInfo" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + ?string $outputKey = NULL, + ?string $completionAction = NULL, + ?string $prompt = NULL +) +``` + +## Parameters + + + + + + + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 99. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/get-completion-action.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/get-completion-action.mdx new file mode 100644 index 0000000000..84ecf80296 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/get-completion-action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/gather-info/get-completion-action" +title: "getCompletionAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\GatherInfo::getCompletionAction" + parent: "SignalWire\\Contexts\\GatherInfo" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getCompletionAction` + +## Signature + +```php +public function getCompletionAction(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 138. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/get-questions.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/get-questions.mdx new file mode 100644 index 0000000000..e00e94f65c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/get-questions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/gather-info/get-questions" +title: "getQuestions" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\GatherInfo::getQuestions" + parent: "SignalWire\\Contexts\\GatherInfo" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getQuestions` + +## Signature + +```php +public function getQuestions(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 133. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/index.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/index.mdx new file mode 100644 index 0000000000..594b0a9a85 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/gather-info" +title: "GatherInfo" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Contexts\\GatherInfo" + parent: "SignalWire\\Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" +--- +# `GatherInfo` + +## Signature + +```php +class GatherInfo +``` + +## Methods + + + + + + Add a question to gather. + + + + + + + + + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/to-array.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/to-array.mdx new file mode 100644 index 0000000000..306b82580a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-info/to-array.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/gather-info/to-array" +title: "toArray" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\GatherInfo::toArray" + parent: "SignalWire\\Contexts\\GatherInfo" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `toArray` + +## Signature + +```php +public function toArray(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 143. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/construct.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/construct.mdx new file mode 100644 index 0000000000..748599d3b7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/construct.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/gather-question/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\GatherQuestion::__construct" + parent: "SignalWire\\Contexts\\GatherQuestion" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $key, + string $question, + string $type = 'string', + bool $confirm = false, + ?string $prompt = NULL, + ?array $functions = NULL +) +``` + +## Parameters + + + Key name for storing the answer in global\_data. + + + + The question text to ask. + + + + JSON schema type for the answer (default 'string'). + + + + If true, the model must confirm the answer. + + + + Extra instruction text appended after the question. + + + + Functions to unlock for this question. + + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 44. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/get-key.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/get-key.mdx new file mode 100644 index 0000000000..15b03a8dbd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/get-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/gather-question/get-key" +title: "getKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\GatherQuestion::getKey" + parent: "SignalWire\\Contexts\\GatherQuestion" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getKey` + +## Signature + +```php +public function getKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 60. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/index.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/index.mdx new file mode 100644 index 0000000000..d0b07cbc6a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/gather-question" +title: "GatherQuestion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Contexts\\GatherQuestion" + parent: "SignalWire\\Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" +--- +# `GatherQuestion` + +## Signature + +```php +class GatherQuestion +``` + +## Methods + + + + + + + + + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/to-array.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/to-array.mdx new file mode 100644 index 0000000000..d32b68f1be --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/gather-question/to-array.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/gather-question/to-array" +title: "toArray" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\GatherQuestion::toArray" + parent: "SignalWire\\Contexts\\GatherQuestion" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `toArray` + +## Signature + +```php +public function toArray(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 65. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/index.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/index.mdx new file mode 100644 index 0000000000..fbfe569d3c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts" +title: "Contexts" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\Contexts" + module: "SignalWire.Contexts" +--- +# `Contexts` + +## Signature + +```php +namespace SignalWire\Contexts +``` + +## Classes + + + + + + Builder for multi-step, multi-context AI agent workflows. + + + + + + + + diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/add-bullets.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/add-bullets.mdx new file mode 100644 index 0000000000..8a0149301d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/add-bullets.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/add-bullets" +title: "addBullets" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::addBullets" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addBullets` + +Add a POM section with bullet points. + +## Signature + +```php +public function addBullets(string $title, array $bullets): SignalWire\Contexts\Step +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 238. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/add-gather-question.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/add-gather-question.mdx new file mode 100644 index 0000000000..7845130c5c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/add-gather-question.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/add-gather-question" +title: "addGatherQuestion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::addGatherQuestion" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addGatherQuestion` + +Add a question to this step's gather\_info. Initializes + +gather\_info if not yet set. + +IMPORTANT — gather mode locks function access: +While the model is asking gather questions, the runtime +forcibly deactivates ALL of the step's other functions. The +only callable tools during a gather question are: + +``` +- gather_submit (the native answer-submission tool) +- Whatever names you pass in this question's 'functions' + option +``` + +next\_step and change\_context are also filtered out — the +model cannot navigate away until the gather completes. This +is by design: it forces a tight ask → submit → next-question +loop. + +If a question needs to call out to a tool (e.g. validate an +email, geocode a ZIP), list that tool name in this question's +'functions' option. Functions listed here are active ONLY for +this question. + +## Signature + +```php +public function addGatherQuestion( + string $key, + string $question, + string $type = 'string', + bool $confirm = false, + ?string $prompt = NULL, + ?array $functions = NULL +): SignalWire\Contexts\Step +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 392. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/add-section.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/add-section.mdx new file mode 100644 index 0000000000..b04624e0ab --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/add-section" +title: "addSection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::addSection" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `addSection` + +Add a POM section with a body paragraph. + +## Signature + +```php +public function addSection(string $title, string $body): SignalWire\Contexts\Step +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 224. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/clear-sections.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/clear-sections.mdx new file mode 100644 index 0000000000..eb489f2ac1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/clear-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/clear-sections" +title: "clearSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::clearSections" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `clearSections` + +Clear all content (both text and sections). + +## Signature + +```php +public function clearSections(): SignalWire\Contexts\Step +``` + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 252. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/construct.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/construct.mdx new file mode 100644 index 0000000000..eb9b68b639 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::__construct" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(string $name) +``` + +## Parameters + + + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 197. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-gather-info.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-gather-info.mdx new file mode 100644 index 0000000000..46883a4cc1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-gather-info.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/get-gather-info" +title: "getGatherInfo" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::getGatherInfo" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getGatherInfo` + +## Signature + +```php +public function getGatherInfo(): ?SignalWire\Contexts\GatherInfo +``` + +## Returns + +`?SignalWire\Contexts\GatherInfo` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 450. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-name.mdx new file mode 100644 index 0000000000..454aec3820 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::getName" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 202. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-valid-contexts.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-valid-contexts.mdx new file mode 100644 index 0000000000..e5f092def1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-valid-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/get-valid-contexts" +title: "getValidContexts" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::getValidContexts" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getValidContexts` + +## Signature + +```php +public function getValidContexts(): ?array +``` + +## Returns + +`?array` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 445. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-valid-steps.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-valid-steps.mdx new file mode 100644 index 0000000000..f066d9de51 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/get-valid-steps.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/get-valid-steps" +title: "getValidSteps" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::getValidSteps" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `getValidSteps` + +## Signature + +```php +public function getValidSteps(): ?array +``` + +## Returns + +`?array` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 440. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/index.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/index.mdx new file mode 100644 index 0000000000..7ccfa1ae8d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/index.mdx @@ -0,0 +1,93 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step" +title: "Step" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step" + parent: "SignalWire\\Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" +--- +# `Step` + +## Signature + +```php +class Step +``` + +## Methods + + + + + + Add a POM section with bullet points. + + + + Add a question to this step's gather\_info. Initializes + + + + Add a POM section with a body paragraph. + + + + Clear all content (both text and sections). + + + + + + + + + + + + Mark this step as terminal for the step flow. + + + + Set which non-internal functions are callable while this step is + + + + Initialize the gather\_info configuration for this step. Questions are + + + + + + + + + + + + + + + + + + Set the step's prompt text directly. Mutually exclusive with POM sections. + + + + + + + + + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 169. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-end.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-end.mdx new file mode 100644 index 0000000000..6fce4b45f5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-end.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-end" +title: "setEnd" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setEnd" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setEnd` + +Mark this step as terminal for the step flow. + +IMPORTANT: $end = true does NOT end the conversation or hang up +the call. It exits step mode entirely after this step executes +— clearing the steps list, current step index, valid\_steps, and +valid\_contexts. The agent keeps running, but operates only +under the base system prompt and the context-level prompt; no +more step instructions are injected and no more next\_step tool +is offered. + +To actually end the call, call a hangup tool or define a +hangup hook. + +## Signature + +```php +public function setEnd(bool $end): SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 329. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-functions.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-functions.mdx new file mode 100644 index 0000000000..1787aea1fe --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-functions.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-functions" +title: "setFunctions" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setFunctions" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setFunctions` + +Set which non-internal functions are callable while this step is + +active. + +IMPORTANT — inheritance behavior: +If you do NOT call this method, the step inherits whichever +function set was active on the previous step (or the previous +context's last step). The server-side runtime only resets the +active set when a step explicitly declares its `functions` +field. This is the most common source of bugs in multi-step +agents: forgetting setFunctions() on a later step lets the +previous step's tools leak through. Best practice is to call +setFunctions() explicitly on every step that should differ +from the previous one. + +Keep the per-step active set small: LLM tool selection accuracy +degrades noticeably past ~7-8 simultaneously-active tools per +call. Use per-step whitelisting to partition large tool +collections. + +Internal functions (e.g. gather\_submit, hangup hook) are ALWAYS +protected and cannot be deactivated by this whitelist. The +native navigation tools next\_step and change\_context are +injected automatically when setValidSteps / setValidContexts is +used; they are not affected by this list and do not need to +appear in it. + +## Signature + +```php +public function setFunctions($functions): SignalWire\Contexts\Step +``` + +## Parameters + + + One of: + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 297. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-gather-info.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-gather-info.mdx new file mode 100644 index 0000000000..f31f65710e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-gather-info.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-gather-info" +title: "setGatherInfo" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setGatherInfo" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setGatherInfo` + +Initialize the gather\_info configuration for this step. Questions are + +presented one at a time via dynamic step instruction re-injection, +producing zero tool\_call/tool\_result entries in LLM-visible history. + +After calling this, use addGatherQuestion() to define questions. + +## Signature + +```php +public function setGatherInfo( + ?string $output_key = NULL, + ?string $completion_action = NULL, + ?string $prompt = NULL +): SignalWire\Contexts\Step +``` + +## Parameters + + + Key in global\_data to store answers under. + + + + Where to go when all questions are answered ('next\_step', a step name, or null). + + + + Preamble text injected once when entering the gather step. + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 360. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-consolidate.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-consolidate.mdx new file mode 100644 index 0000000000..271dc722bc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-consolidate.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-reset-consolidate" +title: "setResetConsolidate" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setResetConsolidate" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setResetConsolidate` + +## Signature + +```php +public function setResetConsolidate(bool $consolidate): SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 426. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-full-reset.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-full-reset.mdx new file mode 100644 index 0000000000..f876709c01 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-full-reset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-reset-full-reset" +title: "setResetFullReset" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setResetFullReset" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setResetFullReset` + +## Signature + +```php +public function setResetFullReset(bool $fullReset): SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 432. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-system-prompt.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-system-prompt.mdx new file mode 100644 index 0000000000..c837eb174f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-system-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-reset-system-prompt" +title: "setResetSystemPrompt" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setResetSystemPrompt" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setResetSystemPrompt` + +## Signature + +```php +public function setResetSystemPrompt(string $systemPrompt): SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 414. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-user-prompt.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-user-prompt.mdx new file mode 100644 index 0000000000..3d5c962b97 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-reset-user-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-reset-user-prompt" +title: "setResetUserPrompt" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setResetUserPrompt" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setResetUserPrompt` + +## Signature + +```php +public function setResetUserPrompt(string $userPrompt): SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 420. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-skip-to-next-step.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-skip-to-next-step.mdx new file mode 100644 index 0000000000..47848b2410 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-skip-to-next-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-skip-to-next-step" +title: "setSkipToNextStep" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setSkipToNextStep" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setSkipToNextStep` + +## Signature + +```php +public function setSkipToNextStep(bool $skip): SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 341. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-skip-user-turn.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-skip-user-turn.mdx new file mode 100644 index 0000000000..9b3156983f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-skip-user-turn.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-skip-user-turn" +title: "setSkipUserTurn" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setSkipUserTurn" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setSkipUserTurn` + +## Signature + +```php +public function setSkipUserTurn(bool $skip): SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 335. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-step-criteria.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-step-criteria.mdx new file mode 100644 index 0000000000..c9d3ca7e3a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-step-criteria.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-step-criteria" +title: "setStepCriteria" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setStepCriteria" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setStepCriteria` + +## Signature + +```php +public function setStepCriteria(string $criteria): SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 259. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-text.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-text.mdx new file mode 100644 index 0000000000..73f1f75261 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-text.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-text" +title: "setText" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setText" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setText` + +Set the step's prompt text directly. Mutually exclusive with POM sections. + +## Signature + +```php +public function setText(string $text): SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 210. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-valid-contexts.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-valid-contexts.mdx new file mode 100644 index 0000000000..8b5973544b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-valid-contexts.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-valid-contexts" +title: "setValidContexts" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setValidContexts" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setValidContexts` + +## Signature + +```php +public function setValidContexts(array $contexts): SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 309. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-valid-steps.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-valid-steps.mdx new file mode 100644 index 0000000000..c63b208f52 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/set-valid-steps.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/set-valid-steps" +title: "setValidSteps" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::setValidSteps" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `setValidSteps` + +## Signature + +```php +public function setValidSteps(array $steps): SignalWire\Contexts\Step +``` + +## Parameters + + + +## Returns + +`SignalWire\Contexts\Step` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 303. diff --git a/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/to-array.mdx b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/to-array.mdx new file mode 100644 index 0000000000..ee365dfb5c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/contexts/contexts/step/to-array.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/contexts/contexts/step/to-array" +title: "toArray" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Contexts\\Step::toArray" + parent: "SignalWire\\Contexts\\Step" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php" + visibility: "public" +--- +# `toArray` + +## Signature + +```php +public function toArray(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Contexts/ContextBuilder.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Contexts/ContextBuilder.php) + +Line 489. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/body.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/body.mdx new file mode 100644 index 0000000000..f2b464dfcb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/body.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/body" +title: "body" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::body" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `body` + +Set body on the last webhook. + +## Signature + +```php +public function body(array $data): SignalWire\DataMap\DataMap +``` + +## Parameters + + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 199. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/construct.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/construct.mdx new file mode 100644 index 0000000000..63cac85962 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::__construct" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(string $functionName) +``` + +## Parameters + + + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/create-expression-tool.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/create-expression-tool.mdx new file mode 100644 index 0000000000..3d33a2294b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/create-expression-tool.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/create-expression-tool" +title: "createExpressionTool" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::createExpressionTool" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `createExpressionTool` + +Build a complete SWAIG function definition with expressions only. + +**Modifiers:** `static` + +## Signature + +```php +public static function createExpressionTool( + string $name, + string $purpose, + array $parameters, + array $expressions +): array +``` + +## Parameters + + + + + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 379. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/create-simple-api-tool.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/create-simple-api-tool.mdx new file mode 100644 index 0000000000..a851c3a443 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/create-simple-api-tool.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/create-simple-api-tool" +title: "createSimpleApiTool" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::createSimpleApiTool" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `createSimpleApiTool` + +Build a complete SWAIG function definition with a single webhook. + +**Modifiers:** `static` + +## Signature + +```php +public static function createSimpleApiTool( + string $name, + string $purpose, + array $parameters, + string $method, + string $url, + mixed $output, + array $headers = array ( +) +): array +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 344. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/description.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/description.mdx new file mode 100644 index 0000000000..f015ba8e98 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/description.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/description" +title: "description" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::description" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `description` + +Alias for purpose(). Sets the LLM-facing tool description. + +This string is read by the model to decide WHEN to call this +tool. See purpose() for bad-vs-good examples. + +## Signature + +```php +public function description(string $desc): SignalWire\DataMap\DataMap +``` + +## Parameters + + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 68. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/error-keys.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/error-keys.mdx new file mode 100644 index 0000000000..63b6255fd8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/error-keys.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/error-keys" +title: "errorKeys" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::errorKeys" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `errorKeys` + +Set error\_keys on the last webhook. + +## Signature + +```php +public function errorKeys(array $keys): SignalWire\DataMap\DataMap +``` + +## Parameters + + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 263. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/expression.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/expression.mdx new file mode 100644 index 0000000000..895700e3be --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/expression.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/expression" +title: "expression" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::expression" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `expression` + +Add an expression rule. + +## Signature + +```php +public function expression( + string $testValue, + string $pattern, + mixed $output, + mixed $nomatchOutput = NULL +): SignalWire\DataMap\DataMap +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 122. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/fallback-output.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/fallback-output.mdx new file mode 100644 index 0000000000..3d03a1ebd7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/fallback-output.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/fallback-output" +title: "fallbackOutput" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::fallbackOutput" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `fallbackOutput` + +Set global fallback output. + +## Signature + +```php +public function fallbackOutput(mixed $result): SignalWire\DataMap\DataMap +``` + +## Parameters + + + FunctionResult, array, or string + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 251. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/foreach.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/foreach.mdx new file mode 100644 index 0000000000..7031fc36b4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/foreach.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/foreach" +title: "foreach" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::foreach" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `foreach` + +Set foreach on the last webhook. + +## Signature + +```php +public function foreach(array $config): SignalWire\DataMap\DataMap +``` + +## Parameters + + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 225. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/global-error-keys.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/global-error-keys.mdx new file mode 100644 index 0000000000..272ca8d780 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/global-error-keys.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/global-error-keys" +title: "globalErrorKeys" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::globalErrorKeys" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `globalErrorKeys` + +Set global error\_keys. + +## Signature + +```php +public function globalErrorKeys(array $keys): SignalWire\DataMap\DataMap +``` + +## Parameters + + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 276. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/index.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/index.mdx new file mode 100644 index 0000000000..fd848ff0f1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/index.mdx @@ -0,0 +1,97 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map" +title: "DataMap" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap" + parent: "SignalWire\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" +--- +# `DataMap` + +## Signature + +```php +class DataMap +``` + +## Methods + + + + + + Set body on the last webhook. + + + + Build a complete SWAIG function definition with expressions only. + + + + Build a complete SWAIG function definition with a single webhook. + + + + Alias for purpose(). Sets the LLM-facing tool description. + + + + Set error\_keys on the last webhook. + + + + Add an expression rule. + + + + Set global fallback output. + + + + Set foreach on the last webhook. + + + + Set global error\_keys. + + + + Set output on the last webhook. + + + + Add a parameter to this data-map tool — the `$description` is + + + + Set params on the last webhook. + + + + Set the LLM-facing tool description (the "purpose"). PROMPT + + + + Serialize to a SWAIG function definition array. + + + + Add a webhook definition. + + + + Set expressions on the last webhook. + + + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 9. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/output.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/output.mdx new file mode 100644 index 0000000000..099caf0c32 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/output.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/output" +title: "output" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::output" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `output` + +Set output on the last webhook. + +## Signature + +```php +public function output(mixed $result): SignalWire\DataMap\DataMap +``` + +## Parameters + + + FunctionResult, array, or string + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 238. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/parameter.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/parameter.mdx new file mode 100644 index 0000000000..cdc98f9b47 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/parameter.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/parameter" +title: "parameter" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::parameter" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `parameter` + +Add a parameter to this data-map tool — the `$description` is + +LLM-FACING. + +Each parameter description is rendered into the OpenAI tool +schema under parameters.properties.<name>.description and sent +to the model. The model uses it to decide HOW to fill in the +argument from user speech. It is prompt engineering, not +developer FYI. + +Bad vs good: + +BAD : ->parameter('city', 'string', 'the city') +GOOD: ->parameter('city', 'string', +'The name of the city to get weather for, e.g. ' +. '"San Francisco". Ask the user if they did not ' +. 'provide one. Include the state or country if the ' +. 'city name is ambiguous.') + +## Signature + +```php +public function parameter( + string $name, + string $type, + string $description, + bool $required = false, + array $enum = array ( +) +): SignalWire\DataMap\DataMap +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 94. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/params.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/params.mdx new file mode 100644 index 0000000000..7d7e57faf9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/params.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/params" +title: "params" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::params" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `params` + +Set params on the last webhook. + +## Signature + +```php +public function params(array $data): SignalWire\DataMap\DataMap +``` + +## Parameters + + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 212. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/purpose.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/purpose.mdx new file mode 100644 index 0000000000..62e800e470 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/purpose.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/purpose" +title: "purpose" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::purpose" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `purpose` + +Set the LLM-facing tool description (the "purpose"). PROMPT + +ENGINEERING, not developer documentation. + +The description string is rendered into the OpenAI tool schema +`description` field on every LLM turn. The model reads it to +decide WHEN to call this tool. A vague purpose() is the #1 +cause of "the model has the right tool but doesn't call it" +failures with data-map tools. + +Bad vs good: + +BAD : ->purpose('weather api') +GOOD: ->purpose('Get the current weather conditions and ' +. 'forecast for a specific city. Use this ' +. 'whenever the user asks about weather, ' +. 'temperature, rain, or similar conditions ' +. 'in a named location.') + +## Signature + +```php +public function purpose(string $desc): SignalWire\DataMap\DataMap +``` + +## Parameters + + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 57. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/to-swaig-function.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/to-swaig-function.mdx new file mode 100644 index 0000000000..0339f00e03 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/to-swaig-function.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/to-swaig-function" +title: "toSwaigFunction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::toSwaigFunction" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `toSwaigFunction` + +Serialize to a SWAIG function definition array. + +## Signature + +```php +public function toSwaigFunction(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 287. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/webhook-expressions.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/webhook-expressions.mdx new file mode 100644 index 0000000000..869f39fc6b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/webhook-expressions.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/webhook-expressions" +title: "webhookExpressions" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::webhookExpressions" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `webhookExpressions` + +Set expressions on the last webhook. + +## Signature + +```php +public function webhookExpressions(array $expressions): SignalWire\DataMap\DataMap +``` + +## Parameters + + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/webhook.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/webhook.mdx new file mode 100644 index 0000000000..52f2148467 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/data-map/webhook.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map/data-map/webhook" +title: "webhook" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\DataMap\\DataMap::webhook" + parent: "SignalWire\\DataMap\\DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php" + visibility: "public" +--- +# `webhook` + +Add a webhook definition. + +## Signature + +```php +public function webhook( + string $method, + string $url, + array $headers = array ( +), + string $formParam = '', + bool $inputArgsAsParams = false, + array $requireArgs = array ( +) +): SignalWire\DataMap\DataMap +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`SignalWire\DataMap\DataMap` + +## Source + +[`SignalWire/DataMap/DataMap.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/DataMap/DataMap.php) + +Line 148. diff --git a/fern/products/sdk-reference/php/signal-wire/data-map/data-map/index.mdx b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/index.mdx new file mode 100644 index 0000000000..3f26ddfad2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/data-map/data-map/index.mdx @@ -0,0 +1,25 @@ +--- +slug: "/reference/php/signal-wire/data-map/data-map" +title: "DataMap" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\DataMap" + module: "SignalWire.DataMap" +--- +# `DataMap` + +## Signature + +```php +namespace SignalWire\DataMap +``` + +## Classes + + + + diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/index.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/index.mdx new file mode 100644 index 0000000000..f7541f2f7e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/index.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/php/signal-wire/logging/logging" +title: "Logging" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\Logging" + module: "SignalWire.Logging" +--- +# `Logging` + +## Signature + +```php +namespace SignalWire\Logging +``` + +## Classes + + + + + + Cross-language SDK contract for serverless / deployment-mode detection. + + diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/debug.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/debug.mdx new file mode 100644 index 0000000000..7616655f39 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/debug.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/debug" +title: "debug" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::debug" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `debug` + +## Signature + +```php +public function debug(string ...$messages): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/error.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/error.mdx new file mode 100644 index 0000000000..883a6438d9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/error.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/error" +title: "error" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::error" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `error` + +## Signature + +```php +public function error(string ...$messages): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 104. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/get-level.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/get-level.mdx new file mode 100644 index 0000000000..6e8398ef9f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/get-level.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/get-level" +title: "getLevel" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::getLevel" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `getLevel` + +## Signature + +```php +public function getLevel(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 56. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/get-logger.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/get-logger.mdx new file mode 100644 index 0000000000..b95d6f3317 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/get-logger.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/get-logger" +title: "getLogger" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::getLogger" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `getLogger` + +**Modifiers:** `static` + +## Signature + +```php +public static function getLogger(string $name = 'signalwire'): SignalWire\Logging\Logger +``` + +## Parameters + + + +## Returns + +`SignalWire\Logging\Logger` + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/get-name.mdx new file mode 100644 index 0000000000..fc469d0a69 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::getName" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 51. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/index.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/index.mdx new file mode 100644 index 0000000000..5daf15fb00 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger" +title: "Logger" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger" + parent: "SignalWire\\Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" +--- +# `Logger` + +## Signature + +```php +class Logger +``` + +## Methods + + + + + + + + + + + + + + + + + + Reset all logger instances (for testing). + + + + + + + + + + + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 7. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/info.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/info.mdx new file mode 100644 index 0000000000..90367490e3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/info.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/info" +title: "info" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::info" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `info` + +## Signature + +```php +public function info(string ...$messages): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 94. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/is-suppressed.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/is-suppressed.mdx new file mode 100644 index 0000000000..805a6c0964 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/is-suppressed.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/is-suppressed" +title: "isSuppressed" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::isSuppressed" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `isSuppressed` + +## Signature + +```php +public function isSuppressed(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 69. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/reset.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/reset.mdx new file mode 100644 index 0000000000..08ab662f26 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/reset" +title: "reset" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::reset" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `reset` + +Reset all logger instances (for testing). + +**Modifiers:** `static` + +## Signature + +```php +public static function reset(): void +``` + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 46. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/set-level.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/set-level.mdx new file mode 100644 index 0000000000..96865adee6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/set-level.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/set-level" +title: "setLevel" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::setLevel" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `setLevel` + +## Signature + +```php +public function setLevel(string $level): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 61. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/set-suppressed.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/set-suppressed.mdx new file mode 100644 index 0000000000..3f85476fa1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/set-suppressed.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/set-suppressed" +title: "setSuppressed" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::setSuppressed" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `setSuppressed` + +## Signature + +```php +public function setSuppressed(bool $suppressed): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 74. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/should-log.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/should-log.mdx new file mode 100644 index 0000000000..ea7878ece2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/should-log.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/should-log" +title: "shouldLog" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::shouldLog" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `shouldLog` + +## Signature + +```php +public function shouldLog(string $level): bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 79. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/warn.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/warn.mdx new file mode 100644 index 0000000000..337707450b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logger/warn.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logger/warn" +title: "warn" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\Logger::warn" + parent: "SignalWire\\Logging\\Logger" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php" + visibility: "public" +--- +# `warn` + +## Signature + +```php +public function warn(string ...$messages): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Logging/Logger.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/Logger.php) + +Line 99. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logging-config/get-execution-mode.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logging-config/get-execution-mode.mdx new file mode 100644 index 0000000000..ae62b8cb6e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logging-config/get-execution-mode.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logging-config/get-execution-mode" +title: "getExecutionMode" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\LoggingConfig::getExecutionMode" + parent: "SignalWire\\Logging\\LoggingConfig" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/LoggingConfig.php" + visibility: "public" +--- +# `getExecutionMode` + +Detect the SDK's deployment environment based on well-known + +environment variables. + +**Modifiers:** `static` + +## Signature + +```php +public static function getExecutionMode(): string +``` + +## Returns + +`string` — One of 'cgi', 'lambda', 'google\_cloud\_function', 'azure\_function', or 'server'. + +## Source + +[`SignalWire/Logging/LoggingConfig.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/LoggingConfig.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logging-config/index.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logging-config/index.mdx new file mode 100644 index 0000000000..deadff7e07 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logging-config/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logging-config" +title: "LoggingConfig" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Logging\\LoggingConfig" + parent: "SignalWire\\Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/LoggingConfig.php" +--- +# `LoggingConfig` + +Cross-language SDK contract for serverless / deployment-mode detection. + +Mirrors signalwire.core.logging\_config.get\_execution\_mode and +signalwire.utils.is\_serverless\_mode in the Python reference. Order +of precedence (FIRST match wins): + +1. GATEWAY\_INTERFACE -> 'cgi' +2. AWS\_LAMBDA\_FUNCTION\_NAME or LAMBDA\_TASK\_ROOT -> 'lambda' +3. FUNCTION\_TARGET, K\_SERVICE, or GOOGLE\_CLOUD\_PROJECT -> 'google\_cloud\_function' +4. AZURE\_FUNCTIONS\_ENVIRONMENT, FUNCTIONS\_WORKER\_RUNTIME, or + AzureWebJobsStorage -> 'azure\_function' +5. otherwise -> 'server' + +The static methods getExecutionMode() and isServerlessMode() project +onto the Python free functions + +- signalwire.core.logging\_config.get\_execution\_mode +- signalwire.utils.is\_serverless\_mode + via scripts/enumerate\_signatures.py FREE\_FUNCTION\_PROJECTIONS. + +**Modifiers:** `final` + +## Signature + +```php +final class LoggingConfig +``` + +## Methods + + + + Detect the SDK's deployment environment based on well-known + + + + + +## Source + +[`SignalWire/Logging/LoggingConfig.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/LoggingConfig.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/logging/logging/logging-config/is-serverless-mode.mdx b/fern/products/sdk-reference/php/signal-wire/logging/logging/logging-config/is-serverless-mode.mdx new file mode 100644 index 0000000000..7c5b824f72 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/logging/logging/logging-config/is-serverless-mode.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/logging/logging/logging-config/is-serverless-mode" +title: "isServerlessMode" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Logging\\LoggingConfig::isServerlessMode" + parent: "SignalWire\\Logging\\LoggingConfig" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/LoggingConfig.php" + visibility: "public" +--- +# `isServerlessMode` + +**Modifiers:** `static` + +## Signature + +```php +public static function isServerlessMode(): bool +``` + +## Returns + +`bool` — True when running in any serverless invocation environment (anything other than 'server'). + +## Source + +[`SignalWire/Logging/LoggingConfig.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Logging/LoggingConfig.php) + +Line 72. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/index.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/index.mdx new file mode 100644 index 0000000000..75333706d5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/index.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/php/signal-wire/pom/pom" +title: "POM" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\POM" + module: "SignalWire.POM" +--- +# `POM` + +## Signature + +```php +namespace SignalWire\POM +``` + +## Classes + + + + A structured data format for composing, organizing, and rendering prompt + + + + Represents a section in the Prompt Object Model. + + diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/add-pom-as-subsection.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/add-pom-as-subsection.mdx new file mode 100644 index 0000000000..3c2872237a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/add-pom-as-subsection.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model/add-pom-as-subsection" +title: "addPomAsSubsection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel::addPomAsSubsection" + parent: "SignalWire\\POM\\PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" + visibility: "public" +--- +# `addPomAsSubsection` + +Add another PromptObjectModel as a subsection block under a target. + +## Signature + +```php +public function addPomAsSubsection( + SignalWire\POM\Section|string $target, + SignalWire\POM\PromptObjectModel $pomToAdd +): void +``` + +## Parameters + + + Either a section title or a Section instance. + + + + +## Throws + +- `\InvalidArgumentException` — When the title cannot be resolved. + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 359. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/add-section.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/add-section.mdx new file mode 100644 index 0000000000..16755f6e98 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/add-section.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model/add-section" +title: "addSection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel::addSection" + parent: "SignalWire\\POM\\PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" + visibility: "public" +--- +# `addSection` + +Add a top-level section to the model. + +## Signature + +```php +public function addSection( + ?string $title = NULL, + array $params = array ( +) +): SignalWire\POM\Section +``` + +## Parameters + + + + + +## Returns + +`SignalWire\POM\Section` + +## Throws + +- `\InvalidArgumentException` — If $title is null and there is already at least one section + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 181. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/construct.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/construct.mdx new file mode 100644 index 0000000000..85efdd9095 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel::__construct" + parent: "SignalWire\\POM\\PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(bool $debug = false) +``` + +## Parameters + + + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 25. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/find-section.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/find-section.mdx new file mode 100644 index 0000000000..556619b18a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/find-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model/find-section" +title: "findSection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel::findSection" + parent: "SignalWire\\POM\\PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" + visibility: "public" +--- +# `findSection` + +Recursively search for a section by title. + +## Signature + +```php +public function findSection(string $title): ?SignalWire\POM\Section +``` + +## Parameters + + + +## Returns + +`?SignalWire\POM\Section` + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 201. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/from-json.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/from-json.mdx new file mode 100644 index 0000000000..f099316c60 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/from-json.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model/from-json" +title: "fromJson" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel::fromJson" + parent: "SignalWire\\POM\\PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" + visibility: "public" +--- +# `fromJson` + +Create a PromptObjectModel from a JSON string or a parsed array. + +**Modifiers:** `static` + +## Signature + +```php +public static function fromJson(array|string $jsonData): SignalWire\POM\PromptObjectModel +``` + +## Parameters + + + +## Returns + +`SignalWire\POM\PromptObjectModel` + +## Throws + +- `\InvalidArgumentException` — on malformed JSON or invalid structure + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 41. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/from-yaml.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/from-yaml.mdx new file mode 100644 index 0000000000..e66a06844b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/from-yaml.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model/from-yaml" +title: "fromYaml" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel::fromYaml" + parent: "SignalWire\\POM\\PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" + visibility: "public" +--- +# `fromYaml` + +Create a PromptObjectModel from a YAML string or a parsed array. + +**Modifiers:** `static` + +## Signature + +```php +public static function fromYaml(array|string $yamlData): SignalWire\POM\PromptObjectModel +``` + +## Parameters + + + +## Returns + +`SignalWire\POM\PromptObjectModel` + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 64. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/index.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/index.mdx new file mode 100644 index 0000000000..a37c52c9b1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/index.mdx @@ -0,0 +1,85 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model" +title: "PromptObjectModel" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel" + parent: "SignalWire\\POM" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" +--- +# `PromptObjectModel` + +A structured data format for composing, organizing, and rendering prompt + +instructions for large language models. + +Mirrors Python's `signalwire.pom.pom.PromptObjectModel`. Provides a +tree-based representation of nested sections, supporting JSON / YAML +serialization and Markdown / XML rendering. + +YAML support: a small bundled emitter and parser implement the subset of +PyYAML's default block style needed for round-tripping POM documents. +Composer-installed yaml extensions are not required. + +## Signature + +```php +class PromptObjectModel +``` + +## Properties + + + + + +## Methods + + + + + + Add another PromptObjectModel as a subsection block under a target. + + + + Add a top-level section to the model. + + + + Recursively search for a section by title. + + + + Create a PromptObjectModel from a JSON string or a parsed array. + + + + Create a PromptObjectModel from a YAML string or a parsed array. + + + + + + + + + + Serialize the model as JSON. Matches Python `json.dumps(.., indent=2)`. + + + + Serialize the model as YAML. Matches PyYAML's default block style + + + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 19. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/render-markdown.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/render-markdown.mdx new file mode 100644 index 0000000000..46169ad2b8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/render-markdown.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model/render-markdown" +title: "renderMarkdown" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel::renderMarkdown" + parent: "SignalWire\\POM\\PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" + visibility: "public" +--- +# `renderMarkdown` + +## Signature + +```php +public function renderMarkdown(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 289. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/render-xml.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/render-xml.mdx new file mode 100644 index 0000000000..55dc7e2b69 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/render-xml.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model/render-xml" +title: "renderXml" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel::renderXml" + parent: "SignalWire\\POM\\PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" + visibility: "public" +--- +# `renderXml` + +## Signature + +```php +public function renderXml(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 318. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/to-array.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/to-array.mdx new file mode 100644 index 0000000000..6fdab968cf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/to-array.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model/to-array" +title: "toArray" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel::toArray" + parent: "SignalWire\\POM\\PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" + visibility: "public" +--- +# `toArray` + +## Signature + +```php +public function toArray(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 230. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/to-json.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/to-json.mdx new file mode 100644 index 0000000000..6834f06593 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/to-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model/to-json" +title: "toJson" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel::toJson" + parent: "SignalWire\\POM\\PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" + visibility: "public" +--- +# `toJson` + +Serialize the model as JSON. Matches Python `json.dumps(.., indent=2)`. + +## Signature + +```php +public function toJson(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 238. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/to-yaml.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/to-yaml.mdx new file mode 100644 index 0000000000..06f5b97107 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/prompt-object-model/to-yaml.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/prompt-object-model/to-yaml" +title: "toYaml" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\PromptObjectModel::toYaml" + parent: "SignalWire\\POM\\PromptObjectModel" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php" + visibility: "public" +--- +# `toYaml` + +Serialize the model as YAML. Matches PyYAML's default block style + +with `default_flow_style=False, sort_keys=False`. + +## Signature + +```php +public function toYaml(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/POM/PromptObjectModel.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/PromptObjectModel.php) + +Line 280. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/section/add-body.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/add-body.mdx new file mode 100644 index 0000000000..74f2e51989 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/add-body.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/section/add-body" +title: "addBody" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\Section::addBody" + parent: "SignalWire\\POM\\Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php" + visibility: "public" +--- +# `addBody` + +Add or replace the body text for this section. + +## Signature + +```php +public function addBody(string $body): void +``` + +## Parameters + + + +## Source + +[`SignalWire/POM/Section.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php) + +Line 72. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/section/add-bullets.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/add-bullets.mdx new file mode 100644 index 0000000000..a153c8c046 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/add-bullets.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/section/add-bullets" +title: "addBullets" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\Section::addBullets" + parent: "SignalWire\\POM\\Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php" + visibility: "public" +--- +# `addBullets` + +Append bullet points to this section. + +## Signature + +```php +public function addBullets(array $bullets): void +``` + +## Parameters + + + +## Source + +[`SignalWire/POM/Section.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php) + +Line 82. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/section/add-subsection.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/add-subsection.mdx new file mode 100644 index 0000000000..ae335cb54a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/add-subsection.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/section/add-subsection" +title: "addSubsection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\Section::addSubsection" + parent: "SignalWire\\POM\\Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php" + visibility: "public" +--- +# `addSubsection` + +Add a subsection to this section. + +## Signature + +```php +public function addSubsection( + string $title, + array $params = array ( +) +): SignalWire\POM\Section +``` + +## Parameters + + + + + +## Returns + +`SignalWire\POM\Section` + +## Throws + +- `\InvalidArgumentException` — If $title is null + +## Source + +[`SignalWire/POM/Section.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php) + +Line 104. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/section/construct.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/construct.mdx new file mode 100644 index 0000000000..678a005543 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/section/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\Section::__construct" + parent: "SignalWire\\POM\\Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(?string $title = NULL, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/POM/Section.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php) + +Line 45. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/section/index.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/index.mdx new file mode 100644 index 0000000000..7a2f4fdc5d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/index.mdx @@ -0,0 +1,89 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/section" +title: "Section" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\POM\\Section" + parent: "SignalWire\\POM" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php" +--- +# `Section` + +Represents a section in the Prompt Object Model. + +Each section contains a title, optional body text, optional bullet +points, and any number of nested subsections. Mirrors Python's +`signalwire.pom.pom.Section` byte-for-byte for `render_markdown`, +`render_xml`, `to_dict` (and indirectly `to_json` / `to_yaml`). + +Python parity: signalwire/signalwire/pom/pom.py::Section + +Constructor params (`params` array — PHP idiom for kwargs): + +- title (?string) section title; null is permitted only on the + first top-level section of a PromptObjectModel +- body (string) paragraph text; default '' +- bullets (?list<string>) bullet items; default \[] +- numbered (?bool) null = inherit; true/false = explicit +- numberedBullets (bool) render bullets as "1. foo" instead of "- foo" + +## Signature + +```php +class Section +``` + +## Properties + + + + + + + + + + + + + +## Methods + + + + + + Add or replace the body text for this section. + + + + Append bullet points to this section. + + + + Add a subsection to this section. + + + + Render this section and all its subsections as Markdown. + + + + Render this section and all its subsections as XML. + + + + Convert the section to a dictionary representation. + + + +## Source + +[`SignalWire/POM/Section.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php) + +Line 25. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/section/render-markdown.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/render-markdown.mdx new file mode 100644 index 0000000000..8be9d3323f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/render-markdown.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/section/render-markdown" +title: "renderMarkdown" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\Section::renderMarkdown" + parent: "SignalWire\\POM\\Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php" + visibility: "public" +--- +# `renderMarkdown` + +Render this section and all its subsections as Markdown. + +## Signature + +```php +public function renderMarkdown(int $level = 2, ?array $sectionNumber = NULL): string +``` + +## Parameters + + + heading level (default 2 -> ##) + + + + numbering breadcrumb + + +## Returns + +`string` + +## Source + +[`SignalWire/POM/Section.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php) + +Line 155. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/section/render-xml.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/render-xml.mdx new file mode 100644 index 0000000000..073ef32997 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/render-xml.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/section/render-xml" +title: "renderXml" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\Section::renderXml" + parent: "SignalWire\\POM\\Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php" + visibility: "public" +--- +# `renderXml` + +Render this section and all its subsections as XML. + +## Signature + +```php +public function renderXml(int $indent = 0, ?array $sectionNumber = NULL): string +``` + +## Parameters + + + indentation level (each = 2 spaces) + + + + numbering breadcrumb + + +## Returns + +`string` + +## Source + +[`SignalWire/POM/Section.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php) + +Line 216. diff --git a/fern/products/sdk-reference/php/signal-wire/pom/pom/section/to-array.mdx b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/to-array.mdx new file mode 100644 index 0000000000..2586af2826 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/pom/pom/section/to-array.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/pom/pom/section/to-array" +title: "toArray" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\POM\\Section::toArray" + parent: "SignalWire\\POM\\Section" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php" + visibility: "public" +--- +# `toArray` + +Convert the section to a dictionary representation. + +Key ordering (must match Python): title, body, bullets, subsections, +numbered, numberedBullets. + +## Signature + +```php +public function toArray(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/POM/Section.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/POM/Section.php) + +Line 122. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/construct.mdx new file mode 100644 index 0000000000..9f8821971f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/construct.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::__construct" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $controlId, + string $callId, + string $nodeId, + object $client +) +``` + +## Parameters + + + + + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/execute-subcommand.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/execute-subcommand.mdx new file mode 100644 index 0000000000..3e35981fbe --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/execute-subcommand.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/execute-subcommand" +title: "executeSubcommand" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::executeSubcommand" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `executeSubcommand` + +Send a sub-command RPC through the client. + +The payload always includes control\_id, call\_id, and node\_id so +the server knows which action instance to target. + +## Signature + +```php +public function executeSubcommand(string $method, array $extraParams = array ( +)): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-call-id.mdx new file mode 100644 index 0000000000..c7e16161f4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::getCallId" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-control-id.mdx new file mode 100644 index 0000000000..55c80bf6ab --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::getControlId" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 102. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-events.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-events.mdx new file mode 100644 index 0000000000..495264e048 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/get-events" +title: "getEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::getEvents" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getEvents` + +## Signature + +```php +public function getEvents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-node-id.mdx new file mode 100644 index 0000000000..2f97b522cc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::getNodeId" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-payload.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-payload.mdx new file mode 100644 index 0000000000..8e8d46a049 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/get-payload" +title: "getPayload" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::getPayload" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getPayload` + +## Signature + +```php +public function getPayload(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-result.mdx new file mode 100644 index 0000000000..036251c455 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::getResult" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 81. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-state.mdx new file mode 100644 index 0000000000..1de2aed37e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::getState" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-stop-method.mdx new file mode 100644 index 0000000000..e18ae75969 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/get-stop-method.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/get-stop-method" +title: "getStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::getStopMethod" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getStopMethod` + +Return the RELAY RPC method that stops this action. + +Subclasses MUST override this to return the correct method name +(e.g. 'calling.play.stop'). + +## Signature + +```php +public function getStopMethod(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 200. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/handle-event.mdx new file mode 100644 index 0000000000..cf4afe0ba7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::handleEvent" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `handleEvent` + +Append an incoming event and update local state / payload. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/index.mdx new file mode 100644 index 0000000000..23d39decbc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action" +title: "Action" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\Action" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" +--- +# `Action` + +Base class for all RELAY call actions (play, record, collect, etc.). + +An Action is the client-side handle returned when you start an +asynchronous operation on a call. It accumulates events, tracks +state, and resolves once the operation reaches a terminal state. + +## Signature + +```php +class Action +``` + +## Methods + + + + + + Send a sub-command RPC through the client. + + + + + + + + + + + + + + + + + + Return the RELAY RPC method that stops this action. + + + + Append an incoming event and update local state / payload. + + + + + + Register a callback to fire when the action completes. + + + + Mark this action as completed. + + + + Stop the running action by sending its stop sub-command. + + + + Block until the action completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 16. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/is-done.mdx new file mode 100644 index 0000000000..517a8fb5ea --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::isDone" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/on-completed.mdx new file mode 100644 index 0000000000..eb01e02037 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::onCompleted" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the action completes. + +If the action is already done the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Action +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Action` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/resolve.mdx new file mode 100644 index 0000000000..bb7975ff1e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::resolve" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +The optional $result is stored and the onCompleted callback is +fired exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/stop.mdx new file mode 100644 index 0000000000..bfb47b2a92 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::stop" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```php +public function stop(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/action/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/wait.mdx new file mode 100644 index 0000000000..26ea90a273 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/action/wait.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/action/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Action::wait" + parent: "SignalWire\\Relay\\Action" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `wait` + +Block until the action completes or $timeout seconds elapse. + +Each iteration calls $client->readOnce() so the event-loop +keeps processing inbound frames. + +Returns the resolving Event when the action completes (mirrors +Python's `return self._wait_event.wait()`). Returns null on +timeout. The numeric `$timeout` is interpreted as seconds and +accepts integers or floats. + +## Signature + +```php +public function wait(int|float $timeout = 30): ?SignalWire\Relay\Event +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/construct.mdx new file mode 100644 index 0000000000..566c14d129 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/construct.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::__construct" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $controlId, + string $callId, + string $nodeId, + object $client +) +``` + +## Parameters + + + + + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/execute-subcommand.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/execute-subcommand.mdx new file mode 100644 index 0000000000..443f141c9e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/execute-subcommand.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/execute-subcommand" +title: "executeSubcommand" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::executeSubcommand" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `executeSubcommand` + +Send a sub-command RPC through the client. + +The payload always includes control\_id, call\_id, and node\_id so +the server knows which action instance to target. + +## Signature + +```php +public function executeSubcommand(string $method, array $extraParams = array ( +)): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-call-id.mdx new file mode 100644 index 0000000000..60dcd0f9aa --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::getCallId" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-control-id.mdx new file mode 100644 index 0000000000..e71c9b98e2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::getControlId" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 102. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-events.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-events.mdx new file mode 100644 index 0000000000..1c06fb56a0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/get-events" +title: "getEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::getEvents" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getEvents` + +## Signature + +```php +public function getEvents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-node-id.mdx new file mode 100644 index 0000000000..ec2bca5d67 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::getNodeId" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-payload.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-payload.mdx new file mode 100644 index 0000000000..f10bfaac12 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/get-payload" +title: "getPayload" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::getPayload" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getPayload` + +## Signature + +```php +public function getPayload(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-result.mdx new file mode 100644 index 0000000000..e68364ec79 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::getResult" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 81. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-state.mdx new file mode 100644 index 0000000000..6765c0c102 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::getState" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-stop-method.mdx new file mode 100644 index 0000000000..5a47e22781 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/get-stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/get-stop-method" +title: "getStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::getStopMethod" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getStopMethod` + +## Signature + +```php +public function getStopMethod(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 478. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/handle-event.mdx new file mode 100644 index 0000000000..5f4c4cd38b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::handleEvent" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `handleEvent` + +Append an incoming event and update local state / payload. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/index.mdx new file mode 100644 index 0000000000..26d6e2b1ec --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action" +title: "AIAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" +--- +# `AIAction` + +Handle for calling.ai operations. + +## Signature + +```php +class AIAction extends Action +``` + +## Inheritance + +**Extends:** [SignalWire\Relay\Action](/reference/php/signal-wire/relay/relay/action) + +## Methods + + + + + + Send a sub-command RPC through the client. + + + + + + + + + + + + + + + + + + + + Append an incoming event and update local state / payload. + + + + + + Register a callback to fire when the action completes. + + + + Mark this action as completed. + + + + Stop the running action by sending its stop sub-command. + + + + Block until the action completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 476. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/is-done.mdx new file mode 100644 index 0000000000..160d368967 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::isDone" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/on-completed.mdx new file mode 100644 index 0000000000..43d84c6fab --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::onCompleted" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the action completes. + +If the action is already done the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Action +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Action` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/resolve.mdx new file mode 100644 index 0000000000..c3c767d318 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::resolve" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +The optional $result is stored and the onCompleted callback is +fired exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/stop.mdx new file mode 100644 index 0000000000..ac97eb0c12 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::stop" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```php +public function stop(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/wait.mdx new file mode 100644 index 0000000000..9702260060 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/ai-action/wait.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/ai-action/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\AIAction::wait" + parent: "SignalWire\\Relay\\AIAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `wait` + +Block until the action completes or $timeout seconds elapse. + +Each iteration calls $client->readOnce() so the event-loop +keeps processing inbound frames. + +Returns the resolving Event when the action completes (mirrors +Python's `return self._wait_event.wait()`). Returns null on +timeout. The numeric `$timeout` is interpreted as seconds and +accepts integers or floats. + +## Signature + +```php +public function wait(int|float $timeout = 30): ?SignalWire\Relay\Event +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai-hold.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai-hold.mdx new file mode 100644 index 0000000000..35cca2ec41 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai-hold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/ai-hold" +title: "aiHold" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::aiHold" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `aiHold` + +## Signature + +```php +public function aiHold(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 313. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai-message.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai-message.mdx new file mode 100644 index 0000000000..0bed3aa70a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/ai-message" +title: "aiMessage" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::aiMessage" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `aiMessage` + +## Signature + +```php +public function aiMessage(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 308. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai-unhold.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai-unhold.mdx new file mode 100644 index 0000000000..d6b614408b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai-unhold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/ai-unhold" +title: "aiUnhold" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::aiUnhold" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `aiUnhold` + +## Signature + +```php +public function aiUnhold(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 318. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai.mdx new file mode 100644 index 0000000000..f93555a88e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/ai.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/ai" +title: "ai" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::ai" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `ai` + +## Signature + +```php +public function ai(array $prompt, array $opts = array ( +)): SignalWire\Relay\AIAction +``` + +## Parameters + + + AI prompt config. + + + + +## Returns + +`SignalWire\Relay\AIAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 535. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/amazon-bedrock.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/amazon-bedrock.mdx new file mode 100644 index 0000000000..90ebeb70ab --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/amazon-bedrock.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/amazon-bedrock" +title: "amazonBedrock" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::amazonBedrock" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `amazonBedrock` + +## Signature + +```php +public function amazonBedrock(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 303. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/answer.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/answer.mdx new file mode 100644 index 0000000000..2368aad4b7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/answer.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/answer" +title: "answer" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::answer" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `answer` + +## Signature + +```php +public function answer(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 184. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/bind-digit.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/bind-digit.mdx new file mode 100644 index 0000000000..f578a695eb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/bind-digit.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/bind-digit" +title: "bindDigit" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::bindDigit" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `bindDigit` + +## Signature + +```php +public function bindDigit(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 258. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/clear-digit-bindings.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/clear-digit-bindings.mdx new file mode 100644 index 0000000000..1a04100489 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/clear-digit-bindings.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/clear-digit-bindings" +title: "clearDigitBindings" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::clearDigitBindings" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `clearDigitBindings` + +Clear all digit bindings, optionally filtered by realm. + +Mirrors Python's Call.clear\_digit\_bindings(\*, realm=None, \*\*kwargs). + +## Signature + +```php +public function clearDigitBindings( + ?string $realm = NULL, + array $kwargs = array ( +) +): array +``` + +## Parameters + + + Optional realm filter — restricts clearing to bindings registered under that realm. + + + + Additional params forwarded to the wire call. + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 273. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/collect.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/collect.mdx new file mode 100644 index 0000000000..0a566ae5d0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/collect.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/collect" +title: "collect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::collect" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `collect` + +Standalone collect (digits / speech / both). + +## Signature + +```php +public function collect(array $opts = array ( +)): SignalWire\Relay\CollectAction +``` + +## Parameters + + + \- \`\`digits\`\` / \`\`speech\`\` / \`\`initial\_timeout\`\` etc forwarded as-is + \- \`\`control\_id\`\` + \- \`\`start\_input\_timers\`\` (bool) + \- \`\`on\_completed\`\` callback + + +## Returns + +`SignalWire\Relay\CollectAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 439. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/connect.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/connect.mdx new file mode 100644 index 0000000000..75ede267cb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/connect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/connect" +title: "connect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::connect" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `connect` + +## Signature + +```php +public function connect(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 208. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/construct.mdx new file mode 100644 index 0000000000..53e0d991a1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::__construct" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(array $params, object $client) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/denoise-stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/denoise-stop.mdx new file mode 100644 index 0000000000..474b3ac347 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/denoise-stop.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/denoise-stop" +title: "denoiseStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::denoiseStop" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `denoiseStop` + +## Signature + +```php +public function denoiseStop(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 233. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/denoise.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/denoise.mdx new file mode 100644 index 0000000000..2ffaeee886 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/denoise.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/denoise" +title: "denoise" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::denoise" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `denoise` + +## Signature + +```php +public function denoise(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 228. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/detect.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/detect.mdx new file mode 100644 index 0000000000..11a7f2e5f7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/detect.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/detect" +title: "detect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::detect" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `detect` + +## Signature + +```php +public function detect( + array $detect, + array $opts = array ( +) +): SignalWire\Relay\DetectAction +``` + +## Parameters + + + Detection request (`{type: 'machine'|'fax'|'digit', params: {...}}`). + + + + +## Returns + +`SignalWire\Relay\DetectAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 466. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/disconnect.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/disconnect.mdx new file mode 100644 index 0000000000..1e3002fb9c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/disconnect.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/disconnect" +title: "disconnect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::disconnect" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `disconnect` + +## Signature + +```php +public function disconnect(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 213. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/dispatch-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/dispatch-event.mdx new file mode 100644 index 0000000000..7c2b218b98 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/dispatch-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/dispatch-event" +title: "dispatchEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::dispatchEvent" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `dispatchEvent` + +Central event router invoked by the Client whenever a server event + +targets this call. + +## Signature + +```php +public function dispatchEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 71. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/echo.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/echo.mdx new file mode 100644 index 0000000000..631a74c4cb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/echo.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/echo" +title: "echo" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::echo" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `echo` + +## Signature + +```php +public function echo(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 253. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/hangup.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/hangup.mdx new file mode 100644 index 0000000000..8e830efdf2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/hangup.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/hangup" +title: "hangup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::hangup" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `hangup` + +Hang up the call. `$reason` is forwarded as `reason` on the + +wire (RELAY accepts `hangup`, `busy`, `decline`, etc.). + +The on-wire method is `calling.end` (production), which historically +was named `calling.hangup` — we send `calling.end` to match the +RELAY schema set extracted from switchblade. + +## Signature + +```php +public function hangup(?string $reason = NULL): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 197. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/hold.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/hold.mdx new file mode 100644 index 0000000000..6adb16b64c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/hold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/hold" +title: "hold" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::hold" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `hold` + +## Signature + +```php +public function hold(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 218. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/index.mdx new file mode 100644 index 0000000000..113dcdc493 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/index.mdx @@ -0,0 +1,175 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call" +title: "Call" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\Call" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" +--- +# `Call` + +Represents a RELAY voice call. + +Holds call-level state, dispatches server events to registered listeners +and to in-flight Action objects, and exposes every calling.\* RPC method +as a first-class PHP method. + +## Signature + +```php +class Call +``` + +## Properties + + + controlId => Action + + + + + + RELAY Client instance + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + + + + + + + + + + + + + + + + Clear all digit bindings, optionally filtered by realm. + + + + Standalone collect (digits / speech / both). + + + + + + + + + + + + + + Central event router invoked by the Client whenever a server event + + + + + + Hang up the call. `$reason` is forwarded as `reason` on the + + + + + + + + + + + + + + + + + + Register a generic event listener on this call. + + + + + + + + Start a calling.play action. + + + + Play media then collect a response (digits, speech). + + + + + + Remove the call from a named queue. + + + + + + + + + + Mark every outstanding action as completed. Called when the call + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 16. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/join-conference.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/join-conference.mdx new file mode 100644 index 0000000000..29467854ed --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/join-conference.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/join-conference" +title: "joinConference" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::joinConference" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `joinConference` + +## Signature + +```php +public function joinConference(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 243. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/join-room.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/join-room.mdx new file mode 100644 index 0000000000..61cee63286 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/join-room.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/join-room" +title: "joinRoom" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::joinRoom" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `joinRoom` + +## Signature + +```php +public function joinRoom(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 293. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/leave-conference.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/leave-conference.mdx new file mode 100644 index 0000000000..33bec19af7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/leave-conference.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/leave-conference" +title: "leaveConference" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::leaveConference" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `leaveConference` + +## Signature + +```php +public function leaveConference(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 248. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/leave-room.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/leave-room.mdx new file mode 100644 index 0000000000..46eac5d1c9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/leave-room.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/leave-room" +title: "leaveRoom" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::leaveRoom" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `leaveRoom` + +## Signature + +```php +public function leaveRoom(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 298. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/live-transcribe.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/live-transcribe.mdx new file mode 100644 index 0000000000..cb2d4ba8d2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/live-transcribe.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/live-transcribe" +title: "liveTranscribe" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::liveTranscribe" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `liveTranscribe` + +## Signature + +```php +public function liveTranscribe(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 283. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/live-translate.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/live-translate.mdx new file mode 100644 index 0000000000..b78bd94d81 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/live-translate.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/live-translate" +title: "liveTranslate" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::liveTranslate" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `liveTranslate` + +## Signature + +```php +public function liveTranslate(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 288. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/on.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/on.mdx new file mode 100644 index 0000000000..fdd718111a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/on.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/on" +title: "on" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::on" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `on` + +Register a generic event listener on this call. + +## Signature + +```php +public function on(callable $cb): SignalWire\Relay\Call +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Call` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 162. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/pass.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/pass.mdx new file mode 100644 index 0000000000..1bb5e0a7a4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/pass.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/pass" +title: "pass" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::pass" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `pass` + +## Signature + +```php +public function pass(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 203. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/pay.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/pay.mdx new file mode 100644 index 0000000000..1c64361c70 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/pay.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/pay" +title: "pay" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::pay" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `pay` + +## Signature + +```php +public function pay( + string $paymentConnectorUrl, + array $opts = array ( +) +): SignalWire\Relay\PayAction +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Relay\PayAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 521. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/play-and-collect.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/play-and-collect.mdx new file mode 100644 index 0000000000..00d26c26cb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/play-and-collect.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/play-and-collect" +title: "playAndCollect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::playAndCollect" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `playAndCollect` + +Play media then collect a response (digits, speech). + +## Signature + +```php +public function playAndCollect( + array $media, + array $collect, + array $opts = array ( +) +): SignalWire\Relay\CollectAction +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire\Relay\CollectAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 452. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/play.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/play.mdx new file mode 100644 index 0000000000..b034586bf4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/play.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/play" +title: "play" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::play" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `play` + +Start a calling.play action. + +## Signature + +```php +public function play( + array $media, + array $opts = array ( +) +): SignalWire\Relay\PlayAction +``` + +## Parameters + + + Play list (each entry is `{type:..., params:...}`). + + + + `control_id` (auto-generated when omitted), `on_completed` callback fired on terminal events. + + +## Returns + +`SignalWire\Relay\PlayAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 407. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/queue-enter.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/queue-enter.mdx new file mode 100644 index 0000000000..37e443b7e2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/queue-enter.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/queue-enter" +title: "queueEnter" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::queueEnter" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `queueEnter` + +## Signature + +```php +public function queueEnter(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 328. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/queue-leave.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/queue-leave.mdx new file mode 100644 index 0000000000..3e85479755 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/queue-leave.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/queue-leave" +title: "queueLeave" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::queueLeave" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `queueLeave` + +Remove the call from a named queue. + +Mirrors Python's Call.queue\_leave(queue\_name, \*, control\_id=None, +queue\_id=None, status\_url=None, \*\*kwargs). When called with no args +the legacy "leave the current queue" behavior is preserved. + +## Signature + +```php +public function queueLeave( + ?string $queue_name = NULL, + ?string $control_id = NULL, + ?string $queue_id = NULL, + ?string $status_url = NULL, + array $kwargs = array ( +) +): array +``` + +## Parameters + + + Name of the queue to leave. Required when also supplying control\_id / queue\_id; when null the legacy no-arg "leave-current" behavior is preserved. + + + + Optional control\_id; auto-generated when null and other named-args are supplied. + + + + Optional explicit queue\_id passed to the server. + + + + Optional status callback URL. + + + + Extra params merged onto the wire call. + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 352. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/receive-fax.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/receive-fax.mdx new file mode 100644 index 0000000000..dbfc6561f4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/receive-fax.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/receive-fax" +title: "receiveFax" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::receiveFax" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `receiveFax` + +## Signature + +```php +public function receiveFax(array $opts = array ( +)): SignalWire\Relay\FaxAction +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\FaxAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 491. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/record.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/record.mdx new file mode 100644 index 0000000000..7629255de3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/record.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/record" +title: "record" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::record" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `record` + +## Signature + +```php +public function record( + array $audio, + array $opts = array ( +) +): SignalWire\Relay\RecordAction +``` + +## Parameters + + + Recording config (`format`, etc.) + + + + +## Returns + +`SignalWire\Relay\RecordAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 420. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/refer.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/refer.mdx new file mode 100644 index 0000000000..086e0722f7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/refer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/refer" +title: "refer" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::refer" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `refer` + +## Signature + +```php +public function refer(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 385. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/resolve-all-actions.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/resolve-all-actions.mdx new file mode 100644 index 0000000000..18eca4d547 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/resolve-all-actions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/resolve-all-actions" +title: "resolveAllActions" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::resolveAllActions" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `resolveAllActions` + +Mark every outstanding action as completed. Called when the call + +enters a terminal state (ended). + +## Signature + +```php +public function resolveAllActions(): void +``` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 172. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/send-digits.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/send-digits.mdx new file mode 100644 index 0000000000..43455de0db --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/send-digits.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/send-digits" +title: "sendDigits" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::sendDigits" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `sendDigits` + +## Signature + +```php +public function sendDigits(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 390. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/send-fax.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/send-fax.mdx new file mode 100644 index 0000000000..a183a02960 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/send-fax.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/send-fax" +title: "sendFax" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::sendFax" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `sendFax` + +## Signature + +```php +public function sendFax( + string $document, + ?string $identity = NULL, + array $opts = array ( +) +): SignalWire\Relay\FaxAction +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire\Relay\FaxAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 476. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/stream.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/stream.mdx new file mode 100644 index 0000000000..c98a0c7fd6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/stream.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/stream" +title: "stream" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::stream" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `stream` + +## Signature + +```php +public function stream( + string $url, + array $opts = array ( +) +): SignalWire\Relay\StreamAction +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Relay\StreamAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 515. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/tap.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/tap.mdx new file mode 100644 index 0000000000..b5e8130a59 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/tap.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/tap" +title: "tap" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::tap" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `tap` + +## Signature + +```php +public function tap( + array $tap, + array $device, + array $opts = array ( +) +): SignalWire\Relay\TapAction +``` + +## Parameters + + + Tap config. + + + + Tap delivery device. + + + + +## Returns + +`SignalWire\Relay\TapAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 505. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/transcribe.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/transcribe.mdx new file mode 100644 index 0000000000..dc2c0b73a2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/transcribe.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/transcribe" +title: "transcribe" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::transcribe" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `transcribe` + +## Signature + +```php +public function transcribe(array $opts = array ( +)): SignalWire\Relay\TranscribeAction +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\TranscribeAction` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 527. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/transfer.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/transfer.mdx new file mode 100644 index 0000000000..2a0cf324b6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/transfer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/transfer" +title: "transfer" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::transfer" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `transfer` + +## Signature + +```php +public function transfer(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 238. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/unhold.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/unhold.mdx new file mode 100644 index 0000000000..265c31c7c5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/unhold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/unhold" +title: "unhold" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::unhold" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `unhold` + +## Signature + +```php +public function unhold(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 223. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/call/user-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/user-event.mdx new file mode 100644 index 0000000000..6c1d83046c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/call/user-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/call/user-event" +title: "userEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Call::userEvent" + parent: "SignalWire\\Relay\\Call" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php" + visibility: "public" +--- +# `userEvent` + +## Signature + +```php +public function userEvent(array $params): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Call.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Call.php) + +Line 323. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/authenticate.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/authenticate.mdx new file mode 100644 index 0000000000..01eaba8ee4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/authenticate.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/authenticate" +title: "authenticate" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::authenticate" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `authenticate` + +Send the signalwire.connect RPC to authenticate and bind a session. + +Sends project/token both at the top level AND nested under +`authentication`. Python sends the nested form; the audit fixture +accepts either; sending both is forward-compatible (per +SUBAGENT\_PLAYBOOK lessons-learned). + +## Signature + +```php +public function authenticate(): void +``` + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 184. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/connect.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/connect.mdx new file mode 100644 index 0000000000..a01fc8660e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/connect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/connect" +title: "connect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::connect" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `connect` + +Open the WebSocket connection and run the JSON-RPC `signalwire.connect` + +handshake. Throws on transport or auth failure. + +The transport URI is `://` (defaults to +`wss:///api/relay/ws`). Tests point SIGNALWIRE\_RELAY\_SCHEME +at `ws` and SIGNALWIRE\_RELAY\_HOST at the fixture's host:port. + +## Signature + +```php +public function connect(): void +``` + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 145. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/construct.mdx new file mode 100644 index 0000000000..683b8dda6f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::__construct" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(array $options) +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 85. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/dial.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/dial.mdx new file mode 100644 index 0000000000..aa1c280f45 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/dial.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/dial" +title: "dial" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::dial" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `dial` + +Originate an outbound call, blocking until `calling.call.dial` + +resolves with a winner or fails. + +## Signature + +```php +public function dial(array $devices, array $opts = array ( +)): SignalWire\Relay\Call +``` + +## Parameters + + + Two-dimensional array of devices: each outer entry is one parallel "leg" of the dial, each inner entry is a serial step within that leg. Mirrors the Python `[[device, device], [device]]` shape. + + + + \- \`\`tag\`\`: explicit dial tag (UUID4 generated when omitted) + \- \`\`dial\_timeout\`\`: seconds to wait for the dial event (default 30.0) + \- \`\`max\_duration\`\`: max call lifetime in seconds, passed through + to \`\`calling.dial\`\`. + \- any other key is forwarded as a top-level param on the wire. + + +## Returns + +`SignalWire\Relay\Call` + +## Throws + +- `RelayError` — on dial failure or timeout. + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 599. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/disconnect.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/disconnect.mdx new file mode 100644 index 0000000000..ea8ebda244 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/disconnect.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/disconnect" +title: "disconnect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::disconnect" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `disconnect` + +Gracefully close the connection. + +## Signature + +```php +public function disconnect(): void +``` + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 239. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/execute.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/execute.mdx new file mode 100644 index 0000000000..472cc5e557 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/execute.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/execute" +title: "execute" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::execute" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `execute` + +Send a JSON-RPC request and synchronously wait for the matching + +response. Returns the "result" portion of the response. + +## Signature + +```php +public function execute(string $method, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Throws + +- `\RuntimeException` — on error responses or transport timeout. + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 320. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/get-call.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/get-call.mdx new file mode 100644 index 0000000000..89c9f8e57a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/get-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/get-call" +title: "getCall" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::getCall" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `getCall` + +## Signature + +```php +public function getCall(string $callId): ?SignalWire\Relay\Call +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Call` + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 757. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/get-calls.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/get-calls.mdx new file mode 100644 index 0000000000..1a1e1fccd5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/get-calls.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/get-calls" +title: "getCalls" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::getCalls" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `getCalls` + +## Signature + +```php +public function getCalls(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 765. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/get-messages.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/get-messages.mdx new file mode 100644 index 0000000000..725b23493a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/get-messages.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/get-messages" +title: "getMessages" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::getMessages" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `getMessages` + +## Signature + +```php +public function getMessages(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 773. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/handle-event.mdx new file mode 100644 index 0000000000..a22fbeb0af --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::handleEvent" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `handleEvent` + +Route a signalwire.event payload to the appropriate handler. + +## Signature + +```php +public function handleEvent(array $outerParams): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 487. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/handle-message.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/handle-message.mdx new file mode 100644 index 0000000000..5789d9dc21 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/handle-message.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/handle-message" +title: "handleMessage" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::handleMessage" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `handleMessage` + +Parse a raw JSON string from the server and route it. + +## Signature + +```php +public function handleMessage(string $raw): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 440. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/index.mdx new file mode 100644 index 0000000000..5f2f6613f0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/index.mdx @@ -0,0 +1,164 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client" +title: "Client" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\Client" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" +--- +# `Client` + +RELAY Client – manages the WebSocket connection to SignalWire, sends + +JSON-RPC requests, and dispatches inbound events to the correct Call +or Message objects. + +The transport layer (WebSocket send/receive) is abstracted behind +thin methods so that unit tests can subclass or mock without needing +a real WebSocket extension. + +## Signature + +```php +class Client +``` + +## Properties + + + + + + + callId => Call + + + + + + + + + + + + messageId => Message + + + + + + + + + + id => callbacks + + + + tag => dial promise + + + + + + + + + + + + + + +## Methods + + + + + + Send the signalwire.connect RPC to authenticate and bind a session. + + + + Open the WebSocket connection and run the JSON-RPC `signalwire.connect` + + + + Originate an outbound call, blocking until `calling.call.dial` + + + + Gracefully close the connection. + + + + Send a JSON-RPC request and synchronously wait for the matching + + + + + + + + + + Route a signalwire.event payload to the appropriate handler. + + + + Parse a raw JSON string from the server and route it. + + + + Register a handler for inbound calls. + + + + Register a handler for inbound messages. + + + + Read a single inbound frame from the WebSocket and dispatch it. + + + + Subscribe to one or more inbound contexts so that events for those + + + + Reconnect with exponential back-off (1 s -> 30 s cap). + + + + Main event loop – reads messages until disconnect. + + + + Encode and send a JSON message over the WebSocket. Throws if the + + + + Send an acknowledgement (empty result) for a server-initiated request. + + + + Send an outbound message. + + + + Unsubscribe from one or more contexts. + + + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 18. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/on-call.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/on-call.mdx new file mode 100644 index 0000000000..0a3e1d6a3f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/on-call.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/on-call" +title: "onCall" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::onCall" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `onCall` + +Register a handler for inbound calls. + +## Signature + +```php +public function onCall(callable $cb): SignalWire\Relay\Client +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Client` + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 740. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/on-message.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/on-message.mdx new file mode 100644 index 0000000000..d3d6f4a829 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/on-message.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/on-message" +title: "onMessage" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::onMessage" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `onMessage` + +Register a handler for inbound messages. + +## Signature + +```php +public function onMessage(callable $cb): SignalWire\Relay\Client +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Client` + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 749. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/read-once.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/read-once.mdx new file mode 100644 index 0000000000..929f87868f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/read-once.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/read-once" +title: "readOnce" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::readOnce" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `readOnce` + +Read a single inbound frame from the WebSocket and dispatch it. + +Returns silently on a read timeout (no frame within $this->readTimeout +seconds — the run loop will call again). Throws on socket errors so +the run loop can trigger reconnect. + +## Signature + +```php +public function readOnce(): void +``` + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 396. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/receive.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/receive.mdx new file mode 100644 index 0000000000..f6ace83511 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/receive.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/receive" +title: "receive" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::receive" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `receive` + +Subscribe to one or more inbound contexts so that events for those + +contexts are delivered to this client. + +## Signature + +```php +public function receive(array $contexts): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 705. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/reconnect.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/reconnect.mdx new file mode 100644 index 0000000000..fb492aa4b2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/reconnect.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/reconnect" +title: "reconnect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::reconnect" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `reconnect` + +Reconnect with exponential back-off (1 s -> 30 s cap). + +## Signature + +```php +public function reconnect(): void +``` + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 259. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/run.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/run.mdx new file mode 100644 index 0000000000..ece22ec2c2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/run.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/run" +title: "run" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::run" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `run` + +Main event loop – reads messages until disconnect. + +Auto-reconnects with exponential backoff on transport errors, +preserving authorization\_state across reconnects so the server +can fast-path the session resumption. + +## Signature + +```php +public function run(): void +``` + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 285. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/send-ack.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/send-ack.mdx new file mode 100644 index 0000000000..ab7f4fc726 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/send-ack.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/send-ack" +title: "sendAck" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::sendAck" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `sendAck` + +Send an acknowledgement (empty result) for a server-initiated request. + +Best-effort: an ACK that fails because the socket dropped during +the request handling is not propagated as an exception (the run +loop will already trigger reconnect on the next read). + +## Signature + +```php +public function sendAck(string $id): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 420. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/send-message.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/send-message.mdx new file mode 100644 index 0000000000..4330d97b9b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/send-message.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/send-message" +title: "sendMessage" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::sendMessage" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `sendMessage` + +Send an outbound message. + +## Signature + +```php +public function sendMessage(array $params): SignalWire\Relay\Message +``` + +## Parameters + + + Outbound messaging.send params (`to_number`, `from_number`, `body`, `media`, `tags`, `context`). + + +## Returns + +`SignalWire\Relay\Message` — Tracking object for the message lifecycle. The Message starts in `queued` state; subsequent `messaging.state` events from the server progress it through `sent` / `delivered` / `undelivered` / `failed`. + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 673. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/send.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/send.mdx new file mode 100644 index 0000000000..31bc3c10d4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/send.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/send" +title: "send" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::send" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `send` + +Encode and send a JSON message over the WebSocket. Throws if the + +socket is closed; the run loop catches and triggers reconnect. + +## Signature + +```php +public function send(array $msg): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 378. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/client/unreceive.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/unreceive.mdx new file mode 100644 index 0000000000..92e5a855c4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/client/unreceive.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/client/unreceive" +title: "unreceive" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Client::unreceive" + parent: "SignalWire\\Relay\\Client" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php" + visibility: "public" +--- +# `unreceive` + +Unsubscribe from one or more contexts. + +## Signature + +```php +public function unreceive(array $contexts): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Client.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Client.php) + +Line 723. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/construct.mdx new file mode 100644 index 0000000000..be03d5bc3d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/construct.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::__construct" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $controlId, + string $callId, + string $nodeId, + object $client +) +``` + +## Parameters + + + + + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/execute-subcommand.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/execute-subcommand.mdx new file mode 100644 index 0000000000..05232d46f3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/execute-subcommand.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/execute-subcommand" +title: "executeSubcommand" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::executeSubcommand" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `executeSubcommand` + +Send a sub-command RPC through the client. + +The payload always includes control\_id, call\_id, and node\_id so +the server knows which action instance to target. + +## Signature + +```php +public function executeSubcommand(string $method, array $extraParams = array ( +)): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-call-id.mdx new file mode 100644 index 0000000000..4118180523 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::getCallId" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-collect-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-collect-result.mdx new file mode 100644 index 0000000000..837b66f6a0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-collect-result.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/get-collect-result" +title: "getCollectResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::getCollectResult" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCollectResult` + +Return the structured collect result from the payload. + +## Signature + +```php +public function getCollectResult(): ?array +``` + +## Returns + +`?array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 360. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-control-id.mdx new file mode 100644 index 0000000000..a07b7f6d3e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::getControlId" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 102. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-events.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-events.mdx new file mode 100644 index 0000000000..d52d47a099 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/get-events" +title: "getEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::getEvents" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getEvents` + +## Signature + +```php +public function getEvents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-node-id.mdx new file mode 100644 index 0000000000..a72da477cf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::getNodeId" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-payload.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-payload.mdx new file mode 100644 index 0000000000..18b0b369cf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/get-payload" +title: "getPayload" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::getPayload" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getPayload` + +## Signature + +```php +public function getPayload(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-result.mdx new file mode 100644 index 0000000000..059d84fd20 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::getResult" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 81. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-state.mdx new file mode 100644 index 0000000000..1f9f5d1623 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::getState" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-stop-method.mdx new file mode 100644 index 0000000000..abd3c5f439 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/get-stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/get-stop-method" +title: "getStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::getStopMethod" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getStopMethod` + +## Signature + +```php +public function getStopMethod(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 343. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/handle-event.mdx new file mode 100644 index 0000000000..15716a9e85 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/handle-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::handleEvent" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `handleEvent` + +Override: silently ignore intermediate play events that arrive + +during a play\_and\_collect operation. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 369. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/index.mdx new file mode 100644 index 0000000000..2d7e3826d1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/index.mdx @@ -0,0 +1,95 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action" +title: "CollectAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" +--- +# `CollectAction` + +Handle for calling.collect (and play\_and\_collect) operations. + +Note: play\_and\_collect emits intermediate calling.call.play events +that must be silently ignored so they do not pollute the collect +action's state. + +## Signature + +```php +class CollectAction extends Action +``` + +## Inheritance + +**Extends:** [SignalWire\Relay\Action](/reference/php/signal-wire/relay/relay/action) + +## Methods + + + + + + Send a sub-command RPC through the client. + + + + + + Return the structured collect result from the payload. + + + + + + + + + + + + + + + + + + Override: silently ignore intermediate play events that arrive + + + + + + Register a callback to fire when the action completes. + + + + Mark this action as completed. + + + + + + Notify the server to start input timers now rather than waiting + + + + Stop the running action by sending its stop sub-command. + + + + Block until the action completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 328. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/is-done.mdx new file mode 100644 index 0000000000..b36d198f5c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::isDone" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/on-completed.mdx new file mode 100644 index 0000000000..4337eb8258 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::onCompleted" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the action completes. + +If the action is already done the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Action +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Action` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/resolve.mdx new file mode 100644 index 0000000000..592ec2104d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::resolve" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +The optional $result is stored and the onCompleted callback is +fired exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/set-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/set-stop-method.mdx new file mode 100644 index 0000000000..920f3e672b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/set-stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/set-stop-method" +title: "setStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::setStopMethod" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `setStopMethod` + +## Signature + +```php +public function setStopMethod(string $method): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 338. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/start-input-timers.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..d3792d97eb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/start-input-timers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/start-input-timers" +title: "startInputTimers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::startInputTimers" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `startInputTimers` + +Notify the server to start input timers now rather than waiting + +for the initial-timeout to expire naturally. + +## Signature + +```php +public function startInputTimers(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 352. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/stop.mdx new file mode 100644 index 0000000000..1192b4c46f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::stop" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```php +public function stop(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/wait.mdx new file mode 100644 index 0000000000..958f64bfec --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/collect-action/wait.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/collect-action/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\CollectAction::wait" + parent: "SignalWire\\Relay\\CollectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `wait` + +Block until the action completes or $timeout seconds elapse. + +Each iteration calls $client->readOnce() so the event-loop +keeps processing inbound frames. + +Returns the resolving Event when the action completes (mirrors +Python's `return self._wait_event.wait()`). Returns null on +timeout. The numeric `$timeout` is interpreted as seconds and +accepts integers or floats. + +## Signature + +```php +public function wait(int|float $timeout = 30): ?SignalWire\Relay\Event +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/constants/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/constants/index.mdx new file mode 100644 index 0000000000..643b151594 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/constants/index.mdx @@ -0,0 +1,140 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/constants" +title: "Constants" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\Constants" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Constants.php" +--- +# `Constants` + +**Modifiers:** `final` + +## Signature + +```php +final class Constants +``` + +## Constants + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Relay/Constants.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Constants.php) + +Line 7. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/construct.mdx new file mode 100644 index 0000000000..0c33cef7c9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/construct.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::__construct" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $controlId, + string $callId, + string $nodeId, + object $client +) +``` + +## Parameters + + + + + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/execute-subcommand.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/execute-subcommand.mdx new file mode 100644 index 0000000000..8c21d25863 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/execute-subcommand.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/execute-subcommand" +title: "executeSubcommand" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::executeSubcommand" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `executeSubcommand` + +Send a sub-command RPC through the client. + +The payload always includes control\_id, call\_id, and node\_id so +the server knows which action instance to target. + +## Signature + +```php +public function executeSubcommand(string $method, array $extraParams = array ( +)): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-call-id.mdx new file mode 100644 index 0000000000..e6bb8911a3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::getCallId" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-control-id.mdx new file mode 100644 index 0000000000..1b69744a8c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::getControlId" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 102. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-detect-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-detect-result.mdx new file mode 100644 index 0000000000..00207026c4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-detect-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/get-detect-result" +title: "getDetectResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::getDetectResult" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getDetectResult` + +## Signature + +```php +public function getDetectResult(): ?array +``` + +## Returns + +`?array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 389. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-events.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-events.mdx new file mode 100644 index 0000000000..59f16acefb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/get-events" +title: "getEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::getEvents" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getEvents` + +## Signature + +```php +public function getEvents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-node-id.mdx new file mode 100644 index 0000000000..17767c7625 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::getNodeId" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-payload.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-payload.mdx new file mode 100644 index 0000000000..05c5ed0b38 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/get-payload" +title: "getPayload" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::getPayload" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getPayload` + +## Signature + +```php +public function getPayload(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-result.mdx new file mode 100644 index 0000000000..c6c763ea72 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::getResult" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 81. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-state.mdx new file mode 100644 index 0000000000..acca520143 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::getState" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-stop-method.mdx new file mode 100644 index 0000000000..bf891b90b2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/get-stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/get-stop-method" +title: "getStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::getStopMethod" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getStopMethod` + +## Signature + +```php +public function getStopMethod(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 384. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/handle-event.mdx new file mode 100644 index 0000000000..87959fd3ff --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::handleEvent" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `handleEvent` + +Append an incoming event and update local state / payload. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/index.mdx new file mode 100644 index 0000000000..fe121859c2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action" +title: "DetectAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" +--- +# `DetectAction` + +Handle for calling.detect operations (fax-tone, digit, machine, etc.). + +## Signature + +```php +class DetectAction extends Action +``` + +## Inheritance + +**Extends:** [SignalWire\Relay\Action](/reference/php/signal-wire/relay/relay/action) + +## Methods + + + + + + Send a sub-command RPC through the client. + + + + + + + + + + + + + + + + + + + + + + Append an incoming event and update local state / payload. + + + + + + Register a callback to fire when the action completes. + + + + Mark this action as completed. + + + + Stop the running action by sending its stop sub-command. + + + + Block until the action completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 382. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/is-done.mdx new file mode 100644 index 0000000000..fe2eda9952 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::isDone" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/on-completed.mdx new file mode 100644 index 0000000000..6cd68c78a1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::onCompleted" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the action completes. + +If the action is already done the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Action +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Action` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/resolve.mdx new file mode 100644 index 0000000000..403b8ebf85 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::resolve" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +The optional $result is stored and the onCompleted callback is +fired exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/stop.mdx new file mode 100644 index 0000000000..ebb39f78e4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::stop" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```php +public function stop(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/wait.mdx new file mode 100644 index 0000000000..e7753aed09 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/detect-action/wait.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/detect-action/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\DetectAction::wait" + parent: "SignalWire\\Relay\\DetectAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `wait` + +Block until the action completes or $timeout seconds elapse. + +Each iteration calls $client->readOnce() so the event-loop +keeps processing inbound frames. + +Returns the resolving Event when the action completes (mirrors +Python's `return self._wait_event.wait()`). Returns null on +timeout. The numeric `$timeout` is interpreted as seconds and +accepts integers or floats. + +## Signature + +```php +public function wait(int|float $timeout = 30): ?SignalWire\Relay\Event +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/construct.mdx new file mode 100644 index 0000000000..e848a10c98 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/construct.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Event::__construct" + parent: "SignalWire\\Relay\\Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(string $eventType, array $params, float $timestamp = 0.0) +``` + +## Parameters + + + + + + + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-call-id.mdx new file mode 100644 index 0000000000..c8b1db994d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Event::getCallId" + parent: "SignalWire\\Relay\\Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-control-id.mdx new file mode 100644 index 0000000000..a297cfb569 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Event::getControlId" + parent: "SignalWire\\Relay\\Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 45. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-event-type.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-event-type.mdx new file mode 100644 index 0000000000..4c75af3408 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-event-type.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event/get-event-type" +title: "getEventType" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Event::getEventType" + parent: "SignalWire\\Relay\\Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" + visibility: "public" +--- +# `getEventType` + +## Signature + +```php +public function getEventType(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 20. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-node-id.mdx new file mode 100644 index 0000000000..35f055d0dd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Event::getNodeId" + parent: "SignalWire\\Relay\\Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 40. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-params.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-params.mdx new file mode 100644 index 0000000000..6abd170611 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event/get-params" +title: "getParams" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Event::getParams" + parent: "SignalWire\\Relay\\Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" + visibility: "public" +--- +# `getParams` + +## Signature + +```php +public function getParams(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 30. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-state.mdx new file mode 100644 index 0000000000..9244b9f2cb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Event::getState" + parent: "SignalWire\\Relay\\Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 55. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-tag.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-tag.mdx new file mode 100644 index 0000000000..f168109f0a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-tag.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event/get-tag" +title: "getTag" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Event::getTag" + parent: "SignalWire\\Relay\\Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" + visibility: "public" +--- +# `getTag` + +## Signature + +```php +public function getTag(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 50. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-timestamp.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-timestamp.mdx new file mode 100644 index 0000000000..a77fd331f2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/get-timestamp.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event/get-timestamp" +title: "getTimestamp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Event::getTimestamp" + parent: "SignalWire\\Relay\\Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" + visibility: "public" +--- +# `getTimestamp` + +## Signature + +```php +public function getTimestamp(): float +``` + +## Returns + +`float` + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 25. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/index.mdx new file mode 100644 index 0000000000..c4ef6e5e4e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event" +title: "Event" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\Event" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" +--- +# `Event` + +## Signature + +```php +class Event +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 7. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/parse.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/parse.mdx new file mode 100644 index 0000000000..b818cffc1a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/parse.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event/parse" +title: "parse" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Event::parse" + parent: "SignalWire\\Relay\\Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" + visibility: "public" +--- +# `parse` + +**Modifiers:** `static` + +## Signature + +```php +public static function parse(string $eventType, array $params): SignalWire\Relay\Event +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 69. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/event/to-array.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/to-array.mdx new file mode 100644 index 0000000000..5a11389785 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/event/to-array.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/event/to-array" +title: "toArray" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Event::toArray" + parent: "SignalWire\\Relay\\Event" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php" + visibility: "public" +--- +# `toArray` + +## Signature + +```php +public function toArray(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Event.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Event.php) + +Line 60. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/construct.mdx new file mode 100644 index 0000000000..423e26a88f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/construct.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::__construct" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $controlId, + string $callId, + string $nodeId, + object $client, + string $faxType = 'send' +) +``` + +## Parameters + + + + + + + + + + + 'send' or 'receive' + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 405. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/execute-subcommand.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/execute-subcommand.mdx new file mode 100644 index 0000000000..2ea0920e3c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/execute-subcommand.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/execute-subcommand" +title: "executeSubcommand" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::executeSubcommand" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `executeSubcommand` + +Send a sub-command RPC through the client. + +The payload always includes control\_id, call\_id, and node\_id so +the server knows which action instance to target. + +## Signature + +```php +public function executeSubcommand(string $method, array $extraParams = array ( +)): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-call-id.mdx new file mode 100644 index 0000000000..b9d830092c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::getCallId" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-control-id.mdx new file mode 100644 index 0000000000..9d904d4d2e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::getControlId" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 102. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-events.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-events.mdx new file mode 100644 index 0000000000..e66be89f67 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/get-events" +title: "getEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::getEvents" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getEvents` + +## Signature + +```php +public function getEvents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-fax-type.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-fax-type.mdx new file mode 100644 index 0000000000..75ddb3b177 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-fax-type.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/get-fax-type" +title: "getFaxType" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::getFaxType" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getFaxType` + +## Signature + +```php +public function getFaxType(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 416. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-node-id.mdx new file mode 100644 index 0000000000..c64de206d9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::getNodeId" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-payload.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-payload.mdx new file mode 100644 index 0000000000..b7e6be66c0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/get-payload" +title: "getPayload" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::getPayload" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getPayload` + +## Signature + +```php +public function getPayload(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-result.mdx new file mode 100644 index 0000000000..c3c5ba95e7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::getResult" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 81. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-state.mdx new file mode 100644 index 0000000000..02fbbc5b7c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::getState" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-stop-method.mdx new file mode 100644 index 0000000000..33eb512b3b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/get-stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/get-stop-method" +title: "getStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::getStopMethod" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getStopMethod` + +## Signature + +```php +public function getStopMethod(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 421. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/handle-event.mdx new file mode 100644 index 0000000000..cd02981abb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::handleEvent" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `handleEvent` + +Append an incoming event and update local state / payload. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/index.mdx new file mode 100644 index 0000000000..b90db645e2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action" +title: "FaxAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" +--- +# `FaxAction` + +Handle for calling.fax operations (send or receive). + +## Signature + +```php +class FaxAction extends Action +``` + +## Inheritance + +**Extends:** [SignalWire\Relay\Action](/reference/php/signal-wire/relay/relay/action) + +## Methods + + + + + + Send a sub-command RPC through the client. + + + + + + + + + + + + + + + + + + + + + + Append an incoming event and update local state / payload. + + + + + + Register a callback to fire when the action completes. + + + + Mark this action as completed. + + + + Stop the running action by sending its stop sub-command. + + + + Block until the action completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 398. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/is-done.mdx new file mode 100644 index 0000000000..6b58d9e5c9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::isDone" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/on-completed.mdx new file mode 100644 index 0000000000..2654575d10 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::onCompleted" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the action completes. + +If the action is already done the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Action +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Action` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/resolve.mdx new file mode 100644 index 0000000000..f9200ccf5d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::resolve" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +The optional $result is stored and the onCompleted callback is +fired exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/stop.mdx new file mode 100644 index 0000000000..e076e63442 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::stop" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```php +public function stop(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/wait.mdx new file mode 100644 index 0000000000..3caea72154 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/fax-action/wait.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/fax-action/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\FaxAction::wait" + parent: "SignalWire\\Relay\\FaxAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `wait` + +Block until the action completes or $timeout seconds elapse. + +Each iteration calls $client->readOnce() so the event-loop +keeps processing inbound frames. + +Returns the resolving Event when the action completes (mirrors +Python's `return self._wait_event.wait()`). Returns null on +timeout. The numeric `$timeout` is interpreted as seconds and +accepts integers or floats. + +## Signature + +```php +public function wait(int|float $timeout = 30): ?SignalWire\Relay\Event +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/index.mdx new file mode 100644 index 0000000000..940eb41caa --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/index.mdx @@ -0,0 +1,91 @@ +--- +slug: "/reference/php/signal-wire/relay/relay" +title: "Relay" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\Relay" + module: "SignalWire.Relay" +--- +# `Relay` + +## Signature + +```php +namespace SignalWire\Relay +``` + +## Classes + + + + Base class for all RELAY call actions (play, record, collect, etc.). + + + + Handle for calling.ai operations. + + + + Represents a RELAY voice call. + + + + RELAY Client – manages the WebSocket connection to SignalWire, sends + + + + Handle for calling.collect (and play\_and\_collect) operations. + + + + + + Handle for calling.detect operations (fax-tone, digit, machine, etc.). + + + + + + Handle for calling.fax operations (send or receive). + + + + Represents a RELAY messaging message (SMS / MMS). + + + + Handle for calling.pay operations. + + + + Handle for calling.play operations. + + + + Handle for calling.record operations. + + + + Exception type for RELAY-protocol-level failures. + + + + Handle for calling.stream operations. + + + + Handle for calling.tap operations. + + + + Handle for calling.transcribe operations. + + + + Minimal RFC 6455 WebSocket client built on PHP streams. + + diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/construct.mdx new file mode 100644 index 0000000000..dcf446e079 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/construct.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::__construct" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `__construct` + +Build a Message from a params array (as returned by the server). + +Expected keys (all optional with sane defaults): +message\_id, context, direction, from\_number / from, +to\_number / to, body, media, tags, state, reason + +## Signature + +```php +public function __construct(array $params = array ( +)) +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 46. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/dispatch-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/dispatch-event.mdx new file mode 100644 index 0000000000..924ce8699e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/dispatch-event.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/dispatch-event" +title: "dispatchEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::dispatchEvent" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `dispatchEvent` + +Process an inbound event for this message. + +Updates state/reason, fires any registered event listeners, and +auto-resolves the message when it reaches a terminal state. + +Accepts both `state` and `message_state` keys on the event +payload — production RELAY emits `message_state` while older +fixtures use `state`. + +## Signature + +```php +public function dispatchEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 74. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-body.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-body.mdx new file mode 100644 index 0000000000..63a1f2e6ee --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/get-body" +title: "getBody" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::getBody" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `getBody` + +## Signature + +```php +public function getBody(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 205. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-context.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-context.mdx new file mode 100644 index 0000000000..a8508c20b9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/get-context" +title: "getContext" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::getContext" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `getContext` + +## Signature + +```php +public function getContext(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 185. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-direction.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-direction.mdx new file mode 100644 index 0000000000..11c94d15bc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-direction.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/get-direction" +title: "getDirection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::getDirection" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `getDirection` + +## Signature + +```php +public function getDirection(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 190. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-from-number.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-from-number.mdx new file mode 100644 index 0000000000..1c4adda5d0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-from-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/get-from-number" +title: "getFromNumber" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::getFromNumber" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `getFromNumber` + +## Signature + +```php +public function getFromNumber(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 195. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-media.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-media.mdx new file mode 100644 index 0000000000..586671affb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-media.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/get-media" +title: "getMedia" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::getMedia" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `getMedia` + +## Signature + +```php +public function getMedia(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 210. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-message-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-message-id.mdx new file mode 100644 index 0000000000..6f2c52f3c6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-message-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/get-message-id" +title: "getMessageId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::getMessageId" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `getMessageId` + +## Signature + +```php +public function getMessageId(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 180. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-reason.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-reason.mdx new file mode 100644 index 0000000000..433ef8c8b8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-reason.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/get-reason" +title: "getReason" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::getReason" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `getReason` + +## Signature + +```php +public function getReason(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 225. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-result.mdx new file mode 100644 index 0000000000..d2407f4ebc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::getResult" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 231. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-state.mdx new file mode 100644 index 0000000000..a5cdea3129 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::getState" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 220. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-tags.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-tags.mdx new file mode 100644 index 0000000000..833ca6cbdf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-tags.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/get-tags" +title: "getTags" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::getTags" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `getTags` + +## Signature + +```php +public function getTags(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 215. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-to-number.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-to-number.mdx new file mode 100644 index 0000000000..999e769fc3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/get-to-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/get-to-number" +title: "getToNumber" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::getToNumber" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `getToNumber` + +## Signature + +```php +public function getToNumber(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 200. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/handle-event.mdx new file mode 100644 index 0000000000..8e9c17e3ec --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/handle-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::handleEvent" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `handleEvent` + +Alias for `dispatchEvent` so the Client's event router (which + +calls `handleEvent` for symmetry with Action) doesn't need a +special case. Both names route the same way. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/index.mdx new file mode 100644 index 0000000000..23c5559d44 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/index.mdx @@ -0,0 +1,90 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message" +title: "Message" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\Message" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" +--- +# `Message` + +Represents a RELAY messaging message (SMS / MMS). + +A Message is created when you send or receive a message through the +RELAY messaging namespace. It accumulates state-change events and +resolves once the message reaches a terminal state (delivered, +undelivered, or failed). + +## Signature + +```php +class Message +``` + +## Methods + + + + Build a Message from a params array (as returned by the server). + + + + Process an inbound event for this message. + + + + + + + + + + + + + + + + + + + + + + + + + + Alias for `dispatchEvent` so the Client's event router (which + + + + + + Register a listener that fires on every state-change event. + + + + Register a callback to fire when the message reaches a terminal state. + + + + Mark this message as completed. + + + + Block until the message completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/is-done.mdx new file mode 100644 index 0000000000..298af06e9d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::isDone" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 175. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/on-completed.mdx new file mode 100644 index 0000000000..45f2ba8889 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::onCompleted" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the message reaches a terminal state. + +If the message is already complete the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Message +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Message` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 160. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/on.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/on.mdx new file mode 100644 index 0000000000..1b9ce800a4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/on.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/on" +title: "on" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::on" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `on` + +Register a listener that fires on every state-change event. + +## Signature + +```php +public function on(callable $cb): SignalWire\Relay\Message +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Message` + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 149. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/resolve.mdx new file mode 100644 index 0000000000..685e87fcf4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::resolve" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `resolve` + +Mark this message as completed. + +The optional $result is stored and the onCompleted callback fires +exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 248. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/message/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/wait.mdx new file mode 100644 index 0000000000..731eebe9a4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/message/wait.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/message/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\Message::wait" + parent: "SignalWire\\Relay\\Message" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php" + visibility: "public" +--- +# `wait` + +Block until the message completes or $timeout seconds elapse. + +The caller is expected to feed events into dispatchEvent() from +another mechanism (e.g. the client's read loop). This method +simply spins until completion. + +## Signature + +```php +public function wait(int $timeout = 30) +``` + +## Parameters + + + +## Returns + +`mixed` — The resolved result, or null on timeout. + +## Source + +[`SignalWire/Relay/Message.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Message.php) + +Line 130. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/construct.mdx new file mode 100644 index 0000000000..c8861fd382 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/construct.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::__construct" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $controlId, + string $callId, + string $nodeId, + object $client +) +``` + +## Parameters + + + + + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/execute-subcommand.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/execute-subcommand.mdx new file mode 100644 index 0000000000..c19a6752ba --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/execute-subcommand.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/execute-subcommand" +title: "executeSubcommand" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::executeSubcommand" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `executeSubcommand` + +Send a sub-command RPC through the client. + +The payload always includes control\_id, call\_id, and node\_id so +the server knows which action instance to target. + +## Signature + +```php +public function executeSubcommand(string $method, array $extraParams = array ( +)): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-call-id.mdx new file mode 100644 index 0000000000..12ba6b8552 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::getCallId" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-control-id.mdx new file mode 100644 index 0000000000..1b84a4eaf0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::getControlId" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 102. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-events.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-events.mdx new file mode 100644 index 0000000000..43c649bf89 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/get-events" +title: "getEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::getEvents" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getEvents` + +## Signature + +```php +public function getEvents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-node-id.mdx new file mode 100644 index 0000000000..a81bbff676 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::getNodeId" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-payload.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-payload.mdx new file mode 100644 index 0000000000..2b5656425a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/get-payload" +title: "getPayload" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::getPayload" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getPayload` + +## Signature + +```php +public function getPayload(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-result.mdx new file mode 100644 index 0000000000..835010ef93 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::getResult" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 81. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-state.mdx new file mode 100644 index 0000000000..ac34524885 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::getState" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-stop-method.mdx new file mode 100644 index 0000000000..113e59156c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/get-stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/get-stop-method" +title: "getStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::getStopMethod" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getStopMethod` + +## Signature + +```php +public function getStopMethod(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 456. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/handle-event.mdx new file mode 100644 index 0000000000..7423293093 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::handleEvent" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `handleEvent` + +Append an incoming event and update local state / payload. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/index.mdx new file mode 100644 index 0000000000..4c63c584a9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action" +title: "PayAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" +--- +# `PayAction` + +Handle for calling.pay operations. + +## Signature + +```php +class PayAction extends Action +``` + +## Inheritance + +**Extends:** [SignalWire\Relay\Action](/reference/php/signal-wire/relay/relay/action) + +## Methods + + + + + + Send a sub-command RPC through the client. + + + + + + + + + + + + + + + + + + + + Append an incoming event and update local state / payload. + + + + + + Register a callback to fire when the action completes. + + + + Mark this action as completed. + + + + Stop the running action by sending its stop sub-command. + + + + Block until the action completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 454. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/is-done.mdx new file mode 100644 index 0000000000..5c60a68790 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::isDone" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/on-completed.mdx new file mode 100644 index 0000000000..9e22b050cc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::onCompleted" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the action completes. + +If the action is already done the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Action +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Action` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/resolve.mdx new file mode 100644 index 0000000000..bcaed3e42c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::resolve" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +The optional $result is stored and the onCompleted callback is +fired exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/stop.mdx new file mode 100644 index 0000000000..63c6fa5654 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::stop" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```php +public function stop(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/wait.mdx new file mode 100644 index 0000000000..c585200b18 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/pay-action/wait.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/pay-action/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PayAction::wait" + parent: "SignalWire\\Relay\\PayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `wait` + +Block until the action completes or $timeout seconds elapse. + +Each iteration calls $client->readOnce() so the event-loop +keeps processing inbound frames. + +Returns the resolving Event when the action completes (mirrors +Python's `return self._wait_event.wait()`). Returns null on +timeout. The numeric `$timeout` is interpreted as seconds and +accepts integers or floats. + +## Signature + +```php +public function wait(int|float $timeout = 30): ?SignalWire\Relay\Event +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/construct.mdx new file mode 100644 index 0000000000..9c4b58b571 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/construct.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::__construct" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $controlId, + string $callId, + string $nodeId, + object $client +) +``` + +## Parameters + + + + + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/execute-subcommand.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/execute-subcommand.mdx new file mode 100644 index 0000000000..a9020c6618 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/execute-subcommand.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/execute-subcommand" +title: "executeSubcommand" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::executeSubcommand" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `executeSubcommand` + +Send a sub-command RPC through the client. + +The payload always includes control\_id, call\_id, and node\_id so +the server knows which action instance to target. + +## Signature + +```php +public function executeSubcommand(string $method, array $extraParams = array ( +)): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-call-id.mdx new file mode 100644 index 0000000000..4e2fbc170f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::getCallId" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-control-id.mdx new file mode 100644 index 0000000000..3ea7f9f81a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::getControlId" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 102. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-events.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-events.mdx new file mode 100644 index 0000000000..d547014340 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/get-events" +title: "getEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::getEvents" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getEvents` + +## Signature + +```php +public function getEvents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-node-id.mdx new file mode 100644 index 0000000000..56043b5257 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::getNodeId" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-payload.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-payload.mdx new file mode 100644 index 0000000000..eeeda94ee8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/get-payload" +title: "getPayload" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::getPayload" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getPayload` + +## Signature + +```php +public function getPayload(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-result.mdx new file mode 100644 index 0000000000..70bf2116d9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::getResult" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 81. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-state.mdx new file mode 100644 index 0000000000..4f8ca9999b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::getState" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-stop-method.mdx new file mode 100644 index 0000000000..53da13955b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/get-stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/get-stop-method" +title: "getStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::getStopMethod" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getStopMethod` + +## Signature + +```php +public function getStopMethod(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 251. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/handle-event.mdx new file mode 100644 index 0000000000..f0fe67f926 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::handleEvent" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `handleEvent` + +Append an incoming event and update local state / payload. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/index.mdx new file mode 100644 index 0000000000..29ece7d92a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/index.mdx @@ -0,0 +1,89 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action" +title: "PlayAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" +--- +# `PlayAction` + +Handle for calling.play operations. + +## Signature + +```php +class PlayAction extends Action +``` + +## Inheritance + +**Extends:** [SignalWire\Relay\Action](/reference/php/signal-wire/relay/relay/action) + +## Methods + + + + + + Send a sub-command RPC through the client. + + + + + + + + + + + + + + + + + + + + Append an incoming event and update local state / payload. + + + + + + Register a callback to fire when the action completes. + + + + + + Mark this action as completed. + + + + + + Stop the running action by sending its stop sub-command. + + + + Adjust playback volume. + + + + Block until the action completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 249. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/is-done.mdx new file mode 100644 index 0000000000..fa00b2280f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::isDone" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/on-completed.mdx new file mode 100644 index 0000000000..fcb7559201 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::onCompleted" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the action completes. + +If the action is already done the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Action +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Action` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/pause.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/pause.mdx new file mode 100644 index 0000000000..f1a696353f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/pause.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/pause" +title: "pause" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::pause" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `pause` + +## Signature + +```php +public function pause(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 256. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/resolve.mdx new file mode 100644 index 0000000000..423095a671 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::resolve" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +The optional $result is stored and the onCompleted callback is +fired exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/resume.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/resume.mdx new file mode 100644 index 0000000000..4d73081b4c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/resume.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/resume" +title: "resume" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::resume" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resume` + +## Signature + +```php +public function resume(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 261. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/stop.mdx new file mode 100644 index 0000000000..2d0fc8a0b8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::stop" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```php +public function stop(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/volume.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/volume.mdx new file mode 100644 index 0000000000..52018ebf79 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/volume.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/volume" +title: "volume" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::volume" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `volume` + +Adjust playback volume. + +## Signature + +```php +public function volume(float $db): void +``` + +## Parameters + + + Volume adjustment in dB (e.g. -4.0 or 6.0). + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 271. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/wait.mdx new file mode 100644 index 0000000000..0f800311b9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/play-action/wait.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/play-action/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\PlayAction::wait" + parent: "SignalWire\\Relay\\PlayAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `wait` + +Block until the action completes or $timeout seconds elapse. + +Each iteration calls $client->readOnce() so the event-loop +keeps processing inbound frames. + +Returns the resolving Event when the action completes (mirrors +Python's `return self._wait_event.wait()`). Returns null on +timeout. The numeric `$timeout` is interpreted as seconds and +accepts integers or floats. + +## Signature + +```php +public function wait(int|float $timeout = 30): ?SignalWire\Relay\Event +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/construct.mdx new file mode 100644 index 0000000000..008e4d43bb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/construct.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::__construct" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $controlId, + string $callId, + string $nodeId, + object $client +) +``` + +## Parameters + + + + + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/execute-subcommand.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/execute-subcommand.mdx new file mode 100644 index 0000000000..1a659d2824 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/execute-subcommand.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/execute-subcommand" +title: "executeSubcommand" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::executeSubcommand" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `executeSubcommand` + +Send a sub-command RPC through the client. + +The payload always includes control\_id, call\_id, and node\_id so +the server knows which action instance to target. + +## Signature + +```php +public function executeSubcommand(string $method, array $extraParams = array ( +)): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-call-id.mdx new file mode 100644 index 0000000000..2de159c25a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::getCallId" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-control-id.mdx new file mode 100644 index 0000000000..4465ff12cd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::getControlId" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 102. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-duration.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-duration.mdx new file mode 100644 index 0000000000..a2b42ea419 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-duration.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/get-duration" +title: "getDuration" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::getDuration" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getDuration` + +## Signature + +```php +public function getDuration(): ?float +``` + +## Returns + +`?float` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 308. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-events.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-events.mdx new file mode 100644 index 0000000000..03479823c5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/get-events" +title: "getEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::getEvents" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getEvents` + +## Signature + +```php +public function getEvents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-node-id.mdx new file mode 100644 index 0000000000..0ba53c4c11 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::getNodeId" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-payload.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-payload.mdx new file mode 100644 index 0000000000..ac5d879dc8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/get-payload" +title: "getPayload" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::getPayload" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getPayload` + +## Signature + +```php +public function getPayload(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-result.mdx new file mode 100644 index 0000000000..241c298478 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::getResult" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 81. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-size.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-size.mdx new file mode 100644 index 0000000000..d62290ea1e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-size.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/get-size" +title: "getSize" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::getSize" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getSize` + +## Signature + +```php +public function getSize(): ?int +``` + +## Returns + +`?int` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 314. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-state.mdx new file mode 100644 index 0000000000..3bc0bf1631 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::getState" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-stop-method.mdx new file mode 100644 index 0000000000..2f29389a33 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/get-stop-method" +title: "getStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::getStopMethod" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getStopMethod` + +## Signature + +```php +public function getStopMethod(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 284. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-url.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-url.mdx new file mode 100644 index 0000000000..54623d1fe2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/get-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/get-url" +title: "getUrl" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::getUrl" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getUrl` + +## Signature + +```php +public function getUrl(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 303. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/handle-event.mdx new file mode 100644 index 0000000000..897e27f22a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::handleEvent" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `handleEvent` + +Append an incoming event and update local state / payload. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/index.mdx new file mode 100644 index 0000000000..09b7308f1c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/index.mdx @@ -0,0 +1,91 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action" +title: "RecordAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" +--- +# `RecordAction` + +Handle for calling.record operations. + +## Signature + +```php +class RecordAction extends Action +``` + +## Inheritance + +**Extends:** [SignalWire\Relay\Action](/reference/php/signal-wire/relay/relay/action) + +## Methods + + + + + + Send a sub-command RPC through the client. + + + + + + + + + + + + + + + + + + + + + + + + + + Append an incoming event and update local state / payload. + + + + + + Register a callback to fire when the action completes. + + + + + + Mark this action as completed. + + + + + + Stop the running action by sending its stop sub-command. + + + + Block until the action completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 282. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/is-done.mdx new file mode 100644 index 0000000000..7b67845fb8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::isDone" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/on-completed.mdx new file mode 100644 index 0000000000..1c833d5721 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::onCompleted" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the action completes. + +If the action is already done the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Action +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Action` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/pause.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/pause.mdx new file mode 100644 index 0000000000..3a458edad8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/pause.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/pause" +title: "pause" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::pause" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `pause` + +## Signature + +```php +public function pause(array $extra = array ( +)): void +``` + +## Parameters + + + Additional params to merge onto the wire (e.g. `['behavior' => 'continuous']`). + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 293. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/resolve.mdx new file mode 100644 index 0000000000..e70ade8458 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::resolve" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +The optional $result is stored and the onCompleted callback is +fired exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/resume.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/resume.mdx new file mode 100644 index 0000000000..26ea8b9d99 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/resume.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/resume" +title: "resume" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::resume" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resume` + +## Signature + +```php +public function resume(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 298. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/stop.mdx new file mode 100644 index 0000000000..d145885f3d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::stop" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```php +public function stop(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/wait.mdx new file mode 100644 index 0000000000..e489512788 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/record-action/wait.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/record-action/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\RecordAction::wait" + parent: "SignalWire\\Relay\\RecordAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `wait` + +Block until the action completes or $timeout seconds elapse. + +Each iteration calls $client->readOnce() so the event-loop +keeps processing inbound frames. + +Returns the resolving Event when the action completes (mirrors +Python's `return self._wait_event.wait()`). Returns null on +timeout. The numeric `$timeout` is interpreted as seconds and +accepts integers or floats. + +## Signature + +```php +public function wait(int|float $timeout = 30): ?SignalWire\Relay\Event +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/relay-error/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/relay-error/index.mdx new file mode 100644 index 0000000000..59a0a4401c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/relay-error/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/relay-error" +title: "RelayError" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\RelayError" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/RelayError.php" +--- +# `RelayError` + +Exception type for RELAY-protocol-level failures. + +Mirrors signalwire.relay.client.RelayError in the Python SDK: raised +when a JSON-RPC response carries an `error` field, when a dial +resolves to a failure outcome, or when an SDK-side timeout fires. + +The numeric code field carries the JSON-RPC error code where +applicable (e.g. -32601 method-not-found from the server) or an +SDK-defined sentinel (e.g. 408 for client-side timeout). + +## Signature + +```php +class RelayError extends RuntimeException implements Stringable, Throwable +``` + +## Inheritance + +**Extends:** `RuntimeException` + +**Implements:** `Stringable`, `Throwable` + +## Source + +[`SignalWire/Relay/RelayError.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/RelayError.php) + +Line 18. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/construct.mdx new file mode 100644 index 0000000000..60010e311b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/construct.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::__construct" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $controlId, + string $callId, + string $nodeId, + object $client +) +``` + +## Parameters + + + + + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/execute-subcommand.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/execute-subcommand.mdx new file mode 100644 index 0000000000..febd5e3d65 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/execute-subcommand.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/execute-subcommand" +title: "executeSubcommand" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::executeSubcommand" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `executeSubcommand` + +Send a sub-command RPC through the client. + +The payload always includes control\_id, call\_id, and node\_id so +the server knows which action instance to target. + +## Signature + +```php +public function executeSubcommand(string $method, array $extraParams = array ( +)): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-call-id.mdx new file mode 100644 index 0000000000..287769cdda --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::getCallId" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-control-id.mdx new file mode 100644 index 0000000000..447607f1c7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::getControlId" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 102. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-events.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-events.mdx new file mode 100644 index 0000000000..08c07a49fc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/get-events" +title: "getEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::getEvents" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getEvents` + +## Signature + +```php +public function getEvents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-node-id.mdx new file mode 100644 index 0000000000..aa8ac589d6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::getNodeId" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-payload.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-payload.mdx new file mode 100644 index 0000000000..08d417963a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/get-payload" +title: "getPayload" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::getPayload" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getPayload` + +## Signature + +```php +public function getPayload(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-result.mdx new file mode 100644 index 0000000000..fadb7ae0c7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::getResult" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 81. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-state.mdx new file mode 100644 index 0000000000..5b6bfa6974 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::getState" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-stop-method.mdx new file mode 100644 index 0000000000..6a251f5398 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/get-stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/get-stop-method" +title: "getStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::getStopMethod" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getStopMethod` + +## Signature + +```php +public function getStopMethod(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 445. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/handle-event.mdx new file mode 100644 index 0000000000..bc6e1f4ed7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::handleEvent" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `handleEvent` + +Append an incoming event and update local state / payload. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/index.mdx new file mode 100644 index 0000000000..e7fd57e7db --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action" +title: "StreamAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" +--- +# `StreamAction` + +Handle for calling.stream operations. + +## Signature + +```php +class StreamAction extends Action +``` + +## Inheritance + +**Extends:** [SignalWire\Relay\Action](/reference/php/signal-wire/relay/relay/action) + +## Methods + + + + + + Send a sub-command RPC through the client. + + + + + + + + + + + + + + + + + + + + Append an incoming event and update local state / payload. + + + + + + Register a callback to fire when the action completes. + + + + Mark this action as completed. + + + + Stop the running action by sending its stop sub-command. + + + + Block until the action completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 443. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/is-done.mdx new file mode 100644 index 0000000000..4f457e23f3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::isDone" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/on-completed.mdx new file mode 100644 index 0000000000..07e6520a6b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::onCompleted" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the action completes. + +If the action is already done the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Action +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Action` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/resolve.mdx new file mode 100644 index 0000000000..a05c561b8f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::resolve" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +The optional $result is stored and the onCompleted callback is +fired exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/stop.mdx new file mode 100644 index 0000000000..bf27ee5a82 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::stop" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```php +public function stop(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/wait.mdx new file mode 100644 index 0000000000..1d2cb5b0f4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/stream-action/wait.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/stream-action/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\StreamAction::wait" + parent: "SignalWire\\Relay\\StreamAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `wait` + +Block until the action completes or $timeout seconds elapse. + +Each iteration calls $client->readOnce() so the event-loop +keeps processing inbound frames. + +Returns the resolving Event when the action completes (mirrors +Python's `return self._wait_event.wait()`). Returns null on +timeout. The numeric `$timeout` is interpreted as seconds and +accepts integers or floats. + +## Signature + +```php +public function wait(int|float $timeout = 30): ?SignalWire\Relay\Event +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/construct.mdx new file mode 100644 index 0000000000..22b29d19c5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/construct.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::__construct" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $controlId, + string $callId, + string $nodeId, + object $client +) +``` + +## Parameters + + + + + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/execute-subcommand.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/execute-subcommand.mdx new file mode 100644 index 0000000000..4bec937349 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/execute-subcommand.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/execute-subcommand" +title: "executeSubcommand" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::executeSubcommand" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `executeSubcommand` + +Send a sub-command RPC through the client. + +The payload always includes control\_id, call\_id, and node\_id so +the server knows which action instance to target. + +## Signature + +```php +public function executeSubcommand(string $method, array $extraParams = array ( +)): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-call-id.mdx new file mode 100644 index 0000000000..3d45a6d19a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::getCallId" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-control-id.mdx new file mode 100644 index 0000000000..2c5fd59bec --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::getControlId" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 102. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-events.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-events.mdx new file mode 100644 index 0000000000..6bea1a17f4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/get-events" +title: "getEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::getEvents" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getEvents` + +## Signature + +```php +public function getEvents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-node-id.mdx new file mode 100644 index 0000000000..85584f5ce0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::getNodeId" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-payload.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-payload.mdx new file mode 100644 index 0000000000..0c98a38089 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/get-payload" +title: "getPayload" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::getPayload" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getPayload` + +## Signature + +```php +public function getPayload(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-result.mdx new file mode 100644 index 0000000000..08cac71a1b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::getResult" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 81. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-state.mdx new file mode 100644 index 0000000000..a726c7f0c4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::getState" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-stop-method.mdx new file mode 100644 index 0000000000..fe0ae7f960 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/get-stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/get-stop-method" +title: "getStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::getStopMethod" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getStopMethod` + +## Signature + +```php +public function getStopMethod(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 434. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/handle-event.mdx new file mode 100644 index 0000000000..398e3c42b7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::handleEvent" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `handleEvent` + +Append an incoming event and update local state / payload. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/index.mdx new file mode 100644 index 0000000000..fa2855a9e0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action" +title: "TapAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" +--- +# `TapAction` + +Handle for calling.tap operations. + +## Signature + +```php +class TapAction extends Action +``` + +## Inheritance + +**Extends:** [SignalWire\Relay\Action](/reference/php/signal-wire/relay/relay/action) + +## Methods + + + + + + Send a sub-command RPC through the client. + + + + + + + + + + + + + + + + + + + + Append an incoming event and update local state / payload. + + + + + + Register a callback to fire when the action completes. + + + + Mark this action as completed. + + + + Stop the running action by sending its stop sub-command. + + + + Block until the action completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 432. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/is-done.mdx new file mode 100644 index 0000000000..bd147788d7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::isDone" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/on-completed.mdx new file mode 100644 index 0000000000..2eef6ea2a9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::onCompleted" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the action completes. + +If the action is already done the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Action +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Action` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/resolve.mdx new file mode 100644 index 0000000000..e223b97d93 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::resolve" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +The optional $result is stored and the onCompleted callback is +fired exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/stop.mdx new file mode 100644 index 0000000000..3cbadfcee1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::stop" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```php +public function stop(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/wait.mdx new file mode 100644 index 0000000000..595222865f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/tap-action/wait.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/tap-action/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TapAction::wait" + parent: "SignalWire\\Relay\\TapAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `wait` + +Block until the action completes or $timeout seconds elapse. + +Each iteration calls $client->readOnce() so the event-loop +keeps processing inbound frames. + +Returns the resolving Event when the action completes (mirrors +Python's `return self._wait_event.wait()`). Returns null on +timeout. The numeric `$timeout` is interpreted as seconds and +accepts integers or floats. + +## Signature + +```php +public function wait(int|float $timeout = 30): ?SignalWire\Relay\Event +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/construct.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/construct.mdx new file mode 100644 index 0000000000..7ce8b2c130 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/construct.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::__construct" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $controlId, + string $callId, + string $nodeId, + object $client +) +``` + +## Parameters + + + + + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/execute-subcommand.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/execute-subcommand.mdx new file mode 100644 index 0000000000..e10ab653d6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/execute-subcommand.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/execute-subcommand" +title: "executeSubcommand" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::executeSubcommand" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `executeSubcommand` + +Send a sub-command RPC through the client. + +The payload always includes control\_id, call\_id, and node\_id so +the server knows which action instance to target. + +## Signature + +```php +public function executeSubcommand(string $method, array $extraParams = array ( +)): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-call-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-call-id.mdx new file mode 100644 index 0000000000..9c5b5abaf9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/get-call-id" +title: "getCallId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::getCallId" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getCallId` + +## Signature + +```php +public function getCallId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-control-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-control-id.mdx new file mode 100644 index 0000000000..70fc2ff3c5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/get-control-id" +title: "getControlId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::getControlId" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getControlId` + +## Signature + +```php +public function getControlId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 102. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-events.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-events.mdx new file mode 100644 index 0000000000..5b099ca466 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/get-events" +title: "getEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::getEvents" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getEvents` + +## Signature + +```php +public function getEvents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-node-id.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-node-id.mdx new file mode 100644 index 0000000000..b2c20997bf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/get-node-id" +title: "getNodeId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::getNodeId" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getNodeId` + +## Signature + +```php +public function getNodeId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-payload.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-payload.mdx new file mode 100644 index 0000000000..c214edc366 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/get-payload" +title: "getPayload" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::getPayload" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getPayload` + +## Signature + +```php +public function getPayload(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-result.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-result.mdx new file mode 100644 index 0000000000..0f97fab6b6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/get-result" +title: "getResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::getResult" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getResult` + +## Signature + +```php +public function getResult() +``` + +## Returns + +`mixed` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 81. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-state.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-state.mdx new file mode 100644 index 0000000000..eba2bec509 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/get-state" +title: "getState" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::getState" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getState` + +## Signature + +```php +public function getState(): ?string +``` + +## Returns + +`?string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-stop-method.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-stop-method.mdx new file mode 100644 index 0000000000..ebc2edf1c7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/get-stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/get-stop-method" +title: "getStopMethod" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::getStopMethod" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `getStopMethod` + +## Signature + +```php +public function getStopMethod(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 467. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/handle-event.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/handle-event.mdx new file mode 100644 index 0000000000..9d91c84944 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/handle-event" +title: "handleEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::handleEvent" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `handleEvent` + +Append an incoming event and update local state / payload. + +## Signature + +```php +public function handleEvent(SignalWire\Relay\Event $event): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/index.mdx new file mode 100644 index 0000000000..d262be5c2a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action" +title: "TranscribeAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" +--- +# `TranscribeAction` + +Handle for calling.transcribe operations. + +## Signature + +```php +class TranscribeAction extends Action +``` + +## Inheritance + +**Extends:** [SignalWire\Relay\Action](/reference/php/signal-wire/relay/relay/action) + +## Methods + + + + + + Send a sub-command RPC through the client. + + + + + + + + + + + + + + + + + + + + Append an incoming event and update local state / payload. + + + + + + Register a callback to fire when the action completes. + + + + Mark this action as completed. + + + + Stop the running action by sending its stop sub-command. + + + + Block until the action completes or $timeout seconds elapse. + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 465. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/is-done.mdx new file mode 100644 index 0000000000..8e2c39073f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::isDone" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/on-completed.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/on-completed.mdx new file mode 100644 index 0000000000..ac40104362 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/on-completed.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/on-completed" +title: "onCompleted" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::onCompleted" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `onCompleted` + +Register a callback to fire when the action completes. + +If the action is already done the callback fires immediately. + +## Signature + +```php +public function onCompleted(callable $cb): SignalWire\Relay\Action +``` + +## Parameters + + + +## Returns + +`SignalWire\Relay\Action` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/resolve.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/resolve.mdx new file mode 100644 index 0000000000..e6fa28adae --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/resolve.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/resolve" +title: "resolve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::resolve" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +The optional $result is stored and the onCompleted callback is +fired exactly once. + +## Signature + +```php +public function resolve($result = NULL): void +``` + +## Parameters + + + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/stop.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/stop.mdx new file mode 100644 index 0000000000..f9d2067dba --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::stop" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```php +public function stop(): void +``` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/wait.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/wait.mdx new file mode 100644 index 0000000000..e29857b6d2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/transcribe-action/wait.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/transcribe-action/wait" +title: "wait" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\TranscribeAction::wait" + parent: "SignalWire\\Relay\\TranscribeAction" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php" + visibility: "public" +--- +# `wait` + +Block until the action completes or $timeout seconds elapse. + +Each iteration calls $client->readOnce() so the event-loop +keeps processing inbound frames. + +Returns the resolving Event when the action completes (mirrors +Python's `return self._wait_event.wait()`). Returns null on +timeout. The numeric `$timeout` is interpreted as seconds and +accepts integers or floats. + +## Signature + +```php +public function wait(int|float $timeout = 30): ?SignalWire\Relay\Event +``` + +## Parameters + + + +## Returns + +`?SignalWire\Relay\Event` + +## Source + +[`SignalWire/Relay/Action.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/Action.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/close.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/close.mdx new file mode 100644 index 0000000000..a79f21bf57 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/close.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/web-socket/close" +title: "close" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\WebSocket::close" + parent: "SignalWire\\Relay\\WebSocket" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php" + visibility: "public" +--- +# `close` + +Send a close frame and tear down the socket. + +## Signature + +```php +public function close(int $code = 1000, string $reason = ''): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Relay/WebSocket.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php) + +Line 132. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/connect.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/connect.mdx new file mode 100644 index 0000000000..158af05fce --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/connect.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/web-socket/connect" +title: "connect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\WebSocket::connect" + parent: "SignalWire\\Relay\\WebSocket" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php" + visibility: "public" +--- +# `connect` + +Open a WebSocket connection to the given URI. + +## Signature + +```php +public function connect( + string $uri, + array $headers = array ( +), + float $timeout = 10.0 +): void +``` + +## Parameters + + + ws:// or wss:// URI (e.g. wss://example.signalwire.com/api/relay/ws). + + + + Additional HTTP headers for the upgrade request. + + + + TCP-connect timeout in seconds. + + +## Throws + +- `\RuntimeException` — on connection or handshake failure. + +## Source + +[`SignalWire/Relay/WebSocket.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/index.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/index.mdx new file mode 100644 index 0000000000..a2f2ebe7ff --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/index.mdx @@ -0,0 +1,87 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/web-socket" +title: "WebSocket" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Relay\\WebSocket" + parent: "SignalWire\\Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php" +--- +# `WebSocket` + +Minimal RFC 6455 WebSocket client built on PHP streams. + +Why this isn't a third-party dep: + +- signalwire-php has no composer.lock and avoids transitive deps + beyond ext-json / ext-openssl / ext-mbstring (see composer.json). +- The RELAY protocol only needs text frames (≤ 64 KiB JSON-RPC + messages) and close frames; binary frames, fragmentation, + continuation, and per-message-deflate are not used. +- We need both blocking reads (during handshake) and non-blocking + poll reads (during the run loop) — straightforward via + stream\_set\_blocking()/stream\_select(). + +Scope: + +- Supports ws:// and wss:// URIs. +- Handshakes per RFC 6455: GET upgrade with random Sec-WebSocket-Key, + verifies Sec-WebSocket-Accept against the magic-GUID SHA-1. +- Encodes outbound text frames with FIN=1, opcode=0x1, mask bit set + (mandatory for client → server) and a fresh 4-byte mask per frame. +- Decodes inbound frames: text (0x1), binary (0x2 — surfaced as + bytes), ping (0x9 — auto-replies with pong), pong (0xA — ignored), + close (0x8 — surfaces a sentinel and drains). +- Honors the 7-bit / 16-bit / 64-bit length encodings. + +NOT IMPLEMENTED (deliberate): + +- Permessage-deflate: RELAY does not negotiate it. +- Fragmented messages: RELAY sends one JSON-RPC message per text + frame. +- WSS certificate pinning beyond stream context defaults. + +## Signature + +```php +class WebSocket +``` + +## Constants + + + Special marker the read loop uses to surface a remote close. + + +## Methods + + + + Send a close frame and tear down the socket. + + + + Open a WebSocket connection to the given URI. + + + + + + Read one complete inbound frame, blocking up to $timeout seconds. + + + + Send a UTF-8 text frame (FIN=1, opcode=0x1, masked). + + + +## Source + +[`SignalWire/Relay/WebSocket.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php) + +Line 37. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/is-connected.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/is-connected.mdx new file mode 100644 index 0000000000..3fc5c44eb5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/is-connected.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/web-socket/is-connected" +title: "isConnected" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\WebSocket::isConnected" + parent: "SignalWire\\Relay\\WebSocket" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php" + visibility: "public" +--- +# `isConnected` + +## Signature + +```php +public function isConnected(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Relay/WebSocket.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php) + +Line 217. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/receive.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/receive.mdx new file mode 100644 index 0000000000..6a355f0c5a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/receive.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/web-socket/receive" +title: "receive" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\WebSocket::receive" + parent: "SignalWire\\Relay\\WebSocket" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php" + visibility: "public" +--- +# `receive` + +Read one complete inbound frame, blocking up to $timeout seconds. + +Returns: + +- the decoded payload string for a text/binary frame +- WebSocket::CLOSE\_FRAME for a close +- null on read timeout (socket still healthy) + Auto-handles ping (replies with pong) and pong (silently consumed) + and re-attempts to deliver the next non-control frame. + +## Signature + +```php +public function receive(float $timeout = 5.0): ?string +``` + +## Parameters + + + +## Returns + +`?string` + +## Throws + +- `\RuntimeException` — on malformed frames or socket errors. + +## Source + +[`SignalWire/Relay/WebSocket.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php) + +Line 159. diff --git a/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/send-text.mdx b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/send-text.mdx new file mode 100644 index 0000000000..9fb2db3cae --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/relay/relay/web-socket/send-text.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/relay/relay/web-socket/send-text" +title: "sendText" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Relay\\WebSocket::sendText" + parent: "SignalWire\\Relay\\WebSocket" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php" + visibility: "public" +--- +# `sendText` + +Send a UTF-8 text frame (FIN=1, opcode=0x1, masked). + +## Signature + +```php +public function sendText(string $payload): void +``` + +## Parameters + + + +## Throws + +- `\RuntimeException` — if the socket is closed or write fails. + +## Source + +[`SignalWire/Relay/WebSocket.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Relay/WebSocket.php) + +Line 120. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/construct.mdx new file mode 100644 index 0000000000..330c4a39b0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/addresses/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Addresses::__construct" + parent: "SignalWire\\REST\\Namespaces\\Addresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/Addresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/create.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/create.mdx new file mode 100644 index 0000000000..bc5b893d6c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/addresses/create" +title: "create" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Addresses::create" + parent: "SignalWire\\REST\\Namespaces\\Addresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php" + visibility: "public" +--- +# `create` + +## Signature + +```php +public function create(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Addresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/delete.mdx new file mode 100644 index 0000000000..08c8bd9b5e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/addresses/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Addresses::delete" + parent: "SignalWire\\REST\\Namespaces\\Addresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $addressId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Addresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php) + +Line 46. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/get-base-path.mdx new file mode 100644 index 0000000000..b2750038e9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/addresses/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Addresses::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\Addresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/Addresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/get.mdx new file mode 100644 index 0000000000..a1077b4738 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/addresses/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Addresses::get" + parent: "SignalWire\\REST\\Namespaces\\Addresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $addressId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Addresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php) + +Line 40. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/index.mdx new file mode 100644 index 0000000000..fa27be1e84 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/addresses" +title: "Addresses" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Addresses" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php" +--- +# `Addresses` + +Addresses namespace — list / create / get / delete (no update). + +## Signature + +```php +class Addresses +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/Addresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/list.mdx new file mode 100644 index 0000000000..ed305669a6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/addresses/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/addresses/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Addresses::list" + parent: "SignalWire\\REST\\Namespaces\\Addresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Addresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Addresses.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-hold.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-hold.mdx new file mode 100644 index 0000000000..fc046d564c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-hold.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-hold" +title: "aiHold" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::aiHold" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `aiHold` + +## Signature + +```php +public function aiHold(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 285. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-message.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-message.mdx new file mode 100644 index 0000000000..f32d69c746 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-message.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-message" +title: "aiMessage" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::aiMessage" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `aiMessage` + +## Signature + +```php +public function aiMessage(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 279. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-stop.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-stop.mdx new file mode 100644 index 0000000000..ec706d8e1b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-stop.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-stop" +title: "aiStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::aiStop" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `aiStop` + +## Signature + +```php +public function aiStop(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 297. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-unhold.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-unhold.mdx new file mode 100644 index 0000000000..2260b455f8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-unhold.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/ai-unhold" +title: "aiUnhold" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::aiUnhold" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `aiUnhold` + +## Signature + +```php +public function aiUnhold(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 291. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/collect-start-input-timers.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/collect-start-input-timers.mdx new file mode 100644 index 0000000000..59a133004f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/collect-start-input-timers.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/collect-start-input-timers" +title: "collectStartInputTimers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::collectStartInputTimers" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `collectStartInputTimers` + +## Signature + +```php +public function collectStartInputTimers( + string $callId, + array $params = array ( +) +): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 189. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/collect-stop.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/collect-stop.mdx new file mode 100644 index 0000000000..be6b872480 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/collect-stop.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/collect-stop" +title: "collectStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::collectStop" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `collectStop` + +## Signature + +```php +public function collectStop(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 183. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/collect.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/collect.mdx new file mode 100644 index 0000000000..f0fd247d8d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/collect.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/collect" +title: "collect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::collect" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `collect` + +## Signature + +```php +public function collect(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 177. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/construct.mdx new file mode 100644 index 0000000000..58b158a897 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::__construct" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $client, string $projectId) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/denoise-stop.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/denoise-stop.mdx new file mode 100644 index 0000000000..2a5d476b52 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/denoise-stop.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/denoise-stop" +title: "denoiseStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::denoiseStop" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `denoiseStop` + +## Signature + +```php +public function denoiseStop(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 253. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/denoise.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/denoise.mdx new file mode 100644 index 0000000000..fee4f63123 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/denoise.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/denoise" +title: "denoise" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::denoise" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `denoise` + +## Signature + +```php +public function denoise(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 247. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/detect-stop.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/detect-stop.mdx new file mode 100644 index 0000000000..f13ca5becf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/detect-stop.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/detect-stop" +title: "detectStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::detectStop" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `detectStop` + +## Signature + +```php +public function detectStop(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 205. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/detect.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/detect.mdx new file mode 100644 index 0000000000..bdd5b76841 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/detect.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/detect" +title: "detect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::detect" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `detect` + +## Signature + +```php +public function detect(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 199. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/dial.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/dial.mdx new file mode 100644 index 0000000000..bc21c17edd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/dial.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/dial" +title: "dial" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::dial" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `dial` + +## Signature + +```php +public function dial(array $params = array ( +)): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/disconnect.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/disconnect.mdx new file mode 100644 index 0000000000..c08ed9b558 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/disconnect.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/disconnect" +title: "disconnect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::disconnect" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `disconnect` + +## Signature + +```php +public function disconnect(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 105. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/end.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/end.mdx new file mode 100644 index 0000000000..6c1619c11c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/end.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/end" +title: "end" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::end" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `end` + +## Signature + +```php +public function end(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 93. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/get-base-path.mdx new file mode 100644 index 0000000000..95e5453895 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 39. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/get-client.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/get-client.mdx new file mode 100644 index 0000000000..16a2e48b92 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/get-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/get-client" +title: "getClient" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::getClient" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `getClient` + +## Signature + +```php +public function getClient(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/get-project-id.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/get-project-id.mdx new file mode 100644 index 0000000000..539c4b9337 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/get-project-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/get-project-id" +title: "getProjectId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::getProjectId" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `getProjectId` + +## Signature + +```php +public function getProjectId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/index.mdx new file mode 100644 index 0000000000..43f4c3d764 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/index.mdx @@ -0,0 +1,121 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling" +title: "Calling" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" +--- +# `Calling` + +Calling API namespace. + +Provides 37 call-control command methods that each POST to +/api/calling/calls with a JSON body containing the command name, +an optional call ID, and parameters. + +## Signature + +```php +class Calling +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Send the bare `update` command (no call\_id at body root; `id` is + + + + + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 16. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/live-transcribe.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/live-transcribe.mdx new file mode 100644 index 0000000000..77578345c8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/live-transcribe.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/live-transcribe" +title: "liveTranscribe" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::liveTranscribe" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `liveTranscribe` + +## Signature + +```php +public function liveTranscribe(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 307. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/live-translate.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/live-translate.mdx new file mode 100644 index 0000000000..da9eaf24d3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/live-translate.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/live-translate" +title: "liveTranslate" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::liveTranslate" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `liveTranslate` + +## Signature + +```php +public function liveTranslate(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 313. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-pause.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-pause.mdx new file mode 100644 index 0000000000..d1b4c1f198 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-pause.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/play-pause" +title: "playPause" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::playPause" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `playPause` + +## Signature + +```php +public function playPause(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 121. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-resume.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-resume.mdx new file mode 100644 index 0000000000..31ac4ad1f1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-resume.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/play-resume" +title: "playResume" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::playResume" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `playResume` + +## Signature + +```php +public function playResume(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 127. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-stop.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-stop.mdx new file mode 100644 index 0000000000..9a46d1d8ad --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-stop.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/play-stop" +title: "playStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::playStop" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `playStop` + +## Signature + +```php +public function playStop(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 133. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-volume.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-volume.mdx new file mode 100644 index 0000000000..36d0f0e4f8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play-volume.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/play-volume" +title: "playVolume" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::playVolume" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `playVolume` + +## Signature + +```php +public function playVolume(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 139. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play.mdx new file mode 100644 index 0000000000..569fcedc47 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/play.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/play" +title: "play" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::play" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `play` + +## Signature + +```php +public function play(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 115. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/receive-fax-stop.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/receive-fax-stop.mdx new file mode 100644 index 0000000000..c888fbdcbd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/receive-fax-stop.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/receive-fax-stop" +title: "receiveFaxStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::receiveFaxStop" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `receiveFaxStop` + +## Signature + +```php +public function receiveFaxStop(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 329. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record-pause.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record-pause.mdx new file mode 100644 index 0000000000..d90c6495e6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record-pause.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/record-pause" +title: "recordPause" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::recordPause" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `recordPause` + +## Signature + +```php +public function recordPause(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 155. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record-resume.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record-resume.mdx new file mode 100644 index 0000000000..0c60143cc9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record-resume.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/record-resume" +title: "recordResume" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::recordResume" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `recordResume` + +## Signature + +```php +public function recordResume(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 161. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record-stop.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record-stop.mdx new file mode 100644 index 0000000000..b9ab03eb58 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record-stop.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/record-stop" +title: "recordStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::recordStop" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `recordStop` + +## Signature + +```php +public function recordStop(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record.mdx new file mode 100644 index 0000000000..bce6a1fe4a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/record.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/record" +title: "record" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::record" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `record` + +## Signature + +```php +public function record(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 149. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/refer.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/refer.mdx new file mode 100644 index 0000000000..f8fc9c245a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/refer.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/refer" +title: "refer" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::refer" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `refer` + +## Signature + +```php +public function refer(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 339. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/send-fax-stop.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/send-fax-stop.mdx new file mode 100644 index 0000000000..e2e493f4cf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/send-fax-stop.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/send-fax-stop" +title: "sendFaxStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::sendFaxStop" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `sendFaxStop` + +## Signature + +```php +public function sendFaxStop(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 323. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/stream-stop.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/stream-stop.mdx new file mode 100644 index 0000000000..25ffca1280 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/stream-stop.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/stream-stop" +title: "streamStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::streamStop" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `streamStop` + +## Signature + +```php +public function streamStop(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 237. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/stream.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/stream.mdx new file mode 100644 index 0000000000..959a0b2a56 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/stream.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/stream" +title: "stream" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::stream" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `stream` + +## Signature + +```php +public function stream(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 231. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/tap-stop.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/tap-stop.mdx new file mode 100644 index 0000000000..5258c84513 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/tap-stop.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/tap-stop" +title: "tapStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::tapStop" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `tapStop` + +## Signature + +```php +public function tapStop(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 221. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/tap.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/tap.mdx new file mode 100644 index 0000000000..39abcf048f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/tap.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/tap" +title: "tap" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::tap" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `tap` + +## Signature + +```php +public function tap(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 215. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/transcribe-stop.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/transcribe-stop.mdx new file mode 100644 index 0000000000..0d5ac82695 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/transcribe-stop.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/transcribe-stop" +title: "transcribeStop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::transcribeStop" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `transcribeStop` + +## Signature + +```php +public function transcribeStop(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 269. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/transcribe.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/transcribe.mdx new file mode 100644 index 0000000000..9decc9fd9d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/transcribe.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/transcribe" +title: "transcribe" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::transcribe" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `transcribe` + +## Signature + +```php +public function transcribe(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 263. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/transfer.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/transfer.mdx new file mode 100644 index 0000000000..55f5478dd4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/transfer.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/transfer" +title: "transfer" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::transfer" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `transfer` + +## Signature + +```php +public function transfer(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 99. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/update.mdx new file mode 100644 index 0000000000..f2277c7116 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::update" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `update` + +Send the bare `update` command (no call\_id at body root; `id` is + +passed inside `params`). Mirrors Python's +`CallingNamespace.update(**params)`. + +## Signature + +```php +public function update(array $params = array ( +)): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 87. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/user-event.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/user-event.mdx new file mode 100644 index 0000000000..3d6c126cd4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/calling/user-event.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/calling/user-event" +title: "userEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Calling::userEvent" + parent: "SignalWire\\REST\\Namespaces\\Calling" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php" + visibility: "public" +--- +# `userEvent` + +## Signature + +```php +public function userEvent(string $callId, array $params = array ( +)): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Calling.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Calling.php) + +Line 349. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/construct.mdx new file mode 100644 index 0000000000..c26e39b7c7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatAccounts::__construct" + parent: "SignalWire\\REST\\Namespaces\\CompatAccounts" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/CompatAccounts.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php) + +Line 20. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/create.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/create.mdx new file mode 100644 index 0000000000..df926ca308 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/create" +title: "create" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatAccounts::create" + parent: "SignalWire\\REST\\Namespaces\\CompatAccounts" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php" + visibility: "public" +--- +# `create` + +## Signature + +```php +public function create(array $body): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatAccounts.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/get-base-path.mdx new file mode 100644 index 0000000000..81de80403c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatAccounts::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\CompatAccounts" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/CompatAccounts.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php) + +Line 25. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/get.mdx new file mode 100644 index 0000000000..6c78c8c536 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatAccounts::get" + parent: "SignalWire\\REST\\Namespaces\\CompatAccounts" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $sid): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatAccounts.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php) + +Line 49. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/index.mdx new file mode 100644 index 0000000000..5a6c2c82e9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts" +title: "CompatAccounts" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatAccounts" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php" +--- +# `CompatAccounts` + +Compat account / sub-project management. + +Mirrors Python `CompatAccounts`: the only resource that lives under +`/api/laml/2010-04-01/Accounts` (rather than `.../Accounts/{Sid}/...`). + +## Signature + +```php +class CompatAccounts +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/CompatAccounts.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php) + +Line 15. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/list.mdx new file mode 100644 index 0000000000..abab1d2c0f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/list.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatAccounts::list" + parent: "SignalWire\\REST\\Namespaces\\CompatAccounts" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatAccounts.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/update.mdx new file mode 100644 index 0000000000..b3dc857440 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-accounts/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatAccounts::update" + parent: "SignalWire\\REST\\Namespaces\\CompatAccounts" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php" + visibility: "public" +--- +# `update` + +## Signature + +```php +public function update(string $sid, array $body): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatAccounts.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatAccounts.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/construct.mdx new file mode 100644 index 0000000000..66a08a2f20 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::__construct" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/delete-recording.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/delete-recording.mdx new file mode 100644 index 0000000000..2b4c790dd5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/delete-recording.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/delete-recording" +title: "deleteRecording" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::deleteRecording" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `deleteRecording` + +## Signature + +```php +public function deleteRecording(string $conferenceSid, string $recordingSid): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 115. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-base-path.mdx new file mode 100644 index 0000000000..36e6d7cecf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-participant.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-participant.mdx new file mode 100644 index 0000000000..bb2664049c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-participant.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-participant" +title: "getParticipant" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::getParticipant" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `getParticipant` + +## Signature + +```php +public function getParticipant(string $conferenceSid, string $callSid): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 60. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-recording.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-recording.mdx new file mode 100644 index 0000000000..e1b8adbe6d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-recording.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get-recording" +title: "getRecording" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::getRecording" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `getRecording` + +## Signature + +```php +public function getRecording(string $conferenceSid, string $recordingSid): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 98. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get.mdx new file mode 100644 index 0000000000..a90146cae2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::get" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $sid): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/index.mdx new file mode 100644 index 0000000000..ebbbe719f8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences" +title: "CompatConferences" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" +--- +# `CompatConferences` + +Compat conference management with participants, recordings, and streams. + +## Signature + +```php +class CompatConferences +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list-participants.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list-participants.mdx new file mode 100644 index 0000000000..021e336ca6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list-participants.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list-participants" +title: "listParticipants" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::listParticipants" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `listParticipants` + +## Signature + +```php +public function listParticipants( + string $conferenceSid, + array $params = array ( +) +): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 51. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list-recordings.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list-recordings.mdx new file mode 100644 index 0000000000..54334ae8ad --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list-recordings.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list-recordings" +title: "listRecordings" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::listRecordings" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `listRecordings` + +## Signature + +```php +public function listRecordings(string $conferenceSid, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list.mdx new file mode 100644 index 0000000000..2a5a874f61 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::list" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/remove-participant.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/remove-participant.mdx new file mode 100644 index 0000000000..3f2b3ae62a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/remove-participant.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/remove-participant" +title: "removeParticipant" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::removeParticipant" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `removeParticipant` + +## Signature + +```php +public function removeParticipant(string $conferenceSid, string $callSid): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 77. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/start-stream.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/start-stream.mdx new file mode 100644 index 0000000000..8c542def10 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/start-stream.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/start-stream" +title: "startStream" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::startStream" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `startStream` + +## Signature + +```php +public function startStream(string $conferenceSid, array $body): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 127. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/stop-stream.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/stop-stream.mdx new file mode 100644 index 0000000000..47e463edb5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/stop-stream.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/stop-stream" +title: "stopStream" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::stopStream" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `stopStream` + +## Signature + +```php +public function stopStream( + string $conferenceSid, + string $streamSid, + array $body +): array +``` + +## Parameters + + + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 136. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update-participant.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update-participant.mdx new file mode 100644 index 0000000000..5eca3e203e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update-participant.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update-participant" +title: "updateParticipant" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::updateParticipant" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `updateParticipant` + +## Signature + +```php +public function updateParticipant( + string $conferenceSid, + string $callSid, + array $body +): array +``` + +## Parameters + + + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 68. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update-recording.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update-recording.mdx new file mode 100644 index 0000000000..09b06e450f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update-recording.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update-recording" +title: "updateRecording" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::updateRecording" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `updateRecording` + +## Signature + +```php +public function updateRecording( + string $conferenceSid, + string $recordingSid, + array $body +): array +``` + +## Parameters + + + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 106. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update.mdx new file mode 100644 index 0000000000..f07cd69e6a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-conferences/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatConferences::update" + parent: "SignalWire\\REST\\Namespaces\\CompatConferences" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php" + visibility: "public" +--- +# `update` + +## Signature + +```php +public function update(string $sid, array $body): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatConferences.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatConferences.php) + +Line 41. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/construct.mdx new file mode 100644 index 0000000000..44a44ea4d3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::__construct" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/delete.mdx new file mode 100644 index 0000000000..70a7fb69b2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::delete" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $sid): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 73. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-available-base.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-available-base.mdx new file mode 100644 index 0000000000..901b73fb91 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-available-base.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-available-base" +title: "getAvailableBase" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::getAvailableBase" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `getAvailableBase` + +## Signature + +```php +public function getAvailableBase(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 44. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-base-path.mdx new file mode 100644 index 0000000000..9f75a411be --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 39. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-imported-base.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-imported-base.mdx new file mode 100644 index 0000000000..584d1cbfe4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-imported-base.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get-imported-base" +title: "getImportedBase" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::getImportedBase" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `getImportedBase` + +## Signature + +```php +public function getImportedBase(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 49. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get.mdx new file mode 100644 index 0000000000..106061eaa7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::get" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $sid): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 61. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/import-number.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/import-number.mdx new file mode 100644 index 0000000000..b51a67ed3c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/import-number.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/import-number" +title: "importNumber" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::importNumber" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `importNumber` + +## Signature + +```php +public function importNumber(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 85. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/index.mdx new file mode 100644 index 0000000000..8497b8e424 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/index.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers" +title: "CompatPhoneNumbers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" +--- +# `CompatPhoneNumbers` + +Compat IncomingPhoneNumbers + AvailablePhoneNumbers + ImportedPhoneNumbers + +management. + +The base path is the IncomingPhoneNumbers collection; the available / +imported variants live at sibling paths derived from the base. + +## Signature + +```php +class CompatPhoneNumbers +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 16. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/list-available-countries.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/list-available-countries.mdx new file mode 100644 index 0000000000..aac3b35e3e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/list-available-countries.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/list-available-countries" +title: "listAvailableCountries" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::listAvailableCountries" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `listAvailableCountries` + +## Signature + +```php +public function listAvailableCountries(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/list.mdx new file mode 100644 index 0000000000..7734fa16f4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::list" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 55. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/purchase.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/purchase.mdx new file mode 100644 index 0000000000..e60d7578b1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/purchase.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/purchase" +title: "purchase" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::purchase" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `purchase` + +## Signature + +```php +public function purchase(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 79. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/search-local.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/search-local.mdx new file mode 100644 index 0000000000..d9fad128e4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/search-local.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/search-local" +title: "searchLocal" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::searchLocal" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `searchLocal` + +## Signature + +```php +public function searchLocal(string $country, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/search-toll-free.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/search-toll-free.mdx new file mode 100644 index 0000000000..04fdd1e192 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/search-toll-free.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/search-toll-free" +title: "searchTollFree" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::searchTollFree" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `searchTollFree` + +## Signature + +```php +public function searchTollFree(string $country, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 103. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/update.mdx new file mode 100644 index 0000000000..d3a006ccaf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-phone-numbers/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers::update" + parent: "SignalWire\\REST\\Namespaces\\CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php" + visibility: "public" +--- +# `update` + +## Signature + +```php +public function update(string $sid, array $body): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatPhoneNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatPhoneNumbers.php) + +Line 67. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/construct.mdx new file mode 100644 index 0000000000..3e1fbabc80 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatRecordings::__construct" + parent: "SignalWire\\REST\\Namespaces\\CompatRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/CompatRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php) + +Line 20. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/delete.mdx new file mode 100644 index 0000000000..c5ddc6eaa7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatRecordings::delete" + parent: "SignalWire\\REST\\Namespaces\\CompatRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $sid): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php) + +Line 44. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/get-base-path.mdx new file mode 100644 index 0000000000..aedd0b235b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatRecordings::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\CompatRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/CompatRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php) + +Line 26. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/get.mdx new file mode 100644 index 0000000000..adfdcbf249 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatRecordings::get" + parent: "SignalWire\\REST\\Namespaces\\CompatRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $sid): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/index.mdx new file mode 100644 index 0000000000..32b1522af0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings" +title: "CompatRecordings" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatRecordings" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php" +--- +# `CompatRecordings` + +Compat recording management. + +Account-scoped recordings — distinct from per-call recordings on +`CompatCalls`. Surface is list / get / delete only. + +## Signature + +```php +class CompatRecordings +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/CompatRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php) + +Line 15. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/list.mdx new file mode 100644 index 0000000000..4b384f100b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-recordings/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatRecordings::list" + parent: "SignalWire\\REST\\Namespaces\\CompatRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatRecordings.php) + +Line 32. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/construct.mdx new file mode 100644 index 0000000000..d312c92d50 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTokens::__construct" + parent: "SignalWire\\REST\\Namespaces\\CompatTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/CompatTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php) + +Line 19. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/create.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/create.mdx new file mode 100644 index 0000000000..8f4f836a3b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/create" +title: "create" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTokens::create" + parent: "SignalWire\\REST\\Namespaces\\CompatTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php" + visibility: "public" +--- +# `create` + +## Signature + +```php +public function create(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php) + +Line 31. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/delete.mdx new file mode 100644 index 0000000000..efea0c9ce9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTokens::delete" + parent: "SignalWire\\REST\\Namespaces\\CompatTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $tokenId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/get-base-path.mdx new file mode 100644 index 0000000000..66f04d4ddf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTokens::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\CompatTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/CompatTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php) + +Line 25. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/index.mdx new file mode 100644 index 0000000000..25d14d017e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens" +title: "CompatTokens" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTokens" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php" +--- +# `CompatTokens` + +Compat API token management. + +Surface is create / update (PATCH) / delete only. + +## Signature + +```php +class CompatTokens +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/CompatTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php) + +Line 14. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/update.mdx new file mode 100644 index 0000000000..52a9fc3d03 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-tokens/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTokens::update" + parent: "SignalWire\\REST\\Namespaces\\CompatTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php" + visibility: "public" +--- +# `update` + +## Signature + +```php +public function update(string $tokenId, array $body): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTokens.php) + +Line 37. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/construct.mdx new file mode 100644 index 0000000000..d3e9e86d7d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTranscriptions::__construct" + parent: "SignalWire\\REST\\Namespaces\\CompatTranscriptions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/CompatTranscriptions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php) + +Line 19. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/delete.mdx new file mode 100644 index 0000000000..77d4ac5d16 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTranscriptions::delete" + parent: "SignalWire\\REST\\Namespaces\\CompatTranscriptions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $sid): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatTranscriptions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/get-base-path.mdx new file mode 100644 index 0000000000..c67d872170 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTranscriptions::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\CompatTranscriptions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/CompatTranscriptions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php) + +Line 25. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/get.mdx new file mode 100644 index 0000000000..e9276c2ae2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTranscriptions::get" + parent: "SignalWire\\REST\\Namespaces\\CompatTranscriptions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $sid): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatTranscriptions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php) + +Line 37. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/index.mdx new file mode 100644 index 0000000000..781c4e9eb0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions" +title: "CompatTranscriptions" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTranscriptions" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php" +--- +# `CompatTranscriptions` + +Compat transcription management. + +Account-scoped transcriptions. Surface is list / get / delete only. + +## Signature + +```php +class CompatTranscriptions +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/CompatTranscriptions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php) + +Line 14. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/list.mdx new file mode 100644 index 0000000000..964e972035 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat-transcriptions/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\CompatTranscriptions::list" + parent: "SignalWire\\REST\\Namespaces\\CompatTranscriptions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/CompatTranscriptions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/CompatTranscriptions.php) + +Line 31. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/accounts.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/accounts.mdx new file mode 100644 index 0000000000..a5abcaecb4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/accounts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/accounts" +title: "accounts" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::accounts" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `accounts` + +## Signature + +```php +public function accounts(): SignalWire\REST\Namespaces\CompatAccounts +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatAccounts` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 73. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/applications.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/applications.mdx new file mode 100644 index 0000000000..74c4da642c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/applications.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/applications" +title: "applications" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::applications" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `applications` + +## Signature + +```php +public function applications(): SignalWire\REST\Namespaces\CompatApplications +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatApplications` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 103. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/calls.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/calls.mdx new file mode 100644 index 0000000000..c67291c0a6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/calls.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/calls" +title: "calls" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::calls" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `calls` + +## Signature + +```php +public function calls(): SignalWire\REST\Namespaces\CompatCalls +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatCalls` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 78. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/conferences.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/conferences.mdx new file mode 100644 index 0000000000..0e1f87eb6d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/conferences.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/conferences" +title: "conferences" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::conferences" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `conferences` + +## Signature + +```php +public function conferences(): SignalWire\REST\Namespaces\CompatConferences +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatConferences` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 93. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/construct.mdx new file mode 100644 index 0000000000..07cd55122b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::__construct" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $accountSid) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/faxes.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/faxes.mdx new file mode 100644 index 0000000000..192c10167b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/faxes.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/faxes" +title: "faxes" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::faxes" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `faxes` + +## Signature + +```php +public function faxes(): SignalWire\REST\Namespaces\CompatFaxes +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatFaxes` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 88. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/get-account-base.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/get-account-base.mdx new file mode 100644 index 0000000000..c25a08d005 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/get-account-base.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/get-account-base" +title: "getAccountBase" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::getAccountBase" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `getAccountBase` + +## Signature + +```php +public function getAccountBase(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 63. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/get-account-sid.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/get-account-sid.mdx new file mode 100644 index 0000000000..2728432bdd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/get-account-sid.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/get-account-sid" +title: "getAccountSid" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::getAccountSid" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `getAccountSid` + +## Signature + +```php +public function getAccountSid(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/get-http.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/get-http.mdx new file mode 100644 index 0000000000..7c76723a97 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/get-http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/get-http" +title: "getHttp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::getHttp" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `getHttp` + +## Signature + +```php +public function getHttp(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 68. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/index.mdx new file mode 100644 index 0000000000..8b73cf3322 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat" +title: "Compat" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" +--- +# `Compat` + +Compatibility (Twilio-compatible LAML) API namespace. + +Mounted under `/api/laml/2010-04-01/Accounts/{AccountSid}` and exposes +the LAML-flavoured REST surface (Accounts, Calls, Messages, Faxes, +Conferences, IncomingPhoneNumbers + AvailablePhoneNumbers, Applications, +LamlBins, Queues, Recordings, Transcriptions, tokens) as object-style +sub-resources to mirror the Python `CompatNamespace` class. + +## Signature + +```php +class Compat +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 19. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/laml-bins.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/laml-bins.mdx new file mode 100644 index 0000000000..f37f550eb9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/laml-bins.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/laml-bins" +title: "lamlBins" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::lamlBins" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `lamlBins` + +## Signature + +```php +public function lamlBins(): SignalWire\REST\Namespaces\CompatLamlBins +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatLamlBins` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 108. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/messages.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/messages.mdx new file mode 100644 index 0000000000..3417328ed0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/messages.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/messages" +title: "messages" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::messages" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `messages` + +## Signature + +```php +public function messages(): SignalWire\REST\Namespaces\CompatMessages +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatMessages` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 83. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/phone-numbers.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/phone-numbers.mdx new file mode 100644 index 0000000000..c54dc1d23b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/phone-numbers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/phone-numbers" +title: "phoneNumbers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::phoneNumbers" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `phoneNumbers` + +## Signature + +```php +public function phoneNumbers(): SignalWire\REST\Namespaces\CompatPhoneNumbers +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatPhoneNumbers` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 98. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/queues.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/queues.mdx new file mode 100644 index 0000000000..8b16dd077d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/queues.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/queues" +title: "queues" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::queues" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `queues` + +## Signature + +```php +public function queues(): SignalWire\REST\Namespaces\CompatQueues +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatQueues` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 113. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/recordings.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/recordings.mdx new file mode 100644 index 0000000000..a898954f80 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/recordings.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/recordings" +title: "recordings" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::recordings" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `recordings` + +## Signature + +```php +public function recordings(): SignalWire\REST\Namespaces\CompatRecordings +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatRecordings` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 118. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/tokens.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/tokens.mdx new file mode 100644 index 0000000000..07103a8a9c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/tokens" +title: "tokens" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::tokens" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `tokens` + +## Signature + +```php +public function tokens(): SignalWire\REST\Namespaces\CompatTokens +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatTokens` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 128. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/transcriptions.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/transcriptions.mdx new file mode 100644 index 0000000000..2d2b6fda70 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/compat/transcriptions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/compat/transcriptions" +title: "transcriptions" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Compat::transcriptions" + parent: "SignalWire\\REST\\Namespaces\\Compat" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php" + visibility: "public" +--- +# `transcriptions` + +## Signature + +```php +public function transcriptions(): SignalWire\REST\Namespaces\CompatTranscriptions +``` + +## Returns + +`SignalWire\REST\Namespaces\CompatTranscriptions` + +## Source + +[`SignalWire/REST/Namespaces/Compat.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Compat.php) + +Line 123. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/construct.mdx new file mode 100644 index 0000000000..36e7ba5986 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ConferenceLogs::__construct" + parent: "SignalWire\\REST\\Namespaces\\ConferenceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ConferenceLogs.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/ConferenceLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ConferenceLogs.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/get-base-path.mdx new file mode 100644 index 0000000000..b7133101ea --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ConferenceLogs::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\ConferenceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ConferenceLogs.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/ConferenceLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ConferenceLogs.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/index.mdx new file mode 100644 index 0000000000..a4f47d4ee4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/conference-logs" +title: "ConferenceLogs" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ConferenceLogs" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ConferenceLogs.php" +--- +# `ConferenceLogs` + +Conference log queries — list-only resource. + +## Signature + +```php +class ConferenceLogs +``` + +## Methods + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/ConferenceLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ConferenceLogs.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/list.mdx new file mode 100644 index 0000000000..3456e97ad4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/conference-logs/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ConferenceLogs::list" + parent: "SignalWire\\REST\\Namespaces\\ConferenceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ConferenceLogs.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/ConferenceLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ConferenceLogs.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/construct.mdx new file mode 100644 index 0000000000..64b9a3decf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/datasphere/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Datasphere::__construct" + parent: "SignalWire\\REST\\Namespaces\\Datasphere" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Datasphere.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Datasphere.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/documents.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/documents.mdx new file mode 100644 index 0000000000..0ba48ef4cb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/documents.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/datasphere/documents" +title: "documents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Datasphere::documents" + parent: "SignalWire\\REST\\Namespaces\\Datasphere" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Datasphere.php" + visibility: "public" +--- +# `documents` + +## Signature + +```php +public function documents(): SignalWire\REST\Namespaces\DatasphereDocuments +``` + +## Returns + +`SignalWire\REST\Namespaces\DatasphereDocuments` + +## Source + +[`SignalWire/REST/Namespaces/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Datasphere.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/get-http.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/get-http.mdx new file mode 100644 index 0000000000..1cd38367e2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/get-http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/datasphere/get-http" +title: "getHttp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Datasphere::getHttp" + parent: "SignalWire\\REST\\Namespaces\\Datasphere" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Datasphere.php" + visibility: "public" +--- +# `getHttp` + +## Signature + +```php +public function getHttp(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/Namespaces/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Datasphere.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/index.mdx new file mode 100644 index 0000000000..88b4e3899b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/datasphere/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/datasphere" +title: "Datasphere" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Datasphere" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Datasphere.php" +--- +# `Datasphere` + +Datasphere API namespace — exposes the documents sub-resource. + +## Signature + +```php +class Datasphere +``` + +## Methods + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Datasphere.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/construct.mdx new file mode 100644 index 0000000000..abd4464bdd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricAddresses::__construct" + parent: "SignalWire\\REST\\Namespaces\\FabricAddresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricAddresses.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/FabricAddresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricAddresses.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/get-base-path.mdx new file mode 100644 index 0000000000..c7c43f5c56 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricAddresses::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\FabricAddresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricAddresses.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/FabricAddresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricAddresses.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/get.mdx new file mode 100644 index 0000000000..f9d0b9716a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricAddresses::get" + parent: "SignalWire\\REST\\Namespaces\\FabricAddresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricAddresses.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $addressId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricAddresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricAddresses.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/index.mdx new file mode 100644 index 0000000000..1677bfa8ee --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses" +title: "FabricAddresses" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricAddresses" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricAddresses.php" +--- +# `FabricAddresses` + +Read-only fabric addresses (`/api/fabric/addresses`). + +## Signature + +```php +class FabricAddresses +``` + +## Methods + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/FabricAddresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricAddresses.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/list.mdx new file mode 100644 index 0000000000..e825257027 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-addresses/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricAddresses::list" + parent: "SignalWire\\REST\\Namespaces\\FabricAddresses" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricAddresses.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricAddresses.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricAddresses.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/assign-domain-application.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/assign-domain-application.mdx new file mode 100644 index 0000000000..4078e1cd4d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/assign-domain-application.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/assign-domain-application" +title: "assignDomainApplication" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricGenericResources::assignDomainApplication" + parent: "SignalWire\\REST\\Namespaces\\FabricGenericResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php" + visibility: "public" +--- +# `assignDomainApplication` + +Bind a domain application to a fabric resource. + +## Signature + +```php +public function assignDomainApplication(string $resourceId, array $body): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricGenericResources.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php) + +Line 64. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/construct.mdx new file mode 100644 index 0000000000..f0fd6215c8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricGenericResources::__construct" + parent: "SignalWire\\REST\\Namespaces\\FabricGenericResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/FabricGenericResources.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php) + +Line 20. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/delete.mdx new file mode 100644 index 0000000000..01a10a15a4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricGenericResources::delete" + parent: "SignalWire\\REST\\Namespaces\\FabricGenericResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $resourceId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricGenericResources.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php) + +Line 44. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/get-base-path.mdx new file mode 100644 index 0000000000..79e68df68f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricGenericResources::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\FabricGenericResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/FabricGenericResources.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php) + +Line 26. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/get.mdx new file mode 100644 index 0000000000..d2dd836080 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricGenericResources::get" + parent: "SignalWire\\REST\\Namespaces\\FabricGenericResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $resourceId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricGenericResources.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/index.mdx new file mode 100644 index 0000000000..52f8130e78 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources" +title: "FabricGenericResources" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricGenericResources" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php" +--- +# `FabricGenericResources` + +Generic operations across all fabric resource types + +(`/api/fabric/resources`). + +Mirrors Python `signalwire.rest.namespaces.fabric.GenericResources`. + +## Signature + +```php +class FabricGenericResources +``` + +## Methods + + + + + + Bind a domain application to a fabric resource. + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/FabricGenericResources.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php) + +Line 15. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/list-addresses.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/list-addresses.mdx new file mode 100644 index 0000000000..07e39402c8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/list-addresses.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/list-addresses" +title: "listAddresses" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricGenericResources::listAddresses" + parent: "SignalWire\\REST\\Namespaces\\FabricGenericResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php" + visibility: "public" +--- +# `listAddresses` + +## Signature + +```php +public function listAddresses(string $resourceId, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricGenericResources.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php) + +Line 50. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/list.mdx new file mode 100644 index 0000000000..66d671256d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-generic-resources/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricGenericResources::list" + parent: "SignalWire\\REST\\Namespaces\\FabricGenericResources" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricGenericResources.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricGenericResources.php) + +Line 32. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/construct.mdx new file mode 100644 index 0000000000..9763eba001 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricTokens::__construct" + parent: "SignalWire\\REST\\Namespaces\\FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/FabricTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-embed-token.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-embed-token.mdx new file mode 100644 index 0000000000..6adb1f3608 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-embed-token.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-embed-token" +title: "createEmbedToken" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricTokens::createEmbedToken" + parent: "SignalWire\\REST\\Namespaces\\FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php" + visibility: "public" +--- +# `createEmbedToken` + +## Signature + +```php +public function createEmbedToken(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php) + +Line 65. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-guest-token.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-guest-token.mdx new file mode 100644 index 0000000000..69e0839358 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-guest-token.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-guest-token" +title: "createGuestToken" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricTokens::createGuestToken" + parent: "SignalWire\\REST\\Namespaces\\FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php" + visibility: "public" +--- +# `createGuestToken` + +## Signature + +```php +public function createGuestToken(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php) + +Line 59. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-invite-token.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-invite-token.mdx new file mode 100644 index 0000000000..f4449b62b6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-invite-token.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-invite-token" +title: "createInviteToken" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricTokens::createInviteToken" + parent: "SignalWire\\REST\\Namespaces\\FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php" + visibility: "public" +--- +# `createInviteToken` + +Note the singular `subscriber` here — the invite endpoint uses + +`/api/fabric/subscriber/invites`, not `subscribers`. + +## Signature + +```php +public function createInviteToken(array $body): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php) + +Line 53. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-subscriber-token.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-subscriber-token.mdx new file mode 100644 index 0000000000..07e008128c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-subscriber-token.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/create-subscriber-token" +title: "createSubscriberToken" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricTokens::createSubscriberToken" + parent: "SignalWire\\REST\\Namespaces\\FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php" + visibility: "public" +--- +# `createSubscriberToken` + +## Signature + +```php +public function createSubscriberToken(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/get-base-path.mdx new file mode 100644 index 0000000000..212925a000 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricTokens::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/FabricTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/index.mdx new file mode 100644 index 0000000000..7bafb35b00 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens" +title: "FabricTokens" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricTokens" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php" +--- +# `FabricTokens` + +Subscriber, guest, invite, and embed token creation under + +`/api/fabric/...`. + +Note: token endpoints sit under different sub-paths inside the Fabric +mount point (`subscribers/tokens`, `subscriber/invites`, `guests`, +`embeds`) — singular vs plural is API-specific so each helper has the +exact path the API expects. + +## Signature + +```php +class FabricTokens +``` + +## Methods + + + + + + + + + + Note the singular `subscriber` here — the invite endpoint uses + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/FabricTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php) + +Line 18. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/refresh-subscriber-token.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/refresh-subscriber-token.mdx new file mode 100644 index 0000000000..71b1103ace --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/refresh-subscriber-token.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric-tokens/refresh-subscriber-token" +title: "refreshSubscriberToken" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FabricTokens::refreshSubscriberToken" + parent: "SignalWire\\REST\\Namespaces\\FabricTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php" + visibility: "public" +--- +# `refreshSubscriberToken` + +## Signature + +```php +public function refreshSubscriberToken(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FabricTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FabricTokens.php) + +Line 41. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/addresses.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/addresses.mdx new file mode 100644 index 0000000000..2529255394 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/addresses.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/addresses" +title: "addresses" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::addresses" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `addresses` + +Read-only fabric addresses (`/api/fabric/addresses`). + +## Signature + +```php +public function addresses(): SignalWire\REST\Namespaces\FabricAddresses +``` + +## Returns + +`SignalWire\REST\Namespaces\FabricAddresses` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 250. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/ai-agents.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/ai-agents.mdx new file mode 100644 index 0000000000..274e8ab201 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/ai-agents.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/ai-agents" +title: "aiAgents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::aiAgents" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `aiAgents` + +## Signature + +```php +public function aiAgents(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 159. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/call-flows.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/call-flows.mdx new file mode 100644 index 0000000000..ce2767ddde --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/call-flows.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/call-flows" +title: "callFlows" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::callFlows" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `callFlows` + +## Signature + +```php +public function callFlows(): SignalWire\REST\Namespaces\FabricCallFlows +``` + +## Returns + +`SignalWire\REST\Namespaces\FabricCallFlows` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 95. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/call-queues.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/call-queues.mdx new file mode 100644 index 0000000000..557bf3ac8e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/call-queues.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/call-queues" +title: "callQueues" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::callQueues" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `callQueues` + +## Signature + +```php +public function callQueues(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 209. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/conference-rooms.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/conference-rooms.mdx new file mode 100644 index 0000000000..60dd2f4405 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/conference-rooms.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/conference-rooms" +title: "conferenceRooms" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::conferenceRooms" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `conferenceRooms` + +## Signature + +```php +public function conferenceRooms(): SignalWire\REST\Namespaces\FabricConferenceRooms +``` + +## Returns + +`SignalWire\REST\Namespaces\FabricConferenceRooms` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 119. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/construct.mdx new file mode 100644 index 0000000000..151d4842a9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::__construct" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $client) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 65. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/conversations.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/conversations.mdx new file mode 100644 index 0000000000..51a308ed06 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/conversations.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/conversations" +title: "conversations" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::conversations" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `conversations` + +## Signature + +```php +public function conversations(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 185. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-applications.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-applications.mdx new file mode 100644 index 0000000000..fe3a467a6a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-applications.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-applications" +title: "cxmlApplications" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::cxmlApplications" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `cxmlApplications` + +## Signature + +```php +public function cxmlApplications(): SignalWire\REST\Namespaces\FabricCxmlApplications +``` + +## Returns + +`SignalWire\REST\Namespaces\FabricCxmlApplications` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 143. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-scripts.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-scripts.mdx new file mode 100644 index 0000000000..257778d543 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-scripts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-scripts" +title: "cxmlScripts" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::cxmlScripts" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `cxmlScripts` + +## Signature + +```php +public function cxmlScripts(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 135. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-webhooks.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-webhooks.mdx new file mode 100644 index 0000000000..01f51ec7ca --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-webhooks.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/cxml-webhooks" +title: "cxmlWebhooks" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::cxmlWebhooks" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `cxmlWebhooks` + +## Signature + +```php +public function cxmlWebhooks(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 175. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/dial-plans.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/dial-plans.mdx new file mode 100644 index 0000000000..9ed2b72637 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/dial-plans.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/dial-plans" +title: "dialPlans" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::dialPlans" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `dialPlans` + +## Signature + +```php +public function dialPlans(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 193. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/freeclimb-apps.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/freeclimb-apps.mdx new file mode 100644 index 0000000000..5913a02174 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/freeclimb-apps.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/freeclimb-apps" +title: "freeclimbApps" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::freeclimbApps" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `freeclimbApps` + +## Signature + +```php +public function freeclimbApps(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 201. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/freeswitch-connectors.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/freeswitch-connectors.mdx new file mode 100644 index 0000000000..7277200259 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/freeswitch-connectors.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/freeswitch-connectors" +title: "freeswitchConnectors" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::freeswitchConnectors" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `freeswitchConnectors` + +## Signature + +```php +public function freeswitchConnectors(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 127. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/get-client.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/get-client.mdx new file mode 100644 index 0000000000..dd8a2a4517 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/get-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/get-client" +title: "getClient" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::getClient" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `getClient` + +## Signature + +```php +public function getClient(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 70. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/index.mdx new file mode 100644 index 0000000000..091ab7e9b2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/index.mdx @@ -0,0 +1,103 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric" +title: "Fabric" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" +--- +# `Fabric` + +Fabric API namespace. + +Mirrors Python `signalwire.rest.namespaces.fabric.FabricNamespace`: +groups all Fabric sub-resources (subscribers, SIP endpoints, call flows, +SWML scripts, conference rooms, AI agents, etc.) under a single object. + +Sub-resources fall into a few buckets: + +- PUT-update CRUD: `swml_scripts`, `relay_applications`, + `call_flows`, `conference_rooms`, `freeswitch_connectors`, + `subscribers`, `sip_endpoints`, `cxml_scripts`, + `cxml_applications`. +- PATCH-update CRUD: `swml_webhooks`, `ai_agents`, `sip_gateways`, + `cxml_webhooks`. +- Special: `resources` (generic `/api/fabric/resources`), + `addresses` (read-only `/api/fabric/addresses`), `tokens` + (subscriber/guest/embed token creation). + +## Signature + +```php +class Fabric +``` + +## Methods + + + + + + Read-only fabric addresses (`/api/fabric/addresses`). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Generic operations across all fabric resource types + + + + + + + + + + + + + + + + Subscriber / guest / invite / embed token creation + + + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/phone-numbers.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/phone-numbers.mdx new file mode 100644 index 0000000000..32a12a4171 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/phone-numbers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/phone-numbers" +title: "phoneNumbers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::phoneNumbers" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `phoneNumbers` + +## Signature + +```php +public function phoneNumbers(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 225. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/relay-applications.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/relay-applications.mdx new file mode 100644 index 0000000000..0e282bc2cc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/relay-applications.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/relay-applications" +title: "relayApplications" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::relayApplications" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `relayApplications` + +## Signature + +```php +public function relayApplications(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 111. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/resources.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/resources.mdx new file mode 100644 index 0000000000..1fda5f9212 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/resources.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/resources" +title: "resources" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::resources" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `resources` + +Generic operations across all fabric resource types + +(`/api/fabric/resources`). + +## Signature + +```php +public function resources(): SignalWire\REST\Namespaces\FabricGenericResources +``` + +## Returns + +`SignalWire\REST\Namespaces\FabricGenericResources` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 239. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-endpoints.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-endpoints.mdx new file mode 100644 index 0000000000..6f6e3b8566 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-endpoints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-endpoints" +title: "sipEndpoints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::sipEndpoints" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `sipEndpoints` + +## Signature + +```php +public function sipEndpoints(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 87. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-gateways.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-gateways.mdx new file mode 100644 index 0000000000..e7d759d35b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-gateways.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-gateways" +title: "sipGateways" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::sipGateways" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `sipGateways` + +## Signature + +```php +public function sipGateways(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-profiles.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-profiles.mdx new file mode 100644 index 0000000000..4821b7769a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-profiles.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/sip-profiles" +title: "sipProfiles" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::sipProfiles" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `sipProfiles` + +## Signature + +```php +public function sipProfiles(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 217. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/subscribers.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/subscribers.mdx new file mode 100644 index 0000000000..1300d8a57b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/subscribers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/subscribers" +title: "subscribers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::subscribers" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `subscribers` + +## Signature + +```php +public function subscribers(): SignalWire\REST\Namespaces\FabricSubscribers +``` + +## Returns + +`SignalWire\REST\Namespaces\FabricSubscribers` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 79. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/swml-scripts.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/swml-scripts.mdx new file mode 100644 index 0000000000..076c9dd136 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/swml-scripts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/swml-scripts" +title: "swmlScripts" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::swmlScripts" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `swmlScripts` + +## Signature + +```php +public function swmlScripts(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 103. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/swml-webhooks.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/swml-webhooks.mdx new file mode 100644 index 0000000000..b12d1c8b05 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/swml-webhooks.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/swml-webhooks" +title: "swmlWebhooks" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::swmlWebhooks" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `swmlWebhooks` + +## Signature + +```php +public function swmlWebhooks(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 151. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/tokens.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/tokens.mdx new file mode 100644 index 0000000000..f12497b803 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fabric/tokens.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fabric/tokens" +title: "tokens" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Fabric::tokens" + parent: "SignalWire\\REST\\Namespaces\\Fabric" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php" + visibility: "public" +--- +# `tokens` + +Subscriber / guest / invite / embed token creation + +(`/api/fabric/...`). + +## Signature + +```php +public function tokens(): SignalWire\REST\Namespaces\FabricTokens +``` + +## Returns + +`SignalWire\REST\Namespaces\FabricTokens` + +## Source + +[`SignalWire/REST/Namespaces/Fabric.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Fabric.php) + +Line 262. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/construct.mdx new file mode 100644 index 0000000000..a1d9b4550f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FaxLogs::__construct" + parent: "SignalWire\\REST\\Namespaces\\FaxLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FaxLogs.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/FaxLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FaxLogs.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/get-base-path.mdx new file mode 100644 index 0000000000..e7b45883f2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FaxLogs::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\FaxLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FaxLogs.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/FaxLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FaxLogs.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/get.mdx new file mode 100644 index 0000000000..29a6245b24 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FaxLogs::get" + parent: "SignalWire\\REST\\Namespaces\\FaxLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FaxLogs.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $logId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FaxLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FaxLogs.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/index.mdx new file mode 100644 index 0000000000..78294a17ef --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fax-logs" +title: "FaxLogs" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FaxLogs" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FaxLogs.php" +--- +# `FaxLogs` + +Fax log queries — list + get by id. + +## Signature + +```php +class FaxLogs +``` + +## Methods + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/FaxLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FaxLogs.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/list.mdx new file mode 100644 index 0000000000..c232ad15ee --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/fax-logs/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\FaxLogs::list" + parent: "SignalWire\\REST\\Namespaces\\FaxLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FaxLogs.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/FaxLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/FaxLogs.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/construct.mdx new file mode 100644 index 0000000000..cc8968d755 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ImportedNumbers::__construct" + parent: "SignalWire\\REST\\Namespaces\\ImportedNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ImportedNumbers.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/ImportedNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ImportedNumbers.php) + +Line 18. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/create.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/create.mdx new file mode 100644 index 0000000000..f7b3bc15b2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/create" +title: "create" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ImportedNumbers::create" + parent: "SignalWire\\REST\\Namespaces\\ImportedNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ImportedNumbers.php" + visibility: "public" +--- +# `create` + +## Signature + +```php +public function create(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/ImportedNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ImportedNumbers.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/get-base-path.mdx new file mode 100644 index 0000000000..95f9149fde --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ImportedNumbers::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\ImportedNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ImportedNumbers.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/ImportedNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ImportedNumbers.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/index.mdx new file mode 100644 index 0000000000..19964cb221 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/imported-numbers" +title: "ImportedNumbers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ImportedNumbers" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ImportedNumbers.php" +--- +# `ImportedNumbers` + +Imported phone numbers — create only (registers an externally-hosted + +number). + +## Signature + +```php +class ImportedNumbers +``` + +## Methods + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/ImportedNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ImportedNumbers.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/index.mdx new file mode 100644 index 0000000000..690fcbc8cc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/index.mdx @@ -0,0 +1,171 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces" +title: "Namespaces" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" +--- +# `Namespaces` + +## Signature + +```php +namespace SignalWire\REST\Namespaces +``` + +## Classes + + + + Addresses namespace — list / create / get / delete (no update). + + + + Calling API namespace. + + + + Compatibility (Twilio-compatible LAML) API namespace. + + + + Compat account / sub-project management. + + + + Compat conference management with participants, recordings, and streams. + + + + Compat IncomingPhoneNumbers + AvailablePhoneNumbers + ImportedPhoneNumbers + + + + Compat recording management. + + + + Compat API token management. + + + + Compat transcription management. + + + + Conference log queries — list-only resource. + + + + Datasphere API namespace — exposes the documents sub-resource. + + + + Fabric API namespace. + + + + Read-only fabric addresses (`/api/fabric/addresses`). + + + + Generic operations across all fabric resource types + + + + Subscriber, guest, invite, and embed token creation under + + + + Fax log queries — list + get by id. + + + + Imported phone numbers — create only (registers an externally-hosted + + + + Logs namespace — message, voice, fax, and conference logs (read-only). + + + + Message log queries — list + get by id. + + + + Multi-factor authentication via SMS or phone call. + + + + Project API namespace — currently exposes the project tokens sub-resource. + + + + Project API token management — create / update (PATCH) / delete. + + + + Recordings — read-only list/get plus delete (no create or update). + + + + 10DLC Campaign Registry namespace — brands, campaigns, orders, numbers. + + + + 10DLC brand management — list, create, get, list\_campaigns, create\_campaign. + + + + 10DLC campaign management — get, update (PUT), list\_numbers, + + + + 10DLC number assignment management — release a number. + + + + 10DLC assignment order management — read-only, retrieve by id. + + + + Short codes management — read + update (PUT) only. + + + + Project SIP profile (singleton resource) — get + update (PUT). + + + + Video API namespace. + + + + Video conference token management — get + reset. + + + + Video room recording management — top-level recordings collection + + + + Video room session management. Read-only with several sub-collections + + + + Video room token generation. Surface is `create` only. + + + + Top-level video stream management — get / update (PUT) / delete. + + + + Voice log queries — list + get by id + per-id event sub-collection. + + diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/conferences.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/conferences.mdx new file mode 100644 index 0000000000..87c0d6ddf7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/conferences.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/logs/conferences" +title: "conferences" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Logs::conferences" + parent: "SignalWire\\REST\\Namespaces\\Logs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php" + visibility: "public" +--- +# `conferences` + +## Signature + +```php +public function conferences(): SignalWire\REST\Namespaces\ConferenceLogs +``` + +## Returns + +`SignalWire\REST\Namespaces\ConferenceLogs` + +## Source + +[`SignalWire/REST/Namespaces/Logs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php) + +Line 49. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/construct.mdx new file mode 100644 index 0000000000..1f70f78c7e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/logs/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Logs::__construct" + parent: "SignalWire\\REST\\Namespaces\\Logs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/Logs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php) + +Line 25. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/fax.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/fax.mdx new file mode 100644 index 0000000000..e1eb709d84 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/fax.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/logs/fax" +title: "fax" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Logs::fax" + parent: "SignalWire\\REST\\Namespaces\\Logs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php" + visibility: "public" +--- +# `fax` + +## Signature + +```php +public function fax(): SignalWire\REST\Namespaces\FaxLogs +``` + +## Returns + +`SignalWire\REST\Namespaces\FaxLogs` + +## Source + +[`SignalWire/REST/Namespaces/Logs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php) + +Line 44. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/get-http.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/get-http.mdx new file mode 100644 index 0000000000..027d35c1d4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/get-http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/logs/get-http" +title: "getHttp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Logs::getHttp" + parent: "SignalWire\\REST\\Namespaces\\Logs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php" + visibility: "public" +--- +# `getHttp` + +## Signature + +```php +public function getHttp(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/Namespaces/Logs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php) + +Line 54. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/index.mdx new file mode 100644 index 0000000000..da154f1d04 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/logs" +title: "Logs" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Logs" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php" +--- +# `Logs` + +Logs namespace — message, voice, fax, and conference logs (read-only). + +Mirrors Python `signalwire.rest.namespaces.logs.LogsNamespace`: each +sub-API lives at a different mount point because that's how the spec +docs slice them. + +## Signature + +```php +class Logs +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/Logs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php) + +Line 16. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/messages.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/messages.mdx new file mode 100644 index 0000000000..22daddbe66 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/messages.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/logs/messages" +title: "messages" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Logs::messages" + parent: "SignalWire\\REST\\Namespaces\\Logs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php" + visibility: "public" +--- +# `messages` + +## Signature + +```php +public function messages(): SignalWire\REST\Namespaces\MessageLogs +``` + +## Returns + +`SignalWire\REST\Namespaces\MessageLogs` + +## Source + +[`SignalWire/REST/Namespaces/Logs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/voice.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/voice.mdx new file mode 100644 index 0000000000..d159f7e79f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/logs/voice.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/logs/voice" +title: "voice" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Logs::voice" + parent: "SignalWire\\REST\\Namespaces\\Logs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php" + visibility: "public" +--- +# `voice` + +## Signature + +```php +public function voice(): SignalWire\REST\Namespaces\VoiceLogs +``` + +## Returns + +`SignalWire\REST\Namespaces\VoiceLogs` + +## Source + +[`SignalWire/REST/Namespaces/Logs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Logs.php) + +Line 39. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/construct.mdx new file mode 100644 index 0000000000..096728cd59 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/message-logs/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\MessageLogs::__construct" + parent: "SignalWire\\REST\\Namespaces\\MessageLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/MessageLogs.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/MessageLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/MessageLogs.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/get-base-path.mdx new file mode 100644 index 0000000000..1c58678407 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/message-logs/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\MessageLogs::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\MessageLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/MessageLogs.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/MessageLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/MessageLogs.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/get.mdx new file mode 100644 index 0000000000..6d24023138 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/message-logs/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\MessageLogs::get" + parent: "SignalWire\\REST\\Namespaces\\MessageLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/MessageLogs.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $logId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/MessageLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/MessageLogs.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/index.mdx new file mode 100644 index 0000000000..3659760a91 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/message-logs" +title: "MessageLogs" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\MessageLogs" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/MessageLogs.php" +--- +# `MessageLogs` + +Message log queries — list + get by id. + +## Signature + +```php +class MessageLogs +``` + +## Methods + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/MessageLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/MessageLogs.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/list.mdx new file mode 100644 index 0000000000..7a6ecef3d2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/message-logs/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/message-logs/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\MessageLogs::list" + parent: "SignalWire\\REST\\Namespaces\\MessageLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/MessageLogs.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/MessageLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/MessageLogs.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/call.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/call.mdx new file mode 100644 index 0000000000..bee6080284 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/call.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/mfa/call" +title: "call" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Mfa::call" + parent: "SignalWire\\REST\\Namespaces\\Mfa" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php" + visibility: "public" +--- +# `call` + +## Signature + +```php +public function call(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Mfa.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/construct.mdx new file mode 100644 index 0000000000..7109933cc6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/mfa/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Mfa::__construct" + parent: "SignalWire\\REST\\Namespaces\\Mfa" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/Mfa.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/get-base-path.mdx new file mode 100644 index 0000000000..e271d22469 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/mfa/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Mfa::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\Mfa" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/Mfa.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/index.mdx new file mode 100644 index 0000000000..75d45068a0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/mfa" +title: "Mfa" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Mfa" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php" +--- +# `Mfa` + +Multi-factor authentication via SMS or phone call. + +## Signature + +```php +class Mfa +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/Mfa.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/sms.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/sms.mdx new file mode 100644 index 0000000000..9d583e7531 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/sms.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/mfa/sms" +title: "sms" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Mfa::sms" + parent: "SignalWire\\REST\\Namespaces\\Mfa" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php" + visibility: "public" +--- +# `sms` + +## Signature + +```php +public function sms(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Mfa.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/verify.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/verify.mdx new file mode 100644 index 0000000000..6b24453275 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/mfa/verify.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/mfa/verify" +title: "verify" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Mfa::verify" + parent: "SignalWire\\REST\\Namespaces\\Mfa" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php" + visibility: "public" +--- +# `verify` + +## Signature + +```php +public function verify(string $requestId, array $body): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Mfa.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Mfa.php) + +Line 40. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/construct.mdx new file mode 100644 index 0000000000..a6411b7309 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ProjectTokens::__construct" + parent: "SignalWire\\REST\\Namespaces\\ProjectTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/ProjectTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/create.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/create.mdx new file mode 100644 index 0000000000..485564d80f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/create" +title: "create" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ProjectTokens::create" + parent: "SignalWire\\REST\\Namespaces\\ProjectTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php" + visibility: "public" +--- +# `create` + +## Signature + +```php +public function create(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/ProjectTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/delete.mdx new file mode 100644 index 0000000000..73bfd61cb7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ProjectTokens::delete" + parent: "SignalWire\\REST\\Namespaces\\ProjectTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $tokenId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/ProjectTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php) + +Line 40. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/get-base-path.mdx new file mode 100644 index 0000000000..db7d7d2c24 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ProjectTokens::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\ProjectTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/ProjectTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/index.mdx new file mode 100644 index 0000000000..d44bc1ccbe --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/project-tokens" +title: "ProjectTokens" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ProjectTokens" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php" +--- +# `ProjectTokens` + +Project API token management — create / update (PATCH) / delete. + +## Signature + +```php +class ProjectTokens +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/ProjectTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/update.mdx new file mode 100644 index 0000000000..bd686c8404 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/project-tokens/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ProjectTokens::update" + parent: "SignalWire\\REST\\Namespaces\\ProjectTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php" + visibility: "public" +--- +# `update` + +## Signature + +```php +public function update(string $tokenId, array $body): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/ProjectTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ProjectTokens.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/construct.mdx new file mode 100644 index 0000000000..40f702bf8f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/project/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Project::__construct" + parent: "SignalWire\\REST\\Namespaces\\Project" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Project.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/Project.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Project.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/get-http.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/get-http.mdx new file mode 100644 index 0000000000..6dcf1a9521 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/get-http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/project/get-http" +title: "getHttp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Project::getHttp" + parent: "SignalWire\\REST\\Namespaces\\Project" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Project.php" + visibility: "public" +--- +# `getHttp` + +## Signature + +```php +public function getHttp(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/Namespaces/Project.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Project.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/index.mdx new file mode 100644 index 0000000000..c3028d398e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/project" +title: "Project" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Project" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Project.php" +--- +# `Project` + +Project API namespace — currently exposes the project tokens sub-resource. + +## Signature + +```php +class Project +``` + +## Methods + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/Project.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Project.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/tokens.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/tokens.mdx new file mode 100644 index 0000000000..2d1ae8b74c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/project/tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/project/tokens" +title: "tokens" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Project::tokens" + parent: "SignalWire\\REST\\Namespaces\\Project" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Project.php" + visibility: "public" +--- +# `tokens` + +## Signature + +```php +public function tokens(): SignalWire\REST\Namespaces\ProjectTokens +``` + +## Returns + +`SignalWire\REST\Namespaces\ProjectTokens` + +## Source + +[`SignalWire/REST/Namespaces/Project.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Project.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/construct.mdx new file mode 100644 index 0000000000..a4c2573da9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/recordings/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Recordings::__construct" + parent: "SignalWire\\REST\\Namespaces\\Recordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/Recordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/delete.mdx new file mode 100644 index 0000000000..8f468e42ff --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/recordings/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Recordings::delete" + parent: "SignalWire\\REST\\Namespaces\\Recordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $recordingId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Recordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php) + +Line 40. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/get-base-path.mdx new file mode 100644 index 0000000000..2dfec23d4c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/recordings/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Recordings::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\Recordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/Recordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/get.mdx new file mode 100644 index 0000000000..b0ab51e1a1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/recordings/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Recordings::get" + parent: "SignalWire\\REST\\Namespaces\\Recordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $recordingId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Recordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/index.mdx new file mode 100644 index 0000000000..7ac18e1c81 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/recordings" +title: "Recordings" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Recordings" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php" +--- +# `Recordings` + +Recordings — read-only list/get plus delete (no create or update). + +## Signature + +```php +class Recordings +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/Recordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/list.mdx new file mode 100644 index 0000000000..f3b091c466 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/recordings/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/recordings/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Recordings::list" + parent: "SignalWire\\REST\\Namespaces\\Recordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/Recordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Recordings.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/construct.mdx new file mode 100644 index 0000000000..b9c0c103d9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryBrands::__construct" + parent: "SignalWire\\REST\\Namespaces\\RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/RegistryBrands.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/create-campaign.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/create-campaign.mdx new file mode 100644 index 0000000000..12a9314dcf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/create-campaign.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/create-campaign" +title: "createCampaign" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryBrands::createCampaign" + parent: "SignalWire\\REST\\Namespaces\\RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php" + visibility: "public" +--- +# `createCampaign` + +## Signature + +```php +public function createCampaign(string $brandId, array $body): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryBrands.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php) + +Line 53. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/create.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/create.mdx new file mode 100644 index 0000000000..594be3054c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/create" +title: "create" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryBrands::create" + parent: "SignalWire\\REST\\Namespaces\\RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php" + visibility: "public" +--- +# `create` + +## Signature + +```php +public function create(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryBrands.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/get-base-path.mdx new file mode 100644 index 0000000000..97d8d5776b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryBrands::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/RegistryBrands.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/get.mdx new file mode 100644 index 0000000000..3ad4395655 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryBrands::get" + parent: "SignalWire\\REST\\Namespaces\\RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $brandId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryBrands.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php) + +Line 41. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/index.mdx new file mode 100644 index 0000000000..ef515741e0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-brands" +title: "RegistryBrands" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryBrands" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php" +--- +# `RegistryBrands` + +10DLC brand management — list, create, get, list\_campaigns, create\_campaign. + +## Signature + +```php +class RegistryBrands +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/RegistryBrands.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/list-campaigns.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/list-campaigns.mdx new file mode 100644 index 0000000000..7397d42aa0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/list-campaigns.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/list-campaigns" +title: "listCampaigns" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryBrands::listCampaigns" + parent: "SignalWire\\REST\\Namespaces\\RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php" + visibility: "public" +--- +# `listCampaigns` + +## Signature + +```php +public function listCampaigns(string $brandId, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryBrands.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php) + +Line 47. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/list.mdx new file mode 100644 index 0000000000..442412eb01 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-brands/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryBrands::list" + parent: "SignalWire\\REST\\Namespaces\\RegistryBrands" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryBrands.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryBrands.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/construct.mdx new file mode 100644 index 0000000000..3d0862bfd7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryCampaigns::__construct" + parent: "SignalWire\\REST\\Namespaces\\RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/RegistryCampaigns.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php) + +Line 18. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/create-order.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/create-order.mdx new file mode 100644 index 0000000000..667511ea22 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/create-order.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/create-order" +title: "createOrder" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryCampaigns::createOrder" + parent: "SignalWire\\REST\\Namespaces\\RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php" + visibility: "public" +--- +# `createOrder` + +## Signature + +```php +public function createOrder(string $campaignId, array $body): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryCampaigns.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php) + +Line 59. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/get-base-path.mdx new file mode 100644 index 0000000000..c3327c336d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryCampaigns::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/RegistryCampaigns.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php) + +Line 24. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/get.mdx new file mode 100644 index 0000000000..6225ba2111 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryCampaigns::get" + parent: "SignalWire\\REST\\Namespaces\\RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $campaignId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryCampaigns.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php) + +Line 30. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/index.mdx new file mode 100644 index 0000000000..0e2375843b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns" +title: "RegistryCampaigns" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryCampaigns" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php" +--- +# `RegistryCampaigns` + +10DLC campaign management — get, update (PUT), list\_numbers, + +list\_orders, create\_order. + +## Signature + +```php +class RegistryCampaigns +``` + +## Methods + + + + + + + + + + + + + + + + Update uses PUT (not PATCH) to mirror the Python `RegistryCampaigns`. + + + +## Source + +[`SignalWire/REST/Namespaces/RegistryCampaigns.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/list-numbers.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/list-numbers.mdx new file mode 100644 index 0000000000..69058f87a3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/list-numbers.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/list-numbers" +title: "listNumbers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryCampaigns::listNumbers" + parent: "SignalWire\\REST\\Namespaces\\RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php" + visibility: "public" +--- +# `listNumbers` + +## Signature + +```php +public function listNumbers(string $campaignId, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryCampaigns.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php) + +Line 47. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/list-orders.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/list-orders.mdx new file mode 100644 index 0000000000..eae326843c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/list-orders.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/list-orders" +title: "listOrders" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryCampaigns::listOrders" + parent: "SignalWire\\REST\\Namespaces\\RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php" + visibility: "public" +--- +# `listOrders` + +## Signature + +```php +public function listOrders(string $campaignId, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryCampaigns.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php) + +Line 53. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/update.mdx new file mode 100644 index 0000000000..a4c64f9a10 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-campaigns/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryCampaigns::update" + parent: "SignalWire\\REST\\Namespaces\\RegistryCampaigns" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php" + visibility: "public" +--- +# `update` + +Update uses PUT (not PATCH) to mirror the Python `RegistryCampaigns`. + +## Signature + +```php +public function update(string $campaignId, array $body): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryCampaigns.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryCampaigns.php) + +Line 41. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/construct.mdx new file mode 100644 index 0000000000..289663bb84 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryNumbers::__construct" + parent: "SignalWire\\REST\\Namespaces\\RegistryNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryNumbers.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/RegistryNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryNumbers.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/delete.mdx new file mode 100644 index 0000000000..285eb31024 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryNumbers::delete" + parent: "SignalWire\\REST\\Namespaces\\RegistryNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryNumbers.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $numberId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryNumbers.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/get-base-path.mdx new file mode 100644 index 0000000000..3847f40c6c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryNumbers::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\RegistryNumbers" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryNumbers.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/RegistryNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryNumbers.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/index.mdx new file mode 100644 index 0000000000..1347b36438 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-numbers" +title: "RegistryNumbers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryNumbers" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryNumbers.php" +--- +# `RegistryNumbers` + +10DLC number assignment management — release a number. + +## Signature + +```php +class RegistryNumbers +``` + +## Methods + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/RegistryNumbers.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryNumbers.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/construct.mdx new file mode 100644 index 0000000000..9ada55bfc1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryOrders::__construct" + parent: "SignalWire\\REST\\Namespaces\\RegistryOrders" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryOrders.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/RegistryOrders.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryOrders.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/get-base-path.mdx new file mode 100644 index 0000000000..6dea3b8744 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryOrders::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\RegistryOrders" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryOrders.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/RegistryOrders.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryOrders.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/get.mdx new file mode 100644 index 0000000000..74b20fa9d6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryOrders::get" + parent: "SignalWire\\REST\\Namespaces\\RegistryOrders" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryOrders.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $orderId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/RegistryOrders.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryOrders.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/index.mdx new file mode 100644 index 0000000000..ead8a5a9b6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry-orders/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry-orders" +title: "RegistryOrders" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\RegistryOrders" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryOrders.php" +--- +# `RegistryOrders` + +10DLC assignment order management — read-only, retrieve by id. + +## Signature + +```php +class RegistryOrders +``` + +## Methods + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/RegistryOrders.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/RegistryOrders.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/brands.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/brands.mdx new file mode 100644 index 0000000000..c5a5488f6f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/brands.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry/brands" +title: "brands" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Registry::brands" + parent: "SignalWire\\REST\\Namespaces\\Registry" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php" + visibility: "public" +--- +# `brands` + +## Signature + +```php +public function brands(): SignalWire\REST\Namespaces\RegistryBrands +``` + +## Returns + +`SignalWire\REST\Namespaces\RegistryBrands` + +## Source + +[`SignalWire/REST/Namespaces/Registry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/campaigns.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/campaigns.mdx new file mode 100644 index 0000000000..28634670c8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/campaigns.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry/campaigns" +title: "campaigns" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Registry::campaigns" + parent: "SignalWire\\REST\\Namespaces\\Registry" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php" + visibility: "public" +--- +# `campaigns` + +## Signature + +```php +public function campaigns(): SignalWire\REST\Namespaces\RegistryCampaigns +``` + +## Returns + +`SignalWire\REST\Namespaces\RegistryCampaigns` + +## Source + +[`SignalWire/REST/Namespaces/Registry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php) + +Line 39. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/construct.mdx new file mode 100644 index 0000000000..a029c61367 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Registry::__construct" + parent: "SignalWire\\REST\\Namespaces\\Registry" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/Registry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php) + +Line 25. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/get-http.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/get-http.mdx new file mode 100644 index 0000000000..532b185474 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/get-http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry/get-http" +title: "getHttp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Registry::getHttp" + parent: "SignalWire\\REST\\Namespaces\\Registry" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php" + visibility: "public" +--- +# `getHttp` + +## Signature + +```php +public function getHttp(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/Namespaces/Registry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php) + +Line 54. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/index.mdx new file mode 100644 index 0000000000..a415f62079 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry" +title: "Registry" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Registry" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php" +--- +# `Registry` + +10DLC Campaign Registry namespace — brands, campaigns, orders, numbers. + +Mirrors Python `signalwire.rest.namespaces.registry.RegistryNamespace`. +All registry endpoints sit under `/api/relay/rest/registry/beta`. + +## Signature + +```php +class Registry +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/Registry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php) + +Line 15. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/numbers.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/numbers.mdx new file mode 100644 index 0000000000..ac6286b8ee --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/numbers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry/numbers" +title: "numbers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Registry::numbers" + parent: "SignalWire\\REST\\Namespaces\\Registry" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php" + visibility: "public" +--- +# `numbers` + +## Signature + +```php +public function numbers(): SignalWire\REST\Namespaces\RegistryNumbers +``` + +## Returns + +`SignalWire\REST\Namespaces\RegistryNumbers` + +## Source + +[`SignalWire/REST/Namespaces/Registry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php) + +Line 49. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/orders.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/orders.mdx new file mode 100644 index 0000000000..e6eefdffac --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/registry/orders.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/registry/orders" +title: "orders" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Registry::orders" + parent: "SignalWire\\REST\\Namespaces\\Registry" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php" + visibility: "public" +--- +# `orders` + +## Signature + +```php +public function orders(): SignalWire\REST\Namespaces\RegistryOrders +``` + +## Returns + +`SignalWire\REST\Namespaces\RegistryOrders` + +## Source + +[`SignalWire/REST/Namespaces/Registry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Registry.php) + +Line 44. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/construct.mdx new file mode 100644 index 0000000000..21123d8180 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/short-codes/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ShortCodes::__construct" + parent: "SignalWire\\REST\\Namespaces\\ShortCodes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/ShortCodes.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/get-base-path.mdx new file mode 100644 index 0000000000..2369e98271 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/short-codes/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ShortCodes::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\ShortCodes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/ShortCodes.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/get.mdx new file mode 100644 index 0000000000..36a19c5a99 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/short-codes/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ShortCodes::get" + parent: "SignalWire\\REST\\Namespaces\\ShortCodes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $shortCodeId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/ShortCodes.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/index.mdx new file mode 100644 index 0000000000..8bca1f8ab5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/short-codes" +title: "ShortCodes" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ShortCodes" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php" +--- +# `ShortCodes` + +Short codes management — read + update (PUT) only. + +## Signature + +```php +class ShortCodes +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/ShortCodes.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/list.mdx new file mode 100644 index 0000000000..106fcc5550 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/short-codes/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ShortCodes::list" + parent: "SignalWire\\REST\\Namespaces\\ShortCodes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/ShortCodes.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/update.mdx new file mode 100644 index 0000000000..cac449b3bb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/short-codes/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/short-codes/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\ShortCodes::update" + parent: "SignalWire\\REST\\Namespaces\\ShortCodes" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php" + visibility: "public" +--- +# `update` + +## Signature + +```php +public function update(string $shortCodeId, array $body): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/ShortCodes.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/ShortCodes.php) + +Line 40. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/construct.mdx new file mode 100644 index 0000000000..995e795136 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\SipProfile::__construct" + parent: "SignalWire\\REST\\Namespaces\\SipProfile" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/SipProfile.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/SipProfile.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/SipProfile.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/get-base-path.mdx new file mode 100644 index 0000000000..25548831e3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\SipProfile::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\SipProfile" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/SipProfile.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/SipProfile.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/SipProfile.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/get.mdx new file mode 100644 index 0000000000..aa56ddd91b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\SipProfile::get" + parent: "SignalWire\\REST\\Namespaces\\SipProfile" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/SipProfile.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/SipProfile.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/SipProfile.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/index.mdx new file mode 100644 index 0000000000..48b51b4a97 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/sip-profile" +title: "SipProfile" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\SipProfile" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/SipProfile.php" +--- +# `SipProfile` + +Project SIP profile (singleton resource) — get + update (PUT). + +## Signature + +```php +class SipProfile +``` + +## Methods + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/SipProfile.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/SipProfile.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/update.mdx new file mode 100644 index 0000000000..14c193cb63 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/sip-profile/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\SipProfile::update" + parent: "SignalWire\\REST\\Namespaces\\SipProfile" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/SipProfile.php" + visibility: "public" +--- +# `update` + +## Signature + +```php +public function update(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/SipProfile.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/SipProfile.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/construct.mdx new file mode 100644 index 0000000000..e6418d4f45 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoConferenceTokens::__construct" + parent: "SignalWire\\REST\\Namespaces\\VideoConferenceTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoConferenceTokens.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/VideoConferenceTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoConferenceTokens.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/get-base-path.mdx new file mode 100644 index 0000000000..b32af503e6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoConferenceTokens::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\VideoConferenceTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoConferenceTokens.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/VideoConferenceTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoConferenceTokens.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/get.mdx new file mode 100644 index 0000000000..f462366ede --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoConferenceTokens::get" + parent: "SignalWire\\REST\\Namespaces\\VideoConferenceTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoConferenceTokens.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $tokenId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoConferenceTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoConferenceTokens.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/index.mdx new file mode 100644 index 0000000000..76a3e0d265 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens" +title: "VideoConferenceTokens" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoConferenceTokens" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoConferenceTokens.php" +--- +# `VideoConferenceTokens` + +Video conference token management — get + reset. + +## Signature + +```php +class VideoConferenceTokens +``` + +## Methods + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/VideoConferenceTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoConferenceTokens.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/reset.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/reset.mdx new file mode 100644 index 0000000000..ff934fb746 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/reset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-conference-tokens/reset" +title: "reset" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoConferenceTokens::reset" + parent: "SignalWire\\REST\\Namespaces\\VideoConferenceTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoConferenceTokens.php" + visibility: "public" +--- +# `reset` + +## Signature + +```php +public function reset(string $tokenId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoConferenceTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoConferenceTokens.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/construct.mdx new file mode 100644 index 0000000000..695c8302ea --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings::__construct" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php) + +Line 18. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/delete.mdx new file mode 100644 index 0000000000..42c4995c49 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings::delete" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $recordingId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php) + +Line 42. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/get-base-path.mdx new file mode 100644 index 0000000000..906364a7b2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php) + +Line 24. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/get.mdx new file mode 100644 index 0000000000..05055473aa --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings::get" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $recordingId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php) + +Line 36. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/index.mdx new file mode 100644 index 0000000000..6ba94f4b29 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings" +title: "VideoRoomRecordings" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php" +--- +# `VideoRoomRecordings` + +Video room recording management — top-level recordings collection + +(distinct from session-scoped recordings). + +## Signature + +```php +class VideoRoomRecordings +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/list-events.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/list-events.mdx new file mode 100644 index 0000000000..7847337bdb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/list-events.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/list-events" +title: "listEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings::listEvents" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php" + visibility: "public" +--- +# `listEvents` + +## Signature + +```php +public function listEvents(string $recordingId, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/list.mdx new file mode 100644 index 0000000000..dfae70c404 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-recordings/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings::list" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomRecordings" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomRecordings.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomRecordings.php) + +Line 30. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/construct.mdx new file mode 100644 index 0000000000..aa6b431d69 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomSessions::__construct" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomSessions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php) + +Line 18. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/get-base-path.mdx new file mode 100644 index 0000000000..f58ce74c45 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomSessions::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomSessions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php) + +Line 24. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/get.mdx new file mode 100644 index 0000000000..03c7a4873c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomSessions::get" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $sessionId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomSessions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php) + +Line 36. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/index.mdx new file mode 100644 index 0000000000..47394a9add --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions" +title: "VideoRoomSessions" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomSessions" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php" +--- +# `VideoRoomSessions` + +Video room session management. Read-only with several sub-collections + +(events, members, recordings). + +## Signature + +```php +class VideoRoomSessions +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomSessions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-events.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-events.mdx new file mode 100644 index 0000000000..c8abffb092 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-events.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-events" +title: "listEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomSessions::listEvents" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php" + visibility: "public" +--- +# `listEvents` + +## Signature + +```php +public function listEvents(string $sessionId, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomSessions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php) + +Line 42. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-members.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-members.mdx new file mode 100644 index 0000000000..ea5ff5abf1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-members.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-members" +title: "listMembers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomSessions::listMembers" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php" + visibility: "public" +--- +# `listMembers` + +## Signature + +```php +public function listMembers(string $sessionId, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomSessions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-recordings.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-recordings.mdx new file mode 100644 index 0000000000..61d3d060f2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-recordings.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list-recordings" +title: "listRecordings" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomSessions::listRecordings" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php" + visibility: "public" +--- +# `listRecordings` + +## Signature + +```php +public function listRecordings(string $sessionId, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomSessions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php) + +Line 54. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list.mdx new file mode 100644 index 0000000000..4b129a60d2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-sessions/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomSessions::list" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomSessions" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomSessions.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomSessions.php) + +Line 30. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/construct.mdx new file mode 100644 index 0000000000..f58cdd7b2b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomTokens::__construct" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomTokens.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomTokens.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/create.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/create.mdx new file mode 100644 index 0000000000..68a8240de5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/create" +title: "create" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomTokens::create" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomTokens.php" + visibility: "public" +--- +# `create` + +## Signature + +```php +public function create(array $body): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomTokens.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/get-base-path.mdx new file mode 100644 index 0000000000..36b8a2e662 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomTokens::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\VideoRoomTokens" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomTokens.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomTokens.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/index.mdx new file mode 100644 index 0000000000..5fa7a28e96 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-room-tokens" +title: "VideoRoomTokens" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoRoomTokens" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomTokens.php" +--- +# `VideoRoomTokens` + +Video room token generation. Surface is `create` only. + +## Signature + +```php +class VideoRoomTokens +``` + +## Methods + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/VideoRoomTokens.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoRoomTokens.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/construct.mdx new file mode 100644 index 0000000000..735237173b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-streams/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoStreams::__construct" + parent: "SignalWire\\REST\\Namespaces\\VideoStreams" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/VideoStreams.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/delete.mdx new file mode 100644 index 0000000000..f6899cee7a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-streams/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoStreams::delete" + parent: "SignalWire\\REST\\Namespaces\\VideoStreams" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $streamId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoStreams.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php) + +Line 41. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/get-base-path.mdx new file mode 100644 index 0000000000..61843535ae --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-streams/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoStreams::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\VideoStreams" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/VideoStreams.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/get.mdx new file mode 100644 index 0000000000..e181f8d90a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-streams/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoStreams::get" + parent: "SignalWire\\REST\\Namespaces\\VideoStreams" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $streamId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoStreams.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/index.mdx new file mode 100644 index 0000000000..a809dd4241 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-streams" +title: "VideoStreams" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoStreams" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php" +--- +# `VideoStreams` + +Top-level video stream management — get / update (PUT) / delete. + +## Signature + +```php +class VideoStreams +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/VideoStreams.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/update.mdx new file mode 100644 index 0000000000..aead4695d9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video-streams/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video-streams/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VideoStreams::update" + parent: "SignalWire\\REST\\Namespaces\\VideoStreams" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php" + visibility: "public" +--- +# `update` + +## Signature + +```php +public function update(string $streamId, array $body): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VideoStreams.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VideoStreams.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/conference-tokens.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/conference-tokens.mdx new file mode 100644 index 0000000000..45f354a952 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/conference-tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video/conference-tokens" +title: "conferenceTokens" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Video::conferenceTokens" + parent: "SignalWire\\REST\\Namespaces\\Video" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php" + visibility: "public" +--- +# `conferenceTokens` + +## Signature + +```php +public function conferenceTokens(): SignalWire\REST\Namespaces\VideoConferenceTokens +``` + +## Returns + +`SignalWire\REST\Namespaces\VideoConferenceTokens` + +## Source + +[`SignalWire/REST/Namespaces/Video.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php) + +Line 72. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/conferences.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/conferences.mdx new file mode 100644 index 0000000000..f8888953c9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/conferences.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video/conferences" +title: "conferences" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Video::conferences" + parent: "SignalWire\\REST\\Namespaces\\Video" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php" + visibility: "public" +--- +# `conferences` + +## Signature + +```php +public function conferences(): SignalWire\REST\Namespaces\VideoConferences +``` + +## Returns + +`SignalWire\REST\Namespaces\VideoConferences` + +## Source + +[`SignalWire/REST/Namespaces/Video.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php) + +Line 67. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/construct.mdx new file mode 100644 index 0000000000..63e91c3d23 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Video::__construct" + parent: "SignalWire\\REST\\Namespaces\\Video" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http) +``` + +## Parameters + + + +## Source + +[`SignalWire/REST/Namespaces/Video.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/get-http.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/get-http.mdx new file mode 100644 index 0000000000..58b49c0f46 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/get-http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video/get-http" +title: "getHttp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Video::getHttp" + parent: "SignalWire\\REST\\Namespaces\\Video" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php" + visibility: "public" +--- +# `getHttp` + +## Signature + +```php +public function getHttp(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/Namespaces/Video.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php) + +Line 42. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/index.mdx new file mode 100644 index 0000000000..ea4f9dcb42 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video" +title: "Video" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Video" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php" +--- +# `Video` + +Video API namespace. + +Mirrors Python `signalwire.rest.namespaces.video.VideoNamespace`: groups +the Video API sub-resources (rooms, room\_sessions, room\_recordings, +conferences, conference\_tokens, streams) under one object. + +## Signature + +```php +class Video +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/Video.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/room-recordings.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/room-recordings.mdx new file mode 100644 index 0000000000..a5537748f2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/room-recordings.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video/room-recordings" +title: "roomRecordings" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Video::roomRecordings" + parent: "SignalWire\\REST\\Namespaces\\Video" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php" + visibility: "public" +--- +# `roomRecordings` + +## Signature + +```php +public function roomRecordings(): SignalWire\REST\Namespaces\VideoRoomRecordings +``` + +## Returns + +`SignalWire\REST\Namespaces\VideoRoomRecordings` + +## Source + +[`SignalWire/REST/Namespaces/Video.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/room-sessions.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/room-sessions.mdx new file mode 100644 index 0000000000..7fd61b1fa6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/room-sessions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video/room-sessions" +title: "roomSessions" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Video::roomSessions" + parent: "SignalWire\\REST\\Namespaces\\Video" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php" + visibility: "public" +--- +# `roomSessions` + +## Signature + +```php +public function roomSessions(): SignalWire\REST\Namespaces\VideoRoomSessions +``` + +## Returns + +`SignalWire\REST\Namespaces\VideoRoomSessions` + +## Source + +[`SignalWire/REST/Namespaces/Video.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php) + +Line 57. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/room-tokens.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/room-tokens.mdx new file mode 100644 index 0000000000..72e3cc7d9d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/room-tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video/room-tokens" +title: "roomTokens" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Video::roomTokens" + parent: "SignalWire\\REST\\Namespaces\\Video" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php" + visibility: "public" +--- +# `roomTokens` + +## Signature + +```php +public function roomTokens(): SignalWire\REST\Namespaces\VideoRoomTokens +``` + +## Returns + +`SignalWire\REST\Namespaces\VideoRoomTokens` + +## Source + +[`SignalWire/REST/Namespaces/Video.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php) + +Line 52. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/rooms.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/rooms.mdx new file mode 100644 index 0000000000..454ffa16a5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/rooms.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video/rooms" +title: "rooms" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Video::rooms" + parent: "SignalWire\\REST\\Namespaces\\Video" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php" + visibility: "public" +--- +# `rooms` + +## Signature + +```php +public function rooms(): SignalWire\REST\Namespaces\VideoRooms +``` + +## Returns + +`SignalWire\REST\Namespaces\VideoRooms` + +## Source + +[`SignalWire/REST/Namespaces/Video.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php) + +Line 47. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/streams.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/streams.mdx new file mode 100644 index 0000000000..c098e22cf0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/video/streams.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/video/streams" +title: "streams" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\Video::streams" + parent: "SignalWire\\REST\\Namespaces\\Video" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php" + visibility: "public" +--- +# `streams` + +## Signature + +```php +public function streams(): SignalWire\REST\Namespaces\VideoStreams +``` + +## Returns + +`SignalWire\REST\Namespaces\VideoStreams` + +## Source + +[`SignalWire/REST/Namespaces/Video.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/Video.php) + +Line 77. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/construct.mdx new file mode 100644 index 0000000000..357e4a82f2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VoiceLogs::__construct" + parent: "SignalWire\\REST\\Namespaces\\VoiceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/Namespaces/VoiceLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/get-base-path.mdx new file mode 100644 index 0000000000..5b64e078a1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VoiceLogs::getBasePath" + parent: "SignalWire\\REST\\Namespaces\\VoiceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/Namespaces/VoiceLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/get.mdx new file mode 100644 index 0000000000..d936232074 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VoiceLogs::get" + parent: "SignalWire\\REST\\Namespaces\\VoiceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $logId): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VoiceLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/index.mdx new file mode 100644 index 0000000000..6bd9632d18 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/voice-logs" +title: "VoiceLogs" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VoiceLogs" + parent: "SignalWire\\REST\\Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php" +--- +# `VoiceLogs` + +Voice log queries — list + get by id + per-id event sub-collection. + +## Signature + +```php +class VoiceLogs +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/Namespaces/VoiceLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/list-events.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/list-events.mdx new file mode 100644 index 0000000000..22c3c32a1b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/list-events.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/list-events" +title: "listEvents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VoiceLogs::listEvents" + parent: "SignalWire\\REST\\Namespaces\\VoiceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php" + visibility: "public" +--- +# `listEvents` + +## Signature + +```php +public function listEvents(string $logId, array $params = array ( +)): array +``` + +## Parameters + + + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VoiceLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php) + +Line 41. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/list.mdx new file mode 100644 index 0000000000..053e45bea7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/list.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/rest/namespaces/namespaces/voice-logs/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\Namespaces\\VoiceLogs::list" + parent: "SignalWire\\REST\\Namespaces\\VoiceLogs" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php" + visibility: "public" +--- +# `list` + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + @return array\ + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/Namespaces/VoiceLogs.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/Namespaces/VoiceLogs.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/construct.mdx new file mode 100644 index 0000000000..e6534c4d22 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/base-resource/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\BaseResource::__construct" + parent: "SignalWire\\REST\\BaseResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $http, string $base_path) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 21. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/get-base-path.mdx new file mode 100644 index 0000000000..0a7f8e3788 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/base-resource/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\BaseResource::getBasePath" + parent: "SignalWire\\REST\\BaseResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/get-http.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/get-http.mdx new file mode 100644 index 0000000000..1a4d05879e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/get-http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/base-resource/get-http" +title: "getHttp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\BaseResource::getHttp" + parent: "SignalWire\\REST\\BaseResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `getHttp` + +## Signature + +```php +public function getHttp(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/index.mdx new file mode 100644 index 0000000000..720d3b3a62 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/base-resource/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/base-resource" +title: "BaseResource" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\BaseResource" + parent: "SignalWire\\REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" +--- +# `BaseResource` + +Common base class for namespace and resource classes. + +Mirrors Python's signalwire.rest.\_base.BaseResource — minimal wrapper +around an HttpClient and a base path. CrudResource extends this for +standard REST collection+item access; namespace classes that want a +shared base path (without inheriting list/create/get/update/delete) +can subclass BaseResource directly. + +## Signature + +```php +class BaseResource +``` + +## Methods + + + + + + + + + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 16. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/construct.mdx new file mode 100644 index 0000000000..bd59904d64 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-resource/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudResource::__construct" + parent: "SignalWire\\REST\\CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $client, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 59. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/create.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/create.mdx new file mode 100644 index 0000000000..6d85382ff7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/create.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-resource/create" +title: "create" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudResource::create" + parent: "SignalWire\\REST\\CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `create` + +Create a new resource (POST basePath). + +## Signature + +```php +public function create(array $data): array +``` + +## Parameters + + + JSON body. + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 105. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/delete.mdx new file mode 100644 index 0000000000..5021b796bc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/delete.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-resource/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudResource::delete" + parent: "SignalWire\\REST\\CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `delete` + +Delete a resource by ID (DELETE basePath/\{id\}). + +## Signature + +```php +public function delete(string $id): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 136. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get-base-path.mdx new file mode 100644 index 0000000000..04ba0182be --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-resource/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudResource::getBasePath" + parent: "SignalWire\\REST\\CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 65. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get-client.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get-client.mdx new file mode 100644 index 0000000000..71bbcb92e0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-resource/get-client" +title: "getClient" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudResource::getClient" + parent: "SignalWire\\REST\\CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `getClient` + +## Signature + +```php +public function getClient(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 70. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get-http.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get-http.mdx new file mode 100644 index 0000000000..c4293235e9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get-http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-resource/get-http" +title: "getHttp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudResource::getHttp" + parent: "SignalWire\\REST\\CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `getHttp` + +## Signature + +```php +public function getHttp(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get.mdx new file mode 100644 index 0000000000..1cdcc12be3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-resource/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudResource::get" + parent: "SignalWire\\REST\\CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `get` + +Retrieve a single resource by ID (GET basePath/\{id\}). + +## Signature + +```php +public function get(string $id): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 115. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/index.mdx new file mode 100644 index 0000000000..2d89b38a49 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-resource" +title: "CrudResource" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\CrudResource" + parent: "SignalWire\\REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" +--- +# `CrudResource` + +Generic CRUD wrapper around an HttpClient and a base API path. + +Provides list / create / get / update / delete for any REST resource that +follows the standard SignalWire collection+item URL pattern. + +## Signature + +```php +class CrudResource extends BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire\REST\BaseResource](/reference/php/signal-wire/rest/rest/base-resource) + +## Methods + + + + + + Create a new resource (POST basePath). + + + + Delete a resource by ID (DELETE basePath/\{id\}). + + + + Retrieve a single resource by ID (GET basePath/\{id\}). + + + + + + + + + + List resources (GET basePath). + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 55. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/list.mdx new file mode 100644 index 0000000000..c3c653e480 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/list.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-resource/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudResource::list" + parent: "SignalWire\\REST\\CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `list` + +List resources (GET basePath). + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + Query-string parameters. + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 94. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/update.mdx new file mode 100644 index 0000000000..fbf9c61f7d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-resource/update.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-resource/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudResource::update" + parent: "SignalWire\\REST\\CrudResource" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `update` + +Update a resource by ID (PUT basePath/\{id\}). + +## Signature + +```php +public function update(string $id, array $data): array +``` + +## Parameters + + + + + JSON body. + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/construct.mdx new file mode 100644 index 0000000000..b17a23cdc1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-with-addresses/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudWithAddresses::__construct" + parent: "SignalWire\\REST\\CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(SignalWire\REST\HttpClient $client, string $basePath) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 59. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/create.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/create.mdx new file mode 100644 index 0000000000..5682fe26c6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/create.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-with-addresses/create" +title: "create" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudWithAddresses::create" + parent: "SignalWire\\REST\\CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `create` + +Create a new resource (POST basePath). + +## Signature + +```php +public function create(array $data): array +``` + +## Parameters + + + JSON body. + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 105. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/delete.mdx new file mode 100644 index 0000000000..9a33bda98e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/delete.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-with-addresses/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudWithAddresses::delete" + parent: "SignalWire\\REST\\CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `delete` + +Delete a resource by ID (DELETE basePath/\{id\}). + +## Signature + +```php +public function delete(string $id): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 136. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get-base-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get-base-path.mdx new file mode 100644 index 0000000000..fe93cee4f6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get-base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-with-addresses/get-base-path" +title: "getBasePath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudWithAddresses::getBasePath" + parent: "SignalWire\\REST\\CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `getBasePath` + +## Signature + +```php +public function getBasePath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 65. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get-client.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get-client.mdx new file mode 100644 index 0000000000..360aaca5a4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get-client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-with-addresses/get-client" +title: "getClient" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudWithAddresses::getClient" + parent: "SignalWire\\REST\\CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `getClient` + +## Signature + +```php +public function getClient(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 70. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get-http.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get-http.mdx new file mode 100644 index 0000000000..668c0b19c4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get-http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-with-addresses/get-http" +title: "getHttp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudWithAddresses::getHttp" + parent: "SignalWire\\REST\\CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `getHttp` + +## Signature + +```php +public function getHttp(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get.mdx new file mode 100644 index 0000000000..dbe2b3d48d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-with-addresses/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudWithAddresses::get" + parent: "SignalWire\\REST\\CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `get` + +Retrieve a single resource by ID (GET basePath/\{id\}). + +## Signature + +```php +public function get(string $id): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 115. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/index.mdx new file mode 100644 index 0000000000..988e3ab1e6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-with-addresses" +title: "CrudWithAddresses" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\CrudWithAddresses" + parent: "SignalWire\\REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" +--- +# `CrudWithAddresses` + +CRUD resource that also supports listing addresses for an item. + +Mirrors Python's signalwire.rest.\_base.CrudWithAddresses — adds +list\_addresses(resource\_id, \*\*params) on top of the standard CRUD set. + +## Signature + +```php +class CrudWithAddresses extends CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire\REST\CrudResource](/reference/php/signal-wire/rest/rest/crud-resource) + +## Methods + + + + + + Create a new resource (POST basePath). + + + + Delete a resource by ID (DELETE basePath/\{id\}). + + + + Retrieve a single resource by ID (GET basePath/\{id\}). + + + + + + + + + + List resources (GET basePath). + + + + List the addresses associated with a resource (GET basePath/\{id\}/addresses). + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 148. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/list-addresses.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/list-addresses.mdx new file mode 100644 index 0000000000..7ac0f55e1d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/list-addresses.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-with-addresses/list-addresses" +title: "listAddresses" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudWithAddresses::listAddresses" + parent: "SignalWire\\REST\\CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `listAddresses` + +List the addresses associated with a resource (GET basePath/\{id\}/addresses). + +## Signature + +```php +public function listAddresses(string $resource_id, array $params = array ( +)): array +``` + +## Parameters + + + + + Query-string parameters. + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 156. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/list.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/list.mdx new file mode 100644 index 0000000000..002a896558 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/list.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-with-addresses/list" +title: "list" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudWithAddresses::list" + parent: "SignalWire\\REST\\CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `list` + +List resources (GET basePath). + +## Signature + +```php +public function list(array $params = array ( +)): array +``` + +## Parameters + + + Query-string parameters. + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 94. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/update.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/update.mdx new file mode 100644 index 0000000000..2b4ffd37fc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/crud-with-addresses/update.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/crud-with-addresses/update" +title: "update" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\CrudWithAddresses::update" + parent: "SignalWire\\REST\\CrudWithAddresses" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php" + visibility: "public" +--- +# `update` + +Update a resource by ID (PUT basePath/\{id\}). + +## Signature + +```php +public function update(string $id, array $data): array +``` + +## Parameters + + + + + JSON body. + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/CrudResource.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/CrudResource.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/construct.mdx new file mode 100644 index 0000000000..0cdaf305b4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/construct.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient::__construct" + parent: "SignalWire\\REST\\HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(string $projectId, string $token, string $baseUrl) +``` + +## Parameters + + + + + + + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 26. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/delete.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/delete.mdx new file mode 100644 index 0000000000..e890faedbb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client/delete" +title: "delete" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient::delete" + parent: "SignalWire\\REST\\HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" + visibility: "public" +--- +# `delete` + +## Signature + +```php +public function delete(string $path): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 97. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-auth-header.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-auth-header.mdx new file mode 100644 index 0000000000..895abc8810 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-auth-header.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client/get-auth-header" +title: "getAuthHeader" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient::getAuthHeader" + parent: "SignalWire\\REST\\HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" + visibility: "public" +--- +# `getAuthHeader` + +## Signature + +```php +public function getAuthHeader(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 49. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-base-url.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-base-url.mdx new file mode 100644 index 0000000000..67d3d76bce --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-base-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client/get-base-url" +title: "getBaseUrl" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient::getBaseUrl" + parent: "SignalWire\\REST\\HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" + visibility: "public" +--- +# `getBaseUrl` + +## Signature + +```php +public function getBaseUrl(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 44. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-project-id.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-project-id.mdx new file mode 100644 index 0000000000..f4259da22e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-project-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client/get-project-id" +title: "getProjectId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient::getProjectId" + parent: "SignalWire\\REST\\HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" + visibility: "public" +--- +# `getProjectId` + +## Signature + +```php +public function getProjectId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-token.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-token.mdx new file mode 100644 index 0000000000..f5a67ec9ae --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client/get-token" +title: "getToken" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient::getToken" + parent: "SignalWire\\REST\\HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" + visibility: "public" +--- +# `getToken` + +## Signature + +```php +public function getToken(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 39. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get.mdx new file mode 100644 index 0000000000..adca9fbdcf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/get.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient::get" + parent: "SignalWire\\REST\\HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" + visibility: "public" +--- +# `get` + +## Signature + +```php +public function get(string $path, array $params = array ( +)): array +``` + +## Parameters + + + + + Query-string parameters. + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/index.mdx new file mode 100644 index 0000000000..ee1e93949e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client" +title: "HttpClient" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient" + parent: "SignalWire\\REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" +--- +# `HttpClient` + +Low-level HTTP client for SignalWire REST APIs. + +Uses cURL for HTTP requests, Basic Auth with project\_id:token, +and returns parsed JSON responses as associative arrays. + +## Signature + +```php +class HttpClient +``` + +## Methods + + + + + + + + + + + + + + + + + + Return a generator that follows `next` links automatically. + + + + + + + + + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/list-all.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/list-all.mdx new file mode 100644 index 0000000000..0546c7af63 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/list-all.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client/list-all" +title: "listAll" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient::listAll" + parent: "SignalWire\\REST\\HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" + visibility: "public" +--- +# `listAll` + +Return a generator that follows `next` links automatically. + +Expects the API to return `{ "data": [...], "links": { "next": "..." } }` +or similar paginated envelope. Each yield is one page (array of items). + +## Signature + +```php +public function listAll(string $path, array $params = array ( +)): Generator +``` + +## Parameters + + + + + Initial query-string parameters. + + +## Returns + +`Generator` + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 115. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/patch.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/patch.mdx new file mode 100644 index 0000000000..db34a44140 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/patch.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client/patch" +title: "patch" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient::patch" + parent: "SignalWire\\REST\\HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" + visibility: "public" +--- +# `patch` + +## Signature + +```php +public function patch(string $path, array $data = array ( +)): array +``` + +## Parameters + + + + + JSON body payload. + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/post.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/post.mdx new file mode 100644 index 0000000000..326f07964b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/post.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client/post" +title: "post" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient::post" + parent: "SignalWire\\REST\\HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" + visibility: "public" +--- +# `post` + +## Signature + +```php +public function post(string $path, array $data = array ( +)): array +``` + +## Parameters + + + + + JSON body payload. + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 71. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/put.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/put.mdx new file mode 100644 index 0000000000..99086699a1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/http-client/put.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/http-client/put" +title: "put" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\HttpClient::put" + parent: "SignalWire\\REST\\HttpClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php" + visibility: "public" +--- +# `put` + +## Signature + +```php +public function put(string $path, array $data = array ( +)): array +``` + +## Parameters + + + + + JSON body payload. + + +## Returns + +`array` + +## Source + +[`SignalWire/REST/HttpClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/HttpClient.php) + +Line 80. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/index.mdx new file mode 100644 index 0000000000..dc63cbd6e9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/php/signal-wire/rest/rest" +title: "REST" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\REST" + module: "SignalWire.REST" +--- +# `REST` + +## Signature + +```php +namespace SignalWire\REST +``` + +## Classes + + + + Common base class for namespace and resource classes. + + + + Generic CRUD wrapper around an HttpClient and a base API path. + + + + CRUD resource that also supports listing addresses for an item. + + + + Low-level HTTP client for SignalWire REST APIs. + + + + Iterates items across paginated API responses. + + + + Top-level SignalWire REST client. + + + + Exception thrown when a SignalWire REST API request fails with a non-2xx status. + + diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/construct.mdx new file mode 100644 index 0000000000..c816c71599 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/construct.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::__construct" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + SignalWire\REST\HttpClient $http, + string $path, + ?array $params = NULL, + string $dataKey = 'data' +) +``` + +## Parameters + + + + + + + Initial query-string parameters. + + + + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/current.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/current.mdx new file mode 100644 index 0000000000..13ccc71f49 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/current.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/current" +title: "current" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::current" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `current` + +## Signature + +```php +public function current(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-data-key.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-data-key.mdx new file mode 100644 index 0000000000..bbf682e064 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-data-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/get-data-key" +title: "getDataKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::getDataKey" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `getDataKey` + +## Signature + +```php +public function getDataKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 63. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-http.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-http.mdx new file mode 100644 index 0000000000..b891519698 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/get-http" +title: "getHttp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::getHttp" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `getHttp` + +## Signature + +```php +public function getHttp(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 47. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-index.mdx new file mode 100644 index 0000000000..03eefe6723 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-index.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/get-index" +title: "getIndex" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::getIndex" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `getIndex` + +## Signature + +```php +public function getIndex(): int +``` + +## Returns + +`int` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 73. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-items.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-items.mdx new file mode 100644 index 0000000000..65ef7f481e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-items.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/get-items" +title: "getItems" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::getItems" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `getItems` + +## Signature + +```php +public function getItems(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 79. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-params.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-params.mdx new file mode 100644 index 0000000000..5bfd518723 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/get-params" +title: "getParams" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::getParams" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `getParams` + +## Signature + +```php +public function getParams(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-path.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-path.mdx new file mode 100644 index 0000000000..1d0b11927d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/get-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/get-path" +title: "getPath" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::getPath" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `getPath` + +## Signature + +```php +public function getPath(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 52. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/index.mdx new file mode 100644 index 0000000000..ade6c0a693 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator" +title: "PaginatedIterator" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator" + parent: "SignalWire\\REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" +--- +# `PaginatedIterator` + +Iterates items across paginated API responses. + +Mirrors Python `signalwire.rest._pagination.PaginatedIterator`: walks +pages by following the `links.next` cursor and extracting query params +from the URL. + +Usage: +foreach (new PaginatedIterator($http, '/api/path', \['k' => 'v']) as $item) \{ +// ... +\} + +## Signature + +```php +class PaginatedIterator implements Iterator, Traversable +``` + +## Inheritance + +**Implements:** `Iterator`, `Traversable` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 19. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/is-done.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/is-done.mdx new file mode 100644 index 0000000000..bbf38f6106 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/is-done" +title: "isDone" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::isDone" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `isDone` + +## Signature + +```php +public function isDone(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 68. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/key.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/key.mdx new file mode 100644 index 0000000000..47b53b79b5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/key" +title: "key" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::key" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `key` + +## Signature + +```php +public function key(): int +``` + +## Returns + +`int` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 112. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/next.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/next.mdx new file mode 100644 index 0000000000..344b67af95 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/next.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/next" +title: "next" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::next" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `next` + +## Signature + +```php +public function next(): void +``` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 117. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/rewind.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/rewind.mdx new file mode 100644 index 0000000000..7f63965810 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/rewind.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/rewind" +title: "rewind" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::rewind" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `rewind` + +## Signature + +```php +public function rewind(): void +``` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 88. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/valid.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/valid.mdx new file mode 100644 index 0000000000..4ccb96b3a6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/paginated-iterator/valid.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/paginated-iterator/valid" +title: "valid" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\PaginatedIterator::valid" + parent: "SignalWire\\REST\\PaginatedIterator" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php" + visibility: "public" +--- +# `valid` + +## Signature + +```php +public function valid(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/REST/PaginatedIterator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/PaginatedIterator.php) + +Line 93. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/addresses.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/addresses.mdx new file mode 100644 index 0000000000..ce495ed552 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/addresses.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/addresses" +title: "addresses" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::addresses" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `addresses` + +Addresses (list / create / get / delete — no update). + +## Signature + +```php +public function addresses(): SignalWire\REST\Namespaces\Addresses +``` + +## Returns + +`SignalWire\REST\Namespaces\Addresses` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 200. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/calling.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/calling.mdx new file mode 100644 index 0000000000..0b19f33697 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/calling.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/calling" +title: "calling" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::calling" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `calling` + +Calling API (37 call-control commands). + +## Signature + +```php +public function calling(): SignalWire\REST\Namespaces\Calling +``` + +## Returns + +`SignalWire\REST\Namespaces\Calling` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 147. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/chat.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/chat.mdx new file mode 100644 index 0000000000..b219ad0f53 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/chat.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/chat" +title: "chat" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::chat" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `chat` + +Chat tokens. + +## Signature + +```php +public function chat(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 326. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/compat.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/compat.mdx new file mode 100644 index 0000000000..850cc0c62f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/compat.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/compat" +title: "compat" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::compat" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `compat` + +Compatibility (Twilio-compatible LaML) API. + +Returns a `Compat` namespace object exposing the LAML sub-resources +(calls, messages, faxes, conferences, phoneNumbers, recordings, ...). + +## Signature + +```php +public function compat(): SignalWire\REST\Namespaces\Compat +``` + +## Returns + +`SignalWire\REST\Namespaces\Compat` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 191. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/construct.mdx new file mode 100644 index 0000000000..d1cea9ba48 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/construct.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::__construct" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $projectId = '', + string $token = '', + string $space = '' +) +``` + +## Parameters + + + Project ID (falls back to SIGNALWIRE\_PROJECT\_ID env var). + + + + API token (falls back to SIGNALWIRE\_API\_TOKEN env var). + + + + Space host or full base URL. - "mycompany.signalwire.com" → https://mycompany.signalwire.com - "https://example.com:8080" → used verbatim - "http://127.0.0.1:8080" → used verbatim (test fixtures) Falls back to SIGNALWIRE\_SPACE env var. + + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 73. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/datasphere.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/datasphere.mdx new file mode 100644 index 0000000000..c215d0e3b1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/datasphere.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/datasphere" +title: "datasphere" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::datasphere" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `datasphere` + +Datasphere documents (CRUD + chunks + search). + +## Signature + +```php +public function datasphere(): SignalWire\REST\Namespaces\Datasphere +``` + +## Returns + +`SignalWire\REST\Namespaces\Datasphere` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 165. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/fabric.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/fabric.mdx new file mode 100644 index 0000000000..d09ec66ee1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/fabric.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/fabric" +title: "fabric" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::fabric" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `fabric` + +Fabric API (sub-resources: subscribers, sip\_endpoints, call\_flows, ...). + +## Signature + +```php +public function fabric(): SignalWire\REST\Namespaces\Fabric +``` + +## Returns + +`SignalWire\REST\Namespaces\Fabric` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 138. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-base-url.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-base-url.mdx new file mode 100644 index 0000000000..ceb64f66e2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-base-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/get-base-url" +title: "getBaseUrl" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::getBaseUrl" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `getBaseUrl` + +## Signature + +```php +public function getBaseUrl(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 123. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-http.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-http.mdx new file mode 100644 index 0000000000..d93882f51f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/get-http" +title: "getHttp" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::getHttp" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `getHttp` + +## Signature + +```php +public function getHttp(): SignalWire\REST\HttpClient +``` + +## Returns + +`SignalWire\REST\HttpClient` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 128. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-project-id.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-project-id.mdx new file mode 100644 index 0000000000..b21fd681e9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-project-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/get-project-id" +title: "getProjectId" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::getProjectId" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `getProjectId` + +## Signature + +```php +public function getProjectId(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 108. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-space.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-space.mdx new file mode 100644 index 0000000000..17265aee17 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-space.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/get-space" +title: "getSpace" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::getSpace" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `getSpace` + +## Signature + +```php +public function getSpace(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 118. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-token.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-token.mdx new file mode 100644 index 0000000000..e07fc228e3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/get-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/get-token" +title: "getToken" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::getToken" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `getToken` + +## Signature + +```php +public function getToken(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 113. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/imported-numbers.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/imported-numbers.mdx new file mode 100644 index 0000000000..07e0436a76 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/imported-numbers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/imported-numbers" +title: "importedNumbers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::importedNumbers" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `importedNumbers` + +Imported phone numbers (create only). + +## Signature + +```php +public function importedNumbers(): SignalWire\REST\Namespaces\ImportedNumbers +``` + +## Returns + +`SignalWire\REST\Namespaces\ImportedNumbers` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 272. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/index.mdx new file mode 100644 index 0000000000..8d5fc173ba --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/index.mdx @@ -0,0 +1,133 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client" +title: "RestClient" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient" + parent: "SignalWire\\REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" +--- +# `RestClient` + +Top-level SignalWire REST client. + +Provides lazy access to every API namespace (fabric, calling, +phone\_numbers, datasphere, video, compat, etc.). Credentials can be +supplied explicitly or pulled from environment variables. + +## Signature + +```php +class RestClient +``` + +## Methods + + + + + + Addresses (list / create / get / delete — no update). + + + + Calling API (37 call-control commands). + + + + Chat tokens. + + + + Compatibility (Twilio-compatible LaML) API. + + + + Datasphere documents (CRUD + chunks + search). + + + + Fabric API (sub-resources: subscribers, sip\_endpoints, call\_flows, ...). + + + + + + + + + + + + + + Imported phone numbers (create only). + + + + Logs (messages, voice, fax, conferences). + + + + Phone number lookup. + + + + Multi-factor authentication (sms / call / verify). + + + + Number groups (CRUD + membership operations). + + + + Phone numbers. + + + + Project management (project tokens). + + + + PubSub tokens. + + + + Queues (CRUD + member operations). + + + + Recordings (list / get / delete only). + + + + Registry (10DLC brands, campaigns, orders, numbers). + + + + Short codes (list / get / update only). + + + + SIP profile (singleton, get + update). + + + + Verified callers. + + + + Video API namespace (rooms, room\_sessions, room\_recordings, + + + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 31. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/logs.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/logs.mdx new file mode 100644 index 0000000000..82165e2489 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/logs.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/logs" +title: "logs" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::logs" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `logs` + +Logs (messages, voice, fax, conferences). + +## Signature + +```php +public function logs(): SignalWire\REST\Namespaces\Logs +``` + +## Returns + +`SignalWire\REST\Namespaces\Logs` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 299. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/lookup.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/lookup.mdx new file mode 100644 index 0000000000..98953a339e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/lookup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/lookup" +title: "lookup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::lookup" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `lookup` + +Phone number lookup. + +## Signature + +```php +public function lookup(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 254. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/mfa.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/mfa.mdx new file mode 100644 index 0000000000..0f4289c27a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/mfa.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/mfa" +title: "mfa" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::mfa" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `mfa` + +Multi-factor authentication (sms / call / verify). + +## Signature + +```php +public function mfa(): SignalWire\REST\Namespaces\Mfa +``` + +## Returns + +`SignalWire\REST\Namespaces\Mfa` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 281. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/number-groups.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/number-groups.mdx new file mode 100644 index 0000000000..53a76606ff --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/number-groups.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/number-groups" +title: "numberGroups" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::numberGroups" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `numberGroups` + +Number groups (CRUD + membership operations). + +## Signature + +```php +public function numberGroups(): SignalWire\REST\Namespaces\NumberGroups +``` + +## Returns + +`SignalWire\REST\Namespaces\NumberGroups` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 227. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/phone-numbers.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/phone-numbers.mdx new file mode 100644 index 0000000000..45654e1a7f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/phone-numbers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/phone-numbers" +title: "phoneNumbers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::phoneNumbers" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `phoneNumbers` + +Phone numbers. + +## Signature + +```php +public function phoneNumbers(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 156. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/project.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/project.mdx new file mode 100644 index 0000000000..5409daac40 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/project.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/project" +title: "project" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::project" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `project` + +Project management (project tokens). + +## Signature + +```php +public function project(): SignalWire\REST\Namespaces\Project +``` + +## Returns + +`SignalWire\REST\Namespaces\Project` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 308. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/pubsub.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/pubsub.mdx new file mode 100644 index 0000000000..5e5fd74945 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/pubsub.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/pubsub" +title: "pubsub" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::pubsub" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `pubsub` + +PubSub tokens. + +## Signature + +```php +public function pubsub(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 317. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/queues.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/queues.mdx new file mode 100644 index 0000000000..9a4f4348d3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/queues.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/queues" +title: "queues" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::queues" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `queues` + +Queues (CRUD + member operations). + +## Signature + +```php +public function queues(): SignalWire\REST\Namespaces\Queues +``` + +## Returns + +`SignalWire\REST\Namespaces\Queues` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 209. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/recordings.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/recordings.mdx new file mode 100644 index 0000000000..866da62e81 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/recordings.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/recordings" +title: "recordings" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::recordings" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `recordings` + +Recordings (list / get / delete only). + +## Signature + +```php +public function recordings(): SignalWire\REST\Namespaces\Recordings +``` + +## Returns + +`SignalWire\REST\Namespaces\Recordings` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 218. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/registry.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/registry.mdx new file mode 100644 index 0000000000..85ac85ad29 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/registry.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/registry" +title: "registry" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::registry" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `registry` + +Registry (10DLC brands, campaigns, orders, numbers). + +## Signature + +```php +public function registry(): SignalWire\REST\Namespaces\Registry +``` + +## Returns + +`SignalWire\REST\Namespaces\Registry` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 290. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/short-codes.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/short-codes.mdx new file mode 100644 index 0000000000..496d858312 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/short-codes.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/short-codes" +title: "shortCodes" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::shortCodes" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `shortCodes` + +Short codes (list / get / update only). + +## Signature + +```php +public function shortCodes(): SignalWire\REST\Namespaces\ShortCodes +``` + +## Returns + +`SignalWire\REST\Namespaces\ShortCodes` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 263. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/sip-profile.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/sip-profile.mdx new file mode 100644 index 0000000000..2123cdaf5c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/sip-profile.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/sip-profile" +title: "sipProfile" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::sipProfile" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `sipProfile` + +SIP profile (singleton, get + update). + +## Signature + +```php +public function sipProfile(): SignalWire\REST\Namespaces\SipProfile +``` + +## Returns + +`SignalWire\REST\Namespaces\SipProfile` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 245. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/verified-callers.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/verified-callers.mdx new file mode 100644 index 0000000000..114e07db5f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/verified-callers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/verified-callers" +title: "verifiedCallers" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::verifiedCallers" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `verifiedCallers` + +Verified callers. + +## Signature + +```php +public function verifiedCallers(): SignalWire\REST\CrudResource +``` + +## Returns + +`SignalWire\REST\CrudResource` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 236. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/video.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/video.mdx new file mode 100644 index 0000000000..75663927b5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/rest-client/video.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/rest-client/video" +title: "video" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\RestClient::video" + parent: "SignalWire\\REST\\RestClient" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php" + visibility: "public" +--- +# `video` + +Video API namespace (rooms, room\_sessions, room\_recordings, + +conferences, conference\_tokens, streams). + +## Signature + +```php +public function video(): SignalWire\REST\Namespaces\Video +``` + +## Returns + +`SignalWire\REST\Namespaces\Video` + +## Source + +[`SignalWire/REST/RestClient.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/RestClient.php) + +Line 177. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/construct.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/construct.mdx new file mode 100644 index 0000000000..53adfb5a69 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/signal-wire-rest-error/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\SignalWireRestError::__construct" + parent: "SignalWire\\REST\\SignalWireRestError" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/SignalWireRestError.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $message, + int $statusCode = 0, + string $responseBody = '' +) +``` + +## Parameters + + + + + + + +## Source + +[`SignalWire/REST/SignalWireRestError.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/SignalWireRestError.php) + +Line 15. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/get-response-body.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/get-response-body.mdx new file mode 100644 index 0000000000..bb55283bd9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/get-response-body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/signal-wire-rest-error/get-response-body" +title: "getResponseBody" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\SignalWireRestError::getResponseBody" + parent: "SignalWire\\REST\\SignalWireRestError" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/SignalWireRestError.php" + visibility: "public" +--- +# `getResponseBody` + +## Signature + +```php +public function getResponseBody(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/SignalWireRestError.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/SignalWireRestError.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/get-status-code.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/get-status-code.mdx new file mode 100644 index 0000000000..475b373500 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/get-status-code.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/signal-wire-rest-error/get-status-code" +title: "getStatusCode" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\SignalWireRestError::getStatusCode" + parent: "SignalWire\\REST\\SignalWireRestError" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/SignalWireRestError.php" + visibility: "public" +--- +# `getStatusCode` + +## Signature + +```php +public function getStatusCode(): int +``` + +## Returns + +`int` + +## Source + +[`SignalWire/REST/SignalWireRestError.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/SignalWireRestError.php) + +Line 23. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/index.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/index.mdx new file mode 100644 index 0000000000..1e74d94379 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/signal-wire-rest-error" +title: "SignalWireRestError" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\REST\\SignalWireRestError" + parent: "SignalWire\\REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/SignalWireRestError.php" +--- +# `SignalWireRestError` + +Exception thrown when a SignalWire REST API request fails with a non-2xx status. + +## Signature + +```php +class SignalWireRestError extends RuntimeException implements Throwable, Stringable +``` + +## Inheritance + +**Extends:** `RuntimeException` + +**Implements:** `Throwable`, `Stringable` + +## Methods + + + + + + + + + + + +## Source + +[`SignalWire/REST/SignalWireRestError.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/SignalWireRestError.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/to-string.mdx b/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/to-string.mdx new file mode 100644 index 0000000000..e05c71457b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/rest/rest/signal-wire-rest-error/to-string.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/rest/rest/signal-wire-rest-error/to-string" +title: "__toString" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\REST\\SignalWireRestError::__toString" + parent: "SignalWire\\REST\\SignalWireRestError" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/SignalWireRestError.php" + visibility: "public" +--- +# `__toString` + +## Signature + +```php +public function __toString(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/REST/SignalWireRestError.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/REST/SignalWireRestError.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/index.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/index.mdx new file mode 100644 index 0000000000..95e11538c2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/php/signal-wire/security/security" +title: "Security" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\Security" + module: "SignalWire.Security" +--- +# `Security` + +## Signature + +```php +namespace SignalWire\Security +``` + +## Classes + + + + + + Middleware that validates SignalWire webhook signatures before forwarding + + + + Webhook signature validation for SignalWire-signed HTTP requests. + + diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/construct.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/construct.mdx new file mode 100644 index 0000000000..5688dabbc2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/construct.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/security/security/session-manager/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Security\\SessionManager::__construct" + parent: "SignalWire\\Security\\SessionManager" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(int $tokenExpirySecs = 3600) +``` + +## Parameters + + + Token lifetime in seconds (default 3600). + + +## Throws + +- `RuntimeException` — If secure random bytes cannot be generated. + +## Source + +[`SignalWire/Security/SessionManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php) + +Line 19. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/create-session.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/create-session.mdx new file mode 100644 index 0000000000..7aded29c48 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/create-session.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/security/security/session-manager/create-session" +title: "createSession" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Security\\SessionManager::createSession" + parent: "SignalWire\\Security\\SessionManager" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php" + visibility: "public" +--- +# `createSession` + +Create or confirm a session, returning the call ID. + +## Signature + +```php +public function createSession(?string $callId = NULL): string +``` + +## Parameters + + + An existing call ID, or null to generate one. + + +## Returns + +`string` — The call ID for this session. + +## Source + +[`SignalWire/Security/SessionManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php) + +Line 41. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/create-tool-token.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/create-tool-token.mdx new file mode 100644 index 0000000000..8be5fe638b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/create-tool-token.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/security/security/session-manager/create-tool-token" +title: "createToolToken" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Security\\SessionManager::createToolToken" + parent: "SignalWire\\Security\\SessionManager" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php" + visibility: "public" +--- +# `createToolToken` + +Alias for generateToken(). + +## Signature + +```php +public function createToolToken(string $functionName, string $callId): string +``` + +## Parameters + + + The function name to bind into the token. + + + + The call ID to bind into the token. + + +## Returns + +`string` — A base64url-encoded token. + +## Source + +[`SignalWire/Security/SessionManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php) + +Line 79. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/generate-token.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/generate-token.mdx new file mode 100644 index 0000000000..5080308997 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/generate-token.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/security/security/session-manager/generate-token" +title: "generateToken" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Security\\SessionManager::generateToken" + parent: "SignalWire\\Security\\SessionManager" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php" + visibility: "public" +--- +# `generateToken` + +Generate an HMAC-SHA256 signed token for a given function and call. + +## Signature + +```php +public function generateToken(string $functionName, string $callId): string +``` + +## Parameters + + + The function name to bind into the token. + + + + The call ID to bind into the token. + + +## Returns + +`string` — A base64url-encoded token. + +## Source + +[`SignalWire/Security/SessionManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/get-token-expiry-secs.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/get-token-expiry-secs.mdx new file mode 100644 index 0000000000..6b5d354292 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/get-token-expiry-secs.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/security/security/session-manager/get-token-expiry-secs" +title: "getTokenExpirySecs" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Security\\SessionManager::getTokenExpirySecs" + parent: "SignalWire\\Security\\SessionManager" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php" + visibility: "public" +--- +# `getTokenExpirySecs` + +Get the configured token expiry duration in seconds. + +## Signature + +```php +public function getTokenExpirySecs(): int +``` + +## Returns + +`int` — Token lifetime in seconds. + +## Source + +[`SignalWire/Security/SessionManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php) + +Line 154. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/index.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/index.mdx new file mode 100644 index 0000000000..f119ce5ef3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/php/signal-wire/security/security/session-manager" +title: "SessionManager" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Security\\SessionManager" + parent: "SignalWire\\Security" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php" +--- +# `SessionManager` + +## Signature + +```php +class SessionManager +``` + +## Methods + + + + + + Create or confirm a session, returning the call ID. + + + + Alias for generateToken(). + + + + Generate an HMAC-SHA256 signed token for a given function and call. + + + + Get the configured token expiry duration in seconds. + + + + Validate a token against the expected call ID and function name. + + + + Alias for validateToken() with reordered parameters. + + + +## Source + +[`SignalWire/Security/SessionManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php) + +Line 9. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/validate-token.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/validate-token.mdx new file mode 100644 index 0000000000..c131fdb50a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/validate-token.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/php/signal-wire/security/security/session-manager/validate-token" +title: "validateToken" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Security\\SessionManager::validateToken" + parent: "SignalWire\\Security\\SessionManager" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php" + visibility: "public" +--- +# `validateToken` + +Validate a token against the expected call ID and function name. + +All comparisons use timing-safe equality checks to prevent side-channel attacks. + +## Signature + +```php +public function validateToken( + string $callId, + string $functionName, + string $token +): bool +``` + +## Parameters + + + The expected call ID. + + + + The expected function name. + + + + The base64url-encoded token to validate. + + +## Returns + +`bool` — True if the token is valid and not expired. + +## Source + +[`SignalWire/Security/SessionManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php) + +Line 95. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/validate-tool-token.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/validate-tool-token.mdx new file mode 100644 index 0000000000..6a146f07bf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/session-manager/validate-tool-token.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/php/signal-wire/security/security/session-manager/validate-tool-token" +title: "validateToolToken" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Security\\SessionManager::validateToolToken" + parent: "SignalWire\\Security\\SessionManager" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php" + visibility: "public" +--- +# `validateToolToken` + +Alias for validateToken() with reordered parameters. + +## Signature + +```php +public function validateToolToken( + string $functionName, + string $token, + string $callId +): bool +``` + +## Parameters + + + The expected function name. + + + + The base64url-encoded token to validate. + + + + The expected call ID. + + +## Returns + +`bool` — True if the token is valid and not expired. + +## Source + +[`SignalWire/Security/SessionManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/SessionManager.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/webhook-middleware/construct.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-middleware/construct.mdx new file mode 100644 index 0000000000..b2a6bd7c9e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-middleware/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/security/security/webhook-middleware/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Security\\WebhookMiddleware::__construct" + parent: "SignalWire\\Security\\WebhookMiddleware" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookMiddleware.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(string $signingKey) +``` + +## Parameters + + + +## Source + +[`SignalWire/Security/WebhookMiddleware.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookMiddleware.php) + +Line 40. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/webhook-middleware/index.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-middleware/index.mdx new file mode 100644 index 0000000000..c58bcdfe18 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-middleware/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/php/signal-wire/security/security/webhook-middleware" +title: "WebhookMiddleware" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Security\\WebhookMiddleware" + parent: "SignalWire\\Security" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookMiddleware.php" +--- +# `WebhookMiddleware` + +Middleware that validates SignalWire webhook signatures before forwarding + +the request to the next handler. + +The signalwire-php SDK does not use PSR-15 — it has its own internal +(method, path, headers, body) -> \[status, headers, body] handler shape. +This middleware mirrors that shape and is the canonical way to add +signature validation to any handleRequest pipeline. + +Usage: + +``` +$mw = new WebhookMiddleware($signingKey); +[$status, $headers, $body] = $mw->process( + $method, $url, $headers, $rawBody, + function ($method, $url, $headers, $rawBody) use ($svc) { + return $svc->handleRequest($method, parse_url($url, PHP_URL_PATH), $headers, $rawBody); + }, +); +``` + +Behaviour: + +- Reads X-SignalWire-Signature (or X-Twilio-Signature alias). +- On valid signature: forwards to $next, returns its result unchanged. +- On invalid signature: returns 403 Forbidden, never calls $next. +- On missing header: returns 403 Forbidden, never calls $next. +- Never logs / echoes the signing key, signature, or expected digest. + +**Modifiers:** `final` + +## Signature + +```php +final class WebhookMiddleware +``` + +## Methods + + + + + + Run the middleware. On valid signature delegates to $next; on + + + +## Source + +[`SignalWire/Security/WebhookMiddleware.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookMiddleware.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/webhook-middleware/process.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-middleware/process.mdx new file mode 100644 index 0000000000..6b98f46c57 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-middleware/process.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/php/signal-wire/security/security/webhook-middleware/process" +title: "process" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Security\\WebhookMiddleware::process" + parent: "SignalWire\\Security\\WebhookMiddleware" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookMiddleware.php" + visibility: "public" +--- +# `process` + +Run the middleware. On valid signature delegates to $next; on + +invalid / missing signature returns 403 directly. + +## Signature + +```php +public function process( + string $method, + string $url, + array $headers, + string $rawBody, + callable $next +): array +``` + +## Parameters + + + HTTP method. + + + + Full reconstructed URL the platform POSTed to (scheme + host + optional port + path + query). Caller is responsible for honouring proxy headers / SWML\_PROXY\_URL\_BASE before passing it in. + + + + Request headers (mixed case keys allowed). + + + + Raw request body bytes. + + + + Downstream handler. Signature: function(string $method, string $url, array $headers, string $rawBody): array + + +## Returns + +`array` — \[status, headers, body]. + +## Source + +[`SignalWire/Security/WebhookMiddleware.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookMiddleware.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/webhook-validator/index.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-validator/index.mdx new file mode 100644 index 0000000000..91f2766984 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-validator/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/php/signal-wire/security/security/webhook-validator" +title: "WebhookValidator" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Security\\WebhookValidator" + parent: "SignalWire\\Security" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookValidator.php" +--- +# `WebhookValidator` + +Webhook signature validation for SignalWire-signed HTTP requests. + +Implements both schemes from porting-sdk/webhooks.md: + +- Scheme A (RELAY/SWML/JSON): hex(HMAC-SHA1(key, url + rawBody)) +- Scheme B (Compat/cXML form): base64(HMAC-SHA1(key, url + sortedFormParams)) + with optional bodySHA256 query-param fallback for JSON-on-compat-surface. + +Public API: + +``` +WebhookValidator::validateWebhookSignature($key, $sig, $url, $rawBody): bool +WebhookValidator::validateRequest($key, $sig, $url, $paramsOrRawBody): bool +``` + +All comparisons use hash\_equals() (constant-time) so the secret is not +leaked across repeated requests. + +**Modifiers:** `final` + +## Signature + +```php +final class WebhookValidator +``` + +## Methods + + + + Legacy @signalwire/compatibility-api drop-in entry point. + + + + Validate a SignalWire webhook signature against both schemes. + + + +## Source + +[`SignalWire/Security/WebhookValidator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookValidator.php) + +Line 26. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/webhook-validator/validate-request.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-validator/validate-request.mdx new file mode 100644 index 0000000000..03d26e8ff9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-validator/validate-request.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/php/signal-wire/security/security/webhook-validator/validate-request" +title: "validateRequest" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Security\\WebhookValidator::validateRequest" + parent: "SignalWire\\Security\\WebhookValidator" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookValidator.php" + visibility: "public" +--- +# `validateRequest` + +Legacy @signalwire/compatibility-api drop-in entry point. + +If $paramsOrRawBody is a string, delegates to validateWebhookSignature +(Scheme A then Scheme B with parsed form). If it is an array, treats +it as pre-parsed form params and runs Scheme B directly (with URL +port normalisation). + +**Modifiers:** `static` + +## Signature + +```php +public static function validateRequest( + string $signingKey, + string $signature, + string $url, + mixed $paramsOrRawBody +): bool +``` + +## Parameters + + + Customer's Signing Key. + + + + Header value. Empty returns false. + + + + Full URL SignalWire POSTed to. + + + + Raw body string OR pre-parsed form params (associative or list-of- \[key, value] pairs). + + +## Returns + +`bool` — True on match, false otherwise. + +## Throws + +- `InvalidArgumentException` — When $signingKey is missing or the 4th argument has an invalid type. + +## Source + +[`SignalWire/Security/WebhookValidator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookValidator.php) + +Line 118. diff --git a/fern/products/sdk-reference/php/signal-wire/security/security/webhook-validator/validate-webhook-signature.mdx b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-validator/validate-webhook-signature.mdx new file mode 100644 index 0000000000..4e6539d41a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/security/security/webhook-validator/validate-webhook-signature.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/php/signal-wire/security/security/webhook-validator/validate-webhook-signature" +title: "validateWebhookSignature" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Security\\WebhookValidator::validateWebhookSignature" + parent: "SignalWire\\Security\\WebhookValidator" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookValidator.php" + visibility: "public" +--- +# `validateWebhookSignature` + +Validate a SignalWire webhook signature against both schemes. + +**Modifiers:** `static` + +## Signature + +```php +public static function validateWebhookSignature( + string $signingKey, + string $signature, + string $url, + string $rawBody +): bool +``` + +## Parameters + + + Customer's Signing Key from the Dashboard. UTF-8 string, secret. Empty string raises InvalidArgumentException — that is a programming error, not a validation failure. + + + + The X-SignalWire-Signature header value (or X-Twilio-Signature for cXML compat). Empty / missing returns false without raising. + + + + The full URL SignalWire POSTed to (scheme, host, optional port, path, query). Must match what the platform saw — see the URL-reconstruction section of porting-sdk/webhooks.md. + + + + The raw request body bytes as a UTF-8 string, BEFORE any JSON / form parsing. Type-hinted string so a parsed array passed by mistake yields a TypeError. + + +## Returns + +`bool` — True if the signature matches either Scheme A (hex JSON) or Scheme B (base64 form, with port-normalisation variants and optional bodySHA256 fallback). False otherwise. + +## Throws + +- `InvalidArgumentException` — When $signingKey is missing. + +## Source + +[`SignalWire/Security/WebhookValidator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Security/WebhookValidator.php) + +Line 51. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/construct.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/construct.mdx new file mode 100644 index 0000000000..a388a0e837 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::__construct" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + ?string $host = NULL, + ?int $port = NULL, + string $logLevel = 'info' +) +``` + +## Parameters + + + + + + + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 59. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-agent.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-agent.mdx new file mode 100644 index 0000000000..f1356a51be --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-agent.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/get-agent" +title: "getAgent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::getAgent" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `getAgent` + +Get an agent by route. + +## Signature + +```php +public function getAgent(string $route): ?SignalWire\Agent\AgentBase +``` + +## Parameters + + + +## Returns + +`?SignalWire\Agent\AgentBase` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 119. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-agents.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-agents.mdx new file mode 100644 index 0000000000..ebd3bcd38d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-agents.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/get-agents" +title: "getAgents" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::getAgents" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `getAgents` + +Get all registered routes (sorted). + +## Signature + +```php +public function getAgents(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 109. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-host.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-host.mdx new file mode 100644 index 0000000000..4f2cb222e3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-host.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/get-host" +title: "getHost" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::getHost" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `getHost` + +## Signature + +```php +public function getHost(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 323. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-port.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-port.mdx new file mode 100644 index 0000000000..b621b3e482 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-port.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/get-port" +title: "getPort" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::getPort" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `getPort` + +## Signature + +```php +public function getPort(): int +``` + +## Returns + +`int` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 328. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-sip-auto-map.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-sip-auto-map.mdx new file mode 100644 index 0000000000..2164890805 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-sip-auto-map.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/get-sip-auto-map" +title: "getSipAutoMap" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::getSipAutoMap" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `getSipAutoMap` + +## Signature + +```php +public function getSipAutoMap(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 178. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-sip-route.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-sip-route.mdx new file mode 100644 index 0000000000..60b0bf953f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-sip-route.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/get-sip-route" +title: "getSipRoute" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::getSipRoute" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `getSipRoute` + +## Signature + +```php +public function getSipRoute(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 173. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-sip-username-mapping.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-sip-username-mapping.mdx new file mode 100644 index 0000000000..32d3473838 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/get-sip-username-mapping.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/get-sip-username-mapping" +title: "getSipUsernameMapping" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::getSipUsernameMapping" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `getSipUsernameMapping` + +Get the SIP username mapping. + +## Signature + +```php +public function getSipUsernameMapping(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 206. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/handle-request.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/handle-request.mdx new file mode 100644 index 0000000000..a9d4ff3d84 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/handle-request.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/handle-request" +title: "handleRequest" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::handleRequest" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `handleRequest` + +Handle an HTTP request and return \[status, headers, body]. + +## Signature + +```php +public function handleRequest( + string $method, + string $path, + array $headers = array ( +), + ?string $body = NULL +): array +``` + +## Parameters + + + + + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 242. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/index.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/index.mdx new file mode 100644 index 0000000000..ca706eb6a7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/index.mdx @@ -0,0 +1,89 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server" +title: "AgentServer" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer" + parent: "SignalWire\\Server" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" +--- +# `AgentServer` + +## Signature + +```php +class AgentServer +``` + +## Methods + + + + + + Get an agent by route. + + + + Get all registered routes (sorted). + + + + + + + + + + + + Get the SIP username mapping. + + + + Handle an HTTP request and return \[status, headers, body]. + + + + Check if SIP routing is enabled. + + + + Register an agent at a route. + + + + Map a SIP username to a route. + + + + Start the server (blocking). + + + + Start the server using PHP's built-in server (blocking). + + + + Serve static files from a directory under a URL prefix. + + + + Set up central SIP-based routing for the server. + + + + Unregister an agent from a route. + + + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/is-sip-routing-enabled.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/is-sip-routing-enabled.mdx new file mode 100644 index 0000000000..6c8e2cef87 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/is-sip-routing-enabled.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/is-sip-routing-enabled" +title: "isSipRoutingEnabled" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::isSipRoutingEnabled" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `isSipRoutingEnabled` + +Check if SIP routing is enabled. + +## Signature + +```php +public function isSipRoutingEnabled(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 196. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/register-sip-username.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/register-sip-username.mdx new file mode 100644 index 0000000000..a41c5e6c22 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/register-sip-username.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/register-sip-username" +title: "registerSipUsername" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::registerSipUsername" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `registerSipUsername` + +Map a SIP username to a route. + +## Signature + +```php +public function registerSipUsername( + string $username, + string $route +): SignalWire\Server\AgentServer +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Server\AgentServer` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 186. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/register.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/register.mdx new file mode 100644 index 0000000000..af1956e059 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/register.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/register" +title: "register" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::register" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `register` + +Register an agent at a route. + +## Signature + +```php +public function register( + SignalWire\Agent\AgentBase $agent, + ?string $route = NULL +): SignalWire\Server\AgentServer +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Server\AgentServer` + +## Throws + +- `\RuntimeException` — If the route is already registered. + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 79. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/run.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/run.mdx new file mode 100644 index 0000000000..f79f26ab6b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/run.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/run" +title: "run" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::run" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `run` + +Start the server (blocking). + +## Signature + +```php +public function run(): void +``` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 296. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/serve-static.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/serve-static.mdx new file mode 100644 index 0000000000..7d1e237c0a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/serve-static.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/serve-static" +title: "serveStatic" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::serveStatic" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `serveStatic` + +Serve static files from a directory under a URL prefix. + +## Signature + +```php +public function serveStatic( + string $directory, + string $urlPrefix +): SignalWire\Server\AgentServer +``` + +## Parameters + + + + + +## Returns + +`SignalWire\Server\AgentServer` + +## Throws + +- `\RuntimeException` — If the directory does not exist. + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 220. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/serve.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/serve.mdx new file mode 100644 index 0000000000..575bd07ba0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/serve.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/serve" +title: "serve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::serve" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `serve` + +Start the server using PHP's built-in server (blocking). + +## Signature + +```php +public function serve(): void +``` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 304. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/setup-sip-routing.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/setup-sip-routing.mdx new file mode 100644 index 0000000000..80d6e34eba --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/setup-sip-routing.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/setup-sip-routing" +title: "setupSipRouting" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::setupSipRouting" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `setupSipRouting` + +Set up central SIP-based routing for the server. + +Mirrors Python's AgentServer.setup\_sip\_routing(route, auto\_map). When +called with no args, defaults match Python: route="/sip", auto\_map=true. + +## Signature + +```php +public function setupSipRouting( + string $route = '/sip', + bool $auto_map = true +): SignalWire\Server\AgentServer +``` + +## Parameters + + + Path for SIP routing (default "/sip"). Leading slash is added if missing; trailing slash is stripped. + + + + If true, existing agents have their SIP usernames auto-derived from their route. + + +## Returns + +`SignalWire\Server\AgentServer` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 141. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/unregister.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/unregister.mdx new file mode 100644 index 0000000000..9e2687ff38 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/agent-server/unregister.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/server/server/agent-server/unregister" +title: "unregister" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Server\\AgentServer::unregister" + parent: "SignalWire\\Server\\AgentServer" + module: "SignalWire.Server" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php" + visibility: "public" +--- +# `unregister` + +Unregister an agent from a route. + +## Signature + +```php +public function unregister(string $route): SignalWire\Server\AgentServer +``` + +## Parameters + + + +## Returns + +`SignalWire\Server\AgentServer` + +## Source + +[`SignalWire/Server/AgentServer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Server/AgentServer.php) + +Line 96. diff --git a/fern/products/sdk-reference/php/signal-wire/server/server/index.mdx b/fern/products/sdk-reference/php/signal-wire/server/server/index.mdx new file mode 100644 index 0000000000..45083c887c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/server/server/index.mdx @@ -0,0 +1,25 @@ +--- +slug: "/reference/php/signal-wire/server/server" +title: "Server" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\Server" + module: "SignalWire.Server" +--- +# `Server` + +## Signature + +```php +namespace SignalWire\Server +``` + +## Classes + + + + diff --git a/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/detect.mdx b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/detect.mdx new file mode 100644 index 0000000000..6d6a3e5ffa --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/detect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/serverless/serverless/adapter/detect" +title: "detect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Serverless\\Adapter::detect" + parent: "SignalWire\\Serverless\\Adapter" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php" + visibility: "public" +--- +# `detect` + +Detect the current runtime environment. + +**Modifiers:** `static` + +## Signature + +```php +public static function detect(): string +``` + +## Returns + +`string` — One of 'lambda', 'gcf', 'azure', 'cgi', or 'server'. + +## Source + +[`SignalWire/Serverless/Adapter.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php) + +Line 18. diff --git a/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-azure.mdx b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-azure.mdx new file mode 100644 index 0000000000..9fb16b3444 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-azure.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/php/signal-wire/serverless/serverless/adapter/handle-azure" +title: "handleAzure" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Serverless\\Adapter::handleAzure" + parent: "SignalWire\\Serverless\\Adapter" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php" + visibility: "public" +--- +# `handleAzure` + +Handle an Azure Functions invocation. + +Extracts method, path, headers, and body from the Azure request +array, calls agent->handleRequest(), and returns an Azure-compatible +response array. + +**Modifiers:** `static` + +## Signature + +```php +public static function handleAzure(object $agent, array $request): array +``` + +## Parameters + + + An AgentBase or Service instance with handleRequest(). + + + + The Azure Functions HTTP request array. + + +## Returns + +`array` — Azure response format \{status, headers, body\}. + +## Source + +[`SignalWire/Serverless/Adapter.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php) + +Line 127. diff --git a/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-cgi.mdx b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-cgi.mdx new file mode 100644 index 0000000000..a1f7c0d3eb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-cgi.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/serverless/serverless/adapter/handle-cgi" +title: "handleCgi" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Serverless\\Adapter::handleCgi" + parent: "SignalWire\\Serverless\\Adapter" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php" + visibility: "public" +--- +# `handleCgi` + +Handle a CGI/FastCGI invocation. + +Reads REQUEST\_METHOD, PATH\_INFO, CONTENT\_TYPE from $_SERVER, +reads body from php://input, parses headers from HTTP_\* env vars, +and outputs the status line, headers, and body to stdout. + +**Modifiers:** `static` + +## Signature + +```php +public static function handleCgi(object $agent): void +``` + +## Parameters + + + An AgentBase or Service instance with handleRequest(). + + +## Source + +[`SignalWire/Serverless/Adapter.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php) + +Line 157. diff --git a/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-gcf.mdx b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-gcf.mdx new file mode 100644 index 0000000000..ab24b74ad3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-gcf.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/serverless/serverless/adapter/handle-gcf" +title: "handleGcf" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Serverless\\Adapter::handleGcf" + parent: "SignalWire\\Serverless\\Adapter" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php" + visibility: "public" +--- +# `handleGcf` + +Handle a Google Cloud Function invocation. + +Reads from php://input and $\_SERVER, calls agent->handleRequest(), +then outputs headers and body directly to the response stream. + +**Modifiers:** `static` + +## Signature + +```php +public static function handleGcf(object $agent): void +``` + +## Parameters + + + An AgentBase or Service instance with handleRequest(). + + +## Source + +[`SignalWire/Serverless/Adapter.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-lambda.mdx b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-lambda.mdx new file mode 100644 index 0000000000..2ac5b5022d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/handle-lambda.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/php/signal-wire/serverless/serverless/adapter/handle-lambda" +title: "handleLambda" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Serverless\\Adapter::handleLambda" + parent: "SignalWire\\Serverless\\Adapter" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php" + visibility: "public" +--- +# `handleLambda` + +Handle an AWS Lambda (API Gateway) invocation. + +Extracts method, path, headers, and body from the API Gateway event +format, calls agent->handleRequest(), and returns an API Gateway +compatible response. + +**Modifiers:** `static` + +## Signature + +```php +public static function handleLambda(object $agent, array $event, object $context): array +``` + +## Parameters + + + An AgentBase or Service instance with handleRequest(). + + + + The API Gateway event payload. + + + + The Lambda context object. + + +## Returns + +`array` — API Gateway response format \{statusCode, headers, body\}. + +## Source + +[`SignalWire/Serverless/Adapter.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php) + +Line 51. diff --git a/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/index.mdx b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/index.mdx new file mode 100644 index 0000000000..0f418b2b5c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/php/signal-wire/serverless/serverless/adapter" +title: "Adapter" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Serverless\\Adapter" + parent: "SignalWire\\Serverless" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php" +--- +# `Adapter` + +Auto-detect and handle serverless environments (Lambda, GCF, Azure, CGI) + +or fall back to the built-in PHP server. + +## Signature + +```php +class Adapter +``` + +## Methods + + + + Detect the current runtime environment. + + + + Handle an Azure Functions invocation. + + + + Handle a CGI/FastCGI invocation. + + + + Handle a Google Cloud Function invocation. + + + + Handle an AWS Lambda (API Gateway) invocation. + + + + Auto-detect the runtime environment and serve the agent. + + + +## Source + +[`SignalWire/Serverless/Adapter.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php) + +Line 11. diff --git a/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/serve.mdx b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/serve.mdx new file mode 100644 index 0000000000..113e1714e4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/adapter/serve.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/serverless/serverless/adapter/serve" +title: "serve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Serverless\\Adapter::serve" + parent: "SignalWire\\Serverless\\Adapter" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php" + visibility: "public" +--- +# `serve` + +Auto-detect the runtime environment and serve the agent. + +For serverless environments, calls the appropriate handler. +For 'server', calls agent->run(). + +**Modifiers:** `static` + +## Signature + +```php +public static function serve(object $agent): void +``` + +## Parameters + + + An AgentBase or Service instance. + + +## Source + +[`SignalWire/Serverless/Adapter.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Serverless/Adapter.php) + +Line 201. diff --git a/fern/products/sdk-reference/php/signal-wire/serverless/serverless/index.mdx b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/index.mdx new file mode 100644 index 0000000000..d1d120c981 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/serverless/serverless/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/php/signal-wire/serverless/serverless" +title: "Serverless" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\Serverless" + module: "SignalWire.Serverless" +--- +# `Serverless` + +## Signature + +```php +namespace SignalWire\Serverless +``` + +## Classes + + + + Auto-detect and handle serverless environments (Lambda, GCF, Azure, CGI) + + diff --git a/fern/products/sdk-reference/php/signal-wire/signal-wire/index.mdx b/fern/products/sdk-reference/php/signal-wire/signal-wire/index.mdx new file mode 100644 index 0000000000..122b62efce --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/signal-wire/index.mdx @@ -0,0 +1,25 @@ +--- +slug: "/reference/php/signal-wire/signal-wire" +title: "SignalWire" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire" + module: "SignalWire" +--- +# `SignalWire` + +## Signature + +```php +namespace SignalWire +``` + +## Classes + + + + diff --git a/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/add-skill-directory.mdx b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/add-skill-directory.mdx new file mode 100644 index 0000000000..b8c6dc2deb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/add-skill-directory.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/signal-wire/signal-wire/add-skill-directory" +title: "add_skill_directory" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SignalWire::add_skill_directory" + parent: "SignalWire\\SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php" + visibility: "public" +--- +# `add_skill_directory` + +Add a directory to search for skills. + +Mirrors Python's `signalwire.add_skill_directory(path)`. Delegates +to the singleton \{@see SkillRegistry\} instance. + +**Modifiers:** `static` + +## Signature + +```php +public static function add_skill_directory(string $path): void +``` + +## Parameters + + + +## Throws + +- `\InvalidArgumentException` — when the path doesn't exist or isn't a directory. + +## Source + +[`SignalWire/SignalWire.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php) + +Line 103. diff --git a/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/get-logger.mdx b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/get-logger.mdx new file mode 100644 index 0000000000..81bfd4b117 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/get-logger.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/signal-wire/signal-wire/get-logger" +title: "getLogger" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SignalWire::getLogger" + parent: "SignalWire\\SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php" + visibility: "public" +--- +# `getLogger` + +Get a logger instance. + +**Modifiers:** `static` + +## Signature + +```php +public static function getLogger(string $name = 'signalwire'): SignalWire\Logging\Logger +``` + +## Parameters + + + +## Returns + +`SignalWire\Logging\Logger` + +## Source + +[`SignalWire/SignalWire.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php) + +Line 19. diff --git a/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/index.mdx b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/index.mdx new file mode 100644 index 0000000000..82ef400fb8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/php/signal-wire/signal-wire/signal-wire" +title: "SignalWire" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\SignalWire" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php" +--- +# `SignalWire` + +**Modifiers:** `final` + +## Signature + +```php +final class SignalWire +``` + +## Constants + + + +## Methods + + + + Add a directory to search for skills. + + + + Get a logger instance. + + + + Get complete schema for all available skills. + + + + Register a custom skill class with the global skill registry. + + + + Construct a REST client. + + + +## Source + +[`SignalWire/SignalWire.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/list-skills-with-params.mdx b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/list-skills-with-params.mdx new file mode 100644 index 0000000000..796dd4461a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/list-skills-with-params.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/signal-wire/signal-wire/list-skills-with-params" +title: "list_skills_with_params" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SignalWire::list_skills_with_params" + parent: "SignalWire\\SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php" + visibility: "public" +--- +# `list_skills_with_params` + +Get complete schema for all available skills. + +Mirrors Python's `signalwire.list_skills_with_params()`. Returns +an associative array keyed by skill name with metadata + parameter +schema. Useful for GUI configuration tools, API documentation, or +programmatic skill discovery. + +**Modifiers:** `static` + +## Signature + +```php +public static function list_skills_with_params(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/SignalWire.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php) + +Line 118. diff --git a/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/register-skill.mdx b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/register-skill.mdx new file mode 100644 index 0000000000..c0f0b89bb7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/register-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/php/signal-wire/signal-wire/signal-wire/register-skill" +title: "register_skill" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SignalWire::register_skill" + parent: "SignalWire\\SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php" + visibility: "public" +--- +# `register_skill` + +Register a custom skill class with the global skill registry. + +Mirrors Python's `signalwire.register_skill(skill_class)`. +Delegates to the singleton \{@see SkillRegistry\} instance. + +**Modifiers:** `static` + +## Signature + +```php +public static function register_skill(string $skillClass): void +``` + +## Parameters + + + +## Source + +[`SignalWire/SignalWire.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php) + +Line 70. diff --git a/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/rest-client.mdx b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/rest-client.mdx new file mode 100644 index 0000000000..d3da9debd0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/signal-wire/signal-wire/rest-client.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/php/signal-wire/signal-wire/signal-wire/rest-client" +title: "RestClient" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SignalWire::RestClient" + parent: "SignalWire\\SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php" + visibility: "public" +--- +# `RestClient` + +Construct a REST client. + +Mirrors Python's top-level `signalwire.RestClient(*args, **kwargs)` +factory — a thin wrapper that lazy-imports +`signalwire.rest.RestClient` and instantiates it. + +The signature accepts two parallel parameters that mirror Python's +variadic shape (`*args` -> `$args` array, `**kwargs` -> +`$kwargs` associative array). Either positional credentials in +`$args` or keyword credentials in `$kwargs` (or both) work. +The cross-language audit recognises `list<*>` ↔ var\_positional +and `dict` ↔ var\_keyword via type-driven leniency. + +**Modifiers:** `static` + +## Signature + +```php +public static function RestClient( + array $args = array ( +), + array $kwargs = array ( +) +): SignalWire\REST\RestClient +``` + +## Parameters + + + Positional credentials (project, token, space) + + + + Keyword credentials + + +## Returns + +`SignalWire\REST\RestClient` + +## Source + +[`SignalWire/SignalWire.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SignalWire.php) + +Line 42. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/cleanup.mdx new file mode 100644 index 0000000000..cb87d2caee --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::cleanup" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/construct.mdx new file mode 100644 index 0000000000..47601476c1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::__construct" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-description.mdx new file mode 100644 index 0000000000..4f034927b3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::getDescription" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/ApiNinjasTrivia.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-global-data.mdx new file mode 100644 index 0000000000..8f7b23c4b2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-hints.mdx new file mode 100644 index 0000000000..08fa2c87bf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::getHints" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-instance-key.mdx new file mode 100644 index 0000000000..a246b9bb82 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-name.mdx new file mode 100644 index 0000000000..27e11171a7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::getName" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/ApiNinjasTrivia.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-parameter-schema.mdx new file mode 100644 index 0000000000..1fabe093e6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-prompt-sections.mdx new file mode 100644 index 0000000000..9383c05e38 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 53. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-required-env-vars.mdx new file mode 100644 index 0000000000..59ce39ac00 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-version.mdx new file mode 100644 index 0000000000..1f3e3f1b49 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::getVersion" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/index.mdx new file mode 100644 index 0000000000..7fe7e3eebd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia" +title: "ApiNinjasTrivia" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php" +--- +# `ApiNinjasTrivia` + +## Signature + +```php +class ApiNinjasTrivia extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/ApiNinjasTrivia.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/register-tools.mdx new file mode 100644 index 0000000000..f567fb01d4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::registerTools" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/ApiNinjasTrivia.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php) + +Line 53. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/setup.mdx new file mode 100644 index 0000000000..d5f57af710 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::setup" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/ApiNinjasTrivia.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php) + +Line 44. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/supports-multiple-instances.mdx new file mode 100644 index 0000000000..2c62b9817f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/ApiNinjasTrivia.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ApiNinjasTrivia.php) + +Line 39. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/validate-env-vars.mdx new file mode 100644 index 0000000000..811f3751a6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/api-ninjas-trivia/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\ApiNinjasTrivia" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/cleanup.mdx new file mode 100644 index 0000000000..3b7d356cbc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::cleanup" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/construct.mdx new file mode 100644 index 0000000000..c4cb8abd0f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::__construct" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-description.mdx new file mode 100644 index 0000000000..1fd6928646 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::getDescription" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/ClaudeSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php) + +Line 64. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-global-data.mdx new file mode 100644 index 0000000000..107030a352 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-hints.mdx new file mode 100644 index 0000000000..2e08b6a281 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::getHints" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/ClaudeSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php) + +Line 502. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-instance-key.mdx new file mode 100644 index 0000000000..dc2ee8c87f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-name.mdx new file mode 100644 index 0000000000..93edfcdea5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::getName" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/ClaudeSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php) + +Line 59. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-parameter-schema.mdx new file mode 100644 index 0000000000..dd9e978c37 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-prompt-sections.mdx new file mode 100644 index 0000000000..cf2ab5e05b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/ClaudeSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php) + +Line 520. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-required-env-vars.mdx new file mode 100644 index 0000000000..e2dc18de51 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-version.mdx new file mode 100644 index 0000000000..335cecf481 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::getVersion" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/index.mdx new file mode 100644 index 0000000000..ab18ad2d50 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/index.mdx @@ -0,0 +1,99 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills" +title: "ClaudeSkills" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php" +--- +# `ClaudeSkills` + +Claude Skills loader. + +Mirrors signalwire-python's +`signalwire.skills.claude_skills.skill.ClaudeSkillsSkill`: + +- Walks `skills_path` for `/SKILL.md` files. +- Parses YAML frontmatter (name, description, argument-hint, + disable-model-invocation, user-invocable). +- Discovers companion `*.md` files inside each skill dir as + selectable sections. +- Registers one SWAIG tool per loadable skill with a `(arguments, + section)` parameter pair, where `section` enums over the + discovered companion docs. +- When invoked, returns the SKILL.md body (or the requested + section), with `$ARGUMENTS`, `$ARGUMENTS[N]`, `$N`, + `${CLAUDE_SKILL_DIR}` and `${CLAUDE_SESSION_ID}` substituted. + +Two deliberate omissions vs Python (each documented in +PORT\_OMISSIONS.md): + +- `allow_shell_injection`: Python preprocesses `!`cmd\`\` patterns + by shelling out. PHP prefers not to ship a hot path that + subprocess() any user-controlled string by default — Python + itself defaults this off too. The flag is accepted but the + processor is a no-op (the pattern is left in place); set + `allow_shell_injection=false` (the default) and the behavior + matches Python. +- YAML frontmatter parser: PHP has no first-class YAML in + core. Implemented a small tolerant subset that handles the + forms Claude Code itself emits (string scalars, bool, list of + strings on continuation lines). Skill files using deeply + nested YAML constructs aren't supported and will hit a + graceful "frontmatter parse failed" warning at load. + +## Signature + +```php +class ClaudeSkills extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/ClaudeSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php) + +Line 45. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/register-tools.mdx new file mode 100644 index 0000000000..c457d0e72d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::registerTools" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/ClaudeSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php) + +Line 108. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/setup.mdx new file mode 100644 index 0000000000..581670342f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::setup" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/ClaudeSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php) + +Line 74. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/supports-multiple-instances.mdx new file mode 100644 index 0000000000..599771e103 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/ClaudeSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/ClaudeSkills.php) + +Line 69. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/validate-env-vars.mdx new file mode 100644 index 0000000000..37a4a94104 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/claude-skills/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/claude-skills/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\ClaudeSkills::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\ClaudeSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/cleanup.mdx new file mode 100644 index 0000000000..58a8bd8540 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::cleanup" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/construct.mdx new file mode 100644 index 0000000000..7d37ef85b5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::__construct" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-description.mdx new file mode 100644 index 0000000000..2ec577faba --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::getDescription" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/CustomSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-global-data.mdx new file mode 100644 index 0000000000..1cabc380e1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-hints.mdx new file mode 100644 index 0000000000..f8239fce3d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::getHints" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-instance-key.mdx new file mode 100644 index 0000000000..7370725e6f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-name.mdx new file mode 100644 index 0000000000..5bee85baaf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::getName" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/CustomSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-parameter-schema.mdx new file mode 100644 index 0000000000..49c8e73d0a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-prompt-sections.mdx new file mode 100644 index 0000000000..f1472e1909 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 53. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-required-env-vars.mdx new file mode 100644 index 0000000000..8e7a6f825d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-version.mdx new file mode 100644 index 0000000000..43de8d09eb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::getVersion" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/index.mdx new file mode 100644 index 0000000000..8af246ad42 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills" +title: "CustomSkills" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php" +--- +# `CustomSkills` + +## Signature + +```php +class CustomSkills extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/CustomSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/register-tools.mdx new file mode 100644 index 0000000000..fb26076449 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::registerTools" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/CustomSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php) + +Line 32. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/setup.mdx new file mode 100644 index 0000000000..93e93731e6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::setup" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/CustomSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/supports-multiple-instances.mdx new file mode 100644 index 0000000000..12412e96c9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/CustomSkills.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/CustomSkills.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/validate-env-vars.mdx new file mode 100644 index 0000000000..f2c57bfcca --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/custom-skills/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/custom-skills/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\CustomSkills::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\CustomSkills" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/cleanup.mdx new file mode 100644 index 0000000000..d7b05d033a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::cleanup" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/construct.mdx new file mode 100644 index 0000000000..f4b5611213 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::__construct" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-description.mdx new file mode 100644 index 0000000000..d8b600dc18 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::getDescription" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/DatasphereServerless.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-global-data.mdx new file mode 100644 index 0000000000..3dbc45f51b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/DatasphereServerless.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php) + +Line 116. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-hints.mdx new file mode 100644 index 0000000000..7f88e02784 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::getHints" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-instance-key.mdx new file mode 100644 index 0000000000..9bd4f4cf0b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-name.mdx new file mode 100644 index 0000000000..4211ca712d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::getName" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/DatasphereServerless.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-parameter-schema.mdx new file mode 100644 index 0000000000..fde1151973 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-prompt-sections.mdx new file mode 100644 index 0000000000..e3c089222a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/DatasphereServerless.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php) + +Line 125. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-required-env-vars.mdx new file mode 100644 index 0000000000..99110254e9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-version.mdx new file mode 100644 index 0000000000..30e5f3cccc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::getVersion" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/index.mdx new file mode 100644 index 0000000000..493ac129a8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless" +title: "DatasphereServerless" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php" +--- +# `DatasphereServerless` + +## Signature + +```php +class DatasphereServerless extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/DatasphereServerless.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/register-tools.mdx new file mode 100644 index 0000000000..87d77a3ddf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::registerTools" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/DatasphereServerless.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php) + +Line 40. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/setup.mdx new file mode 100644 index 0000000000..61e48dd051 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::setup" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/DatasphereServerless.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/supports-multiple-instances.mdx new file mode 100644 index 0000000000..80541d1275 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/DatasphereServerless.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/DatasphereServerless.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/validate-env-vars.mdx new file mode 100644 index 0000000000..f066c53a51 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere-serverless/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\DatasphereServerless::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\DatasphereServerless" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/cleanup.mdx new file mode 100644 index 0000000000..db56fca160 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::cleanup" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/construct.mdx new file mode 100644 index 0000000000..4d04c84371 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::__construct" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-description.mdx new file mode 100644 index 0000000000..6b4db0573a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::getDescription" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php) + +Line 37. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-global-data.mdx new file mode 100644 index 0000000000..016c86e5bf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php) + +Line 202. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-hints.mdx new file mode 100644 index 0000000000..10a3fae4f0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::getHints" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-instance-key.mdx new file mode 100644 index 0000000000..9809618e2d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-name.mdx new file mode 100644 index 0000000000..f11f2bd4f9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::getName" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php) + +Line 32. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-parameter-schema.mdx new file mode 100644 index 0000000000..d6812ba8a2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-prompt-sections.mdx new file mode 100644 index 0000000000..dbf23683a6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-required-env-vars.mdx new file mode 100644 index 0000000000..426f886f36 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-version.mdx new file mode 100644 index 0000000000..55ee24bb4f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::getVersion" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/index.mdx new file mode 100644 index 0000000000..30fe5e6949 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/index.mdx @@ -0,0 +1,80 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere" +title: "Datasphere" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php" +--- +# `Datasphere` + +SignalWire DataSphere knowledge-search skill. + +Mirrors signalwire-python's +`signalwire.skills.datasphere.skill.DataSphereSkill._search_knowledge_handler`: + +POST https://\{space\_name\}.signalwire.com/api/datasphere/documents/search +Auth: Basic project\_id:token +Body: \{ document\_id, query\_string, distance, count, \[tags, language, ...] \} + +The response carries `chunks: [{text, score, ...}]` (NOT `results`). +The handler stringifies the chunks the same way the Python skill does. + +Upstream URL override: `DATASPHERE_BASE_URL` for the audit fixture. +The path `/api/datasphere/documents/search` is preserved. + +## Signature + +```php +class Datasphere extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/register-tools.mdx new file mode 100644 index 0000000000..ca18b32c6a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::registerTools" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php) + +Line 58. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/setup.mdx new file mode 100644 index 0000000000..9c4128d763 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::setup" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php) + +Line 47. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/supports-multiple-instances.mdx new file mode 100644 index 0000000000..0fae83df04 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/Datasphere.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datasphere.php) + +Line 42. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/validate-env-vars.mdx new file mode 100644 index 0000000000..261ede517a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datasphere/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datasphere/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datasphere::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\Datasphere" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/cleanup.mdx new file mode 100644 index 0000000000..e550110f52 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::cleanup" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/construct.mdx new file mode 100644 index 0000000000..96438c6a3d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::__construct" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-description.mdx new file mode 100644 index 0000000000..15b2af29ae --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::getDescription" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/Datetime.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-global-data.mdx new file mode 100644 index 0000000000..b21a5e011e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-hints.mdx new file mode 100644 index 0000000000..b57b25a0c8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::getHints" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-instance-key.mdx new file mode 100644 index 0000000000..4b913d521d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-name.mdx new file mode 100644 index 0000000000..610b365f30 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::getName" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/Datetime.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-parameter-schema.mdx new file mode 100644 index 0000000000..71e7a925ae --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-prompt-sections.mdx new file mode 100644 index 0000000000..22ba745d8a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/Datetime.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php) + +Line 84. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-required-env-vars.mdx new file mode 100644 index 0000000000..2a23026501 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-version.mdx new file mode 100644 index 0000000000..7756544eed --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::getVersion" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/index.mdx new file mode 100644 index 0000000000..a3cf533253 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime" +title: "Datetime" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php" +--- +# `Datetime` + +## Signature + +```php +class Datetime extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/Datetime.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/register-tools.mdx new file mode 100644 index 0000000000..63e47263a8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::registerTools" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/Datetime.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/setup.mdx new file mode 100644 index 0000000000..8dd9eb308e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::setup" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/Datetime.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Datetime.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/supports-multiple-instances.mdx new file mode 100644 index 0000000000..d728bdc321 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/validate-env-vars.mdx new file mode 100644 index 0000000000..83f70721f8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/datetime/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/datetime/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Datetime::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\Datetime" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/cleanup.mdx new file mode 100644 index 0000000000..6da5ac43cd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::cleanup" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/construct.mdx new file mode 100644 index 0000000000..8efd4c58b6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::__construct" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-description.mdx new file mode 100644 index 0000000000..28d247e200 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::getDescription" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/GoogleMaps.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-global-data.mdx new file mode 100644 index 0000000000..bc66c5a395 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-hints.mdx new file mode 100644 index 0000000000..b814acb103 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::getHints" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/GoogleMaps.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php) + +Line 157. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-instance-key.mdx new file mode 100644 index 0000000000..ba4156585c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-name.mdx new file mode 100644 index 0000000000..06de50f833 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::getName" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/GoogleMaps.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-parameter-schema.mdx new file mode 100644 index 0000000000..bd9cd7aabd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-prompt-sections.mdx new file mode 100644 index 0000000000..90e6002f3e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/GoogleMaps.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php) + +Line 162. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-required-env-vars.mdx new file mode 100644 index 0000000000..1ae4ec379e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-version.mdx new file mode 100644 index 0000000000..bce86c7ec4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::getVersion" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/index.mdx new file mode 100644 index 0000000000..4945cdec46 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps" +title: "GoogleMaps" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php" +--- +# `GoogleMaps` + +## Signature + +```php +class GoogleMaps extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/GoogleMaps.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/register-tools.mdx new file mode 100644 index 0000000000..b61520e04a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::registerTools" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/GoogleMaps.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php) + +Line 31. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/setup.mdx new file mode 100644 index 0000000000..59c6cf361c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::setup" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/GoogleMaps.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/GoogleMaps.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/supports-multiple-instances.mdx new file mode 100644 index 0000000000..f20e489f32 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/validate-env-vars.mdx new file mode 100644 index 0000000000..c30e28ec7b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/google-maps/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/google-maps/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\GoogleMaps::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\GoogleMaps" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/index.mdx new file mode 100644 index 0000000000..768dc6aecc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin" +title: "Builtin" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" +--- +# `Builtin` + +## Signature + +```php +namespace SignalWire\Skills\Builtin +``` + +## Classes + + + + + + Claude Skills loader. + + + + + + SignalWire DataSphere knowledge-search skill. + + + + + + + + + + + + + + + + MCP Gateway skill. + + + + Native vector search skill — network/remote mode only. + + + + + + Spider scraping skill. + + + + + + + + Web search skill backed by Google Custom Search. + + + + Wikipedia search skill backed by the public MediaWiki action API. + + diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/cleanup.mdx new file mode 100644 index 0000000000..a17b705dd2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::cleanup" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/construct.mdx new file mode 100644 index 0000000000..68719295b3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::__construct" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-description.mdx new file mode 100644 index 0000000000..f844b7067f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::getDescription" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/InfoGatherer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-global-data.mdx new file mode 100644 index 0000000000..ad038d2a51 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/InfoGatherer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php) + +Line 156. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-hints.mdx new file mode 100644 index 0000000000..257ca91954 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::getHints" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-instance-key.mdx new file mode 100644 index 0000000000..3d06133cc3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-name.mdx new file mode 100644 index 0000000000..05f97302e2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::getName" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/InfoGatherer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-parameter-schema.mdx new file mode 100644 index 0000000000..19b45c7e47 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-prompt-sections.mdx new file mode 100644 index 0000000000..16562f33b5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/InfoGatherer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php) + +Line 170. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-required-env-vars.mdx new file mode 100644 index 0000000000..919d82e36e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-version.mdx new file mode 100644 index 0000000000..0dd7b03f1b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::getVersion" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/index.mdx new file mode 100644 index 0000000000..58cf66045b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer" +title: "InfoGatherer" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php" +--- +# `InfoGatherer` + +## Signature + +```php +class InfoGatherer extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/InfoGatherer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/register-tools.mdx new file mode 100644 index 0000000000..380216eb7b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::registerTools" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/InfoGatherer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php) + +Line 36. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/setup.mdx new file mode 100644 index 0000000000..4cca3b6454 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::setup" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/InfoGatherer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/supports-multiple-instances.mdx new file mode 100644 index 0000000000..ec58d77ef9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/InfoGatherer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/InfoGatherer.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/validate-env-vars.mdx new file mode 100644 index 0000000000..c21d2c5b1c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/info-gatherer/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/info-gatherer/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\InfoGatherer::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\InfoGatherer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/cleanup.mdx new file mode 100644 index 0000000000..719daed192 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::cleanup" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/construct.mdx new file mode 100644 index 0000000000..a41207c18d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::__construct" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-description.mdx new file mode 100644 index 0000000000..b02e43801b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::getDescription" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/Joke.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-global-data.mdx new file mode 100644 index 0000000000..da3b5fd12e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/Joke.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php) + +Line 78. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-hints.mdx new file mode 100644 index 0000000000..ea704d52c5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::getHints" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-instance-key.mdx new file mode 100644 index 0000000000..9294f9781e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-name.mdx new file mode 100644 index 0000000000..3c06e8e528 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::getName" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/Joke.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-parameter-schema.mdx new file mode 100644 index 0000000000..1320857fb8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-prompt-sections.mdx new file mode 100644 index 0000000000..8c3d34d34b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/Joke.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php) + +Line 83. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-required-env-vars.mdx new file mode 100644 index 0000000000..4886aa0eab --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-version.mdx new file mode 100644 index 0000000000..8765572803 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::getVersion" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/index.mdx new file mode 100644 index 0000000000..d545bea5c5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke" +title: "Joke" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php" +--- +# `Joke` + +## Signature + +```php +class Joke extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/Joke.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/register-tools.mdx new file mode 100644 index 0000000000..96ec8cf7f0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::registerTools" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/Joke.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php) + +Line 31. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/setup.mdx new file mode 100644 index 0000000000..e1d6a30385 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::setup" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/Joke.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Joke.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/supports-multiple-instances.mdx new file mode 100644 index 0000000000..515980de1b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/validate-env-vars.mdx new file mode 100644 index 0000000000..1a025a1f17 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/joke/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/joke/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Joke::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\Joke" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/cleanup.mdx new file mode 100644 index 0000000000..7b440a1418 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::cleanup" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/construct.mdx new file mode 100644 index 0000000000..4abb2a9d5a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::__construct" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-description.mdx new file mode 100644 index 0000000000..0500158e45 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::getDescription" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/Math.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-global-data.mdx new file mode 100644 index 0000000000..254ab7a2ae --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-hints.mdx new file mode 100644 index 0000000000..cb04ffd762 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::getHints" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-instance-key.mdx new file mode 100644 index 0000000000..b6a5320df9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-name.mdx new file mode 100644 index 0000000000..793700e3c9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::getName" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/Math.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-parameter-schema.mdx new file mode 100644 index 0000000000..b0f8aa365c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-prompt-sections.mdx new file mode 100644 index 0000000000..7673e8681a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/Math.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php) + +Line 79. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-required-env-vars.mdx new file mode 100644 index 0000000000..aa8c41b083 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-version.mdx new file mode 100644 index 0000000000..ce6c6f7d42 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::getVersion" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/index.mdx new file mode 100644 index 0000000000..f9256bdcec --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math" +title: "Math" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php" +--- +# `Math` + +## Signature + +```php +class Math extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/Math.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/register-tools.mdx new file mode 100644 index 0000000000..d6e8f9c406 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::registerTools" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/Math.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/setup.mdx new file mode 100644 index 0000000000..0de87583b6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::setup" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/Math.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Math.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/supports-multiple-instances.mdx new file mode 100644 index 0000000000..f5808fa6bc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/validate-env-vars.mdx new file mode 100644 index 0000000000..a46a12b5d5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/math/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/math/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Math::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\Math" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/cleanup.mdx new file mode 100644 index 0000000000..19bc2776d2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::cleanup" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/construct.mdx new file mode 100644 index 0000000000..39c79543dd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::__construct" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-description.mdx new file mode 100644 index 0000000000..cca5c687ad --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::getDescription" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/McpGateway.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php) + +Line 39. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-global-data.mdx new file mode 100644 index 0000000000..79b32faa7f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/McpGateway.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php) + +Line 314. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-hints.mdx new file mode 100644 index 0000000000..9c587b5aeb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::getHints" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/McpGateway.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php) + +Line 297. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-instance-key.mdx new file mode 100644 index 0000000000..e12536f61d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-name.mdx new file mode 100644 index 0000000000..8f20a45e1a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::getName" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/McpGateway.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-parameter-schema.mdx new file mode 100644 index 0000000000..0a3f0f2725 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-prompt-sections.mdx new file mode 100644 index 0000000000..7d4e7ce7b8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/McpGateway.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php) + +Line 335. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-required-env-vars.mdx new file mode 100644 index 0000000000..b2234ac1ff --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-version.mdx new file mode 100644 index 0000000000..8402b632bd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::getVersion" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/index.mdx new file mode 100644 index 0000000000..0c8e4e8f58 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/index.mdx @@ -0,0 +1,85 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway" +title: "McpGateway" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php" +--- +# `McpGateway` + +MCP Gateway skill. + +Mirrors signalwire-python's `signalwire.skills.mcp_gateway.skill`: + +POST \{gateway\_url\}/services/\{service\}/call +Auth: Bearer auth\_token OR Basic auth\_user:auth\_password +Body: \{ tool, arguments, session\_id, timeout, metadata \} +Response: \{ result \} — surfaced verbatim + +For session cleanup the Python skill issues `DELETE +/sessions/{session_id}` from the hangup-hook tool. The audit only +exercises the per-tool `call` path; the hangup hook is preserved +but does not block on the audit. + +No upstream URL override env var — the gateway URL is mandatory and +fully user-supplied (no third-party host to mock). The audit path +isn't probed for this skill (it's not in audit\_skills\_dispatch's +SKILL\_PROBES list as of this writing) but the implementation must +still be real because the surface is shipped to users. + +## Signature + +```php +class McpGateway extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/McpGateway.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php) + +Line 32. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/register-tools.mdx new file mode 100644 index 0000000000..288ef513ff --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::registerTools" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/McpGateway.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php) + +Line 56. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/setup.mdx new file mode 100644 index 0000000000..e46949f5e2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::setup" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/McpGateway.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/McpGateway.php) + +Line 44. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/supports-multiple-instances.mdx new file mode 100644 index 0000000000..4ddef31cc2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/validate-env-vars.mdx new file mode 100644 index 0000000000..500e84f1ce --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/mcp-gateway/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\McpGateway::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\McpGateway" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/cleanup.mdx new file mode 100644 index 0000000000..5e43723e43 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::cleanup" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/construct.mdx new file mode 100644 index 0000000000..4e868baf1a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::__construct" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-description.mdx new file mode 100644 index 0000000000..a1661bca6b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::getDescription" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/NativeVectorSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-global-data.mdx new file mode 100644 index 0000000000..055a4dafe8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-hints.mdx new file mode 100644 index 0000000000..5abf38a2dd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::getHints" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/NativeVectorSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php) + +Line 258. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-instance-key.mdx new file mode 100644 index 0000000000..a78811b8d2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-name.mdx new file mode 100644 index 0000000000..ce9f1bbd79 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::getName" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/NativeVectorSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php) + +Line 30. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-parameter-schema.mdx new file mode 100644 index 0000000000..857b9fa640 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-prompt-sections.mdx new file mode 100644 index 0000000000..f45801af81 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 53. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-required-env-vars.mdx new file mode 100644 index 0000000000..2b1cdfc5ec --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-version.mdx new file mode 100644 index 0000000000..677b8eff80 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::getVersion" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/index.mdx new file mode 100644 index 0000000000..f41121279d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search" +title: "NativeVectorSearch" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php" +--- +# `NativeVectorSearch` + +Native vector search skill — network/remote mode only. + +Mirrors signalwire-python's +`signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill`, +specifically the `_search_remote` branch: + +POST \{remote\_url\}/search +Auth: Optional Basic (parsed from remote\_url's user:pass@ if set) +Body: \{ query, index\_name, count, similarity\_threshold, tags \} +Response: \{ results: \[\{ content, score, metadata \}] \} + +The Python skill also supports a local SQLite/pgvector backend via +`signalwire.search`. PHP doesn't ship that backend; in remote mode +the SDK is just a thin HTTP client, which the audit verifies. Local +backend is recorded in PORT\_OMISSIONS.md. + +## Signature + +```php +class NativeVectorSearch extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/NativeVectorSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/register-tools.mdx new file mode 100644 index 0000000000..3e54f2791d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::registerTools" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/NativeVectorSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php) + +Line 54. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/setup.mdx new file mode 100644 index 0000000000..88d2a031a0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::setup" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/NativeVectorSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php) + +Line 45. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/supports-multiple-instances.mdx new file mode 100644 index 0000000000..440a8217a6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/NativeVectorSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/NativeVectorSearch.php) + +Line 40. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/validate-env-vars.mdx new file mode 100644 index 0000000000..6414f7a749 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/native-vector-search/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/native-vector-search/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\NativeVectorSearch::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\NativeVectorSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/cleanup.mdx new file mode 100644 index 0000000000..c0de26607d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::cleanup" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/construct.mdx new file mode 100644 index 0000000000..449fc778ce --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::__construct" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-description.mdx new file mode 100644 index 0000000000..b11a8fd961 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::getDescription" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/PlayBackgroundFile.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-global-data.mdx new file mode 100644 index 0000000000..3078d01f47 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-hints.mdx new file mode 100644 index 0000000000..359254c091 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::getHints" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-instance-key.mdx new file mode 100644 index 0000000000..d67a7385fa --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-name.mdx new file mode 100644 index 0000000000..e781c0d272 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::getName" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/PlayBackgroundFile.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-parameter-schema.mdx new file mode 100644 index 0000000000..48ad1729b1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-prompt-sections.mdx new file mode 100644 index 0000000000..1c3e964b95 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 53. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-required-env-vars.mdx new file mode 100644 index 0000000000..1032183f83 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-version.mdx new file mode 100644 index 0000000000..47fa57bc56 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::getVersion" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/index.mdx new file mode 100644 index 0000000000..cfb485dc85 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file" +title: "PlayBackgroundFile" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php" +--- +# `PlayBackgroundFile` + +## Signature + +```php +class PlayBackgroundFile extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/PlayBackgroundFile.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/register-tools.mdx new file mode 100644 index 0000000000..17e9a392fb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::registerTools" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/PlayBackgroundFile.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php) + +Line 36. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/setup.mdx new file mode 100644 index 0000000000..7bc0ba8366 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::setup" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/PlayBackgroundFile.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/supports-multiple-instances.mdx new file mode 100644 index 0000000000..0435748f59 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/PlayBackgroundFile.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/PlayBackgroundFile.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/validate-env-vars.mdx new file mode 100644 index 0000000000..2a5bc9bc3d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/play-background-file/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/play-background-file/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\PlayBackgroundFile" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/cleanup.mdx new file mode 100644 index 0000000000..1b09f24b5b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::cleanup" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/construct.mdx new file mode 100644 index 0000000000..2dd7c6f28b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::__construct" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-description.mdx new file mode 100644 index 0000000000..cae6a5a6e8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::getDescription" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/Spider.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php) + +Line 36. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-global-data.mdx new file mode 100644 index 0000000000..9abaf34389 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-hints.mdx new file mode 100644 index 0000000000..f070198e74 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::getHints" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/Spider.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php) + +Line 455. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-instance-key.mdx new file mode 100644 index 0000000000..4472fb7d97 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-name.mdx new file mode 100644 index 0000000000..02a6e27b63 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::getName" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/Spider.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php) + +Line 31. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-parameter-schema.mdx new file mode 100644 index 0000000000..0f960995eb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-prompt-sections.mdx new file mode 100644 index 0000000000..b60888b572 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 53. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-required-env-vars.mdx new file mode 100644 index 0000000000..3c3aef6a71 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-version.mdx new file mode 100644 index 0000000000..da416dadcf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::getVersion" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/index.mdx new file mode 100644 index 0000000000..57f1ebeda6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/index.mdx @@ -0,0 +1,80 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider" +title: "Spider" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php" +--- +# `Spider` + +Spider scraping skill. + +Mirrors signalwire-python's `signalwire.skills.spider.skill` (the +`_scrape_url_handler` / `_crawl_site_handler` paths). PHP doesn't +ship `lxml`, so HTML extraction uses a strip\_tags + regex pipeline +that handles the audit's canned `...` +sentinel and basic real-world pages — the Python version's quality +scorer and Reddit-aware extractor are not yet ported, but the +upstream contract (real GET, real text extraction) is met. + +Upstream URL override: `SPIDER_BASE_URL` for the audit fixture. +The audit fixture is a generic JSON server, so the response body +may either be a raw HTML string (production) or a JSON object with +an `_raw_html` field (audit fixture). We accept both. + +## Signature + +```php +class Spider extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/Spider.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/register-tools.mdx new file mode 100644 index 0000000000..79d6b9a8b3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::registerTools" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/Spider.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php) + +Line 51. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/setup.mdx new file mode 100644 index 0000000000..f674ac327f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::setup" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/Spider.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php) + +Line 46. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/supports-multiple-instances.mdx new file mode 100644 index 0000000000..4392ad6038 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/Spider.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/Spider.php) + +Line 41. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/validate-env-vars.mdx new file mode 100644 index 0000000000..f483d35184 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/spider/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/spider/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\Spider::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\Spider" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/cleanup.mdx new file mode 100644 index 0000000000..16cd9ecc30 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::cleanup" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/construct.mdx new file mode 100644 index 0000000000..88ec14aedd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::__construct" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-description.mdx new file mode 100644 index 0000000000..ee6fc3b72d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::getDescription" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/SwmlTransfer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-global-data.mdx new file mode 100644 index 0000000000..4dbeb15caa --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-hints.mdx new file mode 100644 index 0000000000..86f60de2e9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::getHints" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/SwmlTransfer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php) + +Line 131. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-instance-key.mdx new file mode 100644 index 0000000000..1846c7990a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-name.mdx new file mode 100644 index 0000000000..6c2510b5ff --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::getName" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/SwmlTransfer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-parameter-schema.mdx new file mode 100644 index 0000000000..eaebfa2a4b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-prompt-sections.mdx new file mode 100644 index 0000000000..fe746e4602 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/SwmlTransfer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php) + +Line 150. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-required-env-vars.mdx new file mode 100644 index 0000000000..b4c136b5c8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-version.mdx new file mode 100644 index 0000000000..0c3e9422c8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::getVersion" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/index.mdx new file mode 100644 index 0000000000..62bd1ccb64 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer" +title: "SwmlTransfer" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php" +--- +# `SwmlTransfer` + +## Signature + +```php +class SwmlTransfer extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/SwmlTransfer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/register-tools.mdx new file mode 100644 index 0000000000..f3975ea35b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::registerTools" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/SwmlTransfer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php) + +Line 36. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/setup.mdx new file mode 100644 index 0000000000..753bcc9640 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::setup" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/SwmlTransfer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/supports-multiple-instances.mdx new file mode 100644 index 0000000000..d06ebba525 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/SwmlTransfer.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/SwmlTransfer.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/validate-env-vars.mdx new file mode 100644 index 0000000000..9efcd8a7d3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/swml-transfer/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/swml-transfer/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\SwmlTransfer::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\SwmlTransfer" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/cleanup.mdx new file mode 100644 index 0000000000..047c62770a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::cleanup" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/construct.mdx new file mode 100644 index 0000000000..c3f020409d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::__construct" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-description.mdx new file mode 100644 index 0000000000..c8690ead35 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::getDescription" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WeatherApi.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/WeatherApi.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WeatherApi.php) + +Line 17. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-global-data.mdx new file mode 100644 index 0000000000..c2ea5858ac --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-hints.mdx new file mode 100644 index 0000000000..624dfd226d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::getHints" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-instance-key.mdx new file mode 100644 index 0000000000..0b1dc766f3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-name.mdx new file mode 100644 index 0000000000..1855af07eb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::getName" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WeatherApi.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/WeatherApi.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WeatherApi.php) + +Line 12. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-parameter-schema.mdx new file mode 100644 index 0000000000..2e20821109 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-prompt-sections.mdx new file mode 100644 index 0000000000..69503a204b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 53. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-required-env-vars.mdx new file mode 100644 index 0000000000..0b6d7ca708 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-version.mdx new file mode 100644 index 0000000000..01c07a0cd2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::getVersion" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/index.mdx new file mode 100644 index 0000000000..c88c922403 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api" +title: "WeatherApi" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WeatherApi.php" +--- +# `WeatherApi` + +## Signature + +```php +class WeatherApi extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/WeatherApi.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WeatherApi.php) + +Line 10. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/register-tools.mdx new file mode 100644 index 0000000000..985d9a31e8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::registerTools" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WeatherApi.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/WeatherApi.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WeatherApi.php) + +Line 31. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/setup.mdx new file mode 100644 index 0000000000..73abee426d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::setup" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WeatherApi.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/WeatherApi.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WeatherApi.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/supports-multiple-instances.mdx new file mode 100644 index 0000000000..57bb0f19a2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/validate-env-vars.mdx new file mode 100644 index 0000000000..fdda5611b8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/weather-api/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/weather-api/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WeatherApi::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\WeatherApi" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/cleanup.mdx new file mode 100644 index 0000000000..20028b7e0a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::cleanup" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/construct.mdx new file mode 100644 index 0000000000..a99cda363d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::__construct" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-description.mdx new file mode 100644 index 0000000000..76f42e785d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::getDescription" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/WebSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php) + +Line 40. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-global-data.mdx new file mode 100644 index 0000000000..2ac4eab1d8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/WebSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php) + +Line 184. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-hints.mdx new file mode 100644 index 0000000000..ff2b8e6685 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::getHints" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-instance-key.mdx new file mode 100644 index 0000000000..a0262addba --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-name.mdx new file mode 100644 index 0000000000..84cc5d4bb3 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::getName" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/WebSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php) + +Line 35. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-parameter-schema.mdx new file mode 100644 index 0000000000..f12eea5dc7 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-prompt-sections.mdx new file mode 100644 index 0000000000..d66034c634 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/WebSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php) + +Line 193. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-required-env-vars.mdx new file mode 100644 index 0000000000..2708f84e97 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-version.mdx new file mode 100644 index 0000000000..6523976085 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::getVersion" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/WebSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php) + +Line 45. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/index.mdx new file mode 100644 index 0000000000..4ce889b641 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search" +title: "WebSearch" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php" +--- +# `WebSearch` + +Web search skill backed by Google Custom Search. + +Mirrors signalwire-python's `signalwire.skills.web_search.skill` +(the `WebSearchSkill.search_and_scrape_best` path). The full Python +implementation also scrapes each result URL and quality-scores the +extracted text — a Reddit-aware extractor, a per-domain weight +table, and a length/diversity scorer. The PHP port ships the search +call faithfully and falls back to formatted titles+snippets when +the per-result scrape isn't requested. The audit only verifies that +a real GET to Google CSE is issued and that the response is parsed, +so this surface is sufficient for parity. Per-result scraping can +be layered on later without breaking the audit contract. + +Upstream URL override: `WEB_SEARCH_BASE_URL` (used by +audit\_skills\_dispatch.py to point at a local fixture). When set, +the URL is rewritten to the override host while the path +`/customsearch/v1` is preserved. + +## Signature + +```php +class WebSearch extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/WebSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php) + +Line 30. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/register-tools.mdx new file mode 100644 index 0000000000..592f6e4bdc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::registerTools" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/WebSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php) + +Line 63. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/setup.mdx new file mode 100644 index 0000000000..c2f6fc7581 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::setup" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/WebSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php) + +Line 55. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/supports-multiple-instances.mdx new file mode 100644 index 0000000000..c73db96023 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/WebSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WebSearch.php) + +Line 50. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/validate-env-vars.mdx new file mode 100644 index 0000000000..bf00242382 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/web-search/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/web-search/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WebSearch::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\WebSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/cleanup.mdx new file mode 100644 index 0000000000..a8395b298e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::cleanup" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/construct.mdx new file mode 100644 index 0000000000..5ba4260a09 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::__construct" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-description.mdx new file mode 100644 index 0000000000..2e5077b819 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::getDescription" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php" + visibility: "public" +--- +# `getDescription` + +## Signature + +```php +public function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/WikipediaSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-global-data.mdx new file mode 100644 index 0000000000..0052621ce9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::getGlobalData" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-hints.mdx new file mode 100644 index 0000000000..6d102305b5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::getHints" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-instance-key.mdx new file mode 100644 index 0000000000..3d52fb0a92 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::getInstanceKey" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-name.mdx new file mode 100644 index 0000000000..586c6bfc96 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::getName" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/Builtin/WikipediaSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php) + +Line 29. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-parameter-schema.mdx new file mode 100644 index 0000000000..c02268cbbf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::getParameterSchema" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-prompt-sections.mdx new file mode 100644 index 0000000000..ab84a64717 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::getPromptSections" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/Builtin/WikipediaSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php) + +Line 177. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-required-env-vars.mdx new file mode 100644 index 0000000000..45410d42d2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::getRequiredEnvVars" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-version.mdx new file mode 100644 index 0000000000..499e8f5e74 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::getVersion" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/index.mdx new file mode 100644 index 0000000000..85d3d16d58 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search" +title: "WikipediaSearch" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + parent: "SignalWire\\Skills\\Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php" +--- +# `WikipediaSearch` + +Wikipedia search skill backed by the public MediaWiki action API. + +Mirrors signalwire-python's +`signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill.search_wiki`: + +1. GET en.wikipedia.org/w/api.php?action=query\&list=search\&srsearch=... +2. For each top result, GET ?action=query\&prop=extracts\&exintro&... + to fetch the article intro extract. + +Upstream URL override: `WIKIPEDIA_BASE_URL` for the audit fixture. +The path component (`/w/api.php`) is preserved. + +## Signature + +```php +class WikipediaSearch extends SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire\Skills\SkillBase](/reference/php/signal-wire/skills/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/Builtin/WikipediaSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php) + +Line 24. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/register-tools.mdx new file mode 100644 index 0000000000..3a72c7d5b8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::registerTools" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php" + visibility: "public" +--- +# `registerTools` + +## Signature + +```php +public function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/Builtin/WikipediaSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php) + +Line 44. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/setup.mdx new file mode 100644 index 0000000000..b177214bd2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::setup" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php" + visibility: "public" +--- +# `setup` + +## Signature + +```php +public function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/Builtin/WikipediaSearch.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/Builtin/WikipediaSearch.php) + +Line 39. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/supports-multiple-instances.mdx new file mode 100644 index 0000000000..7fba758f14 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::supportsMultipleInstances" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/validate-env-vars.mdx new file mode 100644 index 0000000000..f3d73640be --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/builtin/builtin/wikipedia-search/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\Builtin\\WikipediaSearch::validateEnvVars" + parent: "SignalWire\\Skills\\Builtin\\WikipediaSearch" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/apply-base-url-override.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/apply-base-url-override.mdx new file mode 100644 index 0000000000..c083f36509 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/apply-base-url-override.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/http-helper/apply-base-url-override" +title: "applyBaseUrlOverride" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\HttpHelper::applyBaseUrlOverride" + parent: "SignalWire\\Skills\\HttpHelper" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/HttpHelper.php" + visibility: "public" +--- +# `applyBaseUrlOverride` + +Look up a URL override env var and rewrite the URL host/scheme + +to point at the audit fixture when set. Skills call this with +the documented env name (e.g. `WEB_SEARCH_BASE_URL`) and the +production URL; the helper returns either the original URL or +an audit-fixture rewrite, preserving path + query. + +**Modifiers:** `static` + +## Signature + +```php +public static function applyBaseUrlOverride(string $url, string $envVarName): string +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/HttpHelper.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/HttpHelper.php) + +Line 75. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/get.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/get.mdx new file mode 100644 index 0000000000..0a31e02dc5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/get.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/http-helper/get" +title: "get" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\HttpHelper::get" + parent: "SignalWire\\Skills\\HttpHelper" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/HttpHelper.php" + visibility: "public" +--- +# `get` + +Issue a GET. Returns \[status, body, parsed\_json\_or\_null]. + +**Modifiers:** `static` + +## Signature + +```php +public static function get( + string $url, + array $headers = array ( +), + ?array $query = NULL, + ?array $basicAuth = NULL, + int $timeout = 15 +): array +``` + +## Parameters + + + + + + + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/HttpHelper.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/HttpHelper.php) + +Line 31. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/index.mdx new file mode 100644 index 0000000000..81c1485fca --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/http-helper" +title: "HttpHelper" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\HttpHelper" + parent: "SignalWire\\Skills" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/HttpHelper.php" +--- +# `HttpHelper` + +Tiny HTTP helper for skill upstream calls. + +The REST client uses cURL behind a Basic-auth wrapper bound to +`https://` — that's the wrong shape for skills, which talk to +arbitrary third-party services with their own URL bases, headers, +and auth schemes. Each skill could call cURL inline, but they all +need the same handful of mechanics (URL building, headers, basic +auth, JSON encode/decode, base-URL override for testing). This +helper centralises that and gives skills a way to honor the +`_BASE_URL` env-var override that audit\_skills\_dispatch +relies on without each skill duplicating the env lookup. + +## Signature + +```php +class HttpHelper +``` + +## Constants + + + Default request timeout in seconds. + + +## Methods + + + + Look up a URL override env var and rewrite the URL host/scheme + + + + Issue a GET. Returns \[status, body, parsed\_json\_or\_null]. + + + + Issue a POST with a JSON body. Returns \[status, body, parsed]. + + + + Inner request engine using cURL. Other skills may use this + + + +## Source + +[`SignalWire/Skills/HttpHelper.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/HttpHelper.php) + +Line 20. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/post-json.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/post-json.mdx new file mode 100644 index 0000000000..c8f81ab4cf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/post-json.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/http-helper/post-json" +title: "postJson" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\HttpHelper::postJson" + parent: "SignalWire\\Skills\\HttpHelper" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/HttpHelper.php" + visibility: "public" +--- +# `postJson` + +Issue a POST with a JSON body. Returns \[status, body, parsed]. + +**Modifiers:** `static` + +## Signature + +```php +public static function postJson( + string $url, + mixed $body, + array $headers = array ( +), + ?array $basicAuth = NULL, + int $timeout = 15 +): array +``` + +## Parameters + + + + + + + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/HttpHelper.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/HttpHelper.php) + +Line 51. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/request.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/request.mdx new file mode 100644 index 0000000000..866a797f28 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/http-helper/request.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/http-helper/request" +title: "request" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\HttpHelper::request" + parent: "SignalWire\\Skills\\HttpHelper" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/HttpHelper.php" + visibility: "public" +--- +# `request` + +Inner request engine using cURL. Other skills may use this + +directly when they need PUT/DELETE; the GET / POST helpers +above cover the common cases. + +**Modifiers:** `static` + +## Signature + +```php +public static function request( + string $method, + string $url, + array $headers = array ( +), + ?string $body = NULL, + ?array $basicAuth = NULL, + int $timeout = 15 +): array +``` + +## Parameters + + + + + + + + + + + \[user, password] + + + + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/HttpHelper.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/HttpHelper.php) + +Line 104. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/index.mdx new file mode 100644 index 0000000000..d8730a2c40 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/php/signal-wire/skills/skills" +title: "Skills" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\Skills" + module: "SignalWire.Skills" +--- +# `Skills` + +## Signature + +```php +namespace SignalWire\Skills +``` + +## Classes + + + + Tiny HTTP helper for skill upstream calls. + + + + + + + + diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/cleanup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/cleanup.mdx new file mode 100644 index 0000000000..cb21cf0dcd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/cleanup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/cleanup" +title: "cleanup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::cleanup" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `cleanup` + +## Signature + +```php +public function cleanup(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/construct.mdx new file mode 100644 index 0000000000..63ea684309 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::__construct" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent, array $params = array ( +)) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-description.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-description.mdx new file mode 100644 index 0000000000..dd628f6352 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/get-description" +title: "getDescription" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::getDescription" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getDescription` + +**Modifiers:** `abstract` + +## Signature + +```php +public abstract function getDescription(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 26. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-global-data.mdx new file mode 100644 index 0000000000..cfe03d5ae0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/get-global-data" +title: "getGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::getGlobalData" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getGlobalData` + +## Signature + +```php +public function getGlobalData(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-hints.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-hints.mdx new file mode 100644 index 0000000000..89f0185cd4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/get-hints" +title: "getHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::getHints" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getHints` + +## Signature + +```php +public function getHints(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 43. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-instance-key.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-instance-key.mdx new file mode 100644 index 0000000000..b16a06225a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-instance-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/get-instance-key" +title: "getInstanceKey" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::getInstanceKey" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getInstanceKey` + +## Signature + +```php +public function getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-name.mdx new file mode 100644 index 0000000000..969fd2fb15 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::getName" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getName` + +**Modifiers:** `abstract` + +## Signature + +```php +public abstract function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 24. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-parameter-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-parameter-schema.mdx new file mode 100644 index 0000000000..db949613c4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-parameter-schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::getParameterSchema" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getParameterSchema` + +## Signature + +```php +public function getParameterSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 66. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-prompt-sections.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-prompt-sections.mdx new file mode 100644 index 0000000000..15d978d967 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/get-prompt-sections" +title: "getPromptSections" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::getPromptSections" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getPromptSections` + +## Signature + +```php +public function getPromptSections(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 53. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-required-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-required-env-vars.mdx new file mode 100644 index 0000000000..ff70d3eb16 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-required-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/get-required-env-vars" +title: "getRequiredEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::getRequiredEnvVars" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getRequiredEnvVars` + +## Signature + +```php +public function getRequiredEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-version.mdx new file mode 100644 index 0000000000..de74653d94 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::getVersion" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 28. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/index.mdx new file mode 100644 index 0000000000..f549888165 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base" +title: "SkillBase" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase" + parent: "SignalWire\\Skills" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" +--- +# `SkillBase` + +**Modifiers:** `abstract` + +## Signature + +```php +abstract class SkillBase +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 7. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/register-tools.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/register-tools.mdx new file mode 100644 index 0000000000..9eac660cdb --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/register-tools.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/register-tools" +title: "registerTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::registerTools" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `registerTools` + +**Modifiers:** `abstract` + +## Signature + +```php +public abstract function registerTools(): void +``` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/setup.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/setup.mdx new file mode 100644 index 0000000000..9e966d1880 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/setup" +title: "setup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::setup" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `setup` + +**Modifiers:** `abstract` + +## Signature + +```php +public abstract function setup(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 20. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/supports-multiple-instances.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/supports-multiple-instances.mdx new file mode 100644 index 0000000000..ba68c1a37b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/supports-multiple-instances" +title: "supportsMultipleInstances" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::supportsMultipleInstances" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `supportsMultipleInstances` + +## Signature + +```php +public function supportsMultipleInstances(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 38. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/validate-env-vars.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/validate-env-vars.mdx new file mode 100644 index 0000000000..7bfe824bab --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-base/validate-env-vars.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-base/validate-env-vars" +title: "validateEnvVars" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillBase::validateEnvVars" + parent: "SignalWire\\Skills\\SkillBase" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php" + visibility: "public" +--- +# `validateEnvVars` + +## Signature + +```php +public function validateEnvVars(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillBase.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillBase.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/construct.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/construct.mdx new file mode 100644 index 0000000000..434f933162 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/construct.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-manager/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillManager::__construct" + parent: "SignalWire\\Skills\\SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(object $agent) +``` + +## Parameters + + + +## Source + +[`SignalWire/Skills/SkillManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/get-skill.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/get-skill.mdx new file mode 100644 index 0000000000..7da523eb15 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/get-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-manager/get-skill" +title: "getSkill" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillManager::getSkill" + parent: "SignalWire\\Skills\\SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php" + visibility: "public" +--- +# `getSkill` + +## Signature + +```php +public function getSkill(string $key): ?SignalWire\Skills\SkillBase +``` + +## Parameters + + + +## Returns + +`?SignalWire\Skills\SkillBase` + +## Source + +[`SignalWire/Skills/SkillManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php) + +Line 96. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/has-skill.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/has-skill.mdx new file mode 100644 index 0000000000..321bb3a878 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/has-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-manager/has-skill" +title: "hasSkill" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillManager::hasSkill" + parent: "SignalWire\\Skills\\SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php" + visibility: "public" +--- +# `hasSkill` + +## Signature + +```php +public function hasSkill(string $key): bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/SkillManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php) + +Line 91. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/index.mdx new file mode 100644 index 0000000000..e15a419eba --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-manager" +title: "SkillManager" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillManager" + parent: "SignalWire\\Skills" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php" +--- +# `SkillManager` + +## Signature + +```php +class SkillManager +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/SkillManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php) + +Line 7. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/list-skills.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/list-skills.mdx new file mode 100644 index 0000000000..39f704ff3c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/list-skills.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-manager/list-skills" +title: "listSkills" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillManager::listSkills" + parent: "SignalWire\\Skills\\SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php" + visibility: "public" +--- +# `listSkills` + +## Signature + +```php +public function listSkills(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php) + +Line 86. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/load-skill.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/load-skill.mdx new file mode 100644 index 0000000000..6bbae71156 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/load-skill.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-manager/load-skill" +title: "loadSkill" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillManager::loadSkill" + parent: "SignalWire\\Skills\\SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php" + visibility: "public" +--- +# `loadSkill` + +## Signature + +```php +public function loadSkill( + string $skillName, + array $params = array ( +), + ?string $skillClass = NULL +): array +``` + +## Parameters + + + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php) + +Line 22. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/unload-skill.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/unload-skill.mdx new file mode 100644 index 0000000000..5efe3b2ac4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-manager/unload-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-manager/unload-skill" +title: "unloadSkill" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillManager::unloadSkill" + parent: "SignalWire\\Skills\\SkillManager" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php" + visibility: "public" +--- +# `unloadSkill` + +## Signature + +```php +public function unloadSkill(string $key): bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`SignalWire/Skills/SkillManager.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillManager.php) + +Line 74. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/add-skill-directory.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/add-skill-directory.mdx new file mode 100644 index 0000000000..76a9b63eb0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/add-skill-directory.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-registry/add-skill-directory" +title: "addSkillDirectory" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillRegistry::addSkillDirectory" + parent: "SignalWire\\Skills\\SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php" + visibility: "public" +--- +# `addSkillDirectory` + +Add a directory to search for skills. + +Mirrors Python's +`signalwire.skills.registry.SkillRegistry.add_skill_directory`: +validate that the path exists and is a directory, then append it +(de-duplicated) to the external paths list. Throws +`InvalidArgumentException` (the PHP analog of Python's `ValueError`) +for invalid input. + +## Signature + +```php +public function addSkillDirectory(string $path): void +``` + +## Parameters + + + +## Throws + +- `\InvalidArgumentException` — when the path doesn't exist or isn't a directory. + +## Source + +[`SignalWire/Skills/SkillRegistry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php) + +Line 107. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/get-all-skills-schema.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/get-all-skills-schema.mdx new file mode 100644 index 0000000000..0b0fc1d859 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/get-all-skills-schema.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-registry/get-all-skills-schema" +title: "getAllSkillsSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillRegistry::getAllSkillsSchema" + parent: "SignalWire\\Skills\\SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php" + visibility: "public" +--- +# `getAllSkillsSchema` + +Get complete schema for all registered skills. + +Mirrors Python's instance-method +`SkillRegistry.get_all_skills_schema()` — returns an associative +array keyed by skill name where each entry contains metadata + +parameter schema. PHP skills don't carry rich Python-style +parameter introspection in v1, so the value defaults to a minimal +shape with the skill name; built-ins that expose +`getDescription` / `getVersion` get those merged in. + +## Signature + +```php +public function getAllSkillsSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillRegistry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php) + +Line 144. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/get-external-paths.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/get-external-paths.mdx new file mode 100644 index 0000000000..9156340c21 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/get-external-paths.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-registry/get-external-paths" +title: "getExternalPaths" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillRegistry::getExternalPaths" + parent: "SignalWire\\Skills\\SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php" + visibility: "public" +--- +# `getExternalPaths` + +Returns the registered external skill directories. + +Parity surface for Python's `_external_paths`. + +## Signature + +```php +public function getExternalPaths(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillRegistry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php) + +Line 126. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/get-factory.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/get-factory.mdx new file mode 100644 index 0000000000..38d2abf303 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/get-factory.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-registry/get-factory" +title: "getFactory" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillRegistry::getFactory" + parent: "SignalWire\\Skills\\SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php" + visibility: "public" +--- +# `getFactory` + +## Signature + +```php +public function getFactory(string $name): ?string +``` + +## Parameters + + + +## Returns + +`?string` + +## Source + +[`SignalWire/Skills/SkillRegistry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php) + +Line 47. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/index.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/index.mdx new file mode 100644 index 0000000000..efcab2db9a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-registry" +title: "SkillRegistry" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillRegistry" + parent: "SignalWire\\Skills" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php" +--- +# `SkillRegistry` + +## Signature + +```php +class SkillRegistry +``` + +## Methods + + + + Add a directory to search for skills. + + + + Get complete schema for all registered skills. + + + + Returns the registered external skill directories. + + + + + + + + + + + + + +## Source + +[`SignalWire/Skills/SkillRegistry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php) + +Line 7. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/instance.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/instance.mdx new file mode 100644 index 0000000000..1eacf1e526 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/instance.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-registry/instance" +title: "instance" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillRegistry::instance" + parent: "SignalWire\\Skills\\SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php" + visibility: "public" +--- +# `instance` + +**Modifiers:** `static` + +## Signature + +```php +public static function instance(): SignalWire\Skills\SkillRegistry +``` + +## Returns + +`SignalWire\Skills\SkillRegistry` + +## Source + +[`SignalWire/Skills/SkillRegistry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php) + +Line 80. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/list-skills.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/list-skills.mdx new file mode 100644 index 0000000000..68c703486e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/list-skills.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-registry/list-skills" +title: "listSkills" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillRegistry::listSkills" + parent: "SignalWire\\Skills\\SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php" + visibility: "public" +--- +# `listSkills` + +## Signature + +```php +public function listSkills(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Skills/SkillRegistry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php) + +Line 64. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/register-skill.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/register-skill.mdx new file mode 100644 index 0000000000..17de571c75 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/register-skill.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-registry/register-skill" +title: "registerSkill" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillRegistry::registerSkill" + parent: "SignalWire\\Skills\\SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php" + visibility: "public" +--- +# `registerSkill` + +## Signature + +```php +public function registerSkill(string $name, string $className): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/Skills/SkillRegistry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php) + +Line 42. diff --git a/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/reset.mdx b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/reset.mdx new file mode 100644 index 0000000000..026c8f82f5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/skills/skills/skill-registry/reset.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/skills/skills/skill-registry/reset" +title: "reset" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Skills\\SkillRegistry::reset" + parent: "SignalWire\\Skills\\SkillRegistry" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php" + visibility: "public" +--- +# `reset` + +**Modifiers:** `static` + +## Signature + +```php +public static function reset(): void +``` + +## Source + +[`SignalWire/Skills/SkillRegistry.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Skills/SkillRegistry.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/add-action.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/add-action.mdx new file mode 100644 index 0000000000..640062b383 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/add-action.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/add-action" +title: "addAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::addAction" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `addAction` + +## Signature + +```php +public function addAction(array $action): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/add-actions.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/add-actions.mdx new file mode 100644 index 0000000000..9b8c20f986 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/add-actions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/add-actions" +title: "addActions" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::addActions" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `addActions` + +## Signature + +```php +public function addActions(array $actions): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 39. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/add-dynamic-hints.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/add-dynamic-hints.mdx new file mode 100644 index 0000000000..ceef6f757d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/add-dynamic-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/add-dynamic-hints" +title: "addDynamicHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::addDynamicHints" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `addDynamicHints` + +## Signature + +```php +public function addDynamicHints(array $hints): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 281. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/clear-dynamic-hints.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/clear-dynamic-hints.mdx new file mode 100644 index 0000000000..b5a86663a9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/clear-dynamic-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/clear-dynamic-hints" +title: "clearDynamicHints" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::clearDynamicHints" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `clearDynamicHints` + +## Signature + +```php +public function clearDynamicHints(): SignalWire\SWAIG\FunctionResult +``` + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 287. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/connect.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/connect.mdx new file mode 100644 index 0000000000..65849a6b35 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/connect.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/connect" +title: "connect" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::connect" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `connect` + +## Signature + +```php +public function connect( + string $destination, + bool $final = false, + string $from = '' +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 69. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/construct.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/construct.mdx new file mode 100644 index 0000000000..96cd2e5d69 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/construct.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::__construct" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct(?string $response = '', bool $postProcess = false) +``` + +## Parameters + + + + + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 13. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/create-payment-action.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/create-payment-action.mdx new file mode 100644 index 0000000000..777c45a441 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/create-payment-action.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/create-payment-action" +title: "createPaymentAction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::createPaymentAction" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `createPaymentAction` + +**Modifiers:** `static` + +## Signature + +```php +public static function createPaymentAction( + string $type, + string $text, + string $language = 'en-US', + string $voice = '' +): array +``` + +## Parameters + + + + + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 538. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/create-payment-parameter.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/create-payment-parameter.mdx new file mode 100644 index 0000000000..c872cebbae --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/create-payment-parameter.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/create-payment-parameter" +title: "createPaymentParameter" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::createPaymentParameter" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `createPaymentParameter` + +**Modifiers:** `static` + +## Signature + +```php +public static function createPaymentParameter( + string $name, + string $type, + array $config = array ( +) +): array +``` + +## Parameters + + + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 557. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/create-payment-prompt.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/create-payment-prompt.mdx new file mode 100644 index 0000000000..93dd652f23 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/create-payment-prompt.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/create-payment-prompt" +title: "createPaymentPrompt" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::createPaymentPrompt" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `createPaymentPrompt` + +**Modifiers:** `static` + +## Signature + +```php +public static function createPaymentPrompt( + string $text, + string $language = 'en-US', + string $voice = '' +): array +``` + +## Parameters + + + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 521. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/enable-extensive-data.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/enable-extensive-data.mdx new file mode 100644 index 0000000000..e137fb4813 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/enable-extensive-data.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/enable-extensive-data" +title: "enableExtensiveData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::enableExtensiveData" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `enableExtensiveData` + +## Signature + +```php +public function enableExtensiveData( + bool $enabled = true +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 321. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/enable-functions-on-timeout.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/enable-functions-on-timeout.mdx new file mode 100644 index 0000000000..771ac99886 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/enable-functions-on-timeout.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/enable-functions-on-timeout" +title: "enableFunctionsOnTimeout" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::enableFunctionsOnTimeout" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `enableFunctionsOnTimeout` + +## Signature + +```php +public function enableFunctionsOnTimeout( + bool $enabled = true +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 315. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/execute-rpc.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/execute-rpc.mdx new file mode 100644 index 0000000000..9e8181d36a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/execute-rpc.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/execute-rpc" +title: "executeRpc" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::executeRpc" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `executeRpc` + +## Signature + +```php +public function executeRpc( + string $method, + array $params = array ( +) +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 458. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/execute-swml.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/execute-swml.mdx new file mode 100644 index 0000000000..b5308db404 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/execute-swml.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/execute-swml" +title: "executeSwml" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::executeSwml" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `executeSwml` + +## Signature + +```php +public function executeSwml( + $swmlContent, + bool $transfer = false +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 338. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/hangup.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/hangup.mdx new file mode 100644 index 0000000000..f1ef12eb91 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/hangup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/hangup" +title: "hangup" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::hangup" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `hangup` + +## Signature + +```php +public function hangup(): SignalWire\SWAIG\FunctionResult +``` + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 100. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/hold.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/hold.mdx new file mode 100644 index 0000000000..e5d952eb70 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/hold.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/hold" +title: "hold" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::hold" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `hold` + +## Signature + +```php +public function hold(int $timeout = 300): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 106. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/index.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/index.mdx new file mode 100644 index 0000000000..c4ad14baf1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/index.mdx @@ -0,0 +1,133 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result" +title: "FunctionResult" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult" + parent: "SignalWire\\SWAIG" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" +--- +# `FunctionResult` + +## Signature + +```php +class FunctionResult +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 7. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/join-conference.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/join-conference.mdx new file mode 100644 index 0000000000..a337ab842e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/join-conference.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/join-conference" +title: "joinConference" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::joinConference" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `joinConference` + +## Signature + +```php +public function joinConference( + string $name, + bool $muted = false, + string $beep = 'true', + string $holdAudio = 'ring' +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 353. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/join-room.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/join-room.mdx new file mode 100644 index 0000000000..31551faaa8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/join-room.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/join-room" +title: "joinRoom" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::joinRoom" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `joinRoom` + +## Signature + +```php +public function joinRoom(string $name): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 368. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/pay.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/pay.mdx new file mode 100644 index 0000000000..a988ba757a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/pay.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/pay" +title: "pay" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::pay" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `pay` + +## Signature + +```php +public function pay( + string $connectorUrl, + string $inputMethod = 'dtmf', + string $actionUrl = '', + int $timeout = 600, + int $maxAttempts = 3 +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 434. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/play-background-file.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/play-background-file.mdx new file mode 100644 index 0000000000..3a26323893 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/play-background-file.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/play-background-file" +title: "playBackgroundFile" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::playBackgroundFile" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `playBackgroundFile` + +## Signature + +```php +public function playBackgroundFile( + string $filename, + bool $wait = false +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 232. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/record-call.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/record-call.mdx new file mode 100644 index 0000000000..549b7fcdd5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/record-call.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/record-call" +title: "recordCall" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::recordCall" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `recordCall` + +## Signature + +```php +public function recordCall( + string $controlId = '', + bool $stereo = false, + string $format = 'wav', + string $direction = 'both' +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 248. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/remove-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/remove-global-data.mdx new file mode 100644 index 0000000000..00df071d6c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/remove-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/remove-global-data" +title: "removeGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::removeGlobalData" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `removeGlobalData` + +## Signature + +```php +public function removeGlobalData(array $keys): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 149. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/remove-metadata.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/remove-metadata.mdx new file mode 100644 index 0000000000..d4aa0e5f17 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/remove-metadata.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/remove-metadata" +title: "removeMetadata" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::removeMetadata" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `removeMetadata` + +## Signature + +```php +public function removeMetadata(array $keys): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 161. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/replace-in-history.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/replace-in-history.mdx new file mode 100644 index 0000000000..c682cfa201 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/replace-in-history.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/replace-in-history" +title: "replaceInHistory" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::replaceInHistory" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `replaceInHistory` + +## Signature + +```php +public function replaceInHistory($text): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 214. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/rpc-ai-message.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/rpc-ai-message.mdx new file mode 100644 index 0000000000..8e59606983 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/rpc-ai-message.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/rpc-ai-message" +title: "rpcAiMessage" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::rpcAiMessage" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `rpcAiMessage` + +## Signature + +```php +public function rpcAiMessage( + string $callId, + string $messageText +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 498. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/rpc-ai-unhold.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/rpc-ai-unhold.mdx new file mode 100644 index 0000000000..3e2ffb07fa --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/rpc-ai-unhold.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/rpc-ai-unhold" +title: "rpcAiUnhold" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::rpcAiUnhold" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `rpcAiUnhold` + +## Signature + +```php +public function rpcAiUnhold(string $callId): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 506. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/rpc-dial.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/rpc-dial.mdx new file mode 100644 index 0000000000..ff1f4855be --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/rpc-dial.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/rpc-dial" +title: "rpcDial" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::rpcDial" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `rpcDial` + +## Signature + +```php +public function rpcDial( + string $to, + string $from = '', + ?string $destSwml = NULL, + ?int $callTimeout = NULL, + string $region = '' +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 473. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/say.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/say.mdx new file mode 100644 index 0000000000..6b608f32f2 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/say.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/say" +title: "say" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::say" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `say` + +## Signature + +```php +public function say(string $text): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 226. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/send-sms.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/send-sms.mdx new file mode 100644 index 0000000000..c30cb94b2a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/send-sms.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/send-sms" +title: "sendSms" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::sendSms" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `sendSms` + +## Signature + +```php +public function sendSms( + string $to, + string $from, + string $body, + array $media = array ( +), + array $tags = array ( +) +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 410. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-end-of-speech-timeout.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-end-of-speech-timeout.mdx new file mode 100644 index 0000000000..309aa8847f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-end-of-speech-timeout.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/set-end-of-speech-timeout" +title: "setEndOfSpeechTimeout" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::setEndOfSpeechTimeout" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `setEndOfSpeechTimeout` + +## Signature + +```php +public function setEndOfSpeechTimeout(int $ms): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 293. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-metadata.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-metadata.mdx new file mode 100644 index 0000000000..9e59012ff4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-metadata.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/set-metadata" +title: "setMetadata" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::setMetadata" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `setMetadata` + +## Signature + +```php +public function setMetadata(array $data): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 155. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-post-process.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-post-process.mdx new file mode 100644 index 0000000000..0ab0936f0d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-post-process.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/set-post-process" +title: "setPostProcess" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::setPostProcess" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `setPostProcess` + +## Signature + +```php +public function setPostProcess(bool $val): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-response.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-response.mdx new file mode 100644 index 0000000000..8e31e5963b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-response.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/set-response" +title: "setResponse" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::setResponse" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `setResponse` + +## Signature + +```php +public function setResponse(string $text): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 21. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-speech-event-timeout.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-speech-event-timeout.mdx new file mode 100644 index 0000000000..43b1de2241 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/set-speech-event-timeout.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/set-speech-event-timeout" +title: "setSpeechEventTimeout" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::setSpeechEventTimeout" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `setSpeechEventTimeout` + +## Signature + +```php +public function setSpeechEventTimeout(int $ms): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 299. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/simulate-user-input.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/simulate-user-input.mdx new file mode 100644 index 0000000000..755aa93f16 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/simulate-user-input.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/simulate-user-input" +title: "simulateUserInput" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::simulateUserInput" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `simulateUserInput` + +## Signature + +```php +public function simulateUserInput(string $text): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 513. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/sip-refer.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/sip-refer.mdx new file mode 100644 index 0000000000..aa43025142 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/sip-refer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/sip-refer" +title: "sipRefer" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::sipRefer" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `sipRefer` + +## Signature + +```php +public function sipRefer(string $toUri): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 374. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop-background-file.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop-background-file.mdx new file mode 100644 index 0000000000..5e1160cfcf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop-background-file.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/stop-background-file" +title: "stopBackgroundFile" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::stopBackgroundFile" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `stopBackgroundFile` + +## Signature + +```php +public function stopBackgroundFile(): SignalWire\SWAIG\FunctionResult +``` + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 242. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop-record-call.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop-record-call.mdx new file mode 100644 index 0000000000..b2c7888bcf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop-record-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/stop-record-call" +title: "stopRecordCall" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::stopRecordCall" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `stopRecordCall` + +## Signature + +```php +public function stopRecordCall(string $controlId = ''): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 269. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop-tap.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop-tap.mdx new file mode 100644 index 0000000000..70e2533147 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop-tap.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/stop-tap" +title: "stopTap" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::stopTap" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `stopTap` + +## Signature + +```php +public function stopTap(string $controlId = ''): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 400. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop.mdx new file mode 100644 index 0000000000..f6e957cd08 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/stop.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/stop" +title: "stop" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::stop" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `stop` + +## Signature + +```php +public function stop(): SignalWire\SWAIG\FunctionResult +``` + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 135. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/switch-context.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/switch-context.mdx new file mode 100644 index 0000000000..86387b98ad --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/switch-context.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/switch-context" +title: "switchContext" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::switchContext" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `switchContext` + +## Signature + +```php +public function switchContext( + string $systemPrompt, + string $userPrompt = '', + bool $consolidate = false, + bool $fullReset = false, + bool $isolated = false +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + + + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 185. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-change-context.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-change-context.mdx new file mode 100644 index 0000000000..1a89498f6f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-change-context.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/swml-change-context" +title: "swmlChangeContext" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::swmlChangeContext" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `swmlChangeContext` + +## Signature + +```php +public function swmlChangeContext(string $contextName): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 179. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-change-step.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-change-step.mdx new file mode 100644 index 0000000000..ebe7110415 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-change-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/swml-change-step" +title: "swmlChangeStep" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::swmlChangeStep" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `swmlChangeStep` + +## Signature + +```php +public function swmlChangeStep(string $stepName): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 173. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-transfer.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-transfer.mdx new file mode 100644 index 0000000000..cabc0cbfda --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-transfer.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/swml-transfer" +title: "swmlTransfer" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::swmlTransfer" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `swmlTransfer` + +## Signature + +```php +public function swmlTransfer( + string $dest, + string $aiResponse = '', + bool $final = false +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 89. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-user-event.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-user-event.mdx new file mode 100644 index 0000000000..9c7b9ef7a8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/swml-user-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/swml-user-event" +title: "swmlUserEvent" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::swmlUserEvent" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `swmlUserEvent` + +## Signature + +```php +public function swmlUserEvent(array $eventData): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 167. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/tap.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/tap.mdx new file mode 100644 index 0000000000..3d41266099 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/tap.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/tap" +title: "tap" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::tap" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `tap` + +## Signature + +```php +public function tap( + string $uri, + string $controlId = '', + string $direction = 'both', + string $codec = 'PCMU' +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 380. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/to-array.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/to-array.mdx new file mode 100644 index 0000000000..4d6cc7c484 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/to-array.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/to-array" +title: "toArray" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::toArray" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `toArray` + +## Signature + +```php +public function toArray(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 47. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/to-json.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/to-json.mdx new file mode 100644 index 0000000000..a57b4f5802 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/to-json.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/to-json" +title: "toJson" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::toJson" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `toJson` + +## Signature + +```php +public function toJson(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/toggle-functions.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/toggle-functions.mdx new file mode 100644 index 0000000000..7827b19f61 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/toggle-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/toggle-functions" +title: "toggleFunctions" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::toggleFunctions" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `toggleFunctions` + +## Signature + +```php +public function toggleFunctions(array $toggles): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 305. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/update-global-data.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/update-global-data.mdx new file mode 100644 index 0000000000..a1fff443f0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/update-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/update-global-data" +title: "updateGlobalData" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::updateGlobalData" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `updateGlobalData` + +## Signature + +```php +public function updateGlobalData(array $data): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 143. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/update-settings.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/update-settings.mdx new file mode 100644 index 0000000000..c0c61c1c22 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/update-settings.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/update-settings" +title: "updateSettings" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::updateSettings" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `updateSettings` + +## Signature + +```php +public function updateSettings(array $settings): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 327. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/wait-for-user.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/wait-for-user.mdx new file mode 100644 index 0000000000..060dbdd5cf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/function-result/wait-for-user.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig/function-result/wait-for-user" +title: "waitForUser" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWAIG\\FunctionResult::waitForUser" + parent: "SignalWire\\SWAIG\\FunctionResult" + module: "SignalWire.SWAIG" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php" + visibility: "public" +--- +# `waitForUser` + +## Signature + +```php +public function waitForUser( + ?bool $enabled = NULL, + ?int $timeout = NULL, + ?bool $answerFirst = NULL +): SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + + + +## Returns + +`SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWAIG/FunctionResult.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWAIG/FunctionResult.php) + +Line 113. diff --git a/fern/products/sdk-reference/php/signal-wire/swaig/swaig/index.mdx b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/index.mdx new file mode 100644 index 0000000000..2367273b19 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swaig/swaig/index.mdx @@ -0,0 +1,25 @@ +--- +slug: "/reference/php/signal-wire/swaig/swaig" +title: "SWAIG" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\SWAIG" + module: "SignalWire.SWAIG" +--- +# `SWAIG` + +## Signature + +```php +namespace SignalWire\SWAIG +``` + +## Classes + + + + diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-raw-verb.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-raw-verb.mdx new file mode 100644 index 0000000000..35c470385e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-raw-verb.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/add-raw-verb" +title: "addRawVerb" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::addRawVerb" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `addRawVerb` + +Append a pre-formatted verb hash to a section. + +## Signature + +```php +public function addRawVerb(string $section, array $verbHash): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 73. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-section.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-section.mdx new file mode 100644 index 0000000000..cedd292989 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/add-section" +title: "addSection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::addSection" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `addSection` + +Add a new named section. Returns true if created, false if it already existed. + +## Signature + +```php +public function addSection(string $name): bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 27. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-verb-to-section.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-verb-to-section.mdx new file mode 100644 index 0000000000..1d2eaf8a46 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-verb-to-section.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/add-verb-to-section" +title: "addVerbToSection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::addVerbToSection" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `addVerbToSection` + +Append a verb to a named section. + +## Signature + +```php +public function addVerbToSection( + string $section, + string $verbName, + mixed $config +): void +``` + +## Parameters + + + + + + + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-verb.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-verb.mdx new file mode 100644 index 0000000000..c037b4a419 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/add-verb.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/add-verb" +title: "addVerb" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::addVerb" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `addVerb` + +Append a verb to the main section. + +## Signature + +```php +public function addVerb(string $verbName, mixed $config): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 54. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/clear-section.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/clear-section.mdx new file mode 100644 index 0000000000..c2c45bbba1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/clear-section.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/clear-section" +title: "clearSection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::clearSection" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `clearSection` + +Clear all verbs in a section. + +## Signature + +```php +public function clearSection(string $section): void +``` + +## Parameters + + + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 84. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/construct.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/construct.mdx new file mode 100644 index 0000000000..f259fd2216 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/construct.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::__construct" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct() +``` + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 14. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/get-verbs.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/get-verbs.mdx new file mode 100644 index 0000000000..9b42ad5cd9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/get-verbs.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/get-verbs" +title: "getVerbs" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::getVerbs" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `getVerbs` + +Get a copy of the verbs for a section. + +## Signature + +```php +public function getVerbs(string $section = 'main'): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 46. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/get-version.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/get-version.mdx new file mode 100644 index 0000000000..e386548252 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/get-version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/get-version" +title: "getVersion" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::getVersion" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `getVersion` + +## Signature + +```php +public function getVersion(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 19. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/has-section.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/has-section.mdx new file mode 100644 index 0000000000..3d6a717945 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/has-section.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/has-section" +title: "hasSection" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::hasSection" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `hasSection` + +## Signature + +```php +public function hasSection(string $name): bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 36. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/index.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/index.mdx new file mode 100644 index 0000000000..ae83c7b6d8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document" +title: "Document" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\SWML\\Document" + parent: "SignalWire\\SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" +--- +# `Document` + +## Signature + +```php +class Document +``` + +## Methods + + + + + + Append a pre-formatted verb hash to a section. + + + + Add a new named section. Returns true if created, false if it already existed. + + + + Append a verb to the main section. + + + + Append a verb to a named section. + + + + Clear all verbs in a section. + + + + Get a copy of the verbs for a section. + + + + + + + + Compact JSON string. + + + + Pretty-printed JSON string. + + + + Reset document to initial state. + + + + Return document as associative array. + + + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 7. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/render-pretty.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/render-pretty.mdx new file mode 100644 index 0000000000..1d16ed8e21 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/render-pretty.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/render-pretty" +title: "renderPretty" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::renderPretty" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `renderPretty` + +Pretty-printed JSON string. + +## Signature + +```php +public function renderPretty(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 123. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/render.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/render.mdx new file mode 100644 index 0000000000..30b4a03faf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/render.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/render" +title: "render" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::render" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `render` + +Compact JSON string. + +## Signature + +```php +public function render(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 115. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/reset.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/reset.mdx new file mode 100644 index 0000000000..f10db0dc12 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/reset.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/reset" +title: "reset" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::reset" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `reset` + +Reset document to initial state. + +## Signature + +```php +public function reset(): void +``` + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 94. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/document/to-array.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/to-array.mdx new file mode 100644 index 0000000000..152a27a277 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/document/to-array.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/document/to-array" +title: "toArray" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Document::toArray" + parent: "SignalWire\\SWML\\Document" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php" + visibility: "public" +--- +# `toArray` + +Return document as associative array. + +## Signature + +```php +public function toArray(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/SWML/Document.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Document.php) + +Line 104. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/index.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/index.mdx new file mode 100644 index 0000000000..7b0831dc1d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/index.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/php/signal-wire/swml/swml" +title: "SWML" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\SWML" + module: "SignalWire.SWML" +--- +# `SWML` + +## Signature + +```php +namespace SignalWire\SWML +``` + +## Classes + + + + + + + + diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/get-verb-names.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/get-verb-names.mdx new file mode 100644 index 0000000000..1bc878e1ee --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/get-verb-names.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/schema/get-verb-names" +title: "getVerbNames" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Schema::getVerbNames" + parent: "SignalWire\\SWML\\Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php" + visibility: "public" +--- +# `getVerbNames` + +Get sorted list of all verb names. + +## Signature + +```php +public function getVerbNames(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/SWML/Schema.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php) + +Line 50. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/get-verb.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/get-verb.mdx new file mode 100644 index 0000000000..aa62c7a8d0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/get-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/schema/get-verb" +title: "getVerb" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Schema::getVerb" + parent: "SignalWire\\SWML\\Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php" + visibility: "public" +--- +# `getVerb` + +Get verb metadata, or null if not found. + +## Signature + +```php +public function getVerb(string $name): ?array +``` + +## Parameters + + + +## Returns + +`?array` + +## Source + +[`SignalWire/SWML/Schema.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php) + +Line 62. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/index.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/index.mdx new file mode 100644 index 0000000000..2a8e30b2af --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/schema" +title: "Schema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\SWML\\Schema" + parent: "SignalWire\\SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php" +--- +# `Schema` + +## Signature + +```php +class Schema +``` + +## Methods + + + + Get verb metadata, or null if not found. + + + + Get sorted list of all verb names. + + + + + + Check whether a verb name is valid. + + + + Reset the singleton (for testing). + + + + Number of verbs defined in the schema. + + + +## Source + +[`SignalWire/SWML/Schema.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php) + +Line 7. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/instance.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/instance.mdx new file mode 100644 index 0000000000..2d0658dbc1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/instance.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/schema/instance" +title: "instance" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Schema::instance" + parent: "SignalWire\\SWML\\Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php" + visibility: "public" +--- +# `instance` + +**Modifiers:** `static` + +## Signature + +```php +public static function instance(): SignalWire\SWML\Schema +``` + +## Returns + +`SignalWire\SWML\Schema` + +## Source + +[`SignalWire/SWML/Schema.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php) + +Line 21. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/is-valid-verb.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/is-valid-verb.mdx new file mode 100644 index 0000000000..ea36c3006b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/is-valid-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/schema/is-valid-verb" +title: "isValidVerb" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Schema::isValidVerb" + parent: "SignalWire\\SWML\\Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php" + visibility: "public" +--- +# `isValidVerb` + +Check whether a verb name is valid. + +## Signature + +```php +public function isValidVerb(string $name): bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`SignalWire/SWML/Schema.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php) + +Line 40. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/reset.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/reset.mdx new file mode 100644 index 0000000000..afc2f7754d --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/schema/reset" +title: "reset" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Schema::reset" + parent: "SignalWire\\SWML\\Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php" + visibility: "public" +--- +# `reset` + +Reset the singleton (for testing). + +**Modifiers:** `static` + +## Signature + +```php +public static function reset(): void +``` + +## Source + +[`SignalWire/SWML/Schema.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php) + +Line 32. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/verb-count.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/verb-count.mdx new file mode 100644 index 0000000000..77ed8a2118 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/schema/verb-count.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/schema/verb-count" +title: "verbCount" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Schema::verbCount" + parent: "SignalWire\\SWML\\Schema" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php" + visibility: "public" +--- +# `verbCount` + +Number of verbs defined in the schema. + +## Signature + +```php +public function verbCount(): int +``` + +## Returns + +`int` + +## Source + +[`SignalWire/SWML/Schema.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Schema.php) + +Line 70. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/call.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/call.mdx new file mode 100644 index 0000000000..bb8d32856c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/call.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/call" +title: "__call" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::__call" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `__call` + +Dynamic verb methods from schema. + +$service->answer('main', \['max\_duration' => 3600]); +$service->sleep('main', 2000); +$service->hangup(); + +## Signature + +```php +public function __call(string $method, array $args): static +``` + +## Parameters + + + + + +## Returns + +`static` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 114. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/construct.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/construct.mdx new file mode 100644 index 0000000000..c49801cdcd --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/construct.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::__construct" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `__construct` + +## Signature + +```php +public function __construct( + string $name, + string $route = '/', + ?string $host = NULL, + ?int $port = NULL, + ?string $basicAuthUser = NULL, + ?string $basicAuthPassword = NULL +) +``` + +## Parameters + + + + + + + + + + + + + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 50. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/define-tool.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/define-tool.mdx new file mode 100644 index 0000000000..70712700fe --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/define-tool.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/define-tool" +title: "defineTool" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::defineTool" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `defineTool` + +Define a SWAIG function the AI can call. + +Tool descriptions and parameter descriptions are LLM-facing prompt +engineering, not internal documentation. See PORTING\_GUIDE for guidance. + +## Signature + +```php +public function defineTool( + string $name, + string $description, + array $parameters, + callable $handler, + bool $secure = false +): static +``` + +## Parameters + + + + + + + + + + + +## Returns + +`static` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 226. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/define-tools.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/define-tools.mdx new file mode 100644 index 0000000000..e51e370bd6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/define-tools.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/define-tools" +title: "defineTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::defineTools" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `defineTools` + +Register multiple tool definitions at once. + +## Signature + +```php +public function defineTools(array $toolDefs): static +``` + +## Parameters + + + +## Returns + +`static` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 268. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/dispatch-from-globals.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/dispatch-from-globals.mdx new file mode 100644 index 0000000000..ff6daa8e45 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/dispatch-from-globals.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/dispatch-from-globals" +title: "dispatchFromGlobals" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::dispatchFromGlobals" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `dispatchFromGlobals` + +Dispatch the current PHP request (cli-server / php-fpm / mod\_php) to + +handleRequest() and write the response. Must be called inside a SAPI +that has populated $\_SERVER for the inbound request. + +## Signature + +```php +public function dispatchFromGlobals(): void +``` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 773. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/extract-sip-username.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/extract-sip-username.mdx new file mode 100644 index 0000000000..0726eaea11 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/extract-sip-username.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/extract-sip-username" +title: "extractSipUsername" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::extractSipUsername" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `extractSipUsername` + +Extract SIP username from a request body. + +Validates format: only \[a-zA-Z0-9.\_-], max 64 chars. + +**Modifiers:** `static` + +## Signature + +```php +public static function extractSipUsername(?array $requestBody): ?string +``` + +## Parameters + + + +## Returns + +`?string` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 648. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-all-functions.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-all-functions.mdx new file mode 100644 index 0000000000..23e8e1c479 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-all-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-all-functions" +title: "getAllFunctions" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getAllFunctions" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getAllFunctions` + +Snapshot of all registered SWAIG functions keyed by name. + +Python parity: `ToolRegistry.get_all_functions`. + +## Signature + +```php +public function getAllFunctions(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 306. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-basic-auth-credentials-with-source.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-basic-auth-credentials-with-source.mdx new file mode 100644 index 0000000000..f13742aee4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-basic-auth-credentials-with-source.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-basic-auth-credentials-with-source" +title: "getBasicAuthCredentialsWithSource" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getBasicAuthCredentialsWithSource" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getBasicAuthCredentialsWithSource` + +Get (user, password, source) where source is "provided", + +"environment", or "generated". Python parity: +AuthMixin.get\_basic\_auth\_credentials(include\_source=True). + +## Signature + +```php +public function getBasicAuthCredentialsWithSource(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 178. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..f95307d402 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-basic-auth-credentials.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-basic-auth-credentials" +title: "getBasicAuthCredentials" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getBasicAuthCredentials" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getBasicAuthCredentials` + +## Signature + +```php +public function getBasicAuthCredentials(): array +``` + +## Returns + +`array` — \[user, password] + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 161. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-document.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-document.mdx new file mode 100644 index 0000000000..9217652b25 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-document.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-document" +title: "getDocument" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getDocument" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getDocument` + +## Signature + +```php +public function getDocument(): SignalWire\SWML\Document +``` + +## Returns + +`SignalWire\SWML\Document` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 444. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-full-url.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-full-url.mdx new file mode 100644 index 0000000000..dd5c5f60ed --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-full-url.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-full-url" +title: "getFullUrl" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getFullUrl" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getFullUrl` + +Build the full URL for this service. + +## Signature + +```php +public function getFullUrl(bool $includeAuth = false): string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 198. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-function.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-function.mdx new file mode 100644 index 0000000000..9d262a8932 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-function.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-function" +title: "getFunction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getFunction" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getFunction` + +Get a registered SWAIG function by name, or null when absent. + +Python parity: `ToolRegistry.get_function`. + +## Signature + +```php +public function getFunction(string $name): ?array +``` + +## Parameters + + + +## Returns + +`?array` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 299. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-host.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-host.mdx new file mode 100644 index 0000000000..89e5d12276 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-host.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-host" +title: "getHost" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getHost" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getHost` + +## Signature + +```php +public function getHost(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 434. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-name.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-name.mdx new file mode 100644 index 0000000000..28eeabb414 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-name" +title: "getName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getName" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getName` + +## Signature + +```php +public function getName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 424. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-port.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-port.mdx new file mode 100644 index 0000000000..521f882a0b --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-port.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-port" +title: "getPort" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getPort" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getPort` + +## Signature + +```php +public function getPort(): int +``` + +## Returns + +`int` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 439. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-proxy-url-base.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-proxy-url-base.mdx new file mode 100644 index 0000000000..68277ca50a --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-proxy-url-base.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-proxy-url-base" +title: "getProxyUrlBase" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getProxyUrlBase" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getProxyUrlBase` + +Detect or construct the proxy URL base from request headers. + +## Signature + +```php +public function getProxyUrlBase(array $headers = array ( +)): string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 682. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-route.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-route.mdx new file mode 100644 index 0000000000..2ab1c94958 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-route.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-route" +title: "getRoute" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getRoute" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getRoute` + +## Signature + +```php +public function getRoute(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 429. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-schema-utils.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-schema-utils.mdx new file mode 100644 index 0000000000..c27fed5d5c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-schema-utils.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-schema-utils" +title: "getSchemaUtils" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getSchemaUtils" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getSchemaUtils` + +SchemaUtils helper bound to this Service. Mirrors Python's + +self.schema\_utils public instance attribute on SWMLService. +Built lazily on first access. + +## Signature + +```php +public function getSchemaUtils(): SignalWire\Utils\SchemaUtils +``` + +## Returns + +`SignalWire\Utils\SchemaUtils` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 454. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-tool-names.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-tool-names.mdx new file mode 100644 index 0000000000..bb0f1bd85f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-tool-names.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-tool-names" +title: "getToolNames" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getToolNames" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getToolNames` + +Return the names of registered tools in the order they were + +registered. Stable ordering matters for CLI output and for +tests that rely on deterministic enumeration. + +## Signature + +```php +public function getToolNames(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 327. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-tools.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-tools.mdx new file mode 100644 index 0000000000..df11c19f4c --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/get-tools.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/get-tools" +title: "getTools" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::getTools" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `getTools` + +Return the registered SWAIG tool definitions. + +Used by introspection (CLI --list-tools, the skills audit +harness, and any test that needs to inspect what's been +registered without going through a HTTP round trip). + +## Signature + +```php +public function getTools(): array +``` + +## Returns + +`array` — name => tool definition + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 285. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/handle-request.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/handle-request.mdx new file mode 100644 index 0000000000..12bab012f6 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/handle-request.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/handle-request" +title: "handleRequest" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::handleRequest" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `handleRequest` + +Handle an HTTP request. Returns \[status, headers, body]. + +## Signature + +```php +public function handleRequest( + string $method, + string $path, + array $headers = array ( +), + ?string $body = NULL +): array +``` + +## Parameters + + + + + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 489. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/has-function.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/has-function.mdx new file mode 100644 index 0000000000..812d2513e8 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/has-function.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/has-function" +title: "hasFunction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::hasFunction" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `hasFunction` + +Whether a SWAIG function with the given name is registered. + +Python parity: `ToolRegistry.has_function`. + +## Signature + +```php +public function hasFunction(string $name): bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 292. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/index.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/index.mdx new file mode 100644 index 0000000000..1c6d2a62b0 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/index.mdx @@ -0,0 +1,147 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service" +title: "Service" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\SWML\\Service" + parent: "SignalWire\\SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" +--- +# `Service` + +## Signature + +```php +class Service +``` + +## Methods + + + + Dynamic verb methods from schema. + + + + + + Define a SWAIG function the AI can call. + + + + Register multiple tool definitions at once. + + + + Dispatch the current PHP request (cli-server / php-fpm / mod\_php) to + + + + Extract SIP username from a request body. + + + + Snapshot of all registered SWAIG functions keyed by name. + + + + + + Get (user, password, source) where source is "provided", + + + + + + Build the full URL for this service. + + + + Get a registered SWAIG function by name, or null when absent. + + + + + + + + + + Detect or construct the proxy URL base from request headers. + + + + + + SchemaUtils helper bound to this Service. Mirrors Python's + + + + Return the names of registered tools in the order they were + + + + Return the registered SWAIG tool definitions. + + + + Handle an HTTP request. Returns \[status, headers, body]. + + + + Whether a SWAIG function with the given name is registered. + + + + Dispatch a function call to the registered handler. + + + + Customization hook called when SWML is requested. Default + + + + Customization point for subclasses to modify SWML based on + + + + + + Register a raw SWAIG function definition (e.g. DataMap tools). + + + + Remove a registered SWAIG function. True on success, false if absent. + + + + + + + + Render SWML for a request. Subclasses override this. + + + + Run the service (alias for serve). + + + + Start serving using PHP's built-in server (blocking). + + + + Validate provided basic-auth credentials against the configured ones + + + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 11. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/on-function-call.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/on-function-call.mdx new file mode 100644 index 0000000000..a648385b02 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/on-function-call.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/on-function-call" +title: "onFunctionCall" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::onFunctionCall" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `onFunctionCall` + +Dispatch a function call to the registered handler. + +## Signature + +```php +public function onFunctionCall( + string $name, + array $args, + array $rawData +): ?SignalWire\SWAIG\FunctionResult +``` + +## Parameters + + + + + + + +## Returns + +`?SignalWire\SWAIG\FunctionResult` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 335. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/on-request.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/on-request.mdx new file mode 100644 index 0000000000..7aeba1d978 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/on-request.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/on-request" +title: "onRequest" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::onRequest" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `onRequest` + +Customization hook called when SWML is requested. Default + +delegates to \{@see onSwmlRequest()\}; subclasses typically +override `onSwmlRequest` rather than this method. + +Return null to use the default SWML rendering, or an array of +modifications to merge into the rendered document. + +Python parity: WebMixin.on\_request(request\_data, callback\_path). +The Python third `request` arg is FastAPI-specific and is not +mirrored. + +## Signature + +```php +public function onRequest( + ?array $requestData = NULL, + ?string $callbackPath = NULL +): ?array +``` + +## Parameters + + + + + +## Returns + +`?array` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 402. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/on-swml-request.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/on-swml-request.mdx new file mode 100644 index 0000000000..a0ba639359 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/on-swml-request.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/on-swml-request" +title: "onSwmlRequest" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::onSwmlRequest" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `onSwmlRequest` + +Customization point for subclasses to modify SWML based on + +request data. The default implementation returns null (no +modification). Subclasses override to inspect the body or +callback path and return an associative array of overrides. + +Python parity: WebMixin.on\_swml\_request(request\_data, callback\_path). + +## Signature + +```php +public function onSwmlRequest( + ?array $requestData = NULL, + ?string $callbackPath = NULL +): ?array +``` + +## Parameters + + + + + +## Returns + +`?array` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 415. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/register-routing-callback.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/register-routing-callback.mdx new file mode 100644 index 0000000000..4341c42028 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/register-routing-callback.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/register-routing-callback" +title: "registerRoutingCallback" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::registerRoutingCallback" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `registerRoutingCallback` + +## Signature + +```php +public function registerRoutingCallback(string $path, callable $callback): void +``` + +## Parameters + + + + + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 211. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/register-swaig-function.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/register-swaig-function.mdx new file mode 100644 index 0000000000..109c7d37b1 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/register-swaig-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/register-swaig-function" +title: "registerSwaigFunction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::registerSwaigFunction" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `registerSwaigFunction` + +Register a raw SWAIG function definition (e.g. DataMap tools). + +## Signature + +```php +public function registerSwaigFunction(array $funcDef): static +``` + +## Parameters + + + +## Returns + +`static` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 252. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/remove-function.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/remove-function.mdx new file mode 100644 index 0000000000..15ccbf3114 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/remove-function.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/remove-function" +title: "removeFunction" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::removeFunction" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `removeFunction` + +Remove a registered SWAIG function. True on success, false if absent. + +Python parity: `ToolRegistry.remove_function`. + +## Signature + +```php +public function removeFunction(string $name): bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 313. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/render-pretty.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/render-pretty.mdx new file mode 100644 index 0000000000..355283d517 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/render-pretty.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/render-pretty" +title: "renderPretty" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::renderPretty" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `renderPretty` + +## Signature + +```php +public function renderPretty(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 467. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/render-swml.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/render-swml.mdx new file mode 100644 index 0000000000..185af82eb5 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/render-swml.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/render-swml" +title: "renderSwml" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::renderSwml" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `renderSwml` + +Render SWML for a request. Subclasses override this. + +## Signature + +```php +public function renderSwml( + ?array $requestBody = NULL, + array $headers = array ( +) +): array +``` + +## Parameters + + + + + +## Returns + +`array` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 475. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/render.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/render.mdx new file mode 100644 index 0000000000..8861c4f493 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/render.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/render" +title: "render" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::render" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `render` + +## Signature + +```php +public function render(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 462. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/run.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/run.mdx new file mode 100644 index 0000000000..ac8adc1c83 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/run.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/run" +title: "run" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::run" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `run` + +Run the service (alias for serve). + +## Signature + +```php +public function run(): void +``` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 763. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/serve.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/serve.mdx new file mode 100644 index 0000000000..221a941378 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/serve.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/serve" +title: "serve" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::serve" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `serve` + +Start serving using PHP's built-in server (blocking). + +In CLI mode: spawns `php -S host:port ` where entry-script +is the example file the user ran. The entry script is responsible for +(re)building the service and calling run() — under the cli-server SAPI, +run() dispatches from $\_SERVER instead of re-spawning. + +Under cli-server SAPI: directly dispatches the inbound request to +handleRequest() and writes the result to the response. + +## Signature + +```php +public function serve(): void +``` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 731. diff --git a/fern/products/sdk-reference/php/signal-wire/swml/swml/service/validate-basic-auth.mdx b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/validate-basic-auth.mdx new file mode 100644 index 0000000000..2835ccd9ed --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/swml/swml/service/validate-basic-auth.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/php/signal-wire/swml/swml/service/validate-basic-auth" +title: "validateBasicAuth" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\SWML\\Service::validateBasicAuth" + parent: "SignalWire\\SWML\\Service" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php" + visibility: "public" +--- +# `validateBasicAuth` + +Validate provided basic-auth credentials against the configured ones + +using a constant-time comparison. Python parity: +AuthMixin.validate\_basic\_auth(username, password). + +## Signature + +```php +public function validateBasicAuth(string $username, string $password): bool +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`SignalWire/SWML/Service.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/SWML/Service.php) + +Line 169. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/index.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/index.mdx new file mode 100644 index 0000000000..04a6d2e115 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/php/signal-wire/utils/utils" +title: "Utils" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "module" + language: "php" + qualified_name: "SignalWire\\Utils" + module: "SignalWire.Utils" +--- +# `Utils` + +## Signature + +```php +namespace SignalWire\Utils +``` + +## Classes + + + + SchemaUtils — PHP port of signalwire.utils.schema\_utils.SchemaUtils. + + + + SchemaValidationError — PHP port of + + + + SSRF-prevention guard for user-supplied URLs. + + diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/construct.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/construct.mdx new file mode 100644 index 0000000000..db5d5c50bf --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/construct.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils::__construct" + parent: "SignalWire\\Utils\\SchemaUtils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" + visibility: "public" +--- +# `__construct` + +Construct a SchemaUtils. + +## Signature + +```php +public function __construct(?string $schemaPath = NULL, bool $schemaValidation = true) +``` + +## Parameters + + + Path to a schema.json file; null for the bundled copy. + + + + Whether to enable schema validation (env override applies). + + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 56. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/generate-method-body.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/generate-method-body.mdx new file mode 100644 index 0000000000..ce60a683dc --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/generate-method-body.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils/generate-method-body" +title: "generateMethodBody" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils::generateMethodBody" + parent: "SignalWire\\Utils\\SchemaUtils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" + visibility: "public" +--- +# `generateMethodBody` + +Generate a Python-style method body string for a verb. + +Mirrors Python's generate\_method\_body(verb\_name). + +## Signature + +```php +public function generateMethodBody(string $verbName): string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 344. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/generate-method-signature.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/generate-method-signature.mdx new file mode 100644 index 0000000000..0be539ab09 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/generate-method-signature.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils/generate-method-signature" +title: "generateMethodSignature" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils::generateMethodSignature" + parent: "SignalWire\\Utils\\SchemaUtils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" + visibility: "public" +--- +# `generateMethodSignature` + +Generate a Python-style method signature string for a verb. + +Mirrors Python's generate\_method\_signature(verb\_name). + +## Signature + +```php +public function generateMethodSignature(string $verbName): string +``` + +## Parameters + + + +## Returns + +`string` + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 309. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-all-verb-names.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-all-verb-names.mdx new file mode 100644 index 0000000000..f1e572c243 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-all-verb-names.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils/get-all-verb-names" +title: "getAllVerbNames" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils::getAllVerbNames" + parent: "SignalWire\\Utils\\SchemaUtils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" + visibility: "public" +--- +# `getAllVerbNames` + +Sorted list of all known verb names. + +Mirrors Python's get\_all\_verb\_names(). + +## Signature + +```php +public function getAllVerbNames(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 180. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-verb-parameters.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-verb-parameters.mdx new file mode 100644 index 0000000000..e512259634 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-verb-parameters.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils/get-verb-parameters" +title: "getVerbParameters" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils::getVerbParameters" + parent: "SignalWire\\Utils\\SchemaUtils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" + visibility: "public" +--- +# `getVerbParameters` + +Parameter-definition block used by code-gen tooling. + +Mirrors Python's get\_verb\_parameters(verb\_name). + +## Signature + +```php +public function getVerbParameters(string $verbName): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 232. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-verb-properties.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-verb-properties.mdx new file mode 100644 index 0000000000..747360d18e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-verb-properties.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils/get-verb-properties" +title: "getVerbProperties" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils::getVerbProperties" + parent: "SignalWire\\Utils\\SchemaUtils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" + visibility: "public" +--- +# `getVerbProperties` + +The properties\[verb\_name] block for a verb, or \[] when unknown. + +Mirrors Python's get\_verb\_properties(verb\_name). + +## Signature + +```php +public function getVerbProperties(string $verbName): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 193. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-verb-required-properties.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-verb-required-properties.mdx new file mode 100644 index 0000000000..933de5e695 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/get-verb-required-properties.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils/get-verb-required-properties" +title: "getVerbRequiredProperties" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils::getVerbRequiredProperties" + parent: "SignalWire\\Utils\\SchemaUtils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" + visibility: "public" +--- +# `getVerbRequiredProperties` + +The required list for a verb, or \[] when unknown / no required. + +Mirrors Python's get\_verb\_required\_properties(verb\_name). + +## Signature + +```php +public function getVerbRequiredProperties(string $verbName): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 216. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/index.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/index.mdx new file mode 100644 index 0000000000..096864b7ba --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/index.mdx @@ -0,0 +1,96 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils" +title: "SchemaUtils" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils" + parent: "SignalWire\\Utils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" +--- +# `SchemaUtils` + +SchemaUtils — PHP port of signalwire.utils.schema\_utils.SchemaUtils. + +Loads the SWML JSON Schema, extracts verb metadata, and validates +either a single verb config or a complete SWML document. + +Construction rules mirror Python: + +- Pass schemaPath=null to use the bundled schema.json. +- schemaValidation=false disables validation (validate\_verb returns + valid=true for every call). +- The env var SWML\_SKIP\_SCHEMA\_VALIDATION=1/true/yes also disables + validation regardless of the constructor argument. + +The PHP port currently ships only the lightweight validator (verb +existence + required-property check). Full JSON Schema validation +can be wired in via justinrainbow/json-schema by extending +initFullValidator(). The lightweight contract matches Python's +\_validate\_verb\_lightweight() exactly. + +**Modifiers:** `final` + +## Signature + +```php +final class SchemaUtils +``` + +## Methods + + + + Construct a SchemaUtils. + + + + Generate a Python-style method body string for a verb. + + + + Generate a Python-style method signature string for a verb. + + + + Sorted list of all known verb names. + + + + Parameter-definition block used by code-gen tooling. + + + + The properties\[verb\_name] block for a verb, or \[] when unknown. + + + + The required list for a verb, or \[] when unknown / no required. + + + + Whether full JSON Schema validation is wired up. + + + + Read and parse the JSON Schema. Mirrors Python's load\_schema(). + + + + Validate a complete SWML document. Mirrors Python's + + + + Validate a verb config against the schema. + + + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 33. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/is-full-validation-available.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/is-full-validation-available.mdx new file mode 100644 index 0000000000..4746a629a9 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/is-full-validation-available.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils/is-full-validation-available" +title: "isFullValidationAvailable" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils::isFullValidationAvailable" + parent: "SignalWire\\Utils\\SchemaUtils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" + visibility: "public" +--- +# `isFullValidationAvailable` + +Whether full JSON Schema validation is wired up. + +Mirrors Python's full\_validation\_available property. + +## Signature + +```php +public function isFullValidationAvailable(): bool +``` + +## Returns + +`bool` + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 169. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/load-schema.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/load-schema.mdx new file mode 100644 index 0000000000..fecd77e918 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/load-schema.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils/load-schema" +title: "loadSchema" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils::loadSchema" + parent: "SignalWire\\Utils\\SchemaUtils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" + visibility: "public" +--- +# `loadSchema` + +Read and parse the JSON Schema. Mirrors Python's load\_schema(). + +## Signature + +```php +public function loadSchema(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 79. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/validate-document.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/validate-document.mdx new file mode 100644 index 0000000000..8e7bf79463 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/validate-document.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils/validate-document" +title: "validateDocument" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils::validateDocument" + parent: "SignalWire\\Utils\\SchemaUtils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" + visibility: "public" +--- +# `validateDocument` + +Validate a complete SWML document. Mirrors Python's + +validate\_document(document). Returns (false, \['Schema validator +not initialized']) when no full validator is wired in. + +## Signature + +```php +public function validateDocument(array $document): array +``` + +## Parameters + + + +## Returns + +`array` + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 296. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/validate-verb.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/validate-verb.mdx new file mode 100644 index 0000000000..2d84988b79 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-utils/validate-verb.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-utils/validate-verb" +title: "validateVerb" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaUtils::validateVerb" + parent: "SignalWire\\Utils\\SchemaUtils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php" + visibility: "public" +--- +# `validateVerb` + +Validate a verb config against the schema. + +Mirrors Python's validate\_verb(verb\_name, verb\_config). + +## Signature + +```php +public function validateVerb(string $verbName, array $verbConfig): array +``` + +## Parameters + + + + + +## Returns + +`array` — Tuple of (valid, errors). + +## Source + +[`SignalWire/Utils/SchemaUtils.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaUtils.php) + +Line 249. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/construct.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/construct.mdx new file mode 100644 index 0000000000..4de1825889 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/construct.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-validation-error/construct" +title: "__construct" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaValidationError::__construct" + parent: "SignalWire\\Utils\\SchemaValidationError" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaValidationError.php" + visibility: "public" +--- +# `__construct` + +Construct a SchemaValidationError. Mirrors Python's + +SchemaValidationError(verb\_name, errors). + +## Signature + +```php +public function __construct(string $verbName, array $errors) +``` + +## Parameters + + + the verb whose validation failed + + + + human-readable error messages + + +## Source + +[`SignalWire/Utils/SchemaValidationError.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaValidationError.php) + +Line 34. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/get-errors.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/get-errors.mdx new file mode 100644 index 0000000000..235cc304ab --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/get-errors.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-validation-error/get-errors" +title: "getErrors" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaValidationError::getErrors" + parent: "SignalWire\\Utils\\SchemaValidationError" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaValidationError.php" + visibility: "public" +--- +# `getErrors` + +## Signature + +```php +public function getErrors(): array +``` + +## Returns + +`array` + +## Source + +[`SignalWire/Utils/SchemaValidationError.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaValidationError.php) + +Line 48. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/get-verb-name.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/get-verb-name.mdx new file mode 100644 index 0000000000..f9ae7ef67f --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/get-verb-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-validation-error/get-verb-name" +title: "getVerbName" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaValidationError::getVerbName" + parent: "SignalWire\\Utils\\SchemaValidationError" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaValidationError.php" + visibility: "public" +--- +# `getVerbName` + +## Signature + +```php +public function getVerbName(): string +``` + +## Returns + +`string` + +## Source + +[`SignalWire/Utils/SchemaValidationError.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaValidationError.php) + +Line 42. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/index.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/index.mdx new file mode 100644 index 0000000000..7c6b2785ee --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/schema-validation-error/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/schema-validation-error" +title: "SchemaValidationError" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Utils\\SchemaValidationError" + parent: "SignalWire\\Utils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaValidationError.php" +--- +# `SchemaValidationError` + +SchemaValidationError — PHP port of + +signalwire.utils.schema\_utils.SchemaValidationError. + +Thrown when SWML schema validation of a verb config fails. + +## Signature + +```php +class SchemaValidationError extends RuntimeException implements Stringable, Throwable +``` + +## Inheritance + +**Extends:** `RuntimeException` + +**Implements:** `Stringable`, `Throwable` + +## Methods + + + + Construct a SchemaValidationError. Mirrors Python's + + + + + + + +## Source + +[`SignalWire/Utils/SchemaValidationError.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/SchemaValidationError.php) + +Line 20. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/url-validator/index.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/url-validator/index.mdx new file mode 100644 index 0000000000..840a1fc4d4 --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/url-validator/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/url-validator" +title: "UrlValidator" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "class" + language: "php" + qualified_name: "SignalWire\\Utils\\UrlValidator" + parent: "SignalWire\\Utils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/UrlValidator.php" +--- +# `UrlValidator` + +SSRF-prevention guard for user-supplied URLs. + +Mirrors Python's signalwire.utils.url\_validator.validate\_url: +rejects non-http(s) schemes, missing hostnames, and any URL whose +hostname resolves to a private / loopback / link-local / cloud-metadata +IP. The $allowPrivate parameter, OR the SWML\_ALLOW\_PRIVATE\_URLS env +var with value "1", "true" or "yes" (case-insensitive), bypasses the +IP-blocklist check. + +The static method validateUrl projects onto the Python free function +signalwire.utils.url\_validator.validate\_url via +scripts/enumerate\_signatures.py. + +**Modifiers:** `final` + +## Signature + +```php +final class UrlValidator +``` + +## Properties + + + Pluggable resolver. Tests inject a callable to keep the suite hermetic; production calls dns\_get\_record/gethostbynamel. Signature: function(string $hostname): ?array (array of IP strings, or null on resolution failure). + + +## Constants + + + +## Methods + + + + Validate that a URL is safe to fetch. + + + +## Source + +[`SignalWire/Utils/UrlValidator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/UrlValidator.php) + +Line 30. diff --git a/fern/products/sdk-reference/php/signal-wire/utils/utils/url-validator/validate-url.mdx b/fern/products/sdk-reference/php/signal-wire/utils/utils/url-validator/validate-url.mdx new file mode 100644 index 0000000000..e3b2a98c1e --- /dev/null +++ b/fern/products/sdk-reference/php/signal-wire/utils/utils/url-validator/validate-url.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/php/signal-wire/utils/utils/url-validator/validate-url" +title: "validateUrl" +sdk_label: "PHP SDK" +icon: "php" +lustri: + auto_generated: true + kind: "method" + language: "php" + qualified_name: "SignalWire\\Utils\\UrlValidator::validateUrl" + parent: "SignalWire\\Utils\\UrlValidator" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/UrlValidator.php" + visibility: "public" +--- +# `validateUrl` + +Validate that a URL is safe to fetch. + +**Modifiers:** `static` + +## Signature + +```php +public static function validateUrl(string $url, bool $allowPrivate = false): bool +``` + +## Parameters + + + URL to validate. + + + + When true, bypass the IP-blocklist check. + + +## Returns + +`bool` + +## Source + +[`SignalWire/Utils/UrlValidator.php`](https://github.com/signalwire/signalwire-php/blob/main/SignalWire/Utils/UrlValidator.php) + +Line 62. diff --git a/fern/products/sdk-reference/python/_meta.json b/fern/products/sdk-reference/python/_meta.json new file mode 100644 index 0000000000..1a638d3efd --- /dev/null +++ b/fern/products/sdk-reference/python/_meta.json @@ -0,0 +1,10 @@ +{ + "language": "python", + "sdk_name": "signalwire", + "version": null, + "source_repo": "https://github.com/signalwire/signalwire-python", + "format": "mdx", + "platform": "fern", + "base_slug": "/reference/python", + "item_count": 2470 +} \ No newline at end of file diff --git a/fern/products/sdk-reference/python/index.mdx b/fern/products/sdk-reference/python/index.mdx new file mode 100644 index 0000000000..b1d419bb56 --- /dev/null +++ b/fern/products/sdk-reference/python/index.mdx @@ -0,0 +1,14 @@ +--- +title: "Python SDK" +slug: "/reference/python" +lustri: + auto_generated: true + language: "python" + kind: "sdk" +--- +# Python SDK Reference + +## Modules + +- [`signalwire`](/reference/python/signalwire) + diff --git a/fern/products/sdk-reference/python/signalwire/add-skill-directory.mdx b/fern/products/sdk-reference/python/signalwire/add-skill-directory.mdx new file mode 100644 index 0000000000..db8c5a847e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/add-skill-directory.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/add-skill-directory" +title: "add_skill_directory" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.add_skill_directory" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py" +--- +# `add_skill_directory` + +Add a directory to search for skills + +This allows third-party skill collections to be registered by path. +Skills in these directories should follow the same structure as built-in skills. + +> \[!NOTE] +> +> > > > add\_skill\_directory('/opt/custom\_skills') +> > > > +> > > > # Now agent.add\_skill('my\_custom\_skill') will search in this directory + +## Signature + +```python +add_skill_directory(path) +``` + +## Parameters + + + Path to directory containing skill subdirectories + + +## Source + +[`signalwire/signalwire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py) + +Line 114. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/add-security-headers.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/add-security-headers.mdx new file mode 100644 index 0000000000..b5887cf098 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/add-security-headers.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server/add-security-headers" +title: "add_security_headers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer.__init__.add_security_headers" + parent: "signalwire.agent_server.AgentServer.__init__" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `add_security_headers` + +**Modifiers:** `async` + +**Decorators:** `@self.app.middleware('http')` + +## Signature + +```python +async add_security_headers(request, call_next) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 72. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/get-agent.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/get-agent.mdx new file mode 100644 index 0000000000..358dd55e5e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/get-agent.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server/get-agent" +title: "get_agent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer.get_agent" + parent: "signalwire.agent_server.AgentServer" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `get_agent` + +Get an agent by route + +## Signature + +```python +get_agent(route: str) -> Optional[AgentBase] +``` + +## Parameters + + + The route of the agent + + +## Returns + +`Optional[AgentBase]` — The agent or None if not found + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 310. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/get-agents.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/get-agents.mdx new file mode 100644 index 0000000000..d0b2704cbf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/get-agents.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server/get-agents" +title: "get_agents" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer.get_agents" + parent: "signalwire.agent_server.AgentServer" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `get_agents` + +Get all registered agents + +## Signature + +```python +get_agents() -> List[Tuple[str, AgentBase]] +``` + +## Returns + +`List[Tuple[str, AgentBase]]` — List of (route, agent) tuples + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 301. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/index.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/index.mdx new file mode 100644 index 0000000000..f26fc74a80 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/index.mdx @@ -0,0 +1,96 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server" +title: "AgentServer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer" + parent: "signalwire.agent_server" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `AgentServer` + +Server for hosting multiple SignalWire AI Agents under a single FastAPI application. + +This allows you to run multiple agents on different routes of the same server, +which is useful for deployment and resource management. + +> \[!NOTE] +> server = AgentServer() +> server.register(SupportAgent(), "/support") +> server.register(SalesAgent(), "/sales") +> server.run() + +## Signature + +```python +class AgentServer +``` + +## Properties + + + + + + + + + + + + + +## Methods + + + + Initialize a new agent server + + + + Get an agent by route + + + + Get all registered agents + + + + Register an agent with the server + + + + Register a routing callback across all agents + + + + Register a mapping from SIP username to agent route + + + + Universal run method that automatically detects environment and handles accordingly + + + + Serve static files from a directory. + + + + Set up central SIP-based routing for the server + + + + Unregister an agent from the server + + + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 31. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/init.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/init.mdx new file mode 100644 index 0000000000..7c21745492 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/init.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer.__init__" + parent: "signalwire.agent_server.AgentServer" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `__init__` + +Initialize a new agent server + +## Signature + +```python +__init__(host: str = '0.0.0.0', port: int = 3000, log_level: str = 'info') +``` + +## Parameters + + + Host to bind the server to + + + + Port to bind the server to + + + + Logging level (debug, info, warning, error, critical) + + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 45. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/register-global-routing-callback.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/register-global-routing-callback.mdx new file mode 100644 index 0000000000..dee231ce9e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/register-global-routing-callback.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server/register-global-routing-callback" +title: "register_global_routing_callback" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer.register_global_routing_callback" + parent: "signalwire.agent_server.AgentServer" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `register_global_routing_callback` + +Register a routing callback across all agents + +This allows you to add unified routing logic to all agents at the same path. + +## Signature + +```python +register_global_routing_callback( + callback_fn: Callable[Request, Dict[str, Any], Optional[str]], + path: str +) -> None +``` + +## Parameters + + + The callback function to register + + + + The path to register the callback at + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 652. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/register-sip-username.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/register-sip-username.mdx new file mode 100644 index 0000000000..5bd59f7c4a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/register-sip-username.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server/register-sip-username" +title: "register_sip_username" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer.register_sip_username" + parent: "signalwire.agent_server.AgentServer" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `register_sip_username` + +Register a mapping from SIP username to agent route + +## Signature + +```python +register_sip_username(username: str, route: str) -> None +``` + +## Parameters + + + The SIP username + + + + The route to the agent + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 210. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/register.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/register.mdx new file mode 100644 index 0000000000..4542ce6123 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/register.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server/register" +title: "register" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer.register" + parent: "signalwire.agent_server.AgentServer" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `register` + +Register an agent with the server + +## Signature + +```python +register(agent: AgentBase, route: Optional[str] = None) -> None +``` + +## Parameters + + + The agent to register + + + + Optional route to override the agent's default route + + +## Returns + +`None` + +## Throws + +- `ValueError` — If the route is already in use + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 102. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/run.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/run.mdx new file mode 100644 index 0000000000..5567aa0475 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/run.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server/run" +title: "run" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer.run" + parent: "signalwire.agent_server.AgentServer" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `run` + +Universal run method that automatically detects environment and handles accordingly + +Detects execution mode and routes appropriately: + +- Server mode: Starts uvicorn server with FastAPI +- CGI mode: Uses same routing logic but outputs CGI headers +- Lambda mode: Uses same routing logic but returns Lambda response + +## Signature + +```python +run( + event = None, + context = None, + host: Optional[str] = None, + port: Optional[int] = None +) -> Any +``` + +## Parameters + + + Serverless event object (Lambda, Cloud Functions) + + + + Serverless context object (Lambda, Cloud Functions) + + + + Optional host to override the default (server mode only) + + + + Optional port to override the default (server mode only) + + +## Returns + +`Any` — Response for serverless modes, None for server mode + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 328. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/serve-static-files.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/serve-static-files.mdx new file mode 100644 index 0000000000..15829f2bac --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/serve-static-files.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server/serve-static-files" +title: "serve_static_files" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer.serve_static_files" + parent: "signalwire.agent_server.AgentServer" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `serve_static_files` + +Serve static files from a directory. + +This method properly integrates static file serving with agent routes, +ensuring that agent routes take priority over static files. + +Unlike using StaticFiles.mount("/", ...) directly on self.app, this method +uses explicit route handlers that work correctly with agent routes. + +> \[!NOTE] +> server = AgentServer() +> server.register(SupportAgent(), "/support") +> server.serve\_static\_files("./web") # Serves at / +> +> # /support -> SupportAgent +> +> # /index.html -> ./web/index.html +> +> # / -> ./web/index.html + +## Signature + +```python +serve_static_files(directory: str, route: str = '/') -> None +``` + +## Parameters + + + Path to the directory containing static files + + + + URL path prefix for static files (default: "/" for root) + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 675. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/setup-sip-routing.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/setup-sip-routing.mdx new file mode 100644 index 0000000000..48dd3bb87b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/setup-sip-routing.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server/setup-sip-routing" +title: "setup_sip_routing" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer.setup_sip_routing" + parent: "signalwire.agent_server.AgentServer" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `setup_sip_routing` + +Set up central SIP-based routing for the server + +This configures all agents to handle SIP requests at the specified path, +using a coordinated routing system where each agent checks if it can +handle SIP requests for specific usernames. + +## Signature + +```python +setup_sip_routing(route: str = '/sip', auto_map: bool = True) -> None +``` + +## Parameters + + + The path for SIP routing (default: "/sip") + + + + Whether to automatically map SIP usernames to agent routes + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 147. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/unregister.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/unregister.mdx new file mode 100644 index 0000000000..b1a7073130 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/agent-server/unregister.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/agent-server/agent-server/unregister" +title: "unregister" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.agent_server.AgentServer.unregister" + parent: "signalwire.agent_server.AgentServer" + module: "signalwire.agent_server" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `unregister` + +Unregister an agent from the server + +## Signature + +```python +unregister(route: str) -> bool +``` + +## Parameters + + + The route of the agent to unregister + + +## Returns + +`bool` — True if the agent was unregistered, False if not found + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) + +Line 274. diff --git a/fern/products/sdk-reference/python/signalwire/agent-server/index.mdx b/fern/products/sdk-reference/python/signalwire/agent-server/index.mdx new file mode 100644 index 0000000000..75ccac3d87 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/agent-server/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/agent-server" +title: "agent_server" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.agent_server" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py" +--- +# `agent_server` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module agent_server +``` + +## Classes + + + + Server for hosting multiple SignalWire AI Agents under a single FastAPI application. + + + +## Source + +[`signalwire/signalwire/agent_server.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/agent_server.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/build-search/console-entry-point.mdx b/fern/products/sdk-reference/python/signalwire/cli/build-search/console-entry-point.mdx new file mode 100644 index 0000000000..a04b9b95bd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/build-search/console-entry-point.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/build-search/console-entry-point" +title: "console_entry_point" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.build_search.console_entry_point" + parent: "signalwire.cli.build_search" + module: "signalwire.cli.build_search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py" +--- +# `console_entry_point` + +Console script entry point for pip installation + +## Signature + +```python +console_entry_point() +``` + +## Source + +[`signalwire/signalwire/cli/build_search.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py) + +Line 1238. diff --git a/fern/products/sdk-reference/python/signalwire/cli/build-search/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/build-search/index.mdx new file mode 100644 index 0000000000..342fe64cdb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/build-search/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/cli/build-search" +title: "build_search" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.build_search" + parent: "signalwire.cli" + module: "signalwire.cli" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py" +--- +# `build_search` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module build_search +``` + +## Functions + + + + Console script entry point for pip installation + + + + Main entry point for the build-search command + + + + Migrate search indexes between backends + + + + Search via remote API endpoint + + + + Search within an existing search index + + + + Validate an existing search index + + + +## Source + +[`signalwire/signalwire/cli/build_search.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/build-search/main.mdx b/fern/products/sdk-reference/python/signalwire/cli/build-search/main.mdx new file mode 100644 index 0000000000..1151c57ff1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/build-search/main.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/build-search/main" +title: "main" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.build_search.main" + parent: "signalwire.cli.build_search" + module: "signalwire.cli.build_search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py" +--- +# `main` + +Main entry point for the build-search command + +## Signature + +```python +main() +``` + +## Source + +[`signalwire/signalwire/cli/build_search.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py) + +Line 34. diff --git a/fern/products/sdk-reference/python/signalwire/cli/build-search/migrate-command.mdx b/fern/products/sdk-reference/python/signalwire/cli/build-search/migrate-command.mdx new file mode 100644 index 0000000000..4e04a64e98 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/build-search/migrate-command.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/build-search/migrate-command" +title: "migrate_command" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.build_search.migrate_command" + parent: "signalwire.cli.build_search" + module: "signalwire.cli.build_search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py" +--- +# `migrate_command` + +Migrate search indexes between backends + +## Signature + +```python +migrate_command() +``` + +## Source + +[`signalwire/signalwire/cli/build_search.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py) + +Line 967. diff --git a/fern/products/sdk-reference/python/signalwire/cli/build-search/remote-command.mdx b/fern/products/sdk-reference/python/signalwire/cli/build-search/remote-command.mdx new file mode 100644 index 0000000000..37ad7c314e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/build-search/remote-command.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/build-search/remote-command" +title: "remote_command" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.build_search.remote_command" + parent: "signalwire.cli.build_search" + module: "signalwire.cli.build_search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py" +--- +# `remote_command` + +Search via remote API endpoint + +## Signature + +```python +remote_command() +``` + +## Source + +[`signalwire/signalwire/cli/build_search.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py) + +Line 1103. diff --git a/fern/products/sdk-reference/python/signalwire/cli/build-search/search-command.mdx b/fern/products/sdk-reference/python/signalwire/cli/build-search/search-command.mdx new file mode 100644 index 0000000000..a674bf4824 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/build-search/search-command.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/build-search/search-command" +title: "search_command" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.build_search.search_command" + parent: "signalwire.cli.build_search" + module: "signalwire.cli.build_search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py" +--- +# `search_command` + +Search within an existing search index + +## Signature + +```python +search_command() +``` + +## Source + +[`signalwire/signalwire/cli/build_search.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py) + +Line 659. diff --git a/fern/products/sdk-reference/python/signalwire/cli/build-search/validate-command.mdx b/fern/products/sdk-reference/python/signalwire/cli/build-search/validate-command.mdx new file mode 100644 index 0000000000..fe11d0a56d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/build-search/validate-command.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/build-search/validate-command" +title: "validate_command" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.build_search.validate_command" + parent: "signalwire.cli.build_search" + module: "signalwire.cli.build_search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py" +--- +# `validate_command` + +Validate an existing search index + +## Signature + +```python +validate_command() +``` + +## Source + +[`signalwire/signalwire/cli/build_search.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/build_search.py) + +Line 621. diff --git a/fern/products/sdk-reference/python/signalwire/cli/config/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/config/index.mdx new file mode 100644 index 0000000000..e10c749376 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/config/index.mdx @@ -0,0 +1,80 @@ +--- +slug: "/reference/python/signalwire/cli/config" +title: "config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.config" + parent: "signalwire.cli" + module: "signalwire.cli" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/config.py" +--- +# `config` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module config +``` + +## Constants + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/cli/config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/config.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/discover-agents-in-file.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/discover-agents-in-file.mdx new file mode 100644 index 0000000000..a79b0a7a03 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/discover-agents-in-file.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/cli/core/agent-loader/discover-agents-in-file" +title: "discover_agents_in_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.core.agent_loader.discover_agents_in_file" + parent: "signalwire.cli.core.agent_loader" + module: "signalwire.cli.core.agent_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/agent_loader.py" +--- +# `discover_agents_in_file` + +Backward compatibility wrapper - discovers agents in a file + +## Signature + +```python +discover_agents_in_file(agent_path: str) -> List[Dict[str, Any]] +``` + +## Parameters + + + Path to the Python file containing agents + + +## Returns + +`List[Dict[str, Any]]` — List of dictionaries with agent information + +## Source + +[`signalwire/signalwire/cli/core/agent_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/agent_loader.py) + +Line 59. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/discover-services-in-file.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/discover-services-in-file.mdx new file mode 100644 index 0000000000..0f709690b0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/discover-services-in-file.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/cli/core/agent-loader/discover-services-in-file" +title: "discover_services_in_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.core.agent_loader.discover_services_in_file" + parent: "signalwire.cli.core.agent_loader" + module: "signalwire.cli.core.agent_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/agent_loader.py" +--- +# `discover_services_in_file` + +Discover all available SWML services (including agents) in a Python file without instantiating them + +## Signature + +```python +discover_services_in_file(service_path: str) -> List[Dict[str, Any]] +``` + +## Parameters + + + Path to the Python file containing services + + +## Returns + +`List[Dict[str, Any]]` — List of dictionaries with service information + +## Throws + +- `ImportError` — If the file cannot be imported +- `FileNotFoundError` — If the file doesn't exist + +## Source + +[`signalwire/signalwire/cli/core/agent_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/agent_loader.py) + +Line 38. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/index.mdx new file mode 100644 index 0000000000..49bebc7e73 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/cli/core/agent-loader" +title: "agent_loader" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.core.agent_loader" + parent: "signalwire.cli.core" + module: "signalwire.cli.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/agent_loader.py" +--- +# `agent_loader` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module agent_loader +``` + +## Constants + + + + + + + +## Functions + + + + Backward compatibility wrapper - discovers agents in a file + + + + Discover all available SWML services (including agents) in a Python file without instantiating them + + + + Load an agent from a Python file + + + + Load a SWML service from a Python file + + + +## Source + +[`signalwire/signalwire/cli/core/agent_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/agent_loader.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/load-agent-from-file.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/load-agent-from-file.mdx new file mode 100644 index 0000000000..1b4a218d75 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/load-agent-from-file.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/cli/core/agent-loader/load-agent-from-file" +title: "load_agent_from_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.core.agent_loader.load_agent_from_file" + parent: "signalwire.cli.core.agent_loader" + module: "signalwire.cli.core.agent_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/agent_loader.py" +--- +# `load_agent_from_file` + +Load an agent from a Python file + +## Signature + +```python +load_agent_from_file( + agent_path: str, + agent_class_name: Optional[str] = None +) -> AgentBase +``` + +## Parameters + + + Path to the Python file containing the agent + + + + Optional name of the agent class to instantiate + + +## Returns + +`AgentBase` — AgentBase instance + +## Throws + +- `ImportError` — If the file cannot be imported +- `ValueError` — If no agent is found in the file + +## Source + +[`signalwire/signalwire/cli/core/agent_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/agent_loader.py) + +Line 193. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/load-service-from-file.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/load-service-from-file.mdx new file mode 100644 index 0000000000..74e1d53dd1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/agent-loader/load-service-from-file.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/cli/core/agent-loader/load-service-from-file" +title: "load_service_from_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.core.agent_loader.load_service_from_file" + parent: "signalwire.cli.core.agent_loader" + module: "signalwire.cli.core.agent_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/agent_loader.py" +--- +# `load_service_from_file` + +Load a SWML service from a Python file + +## Signature + +```python +load_service_from_file( + service_path: str, + service_identifier: Optional[str] = None, + prefer_route: bool = True +) -> SWMLService +``` + +## Parameters + + + Path to the Python file containing the service + + + + Optional service identifier - can be class name or route + + + + If True, interpret identifier as route first, then class name + + +## Returns + +`SWMLService` — SWMLService instance (could be AgentBase or basic SWMLService) + +## Throws + +- `ImportError` — If the file cannot be imported +- `ValueError` — If no service is found in the file + +## Source + +[`signalwire/signalwire/cli/core/agent_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/agent_loader.py) + +Line 170. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/error.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/error.mdx new file mode 100644 index 0000000000..63017d4036 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/error.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/error" +title: "error" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.core.argparse_helpers.CustomArgumentParser.error" + parent: "signalwire.cli.core.argparse_helpers.CustomArgumentParser" + module: "signalwire.cli.core.argparse_helpers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py" +--- +# `error` + +Override error method to provide user-friendly error messages + +## Signature + +```python +error(message) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/core/argparse_helpers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py) + +Line 33. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/index.mdx new file mode 100644 index 0000000000..f2de784ae2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser" +title: "CustomArgumentParser" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.core.argparse_helpers.CustomArgumentParser" + parent: "signalwire.cli.core.argparse_helpers" + module: "signalwire.cli.core.argparse_helpers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py" +--- +# `CustomArgumentParser` + +Custom ArgumentParser with better error handling + +## Signature + +```python +class CustomArgumentParser(argparse.ArgumentParser) +``` + +## Inheritance + +**Extends:** `argparse.ArgumentParser` + +## Methods + + + + + + Override error method to provide user-friendly error messages + + + + Override parse\_args to provide custom error handling for missing arguments + + + + Override print\_usage to suppress output when we want custom error handling + + + +## Source + +[`signalwire/signalwire/cli/core/argparse_helpers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/init.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/init.mdx new file mode 100644 index 0000000000..f738204d27 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.core.argparse_helpers.CustomArgumentParser.__init__" + parent: "signalwire.cli.core.argparse_helpers.CustomArgumentParser" + module: "signalwire.cli.core.argparse_helpers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py" +--- +# `__init__` + +## Signature + +```python +__init__(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/cli/core/argparse_helpers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/parse-args.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/parse-args.mdx new file mode 100644 index 0000000000..45cc071472 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/parse-args.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/parse-args" +title: "parse_args" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.core.argparse_helpers.CustomArgumentParser.parse_args" + parent: "signalwire.cli.core.argparse_helpers.CustomArgumentParser" + module: "signalwire.cli.core.argparse_helpers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py" +--- +# `parse_args` + +Override parse\_args to provide custom error handling for missing arguments + +## Signature + +```python +parse_args(args = None, namespace = None) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/cli/core/argparse_helpers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py) + +Line 58. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/print-usage.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/print-usage.mdx new file mode 100644 index 0000000000..6a9c0e70c0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/print-usage.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/core/argparse-helpers/custom-argument-parser/print-usage" +title: "print_usage" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.core.argparse_helpers.CustomArgumentParser.print_usage" + parent: "signalwire.cli.core.argparse_helpers.CustomArgumentParser" + module: "signalwire.cli.core.argparse_helpers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py" +--- +# `print_usage` + +Override print\_usage to suppress output when we want custom error handling + +## Signature + +```python +print_usage(file = None) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/core/argparse_helpers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py) + +Line 52. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/index.mdx new file mode 100644 index 0000000000..98d6daf219 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/cli/core/argparse-helpers" +title: "argparse_helpers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.core.argparse_helpers" + parent: "signalwire.cli.core" + module: "signalwire.cli.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py" +--- +# `argparse_helpers` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module argparse_helpers +``` + +## Functions + + + + Parse function arguments from command line with type coercion based on schema + + + +## Classes + + + + Custom ArgumentParser with better error handling + + + +## Source + +[`signalwire/signalwire/cli/core/argparse_helpers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/parse-function-arguments.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/parse-function-arguments.mdx new file mode 100644 index 0000000000..3d54573c91 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/argparse-helpers/parse-function-arguments.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/cli/core/argparse-helpers/parse-function-arguments" +title: "parse_function_arguments" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.core.argparse_helpers.parse_function_arguments" + parent: "signalwire.cli.core.argparse_helpers" + module: "signalwire.cli.core.argparse_helpers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py" +--- +# `parse_function_arguments` + +Parse function arguments from command line with type coercion based on schema + +## Signature + +```python +parse_function_arguments( + function_args_list: List[str], + func_schema: Dict[str, Any] +) -> Dict[str, Any] +``` + +## Parameters + + + List of command line arguments after --args + + + + Function schema with parameter definitions + + +## Returns + +`Dict[str, Any]` — Dictionary of parsed function arguments + +## Source + +[`signalwire/signalwire/cli/core/argparse_helpers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/argparse_helpers.py) + +Line 82. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/dynamic-config/apply-dynamic-config.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/dynamic-config/apply-dynamic-config.mdx new file mode 100644 index 0000000000..af2703b99f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/dynamic-config/apply-dynamic-config.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/cli/core/dynamic-config/apply-dynamic-config" +title: "apply_dynamic_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.core.dynamic_config.apply_dynamic_config" + parent: "signalwire.cli.core.dynamic_config" + module: "signalwire.cli.core.dynamic_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/dynamic_config.py" +--- +# `apply_dynamic_config` + +Apply dynamic configuration callback if the agent has one + +## Signature + +```python +apply_dynamic_config( + agent: AgentBase, + mock_request: Optional[MockRequest] = None, + verbose: bool = False +) -> None +``` + +## Parameters + + + The agent instance + + + + Optional mock request object + + + + Whether to print verbose output + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/cli/core/dynamic_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/dynamic_config.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/dynamic-config/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/dynamic-config/index.mdx new file mode 100644 index 0000000000..478fcc0df8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/dynamic-config/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/cli/core/dynamic-config" +title: "dynamic_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.core.dynamic_config" + parent: "signalwire.cli.core" + module: "signalwire.cli.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/dynamic_config.py" +--- +# `dynamic_config` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module dynamic_config +``` + +## Functions + + + + Apply dynamic configuration callback if the agent has one + + + +## Source + +[`signalwire/signalwire/cli/core/dynamic_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/dynamic_config.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/index.mdx new file mode 100644 index 0000000000..0cd2816a63 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/cli/core" +title: "core" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.core" + parent: "signalwire.cli" + module: "signalwire.cli" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/__init__.py" +--- +# `core` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module core +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/cli/core/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/discover-agents-in-file.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/discover-agents-in-file.mdx new file mode 100644 index 0000000000..db78261c34 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/discover-agents-in-file.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/core/service-loader/discover-agents-in-file" +title: "discover_agents_in_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.core.service_loader.discover_agents_in_file" + parent: "signalwire.cli.core.service_loader" + module: "signalwire.cli.core.service_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py" +--- +# `discover_agents_in_file` + +Backward compatibility wrapper + +## Signature + +```python +discover_agents_in_file(agent_path: str) -> List[Dict[str, Any]] +``` + +## Parameters + + + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/cli/core/service_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py) + +Line 282. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/index.mdx new file mode 100644 index 0000000000..51e5f97e39 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/index.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/python/signalwire/cli/core/service-loader" +title: "service_loader" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.core.service_loader" + parent: "signalwire.cli.core" + module: "signalwire.cli.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py" +--- +# `service_loader` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module service_loader +``` + +## Constants + + + +## Functions + + + + Backward compatibility wrapper + + + + Backward compatibility wrapper + + + + Load a service file and simulate a request to it + + + + Simulate a request to a SWMLService instance + + + +## Classes + + + + Captures SWMLService instances when they try to run/serve + + + +## Source + +[`signalwire/signalwire/cli/core/service_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/load-agent-from-file.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/load-agent-from-file.mdx new file mode 100644 index 0000000000..ff2374a251 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/load-agent-from-file.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/cli/core/service-loader/load-agent-from-file" +title: "load_agent_from_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.core.service_loader.load_agent_from_file" + parent: "signalwire.cli.core.service_loader" + module: "signalwire.cli.core.service_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py" +--- +# `load_agent_from_file` + +Backward compatibility wrapper + +Note: This still uses the direct extraction approach for compatibility + +## Signature + +```python +load_agent_from_file( + agent_path: str, + agent_class_name: Optional[str] = None, + suppress_output: bool = False +) -> AgentBase +``` + +## Parameters + + + + + + + +## Returns + +`AgentBase` + +## Source + +[`signalwire/signalwire/cli/core/service_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py) + +Line 253. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/load-and-simulate-service.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/load-and-simulate-service.mdx new file mode 100644 index 0000000000..5be47e71ac --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/load-and-simulate-service.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/python/signalwire/cli/core/service-loader/load-and-simulate-service" +title: "load_and_simulate_service" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.core.service_loader.load_and_simulate_service" + parent: "signalwire.cli.core.service_loader" + module: "signalwire.cli.core.service_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py" +--- +# `load_and_simulate_service` + +Load a service file and simulate a request to it + +This is the main entry point that combines loading and request simulation + +## Signature + +```python +load_and_simulate_service( + service_path: str, + route: Optional[str] = None, + method: str = 'POST', + body: Optional[dict] = None, + query_params: Optional[dict] = None, + headers: Optional[dict] = None, + suppress_output: bool = False +) -> dict +``` + +## Parameters + + + Path to the service file + + + + Optional route to request (for multi-service files) + + + + HTTP method + + + + Request body + + + + Query parameters + + + + Request headers + + + + +## Returns + +`dict` — The service's response + +## Source + +[`signalwire/signalwire/cli/core/service_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py) + +Line 183. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/service-capture/capture.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/service-capture/capture.mdx new file mode 100644 index 0000000000..f3635fc22c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/service-capture/capture.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/cli/core/service-loader/service-capture/capture" +title: "capture" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.core.service_loader.ServiceCapture.capture" + parent: "signalwire.cli.core.service_loader.ServiceCapture" + module: "signalwire.cli.core.service_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py" +--- +# `capture` + +Execute a service file and capture any services that try to run + +## Signature + +```python +capture(service_path: str, suppress_output: bool = False) -> List[SWMLService] +``` + +## Parameters + + + Path to the Python file + + + + If True, suppress stdout during module execution + + +## Returns + +`List[SWMLService]` — List of captured SWMLService instances + +## Source + +[`signalwire/signalwire/cli/core/service_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py) + +Line 44. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/service-capture/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/service-capture/index.mdx new file mode 100644 index 0000000000..587edc4a71 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/service-capture/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/cli/core/service-loader/service-capture" +title: "ServiceCapture" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.core.service_loader.ServiceCapture" + parent: "signalwire.cli.core.service_loader" + module: "signalwire.cli.core.service_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py" +--- +# `ServiceCapture` + +Captures SWMLService instances when they try to run/serve + +## Signature + +```python +class ServiceCapture +``` + +## Properties + + + + + +## Methods + + + + + + Execute a service file and capture any services that try to run + + + +## Source + +[`signalwire/signalwire/cli/core/service_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py) + +Line 37. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/service-capture/init.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/service-capture/init.mdx new file mode 100644 index 0000000000..3589c47e16 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/service-capture/init.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/cli/core/service-loader/service-capture/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.core.service_loader.ServiceCapture.__init__" + parent: "signalwire.cli.core.service_loader.ServiceCapture" + module: "signalwire.cli.core.service_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py" +--- +# `__init__` + +## Signature + +```python +__init__() +``` + +## Source + +[`signalwire/signalwire/cli/core/service_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py) + +Line 40. diff --git a/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/simulate-request-to-service.mdx b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/simulate-request-to-service.mdx new file mode 100644 index 0000000000..2e9fef50a0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/core/service-loader/simulate-request-to-service.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/python/signalwire/cli/core/service-loader/simulate-request-to-service" +title: "simulate_request_to_service" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.core.service_loader.simulate_request_to_service" + parent: "signalwire.cli.core.service_loader" + module: "signalwire.cli.core.service_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py" +--- +# `simulate_request_to_service` + +Simulate a request to a SWMLService instance + +**Modifiers:** `async` + +## Signature + +```python +async simulate_request_to_service( + service: SWMLService, + method: str = 'POST', + body: Optional[dict] = None, + query_params: Optional[dict] = None, + headers: Optional[dict] = None +) -> dict +``` + +## Parameters + + + The SWMLService instance + + + + HTTP method (GET or POST) + + + + Request body for POST requests + + + + Query parameters + + + + Request headers + + +## Returns + +`dict` — The service's response as a dict + +## Source + +[`signalwire/signalwire/cli/core/service_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/core/service_loader.py) + +Line 135. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-config.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-config.mdx new file mode 100644 index 0000000000..a886ebe243 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-config.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/cmd-config" +title: "cmd_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.cmd_config" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `cmd_config` + +Manage Dokku config. + +## Signature + +```python +cmd_config(args) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 2158. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-deploy.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-deploy.mdx new file mode 100644 index 0000000000..7636045b00 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-deploy.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/cmd-deploy" +title: "cmd_deploy" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.cmd_deploy" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `cmd_deploy` + +Deploy to Dokku. + +## Signature + +```python +cmd_deploy(args) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 2071. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-init.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-init.mdx new file mode 100644 index 0000000000..52065e36b2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/cmd-init" +title: "cmd_init" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.cmd_init" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `cmd_init` + +Initialize a new Dokku project. + +## Signature + +```python +cmd_init(args) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 1970. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-logs.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-logs.mdx new file mode 100644 index 0000000000..8d6141c12e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-logs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/cmd-logs" +title: "cmd_logs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.cmd_logs" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `cmd_logs` + +Tail Dokku logs. + +## Signature + +```python +cmd_logs(args) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 2136. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-scale.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-scale.mdx new file mode 100644 index 0000000000..8a1c770876 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/cmd-scale.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/cmd-scale" +title: "cmd_scale" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.cmd_scale" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `cmd_scale` + +Scale Dokku processes. + +## Signature + +```python +cmd_scale(args) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 2186. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/colors/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/colors/index.mdx new file mode 100644 index 0000000000..b3a5aa4639 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/colors/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/colors" +title: "Colors" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.dokku.Colors" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `Colors` + +## Signature + +```python +class Colors +``` + +## Properties + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 34. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/dokku-project-generator/generate.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/dokku-project-generator/generate.mdx new file mode 100644 index 0000000000..0768ba74ea --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/dokku-project-generator/generate.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/dokku-project-generator/generate" +title: "generate" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.dokku.DokkuProjectGenerator.generate" + parent: "signalwire.cli.dokku.DokkuProjectGenerator" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `generate` + +Generate the project files. + +## Signature + +```python +generate() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 1828. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/dokku-project-generator/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/dokku-project-generator/index.mdx new file mode 100644 index 0000000000..43bdb17d32 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/dokku-project-generator/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/dokku-project-generator" +title: "DokkuProjectGenerator" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.dokku.DokkuProjectGenerator" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `DokkuProjectGenerator` + +Generates Dokku deployment files for SignalWire agents. + +## Signature + +```python +class DokkuProjectGenerator +``` + +## Properties + + + + + + + + + + + +## Methods + + + + + + Generate the project files. + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 1813. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/dokku-project-generator/init.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/dokku-project-generator/init.mdx new file mode 100644 index 0000000000..e335b121ad --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/dokku-project-generator/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/dokku-project-generator/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.dokku.DokkuProjectGenerator.__init__" + parent: "signalwire.cli.dokku.DokkuProjectGenerator" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `__init__` + +## Signature + +```python +__init__(app_name: str, options: Dict[str, Any]) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 1816. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/generate-password.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/generate-password.mdx new file mode 100644 index 0000000000..8cb524b535 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/generate-password.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/generate-password" +title: "generate_password" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.generate_password" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `generate_password` + +## Signature + +```python +generate_password(length: int = 32) -> str +``` + +## Parameters + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 81. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/index.mdx new file mode 100644 index 0000000000..5ca31fdf0d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/index.mdx @@ -0,0 +1,130 @@ +--- +slug: "/reference/python/signalwire/cli/dokku" +title: "dokku" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.dokku" + parent: "signalwire.cli" + module: "signalwire.cli" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `dokku` + +SignalWire Agent Dokku Deployment Tool + +CLI tool for deploying SignalWire agents to Dokku with support for: + +- Simple git push deployment +- Full CI/CD with GitHub Actions +- Service provisioning (PostgreSQL, Redis) +- Preview environments for PRs + +> \[!NOTE] +> sw-agent-dokku init myagent # Simple mode +> sw-agent-dokku init myagent --cicd # With GitHub Actions CI/CD +> sw-agent-dokku deploy # Deploy current directory +> sw-agent-dokku logs # Tail logs +> sw-agent-dokku config set KEY=value # Set environment variables +> sw-agent-dokku scale web=2 # Scale processes + +## Signature + +```python +module dokku +``` + +## Constants + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Functions + + + + Manage Dokku config. + + + + Deploy to Dokku. + + + + Initialize a new Dokku project. + + + + Tail Dokku logs. + + + + Scale Dokku processes. + + + + + + + + + + + + + + + + + + + + + +## Classes + + + + + + Generates Dokku deployment files for SignalWire agents. + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/main.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/main.mdx new file mode 100644 index 0000000000..de9af24c7c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/main.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/main" +title: "main" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.main" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `main` + +## Signature + +```python +main() +``` + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 2223. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/print-error.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/print-error.mdx new file mode 100644 index 0000000000..91079a3ea9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/print-error.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/print-error" +title: "print_error" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.print_error" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `print_error` + +## Signature + +```python +print_error(msg: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 58. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/print-header.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/print-header.mdx new file mode 100644 index 0000000000..830a742745 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/print-header.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/print-header" +title: "print_header" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.print_header" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `print_header` + +## Signature + +```python +print_header(msg: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 62. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/print-step.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/print-step.mdx new file mode 100644 index 0000000000..d6d3afcd81 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/print-step.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/print-step" +title: "print_step" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.print_step" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `print_step` + +## Signature + +```python +print_step(msg: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 46. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/print-success.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/print-success.mdx new file mode 100644 index 0000000000..cf83e343a1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/print-success.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/print-success" +title: "print_success" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.print_success" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `print_success` + +## Signature + +```python +print_success(msg: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 50. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/print-warning.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/print-warning.mdx new file mode 100644 index 0000000000..9f802606fd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/print-warning.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/print-warning" +title: "print_warning" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.print_warning" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `print_warning` + +## Signature + +```python +print_warning(msg: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 54. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/prompt-yes-no.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/prompt-yes-no.mdx new file mode 100644 index 0000000000..e8b64cc5ad --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/prompt-yes-no.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/prompt-yes-no" +title: "prompt_yes_no" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.prompt_yes_no" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `prompt_yes_no` + +## Signature + +```python +prompt_yes_no(question: str, default: bool = True) -> bool +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 73. diff --git a/fern/products/sdk-reference/python/signalwire/cli/dokku/prompt.mdx b/fern/products/sdk-reference/python/signalwire/cli/dokku/prompt.mdx new file mode 100644 index 0000000000..7f6845e7ec --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/dokku/prompt.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/dokku/prompt" +title: "prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.dokku.prompt" + parent: "signalwire.cli.dokku" + module: "signalwire.cli.dokku" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py" +--- +# `prompt` + +## Signature + +```python +prompt(question: str, default: str = '') -> str +``` + +## Parameters + + + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/dokku.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/dokku.py) + +Line 66. diff --git a/fern/products/sdk-reference/python/signalwire/cli/execution/datamap-exec/execute-datamap-function.mdx b/fern/products/sdk-reference/python/signalwire/cli/execution/datamap-exec/execute-datamap-function.mdx new file mode 100644 index 0000000000..7322749ccb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/execution/datamap-exec/execute-datamap-function.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/cli/execution/datamap-exec/execute-datamap-function" +title: "execute_datamap_function" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.execution.datamap_exec.execute_datamap_function" + parent: "signalwire.cli.execution.datamap_exec" + module: "signalwire.cli.execution.datamap_exec" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/datamap_exec.py" +--- +# `execute_datamap_function` + +Execute a DataMap function following the actual DataMap processing pipeline: + +1. Expressions (pattern matching) +2. Webhooks (try each sequentially until one succeeds) +3. Foreach (within successful webhook) +4. Output (from successful webhook) +5. Fallback output (if all webhooks fail) + +## Signature + +```python +execute_datamap_function( + datamap_config: Dict[str, Any], + args: Dict[str, Any], + verbose: bool = False +) -> Dict[str, Any] +``` + +## Parameters + + + DataMap configuration dictionary + + + + Function arguments + + + + Enable verbose output + + +## Returns + +`Dict[str, Any]` — Function result (should be string or dict with 'response' key) + +## Source + +[`signalwire/signalwire/cli/execution/datamap_exec.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/datamap_exec.py) + +Line 124. diff --git a/fern/products/sdk-reference/python/signalwire/cli/execution/datamap-exec/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/execution/datamap-exec/index.mdx new file mode 100644 index 0000000000..291de8832b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/execution/datamap-exec/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/cli/execution/datamap-exec" +title: "datamap_exec" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.execution.datamap_exec" + parent: "signalwire.cli.execution" + module: "signalwire.cli.execution" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/datamap_exec.py" +--- +# `datamap_exec` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module datamap_exec +``` + +## Functions + + + + Execute a DataMap function following the actual DataMap processing pipeline: 1. Expressions (pattern matching) 2. Webhooks (try each sequentially until one succeeds) 3. Foreach (within successful webhook) 4. Output (from successful webhook) 5. Fallback output (if all webhooks fail) + + + + Simple template expansion for DataMap testing Supports both $\{key\} and %\{key\} syntax with nested object access and array indexing + + + +## Source + +[`signalwire/signalwire/cli/execution/datamap_exec.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/datamap_exec.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/execution/datamap-exec/simple-template-expand.mdx b/fern/products/sdk-reference/python/signalwire/cli/execution/datamap-exec/simple-template-expand.mdx new file mode 100644 index 0000000000..d319bf052c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/execution/datamap-exec/simple-template-expand.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/cli/execution/datamap-exec/simple-template-expand" +title: "simple_template_expand" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.execution.datamap_exec.simple_template_expand" + parent: "signalwire.cli.execution.datamap_exec" + module: "signalwire.cli.execution.datamap_exec" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/datamap_exec.py" +--- +# `simple_template_expand` + +Simple template expansion for DataMap testing +Supports both $\{key\} and %\{key\} syntax with nested object access and array indexing + +## Signature + +```python +simple_template_expand(template: str, data: Dict[str, Any]) -> str +``` + +## Parameters + + + Template string with $\{\} or %\{\} variables + + + + Data dictionary for expansion + + +## Returns + +`str` — Expanded string + +## Source + +[`signalwire/signalwire/cli/execution/datamap_exec.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/datamap_exec.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/cli/execution/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/execution/index.mdx new file mode 100644 index 0000000000..f75433fe02 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/execution/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/cli/execution" +title: "execution" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.execution" + parent: "signalwire.cli" + module: "signalwire.cli" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/__init__.py" +--- +# `execution` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module execution +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/cli/execution/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/execution/webhook-exec/execute-external-webhook-function.mdx b/fern/products/sdk-reference/python/signalwire/cli/execution/webhook-exec/execute-external-webhook-function.mdx new file mode 100644 index 0000000000..43757bba47 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/execution/webhook-exec/execute-external-webhook-function.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/python/signalwire/cli/execution/webhook-exec/execute-external-webhook-function" +title: "execute_external_webhook_function" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.execution.webhook_exec.execute_external_webhook_function" + parent: "signalwire.cli.execution.webhook_exec" + module: "signalwire.cli.execution.webhook_exec" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/webhook_exec.py" +--- +# `execute_external_webhook_function` + +Execute an external webhook SWAIG function by making an HTTP request to the external service. +This simulates what SignalWire would do when calling an external webhook function. + +## Signature + +```python +execute_external_webhook_function( + func: SWAIGFunction, + function_name: str, + function_args: Dict[str, Any], + post_data: Dict[str, Any], + verbose: bool = False +) -> Dict[str, Any] +``` + +## Parameters + + + The SWAIGFunction object with webhook\_url + + + + Name of the function being called + + + + Parsed function arguments + + + + Complete post data to send to the webhook + + + + Whether to show verbose output + + +## Returns + +`Dict[str, Any]` — Response from the external webhook service + +## Source + +[`signalwire/signalwire/cli/execution/webhook_exec.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/webhook_exec.py) + +Line 24. diff --git a/fern/products/sdk-reference/python/signalwire/cli/execution/webhook-exec/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/execution/webhook-exec/index.mdx new file mode 100644 index 0000000000..c75e2128f3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/execution/webhook-exec/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/cli/execution/webhook-exec" +title: "webhook_exec" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.execution.webhook_exec" + parent: "signalwire.cli.execution" + module: "signalwire.cli.execution" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/webhook_exec.py" +--- +# `webhook_exec` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module webhook_exec +``` + +## Functions + + + + Execute an external webhook SWAIG function by making an HTTP request to the external service. This simulates what SignalWire would do when calling an external webhook function. + + + +## Source + +[`signalwire/signalwire/cli/execution/webhook_exec.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/execution/webhook_exec.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/index.mdx new file mode 100644 index 0000000000..27f85d0aad --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/index.mdx @@ -0,0 +1,84 @@ +--- +slug: "/reference/python/signalwire/cli" +title: "cli" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/__init__.py" +--- +# `cli` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module cli +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + SignalWire Agent Dokku Deployment Tool + + + + Copyright (c) 2025 SignalWire + + + + SignalWire Agent Project Generator + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/cli/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/colors/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/colors/index.mdx new file mode 100644 index 0000000000..bd6672b56c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/colors/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/colors" +title: "Colors" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.init_project.Colors" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `Colors` + +## Signature + +```python +class Colors +``` + +## Properties + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 38. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/generate-password.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/generate-password.mdx new file mode 100644 index 0000000000..64ddc81fad --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/generate-password.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/generate-password" +title: "generate_password" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.generate_password" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `generate_password` + +Generate a secure random password. + +## Signature + +```python +generate_password(length: int = 32) -> str +``` + +## Parameters + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 139. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/get-agent-template.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-agent-template.mdx new file mode 100644 index 0000000000..9eec1d4cc2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-agent-template.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/get-agent-template" +title: "get_agent_template" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.get_agent_template" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `get_agent_template` + +Generate the main agent template based on type and features. + +## Signature + +```python +get_agent_template(agent_type: str, features: Dict[str, bool]) -> str +``` + +## Parameters + + + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 1177. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/get-app-template.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-app-template.mdx new file mode 100644 index 0000000000..688dee4d81 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-app-template.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/get-app-template" +title: "get_app_template" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.get_app_template" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `get_app_template` + +Generate the app.py template based on features. + +## Signature + +```python +get_app_template(features: Dict[str, bool]) -> str +``` + +## Parameters + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 1329. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/get-env-credentials.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-env-credentials.mdx new file mode 100644 index 0000000000..7935f81ec5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-env-credentials.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/get-env-credentials" +title: "get_env_credentials" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.get_env_credentials" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `get_env_credentials` + +Get SignalWire credentials from environment variables. + +## Signature + +```python +get_env_credentials() -> Dict[str, str] +``` + +## Returns + +`Dict[str, str]` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 130. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/get-readme-template.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-readme-template.mdx new file mode 100644 index 0000000000..15f2126571 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-readme-template.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/get-readme-template" +title: "get_readme_template" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.get_readme_template" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `get_readme_template` + +Generate README template. + +## Signature + +```python +get_readme_template(project_name: str, features: Dict[str, bool]) -> str +``` + +## Parameters + + + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 1652. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/get-test-template.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-test-template.mdx new file mode 100644 index 0000000000..d597d6562c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-test-template.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/get-test-template" +title: "get_test_template" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.get_test_template" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `get_test_template` + +Generate test template. + +## Signature + +```python +get_test_template(has_tool: bool) -> str +``` + +## Parameters + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 1525. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/get-web-index-template.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-web-index-template.mdx new file mode 100644 index 0000000000..05b675033c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/get-web-index-template.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/get-web-index-template" +title: "get_web_index_template" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.get_web_index_template" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `get_web_index_template` + +Generate a simple web UI template. + +## Signature + +```python +get_web_index_template() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 1744. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/index.mdx new file mode 100644 index 0000000000..d68d254dc1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/index.mdx @@ -0,0 +1,158 @@ +--- +slug: "/reference/python/signalwire/cli/init-project" +title: "init_project" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.init_project" + parent: "signalwire.cli" + module: "signalwire.cli" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `init_project` + +SignalWire Agent Project Generator + +Interactive CLI tool to create new SignalWire agent projects with customizable features. + +> \[!NOTE] +> sw-agent-init # Interactive mode +> sw-agent-init myagent # Quick mode with project name +> sw-agent-init myagent --type full --no-venv + +## Signature + +```python +module init_project +``` + +## Constants + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Functions + + + + Generate a secure random password. + + + + Generate the main agent template based on type and features. + + + + Generate the app.py template based on features. + + + + Get SignalWire credentials from environment variables. + + + + Generate README template. + + + + Generate test template. + + + + Generate a simple web UI template. + + + + Main entry point. + + + + Mask a token showing only first 4 and last 3 characters. + + + + + + + + + + + + Prompt user for input with optional default. + + + + Prompt user to toggle multiple options. Returns list of booleans. + + + + Prompt user to select from numbered options. Returns 1-based index. + + + + Prompt user for yes/no answer. + + + + Run interactive prompts and return configuration. + + + + Run in quick mode with minimal prompts. + + + +## Classes + + + + + + Generates a new SignalWire agent project. + + + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/main.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/main.mdx new file mode 100644 index 0000000000..643fee9132 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/main.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/main" +title: "main" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.main" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `main` + +Main entry point. + +## Signature + +```python +main() +``` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 2578. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/mask-token.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/mask-token.mdx new file mode 100644 index 0000000000..d620d03cab --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/mask-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/mask-token" +title: "mask_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.mask_token" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `mask_token` + +Mask a token showing only first 4 and last 3 characters. + +## Signature + +```python +mask_token(token: str) -> str +``` + +## Parameters + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 123. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/print-error.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/print-error.mdx new file mode 100644 index 0000000000..2c901bc2a5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/print-error.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/print-error" +title: "print_error" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.print_error" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `print_error` + +## Signature + +```python +print_error(msg: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 61. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/print-step.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/print-step.mdx new file mode 100644 index 0000000000..548d1c7e85 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/print-step.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/print-step" +title: "print_step" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.print_step" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `print_step` + +## Signature + +```python +print_step(msg: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 49. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/print-success.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/print-success.mdx new file mode 100644 index 0000000000..987bef31a5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/print-success.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/print-success" +title: "print_success" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.print_success" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `print_success` + +## Signature + +```python +print_success(msg: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 53. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/print-warning.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/print-warning.mdx new file mode 100644 index 0000000000..9c551bac52 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/print-warning.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/print-warning" +title: "print_warning" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.print_warning" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `print_warning` + +## Signature + +```python +print_warning(msg: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 57. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/project-generator/generate.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/project-generator/generate.mdx new file mode 100644 index 0000000000..29512d91e1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/project-generator/generate.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/project-generator/generate" +title: "generate" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.init_project.ProjectGenerator.generate" + parent: "signalwire.cli.init_project.ProjectGenerator" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `generate` + +Generate the project. Returns True on success. + +## Signature + +```python +generate() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 1859. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/project-generator/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/project-generator/index.mdx new file mode 100644 index 0000000000..fedd375b1d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/project-generator/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/project-generator" +title: "ProjectGenerator" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.init_project.ProjectGenerator" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `ProjectGenerator` + +Generates a new SignalWire agent project. + +## Signature + +```python +class ProjectGenerator +``` + +## Properties + + + + + + + + + + + + + + + +## Methods + + + + + + Generate the project. Returns True on success. + + + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 1847. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/project-generator/init.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/project-generator/init.mdx new file mode 100644 index 0000000000..cfbdd41d09 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/project-generator/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/project-generator/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.init_project.ProjectGenerator.__init__" + parent: "signalwire.cli.init_project.ProjectGenerator" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `__init__` + +## Signature + +```python +__init__(config: Dict[str, Any]) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 1850. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt-multiselect.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt-multiselect.mdx new file mode 100644 index 0000000000..69f336a84a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt-multiselect.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/prompt-multiselect" +title: "prompt_multiselect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.prompt_multiselect" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `prompt_multiselect` + +Prompt user to toggle multiple options. Returns list of booleans. + +## Signature + +```python +prompt_multiselect( + question: str, + options: List[str], + defaults: List[bool] +) -> List[bool] +``` + +## Parameters + + + + + + + +## Returns + +`List[bool]` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 101. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt-select.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt-select.mdx new file mode 100644 index 0000000000..37e48ff753 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt-select.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/prompt-select" +title: "prompt_select" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.prompt_select" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `prompt_select` + +Prompt user to select from numbered options. Returns 1-based index. + +## Signature + +```python +prompt_select(question: str, options: List[str], default: int = 1) -> int +``` + +## Parameters + + + + + + + +## Returns + +`int` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 83. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt-yes-no.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt-yes-no.mdx new file mode 100644 index 0000000000..f9d8d7eb43 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt-yes-no.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/prompt-yes-no" +title: "prompt_yes_no" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.prompt_yes_no" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `prompt_yes_no` + +Prompt user for yes/no answer. + +## Signature + +```python +prompt_yes_no(question: str, default: bool = True) -> bool +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 74. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt.mdx new file mode 100644 index 0000000000..4bc94eb0e2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/prompt" +title: "prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.prompt" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `prompt` + +Prompt user for input with optional default. + +## Signature + +```python +prompt(question: str, default: str = '') -> str +``` + +## Parameters + + + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 65. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/run-interactive.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/run-interactive.mdx new file mode 100644 index 0000000000..da209a3f4a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/run-interactive.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/run-interactive" +title: "run_interactive" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.run_interactive" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `run_interactive` + +Run interactive prompts and return configuration. + +## Signature + +```python +run_interactive() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 2388. diff --git a/fern/products/sdk-reference/python/signalwire/cli/init-project/run-quick.mdx b/fern/products/sdk-reference/python/signalwire/cli/init-project/run-quick.mdx new file mode 100644 index 0000000000..9245563747 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/init-project/run-quick.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/cli/init-project/run-quick" +title: "run_quick" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.init_project.run_quick" + parent: "signalwire.cli.init_project" + module: "signalwire.cli.init_project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py" +--- +# `run_quick` + +Run in quick mode with minimal prompts. + +## Signature + +```python +run_quick(project_name: str, args: Any) -> Dict[str, Any] +``` + +## Parameters + + + + + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/cli/init_project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/init_project.py) + +Line 2511. diff --git a/fern/products/sdk-reference/python/signalwire/cli/output/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/output/index.mdx new file mode 100644 index 0000000000..e0cbd3b88b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/output/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/cli/output" +title: "output" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.output" + parent: "signalwire.cli" + module: "signalwire.cli" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/__init__.py" +--- +# `output` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module output +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/cli/output/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/output/output-formatter/display-agent-tools.mdx b/fern/products/sdk-reference/python/signalwire/cli/output/output-formatter/display-agent-tools.mdx new file mode 100644 index 0000000000..c6da1afb27 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/output/output-formatter/display-agent-tools.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/cli/output/output-formatter/display-agent-tools" +title: "display_agent_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.output.output_formatter.display_agent_tools" + parent: "signalwire.cli.output.output_formatter" + module: "signalwire.cli.output.output_formatter" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/output_formatter.py" +--- +# `display_agent_tools` + +Display the available SWAIG functions for an agent + +## Signature + +```python +display_agent_tools(agent: AgentBase, verbose: bool = False) -> None +``` + +## Parameters + + + The agent instance + + + + Whether to show verbose details + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/cli/output/output_formatter.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/output_formatter.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/cli/output/output-formatter/format-result.mdx b/fern/products/sdk-reference/python/signalwire/cli/output/output-formatter/format-result.mdx new file mode 100644 index 0000000000..33739eb494 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/output/output-formatter/format-result.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/cli/output/output-formatter/format-result" +title: "format_result" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.output.output_formatter.format_result" + parent: "signalwire.cli.output.output_formatter" + module: "signalwire.cli.output.output_formatter" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/output_formatter.py" +--- +# `format_result` + +Format the result of a SWAIG function call for display + +## Signature + +```python +format_result(result: Any) -> str +``` + +## Parameters + + + The result from the SWAIG function + + +## Returns + +`str` — Formatted string representation + +## Source + +[`signalwire/signalwire/cli/output/output_formatter.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/output_formatter.py) + +Line 220. diff --git a/fern/products/sdk-reference/python/signalwire/cli/output/output-formatter/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/output/output-formatter/index.mdx new file mode 100644 index 0000000000..b539fbb7d0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/output/output-formatter/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/cli/output/output-formatter" +title: "output_formatter" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.output.output_formatter" + parent: "signalwire.cli.output" + module: "signalwire.cli.output" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/output_formatter.py" +--- +# `output_formatter` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module output_formatter +``` + +## Functions + + + + Display the available SWAIG functions for an agent + + + + Format the result of a SWAIG function call for display + + + +## Source + +[`signalwire/signalwire/cli/output/output_formatter.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/output_formatter.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/output/swml-dump/handle-dump-swml.mdx b/fern/products/sdk-reference/python/signalwire/cli/output/swml-dump/handle-dump-swml.mdx new file mode 100644 index 0000000000..26eab5bf18 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/output/swml-dump/handle-dump-swml.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/cli/output/swml-dump/handle-dump-swml" +title: "handle_dump_swml" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.output.swml_dump.handle_dump_swml" + parent: "signalwire.cli.output.swml_dump" + module: "signalwire.cli.output.swml_dump" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/swml_dump.py" +--- +# `handle_dump_swml` + +Handle SWML dumping with fake post\_data and mock request support + +## Signature + +```python +handle_dump_swml(agent: AgentBase, args: argparse.Namespace) -> int +``` + +## Parameters + + + The loaded agent instance + + + + Parsed CLI arguments + + +## Returns + +`int` — Exit code (0 for success, 1 for error) + +## Source + +[`signalwire/signalwire/cli/output/swml_dump.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/swml_dump.py) + +Line 53. diff --git a/fern/products/sdk-reference/python/signalwire/cli/output/swml-dump/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/output/swml-dump/index.mdx new file mode 100644 index 0000000000..9655597713 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/output/swml-dump/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/cli/output/swml-dump" +title: "swml_dump" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.output.swml_dump" + parent: "signalwire.cli.output" + module: "signalwire.cli.output" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/swml_dump.py" +--- +# `swml_dump` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module swml_dump +``` + +## Properties + + + +## Functions + + + + Handle SWML dumping with fake post\_data and mock request support + + + + Set up output suppression for SWML dumping + + + +## Source + +[`signalwire/signalwire/cli/output/swml_dump.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/swml_dump.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/output/swml-dump/setup-output-suppression.mdx b/fern/products/sdk-reference/python/signalwire/cli/output/swml-dump/setup-output-suppression.mdx new file mode 100644 index 0000000000..45da60db68 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/output/swml-dump/setup-output-suppression.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/output/swml-dump/setup-output-suppression" +title: "setup_output_suppression" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.output.swml_dump.setup_output_suppression" + parent: "signalwire.cli.output.swml_dump" + module: "signalwire.cli.output.swml_dump" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/swml_dump.py" +--- +# `setup_output_suppression` + +Set up output suppression for SWML dumping + +## Signature + +```python +setup_output_suppression() +``` + +## Source + +[`signalwire/signalwire/cli/output/swml_dump.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/output/swml_dump.py) + +Line 33. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/adapt-for-call-type.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/adapt-for-call-type.mdx new file mode 100644 index 0000000000..949785ae7e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/adapt-for-call-type.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-generation/adapt-for-call-type" +title: "adapt_for_call_type" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_generation.adapt_for_call_type" + parent: "signalwire.cli.simulation.data_generation" + module: "signalwire.cli.simulation.data_generation" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py" +--- +# `adapt_for_call_type` + +Adapt call data structure based on call type (sip vs webrtc) + +## Signature + +```python +adapt_for_call_type(call_data: Dict[str, Any], call_type: str) -> Dict[str, Any] +``` + +## Parameters + + + Base call data structure + + + + "sip" or "webrtc" + + +## Returns + +`Dict[str, Any]` — Adapted call data with appropriate addresses and metadata + +## Source + +[`signalwire/signalwire/cli/simulation/data_generation.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py) + +Line 48. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-comprehensive-post-data.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-comprehensive-post-data.mdx new file mode 100644 index 0000000000..95634739c6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-comprehensive-post-data.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-generation/generate-comprehensive-post-data" +title: "generate_comprehensive_post_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_generation.generate_comprehensive_post_data" + parent: "signalwire.cli.simulation.data_generation" + module: "signalwire.cli.simulation.data_generation" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py" +--- +# `generate_comprehensive_post_data` + +Generate comprehensive post\_data that matches what SignalWire would send + +## Signature + +```python +generate_comprehensive_post_data( + function_name: str, + args: Dict[str, Any], + custom_data: Optional[Dict[str, Any]] = None +) -> Dict[str, Any] +``` + +## Parameters + + + Name of the SWAIG function being called + + + + Function arguments + + + + Optional custom data to override defaults + + +## Returns + +`Dict[str, Any]` — Complete post\_data dict with all possible keys + +## Source + +[`signalwire/signalwire/cli/simulation/data_generation.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py) + +Line 143. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-node-id.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-node-id.mdx new file mode 100644 index 0000000000..7237d001e6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-node-id.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-generation/generate-fake-node-id" +title: "generate_fake_node_id" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_generation.generate_fake_node_id" + parent: "signalwire.cli.simulation.data_generation" + module: "signalwire.cli.simulation.data_generation" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py" +--- +# `generate_fake_node_id` + +Generate a fake node ID for testing + +## Signature + +```python +generate_fake_node_id() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/simulation/data_generation.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py) + +Line 27. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-sip-from.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-sip-from.mdx new file mode 100644 index 0000000000..78d9253dba --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-sip-from.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-generation/generate-fake-sip-from" +title: "generate_fake_sip_from" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_generation.generate_fake_sip_from" + parent: "signalwire.cli.simulation.data_generation" + module: "signalwire.cli.simulation.data_generation" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py" +--- +# `generate_fake_sip_from` + +Generate a fake 'from' address based on call type + +## Signature + +```python +generate_fake_sip_from(call_type: str) -> str +``` + +## Parameters + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/simulation/data_generation.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py) + +Line 32. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-sip-to.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-sip-to.mdx new file mode 100644 index 0000000000..d30e7ebbc3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-sip-to.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-generation/generate-fake-sip-to" +title: "generate_fake_sip_to" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_generation.generate_fake_sip_to" + parent: "signalwire.cli.simulation.data_generation" + module: "signalwire.cli.simulation.data_generation" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py" +--- +# `generate_fake_sip_to` + +Generate a fake 'to' address based on call type + +## Signature + +```python +generate_fake_sip_to(call_type: str) -> str +``` + +## Parameters + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/simulation/data_generation.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py) + +Line 40. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-swml-post-data.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-swml-post-data.mdx new file mode 100644 index 0000000000..1e9b7cceec --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-swml-post-data.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-generation/generate-fake-swml-post-data" +title: "generate_fake_swml_post_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_generation.generate_fake_swml_post_data" + parent: "signalwire.cli.simulation.data_generation" + module: "signalwire.cli.simulation.data_generation" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py" +--- +# `generate_fake_swml_post_data` + +Generate fake SWML post\_data that matches real SignalWire structure + +## Signature + +```python +generate_fake_swml_post_data( + call_type: str = 'webrtc', + call_direction: str = 'inbound', + call_state: str = 'created' +) -> Dict[str, Any] +``` + +## Parameters + + + "sip" or "webrtc" (default: webrtc) + + + + "inbound" or "outbound" (default: inbound) + + + + Call state (default: created) + + +## Returns + +`Dict[str, Any]` — Fake post\_data dict with call, vars, and envs structure + +## Source + +[`signalwire/signalwire/cli/simulation/data_generation.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py) + +Line 85. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-uuid.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-uuid.mdx new file mode 100644 index 0000000000..654f7db9cd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-fake-uuid.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-generation/generate-fake-uuid" +title: "generate_fake_uuid" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_generation.generate_fake_uuid" + parent: "signalwire.cli.simulation.data_generation" + module: "signalwire.cli.simulation.data_generation" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py" +--- +# `generate_fake_uuid` + +Generate a fake UUID for testing + +## Signature + +```python +generate_fake_uuid() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/simulation/data_generation.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-minimal-post-data.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-minimal-post-data.mdx new file mode 100644 index 0000000000..e56bc82b8c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/generate-minimal-post-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-generation/generate-minimal-post-data" +title: "generate_minimal_post_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_generation.generate_minimal_post_data" + parent: "signalwire.cli.simulation.data_generation" + module: "signalwire.cli.simulation.data_generation" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py" +--- +# `generate_minimal_post_data` + +Generate minimal post\_data with only essential keys + +## Signature + +```python +generate_minimal_post_data( + function_name: str, + args: Dict[str, Any] +) -> Dict[str, Any] +``` + +## Parameters + + + Name of the SWAIG function being called + + + + Function arguments + + +## Returns + +`Dict[str, Any]` — Minimal post\_data dict + +## Source + +[`signalwire/signalwire/cli/simulation/data_generation.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py) + +Line 358. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/index.mdx new file mode 100644 index 0000000000..c14418a06b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-generation/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-generation" +title: "data_generation" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.simulation.data_generation" + parent: "signalwire.cli.simulation" + module: "signalwire.cli.simulation" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py" +--- +# `data_generation` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module data_generation +``` + +## Functions + + + + Adapt call data structure based on call type (sip vs webrtc) + + + + Generate comprehensive post\_data that matches what SignalWire would send + + + + Generate a fake node ID for testing + + + + Generate a fake 'from' address based on call type + + + + Generate a fake 'to' address based on call type + + + + Generate fake SWML post\_data that matches real SignalWire structure + + + + Generate a fake UUID for testing + + + + Generate minimal post\_data with only essential keys + + + +## Source + +[`signalwire/signalwire/cli/simulation/data_generation.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_generation.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/apply-convenience-mappings.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/apply-convenience-mappings.mdx new file mode 100644 index 0000000000..1a00177ed0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/apply-convenience-mappings.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-overrides/apply-convenience-mappings" +title: "apply_convenience_mappings" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_overrides.apply_convenience_mappings" + parent: "signalwire.cli.simulation.data_overrides" + module: "signalwire.cli.simulation.data_overrides" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_overrides.py" +--- +# `apply_convenience_mappings` + +Apply convenience CLI arguments to data structure + +## Signature + +```python +apply_convenience_mappings( + data: Dict[str, Any], + args: argparse.Namespace +) -> Dict[str, Any] +``` + +## Parameters + + + Data dictionary to modify + + + + Parsed CLI arguments + + +## Returns + +`Dict[str, Any]` — Modified data dictionary + +## Source + +[`signalwire/signalwire/cli/simulation/data_overrides.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_overrides.py) + +Line 117. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/apply-overrides.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/apply-overrides.mdx new file mode 100644 index 0000000000..f71cd3f51d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/apply-overrides.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-overrides/apply-overrides" +title: "apply_overrides" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_overrides.apply_overrides" + parent: "signalwire.cli.simulation.data_overrides" + module: "signalwire.cli.simulation.data_overrides" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_overrides.py" +--- +# `apply_overrides` + +Apply override values to data using dot notation paths + +## Signature + +```python +apply_overrides( + data: Dict[str, Any], + overrides: List[str], + json_overrides: List[str] +) -> Dict[str, Any] +``` + +## Parameters + + + Data dictionary to modify + + + + List of "path=value" strings + + + + List of "path=json\_value" strings + + +## Returns + +`Dict[str, Any]` — Modified data dictionary + +## Source + +[`signalwire/signalwire/cli/simulation/data_overrides.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_overrides.py) + +Line 80. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/index.mdx new file mode 100644 index 0000000000..88c7c94565 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-overrides" +title: "data_overrides" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.simulation.data_overrides" + parent: "signalwire.cli.simulation" + module: "signalwire.cli.simulation" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_overrides.py" +--- +# `data_overrides` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module data_overrides +``` + +## Functions + + + + Apply convenience CLI arguments to data structure + + + + Apply override values to data using dot notation paths + + + + Parse a string value into appropriate Python type + + + + Set a nested value using dot notation path + + + +## Source + +[`signalwire/signalwire/cli/simulation/data_overrides.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_overrides.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/parse-value.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/parse-value.mdx new file mode 100644 index 0000000000..1777ffc659 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/parse-value.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-overrides/parse-value" +title: "parse_value" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_overrides.parse_value" + parent: "signalwire.cli.simulation.data_overrides" + module: "signalwire.cli.simulation.data_overrides" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_overrides.py" +--- +# `parse_value` + +Parse a string value into appropriate Python type + +## Signature + +```python +parse_value(value_str: str) -> Any +``` + +## Parameters + + + String representation of value + + +## Returns + +`Any` — Parsed value (str, int, float, bool, None, or JSON object) + +## Source + +[`signalwire/signalwire/cli/simulation/data_overrides.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_overrides.py) + +Line 43. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/set-nested-value.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/set-nested-value.mdx new file mode 100644 index 0000000000..88af592059 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/data-overrides/set-nested-value.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/data-overrides/set-nested-value" +title: "set_nested_value" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.data_overrides.set_nested_value" + parent: "signalwire.cli.simulation.data_overrides" + module: "signalwire.cli.simulation.data_overrides" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_overrides.py" +--- +# `set_nested_value` + +Set a nested value using dot notation path + +## Signature + +```python +set_nested_value(data: Dict[str, Any], path: str, value: Any) -> None +``` + +## Parameters + + + Dictionary to modify + + + + Dot-notation path (e.g., "call.call\_id" or "vars.userVariables.custom") + + + + Value to set + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/cli/simulation/data_overrides.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/data_overrides.py) + +Line 21. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/index.mdx new file mode 100644 index 0000000000..d3818a0f40 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/cli/simulation" +title: "simulation" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.simulation" + parent: "signalwire.cli" + module: "signalwire.cli" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/__init__.py" +--- +# `simulation` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module simulation +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/cli/simulation/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/create-mock-request.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/create-mock-request.mdx new file mode 100644 index 0000000000..a206f4a8e9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/create-mock-request.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/create-mock-request" +title: "create_mock_request" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.create_mock_request" + parent: "signalwire.cli.simulation.mock_env" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `create_mock_request` + +Factory function to create a mock FastAPI Request object + +## Signature + +```python +create_mock_request( + method: str = 'POST', + url: str = 'http://localhost:8080/swml', + headers: Optional[Dict[str, str]] = None, + query_params: Optional[Dict[str, str]] = None, + body: Optional[Dict[str, Any]] = None +) -> MockRequest +``` + +## Parameters + + + + + + + + + + + +## Returns + +`MockRequest` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 128. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/index.mdx new file mode 100644 index 0000000000..5b68949da3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env" +title: "mock_env" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env" + parent: "signalwire.cli.simulation" + module: "signalwire.cli.simulation" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `mock_env` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module mock_env +``` + +## Functions + + + + Factory function to create a mock FastAPI Request object + + + + Load environment variables from a file + + + +## Classes + + + + Mock FastAPI Headers (case-insensitive dict-like) + + + + Mock FastAPI QueryParams (simple dict-like) + + + + Mock FastAPI Request object for dynamic agent testing + + + + Mock FastAPI URL object + + + + Manages serverless environment simulation for different platforms + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/load-env-file.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/load-env-file.mdx new file mode 100644 index 0000000000..6bbf55a618 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/load-env-file.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/load-env-file" +title: "load_env_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.load_env_file" + parent: "signalwire.cli.simulation.mock_env" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `load_env_file` + +Load environment variables from a file + +## Signature + +```python +load_env_file(env_file_path: str) -> Dict[str, str] +``` + +## Parameters + + + +## Returns + +`Dict[str, str]` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 269. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/contains.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/contains.mdx new file mode 100644 index 0000000000..a948a799e6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/contains.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-headers/contains" +title: "__contains__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockHeaders.__contains__" + parent: "signalwire.cli.simulation.mock_env.MockHeaders" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `__contains__` + +## Signature + +```python +__contains__(key: str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 60. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/get.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/get.mdx new file mode 100644 index 0000000000..6198a14985 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-headers/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockHeaders.get" + parent: "signalwire.cli.simulation.mock_env.MockHeaders" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `get` + +## Signature + +```python +get(key: str, default: Optional[str] = None) -> Optional[str] +``` + +## Parameters + + + + + +## Returns + +`Optional[str]` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 54. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/getitem.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/getitem.mdx new file mode 100644 index 0000000000..1d32826a1b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/getitem.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-headers/getitem" +title: "__getitem__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockHeaders.__getitem__" + parent: "signalwire.cli.simulation.mock_env.MockHeaders" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `__getitem__` + +## Signature + +```python +__getitem__(key: str) -> str +``` + +## Parameters + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 57. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/index.mdx new file mode 100644 index 0000000000..a1e314d951 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-headers" +title: "MockHeaders" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockHeaders" + parent: "signalwire.cli.simulation.mock_env" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `MockHeaders` + +Mock FastAPI Headers (case-insensitive dict-like) + +## Signature + +```python +class MockHeaders +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 45. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/init.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/init.mdx new file mode 100644 index 0000000000..6f474dff4a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-headers/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockHeaders.__init__" + parent: "signalwire.cli.simulation.mock_env.MockHeaders" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `__init__` + +## Signature + +```python +__init__(headers: Optional[Dict[str, str]] = None) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 47. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/items.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/items.mdx new file mode 100644 index 0000000000..584528fb76 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/items.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-headers/items" +title: "items" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockHeaders.items" + parent: "signalwire.cli.simulation.mock_env.MockHeaders" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `items` + +## Signature + +```python +items() +``` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 63. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/keys.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/keys.mdx new file mode 100644 index 0000000000..6e746e2937 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/keys.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-headers/keys" +title: "keys" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockHeaders.keys" + parent: "signalwire.cli.simulation.mock_env.MockHeaders" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `keys` + +## Signature + +```python +keys() +``` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 66. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/values.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/values.mdx new file mode 100644 index 0000000000..dfdce075fa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-headers/values.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-headers/values" +title: "values" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockHeaders.values" + parent: "signalwire.cli.simulation.mock_env.MockHeaders" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `values` + +## Signature + +```python +values() +``` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 69. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/contains.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/contains.mdx new file mode 100644 index 0000000000..2460b3e425 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/contains.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-query-params/contains" +title: "__contains__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockQueryParams.__contains__" + parent: "signalwire.cli.simulation.mock_env.MockQueryParams" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `__contains__` + +## Signature + +```python +__contains__(key: str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 32. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/get.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/get.mdx new file mode 100644 index 0000000000..680353aafa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-query-params/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockQueryParams.get" + parent: "signalwire.cli.simulation.mock_env.MockQueryParams" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `get` + +## Signature + +```python +get(key: str, default: Optional[str] = None) -> Optional[str] +``` + +## Parameters + + + + + +## Returns + +`Optional[str]` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/getitem.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/getitem.mdx new file mode 100644 index 0000000000..a8ebab078b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/getitem.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-query-params/getitem" +title: "__getitem__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockQueryParams.__getitem__" + parent: "signalwire.cli.simulation.mock_env.MockQueryParams" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `__getitem__` + +## Signature + +```python +__getitem__(key: str) -> str +``` + +## Parameters + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/index.mdx new file mode 100644 index 0000000000..0498ed098c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-query-params" +title: "MockQueryParams" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockQueryParams" + parent: "signalwire.cli.simulation.mock_env" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `MockQueryParams` + +Mock FastAPI QueryParams (simple dict-like) + +## Signature + +```python +class MockQueryParams +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 21. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/init.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/init.mdx new file mode 100644 index 0000000000..78549380eb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-query-params/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockQueryParams.__init__" + parent: "signalwire.cli.simulation.mock_env.MockQueryParams" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `__init__` + +## Signature + +```python +__init__(params: Optional[Dict[str, str]] = None) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/items.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/items.mdx new file mode 100644 index 0000000000..0f05e4a1b2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/items.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-query-params/items" +title: "items" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockQueryParams.items" + parent: "signalwire.cli.simulation.mock_env.MockQueryParams" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `items` + +## Signature + +```python +items() +``` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 35. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/keys.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/keys.mdx new file mode 100644 index 0000000000..0b443890b9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/keys.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-query-params/keys" +title: "keys" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockQueryParams.keys" + parent: "signalwire.cli.simulation.mock_env.MockQueryParams" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `keys` + +## Signature + +```python +keys() +``` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 38. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/values.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/values.mdx new file mode 100644 index 0000000000..569bc2cb0f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-query-params/values.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-query-params/values" +title: "values" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockQueryParams.values" + parent: "signalwire.cli.simulation.mock_env.MockQueryParams" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `values` + +## Signature + +```python +values() +``` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 41. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/body.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/body.mdx new file mode 100644 index 0000000000..fdfc9d67a7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/body.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-request/body" +title: "body" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockRequest.body" + parent: "signalwire.cli.simulation.mock_env.MockRequest" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `body` + +Return the raw body bytes + +**Modifiers:** `async` + +## Signature + +```python +async body() -> bytes +``` + +## Returns + +`bytes` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 119. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/client.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/client.mdx new file mode 100644 index 0000000000..1fc36f9721 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/client.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-request/client" +title: "client" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockRequest.client" + parent: "signalwire.cli.simulation.mock_env.MockRequest" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `client` + +Mock client property + +## Signature + +```python +client() +``` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 123. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/index.mdx new file mode 100644 index 0000000000..a668431beb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-request" +title: "MockRequest" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockRequest" + parent: "signalwire.cli.simulation.mock_env" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `MockRequest` + +Mock FastAPI Request object for dynamic agent testing + +## Signature + +```python +class MockRequest +``` + +## Properties + + + + + + + + + + + +## Methods + + + + + + Return the raw body bytes + + + + Mock client property + + + + Return the JSON body + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 100. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/init.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/init.mdx new file mode 100644 index 0000000000..f1e7d5580c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/init.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-request/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockRequest.__init__" + parent: "signalwire.cli.simulation.mock_env.MockRequest" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `__init__` + +## Signature + +```python +__init__( + method: str = 'POST', + url: str = 'http://localhost:8080/swml', + headers: Optional[Dict[str, str]] = None, + query_params: Optional[Dict[str, str]] = None, + json_body: Optional[Dict[str, Any]] = None +) +``` + +## Parameters + + + + + + + + + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 102. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/json.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/json.mdx new file mode 100644 index 0000000000..4bd4778122 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-request/json.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-request/json" +title: "json" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockRequest.json" + parent: "signalwire.cli.simulation.mock_env.MockRequest" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `json` + +Return the JSON body + +**Modifiers:** `async` + +## Signature + +```python +async json() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 115. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-url/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-url/index.mdx new file mode 100644 index 0000000000..4e6366e2c2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-url/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-url" +title: "MockURL" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockURL" + parent: "signalwire.cli.simulation.mock_env" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `MockURL` + +Mock FastAPI URL object + +## Signature + +```python +class MockURL +``` + +## Properties + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 73. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-url/init.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-url/init.mdx new file mode 100644 index 0000000000..5dba9f6cad --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-url/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-url/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockURL.__init__" + parent: "signalwire.cli.simulation.mock_env.MockURL" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `__init__` + +## Signature + +```python +__init__(url: str = 'http://localhost:8080/swml') +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 75. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-url/str.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-url/str.mdx new file mode 100644 index 0000000000..a7c5560783 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/mock-url/str.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/mock-url/str" +title: "__str__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.MockURL.__str__" + parent: "signalwire.cli.simulation.mock_env.MockURL" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `__str__` + +## Signature + +```python +__str__() +``` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 96. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/activate.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/activate.mdx new file mode 100644 index 0000000000..34fde9e5e8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/activate.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/activate" +title: "activate" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.ServerlessSimulator.activate" + parent: "signalwire.cli.simulation.mock_env.ServerlessSimulator" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `activate` + +Apply serverless environment simulation + +## Signature + +```python +activate(verbose: bool = False) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 178. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/add-override.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/add-override.mdx new file mode 100644 index 0000000000..768e2b3ddb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/add-override.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/add-override" +title: "add_override" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.ServerlessSimulator.add_override" + parent: "signalwire.cli.simulation.mock_env.ServerlessSimulator" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `add_override` + +Add an environment variable override + +## Signature + +```python +add_override(key: str, value: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 256. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/deactivate.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/deactivate.mdx new file mode 100644 index 0000000000..f626e7327e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/deactivate.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/deactivate" +title: "deactivate" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.ServerlessSimulator.deactivate" + parent: "signalwire.cli.simulation.mock_env.ServerlessSimulator" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `deactivate` + +Restore original environment + +## Signature + +```python +deactivate(verbose: bool = False) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 227. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/get-current-env.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/get-current-env.mdx new file mode 100644 index 0000000000..764813fd8e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/get-current-env.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/get-current-env" +title: "get_current_env" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.ServerlessSimulator.get_current_env" + parent: "signalwire.cli.simulation.mock_env.ServerlessSimulator" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `get_current_env` + +Get the current environment that would be applied + +## Signature + +```python +get_current_env() -> Dict[str, str] +``` + +## Returns + +`Dict[str, str]` + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 262. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/index.mdx new file mode 100644 index 0000000000..5c0e4f88fa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/serverless-simulator" +title: "ServerlessSimulator" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.ServerlessSimulator" + parent: "signalwire.cli.simulation.mock_env" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `ServerlessSimulator` + +Manages serverless environment simulation for different platforms + +## Signature + +```python +class ServerlessSimulator +``` + +## Properties + + + + + + + + + + + + + +## Methods + + + + + + Apply serverless environment simulation + + + + Add an environment variable override + + + + Restore original environment + + + + Get the current environment that would be applied + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 139. diff --git a/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/init.mdx b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/init.mdx new file mode 100644 index 0000000000..4419f9e99b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/cli/simulation/mock-env/serverless-simulator/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.cli.simulation.mock_env.ServerlessSimulator.__init__" + parent: "signalwire.cli.simulation.mock_env.ServerlessSimulator" + module: "signalwire.cli.simulation.mock_env" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py" +--- +# `__init__` + +## Signature + +```python +__init__(platform: str, overrides: Optional[Dict[str, str]] = None) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/cli/simulation/mock_env.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/simulation/mock_env.py) + +Line 170. diff --git a/fern/products/sdk-reference/python/signalwire/cli/swaig-test-wrapper/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/swaig-test-wrapper/index.mdx new file mode 100644 index 0000000000..c9ba59fef8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/swaig-test-wrapper/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/cli/swaig-test-wrapper" +title: "swaig_test_wrapper" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.swaig_test_wrapper" + parent: "signalwire.cli" + module: "signalwire.cli" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/swaig_test_wrapper.py" +--- +# `swaig_test_wrapper` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module swaig_test_wrapper +``` + +## Functions + + + + Main entry point for the swaig-test command + + + +## Source + +[`signalwire/signalwire/cli/swaig_test_wrapper.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/swaig_test_wrapper.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/swaig-test-wrapper/main.mdx b/fern/products/sdk-reference/python/signalwire/cli/swaig-test-wrapper/main.mdx new file mode 100644 index 0000000000..77f670b6b3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/swaig-test-wrapper/main.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/swaig-test-wrapper/main" +title: "main" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.swaig_test_wrapper.main" + parent: "signalwire.cli.swaig_test_wrapper" + module: "signalwire.cli.swaig_test_wrapper" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/swaig_test_wrapper.py" +--- +# `main` + +Main entry point for the swaig-test command + +## Signature + +```python +main() +``` + +## Source + +[`signalwire/signalwire/cli/swaig_test_wrapper.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/swaig_test_wrapper.py) + +Line 21. diff --git a/fern/products/sdk-reference/python/signalwire/cli/test-swaig/console-entry-point.mdx b/fern/products/sdk-reference/python/signalwire/cli/test-swaig/console-entry-point.mdx new file mode 100644 index 0000000000..43f95a4c05 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/test-swaig/console-entry-point.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/test-swaig/console-entry-point" +title: "console_entry_point" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.test_swaig.console_entry_point" + parent: "signalwire.cli.test_swaig" + module: "signalwire.cli.test_swaig" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/test_swaig.py" +--- +# `console_entry_point` + +Console script entry point for pip installation + +## Signature + +```python +console_entry_point() +``` + +## Source + +[`signalwire/signalwire/cli/test_swaig.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/test_swaig.py) + +Line 800. diff --git a/fern/products/sdk-reference/python/signalwire/cli/test-swaig/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/test-swaig/index.mdx new file mode 100644 index 0000000000..78e2cd4b63 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/test-swaig/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/cli/test-swaig" +title: "test_swaig" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.test_swaig" + parent: "signalwire.cli" + module: "signalwire.cli" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/test_swaig.py" +--- +# `test_swaig` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module test_swaig +``` + +## Functions + + + + Console script entry point for pip installation + + + + Main entry point for the CLI tool + + + + Print comprehensive usage examples + + + + Print detailed help for serverless platform options + + + +## Source + +[`signalwire/signalwire/cli/test_swaig.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/test_swaig.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/test-swaig/main.mdx b/fern/products/sdk-reference/python/signalwire/cli/test-swaig/main.mdx new file mode 100644 index 0000000000..76495561de --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/test-swaig/main.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/test-swaig/main" +title: "main" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.test_swaig.main" + parent: "signalwire.cli.test_swaig" + module: "signalwire.cli.test_swaig" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/test_swaig.py" +--- +# `main` + +Main entry point for the CLI tool + +## Signature + +```python +main() +``` + +## Source + +[`signalwire/signalwire/cli/test_swaig.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/test_swaig.py) + +Line 222. diff --git a/fern/products/sdk-reference/python/signalwire/cli/test-swaig/print-help-examples.mdx b/fern/products/sdk-reference/python/signalwire/cli/test-swaig/print-help-examples.mdx new file mode 100644 index 0000000000..9d1842416a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/test-swaig/print-help-examples.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/test-swaig/print-help-examples" +title: "print_help_examples" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.test_swaig.print_help_examples" + parent: "signalwire.cli.test_swaig" + module: "signalwire.cli.test_swaig" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/test_swaig.py" +--- +# `print_help_examples` + +Print comprehensive usage examples + +## Signature + +```python +print_help_examples() +``` + +## Source + +[`signalwire/signalwire/cli/test_swaig.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/test_swaig.py) + +Line 95. diff --git a/fern/products/sdk-reference/python/signalwire/cli/test-swaig/print-help-platforms.mdx b/fern/products/sdk-reference/python/signalwire/cli/test-swaig/print-help-platforms.mdx new file mode 100644 index 0000000000..471bccdf65 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/test-swaig/print-help-platforms.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/cli/test-swaig/print-help-platforms" +title: "print_help_platforms" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.cli.test_swaig.print_help_platforms" + parent: "signalwire.cli.test_swaig" + module: "signalwire.cli.test_swaig" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/test_swaig.py" +--- +# `print_help_platforms` + +Print detailed help for serverless platform options + +## Signature + +```python +print_help_platforms() +``` + +## Source + +[`signalwire/signalwire/cli/test_swaig.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/test_swaig.py) + +Line 51. diff --git a/fern/products/sdk-reference/python/signalwire/cli/types/agent-info/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/types/agent-info/index.mdx new file mode 100644 index 0000000000..33f9d9bbf5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/types/agent-info/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/cli/types/agent-info" +title: "AgentInfo" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.types.AgentInfo" + parent: "signalwire.cli.types" + module: "signalwire.cli.types" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py" +--- +# `AgentInfo` + +Information about a discovered agent + +## Signature + +```python +class AgentInfo(TypedDict) +``` + +## Inheritance + +**Extends:** `TypedDict` + +## Properties + + + + + + + + + +## Source + +[`signalwire/signalwire/cli/types.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py) + +Line 67. diff --git a/fern/products/sdk-reference/python/signalwire/cli/types/call-data/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/types/call-data/index.mdx new file mode 100644 index 0000000000..74ccd9ed6a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/types/call-data/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/python/signalwire/cli/types/call-data" +title: "CallData" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.types.CallData" + parent: "signalwire.cli.types" + module: "signalwire.cli.types" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py" +--- +# `CallData` + +Call data structure for SWML post\_data + +## Signature + +```python +class CallData(TypedDict) +``` + +## Inheritance + +**Extends:** `TypedDict` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/cli/types.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py) + +Line 18. diff --git a/fern/products/sdk-reference/python/signalwire/cli/types/data-map-config/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/types/data-map-config/index.mdx new file mode 100644 index 0000000000..cb8f98e8c9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/types/data-map-config/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/cli/types/data-map-config" +title: "DataMapConfig" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.types.DataMapConfig" + parent: "signalwire.cli.types" + module: "signalwire.cli.types" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py" +--- +# `DataMapConfig` + +DataMap function configuration + +## Signature + +```python +class DataMapConfig(TypedDict) +``` + +## Inheritance + +**Extends:** `TypedDict` + +## Properties + + + + + + + + + +## Source + +[`signalwire/signalwire/cli/types.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py) + +Line 59. diff --git a/fern/products/sdk-reference/python/signalwire/cli/types/function-info/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/types/function-info/index.mdx new file mode 100644 index 0000000000..170115f7ed --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/types/function-info/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/cli/types/function-info" +title: "FunctionInfo" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.types.FunctionInfo" + parent: "signalwire.cli.types" + module: "signalwire.cli.types" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py" +--- +# `FunctionInfo` + +Information about a SWAIG function + +## Signature + +```python +class FunctionInfo(TypedDict) +``` + +## Inheritance + +**Extends:** `TypedDict` + +## Properties + + + + + + + + + + + +## Source + +[`signalwire/signalwire/cli/types.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py) + +Line 75. diff --git a/fern/products/sdk-reference/python/signalwire/cli/types/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/types/index.mdx new file mode 100644 index 0000000000..36682f27d2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/types/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/cli/types" +title: "types" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.cli.types" + parent: "signalwire.cli" + module: "signalwire.cli" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py" +--- +# `types` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module types +``` + +## Classes + + + + Information about a discovered agent + + + + Call data structure for SWML post\_data + + + + DataMap function configuration + + + + Information about a SWAIG function + + + + Complete post\_data structure for SWML requests + + + + Variables data structure for SWML post\_data + + + +## Source + +[`signalwire/signalwire/cli/types.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py) diff --git a/fern/products/sdk-reference/python/signalwire/cli/types/post-data/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/types/post-data/index.mdx new file mode 100644 index 0000000000..2487e8ec5c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/types/post-data/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/cli/types/post-data" +title: "PostData" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.types.PostData" + parent: "signalwire.cli.types" + module: "signalwire.cli.types" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py" +--- +# `PostData` + +Complete post\_data structure for SWML requests + +## Signature + +```python +class PostData(TypedDict) +``` + +## Inheritance + +**Extends:** `TypedDict` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/cli/types.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py) + +Line 44. diff --git a/fern/products/sdk-reference/python/signalwire/cli/types/vars-data/index.mdx b/fern/products/sdk-reference/python/signalwire/cli/types/vars-data/index.mdx new file mode 100644 index 0000000000..2bc387bc8b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/cli/types/vars-data/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/cli/types/vars-data" +title: "VarsData" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.cli.types.VarsData" + parent: "signalwire.cli.types" + module: "signalwire.cli.types" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py" +--- +# `VarsData` + +Variables data structure for SWML post\_data + +## Signature + +```python +class VarsData(TypedDict) +``` + +## Inheritance + +**Extends:** `TypedDict` + +## Properties + + + + + + + +## Source + +[`signalwire/signalwire/cli/types.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/cli/types.py) + +Line 37. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-answer-verb.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-answer-verb.mdx new file mode 100644 index 0000000000..48f5fdaf5c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-answer-verb.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/add-answer-verb" +title: "add_answer_verb" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.add_answer_verb" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `add_answer_verb` + +Configure the answer verb. + +The answer verb connects the call. Use this method to customize +answer behavior, such as setting max\_duration. + +> \[!NOTE] +> +> # Set maximum call duration to 1 hour +> +> agent.add\_answer\_verb(\{"max\_duration": 3600\}) + +## Signature + +```python +add_answer_verb(config: Optional[Dict[str, Any]] = None) -> AgentBase +``` + +## Parameters + + + Optional answer verb configuration (e.g., \{"max\_duration": 3600\}) + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 536. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-post-ai-verb.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-post-ai-verb.mdx new file mode 100644 index 0000000000..4c7b17a0b8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-post-ai-verb.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/add-post-ai-verb" +title: "add_post_ai_verb" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.add_post_ai_verb" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `add_post_ai_verb` + +Add a verb to run after the AI conversation ends. + +Post-AI verbs run when the AI completes its conversation. Common uses +include clean disconnects, transfers, and logging. + +> \[!NOTE] +> +> # Log call completion and hang up +> +> agent.add\_post\_ai\_verb("request", \{ +> "url": "https://api.example.com/call-complete", +> "method": "POST" +> \}) +> agent.add\_post\_ai\_verb("hangup", \{\}) + +## Signature + +```python +add_post_ai_verb(verb_name: str, config: Dict[str, Any]) -> AgentBase +``` + +## Parameters + + + The SWML verb name (e.g., "hangup", "transfer", "request") + + + + Verb configuration dictionary + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 581. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-post-answer-verb.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-post-answer-verb.mdx new file mode 100644 index 0000000000..5aa4e4ea0b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-post-answer-verb.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/add-post-answer-verb" +title: "add_post_answer_verb" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.add_post_answer_verb" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `add_post_answer_verb` + +Add a verb to run after the call is answered but before the AI starts. + +Post-answer verbs run after the call is connected. Common uses include +welcome messages, legal disclaimers, and hold music. + +> \[!NOTE] +> +> # Play welcome message +> +> agent.add\_post\_answer\_verb("play", \{ +> "url": "say:Welcome to Acme Corporation." +> \}) +> +> # Brief pause +> +> agent.add\_post\_answer\_verb("sleep", \{"time": 500\}) + +## Signature + +```python +add_post_answer_verb(verb_name: str, config: Dict[str, Any]) -> AgentBase +``` + +## Parameters + + + The SWML verb name (e.g., "play", "sleep") + + + + Verb configuration dictionary + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 556. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-pre-answer-verb.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..d6a3a98a66 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-pre-answer-verb.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/add-pre-answer-verb" +title: "add_pre_answer_verb" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.add_pre_answer_verb" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `add_pre_answer_verb` + +Add a verb to run before the call is answered. + +Pre-answer verbs execute while the call is still ringing. Only certain +verbs are safe to use before answering: + +> \[!NOTE] +> cond, if, eval, set, unset, hangup, send\_sms, sleep, +> stop\_record\_call, stop\_denoise, stop\_tap + +Verbs with auto\_answer option (play, connect): Must include +"auto\_answer": False in config to prevent automatic answering. + +> \[!NOTE] +> +> # Play ringback tone before answering +> +> agent.add\_pre\_answer\_verb("play", \{ +> "urls": \["ring:us"], +> "auto\_answer": False +> \}) + +## Signature + +```python +add_pre_answer_verb(verb_name: str, config: Dict[str, Any]) -> AgentBase +``` + +## Parameters + + + The SWML verb name (e.g., "play", "sleep", "request") + + + + Verb configuration dictionary + + +## Returns + +`AgentBase` — Self for method chaining + +## Throws + +- `ValueError` — If verb is not safe for pre-answer use + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 488. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-swaig-query-params.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-swaig-query-params.mdx new file mode 100644 index 0000000000..7ed647a1b9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/add-swaig-query-params.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/add-swaig-query-params" +title: "add_swaig_query_params" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.add_swaig_query_params" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `add_swaig_query_params` + +Add query parameters that will be included in all SWAIG webhook URLs + +This is particularly useful for preserving dynamic configuration state +across SWAIG callbacks. For example, if your dynamic config adds skills +based on query parameters, you can pass those same parameters through +to the SWAIG webhook so the same configuration is applied. + +> \[!NOTE] +> def dynamic\_config(query\_params, body\_params, headers, agent): +> if query\_params.get('tier') == 'premium': +> agent.add\_skill('advanced\_search') +> \# Preserve the tier param so SWAIG callbacks work +> agent.add\_swaig\_query\_params(\{'tier': 'premium'\}) + +## Signature + +```python +add_swaig_query_params(params: Dict[str, str]) -> AgentBase +``` + +## Parameters + + + Dictionary of query parameters to add to SWAIG URLs + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 753. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/auto-map-sip-usernames.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/auto-map-sip-usernames.mdx new file mode 100644 index 0000000000..2cb921a14d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/auto-map-sip-usernames.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/auto-map-sip-usernames" +title: "auto_map_sip_usernames" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.auto_map_sip_usernames" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `auto_map_sip_usernames` + +Automatically register common SIP usernames based on this agent's +name and route + +## Signature + +```python +auto_map_sip_usernames() -> AgentBase +``` + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 700. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..0b2ca1ea07 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-post-ai-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/clear-post-ai-verbs" +title: "clear_post_ai_verbs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.clear_post_ai_verbs" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `clear_post_ai_verbs` + +Remove all post-AI verbs. + +## Signature + +```python +clear_post_ai_verbs() -> AgentBase +``` + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 626. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..e22c8195fd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-post-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/clear-post-answer-verbs" +title: "clear_post_answer_verbs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.clear_post_answer_verbs" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `clear_post_answer_verbs` + +Remove all post-answer verbs. + +## Signature + +```python +clear_post_answer_verbs() -> AgentBase +``` + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 616. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..0afa57be9a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-pre-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/clear-pre-answer-verbs" +title: "clear_pre_answer_verbs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.clear_pre_answer_verbs" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `clear_pre_answer_verbs` + +Remove all pre-answer verbs. + +## Signature + +```python +clear_pre_answer_verbs() -> AgentBase +``` + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 606. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-swaig-query-params.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..fb2f4922d6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/clear-swaig-query-params.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/clear-swaig-query-params" +title: "clear_swaig_query_params" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.clear_swaig_query_params" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `clear_swaig_query_params` + +Clear all SWAIG query parameters + +## Signature + +```python +clear_swaig_query_params() -> AgentBase +``` + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 779. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/enable-sip-routing.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/enable-sip-routing.mdx new file mode 100644 index 0000000000..b9ed35f246 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/enable-sip-routing.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/enable-sip-routing" +title: "enable_sip_routing" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.enable_sip_routing" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `enable_sip_routing` + +Enable SIP-based routing for this agent + +This allows the agent to automatically route SIP requests based on SIP usernames. +When enabled, an endpoint at the specified path is automatically created +that will handle SIP requests and deliver them to this agent. + +## Signature + +```python +enable_sip_routing(auto_map: bool = True, path: str = '/sip') -> AgentBase +``` + +## Parameters + + + Whether to automatically map common SIP usernames to this agent (based on the agent name and route path) + + + + The path to register the SIP routing endpoint (default: "/sip") + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 638. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/get-full-url.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/get-full-url.mdx new file mode 100644 index 0000000000..78c0122397 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/get-full-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/get-full-url" +title: "get_full_url" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.get_full_url" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `get_full_url` + +Get the full URL for this agent's endpoint + +## Signature + +```python +get_full_url(include_auth: bool = False) -> str +``` + +## Parameters + + + Whether to include authentication credentials in the URL + + +## Returns + +`str` — Full URL including host, port, and route (with auth if requested) + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 351. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/get-name.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/get-name.mdx new file mode 100644 index 0000000000..e0af268a84 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/get-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/get-name" +title: "get_name" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.get_name" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `get_name` + +Get agent name + +## Signature + +```python +get_name() -> str +``` + +## Returns + +`str` — Agent name + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 342. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/index.mdx new file mode 100644 index 0000000000..d886bb19b2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/index.mdx @@ -0,0 +1,145 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base" +title: "AgentBase" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase" + parent: "signalwire.core.agent_base" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `AgentBase` + +Base class for all SignalWire AI Agents. + +This class extends SWMLService and provides enhanced functionality for building agents including: + +- Prompt building and customization +- SWML rendering +- SWAIG function definition and execution +- Web service for serving SWML and handling webhooks +- Security and session management + +Subclassing options: + +1. Simple override of get\_prompt() for raw text +2. Using prompt\_\* methods for structured prompts +3. Declarative PROMPT\_SECTIONS class attribute + +## Signature + +```python +class AgentBase(AuthMixin, WebMixin, SWMLService, PromptMixin, SkillMixin, AIConfigMixin, ServerlessMixin, StateMixin, MCPServerMixin) +``` + +## Inheritance + +**Extends:** [AuthMixin](/reference/python/signalwire/core/mixins/auth-mixin/auth-mixin), [WebMixin](/reference/python/signalwire/core/mixins/web-mixin/web-mixin), [SWMLService](/reference/python/signalwire/core/swml-service/swml-service), [PromptMixin](/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin), [SkillMixin](/reference/python/signalwire/core/mixins/skill-mixin/skill-mixin), [AIConfigMixin](/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin), [ServerlessMixin](/reference/python/signalwire/core/mixins/serverless-mixin/serverless-mixin), [StateMixin](/reference/python/signalwire/core/mixins/state-mixin/state-mixin), [MCPServerMixin](/reference/python/signalwire/core/mixins/mcp-server-mixin/mcp-server-mixin) + +## Properties + + + + + + + + + + + + + + + + + +## Methods + + + + Initialize a new agent + + + + Configure the answer verb. + + + + Add a verb to run after the AI conversation ends. + + + + Add a verb to run after the call is answered but before the AI starts. + + + + Add a verb to run before the call is answered. + + + + Add query parameters that will be included in all SWAIG webhook URLs + + + + Automatically register common SIP usernames based on this agent's name and route + + + + Remove all post-AI verbs. + + + + Remove all post-answer verbs. + + + + Remove all pre-answer verbs. + + + + Clear all SWAIG query parameters + + + + Enable SIP-based routing for this agent + + + + Get the full URL for this agent's endpoint + + + + Get agent name + + + + Register a handler for debug webhook events. + + + + Called when a post-prompt summary is received + + + + Register a SIP username that should be routed to this agent + + + + Override the default post\_prompt\_url with a supplied URL string + + + + Override the default web\_hook\_url with a supplied URL string + + + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 78. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/init.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/init.mdx new file mode 100644 index 0000000000..285a00a5aa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/init.mdx @@ -0,0 +1,142 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.__init__" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `__init__` + +Initialize a new agent + +## Signature + +```python +__init__( + name: str, + route: str = '/', + host: str = '0.0.0.0', + port: Optional[int] = None, + basic_auth: Optional[Tuple[str, str]] = None, + use_pom: bool = True, + token_expiry_secs: int = 3600, + auto_answer: bool = True, + record_call: bool = False, + record_format: str = 'mp4', + record_stereo: bool = True, + default_webhook_url: Optional[str] = None, + agent_id: Optional[str] = None, + native_functions: Optional[List[str]] = None, + schema_path: Optional[str] = None, + suppress_logs: bool = False, + enable_post_prompt_override: bool = False, + check_for_input_override: bool = False, + config_file: Optional[str] = None, + schema_validation: bool = True, + signing_key: Optional[str] = None, + trust_proxy_for_signature: bool = False +) +``` + +## Parameters + + + Agent name/identifier + + + + HTTP route path for this agent + + + + Host to bind the web server to + + + + Port to bind the web server to + + + + Optional (username, password) tuple for basic auth + + + + Whether to use POM for prompt building + + + + Seconds until tokens expire + + + + Whether to automatically answer calls + + + + Whether to record calls + + + + Recording format + + + + Whether to record in stereo + + + + Optional default webhook URL for all SWAIG functions + + + + Optional unique ID for this agent, generated if not provided + + + + Optional list of native functions to include in the SWAIG object + + + + Optional path to the schema file + + + + Whether to suppress structured logs + + + + Whether to enable post-prompt override + + + + Whether to enable check-for-input override + + + + Optional path to configuration file + + + + Enable SWML schema validation. Default True. Can also be disabled via SWML\_SKIP\_SCHEMA\_VALIDATION=1 env var. + + + + Optional SignalWire Signing Key (from Dashboard → API Credentials). When set, webhook signature validation is enforced on POST /, /swaig, /post\_prompt — unsigned or invalidly-signed requests get a 403. Falls back to the SIGNALWIRE\_SIGNING\_KEY env var if not passed. See porting-sdk/webhooks.md for the contract. + + + + If True, honor X-Forwarded-Proto / X-Forwarded-Host when reconstructing the URL during signature validation. Default False — proxy headers are spoofable, so opt in only when you control the proxy chain. + + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 108. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/on-debug-event.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/on-debug-event.mdx new file mode 100644 index 0000000000..6666b5ee06 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/on-debug-event.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/on-debug-event" +title: "on_debug_event" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.on_debug_event" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `on_debug_event` + +Register a handler for debug webhook events. + +Use as a decorator to receive real-time debug events from the AI module +during calls. Requires enable\_debug\_events() to be called first. + +> \[!NOTE] +> event\_type (str): The event label (e.g. "barge", "llm\_error", "session\_start") +> data (dict): The full event payload including call\_id, label, and event-specific fields + +The handler may be sync or async. + +> \[!NOTE] +> @agent.on\_debug\_event +> def handle(event\_type, data): +> if event\_type == "barge": +> print(f"Barge detected: \{data.get('barge\_elapsed\_ms')\}ms") + +## Signature + +```python +on_debug_event(handler: Callable) -> Callable +``` + +## Parameters + + + Callback function with signature (event\_type: str, data: dict) + + +## Returns + +`Callable` — The handler function (unchanged), for use as a decorator + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 458. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/on-summary.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/on-summary.mdx new file mode 100644 index 0000000000..aa831520a4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/on-summary.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/on-summary" +title: "on_summary" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.on_summary" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `on_summary` + +Called when a post-prompt summary is received + +## Signature + +```python +on_summary( + summary: Optional[Dict[str, Any]], + raw_data: Optional[Dict[str, Any]] = None +) -> None +``` + +## Parameters + + + The summary object or None if no summary was found + + + + The complete raw POST data from the request + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 447. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/register-sip-username.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/register-sip-username.mdx new file mode 100644 index 0000000000..20b2848249 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/register-sip-username.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/register-sip-username" +title: "register_sip_username" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.register_sip_username" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `register_sip_username` + +Register a SIP username that should be routed to this agent + +## Signature + +```python +register_sip_username(sip_username: str) -> AgentBase +``` + +## Parameters + + + SIP username to register + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 682. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/set-post-prompt-url.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/set-post-prompt-url.mdx new file mode 100644 index 0000000000..c9b9285cdc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/set-post-prompt-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/set-post-prompt-url" +title: "set_post_prompt_url" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.set_post_prompt_url" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `set_post_prompt_url` + +Override the default post\_prompt\_url with a supplied URL string + +## Signature + +```python +set_post_prompt_url(url: str) -> AgentBase +``` + +## Parameters + + + The URL to use for post-prompt summary delivery + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 740. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/set-web-hook-url.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/set-web-hook-url.mdx new file mode 100644 index 0000000000..4f3bdff1ae --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/agent-base/set-web-hook-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/agent-base/agent-base/set-web-hook-url" +title: "set_web_hook_url" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent_base.AgentBase.set_web_hook_url" + parent: "signalwire.core.agent_base.AgentBase" + module: "signalwire.core.agent_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `set_web_hook_url` + +Override the default web\_hook\_url with a supplied URL string + +## Signature + +```python +set_web_hook_url(url: str) -> AgentBase +``` + +## Parameters + + + The URL to use for SWAIG function webhooks + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) + +Line 727. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent-base/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent-base/index.mdx new file mode 100644 index 0000000000..86e1fcb73b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent-base/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/agent-base" +title: "agent_base" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent_base" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py" +--- +# `agent_base` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module agent_base +``` + +## Properties + + + +## Classes + + + + Base class for all SignalWire AI Agents. + + + +## Source + +[`signalwire/signalwire/core/agent_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent_base.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/config/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/config/index.mdx new file mode 100644 index 0000000000..99c927c957 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/config/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/core/agent/config" +title: "config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.config" + parent: "signalwire.core.agent" + module: "signalwire.core.agent" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/config/__init__.py" +--- +# `config` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module config +``` + +## Properties + + + +## Source + +[`signalwire/signalwire/core/agent/config/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/config/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/deployment/handlers/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/deployment/handlers/index.mdx new file mode 100644 index 0000000000..3a66848798 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/deployment/handlers/index.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/python/signalwire/core/agent/deployment/handlers" +title: "handlers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.deployment.handlers" + parent: "signalwire.core.agent.deployment" + module: "signalwire.core.agent.deployment" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/deployment/handlers/__init__.py" +--- +# `handlers` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module handlers +``` + +## Source + +[`signalwire/signalwire/core/agent/deployment/handlers/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/deployment/handlers/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/deployment/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/deployment/index.mdx new file mode 100644 index 0000000000..a9642dd5b5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/deployment/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/agent/deployment" +title: "deployment" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.deployment" + parent: "signalwire.core.agent" + module: "signalwire.core.agent" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/deployment/__init__.py" +--- +# `deployment` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module deployment +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/core/agent/deployment/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/deployment/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/index.mdx new file mode 100644 index 0000000000..6674b047af --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/python/signalwire/core/agent" +title: "agent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/__init__.py" +--- +# `agent` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module agent +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/core/agent/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/index.mdx new file mode 100644 index 0000000000..dbd461cad4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt" +title: "prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.prompt" + parent: "signalwire.core.agent" + module: "signalwire.core.agent" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/__init__.py" +--- +# `prompt` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module prompt +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/core/agent/prompt/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/index.mdx new file mode 100644 index 0000000000..66af556d40 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager" +title: "manager" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager" + parent: "signalwire.core.agent.prompt" + module: "signalwire.core.agent.prompt" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `manager` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module manager +``` + +## Properties + + + +## Classes + + + + Manages prompt building and configuration. + + + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/define-contexts.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/define-contexts.mdx new file mode 100644 index 0000000000..a374332c99 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/define-contexts.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/define-contexts" +title: "define_contexts" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.define_contexts" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `define_contexts` + +Define contexts for the agent. + +## Signature + +```python +define_contexts(contexts: Union[Dict[str, Any], Any]) -> None +``` + +## Parameters + + + Context configuration (dict or ContextBuilder) + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 73. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-contexts.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-contexts.mdx new file mode 100644 index 0000000000..00c029ea21 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-contexts.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-contexts" +title: "get_contexts" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.get_contexts" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `get_contexts` + +Get the contexts configuration. + +## Signature + +```python +get_contexts() -> Optional[Dict[str, Any]] +``` + +## Returns + +`Optional[Dict[str, Any]]` — Contexts dict or None + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 300. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-post-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-post-prompt.mdx new file mode 100644 index 0000000000..abfdd2cfdf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-post-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-post-prompt" +title: "get_post_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.get_post_prompt" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `get_post_prompt` + +Get the post-prompt text. + +## Signature + +```python +get_post_prompt() -> Optional[str] +``` + +## Returns + +`Optional[str]` — Post-prompt text or None + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 291. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-prompt.mdx new file mode 100644 index 0000000000..537f29e224 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-prompt" +title: "get_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.get_prompt" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `get_prompt` + +Get the prompt configuration. + +## Signature + +```python +get_prompt() -> Optional[Union[str, List[Dict[str, Any]]]] +``` + +## Returns + +`Optional[Union[str, List[Dict[str, Any]]]]` — Prompt text or sections or None + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 273. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-raw-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-raw-prompt.mdx new file mode 100644 index 0000000000..d8066b5be7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-raw-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/get-raw-prompt" +title: "get_raw_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.get_raw_prompt" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `get_raw_prompt` + +Get the raw prompt text if set. + +## Signature + +```python +get_raw_prompt() -> Optional[str] +``` + +## Returns + +`Optional[str]` — Raw prompt text or None + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 282. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/index.mdx new file mode 100644 index 0000000000..6d8fc70245 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/index.mdx @@ -0,0 +1,89 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager" +title: "PromptManager" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager" + parent: "signalwire.core.agent.prompt.manager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `PromptManager` + +Manages prompt building and configuration. + +## Signature + +```python +class PromptManager +``` + +## Properties + + + +## Methods + + + + Initialize PromptManager with reference to parent agent. + + + + Define contexts for the agent. + + + + Get the contexts configuration. + + + + Get the post-prompt text. + + + + Get the prompt configuration. + + + + Get the raw prompt text if set. + + + + Add a section to the prompt. + + + + Add a subsection to an existing section (creating parent if needed). + + + + Add content to an existing section (creating it if needed). + + + + Check if a section exists in the prompt. + + + + Set the post-prompt text. + + + + Set the prompt as a POM dictionary. + + + + Set the agent's prompt as raw text. + + + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/init.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/init.mdx new file mode 100644 index 0000000000..0ddb40f869 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.__init__" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `__init__` + +Initialize PromptManager with reference to parent agent. + +## Signature + +```python +__init__(agent) +``` + +## Parameters + + + Parent AgentBase instance + + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-section.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-section.mdx new file mode 100644 index 0000000000..556ad3bf8f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-section.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-section" +title: "prompt_add_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.prompt_add_section" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `prompt_add_section` + +Add a section to the prompt. + +## Signature + +```python +prompt_add_section( + title: str, + body: str = '', + bullets: Optional[List[str]] = None, + numbered: bool = False, + numbered_bullets: bool = False, + subsections: Optional[List[Dict[str, Any]]] = None +) -> None +``` + +## Parameters + + + Section title + + + + Optional section body text + + + + Optional list of bullet points + + + + Whether this section should be numbered + + + + Whether bullets should be numbered + + + + Optional list of subsection objects + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 127. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-subsection.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-subsection.mdx new file mode 100644 index 0000000000..9525f6228e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-subsection.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-subsection" +title: "prompt_add_subsection" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.prompt_add_subsection" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `prompt_add_subsection` + +Add a subsection to an existing section (creating parent if needed). + +## Signature + +```python +prompt_add_subsection( + parent_title: str, + title: str, + body: str = '', + bullets: Optional[List[str]] = None +) -> None +``` + +## Parameters + + + Parent section title + + + + Subsection title + + + + Optional subsection body text + + + + Optional list of bullet points + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 220. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-to-section.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-to-section.mdx new file mode 100644 index 0000000000..494a3d7b65 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-to-section.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-add-to-section" +title: "prompt_add_to_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.prompt_add_to_section" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `prompt_add_to_section` + +Add content to an existing section (creating it if needed). + +## Signature + +```python +prompt_add_to_section( + title: str, + body: Optional[str] = None, + bullet: Optional[str] = None, + bullets: Optional[List[str]] = None +) -> None +``` + +## Parameters + + + Section title + + + + Optional text to append to section body + + + + Optional single bullet point to add + + + + Optional list of bullet points to add + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 179. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-has-section.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-has-section.mdx new file mode 100644 index 0000000000..5659a992c6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-has-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/prompt-has-section" +title: "prompt_has_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.prompt_has_section" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `prompt_has_section` + +Check if a section exists in the prompt. + +## Signature + +```python +prompt_has_section(title: str) -> bool +``` + +## Parameters + + + Section title to check + + +## Returns + +`bool` — True if section exists, False otherwise + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 258. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-post-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-post-prompt.mdx new file mode 100644 index 0000000000..64e9a1ba7b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-post-prompt" +title: "set_post_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.set_post_prompt" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `set_post_prompt` + +Set the post-prompt text. + +## Signature + +```python +set_post_prompt(text: str) -> None +``` + +## Parameters + + + Post-prompt text + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 102. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-prompt-pom.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-prompt-pom.mdx new file mode 100644 index 0000000000..0e7a7c9ca0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-prompt-pom.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-prompt-pom" +title: "set_prompt_pom" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.set_prompt_pom" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `set_prompt_pom` + +Set the prompt as a POM dictionary. + +## Signature + +```python +set_prompt_pom(pom: List[Dict[str, Any]]) -> None +``` + +## Parameters + + + POM dictionary structure + + +## Returns + +`None` + +## Throws + +- `ValueError` — If use\_pom is False + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 112. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-prompt-text.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-prompt-text.mdx new file mode 100644 index 0000000000..89d761bf57 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-prompt-text.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/agent/prompt/manager/prompt-manager/set-prompt-text" +title: "set_prompt_text" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.prompt.manager.PromptManager.set_prompt_text" + parent: "signalwire.core.agent.prompt.manager.PromptManager" + module: "signalwire.core.agent.prompt.manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py" +--- +# `set_prompt_text` + +Set the agent's prompt as raw text. + +## Signature + +```python +set_prompt_text(text: str) -> None +``` + +## Parameters + + + Prompt text + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/agent/prompt/manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/prompt/manager.py) + +Line 91. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/routing/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/routing/index.mdx new file mode 100644 index 0000000000..c4c479a5d7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/routing/index.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/python/signalwire/core/agent/routing" +title: "routing" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.routing" + parent: "signalwire.core.agent" + module: "signalwire.core.agent" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/routing/__init__.py" +--- +# `routing` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module routing +``` + +## Source + +[`signalwire/signalwire/core/agent/routing/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/routing/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/security/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/security/index.mdx new file mode 100644 index 0000000000..c0bb8eb1a3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/security/index.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/python/signalwire/core/agent/security" +title: "security" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.security" + parent: "signalwire.core.agent" + module: "signalwire.core.agent" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/security/__init__.py" +--- +# `security` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module security +``` + +## Source + +[`signalwire/signalwire/core/agent/security/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/security/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/swml/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/swml/index.mdx new file mode 100644 index 0000000000..aaaeac9ce2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/swml/index.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/python/signalwire/core/agent/swml" +title: "swml" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.swml" + parent: "signalwire.core.agent" + module: "signalwire.core.agent" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/swml/__init__.py" +--- +# `swml` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module swml +``` + +## Source + +[`signalwire/signalwire/core/agent/swml/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/swml/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/index.mdx new file mode 100644 index 0000000000..6a79f49e2a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/decorator" +title: "decorator" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.tools.decorator" + parent: "signalwire.core.agent.tools" + module: "signalwire.core.agent.tools" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/decorator.py" +--- +# `decorator` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module decorator +``` + +## Properties + + + +## Classes + + + + Handles tool decoration logic. + + + +## Source + +[`signalwire/signalwire/core/agent/tools/decorator.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/decorator.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/tool-decorator/create-class-decorator.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/tool-decorator/create-class-decorator.mdx new file mode 100644 index 0000000000..5845d60b7d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/tool-decorator/create-class-decorator.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/decorator/tool-decorator/create-class-decorator" +title: "create_class_decorator" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.tools.decorator.ToolDecorator.create_class_decorator" + parent: "signalwire.core.agent.tools.decorator.ToolDecorator" + module: "signalwire.core.agent.tools.decorator" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/decorator.py" +--- +# `create_class_decorator` + +Create class tool decorator. + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +create_class_decorator() +``` + +## Returns + +Decorator function + +## Source + +[`signalwire/signalwire/core/agent/tools/decorator.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/decorator.py) + +Line 132. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/tool-decorator/create-instance-decorator.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/tool-decorator/create-instance-decorator.mdx new file mode 100644 index 0000000000..08b470ac13 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/tool-decorator/create-instance-decorator.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/decorator/tool-decorator/create-instance-decorator" +title: "create_instance_decorator" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.tools.decorator.ToolDecorator.create_instance_decorator" + parent: "signalwire.core.agent.tools.decorator.ToolDecorator" + module: "signalwire.core.agent.tools.decorator" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/decorator.py" +--- +# `create_instance_decorator` + +Create instance tool decorator. + +**Modifiers:** `static` + +## Signature + +```python +@staticmethod +create_instance_decorator(registry) +``` + +## Parameters + + + ToolRegistry instance to register with + + +## Returns + +Decorator function + +## Source + +[`signalwire/signalwire/core/agent/tools/decorator.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/decorator.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/tool-decorator/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/tool-decorator/index.mdx new file mode 100644 index 0000000000..cdabdf971d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/decorator/tool-decorator/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/decorator/tool-decorator" +title: "ToolDecorator" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.agent.tools.decorator.ToolDecorator" + parent: "signalwire.core.agent.tools.decorator" + module: "signalwire.core.agent.tools.decorator" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/decorator.py" +--- +# `ToolDecorator` + +Handles tool decoration logic. + +## Signature + +```python +class ToolDecorator +``` + +## Methods + + + + Create class tool decorator. + + + + Create instance tool decorator. + + + +## Source + +[`signalwire/signalwire/core/agent/tools/decorator.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/decorator.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/index.mdx new file mode 100644 index 0000000000..00daa8b281 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools" +title: "tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.tools" + parent: "signalwire.core.agent" + module: "signalwire.core.agent" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/__init__.py" +--- +# `tools` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module tools +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/core/agent/tools/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/index.mdx new file mode 100644 index 0000000000..fb48fc96d2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/registry" +title: "registry" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.tools.registry" + parent: "signalwire.core.agent.tools" + module: "signalwire.core.agent.tools" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py" +--- +# `registry` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module registry +``` + +## Properties + + + +## Classes + + + + Manages SWAIG function registration. + + + +## Source + +[`signalwire/signalwire/core/agent/tools/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/define-tool.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/define-tool.mdx new file mode 100644 index 0000000000..d577951f9e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/define-tool.mdx @@ -0,0 +1,98 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/registry/tool-registry/define-tool" +title: "define_tool" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.tools.registry.ToolRegistry.define_tool" + parent: "signalwire.core.agent.tools.registry.ToolRegistry" + module: "signalwire.core.agent.tools.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py" +--- +# `define_tool` + +Define a SWAIG function that the AI can call. + +## Signature + +```python +define_tool( + name: str, + description: str, + parameters: Dict[str, Any], + handler: Callable, + secure: bool = True, + fillers: Optional[Dict[str, List[str]]] = None, + wait_file: Optional[str] = None, + wait_file_loops: Optional[int] = None, + webhook_url: Optional[str] = None, + required: Optional[List[str]] = None, + is_typed_handler: bool = False, + **swaig_fields = {} +) -> None +``` + +## Parameters + + + Function name (must be unique) + + + + Function description for the AI + + + + JSON Schema of parameters + + + + Function to call when invoked + + + + Whether to require token validation + + + + Optional dict mapping language codes to arrays of filler phrases (deprecated) + + + + Optional URL to audio file to play while function executes + + + + Optional number of times to loop the wait\_file + + + + Optional external webhook URL to use instead of local handling + + + + Optional list of required parameter names + + + + Whether the handler uses type-hinted parameters + + + + +## Returns + +`None` + +## Throws + +- `ValueError` — If tool name already exists + +## Source + +[`signalwire/signalwire/core/agent/tools/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py) + +Line 35. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/get-all-functions.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/get-all-functions.mdx new file mode 100644 index 0000000000..31f07b3d26 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/get-all-functions.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/registry/tool-registry/get-all-functions" +title: "get_all_functions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.tools.registry.ToolRegistry.get_all_functions" + parent: "signalwire.core.agent.tools.registry.ToolRegistry" + module: "signalwire.core.agent.tools.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py" +--- +# `get_all_functions` + +Get all registered functions. + +## Signature + +```python +get_all_functions() -> Dict[str, Union[SWAIGFunction, Dict[str, Any]]] +``` + +## Returns + +`Dict[str, Union[SWAIGFunction, Dict[str, Any]]]` — Dictionary of function name to function object/dict + +## Source + +[`signalwire/signalwire/core/agent/tools/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py) + +Line 204. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/get-function.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/get-function.mdx new file mode 100644 index 0000000000..ab3e58831b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/get-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/registry/tool-registry/get-function" +title: "get_function" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.tools.registry.ToolRegistry.get_function" + parent: "signalwire.core.agent.tools.registry.ToolRegistry" + module: "signalwire.core.agent.tools.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py" +--- +# `get_function` + +Get a registered function by name. + +## Signature + +```python +get_function(name: str) -> Optional[Union[SWAIGFunction, Dict[str, Any]]] +``` + +## Parameters + + + Function name + + +## Returns + +`Optional[Union[SWAIGFunction, Dict[str, Any]]]` — SWAIGFunction instance or raw function dict, or None if not found + +## Source + +[`signalwire/signalwire/core/agent/tools/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py) + +Line 192. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/has-function.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/has-function.mdx new file mode 100644 index 0000000000..d5942e414c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/has-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/registry/tool-registry/has-function" +title: "has_function" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.tools.registry.ToolRegistry.has_function" + parent: "signalwire.core.agent.tools.registry.ToolRegistry" + module: "signalwire.core.agent.tools.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py" +--- +# `has_function` + +Check if a function is registered. + +## Signature + +```python +has_function(name: str) -> bool +``` + +## Parameters + + + Function name + + +## Returns + +`bool` — True if function exists, False otherwise + +## Source + +[`signalwire/signalwire/core/agent/tools/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py) + +Line 213. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/index.mdx new file mode 100644 index 0000000000..48e034fc6e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/registry/tool-registry" +title: "ToolRegistry" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.agent.tools.registry.ToolRegistry" + parent: "signalwire.core.agent.tools.registry" + module: "signalwire.core.agent.tools.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py" +--- +# `ToolRegistry` + +Manages SWAIG function registration. + +## Signature + +```python +class ToolRegistry +``` + +## Properties + + + +## Methods + + + + Initialize ToolRegistry with reference to parent agent. + + + + Define a SWAIG function that the AI can call. + + + + Get all registered functions. + + + + Get a registered function by name. + + + + Check if a function is registered. + + + + Register tools defined with @AgentBase.tool class decorator. + + + + Register a raw SWAIG function dictionary (e.g., from DataMap.to\_swaig\_function()). + + + + Remove a registered function. + + + +## Source + +[`signalwire/signalwire/core/agent/tools/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py) + +Line 21. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/init.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/init.mdx new file mode 100644 index 0000000000..e4c8094e78 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/registry/tool-registry/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.tools.registry.ToolRegistry.__init__" + parent: "signalwire.core.agent.tools.registry.ToolRegistry" + module: "signalwire.core.agent.tools.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py" +--- +# `__init__` + +Initialize ToolRegistry with reference to parent agent. + +## Signature + +```python +__init__(agent) +``` + +## Parameters + + + Parent AgentBase instance + + +## Source + +[`signalwire/signalwire/core/agent/tools/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py) + +Line 24. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/register-class-decorated-tools.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/register-class-decorated-tools.mdx new file mode 100644 index 0000000000..a9298f1f08 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/register-class-decorated-tools.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/registry/tool-registry/register-class-decorated-tools" +title: "register_class_decorated_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.tools.registry.ToolRegistry.register_class_decorated_tools" + parent: "signalwire.core.agent.tools.registry.ToolRegistry" + module: "signalwire.core.agent.tools.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py" +--- +# `register_class_decorated_tools` + +Register tools defined with @AgentBase.tool class decorator. + +This method scans the class for methods decorated with @AgentBase.tool +and registers them automatically. If parameters are not explicitly +provided and the function has type-hinted parameters, the schema +is inferred from the type hints. + +## Signature + +```python +register_class_decorated_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/agent/tools/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py) + +Line 116. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/register-swaig-function.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/register-swaig-function.mdx new file mode 100644 index 0000000000..c8383265d6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/register-swaig-function.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/registry/tool-registry/register-swaig-function" +title: "register_swaig_function" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.tools.registry.ToolRegistry.register_swaig_function" + parent: "signalwire.core.agent.tools.registry.ToolRegistry" + module: "signalwire.core.agent.tools.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py" +--- +# `register_swaig_function` + +Register a raw SWAIG function dictionary (e.g., from DataMap.to\_swaig\_function()). + +## Signature + +```python +register_swaig_function(function_dict: Dict[str, Any]) -> None +``` + +## Parameters + + + Complete SWAIG function definition dictionary + + +## Returns + +`None` + +## Throws + +- `ValueError` — If function name missing or already exists + +## Source + +[`signalwire/signalwire/core/agent/tools/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py) + +Line 90. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/remove-function.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/remove-function.mdx new file mode 100644 index 0000000000..84d5bd7f7c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/registry/tool-registry/remove-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/registry/tool-registry/remove-function" +title: "remove_function" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.agent.tools.registry.ToolRegistry.remove_function" + parent: "signalwire.core.agent.tools.registry.ToolRegistry" + module: "signalwire.core.agent.tools.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py" +--- +# `remove_function` + +Remove a registered function. + +## Signature + +```python +remove_function(name: str) -> bool +``` + +## Parameters + + + Function name + + +## Returns + +`bool` — True if removed, False if not found + +## Source + +[`signalwire/signalwire/core/agent/tools/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/registry.py) + +Line 225. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/type-inference/create-typed-handler-wrapper.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/type-inference/create-typed-handler-wrapper.mdx new file mode 100644 index 0000000000..4dc384a3cb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/type-inference/create-typed-handler-wrapper.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/type-inference/create-typed-handler-wrapper" +title: "create_typed_handler_wrapper" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.agent.tools.type_inference.create_typed_handler_wrapper" + parent: "signalwire.core.agent.tools.type_inference" + module: "signalwire.core.agent.tools.type_inference" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/type_inference.py" +--- +# `create_typed_handler_wrapper` + +Wrap a typed handler function so it can be called with the standard +SWAIG calling convention (args\_dict, raw\_data). + +The wrapper unpacks the args dict into keyword arguments for the +original function. + +## Signature + +```python +create_typed_handler_wrapper(func, has_raw_data: bool) +``` + +## Parameters + + + The original typed handler function. + + + + If True, pass raw\_data as a keyword argument. + + +## Returns + +A wrapper function with signature (args, raw\_data). + +## Source + +[`signalwire/signalwire/core/agent/tools/type_inference.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/type_inference.py) + +Line 248. diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/type-inference/index.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/type-inference/index.mdx new file mode 100644 index 0000000000..82590cdbb2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/type-inference/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/type-inference" +title: "type_inference" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.agent.tools.type_inference" + parent: "signalwire.core.agent.tools" + module: "signalwire.core.agent.tools" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/type_inference.py" +--- +# `type_inference` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module type_inference +``` + +## Functions + + + + Wrap a typed handler function so it can be called with the standard SWAIG calling convention (args\_dict, raw\_data). + + + + Inspect a function's signature and type hints to infer a JSON Schema for SWAIG tool parameters. + + + +## Source + +[`signalwire/signalwire/core/agent/tools/type_inference.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/type_inference.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/agent/tools/type-inference/infer-schema.mdx b/fern/products/sdk-reference/python/signalwire/core/agent/tools/type-inference/infer-schema.mdx new file mode 100644 index 0000000000..6439cdcaa1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/agent/tools/type-inference/infer-schema.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/agent/tools/type-inference/infer-schema" +title: "infer_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.agent.tools.type_inference.infer_schema" + parent: "signalwire.core.agent.tools.type_inference" + module: "signalwire.core.agent.tools.type_inference" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/type_inference.py" +--- +# `infer_schema` + +Inspect a function's signature and type hints to infer a JSON Schema +for SWAIG tool parameters. + +## Signature + +```python +infer_schema( + func +) -> Tuple[Dict[str, Dict], List[str], Optional[str], bool, bool] +``` + +## Parameters + + + The function to inspect. + + +## Returns + +`Tuple[Dict[str, Dict], List[str], Optional[str], bool, bool]` — A tuple of (parameters, required, description, is\_typed, has\_raw\_data): - parameters: dict mapping parameter names to JSON Schema property dicts - required: list of required parameter names - description: tool description from docstring (or None) - is\_typed: True if the function uses typed parameters (new style) - has\_raw\_data: True if the function accepts a `raw_data` parameter + +## Source + +[`signalwire/signalwire/core/agent/tools/type_inference.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/agent/tools/type_inference.py) + +Line 147. diff --git a/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/flask-decorator.mdx b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/flask-decorator.mdx new file mode 100644 index 0000000000..195281cc26 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/flask-decorator.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/auth-handler/auth-handler/flask-decorator" +title: "flask_decorator" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.auth_handler.AuthHandler.flask_decorator" + parent: "signalwire.core.auth_handler.AuthHandler" + module: "signalwire.core.auth_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py" +--- +# `flask_decorator` + +Flask decorator for authentication. + +This provides compatibility with Flask-based services like MCP Gateway. + +## Signature + +```python +flask_decorator(f: Callable) -> Callable +``` + +## Parameters + + + +## Returns + +`Callable` + +## Source + +[`signalwire/signalwire/core/auth_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py) + +Line 160. diff --git a/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/get-auth-info.mdx b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/get-auth-info.mdx new file mode 100644 index 0000000000..37e04c564c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/get-auth-info.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/auth-handler/auth-handler/get-auth-info" +title: "get_auth_info" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.auth_handler.AuthHandler.get_auth_info" + parent: "signalwire.core.auth_handler.AuthHandler" + module: "signalwire.core.auth_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py" +--- +# `get_auth_info` + +Get information about configured auth methods + +## Signature + +```python +get_auth_info() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/core/auth_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py) + +Line 209. diff --git a/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/get-fastapi-dependency.mdx b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/get-fastapi-dependency.mdx new file mode 100644 index 0000000000..c0c0dbbc83 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/get-fastapi-dependency.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/auth-handler/auth-handler/get-fastapi-dependency" +title: "get_fastapi_dependency" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.auth_handler.AuthHandler.get_fastapi_dependency" + parent: "signalwire.core.auth_handler.AuthHandler" + module: "signalwire.core.auth_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py" +--- +# `get_fastapi_dependency` + +Get FastAPI dependency for authentication. + +## Signature + +```python +get_fastapi_dependency(optional: bool = False) +``` + +## Parameters + + + If True, authentication is optional + + +## Returns + +FastAPI dependency function + +## Source + +[`signalwire/signalwire/core/auth_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py) + +Line 114. diff --git a/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/index.mdx b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/index.mdx new file mode 100644 index 0000000000..a422d00614 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/python/signalwire/core/auth-handler/auth-handler" +title: "AuthHandler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.auth_handler.AuthHandler" + parent: "signalwire.core.auth_handler" + module: "signalwire.core.auth_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py" +--- +# `AuthHandler` + +Unified authentication handler supporting multiple auth methods. + +This class provides a clean pattern for handling Basic Auth, Bearer tokens, +and API keys across all SignalWire services. + +## Signature + +```python +class AuthHandler +``` + +## Properties + + + + + + + +## Methods + + + + Initialize auth handler with security configuration. + + + + Flask decorator for authentication. + + + + Get information about configured auth methods + + + + Get FastAPI dependency for authentication. + + + + Verify API key + + + + Verify basic auth credentials + + + + Verify bearer token + + + +## Source + +[`signalwire/signalwire/core/auth_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py) + +Line 30. diff --git a/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/init.mdx b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/init.mdx new file mode 100644 index 0000000000..806fb94e33 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/core/auth-handler/auth-handler/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.auth_handler.AuthHandler.__init__" + parent: "signalwire.core.auth_handler.AuthHandler" + module: "signalwire.core.auth_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py" +--- +# `__init__` + +Initialize auth handler with security configuration. + +## Signature + +```python +__init__(security_config: SecurityConfig) +``` + +## Parameters + + + SecurityConfig instance with auth settings + + +## Source + +[`signalwire/signalwire/core/auth_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py) + +Line 38. diff --git a/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/verify-api-key.mdx b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/verify-api-key.mdx new file mode 100644 index 0000000000..0f0e41d31a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/verify-api-key.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/core/auth-handler/auth-handler/verify-api-key" +title: "verify_api_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.auth_handler.AuthHandler.verify_api_key" + parent: "signalwire.core.auth_handler.AuthHandler" + module: "signalwire.core.auth_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py" +--- +# `verify_api_key` + +Verify API key + +## Signature + +```python +verify_api_key(api_key: str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/core/auth_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py) + +Line 106. diff --git a/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/verify-basic-auth.mdx b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/verify-basic-auth.mdx new file mode 100644 index 0000000000..d698be557e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/verify-basic-auth.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/core/auth-handler/auth-handler/verify-basic-auth" +title: "verify_basic_auth" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.auth_handler.AuthHandler.verify_basic_auth" + parent: "signalwire.core.auth_handler.AuthHandler" + module: "signalwire.core.auth_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py" +--- +# `verify_basic_auth` + +Verify basic auth credentials + +## Signature + +```python +verify_basic_auth(credentials: HTTPBasicCredentials) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/core/auth_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py) + +Line 81. diff --git a/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/verify-bearer-token.mdx b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/verify-bearer-token.mdx new file mode 100644 index 0000000000..48fbf220a1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/auth-handler/auth-handler/verify-bearer-token.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/core/auth-handler/auth-handler/verify-bearer-token" +title: "verify_bearer_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.auth_handler.AuthHandler.verify_bearer_token" + parent: "signalwire.core.auth_handler.AuthHandler" + module: "signalwire.core.auth_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py" +--- +# `verify_bearer_token` + +Verify bearer token + +## Signature + +```python +verify_bearer_token(credentials: HTTPAuthorizationCredentials) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/core/auth_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py) + +Line 96. diff --git a/fern/products/sdk-reference/python/signalwire/core/auth-handler/index.mdx b/fern/products/sdk-reference/python/signalwire/core/auth-handler/index.mdx new file mode 100644 index 0000000000..49dbfeb31e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/auth-handler/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/auth-handler" +title: "auth_handler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.auth_handler" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py" +--- +# `auth_handler` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module auth_handler +``` + +## Properties + + + +## Classes + + + + Unified authentication handler supporting multiple auth methods. + + + +## Source + +[`signalwire/signalwire/core/auth_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/auth_handler.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/find-config-file.mdx b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/find-config-file.mdx new file mode 100644 index 0000000000..28aa7ecd65 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/find-config-file.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/core/config-loader/config-loader/find-config-file" +title: "find_config_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.config_loader.ConfigLoader.find_config_file" + parent: "signalwire.core.config_loader.ConfigLoader" + module: "signalwire.core.config_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py" +--- +# `find_config_file` + +Static method to find a config file for a service. + +**Modifiers:** `static` + +## Signature + +```python +@staticmethod +find_config_file( + service_name: Optional[str] = None, + additional_paths: Optional[List[str]] = None +) -> Optional[str] +``` + +## Parameters + + + Optional service name for service-specific config + + + + Additional paths to check + + +## Returns + +`Optional[str]` — Path to the first config file found, or None + +## Source + +[`signalwire/signalwire/core/config_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py) + +Line 224. diff --git a/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get-config-file.mdx b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get-config-file.mdx new file mode 100644 index 0000000000..485bbc196f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get-config-file.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/config-loader/config-loader/get-config-file" +title: "get_config_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.config_loader.ConfigLoader.get_config_file" + parent: "signalwire.core.config_loader.ConfigLoader" + module: "signalwire.core.config_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py" +--- +# `get_config_file` + +Get the path of the loaded config file. + +## Signature + +```python +get_config_file() -> Optional[str] +``` + +## Returns + +`Optional[str]` + +## Source + +[`signalwire/signalwire/core/config_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py) + +Line 69. diff --git a/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get-config.mdx b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get-config.mdx new file mode 100644 index 0000000000..dd4faf8daa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get-config.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/config-loader/config-loader/get-config" +title: "get_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.config_loader.ConfigLoader.get_config" + parent: "signalwire.core.config_loader.ConfigLoader" + module: "signalwire.core.config_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py" +--- +# `get_config` + +Get the raw configuration (before substitution). + +## Signature + +```python +get_config() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/core/config_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py) + +Line 73. diff --git a/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get-section.mdx b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get-section.mdx new file mode 100644 index 0000000000..31db7033bb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/config-loader/config-loader/get-section" +title: "get_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.config_loader.ConfigLoader.get_section" + parent: "signalwire.core.config_loader.ConfigLoader" + module: "signalwire.core.config_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py" +--- +# `get_section` + +Get an entire configuration section. + +## Signature + +```python +get_section(section: str) -> Dict[str, Any] +``` + +## Parameters + + + The section name (e.g., "security", "server") + + +## Returns + +`Dict[str, Any]` — The configuration section with all variables substituted + +## Source + +[`signalwire/signalwire/core/config_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py) + +Line 156. diff --git a/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get.mdx b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get.mdx new file mode 100644 index 0000000000..801e55a557 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/config-loader/config-loader/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.config_loader.ConfigLoader.get" + parent: "signalwire.core.config_loader.ConfigLoader" + module: "signalwire.core.config_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py" +--- +# `get` + +Get a configuration value by dot-notation path. + +## Signature + +```python +get(key_path: str, default: Any = None) -> Any +``` + +## Parameters + + + Dot-separated path (e.g., "security.ssl\_enabled") + + + + Default value if path not found + + +## Returns + +`Any` — The configuration value with variables substituted + +## Source + +[`signalwire/signalwire/core/config_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py) + +Line 129. diff --git a/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/has-config.mdx b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/has-config.mdx new file mode 100644 index 0000000000..1dc34a4d4a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/has-config.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/config-loader/config-loader/has-config" +title: "has_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.config_loader.ConfigLoader.has_config" + parent: "signalwire.core.config_loader.ConfigLoader" + module: "signalwire.core.config_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py" +--- +# `has_config` + +Check if a configuration was loaded. + +## Signature + +```python +has_config() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/core/config_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py) + +Line 65. diff --git a/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/index.mdx b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/index.mdx new file mode 100644 index 0000000000..06b8deeb3b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/python/signalwire/core/config-loader/config-loader" +title: "ConfigLoader" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.config_loader.ConfigLoader" + parent: "signalwire.core.config_loader" + module: "signalwire.core.config_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py" +--- +# `ConfigLoader` + +Configuration loader with environment variable substitution. + +Supports $\{VAR|default\} syntax for referencing environment variables +within JSON configuration files. This provides a clean pattern for +configuration across all SignalWire services. + +## Signature + +```python +class ConfigLoader +``` + +## Properties + + + +## Methods + + + + Initialize config loader. + + + + Static method to find a config file for a service. + + + + Get a configuration value by dot-notation path. + + + + Get the raw configuration (before substitution). + + + + Get the path of the loaded config file. + + + + Get an entire configuration section. + + + + Check if a configuration was loaded. + + + + Merge configuration with environment variables. + + + + Recursively substitute environment variables in configuration values. + + + +## Source + +[`signalwire/signalwire/core/config_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py) + +Line 19. diff --git a/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/init.mdx b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/init.mdx new file mode 100644 index 0000000000..7da32888a3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/core/config-loader/config-loader/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.config_loader.ConfigLoader.__init__" + parent: "signalwire.core.config_loader.ConfigLoader" + module: "signalwire.core.config_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py" +--- +# `__init__` + +Initialize config loader. + +## Signature + +```python +__init__(config_paths: Optional[List[str]] = None) +``` + +## Parameters + + + Optional list of config file paths to check. If not provided, uses default search paths. + + +## Source + +[`signalwire/signalwire/core/config_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py) + +Line 28. diff --git a/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/merge-with-env.mdx b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/merge-with-env.mdx new file mode 100644 index 0000000000..a6be7ca7af --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/merge-with-env.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/config-loader/config-loader/merge-with-env" +title: "merge_with_env" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.config_loader.ConfigLoader.merge_with_env" + parent: "signalwire.core.config_loader.ConfigLoader" + module: "signalwire.core.config_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py" +--- +# `merge_with_env` + +Merge configuration with environment variables. + +Config file takes precedence over environment variables, +but config can reference env vars via substitution. + +## Signature + +```python +merge_with_env(env_prefix: str = 'SWML_') -> Dict[str, Any] +``` + +## Parameters + + + Prefix for environment variables to consider + + +## Returns + +`Dict[str, Any]` — Merged configuration dictionary + +## Source + +[`signalwire/signalwire/core/config_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py) + +Line 171. diff --git a/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/substitute-vars.mdx b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/substitute-vars.mdx new file mode 100644 index 0000000000..709f76e0f1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/config-loader/config-loader/substitute-vars.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/core/config-loader/config-loader/substitute-vars" +title: "substitute_vars" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.config_loader.ConfigLoader.substitute_vars" + parent: "signalwire.core.config_loader.ConfigLoader" + module: "signalwire.core.config_loader" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py" +--- +# `substitute_vars` + +Recursively substitute environment variables in configuration values. + +Supports $\{VAR|default\} syntax where: + +- VAR is the environment variable name +- default is the fallback value if VAR is not set + +## Signature + +```python +substitute_vars(value: Any, max_depth: int = 10) -> Any +``` + +## Parameters + + + The value to process (can be string, dict, list, etc.) + + + + Maximum recursion depth to prevent infinite loops + + +## Returns + +`Any` — The value with all environment variables substituted + +## Source + +[`signalwire/signalwire/core/config_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py) + +Line 77. diff --git a/fern/products/sdk-reference/python/signalwire/core/config-loader/index.mdx b/fern/products/sdk-reference/python/signalwire/core/config-loader/index.mdx new file mode 100644 index 0000000000..dbd08f61ea --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/config-loader/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/config-loader" +title: "config_loader" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.config_loader" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py" +--- +# `config_loader` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module config_loader +``` + +## Properties + + + +## Classes + + + + Configuration loader with environment variable substitution. + + + +## Source + +[`signalwire/signalwire/core/config_loader.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/config_loader.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/add-context.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/add-context.mdx new file mode 100644 index 0000000000..10826065ba --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/add-context.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context-builder/add-context" +title: "add_context" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.ContextBuilder.add_context" + parent: "signalwire.core.contexts.ContextBuilder" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_context` + +Add a new context + +## Signature + +```python +add_context(name: str) -> Context +``` + +## Parameters + + + Context name + + +## Returns + +`Context` — Context object for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 1182. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/get-context.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/get-context.mdx new file mode 100644 index 0000000000..f59a3aa45f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/get-context.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context-builder/get-context" +title: "get_context" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.ContextBuilder.get_context" + parent: "signalwire.core.contexts.ContextBuilder" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `get_context` + +Get an existing context by name for inspection or modification. + +## Signature + +```python +get_context(name: str) -> Optional[Context] +``` + +## Parameters + + + Context name + + +## Returns + +`Optional[Context]` — Context object if found, None otherwise + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 1203. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/index.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/index.mdx new file mode 100644 index 0000000000..27a6a1863c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/index.mdx @@ -0,0 +1,100 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context-builder" +title: "ContextBuilder" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.contexts.ContextBuilder" + parent: "signalwire.core.contexts" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `ContextBuilder` + +Builder for multi-step, multi-context AI agent workflows. + +A ContextBuilder owns one or more Contexts; each Context owns an ordered +list of Steps. Only one context and one step is active at a time. Per +chat turn, the runtime injects the current step's instructions as a +system message, then asks the LLM for a response. + +## Native tools auto-injected by the runtime + +When a step (or its enclosing context) declares `valid_steps` or +`valid_contexts`, the runtime auto-injects two native tools so the model +can navigate the flow: + +- `next_step(step: enum)` — present when valid\_steps is set +- `change_context(context: enum)` — present when valid\_contexts is set + +Their `enum` schemas are rewritten on every turn to match whatever +valid\_steps / valid\_contexts apply to the current step. You do NOT need +to define these tools yourself; they appear automatically. + +A third native tool — `gather_submit` — is injected during gather\_info +questioning (see Step.set\_gather\_info / add\_gather\_question). + +These three names — `next_step`, `change_context`, `gather_submit` +— are reserved. ContextBuilder.validate() will reject any agent that +defines a SWAIG tool with one of these names. + +## Function whitelisting (Step.set\_functions) + +Each step may declare a `functions` whitelist. The whitelist is applied +in-memory at the start of each LLM turn. CRITICALLY: if a step does NOT +declare a `functions` field, it INHERITS the previous step's active set. +See Step.set\_functions() for details and examples. + +## Validation + +Call validate() (or to\_dict(), which calls it) to check that: + +- At least one context is defined +- A single context must be named "default" +- Every context has at least one step +- valid\_steps references resolve to real step names (or "next") +- valid\_contexts references resolve to real context names +- gather\_info questions are non-empty and have unique keys +- gather\_info completion\_action targets a reachable step +- No user-defined SWAIG tool collides with a reserved native name + +## Signature + +```python +class ContextBuilder +``` + +## Methods + + + + + + Add a new context + + + + Get an existing context by name for inspection or modification. + + + + Remove all contexts, returning the builder to its initial state. + + + + Convert all contexts to dictionary for SWML generation + + + + Validate the contexts configuration + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 1105. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/init.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/init.mdx new file mode 100644 index 0000000000..fca0fff7c9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context-builder/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.ContextBuilder.__init__" + parent: "signalwire.core.contexts.ContextBuilder" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `__init__` + +## Signature + +```python +__init__(agent) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 1154. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/reset.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/reset.mdx new file mode 100644 index 0000000000..f010a88afd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/reset.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context-builder/reset" +title: "reset" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.ContextBuilder.reset" + parent: "signalwire.core.contexts.ContextBuilder" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `reset` + +Remove all contexts, returning the builder to its initial state. + +Use this in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request — e.g. skipping a +greeting context on transfers. + +Example:: + +``` +def on_dynamic_config(query, body, headers, agent): + if query.get("transfer"): + agent.define_contexts().reset() + ctx = agent.define_contexts().add_context("default") + ctx.add_step("route").set_text("Route the caller.") +``` + +## Signature + +```python +reset() -> ContextBuilder +``` + +## Returns + +`ContextBuilder` — Self for method chaining. + +## Examples + +```python +def on_dynamic_config(query, body, headers, agent): + if query.get("transfer"): + agent.define_contexts().reset() + ctx = agent.define_contexts().add_context("default") + ctx.add_step("route").set_text("Route the caller.") +``` + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 1159. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/to-dict.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/to-dict.mdx new file mode 100644 index 0000000000..f780521e0c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context-builder/to-dict" +title: "to_dict" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.ContextBuilder.to_dict" + parent: "signalwire.core.contexts.ContextBuilder" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `to_dict` + +Convert all contexts to dictionary for SWML generation + +## Signature + +```python +to_dict() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 1339. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/validate.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/validate.mdx new file mode 100644 index 0000000000..692c1ff254 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context-builder/validate.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context-builder/validate" +title: "validate" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.ContextBuilder.validate" + parent: "signalwire.core.contexts.ContextBuilder" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `validate` + +Validate the contexts configuration + +## Signature + +```python +validate() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 1215. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-bullets.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-bullets.mdx new file mode 100644 index 0000000000..1158175961 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-bullets.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/add-bullets" +title: "add_bullets" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.add_bullets" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_bullets` + +Add a POM section with bullet points to the context prompt + +## Signature + +```python +add_bullets(title: str, bullets: List[str]) -> Context +``` + +## Parameters + + + Section title + + + + List of bullet points + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 916. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-enter-filler.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-enter-filler.mdx new file mode 100644 index 0000000000..690ce8117d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-enter-filler.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/add-enter-filler" +title: "add_enter_filler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.add_enter_filler" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_enter_filler` + +Add enter fillers for a specific language + +## Signature + +```python +add_enter_filler(language_code: str, fillers: List[str]) -> Context +``` + +## Parameters + + + Language code (e.g., "en-US", "es") or "default" for catch-all + + + + List of filler phrases for entering this context + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 962. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-exit-filler.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-exit-filler.mdx new file mode 100644 index 0000000000..c034aa84e2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-exit-filler.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/add-exit-filler" +title: "add_exit_filler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.add_exit_filler" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_exit_filler` + +Add exit fillers for a specific language + +## Signature + +```python +add_exit_filler(language_code: str, fillers: List[str]) -> Context +``` + +## Parameters + + + Language code (e.g., "en-US", "es") or "default" for catch-all + + + + List of filler phrases for exiting this context + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 979. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-section.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-section.mdx new file mode 100644 index 0000000000..448e4ca881 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-section.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/add-section" +title: "add_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.add_section" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_section` + +Add a POM section to the context prompt + +## Signature + +```python +add_section(title: str, body: str) -> Context +``` + +## Parameters + + + Section title + + + + Section body text + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 900. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-step.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-step.mdx new file mode 100644 index 0000000000..e7d72faa1d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-step.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/add-step" +title: "add_step" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.add_step" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_step` + +Add a new step to this context. + +When called with only `name` the returned Step can be configured +with the usual method-chaining API. When the optional keyword +arguments are supplied the step is fully configured in one call: + +## Signature + +```python +add_step( + name: str, + *, + task: Optional[str] = None, + bullets: Optional[List[str]] = None, + criteria: Optional[str] = None, + functions: Optional[Union[str, List[str]]] = None, + valid_steps: Optional[List[str]] = None +) -> Step +``` + +## Parameters + + + Step name (must be unique within the context). + + + + Text for the "Task" section (equivalent to `step.add_section("Task", task)`). + + + + List of bullet strings for the "Process" section (equivalent to `step.add_bullets("Process", bullets)`). Requires _task_ to also be set. + + + + Step-completion criteria (equivalent to `step.set_step_criteria(criteria)`). + + + + Tool names the step may call, or `"none"` (equivalent to `step.set_functions(functions)`). + + + + Names of steps the agent may transition to (equivalent to `step.set_valid_steps(valid_steps)`). + + +## Returns + +`Step` — The configured Step object for optional further chaining. + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 596. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-system-bullets.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-system-bullets.mdx new file mode 100644 index 0000000000..16a2f7df81 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-system-bullets.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/add-system-bullets" +title: "add_system_bullets" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.add_system_bullets" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_system_bullets` + +Add a POM section with bullet points to the system prompt + +## Signature + +```python +add_system_bullets(title: str, bullets: List[str]) -> Context +``` + +## Parameters + + + Section title + + + + List of bullet points + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 869. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-system-section.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-system-section.mdx new file mode 100644 index 0000000000..3e96ed3af0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/add-system-section.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/add-system-section" +title: "add_system_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.add_system_section" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_system_section` + +Add a POM section to the system prompt + +## Signature + +```python +add_system_section(title: str, body: str) -> Context +``` + +## Parameters + + + Section title + + + + Section body text + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 853. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/get-step.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/get-step.mdx new file mode 100644 index 0000000000..0f18a81008 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/get-step.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/get-step" +title: "get_step" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.get_step" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `get_step` + +Get an existing step by name for inspection or modification. + +## Signature + +```python +get_step(name: str) -> Optional[Step] +``` + +## Parameters + + + Step name + + +## Returns + +`Optional[Step]` — Step object if found, None otherwise + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 653. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/index.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/index.mdx new file mode 100644 index 0000000000..336613d53f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/index.mdx @@ -0,0 +1,160 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context" +title: "Context" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.contexts.Context" + parent: "signalwire.core.contexts" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `Context` + +A single context containing an ordered list of steps. + +## Conversation history across context switches + +By default (`isolated=False`), switching from one context to another +via `change_context` PRESERVES the entire conversation history. The +user's prior turns and the model's prior responses remain visible +on the next LLM call. The only thing that changes is which step +instructions get injected. + +A common confusion: "the AI re-asked for information the user already +gave." If you see this, history loss is almost never the cause — +history is preserved unless you set `isolated=True`. The real cause +is usually one of: + +- The destination step's `text` literally tells the model to ask + ("Ask the user for their account number"). The model follows + instructions; rephrase to "Confirm the user's account number" + or have the step instructions check global\_data first. +- The relevant info was never extracted into global\_data, so + $\{var\} expansion has nothing to inject and the step prompt + looks generic. Add a webhook that captures the field. +- You explicitly called `set_isolated(True)` on the destination + context. Isolated contexts wipe the conversation array on entry. + Pair with `set_consolidate(True)` if you want a summary instead. + +See Context.set\_isolated() for the wipe semantics, and the SDK's +FunctionResult.swml\_change\_step / swml\_change\_context docstrings +for how to communicate transition intent through tool response text +and global\_data. + +## Signature + +```python +class Context +``` + +## Properties + + + +## Methods + + + + + + Add a POM section with bullet points to the context prompt + + + + Add enter fillers for a specific language + + + + Add exit fillers for a specific language + + + + Add a POM section to the context prompt + + + + Add a new step to this context. + + + + Add a POM section with bullet points to the system prompt + + + + Add a POM section to the system prompt + + + + Get an existing step by name for inspection or modification. + + + + Move an existing step to a specific position in the step order. + + + + Remove a step from this context entirely. + + + + Set whether to consolidate conversation history when entering this context + + + + Set fillers that the AI says when entering this context + + + + Set fillers that the AI says when exiting this context + + + + Set whether to do full reset when entering this context + + + + Set which step the context starts on when entered. + + + + Mark this context as isolated — entering it wipes conversation history. + + + + Set post prompt override for this context + + + + Set the context's prompt text directly + + + + Set system prompt for context switching (triggers context reset) + + + + Set user prompt to inject when entering this context + + + + Set which contexts can be navigated to from this context + + + + Set which steps can be navigated to from any step in this context + + + + Convert context to dictionary for SWML generation + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 538. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/init.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/init.mdx new file mode 100644 index 0000000000..67ef23d365 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.__init__" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `__init__` + +## Signature + +```python +__init__(name: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 571. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/move-step.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/move-step.mdx new file mode 100644 index 0000000000..7192bc42b9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/move-step.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/move-step" +title: "move_step" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.move_step" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `move_step` + +Move an existing step to a specific position in the step order. + +## Signature + +```python +move_step(name: str, position: int) -> Context +``` + +## Parameters + + + Step name to move + + + + Target index in the step order (0 = first) + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 680. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/remove-step.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/remove-step.mdx new file mode 100644 index 0000000000..b1c6203a1f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/remove-step.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/remove-step" +title: "remove_step" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.remove_step" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `remove_step` + +Remove a step from this context entirely. + +## Signature + +```python +remove_step(name: str) -> Context +``` + +## Parameters + + + Step name to remove + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 665. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-consolidate.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-consolidate.mdx new file mode 100644 index 0000000000..b975527312 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-consolidate.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-consolidate" +title: "set_consolidate" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_consolidate" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_consolidate` + +Set whether to consolidate conversation history when entering this context + +## Signature + +```python +set_consolidate(consolidate: bool) -> Context +``` + +## Parameters + + + Whether to consolidate previous conversation + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 781. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-enter-fillers.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-enter-fillers.mdx new file mode 100644 index 0000000000..74da7ac4ed --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-enter-fillers.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-enter-fillers" +title: "set_enter_fillers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_enter_fillers" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_enter_fillers` + +Set fillers that the AI says when entering this context + +## Signature + +```python +set_enter_fillers(enter_fillers: Dict[str, List[str]]) -> Context +``` + +## Parameters + + + Dictionary mapping language codes (or "default") to lists of filler phrases Example: \{"en-US": \["Welcome...", "Hello..."], "default": \["Entering..."]\} + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 932. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-exit-fillers.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-exit-fillers.mdx new file mode 100644 index 0000000000..149770d1ce --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-exit-fillers.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-exit-fillers" +title: "set_exit_fillers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_exit_fillers" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_exit_fillers` + +Set fillers that the AI says when exiting this context + +## Signature + +```python +set_exit_fillers(exit_fillers: Dict[str, List[str]]) -> Context +``` + +## Parameters + + + Dictionary mapping language codes (or "default") to lists of filler phrases Example: \{"en-US": \["Goodbye...", "Thank you..."], "default": \["Exiting..."]\} + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 947. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-full-reset.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-full-reset.mdx new file mode 100644 index 0000000000..554e7eb5fc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-full-reset.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-full-reset" +title: "set_full_reset" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_full_reset" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_full_reset` + +Set whether to do full reset when entering this context + +## Signature + +```python +set_full_reset(full_reset: bool) -> Context +``` + +## Parameters + + + Whether to completely rewrite system prompt vs inject + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 794. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-initial-step.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-initial-step.mdx new file mode 100644 index 0000000000..711843ff3b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-initial-step.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-initial-step" +title: "set_initial_step" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_initial_step" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_initial_step` + +Set which step the context starts on when entered. + +By default, a context starts on its first step (index 0). If the +context has a preamble step that should only run on first entry +(e.g. a greeting), later entries via `change_context` can skip +it by setting `initial_step` to the name of the step to start +from instead. + +`initial_step` is honoured both at conversation creation (when +the context is first activated) and when switching to this context +via `change_context` during the conversation. + +> \[!NOTE] +> ctx = contexts.add\_context("support") +> ctx.add\_step("greeting").set\_text("Welcome!") +> ctx.add\_step("triage").set\_text("What do you need help with?") +> ctx.set\_initial\_step("triage") # skip greeting on re-entry + +## Signature + +```python +set_initial_step(step_name: str) -> Context +``` + +## Parameters + + + Name of the step to start on. Must exist in this context's step list; validated by ContextBuilder.validate(). + + +## Returns + +`Context` — Self for method chaining. + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 723. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-isolated.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-isolated.mdx new file mode 100644 index 0000000000..f753512a28 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-isolated.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-isolated" +title: "set_isolated" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_isolated" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_isolated` + +Mark this context as isolated — entering it wipes conversation history. + +When `isolated=True` and the context is entered via change\_context, +the runtime calls ai\_conversation\_restart() and the entire conversation +array is wiped. The model starts fresh with only the new context's +system\_prompt + step instructions, with no memory of prior turns. + +EXCEPTION — `reset` overrides the wipe: +If the context also has a `reset` configuration (set via the +Step.set\_reset\_\*() methods on a step that switches into this +context, or via set\_consolidate() / set\_full\_reset() on the +context itself), the wipe is skipped in favor of the reset +behavior. Use `reset` with `consolidate=True` to summarize prior +history into a single message instead of dropping it entirely. + +> \[!NOTE] +> +> - Switching to a sensitive billing flow that should not see +> prior small-talk +> - Handing off to a different agent persona +> - Resetting after a long off-topic detour + +## Signature + +```python +set_isolated(isolated: bool) -> Context +``` + +## Parameters + + + True to wipe conversation history on context entry (subject to the reset exception above). + + +## Returns + +`Context` — Self for method chaining. + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 820. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-post-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-post-prompt.mdx new file mode 100644 index 0000000000..e2a40529a5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-post-prompt" +title: "set_post_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_post_prompt" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_post_prompt` + +Set post prompt override for this context + +## Signature + +```python +set_post_prompt(post_prompt: str) -> Context +``` + +## Parameters + + + Post prompt text to use when this context is active + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 753. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-prompt.mdx new file mode 100644 index 0000000000..fc7f91bd6e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-prompt" +title: "set_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_prompt" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_prompt` + +Set the context's prompt text directly + +## Signature + +```python +set_prompt(prompt: str) -> Context +``` + +## Parameters + + + The prompt text for this context + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 885. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-system-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-system-prompt.mdx new file mode 100644 index 0000000000..c9c629738b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-system-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-system-prompt" +title: "set_system_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_system_prompt" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_system_prompt` + +Set system prompt for context switching (triggers context reset) + +## Signature + +```python +set_system_prompt(system_prompt: str) -> Context +``` + +## Parameters + + + New system prompt for when this context is entered + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 766. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-user-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-user-prompt.mdx new file mode 100644 index 0000000000..c95326cd12 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-user-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-user-prompt" +title: "set_user_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_user_prompt" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_user_prompt` + +Set user prompt to inject when entering this context + +## Signature + +```python +set_user_prompt(user_prompt: str) -> Context +``` + +## Parameters + + + User message to inject for context + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 807. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-valid-contexts.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-valid-contexts.mdx new file mode 100644 index 0000000000..c5cb453638 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-valid-contexts.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-valid-contexts" +title: "set_valid_contexts" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_valid_contexts" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_valid_contexts` + +Set which contexts can be navigated to from this context + +## Signature + +```python +set_valid_contexts(contexts: List[str]) -> Context +``` + +## Parameters + + + List of valid context names + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 697. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-valid-steps.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-valid-steps.mdx new file mode 100644 index 0000000000..8671eb606f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/set-valid-steps.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/set-valid-steps" +title: "set_valid_steps" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.set_valid_steps" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_valid_steps` + +Set which steps can be navigated to from any step in this context + +## Signature + +```python +set_valid_steps(steps: List[str]) -> Context +``` + +## Parameters + + + List of valid step names (include "next" for sequential flow) + + +## Returns + +`Context` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 710. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/context/to-dict.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/context/to-dict.mdx new file mode 100644 index 0000000000..ee6feeaa64 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/context/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/contexts/context/to-dict" +title: "to_dict" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Context.to_dict" + parent: "signalwire.core.contexts.Context" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `to_dict` + +Convert context to dictionary for SWML generation + +## Signature + +```python +to_dict() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 1040. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/create-simple-context.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/create-simple-context.mdx new file mode 100644 index 0000000000..1474c07daa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/create-simple-context.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/create-simple-context" +title: "create_simple_context" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.contexts.create_simple_context" + parent: "signalwire.core.contexts" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `create_simple_context` + +Helper function to create a simple single context + +## Signature + +```python +create_simple_context(name: str = 'default') -> Context +``` + +## Parameters + + + Context name (defaults to "default") + + +## Returns + +`Context` — Context object for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 1350. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/add-question.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/add-question.mdx new file mode 100644 index 0000000000..9333fe4122 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/add-question.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/core/contexts/gather-info/add-question" +title: "add_question" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.GatherInfo.add_question" + parent: "signalwire.core.contexts.GatherInfo" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_question` + +Add a question to gather. + +## Signature + +```python +add_question(key: str, question: str, **kwargs = {}) -> GatherInfo +``` + +## Parameters + + + Key name for storing the answer in global\_data + + + + The question text to ask + + + + +## Returns + +`GatherInfo` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 67. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/index.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/index.mdx new file mode 100644 index 0000000000..a5692ccaa9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/core/contexts/gather-info" +title: "GatherInfo" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.contexts.GatherInfo" + parent: "signalwire.core.contexts" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `GatherInfo` + +Configuration for gathering information in a step via the C-side gather\_info system. + +This produces zero tool\_call/tool\_result entries in LLM-visible history, +instead using dynamic step instruction re-injection to present one question +at a time. + +## Signature + +```python +class GatherInfo +``` + +## Methods + + + + + + Add a question to gather. + + + + Convert to dictionary for SWML generation + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 51. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/init.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/init.mdx new file mode 100644 index 0000000000..b5e50de0ba --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/init.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/gather-info/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.GatherInfo.__init__" + parent: "signalwire.core.contexts.GatherInfo" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `__init__` + +## Signature + +```python +__init__( + output_key: Optional[str] = None, + completion_action: Optional[str] = None, + prompt: Optional[str] = None +) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 59. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/to-dict.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/to-dict.mdx new file mode 100644 index 0000000000..6601690964 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-info/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/contexts/gather-info/to-dict" +title: "to_dict" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.GatherInfo.to_dict" + parent: "signalwire.core.contexts.GatherInfo" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `to_dict` + +Convert to dictionary for SWML generation + +## Signature + +```python +to_dict() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 90. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/gather-question/index.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-question/index.mdx new file mode 100644 index 0000000000..b7ae4f211d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-question/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/python/signalwire/core/contexts/gather-question" +title: "GatherQuestion" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.contexts.GatherQuestion" + parent: "signalwire.core.contexts" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `GatherQuestion` + +Represents a single question in a gather\_info configuration + +## Signature + +```python +class GatherQuestion +``` + +## Properties + + + + + + + + + + + + + +## Methods + + + + + + Convert question to dictionary for SWML generation + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 24. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/gather-question/init.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-question/init.mdx new file mode 100644 index 0000000000..1daed79e41 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-question/init.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/core/contexts/gather-question/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.GatherQuestion.__init__" + parent: "signalwire.core.contexts.GatherQuestion" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `__init__` + +## Signature + +```python +__init__( + key: str, + question: str, + type: str = 'string', + confirm: bool = False, + prompt: Optional[str] = None, + functions: Optional[List[str]] = None +) +``` + +## Parameters + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 27. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/gather-question/to-dict.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-question/to-dict.mdx new file mode 100644 index 0000000000..81592c21d9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/gather-question/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/contexts/gather-question/to-dict" +title: "to_dict" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.GatherQuestion.to_dict" + parent: "signalwire.core.contexts.GatherQuestion" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `to_dict` + +Convert question to dictionary for SWML generation + +## Signature + +```python +to_dict() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 37. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/index.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/index.mdx new file mode 100644 index 0000000000..a5eb9417ee --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/python/signalwire/core/contexts" +title: "contexts" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.contexts" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `contexts` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module contexts +``` + +## Constants + + + + + + + +## Functions + + + + Helper function to create a simple single context + + + +## Classes + + + + A single context containing an ordered list of steps. + + + + Builder for multi-step, multi-context AI agent workflows. + + + + Configuration for gathering information in a step via the C-side gather\_info system. + + + + Represents a single question in a gather\_info configuration + + + + Represents a single step within a context + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/add-bullets.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/add-bullets.mdx new file mode 100644 index 0000000000..f73fe23222 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/add-bullets.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/add-bullets" +title: "add_bullets" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.add_bullets" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_bullets` + +Add a POM section with bullet points + +## Signature + +```python +add_bullets(title: str, bullets: List[str]) -> Step +``` + +## Parameters + + + Section title + + + + List of bullet points + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 163. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/add-gather-question.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/add-gather-question.mdx new file mode 100644 index 0000000000..2d04e16f10 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/add-gather-question.mdx @@ -0,0 +1,100 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/add-gather-question" +title: "add_gather_question" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.add_gather_question" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_gather_question` + +Add a question to this step's gather\_info configuration. +set\_gather\_info() must be called before this method. + +IMPORTANT — gather mode locks function access: +While the model is asking gather questions, the runtime forcibly +deactivates ALL of the step's other functions. The only callable +tools during a gather question are: + +``` + - `gather_submit` (the native answer-submission tool) + - Whatever names you list in this question's `functions` arg + +`next_step` and `change_context` are also filtered out — the model +cannot navigate away until the gather completes. This is by design: +it forces a tight ask → submit → next-question loop. + +If a question needs to call out to a tool (e.g. validate an email, +geocode a ZIP), list that tool name in this question's `functions`. +Functions listed here are active ONLY for this question. +``` + +## Signature + +```python +add_gather_question( + key: str, + question: str, + type: str = 'string', + confirm: bool = False, + prompt: Optional[str] = None, + functions: Optional[List[str]] = None +) -> Step +``` + +## Parameters + + + Key name for storing the answer in global\_data. + + + + The question text the model is instructed to ask. + + + + JSON schema type for the answer ("string", "integer", "number", "boolean"). Default: "string". + + + + If True, the model must read the answer back and obtain explicit user confirmation before submitting (the gather\_submit schema gains a required `confirmed_by_user` parameter). + + + + Extra instruction text appended after the question. + + + + Names of functions to unlock for this question only. These are activated on top of `gather_submit`. All other step functions remain locked out. + + +## Returns + +`Step` — Self for method chaining. + +## Examples + +```python + - `gather_submit` (the native answer-submission tool) + - Whatever names you list in this question's `functions` arg + +`next_step` and `change_context` are also filtered out — the model +cannot navigate away until the gather completes. This is by design: +it forces a tight ask → submit → next-question loop. + +If a question needs to call out to a tool (e.g. validate an email, +geocode a ZIP), list that tool name in this question's `functions`. +Functions listed here are active ONLY for this question. +``` + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 358. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/add-section.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/add-section.mdx new file mode 100644 index 0000000000..d2c4db2c16 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/add-section.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/add-section" +title: "add_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.add_section" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `add_section` + +Add a POM section to the step + +## Signature + +```python +add_section(title: str, body: str) -> Step +``` + +## Parameters + + + Section title + + + + Section body text + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 147. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/clear-sections.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/clear-sections.mdx new file mode 100644 index 0000000000..f811bc8f91 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/clear-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/clear-sections" +title: "clear_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.clear_sections" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `clear_sections` + +Remove all POM sections and direct text from this step, allowing it +to be repopulated with new content. + +## Signature + +```python +clear_sections() -> Step +``` + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 404. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/index.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/index.mdx new file mode 100644 index 0000000000..f3b23e2a06 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/index.mdx @@ -0,0 +1,111 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step" +title: "Step" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.contexts.Step" + parent: "signalwire.core.contexts" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `Step` + +Represents a single step within a context + +## Signature + +```python +class Step +``` + +## Properties + + + +## Methods + + + + + + Add a POM section with bullet points + + + + Add a question to this step's gather\_info configuration. set\_gather\_info() must be called before this method. + + + + Add a POM section to the step + + + + Remove all POM sections and direct text from this step, allowing it to be repopulated with new content. + + + + Mark this step as terminal for the step flow. + + + + Set which non-internal functions are callable while this step is active. + + + + Enable info gathering for this step. Questions are presented one at a time via dynamic step instruction re-injection, producing zero tool\_call/tool\_result entries in LLM-visible history. + + + + Set whether to consolidate conversation when this step switches contexts + + + + Set whether to do full reset when this step switches contexts + + + + Set system prompt for context switching when this step navigates to a context + + + + Set user prompt for context switching when this step navigates to a context + + + + Set whether to automatically advance to the next step + + + + Set whether to skip waiting for user input after this step + + + + Set the criteria for determining when this step is complete + + + + Set the step's prompt text directly + + + + Set which contexts can be navigated to from this step + + + + Set which steps can be navigated to from this step + + + + Convert step to dictionary for SWML generation + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 104. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/init.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/init.mdx new file mode 100644 index 0000000000..eeac4432f9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.__init__" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `__init__` + +## Signature + +```python +__init__(name: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 107. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-end.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-end.mdx new file mode 100644 index 0000000000..57ff5d7d73 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-end.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-end" +title: "set_end" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_end" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_end` + +Mark this step as terminal for the step flow. + +IMPORTANT: `end=True` does NOT end the conversation or hang up the +call. It exits step mode entirely after this step executes — clearing +the steps list, current step index, valid\_steps, and valid\_contexts. +The agent keeps running, but operates only under the base system +prompt and the context-level prompt; no more step instructions are +injected and no more `next_step` tool is offered. + +To actually end the call, call a hangup tool or define a hangup\_hook. + +Combine with `set_reset_*()` if you also want to reset/consolidate +the conversation when this step exits. + +## Signature + +```python +set_end(end: bool) -> Step +``` + +## Parameters + + + True to exit step mode after this step. + + +## Returns + +`Step` — Self for method chaining. + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 278. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-functions.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-functions.mdx new file mode 100644 index 0000000000..585726bac1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-functions.mdx @@ -0,0 +1,110 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-functions" +title: "set_functions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_functions" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_functions` + +Set which non-internal functions are callable while this step is active. + +IMPORTANT — keep the per-step active set small: +LLM tool selection accuracy degrades noticeably once the +per-call tool list grows past ~7-8 entries. Symptoms: the model +has the right tool available, the user's request clearly matches +it, but the model doesn't call it (or calls a near-neighbor +instead). Same prompt may pass on rerun. This is the LLM's +native tool-selection behavior — not something the SDK can fix. + +``` +Mitigations: + - Whitelist only the tools the current step actually needs. + A 4-tool step is more reliable than a 12-tool step. + - Split a busy step into two narrower steps so the relevant + tools are partitioned by phase of the conversation. + - Remember that `next_step` and `change_context` are + auto-injected when valid_steps / valid_contexts are set — + they count against the budget too. Don't list them in + `functions`; the runtime adds them separately. +``` + +IMPORTANT — inheritance behavior: +If you do NOT call this method, the step inherits whichever function +set was active on the previous step (or the previous context's last +step). The server-side runtime only resets the active set when a +step explicitly declares its `functions` field. This is by design, +but it is the most common source of bugs in multi-step agents: +forgetting set\_functions() on a later step lets the previous step's +tools leak through. + +``` +Best practice: call set_functions() explicitly on every step that +should have a different toolset than the previous one. +``` + +Internal functions (`startup_hook`, `hangup_hook`, `check_for_input`, +`summarize_conversation`, `gather_submit`, `get_ideal_strategy`) are +ALWAYS protected and cannot be deactivated by this whitelist. + +The native navigation tools `next_step` and `change_context` are +injected automatically when valid\_steps / valid\_contexts is set; they +are not affected by this list and do not need to appear in it. + +step.set\_functions(\["lookup\_account", "check\_balance"]) # whitelist +step.set\_functions(\[]) # disable all +step.set\_functions("none") # disable all (alt) + +## Signature + +```python +set_functions(functions: Union[str, List[str]]) -> Step +``` + +## Parameters + + + One of: + + +## Returns + +`Step` — Self for method chaining. + +## Examples + + + + ```python + Mitigations: + - Whitelist only the tools the current step actually needs. + A 4-tool step is more reliable than a 12-tool step. + - Split a busy step into two narrower steps so the relevant + tools are partitioned by phase of the conversation. + - Remember that `next_step` and `change_context` are + auto-injected when valid_steps / valid_contexts are set — + they count against the budget too. Don't list them in + `functions`; the runtime adds them separately. + ``` + + + + ```python + Best practice: call set_functions() explicitly on every step that + should have a different toolset than the previous one. + ``` + + + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 192. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-gather-info.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-gather-info.mdx new file mode 100644 index 0000000000..5a76b1f27c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-gather-info.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-gather-info" +title: "set_gather_info" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_gather_info" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_gather_info` + +Enable info gathering for this step. Questions are presented one at a time +via dynamic step instruction re-injection, producing zero tool\_call/tool\_result +entries in LLM-visible history. + +After calling this, use add\_gather\_question() to define questions. + +## Signature + +```python +set_gather_info( + output_key: Optional[str] = None, + completion_action: Optional[str] = None, + prompt: Optional[str] = None +) -> Step +``` + +## Parameters + + + Key in global\_data to store answers under (default: top-level) + + + + Where to go when all questions are answered. Can be: + + + + Preamble text injected once when entering the gather step, giving the model personality/context for why it is asking these questions + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 329. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-consolidate.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-consolidate.mdx new file mode 100644 index 0000000000..1e758825c9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-consolidate.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-reset-consolidate" +title: "set_reset_consolidate" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_reset_consolidate" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_reset_consolidate` + +Set whether to consolidate conversation when this step switches contexts + +## Signature + +```python +set_reset_consolidate(consolidate: bool) -> Step +``` + +## Parameters + + + Whether to consolidate previous conversation + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 442. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-full-reset.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-full-reset.mdx new file mode 100644 index 0000000000..6af3f06077 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-full-reset.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-reset-full-reset" +title: "set_reset_full_reset" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_reset_full_reset" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_reset_full_reset` + +Set whether to do full reset when this step switches contexts + +## Signature + +```python +set_reset_full_reset(full_reset: bool) -> Step +``` + +## Parameters + + + Whether to completely rewrite system prompt vs inject + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 455. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-system-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-system-prompt.mdx new file mode 100644 index 0000000000..78857ebf44 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-system-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-reset-system-prompt" +title: "set_reset_system_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_reset_system_prompt" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_reset_system_prompt` + +Set system prompt for context switching when this step navigates to a context + +## Signature + +```python +set_reset_system_prompt(system_prompt: str) -> Step +``` + +## Parameters + + + New system prompt for context switching + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 416. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-user-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-user-prompt.mdx new file mode 100644 index 0000000000..8cfb9b7843 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-reset-user-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-reset-user-prompt" +title: "set_reset_user_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_reset_user_prompt" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_reset_user_prompt` + +Set user prompt for context switching when this step navigates to a context + +## Signature + +```python +set_reset_user_prompt(user_prompt: str) -> Step +``` + +## Parameters + + + User message to inject for context switching + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 429. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-skip-to-next-step.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-skip-to-next-step.mdx new file mode 100644 index 0000000000..d1e778bbce --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-skip-to-next-step.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-skip-to-next-step" +title: "set_skip_to_next_step" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_skip_to_next_step" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_skip_to_next_step` + +Set whether to automatically advance to the next step + +## Signature + +```python +set_skip_to_next_step(skip: bool) -> Step +``` + +## Parameters + + + Whether to skip to the next step automatically + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 316. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-skip-user-turn.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-skip-user-turn.mdx new file mode 100644 index 0000000000..2e2b1fe8a2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-skip-user-turn.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-skip-user-turn" +title: "set_skip_user_turn" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_skip_user_turn" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_skip_user_turn` + +Set whether to skip waiting for user input after this step + +## Signature + +```python +set_skip_user_turn(skip: bool) -> Step +``` + +## Parameters + + + Whether to skip the user turn after this step + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 303. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-step-criteria.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-step-criteria.mdx new file mode 100644 index 0000000000..2df6912bd0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-step-criteria.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-step-criteria" +title: "set_step_criteria" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_step_criteria" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_step_criteria` + +Set the criteria for determining when this step is complete + +## Signature + +```python +set_step_criteria(criteria: str) -> Step +``` + +## Parameters + + + Description of step completion criteria + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 179. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-text.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-text.mdx new file mode 100644 index 0000000000..3e56e12a0d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-text.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-text" +title: "set_text" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_text" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_text` + +Set the step's prompt text directly + +## Signature + +```python +set_text(text: str) -> Step +``` + +## Parameters + + + The prompt text for this step + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 132. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-valid-contexts.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-valid-contexts.mdx new file mode 100644 index 0000000000..ecb6509be6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-valid-contexts.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-valid-contexts" +title: "set_valid_contexts" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_valid_contexts" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_valid_contexts` + +Set which contexts can be navigated to from this step + +## Signature + +```python +set_valid_contexts(contexts: List[str]) -> Step +``` + +## Parameters + + + List of valid context names + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 265. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-valid-steps.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-valid-steps.mdx new file mode 100644 index 0000000000..95308ad356 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/set-valid-steps.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/set-valid-steps" +title: "set_valid_steps" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.set_valid_steps" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `set_valid_steps` + +Set which steps can be navigated to from this step + +## Signature + +```python +set_valid_steps(steps: List[str]) -> Step +``` + +## Parameters + + + List of valid step names (include "next" for sequential flow) + + +## Returns + +`Step` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 252. diff --git a/fern/products/sdk-reference/python/signalwire/core/contexts/step/to-dict.mdx b/fern/products/sdk-reference/python/signalwire/core/contexts/step/to-dict.mdx new file mode 100644 index 0000000000..386a29013d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/contexts/step/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/contexts/step/to-dict" +title: "to_dict" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.contexts.Step.to_dict" + parent: "signalwire.core.contexts.Step" + module: "signalwire.core.contexts" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py" +--- +# `to_dict` + +Convert step to dictionary for SWML generation + +## Signature + +```python +to_dict() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/core/contexts.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/contexts.py) + +Line 490. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/create-expression-tool.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/create-expression-tool.mdx new file mode 100644 index 0000000000..97ffb84ccd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/create-expression-tool.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/core/data-map/create-expression-tool" +title: "create_expression_tool" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.data_map.create_expression_tool" + parent: "signalwire.core.data_map" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `create_expression_tool` + +Create an expression-based tool for pattern matching responses + +## Signature + +```python +create_expression_tool( + name: str, + patterns: Dict[str, Tuple[str, FunctionResult]], + parameters: Optional[Dict[str, Dict]] = None +) -> DataMap +``` + +## Parameters + + + Function name + + + + Dictionary mapping test\_values to (pattern, FunctionResult) tuples + + + + Optional parameter definitions + + +## Returns + +`DataMap` — Configured DataMap object + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 490. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/create-simple-api-tool.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/create-simple-api-tool.mdx new file mode 100644 index 0000000000..80b5d0f529 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/create-simple-api-tool.mdx @@ -0,0 +1,76 @@ +--- +slug: "/reference/python/signalwire/core/data-map/create-simple-api-tool" +title: "create_simple_api_tool" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.data_map.create_simple_api_tool" + parent: "signalwire.core.data_map" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `create_simple_api_tool` + +Create a simple API tool with minimal configuration + +## Signature + +```python +create_simple_api_tool( + name: str, + url: str, + response_template: str, + parameters: Optional[Dict[str, Dict]] = None, + method: str = 'GET', + headers: Optional[Dict[str, str]] = None, + body: Optional[Dict[str, Any]] = None, + error_keys: Optional[List[str]] = None +) -> DataMap +``` + +## Parameters + + + Function name + + + + API endpoint URL + + + + Template for formatting the response + + + + Optional parameter definitions + + + + HTTP method (default: GET) + + + + Optional HTTP headers + + + + Optional request body (for POST/PUT) + + + + Optional list of error indicator keys + + +## Returns + +`DataMap` — Configured DataMap object + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 439. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/body.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/body.mdx new file mode 100644 index 0000000000..668055c6cc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/body.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/body" +title: "body" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.body" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `body` + +Set request body for the last added webhook (POST/PUT requests) + +## Signature + +```python +body(data: Dict[str, Any]) -> DataMap +``` + +## Parameters + + + Request body data (can include $\{variable\} substitutions) + + +## Returns + +`DataMap` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 255. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/description.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/description.mdx new file mode 100644 index 0000000000..de2869c30b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/description.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/description" +title: "description" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.description" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `description` + +Set the function description (alias for purpose). + +See purpose() for guidance on writing description text the LLM +can act on. + +## Signature + +```python +description(description: str) -> DataMap +``` + +## Parameters + + + LLM-facing description of what this function does and when to use it. + + +## Returns + +`DataMap` — Self for method chaining. + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 110. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/error-keys.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/error-keys.mdx new file mode 100644 index 0000000000..535be022c0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/error-keys.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/error-keys" +title: "error_keys" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.error_keys" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `error_keys` + +Set error keys for the most recent webhook (if webhooks exist) or top-level + +## Signature + +```python +error_keys(keys: List[str]) -> DataMap +``` + +## Parameters + + + List of JSON keys whose presence indicates an error + + +## Returns + +`DataMap` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 356. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/expression.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/expression.mdx new file mode 100644 index 0000000000..794d901efe --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/expression.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/expression" +title: "expression" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.expression" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `expression` + +Add an expression pattern for pattern-based responses + +## Signature + +```python +expression( + test_value: str, + pattern: Union[str, Pattern], + output: FunctionResult, + nomatch_output: Optional[FunctionResult] = None +) -> DataMap +``` + +## Parameters + + + Template string to test (e.g., "$\{args.command\}") + + + + Regex pattern string or compiled Pattern object to match against + + + + FunctionResult to return when pattern matches + + + + Optional FunctionResult to return when pattern doesn't match + + +## Returns + +`DataMap` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 173. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/fallback-output.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/fallback-output.mdx new file mode 100644 index 0000000000..7b2d7a15c2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/fallback-output.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/fallback-output" +title: "fallback_output" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.fallback_output" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `fallback_output` + +Set a fallback output result at the top level (used when all webhooks fail) + +## Signature + +```python +fallback_output(result: FunctionResult) -> DataMap +``` + +## Parameters + + + FunctionResult defining the fallback response + + +## Returns + +`DataMap` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 343. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/foreach.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/foreach.mdx new file mode 100644 index 0000000000..ba23e05a40 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/foreach.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/foreach" +title: "foreach" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.foreach" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `foreach` + +Process an array from the webhook response using foreach mechanism + +``` + Args: + foreach_config: Either: + - Dict: Foreach configuration with keys: + - input_key: Key in API response containing the array + - output_key: Name for the built string variable + - max: Maximum number of items to process (optional) + - append: Template string to append for each item + + Returns: + Self for method chaining + + Example: + .foreach({ + "input_key": "results", + "output_key": "formatted_results", + "max": 3, + "append": "Result: ${this.title} - ${this.summary} +``` + +" +\}) + +## Signature + +```python +foreach(foreach_config: Dict[str, Any]) -> DataMap +``` + +## Parameters + + + +## Returns + +`DataMap` + +## Examples + +```python + Args: + foreach_config: Either: + - Dict: Foreach configuration with keys: + - input_key: Key in API response containing the array + - output_key: Name for the built string variable + - max: Maximum number of items to process (optional) + - append: Template string to append for each item + + Returns: + Self for method chaining + + Example: + .foreach({ + "input_key": "results", + "output_key": "formatted_results", + "max": 3, + "append": "Result: ${this.title} - ${this.summary} +``` + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 287. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/global-error-keys.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/global-error-keys.mdx new file mode 100644 index 0000000000..007bd67776 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/global-error-keys.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/global-error-keys" +title: "global_error_keys" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.global_error_keys" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `global_error_keys` + +Set top-level error keys (applies to all webhooks) + +## Signature + +```python +global_error_keys(keys: List[str]) -> DataMap +``` + +## Parameters + + + List of JSON keys whose presence indicates an error + + +## Returns + +`DataMap` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 374. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/index.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/index.mdx new file mode 100644 index 0000000000..4c23aed953 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/index.mdx @@ -0,0 +1,179 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map" +title: "DataMap" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap" + parent: "signalwire.core.data_map" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `DataMap` + +Builder class for creating SWAIG data\_map configurations. + +This provides a fluent interface for building data\_map tools that execute +on the SignalWire server without requiring webhook endpoints. Works similar +to FunctionResult but for building data\_map structures. + +> \[!NOTE] +> +> # Simple API call - output goes inside webhook +> +> data\_map = (DataMap('get\_weather') +> .purpose('Get current weather information') +> .parameter('location', 'string', 'City name', required=True) +> .webhook('GET', 'https://api.weather.com/v1/current?key=API\_KEY\&q=$\{location\}') +> .output(FunctionResult('Weather in $\{location\}: $\{response.current.condition.text\}, $\{response.current.temp\_f\}°F')) +> ) +> +> # Multiple webhooks with fallback +> +> data\_map = (DataMap('search\_multi') +> .purpose('Search with fallback APIs') +> .parameter('query', 'string', 'Search query', required=True) +> .webhook('GET', 'https://api.primary.com/search?q=$\{query\}') +> .output(FunctionResult('Primary result: $\{response.title\}')) +> .webhook('GET', 'https://api.fallback.com/search?q=$\{query\}') +> .output(FunctionResult('Fallback result: $\{response.title\}')) +> .fallback\_output(FunctionResult('Sorry, all search APIs are unavailable')) +> ) +> +> # Expression-based responses (no API calls) +> +> data\_map = (DataMap('file\_control') +> .purpose('Control file playback') +> .parameter('command', 'string', 'Playback command') +> .parameter('filename', 'string', 'File to control', required=False) +> .expression('$\{args.command\}', r'start._', FunctionResult().add\_action('start\_playbook', \{'file': '$\{args.filename\}'\})) +> .expression('$\{args.command\}', r'stop._', FunctionResult().add\_action('stop\_playback', True)) +> ) +> +> # API with array processing +> +> data\_map = (DataMap('search\_docs') +> .purpose('Search documentation') +> .parameter('query', 'string', 'Search query', required=True) +> .webhook('POST', 'https://api.docs.com/search', headers=\{'Authorization': 'Bearer TOKEN'\}) +> .body(\{'query': '$\{query\}', 'limit': 3\}) +> .output(FunctionResult('Found: $\{response.results\[0].title\} - $\{response.results\[0].summary\}')) +> .foreach('$\{response.results\}') +> ) + +## Signature + +```python +class DataMap +``` + +## Examples + +```python +# Multiple webhooks with fallback +data_map = (DataMap('search_multi') + .purpose('Search with fallback APIs') + .parameter('query', 'string', 'Search query', required=True) + .webhook('GET', 'https://api.primary.com/search?q=${query}') + .output(FunctionResult('Primary result: ${response.title}')) + .webhook('GET', 'https://api.fallback.com/search?q=${query}') + .output(FunctionResult('Fallback result: ${response.title}')) + .fallback_output(FunctionResult('Sorry, all search APIs are unavailable')) +) + +# Expression-based responses (no API calls) +data_map = (DataMap('file_control') + .purpose('Control file playback') + .parameter('command', 'string', 'Playback command') + .parameter('filename', 'string', 'File to control', required=False) + .expression('${args.command}', r'start.*', FunctionResult().add_action('start_playbook', {'file': '${args.filename}'})) + .expression('${args.command}', r'stop.*', FunctionResult().add_action('stop_playback', True)) +) + +# API with array processing +data_map = (DataMap('search_docs') + .purpose('Search documentation') + .parameter('query', 'string', 'Search query', required=True) + .webhook('POST', 'https://api.docs.com/search', headers={'Authorization': 'Bearer TOKEN'}) + .body({'query': '${query}', 'limit': 3}) + .output(FunctionResult('Found: ${response.results[0].title} - ${response.results[0].summary}')) + .foreach('${response.results}') +) +``` + +## Properties + + + +## Methods + + + + Initialize a new DataMap builder + + + + Set request body for the last added webhook (POST/PUT requests) + + + + Set the function description (alias for purpose). + + + + Set error keys for the most recent webhook (if webhooks exist) or top-level + + + + Add an expression pattern for pattern-based responses + + + + Set a fallback output result at the top level (used when all webhooks fail) + + + + Process an array from the webhook response using foreach mechanism Args: foreach\_config: Either: - Dict: Foreach configuration with keys: - input\_key: Key in API response containing the array - output\_key: Name for the built string variable - max: Maximum number of items to process (optional) - append: Template string to append for each item Returns: Self for method chaining Example: .foreach(\{ "input\_key": "results", "output\_key": "formatted\_results", "max": 3, "append": "Result: $\{this.title\} - $\{this.summary\} " \}) + + + + Set top-level error keys (applies to all webhooks) + + + + Set the output result for the most recent webhook + + + + Add a function parameter. + + + + Set request params for the last added webhook (alias for body) + + + + Set the function description that the LLM will read. + + + + Convert this DataMap to a SWAIG function definition + + + + Add a webhook API call + + + + Add expressions that run after the most recent webhook completes + + + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 19. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/init.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/init.mdx new file mode 100644 index 0000000000..5ebee542f4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.__init__" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `__init__` + +Initialize a new DataMap builder + +## Signature + +```python +__init__(function_name: str) +``` + +## Parameters + + + Name of the SWAIG function this data\_map will create + + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 67. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/output.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/output.mdx new file mode 100644 index 0000000000..f639d1742a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/output.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/output" +title: "output" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.output" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `output` + +Set the output result for the most recent webhook + +## Signature + +```python +output(result: FunctionResult) -> DataMap +``` + +## Parameters + + + FunctionResult defining the response for this webhook + + +## Returns + +`DataMap` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 327. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/parameter.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/parameter.mdx new file mode 100644 index 0000000000..fdf9027983 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/parameter.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/parameter" +title: "parameter" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.parameter" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `parameter` + +Add a function parameter. + +Just like the function-level `description`, this parameter +`description` is sent to the LLM as part of the tool schema and +is read by the model when deciding HOW to fill in the argument. +Write it as an instruction to the model: + +- Bad: "the id" +- Good: "The customer's 8-digit account number, no dashes or + spaces. Ask the user if they don't provide it." + +## Signature + +```python +parameter( + name: str, + param_type: str, + description: str, + required: bool = False, + enum: Optional[List[str]] = None +) -> DataMap +``` + +## Parameters + + + Parameter name. Becomes a key in the tool schema's `properties` object and is what the model emits. + + + + JSON schema type (string, number, boolean, array, object). + + + + LLM-facing parameter description. See above — this should tell the model what value to put here, in what format, and where to source it. + + + + Whether parameter is required. + + + + Optional list of allowed values. The model will only emit values from this list. + + +## Returns + +`DataMap` — Self for method chaining. + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 126. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/params.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/params.mdx new file mode 100644 index 0000000000..f49bbe7d4f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/params" +title: "params" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.params" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `params` + +Set request params for the last added webhook (alias for body) + +## Signature + +```python +params(data: Dict[str, Any]) -> DataMap +``` + +## Parameters + + + Request params data (can include $\{variable\} substitutions) + + +## Returns + +`DataMap` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 271. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/purpose.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/purpose.mdx new file mode 100644 index 0000000000..e7eea4438b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/purpose.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/purpose" +title: "purpose" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.purpose" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `purpose` + +Set the function description that the LLM will read. + +A DataMap creates a SWAIG function that gets sent to the model in +OpenAI tool-schema format. This `description` field is what the +model reads on every turn to decide WHEN to call the tool. It is +prompt-engineered text, not developer documentation: + +- Bad: "Search function" +- Good: "Search the company's knowledge base for help articles + matching a user query. Use this when the user asks a + product or how-to question that the base prompt does + not cover." + +Vague descriptions are the most common cause of "the model has +the right tool but doesn't call it" failures. + +## Signature + +```python +purpose(description: str) -> DataMap +``` + +## Parameters + + + LLM-facing description of what this function does and when to use it. See above. + + +## Returns + +`DataMap` — Self for method chaining. + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 82. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/to-swaig-function.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/to-swaig-function.mdx new file mode 100644 index 0000000000..17bc43c7b8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/to-swaig-function.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/to-swaig-function" +title: "to_swaig_function" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.to_swaig_function" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `to_swaig_function` + +Convert this DataMap to a SWAIG function definition + +## Signature + +```python +to_swaig_function() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` — Dictionary with function definition and data\_map instead of url + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 387. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/webhook-expressions.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/webhook-expressions.mdx new file mode 100644 index 0000000000..c818d6df6c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/webhook-expressions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/webhook-expressions" +title: "webhook_expressions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.webhook_expressions" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `webhook_expressions` + +Add expressions that run after the most recent webhook completes + +## Signature + +```python +webhook_expressions(expressions: List[Dict[str, Any]]) -> DataMap +``` + +## Parameters + + + List of expression definitions to check post-webhook + + +## Returns + +`DataMap` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 239. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/webhook.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/webhook.mdx new file mode 100644 index 0000000000..2d1b8827b8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/data-map/webhook.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/python/signalwire/core/data-map/data-map/webhook" +title: "webhook" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.data_map.DataMap.webhook" + parent: "signalwire.core.data_map.DataMap" + module: "signalwire.core.data_map" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `webhook` + +Add a webhook API call + +## Signature + +```python +webhook( + method: str, + url: str, + headers: Optional[Dict[str, str]] = None, + form_param: Optional[str] = None, + input_args_as_params: bool = False, + require_args: Optional[List[str]] = None +) -> DataMap +``` + +## Parameters + + + HTTP method (GET, POST, PUT, DELETE, etc.) + + + + API endpoint URL (can include $\{variable\} substitutions) + + + + Optional HTTP headers + + + + Send JSON body as single form parameter with this name + + + + Merge function arguments into params + + + + Only execute if these arguments are present + + +## Returns + +`DataMap` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) + +Line 204. diff --git a/fern/products/sdk-reference/python/signalwire/core/data-map/index.mdx b/fern/products/sdk-reference/python/signalwire/core/data-map/index.mdx new file mode 100644 index 0000000000..fc057b3e5f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/data-map/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/core/data-map" +title: "data_map" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.data_map" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py" +--- +# `data_map` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module data_map +``` + +## Functions + + + + Create an expression-based tool for pattern matching responses + + + + Create a simple API tool with minimal configuration + + + +## Classes + + + + Builder class for creating SWAIG data\_map configurations. + + + +## Source + +[`signalwire/signalwire/core/data_map.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/data_map.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/add-action.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/add-action.mdx new file mode 100644 index 0000000000..3ff64575be --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/add-action.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/add-action" +title: "add_action" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.add_action" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `add_action` + +Add a structured action to the response + +## Signature + +```python +add_action(name: str, data: Any) -> FunctionResult +``` + +## Parameters + + + The name/type of the action (e.g., "play", "transfer") + + + + The data for the action - can be a string, boolean, object, or array + + +## Returns + +`FunctionResult` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 114. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/add-actions.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/add-actions.mdx new file mode 100644 index 0000000000..936fe42de7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/add-actions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/add-actions" +title: "add_actions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.add_actions" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `add_actions` + +Add multiple structured actions to the response + +## Signature + +```python +add_actions(actions: List[Dict[str, Any]]) -> FunctionResult +``` + +## Parameters + + + List of action objects to add to the response + + +## Returns + +`FunctionResult` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 128. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/add-dynamic-hints.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/add-dynamic-hints.mdx new file mode 100644 index 0000000000..21b9aea7da --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/add-dynamic-hints.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/add-dynamic-hints" +title: "add_dynamic_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.add_dynamic_hints" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `add_dynamic_hints` + +Add dynamic speech recognition hints during a call. + +Hints improve speech recognition accuracy for domain-specific terms. +Each hint can be a simple string or a pronunciation pattern object. + +> \[!NOTE] +> result = ( +> FunctionResult("I'll listen for that name") +> .add\_dynamic\_hints(\[ +> "Cabby", +> \{"pattern": "cab bee", "replace": "Cabby", "ignore\_case": True\} +> ]) +> ) + +## Signature + +```python +add_dynamic_hints(hints: List[Union[str, Dict[str, Any]]]) -> FunctionResult +``` + +## Parameters + + + List of hints, where each entry is either: + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 525. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/clear-dynamic-hints.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/clear-dynamic-hints.mdx new file mode 100644 index 0000000000..ef801d7346 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/clear-dynamic-hints.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/clear-dynamic-hints" +title: "clear_dynamic_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.clear_dynamic_hints" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `clear_dynamic_hints` + +Clear all dynamic speech recognition hints. + +Removes all hints previously added via add\_dynamic\_hints(). + +## Signature + +```python +clear_dynamic_hints() -> FunctionResult +``` + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 554. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/connect.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/connect.mdx new file mode 100644 index 0000000000..fb697ef4e2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/connect.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/connect" +title: "connect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.connect" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `connect` + +Add a connect action to transfer/connect the call to another destination. + +This is a convenience method that abstracts the SWML connect verb, so users +don't need to manually construct SWML documents. + +Transfer behavior: + +- final=True: Permanent transfer - call exits the agent completely, + SWML replaces the agent and call continues there +- final=False: Temporary transfer - if far end hangs up, call returns + to the agent to continue the conversation + +> \[!NOTE] +> +> # Permanent transfer to a phone number +> +> result.connect("+15551234567", final=True) +> +> # Temporary transfer to SIP address with custom caller ID +> +> result.connect("support@company.com", final=False, from\_addr="+15559876543") + +## Signature + +```python +connect( + destination: str, + final: bool = True, + from_addr: Optional[str] = None +) -> FunctionResult +``` + +## Parameters + + + Where to connect the call (phone number, SIP address, etc.) + + + + Whether this is a permanent transfer (True) or temporary (False). Defaults to True for permanent transfers. + + + + Optional caller ID override (phone number or SIP address). If None, uses the current call's from address. + + +## Returns + +`FunctionResult` — Self for method chaining + +## Examples + +```python +# Temporary transfer to SIP address with custom caller ID +result.connect("support@company.com", final=False, from_addr="+15559876543") +``` + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 141. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/create-payment-action.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/create-payment-action.mdx new file mode 100644 index 0000000000..5113277193 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/create-payment-action.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/create-payment-action" +title: "create_payment_action" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.create_payment_action" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `create_payment_action` + +Create a payment action for use in payment prompts. + +**Modifiers:** `static` + +## Signature + +```python +@staticmethod +create_payment_action(action_type: str, phrase: str) -> Dict[str, str] +``` + +## Parameters + + + "Say" for text-to-speech or "Play" for audio file + + + + Sentence to say or URL to play + + +## Returns + +`Dict[str, str]` — Dictionary representing the action + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1469. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/create-payment-parameter.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/create-payment-parameter.mdx new file mode 100644 index 0000000000..9ed49365d9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/create-payment-parameter.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/create-payment-parameter" +title: "create_payment_parameter" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.create_payment_parameter" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `create_payment_parameter` + +Create a payment parameter for use with pay() method. + +**Modifiers:** `static` + +## Signature + +```python +@staticmethod +create_payment_parameter(name: str, value: str) -> Dict[str, str] +``` + +## Parameters + + + Parameter name + + + + Parameter value + + +## Returns + +`Dict[str, str]` — Dictionary representing the parameter + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1486. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/create-payment-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/create-payment-prompt.mdx new file mode 100644 index 0000000000..2998384f3a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/create-payment-prompt.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/create-payment-prompt" +title: "create_payment_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.create_payment_prompt" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `create_payment_prompt` + +Create a payment prompt structure for use with pay() method. + +**Modifiers:** `static` + +## Signature + +```python +@staticmethod +create_payment_prompt( + for_situation: str, + actions: List[Dict[str, str]], + card_type: Optional[str] = None, + error_type: Optional[str] = None +) -> Dict[str, Any] +``` + +## Parameters + + + Situation to use prompt for (e.g., "payment-card-number") + + + + List of actions with 'type' and 'phrase' keys + + + + Space-separated card types for this prompt + + + + Space-separated error types for this prompt + + +## Returns + +`Dict[str, Any]` — Dictionary representing the prompt structure + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1441. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/enable-extensive-data.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/enable-extensive-data.mdx new file mode 100644 index 0000000000..b0d2a146f2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/enable-extensive-data.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/enable-extensive-data" +title: "enable_extensive_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.enable_extensive_data" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `enable_extensive_data` + +Send full data to LLM for this turn only, then use smaller replacement +in subsequent turns. + +## Signature + +```python +enable_extensive_data(enabled: bool = True) -> FunctionResult +``` + +## Parameters + + + Whether to send extensive data this turn only + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 652. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/enable-functions-on-timeout.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/enable-functions-on-timeout.mdx new file mode 100644 index 0000000000..edc964f407 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/enable-functions-on-timeout.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/enable-functions-on-timeout" +title: "enable_functions_on_timeout" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.enable_functions_on_timeout" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `enable_functions_on_timeout` + +Enable function calls on speaker timeout. + +## Signature + +```python +enable_functions_on_timeout(enabled: bool = True) -> FunctionResult +``` + +## Parameters + + + Whether to enable functions on timeout + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 640. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/execute-rpc.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/execute-rpc.mdx new file mode 100644 index 0000000000..5732f30b4e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/execute-rpc.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/execute-rpc" +title: "execute_rpc" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.execute_rpc" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `execute_rpc` + +Execute an RPC method on a call using SWML. + +This is a generic helper for executing RPC commands. For common operations, +consider using the specific helpers: rpc\_dial(), rpc\_ai\_message(), rpc\_ai\_unhold(). + +> \[!NOTE] +> result = ( +> FunctionResult("Executing RPC") +> .execute\_rpc( +> method="ai\_message", +> call\_id="some-call-id", +> params=\{"role": "system", "message\_text": "Hello"\} +> ) +> ) + +## Signature + +```python +execute_rpc( + method: str, + params: Optional[Dict[str, Any]] = None, + call_id: Optional[str] = None, + node_id: Optional[str] = None +) -> FunctionResult +``` + +## Parameters + + + The RPC method to execute (e.g., "dial", "ai\_message", "ai\_unhold") + + + + Parameters for the RPC method (optional) + + + + Target call ID for the RPC (optional) + + + + Target node ID for the RPC (optional) + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1287. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/execute-swml.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/execute-swml.mdx new file mode 100644 index 0000000000..b34b7d2fea --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/execute-swml.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/execute-swml" +title: "execute_swml" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.execute_swml" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `execute_swml` + +Execute SWML content with optional transfer behavior. + +## Signature + +```python +execute_swml(swml_content, transfer: bool = False) -> FunctionResult +``` + +## Parameters + + + Can be: + + + + Boolean - whether call should exit agent after execution + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 396. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/hangup.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/hangup.mdx new file mode 100644 index 0000000000..e09df092fa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/hangup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/hangup" +title: "hangup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.hangup" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `hangup` + +Terminate the call. + +## Signature + +```python +hangup() -> FunctionResult +``` + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 433. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/hold.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/hold.mdx new file mode 100644 index 0000000000..7296c1fef0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/hold.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/hold" +title: "hold" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.hold" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `hold` + +Put the call on hold with optional timeout. + +## Signature + +```python +hold(timeout: int = 300) -> FunctionResult +``` + +## Parameters + + + Timeout in seconds (max 900, default 300) + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 442. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/index.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/index.mdx new file mode 100644 index 0000000000..33060f13d9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/index.mdx @@ -0,0 +1,335 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result" +title: "FunctionResult" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult" + parent: "signalwire.core.function_result" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `FunctionResult` + +Wrapper around SWAIG function responses that handles proper formatting +of response text and actions. + +The result object has three main components: + +1. response: Text the AI should say back to the user +2. action: List of structured actions to execute +3. post\_process: Whether to let AI take another turn before executing actions + +Post-processing behavior: + +- post\_process=False (default): Execute actions immediately after AI response +- post\_process=True: Let AI respond to user one more time, then execute actions + +This is useful for confirmation workflows like: +"I'll transfer you to sales. Do you have any other questions first?" +(AI can handle follow-up, then execute the transfer) + +> \[!NOTE] +> return FunctionResult("Found your order") +> +> # With actions +> +> return ( +> FunctionResult("I'll transfer you to support") +> .add\_action("transfer", \{"dest": "support"\}) +> ) +> +> # With simple action value +> +> return ( +> FunctionResult("I'll confirm that") +> .add\_action("confirm", True) +> ) +> +> # With multiple actions +> +> return ( +> FunctionResult("Processing your request") +> .add\_actions(\[ +> \{"set\_global\_data": \{"key": "value"\}\}, +> \{"play": \{"url": "music.mp3"\}\} +> ]) +> ) +> +> # With post-processing enabled +> +> return ( +> FunctionResult("Let me transfer you to billing", post\_process=True) +> .connect("+15551234567", final=True) +> ) +> +> # Using the connect helper +> +> return ( +> FunctionResult("I'll transfer you to our sales team now") +> .connect("sales@company.com", final=False, from\_addr="+15559876543") +> ) + +## Signature + +```python +class FunctionResult +``` + +## Examples + +```python +# With actions +return ( + FunctionResult("I'll transfer you to support") + .add_action("transfer", {"dest": "support"}) +) + +# With simple action value +return ( + FunctionResult("I'll confirm that") + .add_action("confirm", True) +) + +# With multiple actions +return ( + FunctionResult("Processing your request") + .add_actions([ + {"set_global_data": {"key": "value"}}, + {"play": {"url": "music.mp3"}} + ]) +) + +# With post-processing enabled +return ( + FunctionResult("Let me transfer you to billing", post_process=True) + .connect("+15551234567", final=True) +) + +# Using the connect helper +return ( + FunctionResult("I'll transfer you to our sales team now") + .connect("sales@company.com", final=False, from_addr="+15559876543") +) +``` + +## Properties + + + + + + + +## Methods + + + + Initialize a new SWAIG function result + + + + Add a structured action to the response + + + + Add multiple structured actions to the response + + + + Add dynamic speech recognition hints during a call. + + + + Clear all dynamic speech recognition hints. + + + + Add a connect action to transfer/connect the call to another destination. + + + + Create a payment action for use in payment prompts. + + + + Create a payment parameter for use with pay() method. + + + + Create a payment prompt structure for use with pay() method. + + + + Send full data to LLM for this turn only, then use smaller replacement in subsequent turns. + + + + Enable function calls on speaker timeout. + + + + Execute an RPC method on a call using SWML. + + + + Execute SWML content with optional transfer behavior. + + + + Terminate the call. + + + + Put the call on hold with optional timeout. + + + + Join an ad-hoc audio conference with RELAY and CXML calls using SWML. + + + + Join a RELAY room using SWML. + + + + Process payment using SWML pay action. + + + + Play audio or video file in background. + + + + Start background call recording using SWML. + + + + Remove global agent data variables. + + + + Remove metadata from current function's meta\_data\_token scope. + + + + After first send, replace tool\_call+result pair in conversation history. + + + + Inject a message into an AI agent on another call using execute\_rpc. + + + + Unhold another call using execute\_rpc. + + + + Dial out to a number with a destination SWML URL using execute\_rpc. + + + + Make the agent speak specific text. + + + + Send a text message to a PSTN phone number using SWML. + + + + Adjust end of speech timeout - milliseconds of silence after speaking has been detected to finalize speech recognition. + + + + Set metadata scoped to current function's meta\_data\_token. + + + + Set whether to enable post-processing for this result. + + + + Set the natural language response text + + + + Adjust speech event timeout - milliseconds since last speech detection event to finalize recognition. Works better in noisy environments. + + + + Queue simulated user input. + + + + Send SIP REFER to a SIP call using SWML. + + + + Stop the agent execution. + + + + Stop currently playing background file. + + + + Stop an active background call recording using SWML. + + + + Stop an active tap stream using SWML. + + + + Change agent context/prompt during conversation. + + + + Force the conversation into a different context. + + + + Force the conversation into a specific step in the current context. + + + + Add a SWML transfer action with AI response setup for when transfer completes. + + + + Send a user event through SWML to update the client UI. + + + + Start background call tap using SWML. + + + + Convert to the JSON structure expected by SWAIG + + + + Enable/disable specific SWAIG functions. + + + + Update global agent data variables. + + + + Update agent runtime settings. + + + + Control how agent waits for user input. + + + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/init.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/init.mdx new file mode 100644 index 0000000000..f14a65843b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/init.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.__init__" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `__init__` + +Initialize a new SWAIG function result + +## Signature + +```python +__init__(response: Optional[str] = None, post_process: bool = False) +``` + +## Parameters + + + Optional natural language response to include + + + + Whether to let AI take another turn before executing actions. Defaults to False (execute actions immediately after response). + + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 71. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/join-conference.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/join-conference.mdx new file mode 100644 index 0000000000..6f7ce382d6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/join-conference.mdx @@ -0,0 +1,133 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/join-conference" +title: "join_conference" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.join_conference" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `join_conference` + +Join an ad-hoc audio conference with RELAY and CXML calls using SWML. + +This is a virtual helper that generates SWML to join audio conferences +with extensive configuration options for call management and recording. + +## Signature + +```python +join_conference( + name: str, + muted: bool = False, + beep: str = 'true', + start_on_enter: bool = True, + end_on_exit: bool = False, + wait_url: Optional[str] = None, + max_participants: int = 250, + record: str = 'do-not-record', + region: Optional[str] = None, + trim: str = 'trim-silence', + coach: Optional[str] = None, + status_callback_event: Optional[str] = None, + status_callback: Optional[str] = None, + status_callback_method: str = 'POST', + recording_status_callback: Optional[str] = None, + recording_status_callback_method: str = 'POST', + recording_status_callback_event: str = 'completed', + result: Optional[Any] = None +) -> FunctionResult +``` + +## Parameters + + + Name of conference (required) + + + + Whether to join muted (default: False) + + + + Beep configuration - "true", "false", "onEnter", "onExit" (default: "true") + + + + Whether conference starts when this participant enters (default: True) + + + + Whether conference ends when this participant exits (default: False) + + + + SWML URL for hold music (default: None for default hold music) + + + + Maximum participants \<= 250 (default: 250) + + + + Recording mode - "do-not-record", "record-from-start" (default: "do-not-record") + + + + Conference region (default: None) + + + + Trim silence - "trim-silence", "do-not-trim" (default: "trim-silence") + + + + SWML Call ID or CXML CallSid for coaching (default: None) + + + + Events to report - "start end join leave mute hold modify speaker announcement" (default: None) + + + + URL for status callbacks (default: None) + + + + HTTP method - "GET", "POST" (default: "POST") + + + + URL for recording status callbacks (default: None) + + + + HTTP method - "GET", "POST" (default: "POST") + + + + Recording events - "in-progress completed absent" (default: "completed") + + + + Switch on return\_value when object \{\} or cond when array \[] (default: None) + + +## Returns + +`FunctionResult` — self for method chaining + +## Throws + +- `ValueError` — If beep value is invalid or max\_participants exceeds 250 + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1046. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/join-room.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/join-room.mdx new file mode 100644 index 0000000000..70cf6391b2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/join-room.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/join-room" +title: "join_room" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.join_room" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `join_room` + +Join a RELAY room using SWML. + +This is a virtual helper that generates SWML to join a RELAY room, +which enables multi-party communication and collaboration. + +## Signature + +```python +join_room(name: str) -> FunctionResult +``` + +## Parameters + + + The name of the room to join (required) + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 988. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/pay.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/pay.mdx new file mode 100644 index 0000000000..7058617766 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/pay.mdx @@ -0,0 +1,131 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/pay" +title: "pay" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.pay" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `pay` + +Process payment using SWML pay action. + +This is a virtual helper that generates SWML for payment processing. + +## Signature + +```python +pay( + payment_connector_url: str, + input_method: str = 'dtmf', + status_url: Optional[str] = None, + payment_method: str = 'credit-card', + timeout: int = 5, + max_attempts: int = 1, + security_code: bool = True, + postal_code: Union[bool, str] = True, + min_postal_code_length: int = 0, + token_type: str = 'reusable', + charge_amount: Optional[str] = None, + currency: str = 'usd', + language: str = 'en-US', + voice: str = 'woman', + description: Optional[str] = None, + valid_card_types: str = 'visa mastercard amex', + parameters: Optional[List[Dict[str, str]]] = None, + prompts: Optional[List[Dict[str, Any]]] = None, + ai_response: Optional[str] = 'The payment status is ${pay_result}, do not mention anything else about collecting payment if successful.' +) -> FunctionResult +``` + +## Parameters + + + URL to make payment requests to (required) + + + + Method to collect payment details ("dtmf" or "voice") + + + + URL for status change notifications + + + + Payment method ("credit-card" currently supported) + + + + Seconds to wait for next digit (default: 5) + + + + Number of retry attempts (default: 1) + + + + Whether to prompt for security code (default: True) + + + + Whether to prompt for postal code, or actual postcode + + + + Minimum postal code digits (default: 0) + + + + Payment type ("one-time" or "reusable", default: "reusable") + + + + Amount to charge as decimal string + + + + Currency code (default: "usd") + + + + Language for prompts (default: "en-US") + + + + TTS voice to use (default: "woman") + + + + Custom payment description + + + + Space-separated card types (default: "visa mastercard amex") + + + + Array of name/value pairs for payment connector + + + + Array of custom prompt configurations + + + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 797. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/play-background-file.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/play-background-file.mdx new file mode 100644 index 0000000000..89362c111d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/play-background-file.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/play-background-file" +title: "play_background_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.play_background_file" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `play_background_file` + +Play audio or video file in background. + +## Signature + +```python +play_background_file(filename: str, wait: bool = False) -> FunctionResult +``` + +## Parameters + + + Audio/video filename/path + + + + Whether to suppress attention-getting behavior during playback + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 500. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/record-call.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/record-call.mdx new file mode 100644 index 0000000000..e62d41c247 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/record-call.mdx @@ -0,0 +1,95 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/record-call" +title: "record_call" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.record_call" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `record_call` + +Start background call recording using SWML. + +This is a virtual helper that generates SWML to start recording the call +in the background. Unlike foreground recording, the script continues +executing while recording happens in the background. + +## Signature + +```python +record_call( + control_id: Optional[str] = None, + stereo: bool = False, + format: str = 'wav', + direction: str = 'both', + terminators: Optional[str] = None, + beep: bool = False, + input_sensitivity: float = 44.0, + initial_timeout: Optional[float] = None, + end_silence_timeout: Optional[float] = None, + max_length: Optional[float] = None, + status_url: Optional[str] = None +) -> FunctionResult +``` + +## Parameters + + + Identifier for this recording (for use with stop\_record\_call) + + + + Record in stereo (default: False) + + + + Recording format - "wav" or "mp3" (default: "wav") + + + + Audio direction - "speak", "listen", or "both" (default: "both") + + + + Digits that stop recording when pressed + + + + Play beep before recording (default: False) + + + + Input sensitivity for recording (default: 44.0) + + + + Time in seconds to wait for speech start (for voicemail-style recording) + + + + Time in seconds to wait in silence before ending (for voicemail-style recording) + + + + Maximum recording length in seconds + + + + URL to send recording status events to + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 883. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/remove-global-data.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/remove-global-data.mdx new file mode 100644 index 0000000000..05749c57f1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/remove-global-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/remove-global-data" +title: "remove_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.remove_global_data" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `remove_global_data` + +Remove global agent data variables. + +## Signature + +```python +remove_global_data(keys: Union[str, List[str]]) -> FunctionResult +``` + +## Parameters + + + Single key string or list of keys to remove + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 592. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/remove-metadata.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/remove-metadata.mdx new file mode 100644 index 0000000000..17e937a47b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/remove-metadata.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/remove-metadata" +title: "remove_metadata" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.remove_metadata" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `remove_metadata` + +Remove metadata from current function's meta\_data\_token scope. + +## Signature + +```python +remove_metadata(keys: Union[str, List[str]]) -> FunctionResult +``` + +## Parameters + + + Single key string or list of keys to remove + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 616. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/replace-in-history.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/replace-in-history.mdx new file mode 100644 index 0000000000..b5b1e96869 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/replace-in-history.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/replace-in-history" +title: "replace_in_history" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.replace_in_history" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `replace_in_history` + +After first send, replace tool\_call+result pair in conversation history. + +## Signature + +```python +replace_in_history(text: Union[str, bool] = True) -> FunctionResult +``` + +## Parameters + + + String = replace tool\_call with an assistant message containing this text. True = remove the tool\_call+result pair from history entirely. + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 665. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/rpc-ai-message.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/rpc-ai-message.mdx new file mode 100644 index 0000000000..02a869355d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/rpc-ai-message.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/rpc-ai-message" +title: "rpc_ai_message" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.rpc_ai_message" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `rpc_ai_message` + +Inject a message into an AI agent on another call using execute\_rpc. + +This is useful for cross-call communication, such as notifying a held +caller's AI agent about a status change or instructing it to relay +a message. + +> \[!NOTE] +> result = ( +> FunctionResult("I'll let them know.") +> .rpc\_ai\_message( +> call\_id=original\_call\_id, +> message\_text="The person you were trying to reach is unavailable. Please take a message." +> ) +> ) + +## Signature + +```python +rpc_ai_message( + call_id: str, + message_text: str, + role: str = 'system' +) -> FunctionResult +``` + +## Parameters + + + The call ID of the target call + + + + The message text to inject into the AI conversation + + + + The role for the message, typically "system" (default: "system") + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1380. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/rpc-ai-unhold.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/rpc-ai-unhold.mdx new file mode 100644 index 0000000000..949089f4a9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/rpc-ai-unhold.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/rpc-ai-unhold" +title: "rpc_ai_unhold" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.rpc_ai_unhold" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `rpc_ai_unhold` + +Unhold another call using execute\_rpc. + +This releases a call from hold state, typically used after injecting +a message to the held caller's AI agent. + +> \[!NOTE] +> result = ( +> FunctionResult("Understood, I'll let them know.") +> .rpc\_ai\_message(call\_id, "No one is available. Please take a message.") +> .rpc\_ai\_unhold(call\_id) +> ) + +## Signature + +```python +rpc_ai_unhold(call_id: str) -> FunctionResult +``` + +## Parameters + + + The call ID of the call to unhold + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1415. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/rpc-dial.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/rpc-dial.mdx new file mode 100644 index 0000000000..851d9c23d7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/rpc-dial.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/rpc-dial" +title: "rpc_dial" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.rpc_dial" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `rpc_dial` + +Dial out to a number with a destination SWML URL using execute\_rpc. + +This is commonly used in call screening scenarios where you place a caller +on hold and dial out to a human, with the dest\_swml specifying what agent +handles the outbound leg. + +> \[!NOTE] +> result = ( +> FunctionResult("Please hold while I connect you.") +> .hold(timeout=120) +> .rpc\_dial( +> to\_number="+15551234567", +> from\_number="+15559876543", +> dest\_swml="https://example.com/call-agent?caller=John" +> ) +> ) + +## Signature + +```python +rpc_dial( + to_number: str, + from_number: str, + dest_swml: str, + device_type: str = 'phone' +) -> FunctionResult +``` + +## Parameters + + + Phone number to dial (E.164 format) + + + + Caller ID to use (E.164 format) + + + + URL to the SWML that handles the outbound call + + + + Device type, typically "phone" (default: "phone") + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1337. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/say.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/say.mdx new file mode 100644 index 0000000000..9713792131 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/say.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/say" +title: "say" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.say" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `say` + +Make the agent speak specific text. + +## Signature + +```python +say(text: str) -> FunctionResult +``` + +## Parameters + + + Text for agent to speak + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 488. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/send-sms.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/send-sms.mdx new file mode 100644 index 0000000000..458e8516fc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/send-sms.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/send-sms" +title: "send_sms" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.send_sms" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `send_sms` + +Send a text message to a PSTN phone number using SWML. + +This is a virtual helper that generates SWML to send SMS messages. +Either body or media (or both) must be provided. + +## Signature + +```python +send_sms( + to_number: str, + from_number: str, + body: Optional[str] = None, + media: Optional[List[str]] = None, + tags: Optional[List[str]] = None, + region: Optional[str] = None +) -> FunctionResult +``` + +## Parameters + + + Phone number in E.164 format to send to + + + + Phone number in E.164 format to send from + + + + Body text of the message (optional if media provided) + + + + Array of URLs to send in the message (optional if body provided) + + + + Array of tags to associate with the message for UI searching + + + + Region to originate the message from + + +## Returns + +`FunctionResult` — self for method chaining + +## Throws + +- `ValueError` — If neither body nor media is provided + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 741. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-end-of-speech-timeout.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-end-of-speech-timeout.mdx new file mode 100644 index 0000000000..f17c2e8464 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-end-of-speech-timeout.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/set-end-of-speech-timeout" +title: "set_end_of_speech_timeout" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.set_end_of_speech_timeout" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `set_end_of_speech_timeout` + +Adjust end of speech timeout - milliseconds of silence after speaking +has been detected to finalize speech recognition. + +## Signature + +```python +set_end_of_speech_timeout(milliseconds: int) -> FunctionResult +``` + +## Parameters + + + Timeout in milliseconds + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 566. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-metadata.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-metadata.mdx new file mode 100644 index 0000000000..da05ba0fea --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-metadata.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/set-metadata" +title: "set_metadata" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.set_metadata" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `set_metadata` + +Set metadata scoped to current function's meta\_data\_token. + +## Signature + +```python +set_metadata(data: Dict[str, Any]) -> FunctionResult +``` + +## Parameters + + + Dictionary of key-value pairs for metadata + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 604. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-post-process.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-post-process.mdx new file mode 100644 index 0000000000..e677fdbf87 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-post-process.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/set-post-process" +title: "set_post_process" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.set_post_process" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `set_post_process` + +Set whether to enable post-processing for this result. + +Post-processing allows the AI to take one more turn with the user +before executing any actions. This is useful for confirmation workflows. + +## Signature + +```python +set_post_process(post_process: bool) -> FunctionResult +``` + +## Parameters + + + True to let AI respond once more before executing actions, False to execute actions immediately after the response. + + +## Returns + +`FunctionResult` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 97. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-response.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-response.mdx new file mode 100644 index 0000000000..f7ada86393 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-response.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/set-response" +title: "set_response" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.set_response" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `set_response` + +Set the natural language response text + +## Signature + +```python +set_response(response: str) -> FunctionResult +``` + +## Parameters + + + The text the AI should say + + +## Returns + +`FunctionResult` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 84. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-speech-event-timeout.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-speech-event-timeout.mdx new file mode 100644 index 0000000000..b89bcf224b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/set-speech-event-timeout.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/set-speech-event-timeout" +title: "set_speech_event_timeout" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.set_speech_event_timeout" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `set_speech_event_timeout` + +Adjust speech event timeout - milliseconds since last speech detection +event to finalize recognition. Works better in noisy environments. + +## Signature + +```python +set_speech_event_timeout(milliseconds: int) -> FunctionResult +``` + +## Parameters + + + Timeout in milliseconds + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 579. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/simulate-user-input.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/simulate-user-input.mdx new file mode 100644 index 0000000000..f7e1dc8134 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/simulate-user-input.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/simulate-user-input" +title: "simulate_user_input" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.simulate_user_input" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `simulate_user_input` + +Queue simulated user input. + +## Signature + +```python +simulate_user_input(text: str) -> FunctionResult +``` + +## Parameters + + + Text to simulate as user input + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 729. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/sip-refer.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/sip-refer.mdx new file mode 100644 index 0000000000..6dd6d98d9d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/sip-refer.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/sip-refer" +title: "sip_refer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.sip_refer" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `sip_refer` + +Send SIP REFER to a SIP call using SWML. + +This is a virtual helper that generates SWML to send a SIP REFER +message, which is used for call transfer in SIP environments. + +## Signature + +```python +sip_refer(to_uri: str) -> FunctionResult +``` + +## Parameters + + + The SIP URI to send the REFER to (required) + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1017. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop-background-file.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop-background-file.mdx new file mode 100644 index 0000000000..c445822451 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop-background-file.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/stop-background-file" +title: "stop_background_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.stop_background_file" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `stop_background_file` + +Stop currently playing background file. + +## Signature + +```python +stop_background_file() -> FunctionResult +``` + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 516. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop-record-call.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop-record-call.mdx new file mode 100644 index 0000000000..306b2fcf2a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop-record-call.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/stop-record-call" +title: "stop_record_call" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.stop_record_call" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `stop_record_call` + +Stop an active background call recording using SWML. + +This is a virtual helper that generates SWML to stop a recording that +was started with record\_call(). + +## Signature + +```python +stop_record_call(control_id: Optional[str] = None) -> FunctionResult +``` + +## Parameters + + + Identifier for the recording to stop. If not provided, the most recent recording will be stopped. + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 956. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop-tap.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop-tap.mdx new file mode 100644 index 0000000000..9f91dcb992 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop-tap.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/stop-tap" +title: "stop_tap" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.stop_tap" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `stop_tap` + +Stop an active tap stream using SWML. + +This is a virtual helper that generates SWML to stop a tap stream +that was started with tap(). + +## Signature + +```python +stop_tap(control_id: Optional[str] = None) -> FunctionResult +``` + +## Parameters + + + ID of the tap to stop (optional) If not set, the last tap started will be stopped + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1253. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop.mdx new file mode 100644 index 0000000000..de40d0dcad --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.stop" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `stop` + +Stop the agent execution. + +## Signature + +```python +stop() -> FunctionResult +``` + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 479. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/switch-context.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/switch-context.mdx new file mode 100644 index 0000000000..6f1c1e2480 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/switch-context.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/switch-context" +title: "switch_context" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.switch_context" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `switch_context` + +Change agent context/prompt during conversation. + +## Signature + +```python +switch_context( + system_prompt: Optional[str] = None, + user_prompt: Optional[str] = None, + consolidate: bool = False, + full_reset: bool = False +) -> FunctionResult +``` + +## Parameters + + + New system prompt + + + + User message to add + + + + Whether to summarize existing conversation + + + + Whether to do complete context reset + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 699. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-change-context.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-change-context.mdx new file mode 100644 index 0000000000..b1e523c65e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-change-context.mdx @@ -0,0 +1,80 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/swml-change-context" +title: "swml_change_context" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.swml_change_context" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `swml_change_context` + +Force the conversation into a different context. + +Webhook-triggered context changes bypass any `valid_contexts` clamp. +Step state resets (cur\_step = 0) on entry. The new context's first +step's instructions are injected on the next turn. + +## Communicating intent to the destination context + +Same pattern as swml\_change\_step: the model reads your FunctionResult's +`response` text as the tool result before it sees the destination +context's first step. Put your reason there: + +``` +FunctionResult( + "I'm transferring you to billing because your question is " + "about an invoice charge." +).swml_change_context("billing") +``` + +For structured carry-over, use update\_global\_data() and reference the +values via $\{var\} expansion in the destination context's step text. + +Note that conversation history is preserved across context switches +unless the destination context is marked `isolated=True`. The model +retains everything the user said in the previous context — you do +not need to re-state it. + +> \[!NOTE] +> result = ( +> FunctionResult("Transferring you to technical support.") +> .update\_global\_data(\{"original\_issue": user\_problem\}) +> .swml\_change\_context("technical\_support") +> ) + +## Signature + +```python +swml_change_context(context_name: str) -> FunctionResult +``` + +## Parameters + + + Name of the context to switch to. Must exist in the agent's context map. + + +## Returns + +`FunctionResult` — Self for method chaining. + +## Examples + +```python +FunctionResult( + "I'm transferring you to billing because your question is " + "about an invoice charge." +).swml_change_context("billing") +``` + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 353. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-change-step.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-change-step.mdx new file mode 100644 index 0000000000..e9564fafc0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-change-step.mdx @@ -0,0 +1,113 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/swml-change-step" +title: "swml_change_step" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.swml_change_step" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `swml_change_step` + +Force the conversation into a specific step in the current context. + +This is a workflow-level transition driven by your webhook, not by the +model. Webhook-triggered step changes bypass any `valid_steps` clamp +on the current step (the model's `next_step` tool is the constrained +path; this is the unconstrained one). Use it when something the user +said unambiguously requires moving the flow forward. + +## Communicating intent to the destination step + +When the model arrives at the new step, the next thing it sees in +history is the tool result that contained this action — i.e., your +FunctionResult's `response` text. Put your "why" there. The model +reads it before the new step's injected instructions: + +``` +FunctionResult( + "Premium plan confirmed. Now collecting payment details." +).swml_change_step("collect_payment") +``` + +For structured data the destination step needs (account number, +plan tier, etc.), pair this with `update_global_data()` and reference +the values from the destination step's `text` via $\{var\} expansion: + +``` +(FunctionResult("Premium plan confirmed.") + .update_global_data({"plan": "premium", "billing_cycle": "annual"}) + .swml_change_step("collect_payment")) +``` + +And in the destination step's text: + +``` +step.set_text( + "Collect payment for the ${plan} plan, billed ${billing_cycle}. " + "Confirm the amount with the user before proceeding." +) +``` + +> \[!NOTE] +> result = ( +> FunctionResult("Starting a new hand") +> .update\_global\_data(\{"chips": 1000\}) +> .swml\_change\_step("betting") +> ) + +## Signature + +```python +swml_change_step(step_name: str) -> FunctionResult +``` + +## Parameters + + + Name of the step to transition to. The step must exist in the current context. + + +## Returns + +`FunctionResult` — Self for method chaining. + +## Examples + + + + ```python + FunctionResult( + "Premium plan confirmed. Now collecting payment details." + ).swml_change_step("collect_payment") + ``` + + + + ```python + (FunctionResult("Premium plan confirmed.") + .update_global_data({"plan": "premium", "billing_cycle": "annual"}) + .swml_change_step("collect_payment")) + ``` + + + + ```python + step.set_text( + "Collect payment for the ${plan} plan, billed ${billing_cycle}. " + "Confirm the amount with the user before proceeding." + ) + ``` + + + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 301. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-transfer.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-transfer.mdx new file mode 100644 index 0000000000..e3c2bf517a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-transfer.mdx @@ -0,0 +1,85 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/swml-transfer" +title: "swml_transfer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.swml_transfer" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `swml_transfer` + +Add a SWML transfer action with AI response setup for when transfer completes. + +This is a virtual helper that generates SWML to transfer the call to another +destination and sets up an AI response for when the transfer completes and +control returns to the agent. + +For transfers, you typically want to enable post-processing so the AI speaks +the response first before executing the transfer. + +> \[!NOTE] +> +> # Permanent transfer (default) +> +> result = ( +> FunctionResult("I'm transferring you to support", post\_process=True) +> .swml\_transfer( +> "https://support.example.com/swml", +> "Goodbye!" # Won't be used since final=True by default +> ) +> ) +> +> # Temporary transfer with return +> +> result.swml\_transfer( +> dest, +> "The support call is complete. How else can I help?", +> final=False +> ) + +## Signature + +```python +swml_transfer(dest: str, ai_response: str, final: bool = True) -> FunctionResult +``` + +## Parameters + + + Destination URL for the transfer (SWML endpoint, SIP address, etc.) + + + + Message the AI should say when transfer completes and control returns + + + + Whether this is a permanent transfer (True) or temporary (False). Defaults to True for permanent transfers (same as connect method). + + +## Returns + +`FunctionResult` — Self for method chaining + +## Examples + +```python +# Temporary transfer with return +result.swml_transfer( + dest, + "The support call is complete. How else can I help?", + final=False +) +``` + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 191. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-user-event.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-user-event.mdx new file mode 100644 index 0000000000..9d10fa59b8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/swml-user-event.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/swml-user-event" +title: "swml_user_event" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.swml_user_event" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `swml_user_event` + +Send a user event through SWML to update the client UI. + +This is a convenience method for sending user events to connected clients, +commonly used for real-time UI updates in interactive applications. + +> \[!NOTE] +> result = ( +> FunctionResult("You have blackjack!") +> .swml\_user\_event(\{ +> "type": "cards\_dealt", +> "player\_hand": player\_cards, +> "dealer\_hand": dealer\_cards, +> "player\_score": 21 +> \}) +> ) + +## Signature + +```python +swml_user_event(event_data: Dict[str, Any]) -> FunctionResult +``` + +## Parameters + + + Dictionary containing the event type and any associated data Example: \{"type": "cards\_dealt", "player\_hand": \[...], "score": 21\} + + +## Returns + +`FunctionResult` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 263. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/tap.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/tap.mdx new file mode 100644 index 0000000000..e6d3a28003 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/tap.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/tap" +title: "tap" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.tap" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `tap` + +Start background call tap using SWML. + +This is a virtual helper that generates SWML to start background call tapping. +Media is streamed over Websocket or RTP to customer controlled URI. + +## Signature + +```python +tap( + uri: str, + control_id: Optional[str] = None, + direction: str = 'both', + codec: str = 'PCMU', + rtp_ptime: int = 20, + status_url: Optional[str] = None +) -> FunctionResult +``` + +## Parameters + + + Destination of tap media stream (required) Formats: rtp://IP:port, ws://example.com, or wss://example.com + + + + Identifier for this tap to use with stop\_tap (optional) Default is generated and stored in tap\_control\_id variable + + + + Direction of audio to tap (default: "both") "speak" = what party says "hear" = what party hears\ + "both" = what party hears and says + + + + Codec for tap media stream - "PCMU" or "PCMA" (default: "PCMU") + + + + Packetization time in milliseconds for RTP (default: 20) + + + + URL for status change requests (optional) + + +## Returns + +`FunctionResult` — self for method chaining + +## Throws + +- `ValueError` — If direction or codec values are invalid + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1183. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/to-dict.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/to-dict.mdx new file mode 100644 index 0000000000..08da9709d0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/to-dict.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/to-dict" +title: "to_dict" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.to_dict" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `to_dict` + +Convert to the JSON structure expected by SWAIG + +The result must have at least one of: + +- 'response': Text to be spoken by the AI +- 'action': Array of action objects + +Optional: + +- 'post\_process': Boolean controlling when actions execute + +## Signature + +```python +to_dict() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` — Dictionary in SWAIG function response format + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 1503. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/toggle-functions.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/toggle-functions.mdx new file mode 100644 index 0000000000..139eb15918 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/toggle-functions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/toggle-functions" +title: "toggle_functions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.toggle_functions" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `toggle_functions` + +Enable/disable specific SWAIG functions. + +## Signature + +```python +toggle_functions(function_toggles: List[Dict[str, Any]]) -> FunctionResult +``` + +## Parameters + + + List of dicts with 'function' and 'active' keys + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 628. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/update-global-data.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/update-global-data.mdx new file mode 100644 index 0000000000..952a409d12 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/update-global-data.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/update-global-data" +title: "update_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.update_global_data" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `update_global_data` + +Update global agent data variables. + +This is a convenience method that abstracts the set\_global\_data action. +Global data persists across the entire agent session and is available +in prompt variables and can be accessed by all functions. + +## Signature + +```python +update_global_data(data: Dict[str, Any]) -> FunctionResult +``` + +## Parameters + + + Dictionary of key-value pairs to set/update in global data + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 247. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/update-settings.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/update-settings.mdx new file mode 100644 index 0000000000..0e37960ee1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/update-settings.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/update-settings" +title: "update_settings" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.update_settings" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `update_settings` + +Update agent runtime settings. + +Supported settings: + +- frequency-penalty: Float (-2.0 to 2.0) +- presence-penalty: Float (-2.0 to 2.0) +- max-tokens: Integer (0 to 4096) +- top-p: Float (0.0 to 1.0) +- confidence: Float (0.0 to 1.0) +- barge-confidence: Float (0.0 to 1.0) +- temperature: Float (0.0 to 2.0, clamped to 1.5) + +## Signature + +```python +update_settings(settings: Dict[str, Any]) -> FunctionResult +``` + +## Parameters + + + Dictionary of settings to update + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 678. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/wait-for-user.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/wait-for-user.mdx new file mode 100644 index 0000000000..57681c30db --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/function-result/wait-for-user.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/core/function-result/function-result/wait-for-user" +title: "wait_for_user" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.function_result.FunctionResult.wait_for_user" + parent: "signalwire.core.function_result.FunctionResult" + module: "signalwire.core.function_result" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `wait_for_user` + +Control how agent waits for user input. + +## Signature + +```python +wait_for_user( + enabled: Optional[bool] = None, + timeout: Optional[int] = None, + answer_first: bool = False +) -> FunctionResult +``` + +## Parameters + + + Boolean to enable/disable waiting + + + + Number of seconds to wait + + + + Special "answer\_first" mode + + +## Returns + +`FunctionResult` — self for method chaining + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) + +Line 456. diff --git a/fern/products/sdk-reference/python/signalwire/core/function-result/index.mdx b/fern/products/sdk-reference/python/signalwire/core/function-result/index.mdx new file mode 100644 index 0000000000..911c4219f2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/function-result/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/function-result" +title: "function_result" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.function_result" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py" +--- +# `function_result` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module function_result +``` + +## Properties + + + +## Classes + + + + Wrapper around SWAIG function responses that handles proper formatting of response text and actions. + + + +## Source + +[`signalwire/signalwire/core/function_result.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/function_result.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/index.mdx b/fern/products/sdk-reference/python/signalwire/core/index.mdx new file mode 100644 index 0000000000..fa1ffbcea4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/index.mdx @@ -0,0 +1,116 @@ +--- +slug: "/reference/python/signalwire/core" +title: "core" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/__init__.py" +--- +# `core` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module core +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/core/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/logging-config/configure-logging.mdx b/fern/products/sdk-reference/python/signalwire/core/logging-config/configure-logging.mdx new file mode 100644 index 0000000000..7be166d535 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/logging-config/configure-logging.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/python/signalwire/core/logging-config/configure-logging" +title: "configure_logging" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.logging_config.configure_logging" + parent: "signalwire.core.logging_config" + module: "signalwire.core.logging_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py" +--- +# `configure_logging` + +Configure logging system once, globally, based on environment variables + +> \[!NOTE] +> SIGNALWIRE\_LOG\_MODE: off, stderr, default, auto +> SIGNALWIRE\_LOG\_LEVEL: debug, info, warning, error, critical +> SIGNALWIRE\_LOG\_FORMAT: console, json (default: console) + +## Signature + +```python +configure_logging() +``` + +## Source + +[`signalwire/signalwire/core/logging_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py) + +Line 98. diff --git a/fern/products/sdk-reference/python/signalwire/core/logging-config/get-execution-mode.mdx b/fern/products/sdk-reference/python/signalwire/core/logging-config/get-execution-mode.mdx new file mode 100644 index 0000000000..b8ef7ec1d8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/logging-config/get-execution-mode.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/logging-config/get-execution-mode" +title: "get_execution_mode" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.logging_config.get_execution_mode" + parent: "signalwire.core.logging_config" + module: "signalwire.core.logging_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py" +--- +# `get_execution_mode` + +Determine the execution mode based on environment variables + +## Signature + +```python +get_execution_mode() +``` + +## Returns + +'server', 'cgi', 'lambda', 'google\_cloud\_function', 'azure\_function', or 'unknown' + +## Source + +[`signalwire/signalwire/core/logging_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py) + +Line 44. diff --git a/fern/products/sdk-reference/python/signalwire/core/logging-config/get-logger.mdx b/fern/products/sdk-reference/python/signalwire/core/logging-config/get-logger.mdx new file mode 100644 index 0000000000..fd18d9a17d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/logging-config/get-logger.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/logging-config/get-logger" +title: "get_logger" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.logging_config.get_logger" + parent: "signalwire.core.logging_config" + module: "signalwire.core.logging_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py" +--- +# `get_logger` + +Get a logger instance for the specified name with structured logging support + +This is the single entry point for all logging in the SDK. +All modules should use this instead of direct logging module usage. + +## Signature + +```python +get_logger(name) +``` + +## Parameters + + + Logger name, typically **name** + + +## Returns + +A structlog BoundLogger that supports .bind(), .info(), .debug(), etc. + +## Source + +[`signalwire/signalwire/core/logging_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py) + +Line 280. diff --git a/fern/products/sdk-reference/python/signalwire/core/logging-config/index.mdx b/fern/products/sdk-reference/python/signalwire/core/logging-config/index.mdx new file mode 100644 index 0000000000..f6b1486654 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/logging-config/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/logging-config" +title: "logging_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.logging_config" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py" +--- +# `logging_config` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module logging_config +``` + +## Functions + + + + Configure logging system once, globally, based on environment variables + + + + Determine the execution mode based on environment variables + + + + Get a logger instance for the specified name with structured logging support + + + + Reset the logging configuration flag to allow reconfiguration + + + + Strip control characters from log event values to prevent log injection. + + + +## Source + +[`signalwire/signalwire/core/logging_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/logging-config/reset-logging-configuration.mdx b/fern/products/sdk-reference/python/signalwire/core/logging-config/reset-logging-configuration.mdx new file mode 100644 index 0000000000..b6f5962d9b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/logging-config/reset-logging-configuration.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/core/logging-config/reset-logging-configuration" +title: "reset_logging_configuration" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.logging_config.reset_logging_configuration" + parent: "signalwire.core.logging_config" + module: "signalwire.core.logging_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py" +--- +# `reset_logging_configuration` + +Reset the logging configuration flag to allow reconfiguration + +This is useful when environment variables change after initial configuration. + +## Signature + +```python +reset_logging_configuration() +``` + +## Source + +[`signalwire/signalwire/core/logging_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py) + +Line 75. diff --git a/fern/products/sdk-reference/python/signalwire/core/logging-config/strip-control-chars.mdx b/fern/products/sdk-reference/python/signalwire/core/logging-config/strip-control-chars.mdx new file mode 100644 index 0000000000..84f99e95bb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/logging-config/strip-control-chars.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/core/logging-config/strip-control-chars" +title: "strip_control_chars" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.logging_config.strip_control_chars" + parent: "signalwire.core.logging_config" + module: "signalwire.core.logging_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py" +--- +# `strip_control_chars` + +Strip control characters from log event values to prevent log injection. + +## Signature + +```python +strip_control_chars(logger, method_name, event_dict) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/core/logging_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/logging_config.py) + +Line 33. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-function-include.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-function-include.mdx new file mode 100644 index 0000000000..a1bebe487b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-function-include.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-function-include" +title: "add_function_include" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.add_function_include" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `add_function_include` + +Add a remote function include to the SWAIG configuration + +## Signature + +```python +add_function_include( + url: str, + functions: List[str], + meta_data: Optional[Dict[str, Any]] = None +) -> AgentBase +``` + +## Parameters + + + URL to fetch remote functions from + + + + List of function names to include + + + + Optional metadata to include with the function include + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 502. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-hint.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-hint.mdx new file mode 100644 index 0000000000..b78e23b980 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-hint.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-hint" +title: "add_hint" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.add_hint" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `add_hint` + +Add a simple string hint to help the AI agent understand certain words better + +## Signature + +```python +add_hint(hint: str) -> AgentBase +``` + +## Parameters + + + The hint string to add + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 19. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-hints.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-hints.mdx new file mode 100644 index 0000000000..1eb95f4950 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-hints.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-hints" +title: "add_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.add_hints" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `add_hints` + +Add multiple string hints + +## Signature + +```python +add_hints(hints: List[str]) -> AgentBase +``` + +## Parameters + + + List of hint strings + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 33. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-internal-filler.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-internal-filler.mdx new file mode 100644 index 0000000000..1894de6da9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-internal-filler.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-internal-filler" +title: "add_internal_filler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.add_internal_filler" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `add_internal_filler` + +Add internal fillers for a single internal function and language. + +See set\_internal\_fillers() for the complete list of supported +function\_name values and an explanation of what fillers do. + +> \[!NOTE] +> agent.add\_internal\_filler( +> "change\_context", "en-US", +> \["Let me switch over to that...", "One moment..."] +> ) + +## Signature + +```python +add_internal_filler( + function_name: str, + language_code: str, + fillers: List[str] +) -> AgentBase +``` + +## Parameters + + + One of the supported internal function names (see SUPPORTED\_INTERNAL\_FILLER\_NAMES). Common values: 'next\_step', 'change\_context', 'check\_time', 'wait\_for\_user', 'hangup'. Names outside the supported set log a warning and are ignored by the runtime. + + + + Language code (e.g. 'en-US', 'es', 'fr'). + + + + List of filler phrases for this function and language. + + +## Returns + +`AgentBase` — Self for method chaining. + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 425. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-language.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-language.mdx new file mode 100644 index 0000000000..035bda83f3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-language.mdx @@ -0,0 +1,109 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-language" +title: "add_language" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.add_language" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `add_language` + +Add a language configuration to support multilingual conversations + +# Simple voice name + +agent.add\_language("English", "en-US", "en-US-Neural2-F") + +# Explicit parameters + +agent.add\_language("English", "en-US", "josh", engine="elevenlabs", model="eleven\_turbo\_v2\_5") + +# Combined format + +agent.add\_language("English", "en-US", "elevenlabs.josh:eleven\_turbo\_v2\_5") + +# Per-language params (engine-specific knobs) + +agent.add\_language("English", "en-US", "josh", +engine="elevenlabs", +params=\{"stability": 0.5, "similarity\_boost": 0.75\}) + +## Signature + +```python +add_language( + name: str, + code: str, + voice: str, + speech_fillers: Optional[List[str]] = None, + function_fillers: Optional[List[str]] = None, + engine: Optional[str] = None, + model: Optional[str] = None, + params: Optional[Dict[str, Any]] = None +) -> AgentBase +``` + +## Parameters + + + Name of the language (e.g., "English", "French") + + + + Language code (e.g., "en-US", "fr-FR") + + + + TTS voice to use. Can be a simple name (e.g., "en-US-Neural2-F") or a combined format "engine.voice:model" (e.g., "elevenlabs.josh:eleven\_turbo\_v2\_5") + + + + Optional list of filler phrases for natural speech + + + + Optional list of filler phrases during function calls + + + + Optional explicit engine name (e.g., "elevenlabs", "rime") + + + + Optional explicit model name (e.g., "eleven\_turbo\_v2\_5", "arcana") + + + + Optional per-language params dict (engine-specific tuning, voice settings, etc.). Emitted as the language object's `params` key in SWML. + + +## Returns + +`AgentBase` — Self for method chaining + +## Examples + +```python +# Explicit parameters +agent.add_language("English", "en-US", "josh", engine="elevenlabs", model="eleven_turbo_v2_5") + +# Combined format +agent.add_language("English", "en-US", "elevenlabs.josh:eleven_turbo_v2_5") + +# Per-language params (engine-specific knobs) +agent.add_language("English", "en-US", "josh", + engine="elevenlabs", + params={"stability": 0.5, "similarity_boost": 0.75}) +``` + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 75. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-mcp-server.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-mcp-server.mdx new file mode 100644 index 0000000000..b2261eb9b9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-mcp-server.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-mcp-server" +title: "add_mcp_server" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.add_mcp_server" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `add_mcp_server` + +Add an external MCP server for tool discovery and invocation. + +Tools are discovered via the MCP protocol at session start and +registered as SWAIG functions. Resources are optionally fetched +into global\_data. + +## Signature + +```python +add_mcp_server( + url: str, + headers: Optional[Dict[str, str]] = None, + resources: bool = False, + resource_vars: Optional[Dict[str, str]] = None +) -> AgentBase +``` + +## Parameters + + + MCP server HTTP endpoint URL + + + + Optional HTTP headers (e.g. \{"Authorization": "Bearer sk-xxx"\}) + + + + Whether to fetch resources into global\_data + + + + Variables for URI template substitution (e.g. \{"caller\_id": "$\{caller\_id\_number\}"\}) + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 546. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-pattern-hint.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-pattern-hint.mdx new file mode 100644 index 0000000000..ea626ce346 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-pattern-hint.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-pattern-hint" +title: "add_pattern_hint" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.add_pattern_hint" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `add_pattern_hint` + +Add a complex hint with pattern matching + +## Signature + +```python +add_pattern_hint( + hint: str, + pattern: str, + replace: str, + ignore_case: bool = False +) -> AgentBase +``` + +## Parameters + + + The hint to match + + + + Regular expression pattern + + + + Text to replace the hint with + + + + Whether to ignore case when matching + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 49. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-pronunciation.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-pronunciation.mdx new file mode 100644 index 0000000000..2d3d32df12 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-pronunciation.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/add-pronunciation" +title: "add_pronunciation" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.add_pronunciation" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `add_pronunciation` + +Add a pronunciation rule to help the AI speak certain words correctly + +## Signature + +```python +add_pronunciation( + replace: str, + with_text: str, + ignore_case: bool = False +) -> AgentBase +``` + +## Parameters + + + The expression to replace + + + + The phonetic spelling to use instead + + + + Whether to ignore case when matching + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 217. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/enable-debug-events.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/enable-debug-events.mdx new file mode 100644 index 0000000000..4006cd5ecf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/enable-debug-events.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/enable-debug-events" +title: "enable_debug_events" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.enable_debug_events" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `enable_debug_events` + +Enable debug event webhook for this agent. + +When enabled, the AI module will POST real-time debug events to a +/debug\_events endpoint on this agent during calls. Events are +automatically logged via the agent's structured logger, and can +optionally be handled with a custom callback via on\_debug\_event(). + +> \[!NOTE] +> agent = AgentBase("my\_agent") +> agent.enable\_debug\_events(level=1) +> +> @agent.on\_debug\_event +> def handle\_debug(event\_type, data): +> if event\_type == "llm\_error": +> alert\_ops\_team(data) + +## Signature + +```python +enable_debug_events(level: int = 1) -> AgentBase +``` + +## Parameters + + + Debug event verbosity level. 1 = high-level events (barge, errors, session start/end, step changes) 2+ = adds high-volume events (every LLM request/response, conversation\_add) + + +## Returns + +`AgentBase` — Self for method chaining + +## Examples + +```python +@agent.on_debug_event +def handle_debug(event_type, data): + if event_type == "llm_error": + alert_ops_team(data) +``` + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 472. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/enable-mcp-server.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/enable-mcp-server.mdx new file mode 100644 index 0000000000..0c44f0de6e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/enable-mcp-server.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/enable-mcp-server" +title: "enable_mcp_server" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.enable_mcp_server" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `enable_mcp_server` + +Expose this agent's @tool functions as an MCP server endpoint. + +Adds a /mcp route that speaks JSON-RPC 2.0 (MCP protocol). +Other MCP clients (Claude Desktop, other agents, etc.) can +connect and use the same tools. The agent's SWML output also +references this endpoint for native MCP tool discovery. + +## Signature + +```python +enable_mcp_server() -> AgentBase +``` + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 574. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/get-language-params.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/get-language-params.mdx new file mode 100644 index 0000000000..fa3833dcb8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/get-language-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/get-language-params" +title: "get_language_params" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.get_language_params" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `get_language_params` + +Read the per-language `params` dict for a previously-added language. + +## Signature + +```python +get_language_params(code: str) -> Optional[Dict[str, Any]] +``` + +## Parameters + + + Language code as previously passed to `add_language`. + + +## Returns + +`Optional[Dict[str, Any]]` — The params dict if set, `None` otherwise (including when the code is unknown). + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 188. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/index.mdx new file mode 100644 index 0000000000..4ebe96a314 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/index.mdx @@ -0,0 +1,129 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin" +title: "AIConfigMixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + parent: "signalwire.core.mixins.ai_config_mixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `AIConfigMixin` + +Mixin class containing all AI configuration methods for AgentBase + +## Signature + +```python +class AIConfigMixin +``` + +## Properties + + + +## Methods + + + + Add a remote function include to the SWAIG configuration + + + + Add a simple string hint to help the AI agent understand certain words better + + + + Add multiple string hints + + + + Add internal fillers for a single internal function and language. + + + + Add a language configuration to support multilingual conversations + + + + Add an external MCP server for tool discovery and invocation. + + + + Add a complex hint with pattern matching + + + + Add a pronunciation rule to help the AI speak certain words correctly + + + + Enable debug event webhook for this agent. + + + + Expose this agent's @tool functions as an MCP server endpoint. + + + + Read the per-language `params` dict for a previously-added language. + + + + Set the complete list of function includes + + + + Merge data into the global data available to the AI throughout the conversation. + + + + Set internal fillers for native SWAIG functions. + + + + Set (or replace) the per-language `params` dict on an already-added language. Useful when language entries are built up via add\_language() first and engine-specific tuning is added later (e.g., from a config loader). Returns self for chaining. + + + + Set all language configurations at once + + + + Set the list of native functions to enable + + + + Set a single AI parameter + + + + Set multiple AI parameters at once + + + + Set LLM parameters for the post-prompt. + + + + Set LLM parameters for the main prompt. + + + + Set all pronunciation rules at once + + + + Update the global data with new values + + + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 14. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-function-includes.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-function-includes.mdx new file mode 100644 index 0000000000..9de9d18483 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-function-includes.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-function-includes" +title: "set_function_includes" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.set_function_includes" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `set_function_includes` + +Set the complete list of function includes + +## Signature + +```python +set_function_includes(includes: List[Dict[str, Any]]) -> AgentBase +``` + +## Parameters + + + List of include objects, each with url and functions properties + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 525. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-global-data.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-global-data.mdx new file mode 100644 index 0000000000..bf7dcbfbc9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-global-data.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-global-data" +title: "set_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.set_global_data" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `set_global_data` + +Merge data into the global data available to the AI throughout the conversation. + +This merges (not replaces) so that skills and other callers can each +contribute keys without clobbering each other. + +## Signature + +```python +set_global_data(data: Dict[str, Any]) -> AgentBase +``` + +## Parameters + + + Dictionary of global data to merge + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 286. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-internal-fillers.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-internal-fillers.mdx new file mode 100644 index 0000000000..6acc04653b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-internal-fillers.mdx @@ -0,0 +1,97 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-internal-fillers" +title: "set_internal_fillers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.set_internal_fillers" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `set_internal_fillers` + +Set internal fillers for native SWAIG functions. + +Internal fillers are short phrases the AI agent speaks (via TTS) while +an internal/native function is running, so the caller doesn't hear +dead air during transitions or background work. + +Supported function names (matches the SWAIGInternalFiller schema): + +``` +hangup — when the agent is hanging up +check_time — when checking the time +wait_for_user — when waiting for user input +wait_seconds — during deliberate pauses +adjust_response_latency — when adjusting response timing +next_step — transitioning between steps in prompt.contexts +change_context — switching between contexts in prompt.contexts +get_visual_input — processing visual input (enable_vision=True) +get_ideal_strategy — thinking (enable_thinking=True) +``` + +Notably NOT supported: change\_step, gather\_submit, or arbitrary +user-defined SWAIG function names. The runtime only honors fillers +for the names listed above; everything else is silently ignored at +the SWML level. This method warns at registration time if you pass +an unknown name so you catch the typo early. + +Without internal fillers, callers hear dead air during context +switches and other internal transitions — set this on every agent +that uses contexts/steps with audio. + +> \[!NOTE] +> agent.set\_internal\_fillers(\{ +> "next\_step": \{ +> "en-US": \["Moving to the next step...", "Great, let's continue..."], +> "es": \["Pasando al siguiente paso...", "Excelente, continuemos..."] +> \}, +> "change\_context": \{ +> "en-US": \["Let me switch modes...", "One moment..."] +> \}, +> "check\_time": \{ +> "en-US": \["Let me check the time...", "Getting the current time..."] +> \} +> \}) + +## Signature + +```python +set_internal_fillers( + internal_fillers: Dict[str, Dict[str, List[str]]] +) -> AgentBase +``` + +## Parameters + + + Dictionary mapping function names to language-specific filler phrases. Format: \{"function\_name": \{"language\_code": \["phrase1", "phrase2"]\}\} + + +## Returns + +`AgentBase` — Self for method chaining. + +## Examples + +```python +hangup — when the agent is hanging up +check_time — when checking the time +wait_for_user — when waiting for user input +wait_seconds — during deliberate pauses +adjust_response_latency — when adjusting response timing +next_step — transitioning between steps in prompt.contexts +change_context — switching between contexts in prompt.contexts +get_visual_input — processing visual input (enable_vision=True) +get_ideal_strategy — thinking (enable_thinking=True) +``` + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 353. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-language-params.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-language-params.mdx new file mode 100644 index 0000000000..ecf07e4680 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-language-params.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-language-params" +title: "set_language_params" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.set_language_params" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `set_language_params` + +Set (or replace) the per-language `params` dict on an already-added +language. Useful when language entries are built up via add\_language() +first and engine-specific tuning is added later (e.g., from a config +loader). Returns self for chaining. + +## Signature + +```python +set_language_params(code: str, params: Dict[str, Any]) -> AgentBase +``` + +## Parameters + + + Language code as previously passed to `add_language` (e.g. `"en-US"`). + + + + Engine-specific params dict to attach. Empty dict removes the key. + + +## Returns + +`AgentBase` — Self for method chaining. No-op if the code isn't found. + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 165. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-languages.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-languages.mdx new file mode 100644 index 0000000000..6198532207 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-languages.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-languages" +title: "set_languages" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.set_languages" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `set_languages` + +Set all language configurations at once + +## Signature + +```python +set_languages(languages: List[Dict[str, Any]]) -> AgentBase +``` + +## Parameters + + + List of language configuration dictionaries + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 203. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-native-functions.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-native-functions.mdx new file mode 100644 index 0000000000..1813e92ab5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-native-functions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-native-functions" +title: "set_native_functions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.set_native_functions" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `set_native_functions` + +Set the list of native functions to enable + +## Signature + +```python +set_native_functions(function_names: List[str]) -> AgentBase +``` + +## Parameters + + + List of native function names + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 323. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-param.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-param.mdx new file mode 100644 index 0000000000..537b6f190e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-param.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-param" +title: "set_param" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.set_param" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `set_param` + +Set a single AI parameter + +## Signature + +```python +set_param(key: str, value: Any) -> AgentBase +``` + +## Parameters + + + Parameter name + + + + Parameter value + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 257. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-params.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-params.mdx new file mode 100644 index 0000000000..ff712ab098 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-params" +title: "set_params" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.set_params" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `set_params` + +Set multiple AI parameters at once + +## Signature + +```python +set_params(params: Dict[str, Any]) -> AgentBase +``` + +## Parameters + + + Dictionary of parameter name/value pairs + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 272. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..8da065094c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-post-prompt-llm-params.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-post-prompt-llm-params" +title: "set_post_prompt_llm_params" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.set_post_prompt_llm_params" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `set_post_prompt_llm_params` + +Set LLM parameters for the post-prompt. + +Accepts any parameters which will be passed through to the SignalWire server. +The server will validate and apply parameters based on the target model's capabilities. + +> \[!NOTE] +> model: The AI model to use (gpt-4o-mini, gpt-4.1-mini, gpt-4.1-nano, nova-micro, nova-lite, qwen3-235b-A22b-instruct) +> temperature: Randomness setting. Lower values make output more deterministic. +> top\_p: Alternative to temperature. Controls nucleus sampling. +> presence\_penalty: Topic diversity. Positive values encourage new topics. +> frequency\_penalty: Repetition control. Positive values reduce repetition. + +Note: Parameters are model-specific and will be validated by the server. +Invalid parameters for the selected model will be handled/ignored by the server. +barge\_confidence is not applicable to post-prompt. + +> \[!NOTE] +> agent.set\_post\_prompt\_llm\_params( +> model="gpt-4o-mini", +> temperature=0.5, # More deterministic for post-prompt +> top\_p=0.9 +> ) + +## Signature + +```python +set_post_prompt_llm_params(**params = {}) -> AgentBase +``` + +## Parameters + + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 624. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-prompt-llm-params.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..ca7336fbe3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-prompt-llm-params.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-prompt-llm-params" +title: "set_prompt_llm_params" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.set_prompt_llm_params" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `set_prompt_llm_params` + +Set LLM parameters for the main prompt. + +Accepts any parameters which will be passed through to the SignalWire server. +The server will validate and apply parameters based on the target model's capabilities. + +> \[!NOTE] +> model: The AI model to use (gpt-4o-mini, gpt-4.1-mini, gpt-4.1-nano, nova-micro, nova-lite, qwen3-235b-A22b-instruct) +> temperature: Randomness setting. Lower values make output more deterministic. +> top\_p: Alternative to temperature. Controls nucleus sampling. +> barge\_confidence: ASR confidence to interrupt. Higher values make it harder to interrupt. +> presence\_penalty: Topic diversity. Positive values encourage new topics. +> frequency\_penalty: Repetition control. Positive values reduce repetition. + +Note: Parameters are model-specific and will be validated by the server. +Invalid parameters for the selected model will be handled/ignored by the server. + +> \[!NOTE] +> agent.set\_prompt\_llm\_params( +> model="nova-micro", # Using Amazon's nova-micro model +> temperature=0.7, +> top\_p=0.9, +> barge\_confidence=0.6 +> ) + +## Signature + +```python +set_prompt_llm_params(**params = {}) -> AgentBase +``` + +## Parameters + + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 589. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-pronunciations.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-pronunciations.mdx new file mode 100644 index 0000000000..040b30b7e2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-pronunciations.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/set-pronunciations" +title: "set_pronunciations" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.set_pronunciations" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `set_pronunciations` + +Set all pronunciation rules at once + +## Signature + +```python +set_pronunciations(pronunciations: List[Dict[str, Any]]) -> AgentBase +``` + +## Parameters + + + List of pronunciation rule dictionaries + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 243. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/update-global-data.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/update-global-data.mdx new file mode 100644 index 0000000000..47b36255b4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/update-global-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin/ai-config-mixin/update-global-data" +title: "update_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin.update_global_data" + parent: "signalwire.core.mixins.ai_config_mixin.AIConfigMixin" + module: "signalwire.core.mixins.ai_config_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `update_global_data` + +Update the global data with new values + +## Signature + +```python +update_global_data(data: Dict[str, Any]) -> AgentBase +``` + +## Parameters + + + Dictionary of global data to update + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) + +Line 306. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/index.mdx new file mode 100644 index 0000000000..2ab657d194 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/ai-config-mixin/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/mixins/ai-config-mixin" +title: "ai_config_mixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.mixins.ai_config_mixin" + parent: "signalwire.core.mixins" + module: "signalwire.core.mixins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py" +--- +# `ai_config_mixin` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module ai_config_mixin +``` + +## Classes + + + + Mixin class containing all AI configuration methods for AgentBase + + + +## Source + +[`signalwire/signalwire/core/mixins/ai_config_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/ai_config_mixin.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/auth-mixin/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/auth-mixin/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..75c2b25f1d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/auth-mixin/get-basic-auth-credentials.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/core/mixins/auth-mixin/auth-mixin/get-basic-auth-credentials" +title: "get_basic_auth_credentials" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.auth_mixin.AuthMixin.get_basic_auth_credentials" + parent: "signalwire.core.mixins.auth_mixin.AuthMixin" + module: "signalwire.core.mixins.auth_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/auth_mixin.py" +--- +# `get_basic_auth_credentials` + +Get the basic auth credentials + +## Signature + +```python +get_basic_auth_credentials( + include_source: bool = False +) -> Union[Tuple[str, str], Tuple[str, str, str]] +``` + +## Parameters + + + Whether to include the source of the credentials + + +## Returns + +`Union[Tuple[str, str], Tuple[str, str, str]]` — If include\_source is False: (username, password) tuple If include\_source is True: (username, password, source) tuple, where source is one of: "provided", "environment", or "generated" + +## Source + +[`signalwire/signalwire/core/mixins/auth_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/auth_mixin.py) + +Line 42. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/auth-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/auth-mixin/index.mdx new file mode 100644 index 0000000000..9182cb4d0c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/auth-mixin/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/core/mixins/auth-mixin/auth-mixin" +title: "AuthMixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.mixins.auth_mixin.AuthMixin" + parent: "signalwire.core.mixins.auth_mixin" + module: "signalwire.core.mixins.auth_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/auth_mixin.py" +--- +# `AuthMixin` + +Mixin class containing all authentication-related methods for AgentBase + +## Signature + +```python +class AuthMixin +``` + +## Methods + + + + Get the basic auth credentials + + + + Validate basic auth credentials + + + +## Source + +[`signalwire/signalwire/core/mixins/auth_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/auth_mixin.py) + +Line 19. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/auth-mixin/validate-basic-auth.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/auth-mixin/validate-basic-auth.mdx new file mode 100644 index 0000000000..223f560450 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/auth-mixin/validate-basic-auth.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/core/mixins/auth-mixin/auth-mixin/validate-basic-auth" +title: "validate_basic_auth" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.auth_mixin.AuthMixin.validate_basic_auth" + parent: "signalwire.core.mixins.auth_mixin.AuthMixin" + module: "signalwire.core.mixins.auth_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/auth_mixin.py" +--- +# `validate_basic_auth` + +Validate basic auth credentials + +This method can be overridden by subclasses. + +## Signature + +```python +validate_basic_auth(username: str, password: str) -> bool +``` + +## Parameters + + + Username from request + + + + Password from request + + +## Returns + +`bool` — True if valid, False otherwise + +## Source + +[`signalwire/signalwire/core/mixins/auth_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/auth_mixin.py) + +Line 24. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/index.mdx new file mode 100644 index 0000000000..22d2852da8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/auth-mixin/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/mixins/auth-mixin" +title: "auth_mixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.mixins.auth_mixin" + parent: "signalwire.core.mixins" + module: "signalwire.core.mixins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/auth_mixin.py" +--- +# `auth_mixin` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module auth_mixin +``` + +## Classes + + + + Mixin class containing all authentication-related methods for AgentBase + + + +## Source + +[`signalwire/signalwire/core/mixins/auth_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/auth_mixin.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/index.mdx new file mode 100644 index 0000000000..46ad5cbdaa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/index.mdx @@ -0,0 +1,76 @@ +--- +slug: "/reference/python/signalwire/core/mixins" +title: "mixins" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.mixins" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/__init__.py" +--- +# `mixins` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module mixins +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/core/mixins/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/mcp-server-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/mcp-server-mixin/index.mdx new file mode 100644 index 0000000000..40f22a74bc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/mcp-server-mixin/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/mixins/mcp-server-mixin" +title: "mcp_server_mixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.mixins.mcp_server_mixin" + parent: "signalwire.core.mixins" + module: "signalwire.core.mixins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/mcp_server_mixin.py" +--- +# `mcp_server_mixin` + +Copyright (c) 2025 SignalWire + +MCP Server Mixin for AgentBase + +Exposes @tool decorated functions as an MCP server endpoint at /mcp. +Handles the MCP JSON-RPC 2.0 protocol: initialize, tools/list, tools/call. + +## Signature + +```python +module mcp_server_mixin +``` + +## Properties + + + +## Classes + + + + Mixin that adds MCP server endpoint to an agent + + + +## Source + +[`signalwire/signalwire/core/mixins/mcp_server_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/mcp_server_mixin.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/mcp-server-mixin/mcp-server-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/mcp-server-mixin/mcp-server-mixin/index.mdx new file mode 100644 index 0000000000..d2b138ab30 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/mcp-server-mixin/mcp-server-mixin/index.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/core/mixins/mcp-server-mixin/mcp-server-mixin" +title: "MCPServerMixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.mixins.mcp_server_mixin.MCPServerMixin" + parent: "signalwire.core.mixins.mcp_server_mixin" + module: "signalwire.core.mixins.mcp_server_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/mcp_server_mixin.py" +--- +# `MCPServerMixin` + +Mixin that adds MCP server endpoint to an agent + +## Signature + +```python +class MCPServerMixin +``` + +## Source + +[`signalwire/signalwire/core/mixins/mcp_server_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/mcp_server_mixin.py) + +Line 18. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/index.mdx new file mode 100644 index 0000000000..b1b036eeae --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin" +title: "prompt_mixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin" + parent: "signalwire.core.mixins" + module: "signalwire.core.mixins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `prompt_mixin` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module prompt_mixin +``` + +## Classes + + + + Mixin class containing all prompt-related methods for AgentBase + + + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/define-contexts.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/define-contexts.mdx new file mode 100644 index 0000000000..730ea1dc5d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/define-contexts.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/define-contexts" +title: "define_contexts" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin.define_contexts" + parent: "signalwire.core.mixins.prompt_mixin.PromptMixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `define_contexts` + +Define contexts and steps for this agent (alternative to POM/prompt) + +> \[!NOTE] +> Contexts can coexist with traditional prompts. The restriction is only +> that you can't mix POM sections with raw text in the main prompt. + +## Signature + +```python +define_contexts(contexts = None) -> Union[AgentBase, ContextBuilder] +``` + +## Parameters + + + Optional context configuration (dict or ContextBuilder) + + +## Returns + +`Union[AgentBase, ContextBuilder]` — ContextBuilder for method chaining if no contexts provided + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 121. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/get-post-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/get-post-prompt.mdx new file mode 100644 index 0000000000..eb5ad250f9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/get-post-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/get-post-prompt" +title: "get_post_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin.get_post_prompt" + parent: "signalwire.core.mixins.prompt_mixin.PromptMixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `get_post_prompt` + +Get the post-prompt for the agent + +## Signature + +```python +get_post_prompt() -> Optional[str] +``` + +## Returns + +`Optional[str]` — Post-prompt text or None if not set + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 374. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/get-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/get-prompt.mdx new file mode 100644 index 0000000000..df3ae936f6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/get-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/get-prompt" +title: "get_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin.get_prompt" + parent: "signalwire.core.mixins.prompt_mixin.PromptMixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `get_prompt` + +Get the prompt for the agent + +## Signature + +```python +get_prompt() -> Union[str, List[Dict[str, Any]]] +``` + +## Returns + +`Union[str, List[Dict[str, Any]]]` — Either a string prompt or a POM object as list of dicts + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 327. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/index.mdx new file mode 100644 index 0000000000..03912f88f0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin" +title: "PromptMixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin" + parent: "signalwire.core.mixins.prompt_mixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `PromptMixin` + +Mixin class containing all prompt-related methods for AgentBase + +## Signature + +```python +class PromptMixin +``` + +## Properties + + + Get the ContextBuilder for this agent + + +## Methods + + + + Define contexts and steps for this agent (alternative to POM/prompt) + + + + Get the post-prompt for the agent + + + + Get the prompt for the agent + + + + Add a section to the prompt + + + + Add a subsection to an existing section (creating parent if needed) + + + + Add content to an existing section (creating it if needed) + + + + Check if a section exists in the prompt + + + + Remove all contexts, returning the agent to a no-contexts state. + + + + Set the post-prompt text for summary generation + + + + Set the prompt as a POM dictionary + + + + Set the prompt as raw text instead of using POM + + + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 19. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-section.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-section.mdx new file mode 100644 index 0000000000..d960e231ee --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-section.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-section" +title: "prompt_add_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin.prompt_add_section" + parent: "signalwire.core.mixins.prompt_mixin.PromptMixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `prompt_add_section` + +Add a section to the prompt + +## Signature + +```python +prompt_add_section( + title: str, + body: str = '', + bullets: Optional[List[str]] = None, + numbered: bool = False, + numbered_bullets: bool = False, + subsections: Optional[List[Dict[str, Any]]] = None +) -> AgentBase +``` + +## Parameters + + + Section title + + + + Optional section body text + + + + Optional list of bullet points + + + + Whether this section should be numbered + + + + Whether bullets should be numbered + + + + Optional list of subsection objects + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 228. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-subsection.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-subsection.mdx new file mode 100644 index 0000000000..410d1e5533 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-subsection.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-subsection" +title: "prompt_add_subsection" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin.prompt_add_subsection" + parent: "signalwire.core.mixins.prompt_mixin.PromptMixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `prompt_add_subsection` + +Add a subsection to an existing section (creating parent if needed) + +## Signature + +```python +prompt_add_subsection( + parent_title: str, + title: str, + body: str = '', + bullets: Optional[List[str]] = None +) -> AgentBase +``` + +## Parameters + + + Parent section title + + + + Subsection title + + + + Optional subsection body text + + + + Optional list of bullet points + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 288. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-to-section.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-to-section.mdx new file mode 100644 index 0000000000..b0c299f051 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-to-section.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-add-to-section" +title: "prompt_add_to_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin.prompt_add_to_section" + parent: "signalwire.core.mixins.prompt_mixin.PromptMixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `prompt_add_to_section` + +Add content to an existing section (creating it if needed) + +## Signature + +```python +prompt_add_to_section( + title: str, + body: Optional[str] = None, + bullet: Optional[str] = None, + bullets: Optional[List[str]] = None +) -> AgentBase +``` + +## Parameters + + + Section title + + + + Optional text to append to section body + + + + Optional single bullet point to add + + + + Optional list of bullet points to add + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 261. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-has-section.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-has-section.mdx new file mode 100644 index 0000000000..95cf290d36 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-has-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/prompt-has-section" +title: "prompt_has_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin.prompt_has_section" + parent: "signalwire.core.mixins.prompt_mixin.PromptMixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `prompt_has_section` + +Check if a section exists in the prompt + +## Signature + +```python +prompt_has_section(title: str) -> bool +``` + +## Parameters + + + Section title to check + + +## Returns + +`bool` — True if section exists, False otherwise + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 315. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/reset-contexts.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/reset-contexts.mdx new file mode 100644 index 0000000000..de1283d084 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/reset-contexts.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/reset-contexts" +title: "reset_contexts" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin.reset_contexts" + parent: "signalwire.core.mixins.prompt_mixin.PromptMixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `reset_contexts` + +Remove all contexts, returning the agent to a no-contexts state. + +This is a convenience wrapper around `define_contexts().reset()`. +Use it in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +Example:: + +``` +def on_dynamic_config(query, body, headers, agent): + if query.get("transfer"): + agent.reset_contexts() + ctx = agent.define_contexts().add_context("default") + ctx.add_step("route").set_text("Route the caller.") +``` + +## Signature + +```python +reset_contexts() -> AgentBase +``` + +## Returns + +`AgentBase` — Self for method chaining. + +## Examples + +```python +def on_dynamic_config(query, body, headers, agent): + if query.get("transfer"): + agent.reset_contexts() + ctx = agent.define_contexts().add_context("default") + ctx.add_step("route").set_text("Route the caller.") +``` + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 157. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-post-prompt.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-post-prompt.mdx new file mode 100644 index 0000000000..5526ddf839 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-post-prompt" +title: "set_post_prompt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin.set_post_prompt" + parent: "signalwire.core.mixins.prompt_mixin.PromptMixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `set_post_prompt` + +Set the post-prompt text for summary generation + +## Signature + +```python +set_post_prompt(text: str) -> AgentBase +``` + +## Parameters + + + The post-prompt text + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 202. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-prompt-pom.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-prompt-pom.mdx new file mode 100644 index 0000000000..6acda84eed --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-prompt-pom.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-prompt-pom" +title: "set_prompt_pom" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin.set_prompt_pom" + parent: "signalwire.core.mixins.prompt_mixin.PromptMixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `set_prompt_pom` + +Set the prompt as a POM dictionary + +## Signature + +```python +set_prompt_pom(pom: List[Dict[str, Any]]) -> AgentBase +``` + +## Parameters + + + POM dictionary structure + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 215. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-prompt-text.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-prompt-text.mdx new file mode 100644 index 0000000000..3682a687c6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-prompt-text.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/prompt-mixin/prompt-mixin/set-prompt-text" +title: "set_prompt_text" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.prompt_mixin.PromptMixin.set_prompt_text" + parent: "signalwire.core.mixins.prompt_mixin.PromptMixin" + module: "signalwire.core.mixins.prompt_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py" +--- +# `set_prompt_text` + +Set the prompt as raw text instead of using POM + +## Signature + +```python +set_prompt_text(text: str) -> AgentBase +``` + +## Parameters + + + The raw prompt text + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/prompt_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/prompt_mixin.py) + +Line 189. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/serverless-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/serverless-mixin/index.mdx new file mode 100644 index 0000000000..49df9d68b6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/serverless-mixin/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/mixins/serverless-mixin" +title: "serverless_mixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.mixins.serverless_mixin" + parent: "signalwire.core.mixins" + module: "signalwire.core.mixins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/serverless_mixin.py" +--- +# `serverless_mixin` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module serverless_mixin +``` + +## Constants + + + +## Classes + + + + Mixin class containing all serverless/cloud platform methods for AgentBase + + + +## Source + +[`signalwire/signalwire/core/mixins/serverless_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/serverless_mixin.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/serverless-mixin/serverless-mixin/handle-serverless-request.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/serverless-mixin/serverless-mixin/handle-serverless-request.mdx new file mode 100644 index 0000000000..e03cfc44b2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/serverless-mixin/serverless-mixin/handle-serverless-request.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/core/mixins/serverless-mixin/serverless-mixin/handle-serverless-request" +title: "handle_serverless_request" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.serverless_mixin.ServerlessMixin.handle_serverless_request" + parent: "signalwire.core.mixins.serverless_mixin.ServerlessMixin" + module: "signalwire.core.mixins.serverless_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/serverless_mixin.py" +--- +# `handle_serverless_request` + +Handle serverless environment requests (CGI, Lambda, Cloud Functions) + +## Signature + +```python +handle_serverless_request(event = None, context = None, mode = None) +``` + +## Parameters + + + Serverless event object (Lambda, Cloud Functions) + + + + Serverless context object (Lambda, Cloud Functions) + + + + Override execution mode (from force\_mode in run()) + + +## Returns + +Response appropriate for the serverless platform + +## Source + +[`signalwire/signalwire/core/mixins/serverless_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/serverless_mixin.py) + +Line 28. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/serverless-mixin/serverless-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/serverless-mixin/serverless-mixin/index.mdx new file mode 100644 index 0000000000..14564bfb0a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/serverless-mixin/serverless-mixin/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/core/mixins/serverless-mixin/serverless-mixin" +title: "ServerlessMixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.mixins.serverless_mixin.ServerlessMixin" + parent: "signalwire.core.mixins.serverless_mixin" + module: "signalwire.core.mixins.serverless_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/serverless_mixin.py" +--- +# `ServerlessMixin` + +Mixin class containing all serverless/cloud platform methods for AgentBase + +## Signature + +```python +class ServerlessMixin +``` + +## Methods + + + + Handle serverless environment requests (CGI, Lambda, Cloud Functions) + + + +## Source + +[`signalwire/signalwire/core/mixins/serverless_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/serverless_mixin.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/index.mdx new file mode 100644 index 0000000000..d409a11207 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/mixins/skill-mixin" +title: "skill_mixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.mixins.skill_mixin" + parent: "signalwire.core.mixins" + module: "signalwire.core.mixins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py" +--- +# `skill_mixin` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill_mixin +``` + +## Classes + + + + Mixin class containing all skill management methods for AgentBase + + + +## Source + +[`signalwire/signalwire/core/mixins/skill_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/add-skill.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/add-skill.mdx new file mode 100644 index 0000000000..a57fb048f8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/add-skill.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/add-skill" +title: "add_skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.skill_mixin.SkillMixin.add_skill" + parent: "signalwire.core.mixins.skill_mixin.SkillMixin" + module: "signalwire.core.mixins.skill_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py" +--- +# `add_skill` + +Add a skill to this agent + +## Signature + +```python +add_skill(skill_name: str, params: Optional[Dict[str, Any]] = None) -> AgentBase +``` + +## Parameters + + + Name of the skill to add + + + + Optional parameters to pass to the skill for configuration + + +## Returns + +`AgentBase` — Self for method chaining + +## Throws + +- `ValueError` — If skill not found or failed to load with detailed error message + +## Source + +[`signalwire/signalwire/core/mixins/skill_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py) + +Line 18. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/has-skill.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/has-skill.mdx new file mode 100644 index 0000000000..59241d1131 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/has-skill.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/has-skill" +title: "has_skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.skill_mixin.SkillMixin.has_skill" + parent: "signalwire.core.mixins.skill_mixin.SkillMixin" + module: "signalwire.core.mixins.skill_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py" +--- +# `has_skill` + +Check if skill is loaded + +## Signature + +```python +has_skill(skill_name: str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/core/mixins/skill_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py) + +Line 53. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/index.mdx new file mode 100644 index 0000000000..9971ffe226 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/core/mixins/skill-mixin/skill-mixin" +title: "SkillMixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.mixins.skill_mixin.SkillMixin" + parent: "signalwire.core.mixins.skill_mixin" + module: "signalwire.core.mixins.skill_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py" +--- +# `SkillMixin` + +Mixin class containing all skill management methods for AgentBase + +## Signature + +```python +class SkillMixin +``` + +## Methods + + + + Add a skill to this agent + + + + Check if skill is loaded + + + + List currently loaded skills + + + + Remove a skill from this agent + + + +## Source + +[`signalwire/signalwire/core/mixins/skill_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py) + +Line 13. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/list-skills.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/list-skills.mdx new file mode 100644 index 0000000000..3c231474cf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/list-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/list-skills" +title: "list_skills" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.skill_mixin.SkillMixin.list_skills" + parent: "signalwire.core.mixins.skill_mixin.SkillMixin" + module: "signalwire.core.mixins.skill_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py" +--- +# `list_skills` + +List currently loaded skills + +## Signature + +```python +list_skills() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/core/mixins/skill_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py) + +Line 49. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/remove-skill.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/remove-skill.mdx new file mode 100644 index 0000000000..b998cdffd3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/remove-skill.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/core/mixins/skill-mixin/skill-mixin/remove-skill" +title: "remove_skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.skill_mixin.SkillMixin.remove_skill" + parent: "signalwire.core.mixins.skill_mixin.SkillMixin" + module: "signalwire.core.mixins.skill_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py" +--- +# `remove_skill` + +Remove a skill from this agent + +## Signature + +```python +remove_skill(skill_name: str) -> AgentBase +``` + +## Parameters + + + +## Returns + +`AgentBase` + +## Source + +[`signalwire/signalwire/core/mixins/skill_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/skill_mixin.py) + +Line 44. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/state-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/state-mixin/index.mdx new file mode 100644 index 0000000000..eb6d0610de --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/state-mixin/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/mixins/state-mixin" +title: "state_mixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.mixins.state_mixin" + parent: "signalwire.core.mixins" + module: "signalwire.core.mixins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/state_mixin.py" +--- +# `state_mixin` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module state_mixin +``` + +## Classes + + + + Mixin class containing all state and session management methods for AgentBase + + + +## Source + +[`signalwire/signalwire/core/mixins/state_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/state_mixin.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/state-mixin/state-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/state-mixin/state-mixin/index.mdx new file mode 100644 index 0000000000..b494135ac8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/state-mixin/state-mixin/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/core/mixins/state-mixin/state-mixin" +title: "StateMixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.mixins.state_mixin.StateMixin" + parent: "signalwire.core.mixins.state_mixin" + module: "signalwire.core.mixins.state_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/state_mixin.py" +--- +# `StateMixin` + +Mixin class containing all state and session management methods for AgentBase + +## Signature + +```python +class StateMixin +``` + +## Methods + + + + Validate a tool token + + + +## Source + +[`signalwire/signalwire/core/mixins/state_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/state_mixin.py) + +Line 15. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/state-mixin/state-mixin/validate-tool-token.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/state-mixin/state-mixin/validate-tool-token.mdx new file mode 100644 index 0000000000..9fbf91eba1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/state-mixin/state-mixin/validate-tool-token.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/core/mixins/state-mixin/state-mixin/validate-tool-token" +title: "validate_tool_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.state_mixin.StateMixin.validate_tool_token" + parent: "signalwire.core.mixins.state_mixin.StateMixin" + module: "signalwire.core.mixins.state_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/state_mixin.py" +--- +# `validate_tool_token` + +Validate a tool token + +## Signature + +```python +validate_tool_token(function_name: str, token: str, call_id: str) -> bool +``` + +## Parameters + + + Name of the function/tool + + + + Token to validate + + + + Call ID for the session + + +## Returns + +`bool` — True if token is valid, False otherwise + +## Source + +[`signalwire/signalwire/core/mixins/state_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/state_mixin.py) + +Line 43. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/index.mdx new file mode 100644 index 0000000000..5fced8f45c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/mixins/tool-mixin" +title: "tool_mixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.mixins.tool_mixin" + parent: "signalwire.core.mixins" + module: "signalwire.core.mixins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py" +--- +# `tool_mixin` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module tool_mixin +``` + +## Classes + + + + Mixin class containing all tool/function-related methods for AgentBase + + + +## Source + +[`signalwire/signalwire/core/mixins/tool_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/define-tool.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/define-tool.mdx new file mode 100644 index 0000000000..a7e1316e34 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/define-tool.mdx @@ -0,0 +1,166 @@ +--- +slug: "/reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/define-tool" +title: "define_tool" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.tool_mixin.ToolMixin.define_tool" + parent: "signalwire.core.mixins.tool_mixin.ToolMixin" + module: "signalwire.core.mixins.tool_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py" +--- +# `define_tool` + +Define a SWAIG function the AI can call. + +## How this becomes a tool the model sees + +SWAIG functions are NOT a separate concept from "LLM tools" — they +ARE the tools, exposed to the model in exactly the same shape as +native OpenAI / Anthropic tool calling. Under the hood, the SDK +renders each SWAIG function into an OpenAI-format tool schema: + +``` +{"type": "function", "function": { + "name": "", + "description": "", + "parameters": {} +}} +``` + +That schema is sent to the model on every turn. The model reads +the `description` field and the per-parameter `description` +strings inside `parameters` to decide WHEN to call this tool and +HOW to fill in the arguments. + +Treat description text as prompt engineering, not as developer +documentation: + +- Bad: "Lookup function" + +- Bad: "Internal helper for account fetching" + +- Good: "Look up a customer's account details by their account + number. Use this BEFORE quoting any account-specific + information (balance, plan, status, billing date)." + +- Bad parameter: "the id" + +- Good parameter: "The customer's account number, exactly 8 + digits, no dashes or spaces. Ask the user if + they don't provide it." + +Vague descriptions are the #1 cause of "the model has the right +tool but doesn't call it" failures. Be specific about WHEN to +use the tool, what makes it the right choice over alternatives, +and any preconditions on the arguments. + +Tool count matters too: LLM tool selection accuracy degrades past +\~7-8 simultaneously-active tools per call. If you have many tools, +partition them across steps using Step.set\_functions() so only +the relevant subset is active at any moment. + +> \[!NOTE] +> agent.define\_tool( +> name="lookup\_account", +> description=( +> "Look up a customer's account details by their account " +> "number. Use this BEFORE quoting any account-specific " +> "information. Do not call it for general questions about " +> "the product." +> ), +> parameters=\{ +> "type": "object", +> "properties": \{ +> "account\_number": \{ +> "type": "string", +> "description": ( +> "The customer's 8-digit account number, " +> "no dashes. Ask the user if not provided." +> ), +> \} +> \}, +> "required": \["account\_number"], +> \}, +> handler=self.handle\_lookup\_account, +> ) + +## Signature + +```python +define_tool( + name: str, + description: str, + parameters: Dict[str, Any], + handler: Callable, + secure: bool = True, + fillers: Optional[Dict[str, List[str]]] = None, + webhook_url: Optional[str] = None, + required: Optional[List[str]] = None, + is_typed_handler: bool = False, + **swaig_fields = {} +) -> AgentBase +``` + +## Parameters + + + Function name. Must be unique across all SWAIG functions on this agent. Becomes the `name` field in the OpenAI tool schema and is what the model emits when it picks this tool. Use snake\_case; the model picks up naming conventions from this field too. + + + + The function description as the LLM will read it. See above — this is prompt-engineered text, not internal docs. Explain what the tool does, when to use it, and what NOT to use it for if there are sibling tools the model might confuse it with. + + + + JSON Schema for the function's arguments. The per-property `description` fields inside the schema are also LLM-facing — give every parameter a description that tells the model how to fill it in (format, source, constraints). + + + + Python callable invoked when the model calls this tool. Receives parsed args and the raw request data. Should return a FunctionResult or dict; anything else logs a warning and is stringified. + + + + Whether to require SWAIG token validation on the webhook callback. + + + + Optional dict mapping language codes to arrays of filler phrases the AI speaks while the function executes. Format: \{"en-US": \["one moment...", "checking..."]\} + + + + Optional external webhook URL. If set, the SDK does not handle the call locally — the model's tool call is forwarded to this URL. + + + + Optional list of required parameter names. May also be set inside `parameters["required"]`. + + + + Whether the handler uses type-hinted parameters (auto-wrapped from inferred schema). + + + + +## Returns + +`AgentBase` — Self for method chaining. + +## Examples + +```python +{"type": "function", "function": { + "name": "", + "description": "", + "parameters": {} +}} +``` + +## Source + +[`signalwire/signalwire/core/mixins/tool_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/define-tools.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/define-tools.mdx new file mode 100644 index 0000000000..e93b560176 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/define-tools.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/define-tools" +title: "define_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.tool_mixin.ToolMixin.define_tools" + parent: "signalwire.core.mixins.tool_mixin.ToolMixin" + module: "signalwire.core.mixins.tool_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py" +--- +# `define_tools` + +Define the tools this agent can use + +This method can be overridden by subclasses. + +## Signature + +```python +define_tools() -> List[SWAIGFunction] +``` + +## Returns + +`List[SWAIGFunction]` — List of SWAIGFunction objects or raw dictionaries (for data\_map tools) + +## Source + +[`signalwire/signalwire/core/mixins/tool_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py) + +Line 200. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/index.mdx new file mode 100644 index 0000000000..798e579425 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/python/signalwire/core/mixins/tool-mixin/tool-mixin" +title: "ToolMixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.mixins.tool_mixin.ToolMixin" + parent: "signalwire.core.mixins.tool_mixin" + module: "signalwire.core.mixins.tool_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py" +--- +# `ToolMixin` + +Mixin class containing all tool/function-related methods for AgentBase + +## Signature + +```python +class ToolMixin +``` + +## Methods + + + + Define a SWAIG function the AI can call. + + + + Define the tools this agent can use + + + + Called when a SWAIG function is invoked + + + + Register a raw SWAIG function dictionary (e.g., from DataMap.to\_swaig\_function()) + + + + Class method decorator for defining SWAIG tools + + + +## Source + +[`signalwire/signalwire/core/mixins/tool_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py) + +Line 21. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/on-function-call.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/on-function-call.mdx new file mode 100644 index 0000000000..58f34a02b4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/on-function-call.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/on-function-call" +title: "on_function_call" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.tool_mixin.ToolMixin.on_function_call" + parent: "signalwire.core.mixins.tool_mixin.ToolMixin" + module: "signalwire.core.mixins.tool_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py" +--- +# `on_function_call` + +Called when a SWAIG function is invoked + +## Signature + +```python +on_function_call( + name: str, + args: Dict[str, Any], + raw_data: Optional[Dict[str, Any]] = None +) -> Any +``` + +## Parameters + + + Function name + + + + Function arguments + + + + Raw request data + + +## Returns + +`Any` — Function result + +## Source + +[`signalwire/signalwire/core/mixins/tool_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py) + +Line 219. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/register-swaig-function.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/register-swaig-function.mdx new file mode 100644 index 0000000000..11e6b1e712 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/register-swaig-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/register-swaig-function" +title: "register_swaig_function" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.tool_mixin.ToolMixin.register_swaig_function" + parent: "signalwire.core.mixins.tool_mixin.ToolMixin" + module: "signalwire.core.mixins.tool_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py" +--- +# `register_swaig_function` + +Register a raw SWAIG function dictionary (e.g., from DataMap.to\_swaig\_function()) + +## Signature + +```python +register_swaig_function(function_dict: Dict[str, Any]) -> AgentBase +``` + +## Parameters + + + Complete SWAIG function definition dictionary + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/tool_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py) + +Line 162. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/tool.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/tool.mdx new file mode 100644 index 0000000000..6c51097fb9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/tool.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/mixins/tool-mixin/tool-mixin/tool" +title: "tool" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.tool_mixin.ToolMixin.tool" + parent: "signalwire.core.mixins.tool_mixin.ToolMixin" + module: "signalwire.core.mixins.tool_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py" +--- +# `tool` + +Class method decorator for defining SWAIG tools + +Used as: + +@AgentBase.tool(name="example\_function", parameters=\{...\}) +def example\_function(self, param1): +\# ... + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +tool(name = None, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/core/mixins/tool_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/tool_mixin.py) + +Line 187. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/index.mdx new file mode 100644 index 0000000000..a7a47ce368 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin" +title: "web_mixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin" + parent: "signalwire.core.mixins" + module: "signalwire.core.mixins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `web_mixin` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module web_mixin +``` + +## Constants + + + +## Classes + + + + Mixin class containing all web server and routing-related methods for AgentBase + + + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/as-router.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/as-router.mdx new file mode 100644 index 0000000000..a6d1e583ba --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/as-router.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin/as-router" +title: "as_router" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin.as_router" + parent: "signalwire.core.mixins.web_mixin.WebMixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `as_router` + +Get a FastAPI router for this agent + +## Signature + +```python +as_router() -> APIRouter +``` + +## Returns + +`APIRouter` — FastAPI router + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 133. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/enable-debug-routes.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/enable-debug-routes.mdx new file mode 100644 index 0000000000..6021ff5772 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/enable-debug-routes.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin/enable-debug-routes" +title: "enable_debug_routes" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin.enable_debug_routes" + parent: "signalwire.core.mixins.web_mixin.WebMixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `enable_debug_routes` + +Enable debug routes for testing and development + +## Signature + +```python +enable_debug_routes() -> AgentBase +``` + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 1244. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/get-app.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/get-app.mdx new file mode 100644 index 0000000000..3457ffb27e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/get-app.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin/get-app" +title: "get_app" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin.get_app" + parent: "signalwire.core.mixins.web_mixin.WebMixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `get_app` + +Get the FastAPI application instance for deployment adapters like Lambda/Mangum + +This method ensures the FastAPI app is properly initialized and configured, +then returns it for use with deployment adapters like Mangum for AWS Lambda. + +## Signature + +```python +get_app() +``` + +## Returns + +The configured FastAPI application instance + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 41. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/index.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/index.mdx new file mode 100644 index 0000000000..f3f29dcb7b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin" +title: "WebMixin" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin" + parent: "signalwire.core.mixins.web_mixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `WebMixin` + +Mixin class containing all web server and routing-related methods for AgentBase + +## Signature + +```python +class WebMixin +``` + +## Methods + + + + Get a FastAPI router for this agent + + + + Enable debug routes for testing and development + + + + Get the FastAPI application instance for deployment adapters like Lambda/Mangum + + + + Manually set the proxy URL base for webhook callbacks + + + + Called when SWML is requested, with request data when available + + + + Customization point for subclasses to modify SWML based on request data + + + + Register a callback function that will be called to determine routing based on POST data. + + + + Smart run method that automatically detects environment and handles accordingly + + + + Start a web server for this agent + + + + Set a callback function for dynamic agent configuration + + + + Setup signal handlers for graceful shutdown (useful for Kubernetes) + + + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 36. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/manual-set-proxy-url.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..f57f40abd9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/manual-set-proxy-url.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin/manual-set-proxy-url" +title: "manual_set_proxy_url" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin.manual_set_proxy_url" + parent: "signalwire.core.mixins.web_mixin.WebMixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `manual_set_proxy_url` + +Manually set the proxy URL base for webhook callbacks + +This can be called at runtime to set or update the proxy URL + +## Signature + +```python +manual_set_proxy_url(proxy_url: str) -> AgentBase +``` + +## Parameters + + + The base URL to use for webhooks (e.g., https://example.ngrok.io) + + +## Returns + +`AgentBase` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 1191. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/on-request.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/on-request.mdx new file mode 100644 index 0000000000..93085cdf2e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/on-request.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin/on-request" +title: "on_request" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin.on_request" + parent: "signalwire.core.mixins.web_mixin.WebMixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `on_request` + +Called when SWML is requested, with request data when available + +This method overrides SWMLService's on\_request to properly handle SWML generation +for AI Agents. + +## Signature + +```python +on_request( + request_data: Optional[dict] = None, + callback_path: Optional[str] = None +) -> Optional[dict] +``` + +## Parameters + + + Optional dictionary containing the parsed POST body + + + + Optional callback path + + +## Returns + +`Optional[dict]` — None to use the default SWML rendering (which will call \_render\_swml) + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 1079. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/on-swml-request.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/on-swml-request.mdx new file mode 100644 index 0000000000..5c43041a0d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/on-swml-request.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin/on-swml-request" +title: "on_swml_request" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin.on_swml_request" + parent: "signalwire.core.mixins.web_mixin.WebMixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `on_swml_request` + +Customization point for subclasses to modify SWML based on request data + +## Signature + +```python +on_swml_request( + request_data: Optional[dict] = None, + callback_path: Optional[str] = None, + request: Optional[Request] = None +) -> Optional[dict] +``` + +## Parameters + + + Optional dictionary containing the parsed POST body + + + + Optional callback path + + + + Optional FastAPI Request object for accessing query params, headers, etc. + + +## Returns + +`Optional[dict]` — Optional dict with modifications to apply to the SWML document + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 1100. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/register-routing-callback.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/register-routing-callback.mdx new file mode 100644 index 0000000000..fd1cd1c2ee --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/register-routing-callback.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin/register-routing-callback" +title: "register_routing_callback" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin.register_routing_callback" + parent: "signalwire.core.mixins.web_mixin.WebMixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `register_routing_callback` + +Register a callback function that will be called to determine routing +based on POST data. + +When a routing callback is registered, an endpoint at the specified path is automatically +created that will handle requests. This endpoint will use the callback to +determine if the request should be processed by this service or redirected. + +The callback should take a request object and request body dictionary and return: + +- A route string if it should be routed to a different endpoint +- None if normal processing should continue + +## Signature + +```python +register_routing_callback( + callback_fn: Callable[Request, Dict[str, Any], Optional[str]], + path: str = '/sip' +) -> None +``` + +## Parameters + + + The callback function to register + + + + The path where this callback should be registered (default: "/sip") + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 1131. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/run.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/run.mdx new file mode 100644 index 0000000000..fe59fc76ec --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/run.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin/run" +title: "run" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin.run" + parent: "signalwire.core.mixins.web_mixin.WebMixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `run` + +Smart run method that automatically detects environment and handles accordingly + +## Signature + +```python +run( + event = None, + context = None, + force_mode = None, + host: Optional[str] = None, + port: Optional[int] = None +) +``` + +## Parameters + + + Serverless event object (Lambda, Cloud Functions) + + + + Serverless context object (Lambda, Cloud Functions) + + + + Override automatic mode detection for testing + + + + Host override for server mode + + + + Port override for server mode + + +## Returns + +Response for serverless modes, None for server mode + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 305. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/serve.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/serve.mdx new file mode 100644 index 0000000000..3c13f79d5e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/serve.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin/serve" +title: "serve" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin.serve" + parent: "signalwire.core.mixins.web_mixin.WebMixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `serve` + +Start a web server for this agent + +## Signature + +```python +serve(host: Optional[str] = None, port: Optional[int] = None) -> None +``` + +## Parameters + + + Optional host to override the default + + + + Optional port to override the default + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 153. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..22c71fb7d5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/set-dynamic-config-callback.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin/set-dynamic-config-callback" +title: "set_dynamic_config_callback" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin.set_dynamic_config_callback" + parent: "signalwire.core.mixins.web_mixin.WebMixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `set_dynamic_config_callback` + +Set a callback function for dynamic agent configuration + +This callback receives the actual agent instance, allowing you to dynamically +configure ANY aspect of the agent including adding skills, modifying prompts, +changing parameters, etc. based on request data. + +> \[!NOTE] +> def my\_config(query\_params, body\_params, headers, agent): +> if query\_params.get('tier') == 'premium': +> agent.add\_skill("advanced\_search") +> agent.add\_language("English", "en-US", "premium\_voice") +> agent.set\_params(\{"end\_of\_speech\_timeout": 500\}) +> agent.set\_global\_data(\{"tier": query\_params.get('tier', 'standard')\}) +> +> my\_agent.set\_dynamic\_config\_callback(my\_config) + +## Signature + +```python +set_dynamic_config_callback( + callback: Callable[dict, dict, dict, AgentBase, None] +) -> AgentBase +``` + +## Parameters + + + Function that takes (query\_params, body\_params, headers, agent) and configures the agent using any available methods like: - agent.add\_skill(...) - agent.add\_language(...) - agent.prompt\_add\_section(...) - agent.set\_params(...) - agent.set\_global\_data(...) - agent.define\_tool(...) + + +## Returns + +`AgentBase` + +## Examples + +```python +my_agent.set_dynamic_config_callback(my_config) +``` + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 1160. diff --git a/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/setup-graceful-shutdown.mdx b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/setup-graceful-shutdown.mdx new file mode 100644 index 0000000000..15d9b79143 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/mixins/web-mixin/web-mixin/setup-graceful-shutdown.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/mixins/web-mixin/web-mixin/setup-graceful-shutdown" +title: "setup_graceful_shutdown" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.mixins.web_mixin.WebMixin.setup_graceful_shutdown" + parent: "signalwire.core.mixins.web_mixin.WebMixin" + module: "signalwire.core.mixins.web_mixin" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py" +--- +# `setup_graceful_shutdown` + +Setup signal handlers for graceful shutdown (useful for Kubernetes) + +## Signature + +```python +setup_graceful_shutdown() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/mixins/web_mixin.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/mixins/web_mixin.py) + +Line 1218. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/index.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/index.mdx new file mode 100644 index 0000000000..b894f24e23 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder" +title: "pom_builder" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.pom_builder" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `pom_builder` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module pom_builder +``` + +## Classes + + + + Builder class for creating structured prompts using the Prompt Object Model. + + + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/add-section.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/add-section.mdx new file mode 100644 index 0000000000..8924e7705c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/add-section.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder/add-section" +title: "add_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder.add_section" + parent: "signalwire.core.pom_builder.PomBuilder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `add_section` + +Add a new section to the POM + +## Signature + +```python +add_section( + title: str, + body: str = '', + bullets: Optional[List[str]] = None, + numbered: bool = False, + numbered_bullets: bool = False, + subsections: Optional[List[Dict[str, Any]]] = None +) -> PomBuilder +``` + +## Parameters + + + Section title + + + + Optional body text + + + + Optional list of bullet points + + + + Whether to number this section + + + + Whether to number bullet points + + + + Optional list of subsection objects + + +## Returns + +`PomBuilder` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 38. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/add-subsection.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/add-subsection.mdx new file mode 100644 index 0000000000..76cebdbcd4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/add-subsection.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder/add-subsection" +title: "add_subsection" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder.add_subsection" + parent: "signalwire.core.pom_builder.PomBuilder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `add_subsection` + +Add a subsection to an existing section, creating the parent if needed + +## Signature + +```python +add_subsection( + parent_title: str, + title: str, + body: str = '', + bullets: Optional[List[str]] = None +) -> PomBuilder +``` + +## Parameters + + + Title of the parent section + + + + Title for the new subsection + + + + Optional body text + + + + Optional list of bullet points + + +## Returns + +`PomBuilder` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 115. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/add-to-section.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/add-to-section.mdx new file mode 100644 index 0000000000..7da8aa5058 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/add-to-section.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder/add-to-section" +title: "add_to_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder.add_to_section" + parent: "signalwire.core.pom_builder.PomBuilder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `add_to_section` + +Add content to an existing section + +## Signature + +```python +add_to_section( + title: str, + body: Optional[str] = None, + bullet: Optional[str] = None, + bullets: Optional[List[str]] = None +) -> PomBuilder +``` + +## Parameters + + + Section title + + + + Text to append to the section body + + + + Single bullet to add + + + + List of bullets to add + + +## Returns + +`PomBuilder` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 80. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/from-sections.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/from-sections.mdx new file mode 100644 index 0000000000..660f15fe47 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/from-sections.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder/from-sections" +title: "from_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder.from_sections" + parent: "signalwire.core.pom_builder.PomBuilder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `from_sections` + +Create a PomBuilder from a list of section dictionaries + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_sections(sections: List[Dict[str, Any]]) -> PomBuilder +``` + +## Parameters + + + List of section definition dictionaries + + +## Returns + +`PomBuilder` — A new PomBuilder instance with the sections added + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 181. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/get-section.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/get-section.mdx new file mode 100644 index 0000000000..f0180b3cea --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/get-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder/get-section" +title: "get_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder.get_section" + parent: "signalwire.core.pom_builder.PomBuilder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `get_section` + +Get a section by title + +## Signature + +```python +get_section(title: str) -> Optional[Section] +``` + +## Parameters + + + Section title + + +## Returns + +`Optional[Section]` — Section object or None if not found + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 153. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/has-section.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/has-section.mdx new file mode 100644 index 0000000000..7b498e1f35 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/has-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder/has-section" +title: "has_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder.has_section" + parent: "signalwire.core.pom_builder.PomBuilder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `has_section` + +Check if a section with the given title exists + +## Signature + +```python +has_section(title: str) -> bool +``` + +## Parameters + + + Section title to check + + +## Returns + +`bool` — True if the section exists, False otherwise + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 141. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/index.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/index.mdx new file mode 100644 index 0000000000..581f340935 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/index.mdx @@ -0,0 +1,91 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder" +title: "PomBuilder" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder" + parent: "signalwire.core.pom_builder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `PomBuilder` + +Builder class for creating structured prompts using the Prompt Object Model. + +This class is a flexible wrapper around the POM API that allows for: + +- Dynamic creation of sections on demand +- Adding content to existing sections +- Nesting subsections +- Rendering to markdown or XML + +Unlike previous implementations, there are no predefined section types - +you can create any section structure that fits your needs. + +## Signature + +```python +class PomBuilder +``` + +## Properties + + + +## Methods + + + + Initialize a new POM builder with an empty POM + + + + Add a new section to the POM + + + + Add a subsection to an existing section, creating the parent if needed + + + + Add content to an existing section + + + + Create a PomBuilder from a list of section dictionaries + + + + Get a section by title + + + + Check if a section with the given title exists + + + + Render the POM as markdown + + + + Render the POM as XML + + + + Convert the POM to a list of section dictionaries + + + + Convert the POM to a JSON string + + + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 19. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/init.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/init.mdx new file mode 100644 index 0000000000..04fc300220 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/init.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder.__init__" + parent: "signalwire.core.pom_builder.PomBuilder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `__init__` + +Initialize a new POM builder with an empty POM + +## Signature + +```python +__init__() +``` + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 33. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/render-markdown.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/render-markdown.mdx new file mode 100644 index 0000000000..ed50749f08 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/render-markdown.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder/render-markdown" +title: "render_markdown" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder.render_markdown" + parent: "signalwire.core.pom_builder.PomBuilder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `render_markdown` + +Render the POM as markdown + +## Signature + +```python +render_markdown() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 165. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/render-xml.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/render-xml.mdx new file mode 100644 index 0000000000..1f9e7d2403 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/render-xml.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder/render-xml" +title: "render_xml" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder.render_xml" + parent: "signalwire.core.pom_builder.PomBuilder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `render_xml` + +Render the POM as XML + +## Signature + +```python +render_xml() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 169. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/to-dict.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/to-dict.mdx new file mode 100644 index 0000000000..e1cb39bd86 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder/to-dict" +title: "to_dict" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder.to_dict" + parent: "signalwire.core.pom_builder.PomBuilder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `to_dict` + +Convert the POM to a list of section dictionaries + +## Signature + +```python +to_dict() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 173. diff --git a/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/to-json.mdx b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/to-json.mdx new file mode 100644 index 0000000000..15b587fda7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/pom-builder/pom-builder/to-json.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/pom-builder/pom-builder/to-json" +title: "to_json" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.pom_builder.PomBuilder.to_json" + parent: "signalwire.core.pom_builder.PomBuilder" + module: "signalwire.core.pom_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py" +--- +# `to_json` + +Convert the POM to a JSON string + +## Signature + +```python +to_json() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/core/pom_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/pom_builder.py) + +Line 177. diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/index.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/index.mdx new file mode 100644 index 0000000000..e614ceb9a1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/core/security-config" +title: "security_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.security_config" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `security_config` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module security_config +``` + +## Properties + + + + + +## Classes + + + + Unified security configuration for SignalWire services. + + + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-basic-auth.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-basic-auth.mdx new file mode 100644 index 0000000000..e8ffae8a9e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-basic-auth.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/core/security-config/security-config/get-basic-auth" +title: "get_basic_auth" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security_config.SecurityConfig.get_basic_auth" + parent: "signalwire.core.security_config.SecurityConfig" + module: "signalwire.core.security_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `get_basic_auth` + +Get basic auth credentials, generating if not set. + +If no basic auth password is configured (e.g. SWML\_BASIC\_AUTH\_PASSWORD +env var is unset and the SDK caller didn't pass one explicitly), the +SDK falls back to a random password generated via secrets.token\_urlsafe. +That password lives only in memory and is regenerated on every process +start, so any external caller (tests, RPC clients, MCP) that doesn't +share the auto-generated value will get HTTP 401. + +We log a warning the first time the auto-generated fallback fires so +the failure mode is visible in logs instead of silently breaking +external callers. Set SWML\_BASIC\_AUTH\_USER / SWML\_BASIC\_AUTH\_PASSWORD +(or load .env before constructing the agent) to suppress the warning. + +## Signature + +```python +get_basic_auth() -> Tuple[str, str] +``` + +## Returns + +`Tuple[str, str]` — Tuple of (username, password) + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) + +Line 247. diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-cors-config.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-cors-config.mdx new file mode 100644 index 0000000000..f17bd76733 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-cors-config.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/security-config/security-config/get-cors-config" +title: "get_cors_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security_config.SecurityConfig.get_cors_config" + parent: "signalwire.core.security_config.SecurityConfig" + module: "signalwire.core.security_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `get_cors_config` + +Get CORS configuration for FastAPI. + +## Signature + +```python +get_cors_config() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` — Dictionary of CORS settings + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) + +Line 328. diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-security-headers.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-security-headers.mdx new file mode 100644 index 0000000000..eaacbfe9c5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-security-headers.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/security-config/security-config/get-security-headers" +title: "get_security_headers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security_config.SecurityConfig.get_security_headers" + parent: "signalwire.core.security_config.SecurityConfig" + module: "signalwire.core.security_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `get_security_headers` + +Get security headers to add to responses. + +## Signature + +```python +get_security_headers(is_https: bool = False) -> Dict[str, str] +``` + +## Parameters + + + Whether the connection is over HTTPS + + +## Returns + +`Dict[str, str]` — Dictionary of security headers + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) + +Line 290. diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-ssl-context-kwargs.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-ssl-context-kwargs.mdx new file mode 100644 index 0000000000..a9ac2187ab --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-ssl-context-kwargs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/security-config/security-config/get-ssl-context-kwargs" +title: "get_ssl_context_kwargs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security_config.SecurityConfig.get_ssl_context_kwargs" + parent: "signalwire.core.security_config.SecurityConfig" + module: "signalwire.core.security_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `get_ssl_context_kwargs` + +Get SSL context kwargs for uvicorn. + +## Signature + +```python +get_ssl_context_kwargs() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` — Dictionary of SSL parameters for uvicorn + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) + +Line 226. diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-url-scheme.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-url-scheme.mdx new file mode 100644 index 0000000000..60ef76245e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/get-url-scheme.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/security-config/security-config/get-url-scheme" +title: "get_url_scheme" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security_config.SecurityConfig.get_url_scheme" + parent: "signalwire.core.security_config.SecurityConfig" + module: "signalwire.core.security_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `get_url_scheme` + +Get the URL scheme based on SSL configuration + +## Signature + +```python +get_url_scheme() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) + +Line 342. diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/index.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/index.mdx new file mode 100644 index 0000000000..6e089c43aa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/index.mdx @@ -0,0 +1,108 @@ +--- +slug: "/reference/python/signalwire/core/security-config/security-config" +title: "SecurityConfig" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.security_config.SecurityConfig" + parent: "signalwire.core.security_config" + module: "signalwire.core.security_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `SecurityConfig` + +Unified security configuration for SignalWire services. + +This class provides centralized security settings that can be used by +both SWML and Search services, ensuring consistent security behavior. + +## Signature + +```python +class SecurityConfig +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + Initialize security configuration. + + + + Get basic auth credentials, generating if not set. + + + + Get CORS configuration for FastAPI. + + + + Get security headers to add to responses. + + + + Get SSL context kwargs for uvicorn. + + + + Get the URL scheme based on SSL configuration + + + + Load configuration from environment variables + + + + Log the current security configuration + + + + Check if a host is allowed. + + + + Validate SSL configuration. + + + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) + +Line 19. diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/init.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/init.mdx new file mode 100644 index 0000000000..7576c01852 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/init.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/security-config/security-config/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security_config.SecurityConfig.__init__" + parent: "signalwire.core.security_config.SecurityConfig" + module: "signalwire.core.security_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `__init__` + +Initialize security configuration. + +## Signature + +```python +__init__(config_file: Optional[str] = None, service_name: Optional[str] = None) +``` + +## Parameters + + + Optional path to config file + + + + Optional service name for finding service-specific config + + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) + +Line 60. diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/load-from-env.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/load-from-env.mdx new file mode 100644 index 0000000000..a6663588db --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/load-from-env.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/core/security-config/security-config/load-from-env" +title: "load_from_env" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security_config.SecurityConfig.load_from_env" + parent: "signalwire.core.security_config.SecurityConfig" + module: "signalwire.core.security_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `load_from_env` + +Load configuration from environment variables + +## Signature + +```python +load_from_env() +``` + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) + +Line 168. diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/log-config.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/log-config.mdx new file mode 100644 index 0000000000..92e6b064aa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/log-config.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/security-config/security-config/log-config" +title: "log_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security_config.SecurityConfig.log_config" + parent: "signalwire.core.security_config.SecurityConfig" + module: "signalwire.core.security_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `log_config` + +Log the current security configuration + +## Signature + +```python +log_config(service_name: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) + +Line 346. diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/should-allow-host.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/should-allow-host.mdx new file mode 100644 index 0000000000..8925a7803c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/should-allow-host.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/security-config/security-config/should-allow-host" +title: "should_allow_host" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security_config.SecurityConfig.should_allow_host" + parent: "signalwire.core.security_config.SecurityConfig" + module: "signalwire.core.security_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `should_allow_host` + +Check if a host is allowed. + +## Signature + +```python +should_allow_host(host: str) -> bool +``` + +## Parameters + + + The host to check + + +## Returns + +`bool` — True if the host is allowed + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) + +Line 313. diff --git a/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/validate-ssl-config.mdx b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/validate-ssl-config.mdx new file mode 100644 index 0000000000..55efc57d8e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security-config/security-config/validate-ssl-config.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/security-config/security-config/validate-ssl-config" +title: "validate_ssl_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security_config.SecurityConfig.validate_ssl_config" + parent: "signalwire.core.security_config.SecurityConfig" + module: "signalwire.core.security_config" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py" +--- +# `validate_ssl_config` + +Validate SSL configuration. + +## Signature + +```python +validate_ssl_config() -> Tuple[bool, Optional[str]] +``` + +## Returns + +`Tuple[bool, Optional[str]]` — Tuple of (is\_valid, error\_message) + +## Source + +[`signalwire/signalwire/core/security_config.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security_config.py) + +Line 202. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/index.mdx b/fern/products/sdk-reference/python/signalwire/core/security/index.mdx new file mode 100644 index 0000000000..ac7c4d3fd7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/core/security" +title: "security" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.security" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/__init__.py" +--- +# `security` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module security +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + FastAPI middleware / dependency for SignalWire webhook signature validation. + + + + Webhook signature validation for SignalWire-signed HTTP requests. + + + +## Source + +[`signalwire/signalwire/core/security/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/index.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/index.mdx new file mode 100644 index 0000000000..d687c059dc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager" +title: "session_manager" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.security.session_manager" + parent: "signalwire.core.security" + module: "signalwire.core.security" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `session_manager` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module session_manager +``` + +## Classes + + + + Manages security tokens for function calls + + + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/activate-session.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/activate-session.mdx new file mode 100644 index 0000000000..04fd1fbca8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/activate-session.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager/activate-session" +title: "activate_session" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager.activate_session" + parent: "signalwire.core.security.session_manager.SessionManager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `activate_session` + +Legacy method, does nothing but returns success + +## Signature + +```python +activate_session(call_id: str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 184. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/create-session.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/create-session.mdx new file mode 100644 index 0000000000..a919506d97 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/create-session.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager/create-session" +title: "create_session" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager.create_session" + parent: "signalwire.core.security.session_manager.SessionManager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `create_session` + +Create a new session ID if one isn't provided + +## Signature + +```python +create_session(call_id: Optional[str] = None) -> str +``` + +## Parameters + + + Optional call ID, generated if not provided + + +## Returns + +`str` — The call\_id for the session + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 44. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/create-tool-token.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/create-tool-token.mdx new file mode 100644 index 0000000000..f87339c96a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/create-tool-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager/create-tool-token" +title: "create_tool_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager.create_tool_token" + parent: "signalwire.core.security.session_manager.SessionManager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `create_tool_token` + +Alias for generate\_token to maintain backward compatibility + +## Signature + +```python +create_tool_token(function_name: str, call_id: str) -> str +``` + +## Parameters + + + Name of the function to generate a token for + + + + Call session ID + + +## Returns + +`str` — A secure token + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 92. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/debug-token.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/debug-token.mdx new file mode 100644 index 0000000000..90311b732e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/debug-token.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager/debug-token" +title: "debug_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager.debug_token" + parent: "signalwire.core.security.session_manager.SessionManager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `debug_token` + +Debug a token without validating it + +This method decodes the token and extracts its components for debugging purposes +without performing validation. Requires \_debug\_mode to be True. + +## Signature + +```python +debug_token(token: str) -> Dict[str, Any] +``` + +## Parameters + + + The token to debug + + +## Returns + +`Dict[str, Any]` — Dictionary with token components and analysis + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 208. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/end-session.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/end-session.mdx new file mode 100644 index 0000000000..74f39c4fe5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/end-session.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager/end-session" +title: "end_session" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager.end_session" + parent: "signalwire.core.security.session_manager.SessionManager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `end_session` + +Legacy method, does nothing but returns success + +## Signature + +```python +end_session(call_id: str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 190. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/generate-token.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/generate-token.mdx new file mode 100644 index 0000000000..913e3537e5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/generate-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager/generate-token" +title: "generate_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager.generate_token" + parent: "signalwire.core.security.session_manager.SessionManager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `generate_token` + +Generate a secure self-contained token for a function call + +## Signature + +```python +generate_token(function_name: str, call_id: str) -> str +``` + +## Parameters + + + Name of the function to generate a token for + + + + Call session ID + + +## Returns + +`str` — A secure token + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 60. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/get-session-metadata.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/get-session-metadata.mdx new file mode 100644 index 0000000000..ed2713a183 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/get-session-metadata.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager/get-session-metadata" +title: "get_session_metadata" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager.get_session_metadata" + parent: "signalwire.core.security.session_manager.SessionManager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `get_session_metadata` + +Legacy method, always returns empty metadata + +## Signature + +```python +get_session_metadata(call_id: str) -> Optional[Dict[str, Any]] +``` + +## Parameters + + + +## Returns + +`Optional[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 196. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/index.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/index.mdx new file mode 100644 index 0000000000..aae9b03128 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/index.mdx @@ -0,0 +1,87 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager" +title: "SessionManager" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager" + parent: "signalwire.core.security.session_manager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `SessionManager` + +Manages security tokens for function calls + +This implementation is completely stateless - it does not track call sessions +or store any information in memory. All validation is done using cryptographic +signatures with the tokens containing all necessary information. + +## Signature + +```python +class SessionManager +``` + +## Properties + + + + + +## Methods + + + + Initialize the session manager + + + + Legacy method, does nothing but returns success + + + + Create a new session ID if one isn't provided + + + + Alias for generate\_token to maintain backward compatibility + + + + Debug a token without validating it + + + + Legacy method, does nothing but returns success + + + + Generate a secure self-contained token for a function call + + + + Legacy method, always returns empty metadata + + + + Legacy method, does nothing but returns success + + + + Validate a function call token + + + + Alias for validate\_token to maintain backward compatibility + + + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/init.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/init.mdx new file mode 100644 index 0000000000..0bf22d7c62 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/init.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager.__init__" + parent: "signalwire.core.security.session_manager.SessionManager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `__init__` + +Initialize the session manager + +## Signature + +```python +__init__(token_expiry_secs: int = 900, secret_key: Optional[str] = None) +``` + +## Parameters + + + Seconds until tokens expire (default: 15 minutes) + + + + Secret key for signing tokens (generated if not provided) + + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 31. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/set-session-metadata.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/set-session-metadata.mdx new file mode 100644 index 0000000000..0711b343a7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/set-session-metadata.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager/set-session-metadata" +title: "set_session_metadata" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager.set_session_metadata" + parent: "signalwire.core.security.session_manager.SessionManager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `set_session_metadata` + +Legacy method, does nothing but returns success + +## Signature + +```python +set_session_metadata(call_id: str, key: str, value: Any) -> bool +``` + +## Parameters + + + + + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 202. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/validate-token.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/validate-token.mdx new file mode 100644 index 0000000000..8f093197eb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/validate-token.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager/validate-token" +title: "validate_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager.validate_token" + parent: "signalwire.core.security.session_manager.SessionManager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `validate_token` + +Validate a function call token + +## Signature + +```python +validate_token(call_id: str, function_name: str, token: str) -> bool +``` + +## Parameters + + + Call session ID + + + + Name of the function being called + + + + Token to validate + + +## Returns + +`bool` — True if valid, False otherwise + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 105. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/validate-tool-token.mdx b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/validate-tool-token.mdx new file mode 100644 index 0000000000..cea2c353c2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/session-manager/session-manager/validate-tool-token.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/core/security/session-manager/session-manager/validate-tool-token" +title: "validate_tool_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.security.session_manager.SessionManager.validate_tool_token" + parent: "signalwire.core.security.session_manager.SessionManager" + module: "signalwire.core.security.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py" +--- +# `validate_tool_token` + +Alias for validate\_token to maintain backward compatibility + +## Signature + +```python +validate_tool_token(function_name: str, token: str, call_id: str) -> bool +``` + +## Parameters + + + Name of the function being called + + + + Token to validate + + + + Call session ID + + +## Returns + +`bool` — True if valid, False otherwise + +## Source + +[`signalwire/signalwire/core/security/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/session_manager.py) + +Line 167. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/webhook-middleware/index.mdx b/fern/products/sdk-reference/python/signalwire/core/security/webhook-middleware/index.mdx new file mode 100644 index 0000000000..1343cea050 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/webhook-middleware/index.mdx @@ -0,0 +1,95 @@ +--- +slug: "/reference/python/signalwire/core/security/webhook-middleware" +title: "webhook_middleware" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.security.webhook_middleware" + parent: "signalwire.core.security" + module: "signalwire.core.security" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/webhook_middleware.py" +--- +# `webhook_middleware` + +FastAPI middleware / dependency for SignalWire webhook signature validation. + +Copyright (c) 2025 SignalWire. Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +This module ships a small, framework-aware adapter around +:func:`signalwire.core.security.webhook_validator.validate_webhook_signature`. + +Why a custom dependency rather than a vanilla `Depends` on `request.body()`? + +- We MUST capture the raw bytes BEFORE FastAPI's JSON parser consumes the + stream — re-serialization changes whitespace and key order, which breaks + the Scheme A digest. The dependency stashes the raw body on + `request.state.raw_body` so the downstream handler can re-parse without + re-reading the stream. +- Reverse-proxy / ngrok deployments need the URL the platform POSTed to, + which differs from the URL the SDK sees. The dependency honors + `X-Forwarded-Proto` / `X-Forwarded-Host` when `trust_proxy=True`, + plus the `SWML_PROXY_URL_BASE` env var, with `request.url` as last + resort. +- The legacy cXML/Compatibility scheme used the `X-Twilio-Signature` + header. We accept it as an alias of `X-SignalWire-Signature` so users + migrating from the legacy SDK can keep their callers unchanged. + +Usage:: + +``` +from signalwire.core.security.webhook_middleware import ( + make_webhook_validation_dependency, +) + +dep = make_webhook_validation_dependency(signing_key="PSK...") + +@app.post("/webhook", dependencies=[Depends(dep)]) +async def webhook(request: Request): + body = request.state.raw_body # bytes; re-parse if you need JSON +``` + +## Signature + +```python +module webhook_middleware +``` + +## Examples + +```python +from signalwire.core.security.webhook_middleware import ( + make_webhook_validation_dependency, +) + +dep = make_webhook_validation_dependency(signing_key="PSK...") + +@app.post("/webhook", dependencies=[Depends(dep)]) +async def webhook(request: Request): + body = request.state.raw_body # bytes; re-parse if you need JSON +``` + +## Properties + + + +## Constants + + + + + +## Functions + + + + Build a FastAPI dependency that enforces signature validation. + + + +## Source + +[`signalwire/signalwire/core/security/webhook_middleware.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/webhook_middleware.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/security/webhook-middleware/make-webhook-validation-dependency.mdx b/fern/products/sdk-reference/python/signalwire/core/security/webhook-middleware/make-webhook-validation-dependency.mdx new file mode 100644 index 0000000000..530a439447 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/webhook-middleware/make-webhook-validation-dependency.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/python/signalwire/core/security/webhook-middleware/make-webhook-validation-dependency" +title: "make_webhook_validation_dependency" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.security.webhook_middleware.make_webhook_validation_dependency" + parent: "signalwire.core.security.webhook_middleware" + module: "signalwire.core.security.webhook_middleware" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/webhook_middleware.py" +--- +# `make_webhook_validation_dependency` + +Build a FastAPI dependency that enforces signature validation. + +The returned coroutine: + +1. Reads `await request.body()` and stashes the bytes on + `request.state.raw_body`. +2. Pulls the `X-SignalWire-Signature` header (or the Twilio alias). +3. Reconstructs the public URL (proxy headers / env / fallback). +4. Calls :func:`validate_webhook_signature`. +5. On invalid signature: raises `HTTPException(403)` to short-circuit + the handler. FastAPI's `dependencies=[Depends(...)]` only honors + short-circuiting via raised exceptions — returning a Response from a + dependency does not stop the endpoint. +6. On valid: returns `None` so the handler runs as normal. + +## Signature + +```python +make_webhook_validation_dependency( + signing_key: str, + *, + trust_proxy: bool = False +) -> Callable[Request, Response, Awaitable[Optional[Response]]] +``` + +## Parameters + + + The customer's Signing Key. Required, non-empty. + + + + If True, honor `X-Forwarded-Proto` / `X-Forwarded-Host` when reconstructing the URL. Default False — proxy headers are spoofable, so opt in only when you control the proxy. + + +## Returns + +`Callable[Request, Response, Awaitable[Optional[Response]]]` — Async callable suitable for `Depends(...)`. + +## Throws + +- `ValueError` — at construction time if `signing_key` is empty. + +## Source + +[`signalwire/signalwire/core/security/webhook_middleware.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/webhook_middleware.py) + +Line 88. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/webhook-validator/index.mdx b/fern/products/sdk-reference/python/signalwire/core/security/webhook-validator/index.mdx new file mode 100644 index 0000000000..d521001061 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/webhook-validator/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/python/signalwire/core/security/webhook-validator" +title: "webhook_validator" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.security.webhook_validator" + parent: "signalwire.core.security" + module: "signalwire.core.security" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/webhook_validator.py" +--- +# `webhook_validator` + +Webhook signature validation for SignalWire-signed HTTP requests. + +Copyright (c) 2025 SignalWire. Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +Implements both schemes from porting-sdk/webhooks.md: + +- Scheme A (RELAY/SWML/JSON): hex(HMAC-SHA1(key, url + raw\_body)) +- Scheme B (Compat/cXML form): base64(HMAC-SHA1(key, url + sortedFormParams)) + with optional bodySHA256 query-param fallback for JSON-on-compat-surface. + +> \[!NOTE] +> validate\_webhook\_signature(signing\_key, signature, url, raw\_body) -> bool +> validate\_request(signing\_key, signature, url, params\_or\_raw\_body) -> bool + +All comparisons use `hmac.compare_digest` (constant-time) so the secret +is not leaked over repeated requests. + +## Signature + +```python +module webhook_validator +``` + +## Properties + + + +## Functions + + + + Legacy `@signalwire/compatibility-api` drop-in entry point. + + + + Validate a SignalWire webhook signature against both schemes. + + + +## Source + +[`signalwire/signalwire/core/security/webhook_validator.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/webhook_validator.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/security/webhook-validator/validate-request.mdx b/fern/products/sdk-reference/python/signalwire/core/security/webhook-validator/validate-request.mdx new file mode 100644 index 0000000000..2e05d67255 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/webhook-validator/validate-request.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/python/signalwire/core/security/webhook-validator/validate-request" +title: "validate_request" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.security.webhook_validator.validate_request" + parent: "signalwire.core.security.webhook_validator" + module: "signalwire.core.security.webhook_validator" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/webhook_validator.py" +--- +# `validate_request` + +Legacy `@signalwire/compatibility-api` drop-in entry point. + +If `params_or_raw_body` is a string, delegates to +:func:`validate_webhook_signature` (Scheme A then Scheme B with parsed form). + +If it's a mapping or a list of (key, value) tuples, treats it as +pre-parsed form params and runs Scheme B directly (with URL port +normalization and optional bodySHA256 fallback). + +## Signature + +```python +validate_request( + signing_key: str, + signature: str, + url: str, + params_or_raw_body: Union[str, Mapping[str, Any], List[Tuple[str, Any]], None] +) -> bool +``` + +## Parameters + + + Customer's Signing Key. Missing raises `ValueError`. + + + + Header value. Missing / empty returns False. + + + + Full URL SignalWire POSTed to. + + + + `str` raw body OR pre-parsed form params. + + +## Returns + +`bool` — True on match, False otherwise. + +## Throws + +- `ValueError` — when `signing_key` is missing. +- `TypeError` — when `params_or_raw_body` is neither a string nor a mapping/list (e.g. a parsed JSON dict-like that's been rejected). + +## Source + +[`signalwire/signalwire/core/security/webhook_validator.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/webhook_validator.py) + +Line 268. diff --git a/fern/products/sdk-reference/python/signalwire/core/security/webhook-validator/validate-webhook-signature.mdx b/fern/products/sdk-reference/python/signalwire/core/security/webhook-validator/validate-webhook-signature.mdx new file mode 100644 index 0000000000..1018acff32 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/security/webhook-validator/validate-webhook-signature.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/python/signalwire/core/security/webhook-validator/validate-webhook-signature" +title: "validate_webhook_signature" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.core.security.webhook_validator.validate_webhook_signature" + parent: "signalwire.core.security.webhook_validator" + module: "signalwire.core.security.webhook_validator" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/webhook_validator.py" +--- +# `validate_webhook_signature` + +Validate a SignalWire webhook signature against both schemes. + +## Signature + +```python +validate_webhook_signature( + signing_key: str, + signature: str, + url: str, + raw_body: str +) -> bool +``` + +## Parameters + + + Customer's Signing Key from the Dashboard. UTF-8 string, secret. `None` / empty raises `ValueError` — that's a programming error, not a validation failure. + + + + The `X-SignalWire-Signature` header value (or `X-Twilio-Signature` for cXML compat). Missing / empty returns False without raising. + + + + The full URL SignalWire POSTed to (scheme, host, optional port, path, query). Must match what the platform saw — see the `URL reconstruction` section of porting-sdk/webhooks.md. + + + + The raw request body bytes as a UTF-8 string, BEFORE any JSON / form parsing. Must be a `str` — passing a parsed dict raises `TypeError`. + + +## Returns + +`bool` — True if the signature matches either Scheme A (hex JSON) or Scheme B (base64 form, with port-normalization variants and optional bodySHA256 fallback). False otherwise. + +## Throws + +- `ValueError` — when `signing_key` is missing. +- `TypeError` — when `raw_body` is not a string. + +## Source + +[`signalwire/signalwire/core/security/webhook_validator.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/security/webhook_validator.py) + +Line 198. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/index.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/index.mdx new file mode 100644 index 0000000000..e3f4892ece --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/skill-base" +title: "skill_base" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.skill_base" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `skill_base` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill_base +``` + +## Classes + + + + Abstract base class for all agent skills + + + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/cleanup.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/cleanup.mdx new file mode 100644 index 0000000000..a6339aecd1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/cleanup" +title: "cleanup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.cleanup" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `cleanup` + +Cleanup when skill is removed or agent shuts down + +## Signature + +```python +cleanup() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 99. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/define-tool.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/define-tool.mdx new file mode 100644 index 0000000000..7080d4e905 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/define-tool.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/define-tool" +title: "define_tool" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.define_tool" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `define_tool` + +Wrapper method that automatically includes swaig\_fields when defining tools. + +This method delegates to self.agent.define\_tool() but automatically merges +any swaig\_fields configured for this skill. Skills should use this method +instead of calling self.agent.define\_tool() directly. + +## Signature + +```python +define_tool(**kwargs = {}) -> None +``` + +## Parameters + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 58. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-global-data.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-global-data.mdx new file mode 100644 index 0000000000..9b0c6a230e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/get-global-data" +title: "get_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.get_global_data" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `get_global_data` + +Return data to add to agent's global context + +## Signature + +```python +get_global_data() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 84. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-hints.mdx new file mode 100644 index 0000000000..79e8302012 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.get_hints" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `get_hints` + +Return speech recognition hints for this skill + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 80. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-instance-key.mdx new file mode 100644 index 0000000000..5b5465ed5e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-instance-key.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.get_instance_key" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `get_instance_key` + +Get the key used to track this skill instance + +For skills that support multiple instances (SUPPORTS\_MULTIPLE\_INSTANCES = True), +this method can be overridden to provide a unique key for each instance. + +Default implementation: + +- If SUPPORTS\_MULTIPLE\_INSTANCES is False: returns SKILL\_NAME +- If SUPPORTS\_MULTIPLE\_INSTANCES is True: returns SKILL\_NAME + "\_" + tool\_name + (where tool\_name comes from params\['tool\_name'] or defaults to the skill name) + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` — Unique key for this skill instance + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 126. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-parameter-schema.mdx new file mode 100644 index 0000000000..4e1742b330 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-parameter-schema.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.get_parameter_schema" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `get_parameter_schema` + +Get the parameter schema for this skill + +This method returns metadata about all parameters the skill accepts, +including their types, descriptions, default values, and whether they +are required or should be hidden (e.g., API keys). + +The base implementation provides common parameters available to all skills. +Subclasses should override this method and merge their specific parameters +with the base schema. + +> \[!NOTE] +> \{ +> "tool\_name": \{ +> "type": "string", +> "description": "Name for the tool when using multiple instances", +> "default": "my\_skill", +> "required": False +> \}, +> "api\_key": \{ +> "type": "string", +> "description": "API key for the service", +> "required": True, +> "hidden": True, +> "env\_var": "MY\_API\_KEY" +> \} +> \} + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` — Dict\[str, Dict\[str, Any]]: Parameter schema where keys are parameter names and values are dictionaries containing: + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 197. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-prompt-sections.mdx new file mode 100644 index 0000000000..7b224519b7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.get_prompt_sections" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent. +Returns empty list if skip\_prompt is set to True in params. + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 88. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-skill-data.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-skill-data.mdx new file mode 100644 index 0000000000..610dbde814 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/get-skill-data" +title: "get_skill_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.get_skill_data" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `get_skill_data` + +Read this skill instance's namespaced data from raw\_data global\_data. + +## Signature + +```python +get_skill_data(raw_data: Dict[str, Any]) -> Dict[str, Any] +``` + +## Parameters + + + The raw\_data dict passed to SWAIG function handlers, expected to contain a 'global\_data' key. + + +## Returns + +`Dict[str, Any]` — The skill's namespaced state, or empty dict if not found. + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 164. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/index.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/index.mdx new file mode 100644 index 0000000000..b30169b13e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/index.mdx @@ -0,0 +1,113 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base" +title: "SkillBase" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase" + parent: "signalwire.core.skill_base" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `SkillBase` + +Abstract base class for all agent skills + +## Signature + +```python +class SkillBase(ABC) +``` + +## Inheritance + +**Extends:** `ABC` + +## Properties + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + + Cleanup when skill is removed or agent shuts down + + + + Wrapper method that automatically includes swaig\_fields when defining tools. + + + + Return data to add to agent's global context + + + + Return speech recognition hints for this skill + + + + Get the key used to track this skill instance + + + + Get the parameter schema for this skill + + + + Return prompt sections to add to agent. Returns empty list if skip\_prompt is set to True in params. + + + + Read this skill instance's namespaced data from raw\_data global\_data. + + + + Register SWAIG tools with the agent + + + + Setup the skill (validate env vars, initialize APIs, etc.) Returns True if setup successful, False otherwise + + + + Write this skill instance's namespaced data into a FunctionResult. + + + + Check if all required environment variables are set + + + + Check if all required packages are available + + + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 19. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/init.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/init.mdx new file mode 100644 index 0000000000..6627d179bd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.__init__" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `__init__` + +## Signature + +```python +__init__(agent: AgentBase, params: Optional[Dict[str, Any]] = None) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 32. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/register-tools.mdx new file mode 100644 index 0000000000..3b5275dd6f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/register-tools.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.register_tools" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `register_tools` + +Register SWAIG tools with the agent + +**Modifiers:** `abstract` + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 53. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/setup.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/setup.mdx new file mode 100644 index 0000000000..ef3f4ed38c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/setup.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.setup" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `setup` + +Setup the skill (validate env vars, initialize APIs, etc.) +Returns True if setup successful, False otherwise + +**Modifiers:** `abstract` + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 45. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/update-skill-data.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/update-skill-data.mdx new file mode 100644 index 0000000000..4d3ec667d8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/update-skill-data.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/update-skill-data" +title: "update_skill_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.update_skill_data" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `update_skill_data` + +Write this skill instance's namespaced data into a FunctionResult. + +Wraps the data under the skill's namespace key and calls +result.update\_global\_data(). + +## Signature + +```python +update_skill_data( + result: FunctionResult, + data: Dict[str, Any] +) -> FunctionResult +``` + +## Parameters + + + The FunctionResult to add the global\_data update to. + + + + The skill state dict to store under the namespace. + + +## Returns + +`FunctionResult` — The result, for method chaining. + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 179. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/validate-env-vars.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/validate-env-vars.mdx new file mode 100644 index 0000000000..9ff5388c87 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/validate-env-vars.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/validate-env-vars" +title: "validate_env_vars" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.validate_env_vars" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `validate_env_vars` + +Check if all required environment variables are set + +## Signature + +```python +validate_env_vars() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 103. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/validate-packages.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/validate-packages.mdx new file mode 100644 index 0000000000..161ac1596d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-base/skill-base/validate-packages.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/skill-base/skill-base/validate-packages" +title: "validate_packages" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_base.SkillBase.validate_packages" + parent: "signalwire.core.skill_base.SkillBase" + module: "signalwire.core.skill_base" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py" +--- +# `validate_packages` + +Check if all required packages are available + +## Signature + +```python +validate_packages() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/core/skill_base.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_base.py) + +Line 112. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-manager/index.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-manager/index.mdx new file mode 100644 index 0000000000..8c4005af75 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-manager/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/skill-manager" +title: "skill_manager" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.skill_manager" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py" +--- +# `skill_manager` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill_manager +``` + +## Classes + + + + Manages loading and lifecycle of agent skills + + + +## Source + +[`signalwire/signalwire/core/skill_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/get-skill.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/get-skill.mdx new file mode 100644 index 0000000000..2086c269fe --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/get-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/skill-manager/skill-manager/get-skill" +title: "get_skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_manager.SkillManager.get_skill" + parent: "signalwire.core.skill_manager.SkillManager" + module: "signalwire.core.skill_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py" +--- +# `get_skill` + +Get a loaded skill instance by identifier + +## Signature + +```python +get_skill(skill_identifier: str) -> Optional[SkillBase] +``` + +## Parameters + + + Either a skill name or an instance key + + +## Returns + +`Optional[SkillBase]` — The skill instance if found, None otherwise + +## Source + +[`signalwire/signalwire/core/skill_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py) + +Line 228. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/has-skill.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/has-skill.mdx new file mode 100644 index 0000000000..da3c2e0716 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/has-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/skill-manager/skill-manager/has-skill" +title: "has_skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_manager.SkillManager.has_skill" + parent: "signalwire.core.skill_manager.SkillManager" + module: "signalwire.core.skill_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py" +--- +# `has_skill` + +Check if skill is currently loaded + +## Signature + +```python +has_skill(skill_identifier: str) -> bool +``` + +## Parameters + + + Either a skill name or an instance key + + +## Returns + +`bool` — True if loaded, False otherwise + +## Source + +[`signalwire/signalwire/core/skill_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py) + +Line 212. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/index.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/index.mdx new file mode 100644 index 0000000000..98d86fe6a7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/python/signalwire/core/skill-manager/skill-manager" +title: "SkillManager" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.skill_manager.SkillManager" + parent: "signalwire.core.skill_manager" + module: "signalwire.core.skill_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py" +--- +# `SkillManager` + +Manages loading and lifecycle of agent skills + +## Signature + +```python +class SkillManager +``` + +## Properties + + + + + + + +## Methods + + + + + + Get a loaded skill instance by identifier + + + + Check if skill is currently loaded + + + + List instance keys of currently loaded skills + + + + Load and setup a skill by name + + + + Unload a skill and cleanup + + + +## Source + +[`signalwire/signalwire/core/skill_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py) + +Line 14. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/init.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/init.mdx new file mode 100644 index 0000000000..f852caaac1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/core/skill-manager/skill-manager/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_manager.SkillManager.__init__" + parent: "signalwire.core.skill_manager.SkillManager" + module: "signalwire.core.skill_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py" +--- +# `__init__` + +## Signature + +```python +__init__(agent) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/core/skill_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/list-loaded-skills.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/list-loaded-skills.mdx new file mode 100644 index 0000000000..191a2fefc2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/list-loaded-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/skill-manager/skill-manager/list-loaded-skills" +title: "list_loaded_skills" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_manager.SkillManager.list_loaded_skills" + parent: "signalwire.core.skill_manager.SkillManager" + module: "signalwire.core.skill_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py" +--- +# `list_loaded_skills` + +List instance keys of currently loaded skills + +## Signature + +```python +list_loaded_skills() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/core/skill_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py) + +Line 208. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/load-skill.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/load-skill.mdx new file mode 100644 index 0000000000..ca36ccc7fd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/load-skill.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/core/skill-manager/skill-manager/load-skill" +title: "load_skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_manager.SkillManager.load_skill" + parent: "signalwire.core.skill_manager.SkillManager" + module: "signalwire.core.skill_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py" +--- +# `load_skill` + +Load and setup a skill by name + +## Signature + +```python +load_skill( + skill_name: str, + skill_class: Type[SkillBase] = None, + params: Optional[Dict[str, Any]] = None +) -> tuple[bool, str] +``` + +## Parameters + + + Name of the skill to load + + + + Optional skill class (if not provided, will try to find it) + + + + Optional parameters to pass to the skill + + +## Returns + +`tuple[bool, str]` — (success, error\_message) - error\_message is empty string if successful + +## Source + +[`signalwire/signalwire/core/skill_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/unload-skill.mdx b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/unload-skill.mdx new file mode 100644 index 0000000000..7f86928b60 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/skill-manager/skill-manager/unload-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/skill-manager/skill-manager/unload-skill" +title: "unload_skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.skill_manager.SkillManager.unload_skill" + parent: "signalwire.core.skill_manager.SkillManager" + module: "signalwire.core.skill_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py" +--- +# `unload_skill` + +Unload a skill and cleanup + +## Signature + +```python +unload_skill(skill_identifier: str) -> bool +``` + +## Parameters + + + Either a skill name or an instance key + + +## Returns + +`bool` — True if successfully unloaded, False otherwise + +## Source + +[`signalwire/signalwire/core/skill_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/skill_manager.py) + +Line 176. diff --git a/fern/products/sdk-reference/python/signalwire/core/swaig-function/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swaig-function/index.mdx new file mode 100644 index 0000000000..3f51b6bb33 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swaig-function/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/swaig-function" +title: "swaig_function" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.swaig_function" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py" +--- +# `swaig_function` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module swaig_function +``` + +## Classes + + + + Represents a SWAIG function — i.e., a tool the AI model can call. + + + +## Source + +[`signalwire/signalwire/core/swaig_function.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/call.mdx b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/call.mdx new file mode 100644 index 0000000000..c5faa6aa83 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/call.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/core/swaig-function/swaig-function/call" +title: "__call__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swaig_function.SWAIGFunction.__call__" + parent: "signalwire.core.swaig_function.SWAIGFunction" + module: "signalwire.core.swaig_function" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py" +--- +# `__call__` + +Call the underlying handler function + +## Signature + +```python +__call__(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/core/swaig_function.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py) + +Line 133. diff --git a/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/execute.mdx b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/execute.mdx new file mode 100644 index 0000000000..09c00c384b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/execute.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/core/swaig-function/swaig-function/execute" +title: "execute" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swaig_function.SWAIGFunction.execute" + parent: "signalwire.core.swaig_function.SWAIGFunction" + module: "signalwire.core.swaig_function" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py" +--- +# `execute` + +Execute the function with the given arguments + +## Signature + +```python +execute( + args: Dict[str, Any], + raw_data: Optional[Dict[str, Any]] = None +) -> Dict[str, Any] +``` + +## Parameters + + + Parsed arguments for the function + + + + Optional raw request data + + +## Returns + +`Dict[str, Any]` — Function result as a dictionary (from FunctionResult.to\_dict()) + +## Source + +[`signalwire/signalwire/core/swaig_function.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py) + +Line 139. diff --git a/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/index.mdx new file mode 100644 index 0000000000..b2474d0c65 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/index.mdx @@ -0,0 +1,112 @@ +--- +slug: "/reference/python/signalwire/core/swaig-function/swaig-function" +title: "SWAIGFunction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.swaig_function.SWAIGFunction" + parent: "signalwire.core.swaig_function" + module: "signalwire.core.swaig_function" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py" +--- +# `SWAIGFunction` + +Represents a SWAIG function — i.e., a tool the AI model can call. + +A SWAIG function is exactly the same concept as a "tool" in native +OpenAI / Anthropic tool calling. Each SWAIGFunction is rendered into +the OpenAI tool schema format and sent to the model on every turn: + +``` +{"type": "function", "function": { + "name": self.name, + "description": self.description, + "parameters": self.parameters, +}} +``` + +The model parses `description` (and the `description` inside each +parameter) to decide WHEN to call the tool and HOW to fill in the +arguments. Both fields are prompt-engineered text — the quality of +your descriptions directly drives tool-selection accuracy. + +Use AgentBase.define\_tool() to create one (it builds the +SWAIGFunction for you and registers it). Use the @agent.tool() +decorator for the same thing in class-based agents. + +## Signature + +```python +class SWAIGFunction +``` + +## Examples + +```python +{"type": "function", "function": { + "name": self.name, + "description": self.description, + "parameters": self.parameters, +}} +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + Call the underlying handler function + + + + Initialize a new SWAIG function. + + + + Execute the function with the given arguments + + + + Convert this function to a SWAIG-compatible JSON object for SWML + + + + Validate the arguments against the parameter schema. + + + +## Source + +[`signalwire/signalwire/core/swaig_function.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py) + +Line 21. diff --git a/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/init.mdx b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/init.mdx new file mode 100644 index 0000000000..412bd5d6ff --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/init.mdx @@ -0,0 +1,90 @@ +--- +slug: "/reference/python/signalwire/core/swaig-function/swaig-function/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swaig_function.SWAIGFunction.__init__" + parent: "signalwire.core.swaig_function.SWAIGFunction" + module: "signalwire.core.swaig_function" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py" +--- +# `__init__` + +Initialize a new SWAIG function. + +## Signature + +```python +__init__( + name: str, + handler: Callable, + description: str, + parameters: Dict[str, Dict] = None, + secure: bool = False, + fillers: Optional[Dict[str, List[str]]] = None, + wait_file: Optional[str] = None, + wait_file_loops: Optional[int] = None, + webhook_url: Optional[str] = None, + required: Optional[List[str]] = None, + is_typed_handler: bool = False, + **extra_swaig_fields = {} +) +``` + +## Parameters + + + Function name. Becomes the `name` field in the OpenAI tool schema sent to the model — what the model emits when it decides to call this tool. + + + + Python callable invoked when the model calls this tool. + + + + LLM-facing description. The model reads this on every turn to decide whether to call the tool. Be specific about WHEN to use it and what makes it the right choice over sibling tools — vague descriptions are the most common cause of "model has the right tool but doesn't call it" failures. + + + + JSON Schema for the arguments. Per-property `description` strings inside the schema are also LLM-facing — write them as instructions to the model on how to fill in each argument. + + + + Whether this function requires SWAIG token validation. + + + + Optional dictionary of filler phrases by language code (deprecated, use wait\_file). + + + + Optional URL to audio file to play while function executes. + + + + Optional number of times to loop the wait\_file. + + + + Optional external webhook URL to use instead of local handling. + + + + Optional list of required parameter names. + + + + Whether the handler uses type-hinted parameters (auto-wrapped). + + + + +## Source + +[`signalwire/signalwire/core/swaig_function.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py) + +Line 44. diff --git a/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/to-swaig.mdx b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/to-swaig.mdx new file mode 100644 index 0000000000..b7d15a93a1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/to-swaig.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/swaig-function/swaig-function/to-swaig" +title: "to_swaig" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swaig_function.SWAIGFunction.to_swaig" + parent: "signalwire.core.swaig_function.SWAIGFunction" + module: "signalwire.core.swaig_function" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py" +--- +# `to_swaig` + +Convert this function to a SWAIG-compatible JSON object for SWML + +## Signature + +```python +to_swaig( + base_url: str, + token: Optional[str] = None, + call_id: Optional[str] = None, + include_auth: bool = True +) -> Dict[str, Any] +``` + +## Parameters + + + Base URL for the webhook + + + + Optional auth token to include + + + + Optional call ID for session tracking + + + + Whether to include auth credentials in URL + + +## Returns + +`Dict[str, Any]` — Dictionary representation for the SWAIG array in SWML + +## Source + +[`signalwire/signalwire/core/swaig_function.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py) + +Line 234. diff --git a/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/validate-args.mdx b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/validate-args.mdx new file mode 100644 index 0000000000..7751f6a1f2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swaig-function/swaig-function/validate-args.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/core/swaig-function/swaig-function/validate-args" +title: "validate_args" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swaig_function.SWAIGFunction.validate_args" + parent: "signalwire.core.swaig_function.SWAIGFunction" + module: "signalwire.core.swaig_function" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py" +--- +# `validate_args` + +Validate the arguments against the parameter schema. + +Uses jsonschema\_rs if available for fast validation, falls back to +jsonschema if available, otherwise skips validation. + +## Signature + +```python +validate_args(args: Dict[str, Any]) -> tuple +``` + +## Parameters + + + Arguments to validate + + +## Returns + +`tuple` — Tuple of (is\_valid: bool, errors: list\[str]) If no validation library is available, returns (True, \[]) + +## Source + +[`signalwire/signalwire/core/swaig_function.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swaig_function.py) + +Line 180. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/index.mdx new file mode 100644 index 0000000000..f44f6c8bc5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder" +title: "swml_builder" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.swml_builder" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `swml_builder` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module swml_builder +``` + +## Constants + + + +## Classes + + + + Fluent builder for SWML documents + + + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/add-section.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/add-section.mdx new file mode 100644 index 0000000000..806f618c05 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/add-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder/add-section" +title: "add_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder.add_section" + parent: "signalwire.core.swml_builder.SWMLBuilder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `add_section` + +Add a new section to the document + +## Signature + +```python +add_section(section_name: str) -> Self +``` + +## Parameters + + + Name of the section to add + + +## Returns + +`Self` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 206. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/ai.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/ai.mdx new file mode 100644 index 0000000000..72864969c0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/ai.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder/ai" +title: "ai" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder.ai" + parent: "signalwire.core.swml_builder.SWMLBuilder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `ai` + +Add an 'ai' verb to the main section + +## Signature + +```python +ai( + prompt_text: Optional[str] = None, + prompt_pom: Optional[List[Dict[str, Any]]] = None, + post_prompt: Optional[str] = None, + post_prompt_url: Optional[str] = None, + swaig: Optional[Dict[str, Any]] = None, + **kwargs = {} +) -> Self +``` + +## Parameters + + + Text prompt for the AI (mutually exclusive with prompt\_pom) + + + + POM structure for the AI prompt (mutually exclusive with prompt\_text) + + + + Optional post-prompt text + + + + Optional URL for post-prompt processing + + + + Optional SWAIG configuration + + + + +## Returns + +`Self` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 89. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/answer.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/answer.mdx new file mode 100644 index 0000000000..bc3d8a68a4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/answer.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder/answer" +title: "answer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder.answer" + parent: "signalwire.core.swml_builder.SWMLBuilder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `answer` + +Add an 'answer' verb to the main section + +## Signature + +```python +answer(max_duration: Optional[int] = None, codecs: Optional[str] = None) -> Self +``` + +## Parameters + + + Maximum duration in seconds + + + + Comma-separated list of codecs + + +## Returns + +`Self` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 54. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/build.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/build.mdx new file mode 100644 index 0000000000..1895f8eeee --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/build.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder/build" +title: "build" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder.build" + parent: "signalwire.core.swml_builder.SWMLBuilder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `build` + +Build and return the SWML document + +## Signature + +```python +build() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` — The complete SWML document as a dictionary + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 219. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/getattr.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/getattr.mdx new file mode 100644 index 0000000000..1992b3e7e6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/getattr.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder/getattr" +title: "__getattr__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder.__getattr__" + parent: "signalwire.core.swml_builder.SWMLBuilder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `__getattr__` + +Dynamically generate and return SWML verb methods when accessed + +This method is called when an attribute lookup fails through the normal +mechanisms. It checks if the attribute name corresponds to a SWML verb +defined in the schema, and if so, dynamically creates a method for that verb. + +## Signature + +```python +__getattr__(name: str) -> Any +``` + +## Parameters + + + The name of the attribute being accessed + + +## Returns + +`Any` — The dynamically created verb method if name is a valid SWML verb, otherwise raises AttributeError + +## Throws + +- `AttributeError` — If name is not a valid SWML verb + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 326. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/hangup.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/hangup.mdx new file mode 100644 index 0000000000..940e556b55 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/hangup.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder/hangup" +title: "hangup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder.hangup" + parent: "signalwire.core.swml_builder.SWMLBuilder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `hangup` + +Add a 'hangup' verb to the main section + +## Signature + +```python +hangup(reason: Optional[str] = None) -> Self +``` + +## Parameters + + + Optional reason for hangup + + +## Returns + +`Self` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 73. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/index.mdx new file mode 100644 index 0000000000..a72602db41 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/index.mdx @@ -0,0 +1,85 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder" +title: "SWMLBuilder" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder" + parent: "signalwire.core.swml_builder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `SWMLBuilder` + +Fluent builder for SWML documents + +This class provides a fluent interface for building SWML documents +by chaining method calls. It delegates to an underlying SWMLService +instance for the actual document creation. + +## Signature + +```python +class SWMLBuilder +``` + +## Properties + + + +## Methods + + + + Dynamically generate and return SWML verb methods when accessed + + + + Initialize with a SWMLService instance + + + + Add a new section to the document + + + + Add an 'ai' verb to the main section + + + + Add an 'answer' verb to the main section + + + + Build and return the SWML document + + + + Add a 'hangup' verb to the main section + + + + Add a 'play' verb to the main section + + + + Build and render the SWML document as a JSON string + + + + Reset the document to an empty state + + + + Add a 'play' verb with say: prefix for text-to-speech + + + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 30. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/init.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/init.mdx new file mode 100644 index 0000000000..87f23dbbfc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder.__init__" + parent: "signalwire.core.swml_builder.SWMLBuilder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `__init__` + +Initialize with a SWMLService instance + +## Signature + +```python +__init__(service: SWMLService) +``` + +## Parameters + + + The SWMLService to delegate to + + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 39. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/play.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/play.mdx new file mode 100644 index 0000000000..db29b83136 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/play.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder/play" +title: "play" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder.play" + parent: "signalwire.core.swml_builder.SWMLBuilder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `play` + +Add a 'play' verb to the main section + +## Signature + +```python +play( + url: Optional[str] = None, + urls: Optional[List[str]] = None, + volume: Optional[float] = None, + say_voice: Optional[str] = None, + say_language: Optional[str] = None, + say_gender: Optional[str] = None, + auto_answer: Optional[bool] = None +) -> Self +``` + +## Parameters + + + Single URL to play (mutually exclusive with urls) + + + + List of URLs to play (mutually exclusive with url) + + + + Volume level (-40 to 40) + + + + Voice for text-to-speech + + + + Language for text-to-speech + + + + Gender for text-to-speech + + + + Whether to auto-answer the call + + +## Returns + +`Self` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 132. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/render.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/render.mdx new file mode 100644 index 0000000000..08517cc206 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/render.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder/render" +title: "render" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder.render" + parent: "signalwire.core.swml_builder.SWMLBuilder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `render` + +Build and render the SWML document as a JSON string + +## Signature + +```python +render() -> str +``` + +## Returns + +`str` — The complete SWML document as a JSON string + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 228. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/reset.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/reset.mdx new file mode 100644 index 0000000000..06caa7fdc1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/reset.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder/reset" +title: "reset" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder.reset" + parent: "signalwire.core.swml_builder.SWMLBuilder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `reset` + +Reset the document to an empty state + +## Signature + +```python +reset() -> Self +``` + +## Returns + +`Self` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 237. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/say.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/say.mdx new file mode 100644 index 0000000000..51346e5117 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-builder/swml-builder/say.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/python/signalwire/core/swml-builder/swml-builder/say" +title: "say" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_builder.SWMLBuilder.say" + parent: "signalwire.core.swml_builder.SWMLBuilder" + module: "signalwire.core.swml_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py" +--- +# `say` + +Add a 'play' verb with say: prefix for text-to-speech + +## Signature + +```python +say( + text: str, + voice: Optional[str] = None, + language: Optional[str] = None, + gender: Optional[str] = None, + volume: Optional[float] = None +) -> Self +``` + +## Parameters + + + Text to speak + + + + Voice for text-to-speech + + + + Language for text-to-speech + + + + Gender for text-to-speech + + + + Volume level (-40 to 40) + + +## Returns + +`Self` — Self for method chaining + +## Source + +[`signalwire/signalwire/core/swml_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_builder.py) + +Line 178. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/build-config.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/build-config.mdx new file mode 100644 index 0000000000..e37be7a23e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/build-config.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/ai-verb-handler/build-config" +title: "build_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_handler.AIVerbHandler.build_config" + parent: "signalwire.core.swml_handler.AIVerbHandler" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `build_config` + +Build a configuration for the AI verb + +## Signature + +```python +build_config( + prompt_text: Optional[str] = None, + prompt_pom: Optional[List[Dict[str, Any]]] = None, + contexts: Optional[Dict[str, Any]] = None, + post_prompt: Optional[str] = None, + post_prompt_url: Optional[str] = None, + swaig: Optional[Dict[str, Any]] = None, + **kwargs = {} +) -> Dict[str, Any] +``` + +## Parameters + + + Text prompt for the AI (mutually exclusive with prompt\_pom) + + + + POM structure for the AI prompt (mutually exclusive with prompt\_text) + + + + Optional contexts and steps configuration (can be combined with text or pom) + + + + Optional post-prompt text + + + + Optional URL for post-prompt processing + + + + Optional SWAIG configuration + + + + +## Returns + +`Dict[str, Any]` — AI verb configuration dictionary + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 132. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/get-verb-name.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/get-verb-name.mdx new file mode 100644 index 0000000000..ead9344af4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/get-verb-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/ai-verb-handler/get-verb-name" +title: "get_verb_name" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_handler.AIVerbHandler.get_verb_name" + parent: "signalwire.core.swml_handler.AIVerbHandler" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `get_verb_name` + +Get the name of the verb this handler handles + +## Signature + +```python +get_verb_name() -> str +``` + +## Returns + +`str` — "ai" as the verb name + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 75. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/index.mdx new file mode 100644 index 0000000000..ed23d8b518 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/ai-verb-handler" +title: "AIVerbHandler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.swml_handler.AIVerbHandler" + parent: "signalwire.core.swml_handler" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `AIVerbHandler` + +Handler for the SWML 'ai' verb + +The 'ai' verb is complex and requires specialized handling, particularly +for managing prompts, SWAIG functions, and AI configurations. + +## Signature + +```python +class AIVerbHandler(SWMLVerbHandler) +``` + +## Inheritance + +**Extends:** [SWMLVerbHandler](/reference/python/signalwire/core/swml-handler/swml-verb-handler) + +## Methods + + + + Build a configuration for the AI verb + + + + Get the name of the verb this handler handles + + + + Validate the configuration for the AI verb + + + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 67. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/validate-config.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/validate-config.mdx new file mode 100644 index 0000000000..c5b2f72809 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/ai-verb-handler/validate-config.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/ai-verb-handler/validate-config" +title: "validate_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_handler.AIVerbHandler.validate_config" + parent: "signalwire.core.swml_handler.AIVerbHandler" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `validate_config` + +Validate the configuration for the AI verb + +## Signature + +```python +validate_config(config: Dict[str, Any]) -> Tuple[bool, List[str]] +``` + +## Parameters + + + The configuration dictionary for the AI verb + + +## Returns + +`Tuple[bool, List[str]]` — (is\_valid, error\_messages) tuple + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 84. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/index.mdx new file mode 100644 index 0000000000..4c3b6f7544 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler" +title: "swml_handler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.swml_handler" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `swml_handler` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module swml_handler +``` + +## Classes + + + + Handler for the SWML 'ai' verb + + + + Base interface for SWML verb handlers + + + + Registry for SWML verb handlers + + + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/build-config.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/build-config.mdx new file mode 100644 index 0000000000..f1cb711ab1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/build-config.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/swml-verb-handler/build-config" +title: "build_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_handler.SWMLVerbHandler.build_config" + parent: "signalwire.core.swml_handler.SWMLVerbHandler" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `build_config` + +Build a configuration for this verb from the provided arguments + +**Modifiers:** `abstract` + +## Signature + +```python +build_config(**kwargs = {}) -> Dict[str, Any] +``` + +## Parameters + + + +## Returns + +`Dict[str, Any]` — Configuration dictionary + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 53. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/get-verb-name.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/get-verb-name.mdx new file mode 100644 index 0000000000..622515687e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/get-verb-name.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/swml-verb-handler/get-verb-name" +title: "get_verb_name" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_handler.SWMLVerbHandler.get_verb_name" + parent: "signalwire.core.swml_handler.SWMLVerbHandler" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `get_verb_name` + +Get the name of the verb this handler handles + +**Modifiers:** `abstract` + +## Signature + +```python +get_verb_name() -> str +``` + +## Returns + +`str` — The verb name as a string + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 30. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/index.mdx new file mode 100644 index 0000000000..6f08300c89 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/swml-verb-handler" +title: "SWMLVerbHandler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.swml_handler.SWMLVerbHandler" + parent: "signalwire.core.swml_handler" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `SWMLVerbHandler` + +Base interface for SWML verb handlers + +This abstract class defines the interface that all SWML verb handlers +must implement. Verb handlers provide specialized logic for complex +SWML verbs that cannot be handled generically. + +## Signature + +```python +class SWMLVerbHandler(ABC) +``` + +## Inheritance + +**Extends:** `ABC` + +## Methods + + + + Build a configuration for this verb from the provided arguments + + + + Get the name of the verb this handler handles + + + + Validate the configuration for this verb + + + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 21. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/validate-config.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/validate-config.mdx new file mode 100644 index 0000000000..69ba36d5c2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/swml-verb-handler/validate-config.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/swml-verb-handler/validate-config" +title: "validate_config" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_handler.SWMLVerbHandler.validate_config" + parent: "signalwire.core.swml_handler.SWMLVerbHandler" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `validate_config` + +Validate the configuration for this verb + +**Modifiers:** `abstract` + +## Signature + +```python +validate_config(config: Dict[str, Any]) -> Tuple[bool, List[str]] +``` + +## Parameters + + + The configuration dictionary for this verb + + +## Returns + +`Tuple[bool, List[str]]` — (is\_valid, error\_messages) tuple + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 40. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/get-handler.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/get-handler.mdx new file mode 100644 index 0000000000..a719ce0fad --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/get-handler.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/verb-handler-registry/get-handler" +title: "get_handler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_handler.VerbHandlerRegistry.get_handler" + parent: "signalwire.core.swml_handler.VerbHandlerRegistry" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `get_handler` + +Get the handler for a specific verb + +## Signature + +```python +get_handler(verb_name: str) -> Optional[SWMLVerbHandler] +``` + +## Parameters + + + The name of the verb + + +## Returns + +`Optional[SWMLVerbHandler]` — The handler if found, None otherwise + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 235. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/has-handler.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/has-handler.mdx new file mode 100644 index 0000000000..6d6f226dfb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/has-handler.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/verb-handler-registry/has-handler" +title: "has_handler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_handler.VerbHandlerRegistry.has_handler" + parent: "signalwire.core.swml_handler.VerbHandlerRegistry" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `has_handler` + +Check if a handler exists for a specific verb + +## Signature + +```python +has_handler(verb_name: str) -> bool +``` + +## Parameters + + + The name of the verb + + +## Returns + +`bool` — True if a handler exists, False otherwise + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 247. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/index.mdx new file mode 100644 index 0000000000..d6ea57f5b2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/verb-handler-registry" +title: "VerbHandlerRegistry" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.swml_handler.VerbHandlerRegistry" + parent: "signalwire.core.swml_handler" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `VerbHandlerRegistry` + +Registry for SWML verb handlers + +This class maintains a registry of handlers for special SWML verbs +and provides methods for accessing and using them. + +## Signature + +```python +class VerbHandlerRegistry +``` + +## Methods + + + + Initialize the registry with default handlers + + + + Get the handler for a specific verb + + + + Check if a handler exists for a specific verb + + + + Register a new verb handler + + + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 210. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/init.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/init.mdx new file mode 100644 index 0000000000..c628ee39b9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/init.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/verb-handler-registry/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_handler.VerbHandlerRegistry.__init__" + parent: "signalwire.core.swml_handler.VerbHandlerRegistry" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `__init__` + +Initialize the registry with default handlers + +## Signature + +```python +__init__() +``` + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 218. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/register-handler.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/register-handler.mdx new file mode 100644 index 0000000000..587bb5a94c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-handler/verb-handler-registry/register-handler.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/swml-handler/verb-handler-registry/register-handler" +title: "register_handler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_handler.VerbHandlerRegistry.register_handler" + parent: "signalwire.core.swml_handler.VerbHandlerRegistry" + module: "signalwire.core.swml_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py" +--- +# `register_handler` + +Register a new verb handler + +## Signature + +```python +register_handler(handler: SWMLVerbHandler) -> None +``` + +## Parameters + + + The handler to register + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/swml_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_handler.py) + +Line 225. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-renderer/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-renderer/index.mdx new file mode 100644 index 0000000000..214176eee4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-renderer/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/core/swml-renderer" +title: "swml_renderer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.swml_renderer" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_renderer.py" +--- +# `swml_renderer` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module swml_renderer +``` + +## Classes + + + + Renders SWML documents for SignalWire AI Agents with AI and SWAIG components + + + +## Source + +[`signalwire/signalwire/core/swml_renderer.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_renderer.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-renderer/swml-renderer/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-renderer/swml-renderer/index.mdx new file mode 100644 index 0000000000..b48969634d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-renderer/swml-renderer/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/swml-renderer/swml-renderer" +title: "SwmlRenderer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.swml_renderer.SwmlRenderer" + parent: "signalwire.core.swml_renderer" + module: "signalwire.core.swml_renderer" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_renderer.py" +--- +# `SwmlRenderer` + +Renders SWML documents for SignalWire AI Agents with AI and SWAIG components + +This class provides methods for rendering SWML documents using the SWMLService architecture. + +## Signature + +```python +class SwmlRenderer +``` + +## Methods + + + + Generate a SWML document for a function response + + + + Generate a complete SWML document with AI configuration + + + +## Source + +[`signalwire/signalwire/core/swml_renderer.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_renderer.py) + +Line 21. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-renderer/swml-renderer/render-function-response-swml.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-renderer/swml-renderer/render-function-response-swml.mdx new file mode 100644 index 0000000000..a0b86dbad9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-renderer/swml-renderer/render-function-response-swml.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/python/signalwire/core/swml-renderer/swml-renderer/render-function-response-swml" +title: "render_function_response_swml" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_renderer.SwmlRenderer.render_function_response_swml" + parent: "signalwire.core.swml_renderer.SwmlRenderer" + module: "signalwire.core.swml_renderer" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_renderer.py" +--- +# `render_function_response_swml` + +Generate a SWML document for a function response + +**Modifiers:** `static` + +## Signature + +```python +@staticmethod +render_function_response_swml( + response_text: str, + service: SWMLService, + actions: Optional[List[Dict[str, Any]]] = None, + format: str = 'json' +) -> str +``` + +## Parameters + + + Text response to include in the document + + + + SWMLService instance to use + + + + Optional list of actions to perform + + + + Output format (json or yaml) + + +## Returns + +`str` — SWML document as a string + +## Source + +[`signalwire/signalwire/core/swml_renderer.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_renderer.py) + +Line 150. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-renderer/swml-renderer/render-swml.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-renderer/swml-renderer/render-swml.mdx new file mode 100644 index 0000000000..5529d050fe --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-renderer/swml-renderer/render-swml.mdx @@ -0,0 +1,114 @@ +--- +slug: "/reference/python/signalwire/core/swml-renderer/swml-renderer/render-swml" +title: "render_swml" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_renderer.SwmlRenderer.render_swml" + parent: "signalwire.core.swml_renderer.SwmlRenderer" + module: "signalwire.core.swml_renderer" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_renderer.py" +--- +# `render_swml` + +Generate a complete SWML document with AI configuration + +**Modifiers:** `static` + +## Signature + +```python +@staticmethod +render_swml( + prompt: Union[str, List[Dict[str, Any]]], + service: SWMLService, + post_prompt: Optional[str] = None, + post_prompt_url: Optional[str] = None, + swaig_functions: Optional[List[Dict[str, Any]]] = None, + startup_hook_url: Optional[str] = None, + hangup_hook_url: Optional[str] = None, + prompt_is_pom: bool = False, + params: Optional[Dict[str, Any]] = None, + add_answer: bool = False, + record_call: bool = False, + record_format: str = 'mp4', + record_stereo: bool = True, + format: str = 'json', + default_webhook_url: Optional[str] = None +) -> str +``` + +## Parameters + + + AI prompt text or POM structure + + + + SWMLService instance to use for document building + + + + Optional post-prompt text + + + + Optional post-prompt URL + + + + List of SWAIG function definitions + + + + Optional startup hook URL + + + + Optional hangup hook URL + + + + Whether prompt is POM format + + + + Additional AI verb parameters + + + + Whether to add answer verb + + + + Whether to add record\_call verb + + + + Recording format + + + + Whether to record in stereo + + + + Output format (json or yaml) + + + + Default webhook URL for SWAIG functions + + +## Returns + +`str` — SWML document as a string + +## Source + +[`signalwire/signalwire/core/swml_renderer.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_renderer.py) + +Line 28. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/index.mdx new file mode 100644 index 0000000000..51bdf14b3b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/core/swml-service" +title: "swml_service" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.core.swml_service" + parent: "signalwire.core" + module: "signalwire.core" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `swml_service` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module swml_service +``` + +## Properties + + + +## Constants + + + +## Classes + + + + Base class for creating and serving SWML documents. + + + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/add-section.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/add-section.mdx new file mode 100644 index 0000000000..98a00bf8f6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/add-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/add-section" +title: "add_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.add_section" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `add_section` + +Add a new section to the document + +## Signature + +```python +add_section(section_name: str) -> bool +``` + +## Parameters + + + Name of the section to add + + +## Returns + +`bool` — True if the section was added, False if it already exists + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 473. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/add-verb-to-section.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/add-verb-to-section.mdx new file mode 100644 index 0000000000..de8288eadf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/add-verb-to-section.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/add-verb-to-section" +title: "add_verb_to_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.add_verb_to_section" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `add_verb_to_section` + +Add a verb to a specific section + +## Signature + +```python +add_verb_to_section( + section_name: str, + verb_name: str, + config: Union[Dict[str, Any], int] +) -> bool +``` + +## Parameters + + + Name of the section to add to + + + + The name of the verb to add + + + + Configuration for the verb or direct value for certain verbs (e.g., sleep) + + +## Returns + +`bool` — True if the verb was added successfully, False otherwise + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 489. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/add-verb.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/add-verb.mdx new file mode 100644 index 0000000000..d56a088b52 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/add-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/add-verb" +title: "add_verb" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.add_verb" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `add_verb` + +Add a verb to the main section of the current document + +## Signature + +```python +add_verb(verb_name: str, config: Union[Dict[str, Any], int]) -> bool +``` + +## Parameters + + + The name of the verb to add + + + + Configuration for the verb or direct value for certain verbs (e.g., sleep) + + +## Returns + +`bool` — True if the verb was added successfully, False otherwise + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 433. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/as-router.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/as-router.mdx new file mode 100644 index 0000000000..766b6011d5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/as-router.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/as-router" +title: "as_router" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.as_router" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `as_router` + +Create a FastAPI router for this service + +## Signature + +```python +as_router() -> APIRouter +``` + +## Returns + +`APIRouter` — FastAPI router + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 561. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/extract-sip-username.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/extract-sip-username.mdx new file mode 100644 index 0000000000..89fe2b2623 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/extract-sip-username.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/extract-sip-username" +title: "extract_sip_username" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.extract_sip_username" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `extract_sip_username` + +Extract SIP username from request body + +This extracts the username portion of a SIP URI from the 'to' field +in the call data of a request body. + +**Modifiers:** `static` + +## Signature + +```python +@staticmethod +extract_sip_username(request_body: Dict[str, Any]) -> Optional[str] +``` + +## Parameters + + + The parsed JSON body of the request + + +## Returns + +`Optional[str]` — The extracted SIP username, or None if not found + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 821. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..54be55d347 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/get-basic-auth-credentials.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/get-basic-auth-credentials" +title: "get_basic_auth_credentials" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.get_basic_auth_credentials" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `get_basic_auth_credentials` + +Get the basic auth credentials + +## Signature + +```python +get_basic_auth_credentials( + include_source: bool = False +) -> Union[Tuple[str, str], Tuple[str, str, str]] +``` + +## Parameters + + + Whether to include the source of the credentials + + +## Returns + +`Union[Tuple[str, str], Tuple[str, str, str]]` — (username, password) tuple or (username, password, source) tuple if include\_source is True + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 1133. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/get-document.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/get-document.mdx new file mode 100644 index 0000000000..1fa0a38cd6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/get-document.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/get-document" +title: "get_document" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.get_document" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `get_document` + +Get the current SWML document + +## Signature + +```python +get_document() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` — The current SWML document as a dictionary + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 534. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/getattr.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/getattr.mdx new file mode 100644 index 0000000000..af2cfacc78 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/getattr.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/getattr" +title: "__getattr__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.__getattr__" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `__getattr__` + +Dynamically generate and return SWML verb methods when accessed + +This method is called when an attribute lookup fails through the normal +mechanisms. It checks if the attribute name corresponds to a SWML verb +defined in the schema, and if so, dynamically creates a method for that verb. + +## Signature + +```python +__getattr__(name: str) -> Any +``` + +## Parameters + + + The name of the attribute being accessed + + +## Returns + +`Any` — The dynamically created verb method if name is a valid SWML verb, otherwise raises AttributeError + +## Throws + +- `AttributeError` — If name is not a valid SWML verb + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 256. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/index.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/index.mdx new file mode 100644 index 0000000000..ee9ac72e44 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/index.mdx @@ -0,0 +1,145 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service" +title: "SWMLService" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService" + parent: "signalwire.core.swml_service" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `SWMLService` + +Base class for creating and serving SWML documents. + +This class provides core functionality for: + +- Loading and validating SWML schema +- Creating SWML documents +- Setting up web endpoints for serving SWML +- Managing authentication +- Registering SWML functions + +It serves as the foundation for more specialized services like AgentBase. + +## Signature + +```python +class SWMLService(ToolMixin) +``` + +## Inheritance + +**Extends:** [ToolMixin](/reference/python/signalwire/core/mixins/tool-mixin/tool-mixin) + +## Properties + + + + + Check if full JSON Schema validation is enabled. + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + Dynamically generate and return SWML verb methods when accessed + + + + Initialize a new SWML service + + + + Add a new section to the document + + + + Add a verb to the main section of the current document + + + + Add a verb to a specific section + + + + Create a FastAPI router for this service + + + + Extract SIP username from request body + + + + Get the basic auth credentials + + + + Get the current SWML document + + + + Manually set the proxy URL base for webhook callbacks + + + + Called when SWML is requested, with request data when available + + + + Register a callback function that will be called to determine routing based on POST data. + + + + Register a custom verb handler + + + + Render the current SWML document as a JSON string + + + + Reset the current document to an empty state + + + + Start a web server for this service + + + + Stop the web server + + + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 56. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/init.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/init.mdx new file mode 100644 index 0000000000..f08952c55e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/init.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.__init__" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `__init__` + +Initialize a new SWML service + +## Signature + +```python +__init__( + name: str, + route: str = '/', + host: str = '0.0.0.0', + port: Optional[int] = None, + basic_auth: Optional[Tuple[str, str]] = None, + schema_path: Optional[str] = None, + config_file: Optional[str] = None, + schema_validation: bool = True +) +``` + +## Parameters + + + Service name/identifier + + + + HTTP route path for this service + + + + Host to bind the web server to + + + + Port to bind the web server to + + + + Optional (username, password) tuple for basic auth + + + + Optional path to the schema file + + + + Optional path to configuration file + + + + Enable schema validation. Default True. Can also be disabled via SWML\_SKIP\_SCHEMA\_VALIDATION=1 env var. + + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 70. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/manual-set-proxy-url.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..190862efcf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/manual-set-proxy-url.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/manual-set-proxy-url" +title: "manual_set_proxy_url" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.manual_set_proxy_url" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `manual_set_proxy_url` + +Manually set the proxy URL base for webhook callbacks + +This can be called at runtime to set or update the proxy URL + +## Signature + +```python +manual_set_proxy_url(proxy_url: str) -> None +``` + +## Parameters + + + The base URL to use for webhooks (e.g., https://example.ngrok.io) + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 1399. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/on-request.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/on-request.mdx new file mode 100644 index 0000000000..06e9dd89ba --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/on-request.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/on-request" +title: "on_request" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.on_request" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `on_request` + +Called when SWML is requested, with request data when available + +Subclasses can override this to inspect or modify SWML based on the request + +## Signature + +```python +on_request( + request_data: Optional[dict] = None, + callback_path: Optional[str] = None +) -> Optional[dict] +``` + +## Parameters + + + Optional dictionary containing the parsed POST body + + + + Optional callback path + + +## Returns + +`Optional[dict]` — Optional dict to modify/augment the SWML document + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 941. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/register-routing-callback.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/register-routing-callback.mdx new file mode 100644 index 0000000000..31dfde8022 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/register-routing-callback.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/register-routing-callback" +title: "register_routing_callback" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.register_routing_callback" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `register_routing_callback` + +Register a callback function that will be called to determine routing +based on POST data. + +When a routing callback is registered, an endpoint at the specified path is automatically +created that will handle requests. This endpoint will use the callback to +determine if the request should be processed by this service or redirected. + +The callback should take a request object and request body dictionary and return: + +- A route string if it should be routed to a different endpoint +- None if normal processing should continue + +## Signature + +```python +register_routing_callback( + callback_fn: Callable[Request, Dict[str, Any], Optional[str]], + path: str = '/sip' +) -> None +``` + +## Parameters + + + The callback function to register + + + + The path where this callback should be registered (default: "/sip") + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 795. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/register-verb-handler.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/register-verb-handler.mdx new file mode 100644 index 0000000000..2317a633b9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/register-verb-handler.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/register-verb-handler" +title: "register_verb_handler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.register_verb_handler" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `register_verb_handler` + +Register a custom verb handler + +## Signature + +```python +register_verb_handler(handler: SWMLVerbHandler) -> None +``` + +## Parameters + + + The verb handler to register + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 552. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/render-document.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/render-document.mdx new file mode 100644 index 0000000000..65e53437e6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/render-document.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/render-document" +title: "render_document" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.render_document" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `render_document` + +Render the current SWML document as a JSON string + +## Signature + +```python +render_document() -> str +``` + +## Returns + +`str` — The current SWML document as a JSON string + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 543. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/reset-document.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/reset-document.mdx new file mode 100644 index 0000000000..b3ddf0a782 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/reset-document.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/reset-document" +title: "reset_document" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.reset_document" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `reset_document` + +Reset the current document to an empty state + +## Signature + +```python +reset_document() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 427. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/serve.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/serve.mdx new file mode 100644 index 0000000000..e32f1a43f9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/serve.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/serve" +title: "serve" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.serve" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `serve` + +Start a web server for this service + +## Signature + +```python +serve( + host: Optional[str] = None, + port: Optional[int] = None, + ssl_cert: Optional[str] = None, + ssl_key: Optional[str] = None, + ssl_enabled: Optional[bool] = None, + domain: Optional[str] = None +) -> None +``` + +## Parameters + + + Host to bind to (defaults to self.host) + + + + Port to bind to (defaults to self.port) + + + + Path to SSL certificate file + + + + Path to SSL key file + + + + Whether to enable SSL + + + + Domain name for SSL certificate + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 957. diff --git a/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/stop.mdx b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/stop.mdx new file mode 100644 index 0000000000..9527a94efc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/core/swml-service/swml-service/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/core/swml-service/swml-service/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.core.swml_service.SWMLService.stop" + parent: "signalwire.core.swml_service.SWMLService" + module: "signalwire.core.swml_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py" +--- +# `stop` + +Stop the web server + +## Signature + +```python +stop() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/core/swml_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/core/swml_service.py) + +Line 1098. diff --git a/fern/products/sdk-reference/python/signalwire/index.mdx b/fern/products/sdk-reference/python/signalwire/index.mdx new file mode 100644 index 0000000000..b0c2cb4f4d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/index.mdx @@ -0,0 +1,124 @@ +--- +slug: "/reference/python/signalwire" +title: "signalwire" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py" +--- +# `signalwire` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module signalwire +``` + +## Properties + + + + + +## Functions + + + + Add a directory to search for skills + + + + List available skills (lazy import) + + + + Get complete schema for all available skills including parameter metadata + + + + Register a custom skill class + + + + Create a SignalWire REST API client (lazy import) + + + + Run an agent (lazy import) + + + + Start an agent (lazy import) + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + SignalWire RELAY client — real-time call control over WebSocket. + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/list-skills-with-params.mdx b/fern/products/sdk-reference/python/signalwire/list-skills-with-params.mdx new file mode 100644 index 0000000000..9b464cad96 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/list-skills-with-params.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/list-skills-with-params" +title: "list_skills_with_params" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.list_skills_with_params" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py" +--- +# `list_skills_with_params` + +Get complete schema for all available skills including parameter metadata + +This function returns a comprehensive schema for all available skills, +including their metadata and parameter definitions. This is useful for +GUI configuration tools, API documentation, or programmatic skill discovery. + +> \[!NOTE] +> +> > > > schema = list\_skills\_with\_params() +> > > > print(schema\['web\_search']\['parameters']\['api\_key']) +> > > > \{ +> > > > 'type': 'string', +> > > > 'description': 'Google Custom Search API key', +> > > > 'required': True, +> > > > 'hidden': True, +> > > > 'env\_var': 'GOOGLE\_SEARCH\_API\_KEY' +> > > > \} + +## Signature + +```python +list_skills_with_params() +``` + +## Returns + +Dict\[str, Dict\[str, Any]]: Complete skill schema where keys are skill names + +## Source + +[`signalwire/signalwire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py) + +Line 70. diff --git a/fern/products/sdk-reference/python/signalwire/list-skills.mdx b/fern/products/sdk-reference/python/signalwire/list-skills.mdx new file mode 100644 index 0000000000..f8472c4698 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/list-skills.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/list-skills" +title: "list_skills" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.list_skills" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py" +--- +# `list_skills` + +List available skills (lazy import) + +## Signature + +```python +list_skills(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py) + +Line 62. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-handoff/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-handoff/index.mdx new file mode 100644 index 0000000000..4c251331c4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-handoff/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-handoff" +title: "AgentHandoff" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.AgentHandoff" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `AgentHandoff` + +Signals a handoff to another agent in multi-agent scenarios. + +## Signature + +```python +class AgentHandoff +``` + +## Properties + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 150. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-handoff/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-handoff/init.mdx new file mode 100644 index 0000000000..31b5101128 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-handoff/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-handoff/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.AgentHandoff.__init__" + parent: "signalwire.livewire.AgentHandoff" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__(agent, *, returns = None) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 153. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-server/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-server/index.mdx new file mode 100644 index 0000000000..13f80e2561 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-server/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-server" +title: "AgentServer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.AgentServer" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `AgentServer` + +Mirrors a livekit AgentServer -- registers entrypoints and starts. + +## Signature + +```python +class AgentServer +``` + +## Properties + + + +## Methods + + + + + + Decorator that registers the session entrypoint. + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 683. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-server/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-server/init.mdx new file mode 100644 index 0000000000..1007dc346d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-server/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-server/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.AgentServer.__init__" + parent: "signalwire.livewire.AgentServer" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 686. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-server/rtc-session.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-server/rtc-session.mdx new file mode 100644 index 0000000000..2846a8c90b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-server/rtc-session.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-server/rtc-session" +title: "rtc_session" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.AgentServer.rtc_session" + parent: "signalwire.livewire.AgentServer" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `rtc_session` + +Decorator that registers the session entrypoint. + +## Signature + +```python +rtc_session( + func = None, + *, + agent_name: str = '', + type: str = 'room', + on_request = None, + on_session_end = None +) +``` + +## Parameters + + + + + + + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 691. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-session/generate-reply.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/generate-reply.mdx new file mode 100644 index 0000000000..e508c7aa66 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/generate-reply.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-session/generate-reply" +title: "generate_reply" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.AgentSession.generate_reply" + parent: "signalwire.livewire.AgentSession" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `generate_reply` + +Trigger the agent to generate a reply. On SignalWire the prompt +handles this; if _instructions_ is provided they are noted. + +## Signature + +```python +generate_reply(*, instructions: Optional[str] = None) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 514. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-session/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/index.mdx new file mode 100644 index 0000000000..18bdadc3dc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-session" +title: "AgentSession" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.AgentSession" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `AgentSession` + +Mirrors a livekit AgentSession -- orchestrator that binds an Agent +to the SignalWire platform. + +## Signature + +```python +class AgentSession +``` + +## Properties + + + + + +## Methods + + + + + + Trigger the agent to generate a reply. On SignalWire the prompt handles this; if _instructions_ is provided they are noted. + + + + Noop -- SignalWire handles barge-in automatically. + + + + Queue text to be spoken by the agent. + + + + Bind to an Agent and prepare the underlying SignalWire AgentBase. + + + + Swap in a new Agent. + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 403. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-session/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/init.mdx new file mode 100644 index 0000000000..ac08b7b948 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/init.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-session/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.AgentSession.__init__" + parent: "signalwire.livewire.AgentSession" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__( + *, + stt: Any = None, + tts: Any = None, + llm: Any = None, + vad: Any = None, + turn_detection: Any = None, + tools: Optional[List[Any]] = None, + mcp_servers: Any = None, + userdata: Any = None, + allow_interruptions: bool = True, + min_interruption_duration: float = 0.5, + min_endpointing_delay: float = 0.5, + max_endpointing_delay: float = 3.0, + max_tool_steps: int = 3, + preemptive_generation: bool = False +) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 407. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-session/interrupt.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/interrupt.mdx new file mode 100644 index 0000000000..9e18c1265e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/interrupt.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-session/interrupt" +title: "interrupt" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.AgentSession.interrupt" + parent: "signalwire.livewire.AgentSession" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `interrupt` + +Noop -- SignalWire handles barge-in automatically. + +## Signature + +```python +interrupt() +``` + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 520. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-session/say.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/say.mdx new file mode 100644 index 0000000000..91269f5a00 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/say.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-session/say" +title: "say" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.AgentSession.say" + parent: "signalwire.livewire.AgentSession" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `say` + +Queue text to be spoken by the agent. + +## Signature + +```python +say(text: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 510. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-session/start.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/start.mdx new file mode 100644 index 0000000000..199cc49b1c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/start.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-session/start" +title: "start" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.AgentSession.start" + parent: "signalwire.livewire.AgentSession" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `start` + +Bind to an Agent and prepare the underlying SignalWire AgentBase. + +**Modifiers:** `async` + +## Signature + +```python +async start(agent: Agent, *, room = None, record: bool = False) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 504. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent-session/update-agent.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/update-agent.mdx new file mode 100644 index 0000000000..2d2a7661de --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent-session/update-agent.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/livewire/agent-session/update-agent" +title: "update_agent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.AgentSession.update_agent" + parent: "signalwire.livewire.AgentSession" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `update_agent` + +Swap in a new Agent. + +## Signature + +```python +update_agent(agent: Agent) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 528. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent/index.mdx new file mode 100644 index 0000000000..bde44c19ae --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/python/signalwire/livewire/agent" +title: "Agent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.Agent" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `Agent` + +Mirrors a livekit Agent -- holds instructions and tool definitions. + +## Signature + +```python +class Agent +``` + +## Properties + + + + + +## Methods + + + + + + Noop -- SignalWire handles LLM in its control plane. + + + + Called when the agent enters. Override in subclass. + + + + Called when the agent exits. Override in subclass. + + + + Called when the user finishes speaking. Override in subclass. + + + + Noop -- SignalWire handles STT in its control plane. + + + + Noop -- SignalWire handles TTS in its control plane. + + + + Update the agent's instructions mid-session. + + + + Update the agent's tool list mid-session. + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 271. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent/init.mdx new file mode 100644 index 0000000000..52551709d9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent/init.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/python/signalwire/livewire/agent/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.Agent.__init__" + parent: "signalwire.livewire.Agent" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__( + *, + instructions: str = '', + tools: Optional[List[Any]] = None, + chat_ctx: Any = NOT_GIVEN, + stt: Any = NOT_GIVEN, + tts: Any = NOT_GIVEN, + llm: Any = NOT_GIVEN, + vad: Any = NOT_GIVEN, + turn_detection: Any = NOT_GIVEN, + mcp_servers: Any = NOT_GIVEN, + allow_interruptions: Any = NOT_GIVEN, + min_endpointing_delay: Any = NOT_GIVEN, + max_endpointing_delay: Any = NOT_GIVEN +) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 274. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent/llm-node.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent/llm-node.mdx new file mode 100644 index 0000000000..e4363ac287 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent/llm-node.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/livewire/agent/llm-node" +title: "llm_node" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.Agent.llm_node" + parent: "signalwire.livewire.Agent" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `llm_node` + +Noop -- SignalWire handles LLM in its control plane. + +**Modifiers:** `async` + +## Signature + +```python +async llm_node(chat_ctx = None, tools = None, model_settings = None) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 370. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent/on-enter.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent/on-enter.mdx new file mode 100644 index 0000000000..22fae5e5f6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent/on-enter.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/livewire/agent/on-enter" +title: "on_enter" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.Agent.on_enter" + parent: "signalwire.livewire.Agent" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `on_enter` + +Called when the agent enters. Override in subclass. + +**Modifiers:** `async` + +## Signature + +```python +async on_enter() +``` + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 346. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent/on-exit.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent/on-exit.mdx new file mode 100644 index 0000000000..66823fd8d9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent/on-exit.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/livewire/agent/on-exit" +title: "on_exit" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.Agent.on_exit" + parent: "signalwire.livewire.Agent" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `on_exit` + +Called when the agent exits. Override in subclass. + +**Modifiers:** `async` + +## Signature + +```python +async on_exit() +``` + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 350. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent/on-user-turn-completed.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent/on-user-turn-completed.mdx new file mode 100644 index 0000000000..7e4c83cc73 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent/on-user-turn-completed.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/livewire/agent/on-user-turn-completed" +title: "on_user_turn_completed" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.Agent.on_user_turn_completed" + parent: "signalwire.livewire.Agent" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `on_user_turn_completed` + +Called when the user finishes speaking. Override in subclass. + +**Modifiers:** `async` + +## Signature + +```python +async on_user_turn_completed(turn_ctx = None, new_message = None) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 354. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent/stt-node.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent/stt-node.mdx new file mode 100644 index 0000000000..91e3ca3b87 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent/stt-node.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/livewire/agent/stt-node" +title: "stt_node" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.Agent.stt_node" + parent: "signalwire.livewire.Agent" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `stt_node` + +Noop -- SignalWire handles STT in its control plane. + +**Modifiers:** `async` + +## Signature + +```python +async stt_node(audio = None, model_settings = None) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 362. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent/tts-node.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent/tts-node.mdx new file mode 100644 index 0000000000..1f2b53c904 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent/tts-node.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/livewire/agent/tts-node" +title: "tts_node" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.Agent.tts_node" + parent: "signalwire.livewire.Agent" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `tts_node` + +Noop -- SignalWire handles TTS in its control plane. + +**Modifiers:** `async` + +## Signature + +```python +async tts_node(text = None, model_settings = None) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 378. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent/update-instructions.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent/update-instructions.mdx new file mode 100644 index 0000000000..acfd126098 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent/update-instructions.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/livewire/agent/update-instructions" +title: "update_instructions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.Agent.update_instructions" + parent: "signalwire.livewire.Agent" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `update_instructions` + +Update the agent's instructions mid-session. + +**Modifiers:** `async` + +## Signature + +```python +async update_instructions(instructions: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 390. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/agent/update-tools.mdx b/fern/products/sdk-reference/python/signalwire/livewire/agent/update-tools.mdx new file mode 100644 index 0000000000..62fcbf17f7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/agent/update-tools.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/livewire/agent/update-tools" +title: "update_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.Agent.update_tools" + parent: "signalwire.livewire.Agent" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `update_tools` + +Update the agent's tool list mid-session. + +**Modifiers:** `async` + +## Signature + +```python +async update_tools(tools: List[Any]) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 394. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/chat-context/append.mdx b/fern/products/sdk-reference/python/signalwire/livewire/chat-context/append.mdx new file mode 100644 index 0000000000..18ade0f3bf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/chat-context/append.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/livewire/chat-context/append" +title: "append" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.ChatContext.append" + parent: "signalwire.livewire.ChatContext" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `append` + +## Signature + +```python +append(*, role: str = 'user', text: str = '') +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 168. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/chat-context/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/chat-context/index.mdx new file mode 100644 index 0000000000..3094a21410 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/chat-context/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/livewire/chat-context" +title: "ChatContext" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.ChatContext" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `ChatContext` + +Minimal stub mirroring livekit ChatContext. + +## Signature + +```python +class ChatContext +``` + +## Properties + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 162. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/chat-context/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/chat-context/init.mdx new file mode 100644 index 0000000000..e8b88d69e6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/chat-context/init.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/livewire/chat-context/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.ChatContext.__init__" + parent: "signalwire.livewire.ChatContext" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__() +``` + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 165. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/function-tool.mdx b/fern/products/sdk-reference/python/signalwire/livewire/function-tool.mdx new file mode 100644 index 0000000000..a5f61e52a5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/function-tool.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/livewire/function-tool" +title: "function_tool" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.livewire.function_tool" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `function_tool` + +Mirrors the livekit `@function_tool` decorator. + +Wraps a plain function so it can be passed into `Agent(tools=[...])`. +Parameters are extracted from type-hints; the docstring is used as the +description when _description_ is not provided explicitly. + +## Signature + +```python +function_tool( + func = None, + *, + name: Optional[str] = None, + description: Optional[str] = None +) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 177. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/index.mdx new file mode 100644 index 0000000000..0a6daa56e0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/index.mdx @@ -0,0 +1,132 @@ +--- +slug: "/reference/python/signalwire/livewire" +title: "livewire" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.livewire" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `livewire` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module livewire +``` + +## Properties + + + + + + + + + + + +## Constants + + + + + + + +## Functions + + + + Mirrors the livekit `@function_tool` decorator. + + + + Print banner, print a random tip, run the agent. + + + +## Classes + + + + Mirrors a livekit Agent -- holds instructions and tool definitions. + + + + Signals a handoff to another agent in multi-agent scenarios. + + + + Mirrors a livekit AgentServer -- registers entrypoints and starts. + + + + Mirrors a livekit AgentSession -- orchestrator that binds an Agent to the SignalWire platform. + + + + Minimal stub mirroring livekit ChatContext. + + + + Stub for livekit inference.LLM. + + + + Stub for livekit inference.STT. + + + + Stub for livekit inference.TTS. + + + + Mirrors a livekit JobContext -- provides room and connection info. + + + + Mirrors a livekit JobProcess -- used for prewarm/setup. + + + + Stub -- SignalWire doesn't use the LiveKit room abstraction. + + + + Mirrors livekit RunContext -- available inside tool handlers. + + + + Signals that a tool should not trigger another LLM reply. + + + + Signals a tool execution error. + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/livewire/inference-llm/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/inference-llm/index.mdx new file mode 100644 index 0000000000..2255d20cbe --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/inference-llm/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/livewire/inference-llm" +title: "InferenceLLM" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.InferenceLLM" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `InferenceLLM` + +Stub for livekit inference.LLM. + +## Signature + +```python +class InferenceLLM +``` + +## Properties + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 748. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/inference-llm/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/inference-llm/init.mdx new file mode 100644 index 0000000000..8f0caa4c8f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/inference-llm/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/livewire/inference-llm/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.InferenceLLM.__init__" + parent: "signalwire.livewire.InferenceLLM" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__(model: str = '', **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 751. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/inference-stt/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/inference-stt/index.mdx new file mode 100644 index 0000000000..1639fedc3c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/inference-stt/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/livewire/inference-stt" +title: "InferenceSTT" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.InferenceSTT" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `InferenceSTT` + +Stub for livekit inference.STT. + +## Signature + +```python +class InferenceSTT +``` + +## Properties + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 736. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/inference-stt/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/inference-stt/init.mdx new file mode 100644 index 0000000000..20ef2c54e0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/inference-stt/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/livewire/inference-stt/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.InferenceSTT.__init__" + parent: "signalwire.livewire.InferenceSTT" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__(model: str = '', **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 739. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/inference-tts/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/inference-tts/index.mdx new file mode 100644 index 0000000000..d2b8ffcb91 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/inference-tts/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/livewire/inference-tts" +title: "InferenceTTS" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.InferenceTTS" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `InferenceTTS` + +Stub for livekit inference.TTS. + +## Signature + +```python +class InferenceTTS +``` + +## Properties + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 755. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/inference-tts/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/inference-tts/init.mdx new file mode 100644 index 0000000000..f4c2f2c20a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/inference-tts/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/livewire/inference-tts/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.InferenceTTS.__init__" + parent: "signalwire.livewire.InferenceTTS" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__(model: str = '', **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 758. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/job-context/connect.mdx b/fern/products/sdk-reference/python/signalwire/livewire/job-context/connect.mdx new file mode 100644 index 0000000000..f0aca84bf7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/job-context/connect.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/python/signalwire/livewire/job-context/connect" +title: "connect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.JobContext.connect" + parent: "signalwire.livewire.JobContext" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `connect` + +Noop -- SignalWire agents connect automatically when the platform +invokes the SWML endpoint. + +**Modifiers:** `async` + +## Signature + +```python +async connect() +``` + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 661. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/job-context/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/job-context/index.mdx new file mode 100644 index 0000000000..33c0d9f32a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/job-context/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/livewire/job-context" +title: "JobContext" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.JobContext" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `JobContext` + +Mirrors a livekit JobContext -- provides room and connection info. + +## Signature + +```python +class JobContext +``` + +## Properties + + + + + +## Methods + + + + + + Noop -- SignalWire agents connect automatically when the platform invokes the SWML endpoint. + + + + Noop -- SignalWire handles participant management automatically. + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 653. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/job-context/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/job-context/init.mdx new file mode 100644 index 0000000000..66075a01c2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/job-context/init.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/livewire/job-context/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.JobContext.__init__" + parent: "signalwire.livewire.JobContext" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__() +``` + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 656. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/job-context/wait-for-participant.mdx b/fern/products/sdk-reference/python/signalwire/livewire/job-context/wait-for-participant.mdx new file mode 100644 index 0000000000..2321b802c5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/job-context/wait-for-participant.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/livewire/job-context/wait-for-participant" +title: "wait_for_participant" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.JobContext.wait_for_participant" + parent: "signalwire.livewire.JobContext" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `wait_for_participant` + +Noop -- SignalWire handles participant management automatically. + +**Modifiers:** `async` + +## Signature + +```python +async wait_for_participant(*, identity = None) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 670. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/job-process/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/job-process/index.mdx new file mode 100644 index 0000000000..4d6ea6ba51 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/job-process/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/livewire/job-process" +title: "JobProcess" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.JobProcess" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `JobProcess` + +Mirrors a livekit JobProcess -- used for prewarm/setup. + +## Signature + +```python +class JobProcess +``` + +## Properties + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 646. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/job-process/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/job-process/init.mdx new file mode 100644 index 0000000000..9f22cbf8f0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/job-process/init.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/livewire/job-process/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.JobProcess.__init__" + parent: "signalwire.livewire.JobProcess" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__() +``` + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 649. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/cartesia-tts/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/cartesia-tts/index.mdx new file mode 100644 index 0000000000..092f6e2626 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/cartesia-tts/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins/cartesia-tts" +title: "CartesiaTTS" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.plugins.CartesiaTTS" + parent: "signalwire.livewire.plugins" + module: "signalwire.livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `CartesiaTTS` + +Stub for livekit Cartesia TTS plugin. + +## Signature + +```python +class CartesiaTTS +``` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) + +Line 82. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/cartesia-tts/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/cartesia-tts/init.mdx new file mode 100644 index 0000000000..28803d65ab --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/cartesia-tts/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins/cartesia-tts/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.plugins.CartesiaTTS.__init__" + parent: "signalwire.livewire.plugins.CartesiaTTS" + module: "signalwire.livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `__init__` + +## Signature + +```python +__init__(**kwargs: Any = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) + +Line 85. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/deepgram-stt/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/deepgram-stt/index.mdx new file mode 100644 index 0000000000..61ecca131e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/deepgram-stt/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins/deepgram-stt" +title: "DeepgramSTT" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.plugins.DeepgramSTT" + parent: "signalwire.livewire.plugins" + module: "signalwire.livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `DeepgramSTT` + +Stub for livekit Deepgram STT plugin. + +## Signature + +```python +class DeepgramSTT +``` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) + +Line 49. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/deepgram-stt/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/deepgram-stt/init.mdx new file mode 100644 index 0000000000..2c346587de --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/deepgram-stt/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins/deepgram-stt/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.plugins.DeepgramSTT.__init__" + parent: "signalwire.livewire.plugins.DeepgramSTT" + module: "signalwire.livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `__init__` + +## Signature + +```python +__init__(**kwargs: Any = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) + +Line 52. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/eleven-labs-tts/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/eleven-labs-tts/index.mdx new file mode 100644 index 0000000000..79e6af9df9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/eleven-labs-tts/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins/eleven-labs-tts" +title: "ElevenLabsTTS" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.plugins.ElevenLabsTTS" + parent: "signalwire.livewire.plugins" + module: "signalwire.livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `ElevenLabsTTS` + +Stub for livekit ElevenLabs TTS plugin. + +## Signature + +```python +class ElevenLabsTTS +``` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) + +Line 94. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/eleven-labs-tts/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/eleven-labs-tts/init.mdx new file mode 100644 index 0000000000..69fccb6f20 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/eleven-labs-tts/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins/eleven-labs-tts/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.plugins.ElevenLabsTTS.__init__" + parent: "signalwire.livewire.plugins.ElevenLabsTTS" + module: "signalwire.livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `__init__` + +## Signature + +```python +__init__(**kwargs: Any = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) + +Line 97. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/index.mdx new file mode 100644 index 0000000000..e749a670ae --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins" +title: "plugins" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.livewire.plugins" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `plugins` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module plugins +``` + +## Classes + + + + Stub for livekit Cartesia TTS plugin. + + + + Stub for livekit Deepgram STT plugin. + + + + Stub for livekit ElevenLabs TTS plugin. + + + + Stub for livekit OpenAI LLM plugin. + + + + Stub for livekit Silero VAD plugin. + + + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/open-aillm/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/open-aillm/index.mdx new file mode 100644 index 0000000000..34d985027a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/open-aillm/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins/open-aillm" +title: "OpenAILLM" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.plugins.OpenAILLM" + parent: "signalwire.livewire.plugins" + module: "signalwire.livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `OpenAILLM` + +Stub for livekit OpenAI LLM plugin. + +## Signature + +```python +class OpenAILLM +``` + +## Properties + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) + +Line 65. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/open-aillm/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/open-aillm/init.mdx new file mode 100644 index 0000000000..c2728dda13 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/open-aillm/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins/open-aillm/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.plugins.OpenAILLM.__init__" + parent: "signalwire.livewire.plugins.OpenAILLM" + module: "signalwire.livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `__init__` + +## Signature + +```python +__init__(**kwargs: Any = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) + +Line 68. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/silero-vad/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/silero-vad/index.mdx new file mode 100644 index 0000000000..a6ddaef620 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/silero-vad/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins/silero-vad" +title: "SileroVAD" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.plugins.SileroVAD" + parent: "signalwire.livewire.plugins" + module: "signalwire.livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `SileroVAD` + +Stub for livekit Silero VAD plugin. + +## Signature + +```python +class SileroVAD +``` + +## Methods + + + + + + Mirrors the SileroVAD.load() factory. + + + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) + +Line 110. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/silero-vad/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/silero-vad/init.mdx new file mode 100644 index 0000000000..3eeccb485f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/silero-vad/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins/silero-vad/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.plugins.SileroVAD.__init__" + parent: "signalwire.livewire.plugins.SileroVAD" + module: "signalwire.livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `__init__` + +## Signature + +```python +__init__(**kwargs: Any = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) + +Line 113. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/plugins/silero-vad/load.mdx b/fern/products/sdk-reference/python/signalwire/livewire/plugins/silero-vad/load.mdx new file mode 100644 index 0000000000..5c04cc645d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/plugins/silero-vad/load.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/python/signalwire/livewire/plugins/silero-vad/load" +title: "load" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.plugins.SileroVAD.load" + parent: "signalwire.livewire.plugins.SileroVAD" + module: "signalwire.livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py" +--- +# `load` + +Mirrors the SileroVAD.load() factory. + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +load() +``` + +## Source + +[`signalwire/signalwire/livewire/plugins.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/plugins.py) + +Line 121. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/room/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/room/index.mdx new file mode 100644 index 0000000000..3d64c75d27 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/room/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/livewire/room" +title: "Room" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.Room" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `Room` + +Stub -- SignalWire doesn't use the LiveKit room abstraction. + +## Signature + +```python +class Room +``` + +## Properties + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 641. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/run-app.mdx b/fern/products/sdk-reference/python/signalwire/livewire/run-app.mdx new file mode 100644 index 0000000000..2c1d80b5e0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/run-app.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/livewire/run-app" +title: "run_app" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.livewire.run_app" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `run_app` + +Print banner, print a random tip, run the agent. + +This is the main entry point -- mirrors `livekit.agents.cli.run_app`. + +## Signature + +```python +run_app(server: AgentServer) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 799. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/run-context/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/run-context/index.mdx new file mode 100644 index 0000000000..f9077e34c7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/run-context/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/livewire/run-context" +title: "RunContext" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.RunContext" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `RunContext` + +Mirrors livekit RunContext -- available inside tool handlers. + +## Signature + +```python +class RunContext +``` + +## Properties + + + + + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 252. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/run-context/init.mdx b/fern/products/sdk-reference/python/signalwire/livewire/run-context/init.mdx new file mode 100644 index 0000000000..846559154a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/run-context/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/livewire/run-context/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.livewire.RunContext.__init__" + parent: "signalwire.livewire.RunContext" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__(session = None, *, speech_handle = None, function_call = None) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 255. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/stop-response/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/stop-response/index.mdx new file mode 100644 index 0000000000..ab42b1d085 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/stop-response/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/livewire/stop-response" +title: "StopResponse" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.StopResponse" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `StopResponse` + +Signals that a tool should not trigger another LLM reply. + +## Signature + +```python +class StopResponse(Exception) +``` + +## Inheritance + +**Extends:** `Exception` + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 140. diff --git a/fern/products/sdk-reference/python/signalwire/livewire/tool-error/index.mdx b/fern/products/sdk-reference/python/signalwire/livewire/tool-error/index.mdx new file mode 100644 index 0000000000..c659793062 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/livewire/tool-error/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/livewire/tool-error" +title: "ToolError" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.livewire.ToolError" + parent: "signalwire.livewire" + module: "signalwire.livewire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py" +--- +# `ToolError` + +Signals a tool execution error. + +## Signature + +```python +class ToolError(Exception) +``` + +## Inheritance + +**Extends:** `Exception` + +## Source + +[`signalwire/signalwire/livewire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/livewire/__init__.py) + +Line 145. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/index.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/index.mdx new file mode 100644 index 0000000000..19f6171e78 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/gateway-service" +title: "gateway_service" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.mcp_gateway.gateway_service" + parent: "signalwire.mcp_gateway" + module: "signalwire.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py" +--- +# `gateway_service` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module gateway_service +``` + +## Properties + + + +## Functions + + + + Main entry point + + + +## Classes + + + + Main gateway service class + + + +## Source + +[`signalwire/signalwire/mcp_gateway/gateway_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py) diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/main.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/main.mdx new file mode 100644 index 0000000000..51a6df8693 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/main.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/gateway-service/main" +title: "main" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.mcp_gateway.gateway_service.main" + parent: "signalwire.mcp_gateway.gateway_service" + module: "signalwire.mcp_gateway.gateway_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py" +--- +# `main` + +Main entry point + +## Signature + +```python +main() +``` + +## Source + +[`signalwire/signalwire/mcp_gateway/gateway_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py) + +Line 557. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/index.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/index.mdx new file mode 100644 index 0000000000..c6e8b36d99 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway" +title: "MCPGateway" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.mcp_gateway.gateway_service.MCPGateway" + parent: "signalwire.mcp_gateway.gateway_service" + module: "signalwire.mcp_gateway.gateway_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py" +--- +# `MCPGateway` + +Main gateway service class + +## Signature + +```python +class MCPGateway +``` + +## Properties + + + + + + + + + + + + + + + + + + + +## Methods + + + + + + Run the gateway service + + + + Shutdown the gateway service + + + +## Source + +[`signalwire/signalwire/mcp_gateway/gateway_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py) + +Line 52. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/init.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/init.mdx new file mode 100644 index 0000000000..c3c44bc8cc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.gateway_service.MCPGateway.__init__" + parent: "signalwire.mcp_gateway.gateway_service.MCPGateway" + module: "signalwire.mcp_gateway.gateway_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py" +--- +# `__init__` + +## Signature + +```python +__init__(config_path: str = 'config.json') +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/mcp_gateway/gateway_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py) + +Line 55. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/run.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/run.mdx new file mode 100644 index 0000000000..a2b77d4ce1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/run.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/run" +title: "run" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.gateway_service.MCPGateway.run" + parent: "signalwire.mcp_gateway.gateway_service.MCPGateway" + module: "signalwire.mcp_gateway.gateway_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py" +--- +# `run` + +Run the gateway service + +## Signature + +```python +run() +``` + +## Source + +[`signalwire/signalwire/mcp_gateway/gateway_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py) + +Line 478. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/set-security-headers.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/set-security-headers.mdx new file mode 100644 index 0000000000..f3cbf656ab --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/set-security-headers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/set-security-headers" +title: "set_security_headers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.mcp_gateway.gateway_service.MCPGateway.__init__.set_security_headers" + parent: "signalwire.mcp_gateway.gateway_service.MCPGateway.__init__" + module: "signalwire.mcp_gateway.gateway_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py" +--- +# `set_security_headers` + +**Decorators:** `@self.app.after_request` + +## Signature + +```python +set_security_headers(response) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/mcp_gateway/gateway_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py) + +Line 92. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/shutdown.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/shutdown.mdx new file mode 100644 index 0000000000..081b83fdf7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/shutdown.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/gateway-service/mcp-gateway/shutdown" +title: "shutdown" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.gateway_service.MCPGateway.shutdown" + parent: "signalwire.mcp_gateway.gateway_service.MCPGateway" + module: "signalwire.mcp_gateway.gateway_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py" +--- +# `shutdown` + +Shutdown the gateway service + +## Signature + +```python +shutdown() +``` + +## Source + +[`signalwire/signalwire/mcp_gateway/gateway_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/gateway_service.py) + +Line 520. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/index.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/index.mdx new file mode 100644 index 0000000000..e535cd5881 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway" +title: "mcp_gateway" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.mcp_gateway" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/__init__.py" +--- +# `mcp_gateway` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module mcp_gateway +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/mcp_gateway/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/index.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/index.mdx new file mode 100644 index 0000000000..6836ed40be --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager" +title: "mcp_manager" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager" + parent: "signalwire.mcp_gateway" + module: "signalwire.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `mcp_manager` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module mcp_manager +``` + +## Properties + + + +## Classes + + + + Client for communicating with a single MCP server process + + + + Manages multiple MCP services and their lifecycles + + + + Configuration for an MCP service + + + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/call-method.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/call-method.mdx new file mode 100644 index 0000000000..ebe1cbcbda --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/call-method.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/call-method" +title: "call_method" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPClient.call_method" + parent: "signalwire.mcp_gateway.mcp_manager.MCPClient" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `call_method` + +Call an RPC method and wait for response + +## Signature + +```python +call_method(method: str, params: Dict[str, Any]) -> Any +``` + +## Parameters + + + + + +## Returns + +`Any` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 282. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/call-tool.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/call-tool.mdx new file mode 100644 index 0000000000..9d0403dc47 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/call-tool.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/call-tool" +title: "call_tool" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPClient.call_tool" + parent: "signalwire.mcp_gateway.mcp_manager.MCPClient" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `call_tool` + +Call a tool on the MCP server + +## Signature + +```python +call_tool(tool_name: str, arguments: Dict[str, Any]) -> Dict[str, Any] +``` + +## Parameters + + + + + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 275. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/get-tools.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/get-tools.mdx new file mode 100644 index 0000000000..a250db1174 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/get-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/get-tools" +title: "get_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPClient.get_tools" + parent: "signalwire.mcp_gateway.mcp_manager.MCPClient" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `get_tools` + +Get the list of available tools + +## Signature + +```python +get_tools() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 321. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/index.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/index.mdx new file mode 100644 index 0000000000..86907a1ce4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client" +title: "MCPClient" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPClient" + parent: "signalwire.mcp_gateway.mcp_manager" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `MCPClient` + +Client for communicating with a single MCP server process + +## Signature + +```python +class MCPClient +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + + Call an RPC method and wait for response + + + + Call a tool on the MCP server + + + + Get the list of available tools + + + + Start the MCP server process and initialize connection + + + + Stop the MCP server process and clean up sandbox + + + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 59. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/init.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/init.mdx new file mode 100644 index 0000000000..678ad9a867 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPClient.__init__" + parent: "signalwire.mcp_gateway.mcp_manager.MCPClient" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `__init__` + +## Signature + +```python +__init__(service: MCPService, sandbox_base_dir: str = './sandbox') +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 62. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/start.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/start.mdx new file mode 100644 index 0000000000..8545d8e703 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/start.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/start" +title: "start" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPClient.start" + parent: "signalwire.mcp_gateway.mcp_manager.MCPClient" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `start` + +Start the MCP server process and initialize connection + +## Signature + +```python +start() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 163. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/stop.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/stop.mdx new file mode 100644 index 0000000000..b0628a78a8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/stop.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-client/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPClient.stop" + parent: "signalwire.mcp_gateway.mcp_manager.MCPClient" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `stop` + +Stop the MCP server process and clean up sandbox + +## Signature + +```python +stop() +``` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 213. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/create-client.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/create-client.mdx new file mode 100644 index 0000000000..8ddf4ef0dd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/create-client.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/create-client" +title: "create_client" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPManager.create_client" + parent: "signalwire.mcp_gateway.mcp_manager.MCPManager" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `create_client` + +Create a new MCP client for a service + +## Signature + +```python +create_client(service_name: str) -> MCPClient +``` + +## Parameters + + + +## Returns + +`MCPClient` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 465. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/get-service-tools.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/get-service-tools.mdx new file mode 100644 index 0000000000..82c4023717 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/get-service-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/get-service-tools" +title: "get_service_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPManager.get_service_tools" + parent: "signalwire.mcp_gateway.mcp_manager.MCPManager" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `get_service_tools` + +Get tools for a service by starting a temporary instance + +## Signature + +```python +get_service_tools(service_name: str) -> List[Dict[str, Any]] +``` + +## Parameters + + + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 484. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/get-service.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/get-service.mdx new file mode 100644 index 0000000000..2373520d6d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/get-service.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/get-service" +title: "get_service" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPManager.get_service" + parent: "signalwire.mcp_gateway.mcp_manager.MCPManager" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `get_service` + +Get a service definition by name + +## Signature + +```python +get_service(service_name: str) -> Optional[MCPService] +``` + +## Parameters + + + +## Returns + +`Optional[MCPService]` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 448. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/index.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/index.mdx new file mode 100644 index 0000000000..7da9625119 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager" +title: "MCPManager" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPManager" + parent: "signalwire.mcp_gateway.mcp_manager" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `MCPManager` + +Manages multiple MCP services and their lifecycles + +## Signature + +```python +class MCPManager +``` + +## Properties + + + + + + + + + +## Methods + + + + + + Create a new MCP client for a service + + + + Get a service definition by name + + + + Get tools for a service by starting a temporary instance + + + + List all available services + + + + Shutdown all active MCP clients + + + + Validate that all services can be started + + + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 409. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/init.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/init.mdx new file mode 100644 index 0000000000..2fe88c391a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPManager.__init__" + parent: "signalwire.mcp_gateway.mcp_manager.MCPManager" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `__init__` + +## Signature + +```python +__init__(config: Dict[str, Any]) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 412. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/list-services.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/list-services.mdx new file mode 100644 index 0000000000..0103d06e2d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/list-services.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/list-services" +title: "list_services" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPManager.list_services" + parent: "signalwire.mcp_gateway.mcp_manager.MCPManager" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `list_services` + +List all available services + +## Signature + +```python +list_services() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 452. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/shutdown.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/shutdown.mdx new file mode 100644 index 0000000000..bd7b139d1a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/shutdown.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/shutdown" +title: "shutdown" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPManager.shutdown" + parent: "signalwire.mcp_gateway.mcp_manager.MCPManager" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `shutdown` + +Shutdown all active MCP clients + +## Signature + +```python +shutdown() +``` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 519. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/validate-services.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/validate-services.mdx new file mode 100644 index 0000000000..1792c974d5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/validate-services.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-manager/validate-services" +title: "validate_services" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPManager.validate_services" + parent: "signalwire.mcp_gateway.mcp_manager.MCPManager" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `validate_services` + +Validate that all services can be started + +## Signature + +```python +validate_services() -> Dict[str, bool] +``` + +## Returns + +`Dict[str, bool]` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 499. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/hash.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/hash.mdx new file mode 100644 index 0000000000..ab8c567eb3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/hash.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/hash" +title: "__hash__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPService.__hash__" + parent: "signalwire.mcp_gateway.mcp_manager.MCPService" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `__hash__` + +## Signature + +```python +__hash__() +``` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 55. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/index.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/index.mdx new file mode 100644 index 0000000000..202e12fb44 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service" +title: "MCPService" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPService" + parent: "signalwire.mcp_gateway.mcp_manager" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `MCPService` + +Configuration for an MCP service + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class MCPService +``` + +## Properties + + + + + + + + + + + +## Methods + + + + + + + + + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 37. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/init.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/init.mdx new file mode 100644 index 0000000000..4e5b2795d3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/init.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPService.__init__" + parent: "signalwire.mcp_gateway.mcp_manager.MCPService" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `__init__` + +## Signature + +```python +__init__( + name: str, + command: List[str], + description: str, + enabled: bool = True, + sandbox_config: Dict[str, Any] = None +) -> None +``` + +## Parameters + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/post-init.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/post-init.mdx new file mode 100644 index 0000000000..0600b90322 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/post-init.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/mcp-manager/mcp-service/post-init" +title: "__post_init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.mcp_manager.MCPService.__post_init__" + parent: "signalwire.mcp_gateway.mcp_manager.MCPService" + module: "signalwire.mcp_gateway.mcp_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py" +--- +# `__post_init__` + +## Signature + +```python +__post_init__() +``` + +## Source + +[`signalwire/signalwire/mcp_gateway/mcp_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/mcp_manager.py) + +Line 46. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/index.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/index.mdx new file mode 100644 index 0000000000..4743acc3c2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager" +title: "session_manager" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager" + parent: "signalwire.mcp_gateway" + module: "signalwire.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `session_manager` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module session_manager +``` + +## Properties + + + +## Classes + + + + Represents an active MCP session + + + + Manages MCP server sessions with automatic cleanup + + + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/close-session.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/close-session.mdx new file mode 100644 index 0000000000..e71f2ade94 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/close-session.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager/session-manager/close-session" +title: "close_session" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager.SessionManager.close_session" + parent: "signalwire.mcp_gateway.session_manager.SessionManager" + module: "signalwire.mcp_gateway.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `close_session` + +Close and remove a session + +## Signature + +```python +close_session(session_id: str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) + +Line 126. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/create-session.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/create-session.mdx new file mode 100644 index 0000000000..66124f7db3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/create-session.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager/session-manager/create-session" +title: "create_session" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager.SessionManager.create_session" + parent: "signalwire.mcp_gateway.session_manager.SessionManager" + module: "signalwire.mcp_gateway.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `create_session` + +Create and register a new session + +## Signature + +```python +create_session( + session_id: str, + service_name: str, + process: Any, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, Any]] = None +) -> Session +``` + +## Parameters + + + + + + + + + + + +## Returns + +`Session` + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) + +Line 73. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/get-service-session-count.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/get-service-session-count.mdx new file mode 100644 index 0000000000..19ab120862 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/get-service-session-count.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager/session-manager/get-service-session-count" +title: "get_service_session_count" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager.SessionManager.get_service_session_count" + parent: "signalwire.mcp_gateway.session_manager.SessionManager" + module: "signalwire.mcp_gateway.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `get_service_session_count` + +Get number of active sessions for a service + +## Signature + +```python +get_service_session_count(service_name: str) -> int +``` + +## Parameters + + + +## Returns + +`int` + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) + +Line 168. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/get-session.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/get-session.mdx new file mode 100644 index 0000000000..45e01c2a72 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/get-session.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager/session-manager/get-session" +title: "get_session" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager.SessionManager.get_session" + parent: "signalwire.mcp_gateway.session_manager.SessionManager" + module: "signalwire.mcp_gateway.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `get_session` + +Get an active session by ID + +## Signature + +```python +get_session(session_id: str) -> Optional[Session] +``` + +## Parameters + + + +## Returns + +`Optional[Session]` + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) + +Line 105. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/index.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/index.mdx new file mode 100644 index 0000000000..c94ec9e5a6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager/session-manager" +title: "SessionManager" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager.SessionManager" + parent: "signalwire.mcp_gateway.session_manager" + module: "signalwire.mcp_gateway.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `SessionManager` + +Manages MCP server sessions with automatic cleanup + +## Signature + +```python +class SessionManager +``` + +## Properties + + + + + + + + + + + + + + + + + +## Methods + + + + + + Close and remove a session + + + + Create and register a new session + + + + Get number of active sessions for a service + + + + Get an active session by ID + + + + List all active sessions with their info + + + + Shutdown all sessions and cleanup + + + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) + +Line 54. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/init.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/init.mdx new file mode 100644 index 0000000000..d6d678c315 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager/session-manager/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager.SessionManager.__init__" + parent: "signalwire.mcp_gateway.session_manager.SessionManager" + module: "signalwire.mcp_gateway.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `__init__` + +## Signature + +```python +__init__(config: Dict[str, Any], max_total_sessions: int = 500) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) + +Line 57. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/list-sessions.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/list-sessions.mdx new file mode 100644 index 0000000000..88c830c6b9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/list-sessions.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager/session-manager/list-sessions" +title: "list_sessions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager.SessionManager.list_sessions" + parent: "signalwire.mcp_gateway.session_manager.SessionManager" + module: "signalwire.mcp_gateway.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `list_sessions` + +List all active sessions with their info + +## Signature + +```python +list_sessions() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) + +Line 146. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/shutdown.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/shutdown.mdx new file mode 100644 index 0000000000..a4f8d8f56c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session-manager/shutdown.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager/session-manager/shutdown" +title: "shutdown" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager.SessionManager.shutdown" + parent: "signalwire.mcp_gateway.session_manager.SessionManager" + module: "signalwire.mcp_gateway.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `shutdown` + +Shutdown all sessions and cleanup + +## Signature + +```python +shutdown() +``` + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) + +Line 203. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session/index.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session/index.mdx new file mode 100644 index 0000000000..f7b68c4199 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager/session" +title: "Session" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager.Session" + parent: "signalwire.mcp_gateway.session_manager" + module: "signalwire.mcp_gateway.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `Session` + +Represents an active MCP session + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class Session +``` + +## Properties + + + + + Check if the underlying MCP client is still running + + + + Check if session has expired based on timeout + + + + + + + + + + + + + + +## Methods + + + + + + Update last accessed time + + + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) + +Line 28. diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session/init.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session/init.mdx new file mode 100644 index 0000000000..d430b4e0d9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session/init.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager/session/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager.Session.__init__" + parent: "signalwire.mcp_gateway.session_manager.Session" + module: "signalwire.mcp_gateway.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `__init__` + +## Signature + +```python +__init__( + session_id: str, + service_name: str, + process: Any, + created_at: datetime = datetime.now(), + last_accessed: datetime = datetime.now(), + timeout: int = 300, + metadata: Dict[str, Any] = dict() +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) diff --git a/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session/touch.mdx b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session/touch.mdx new file mode 100644 index 0000000000..2a742e8df9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/mcp-gateway/session-manager/session/touch.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/mcp-gateway/session-manager/session/touch" +title: "touch" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.mcp_gateway.session_manager.Session.touch" + parent: "signalwire.mcp_gateway.session_manager.Session" + module: "signalwire.mcp_gateway.session_manager" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py" +--- +# `touch` + +Update last accessed time + +## Signature + +```python +touch() +``` + +## Source + +[`signalwire/signalwire/mcp_gateway/session_manager.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/mcp_gateway/session_manager.py) + +Line 49. diff --git a/fern/products/sdk-reference/python/signalwire/pom/index.mdx b/fern/products/sdk-reference/python/signalwire/pom/index.mdx new file mode 100644 index 0000000000..61955e77f0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/pom" +title: "pom" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.pom" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/__init__.py" +--- +# `pom` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module pom +``` + +## Properties + + + +## Modules + + + + + + POM Tool - Command line utility for working with Prompt Object Model files + + + +## Source + +[`signalwire/signalwire/pom/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom-tool/detect-file-format.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom-tool/detect-file-format.mdx new file mode 100644 index 0000000000..be9480408c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom-tool/detect-file-format.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/pom/pom-tool/detect-file-format" +title: "detect_file_format" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.pom.pom_tool.detect_file_format" + parent: "signalwire.pom.pom_tool" + module: "signalwire.pom.pom_tool" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom_tool.py" +--- +# `detect_file_format` + +Detect if the file is JSON or YAML based on extension and content. + +## Signature + +```python +detect_file_format(file_path) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/pom/pom_tool.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom_tool.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom-tool/index.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom-tool/index.mdx new file mode 100644 index 0000000000..def9db8230 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom-tool/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/pom/pom-tool" +title: "pom_tool" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.pom.pom_tool" + parent: "signalwire.pom" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom_tool.py" +--- +# `pom_tool` + +POM Tool - Command line utility for working with Prompt Object Model files + +> \[!NOTE] +> pom\_tool \ \[--output=<format>] \[--outfile=<file>] \[--merge\_pom="<section name>:<filename>"] +> pom\_tool (-h | --help) + +> \[!NOTE] +> -h --help Show this help message +> \--output=<format> Output format: md, xml, json, yaml \[default: md] +> \--outfile=<file> Output file (if not specified, prints to stdout) +> \--merge\_pom=<arg> Merge another POM into a section: "<section name>:<filename>" + +## Signature + +```python +module pom_tool +``` + +## Functions + + + + Detect if the file is JSON or YAML based on extension and content. + + + + Load a POM from a file, auto-detecting the format. + + + + Main entry point for the POM tool. + + + + Render the POM in the specified format. + + + +## Source + +[`signalwire/signalwire/pom/pom_tool.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom_tool.py) diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom-tool/load-pom.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom-tool/load-pom.mdx new file mode 100644 index 0000000000..85b8490266 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom-tool/load-pom.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/pom/pom-tool/load-pom" +title: "load_pom" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.pom.pom_tool.load_pom" + parent: "signalwire.pom.pom_tool" + module: "signalwire.pom.pom_tool" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom_tool.py" +--- +# `load_pom` + +Load a POM from a file, auto-detecting the format. + +## Signature + +```python +load_pom(file_path) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/pom/pom_tool.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom_tool.py) + +Line 55. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom-tool/main.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom-tool/main.mdx new file mode 100644 index 0000000000..c4a6bd0ac6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom-tool/main.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/pom/pom-tool/main" +title: "main" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.pom.pom_tool.main" + parent: "signalwire.pom.pom_tool" + module: "signalwire.pom.pom_tool" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom_tool.py" +--- +# `main` + +Main entry point for the POM tool. + +## Signature + +```python +main() +``` + +## Source + +[`signalwire/signalwire/pom/pom_tool.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom_tool.py) + +Line 80. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom-tool/render-pom.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom-tool/render-pom.mdx new file mode 100644 index 0000000000..f721c9ef2f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom-tool/render-pom.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/pom/pom-tool/render-pom" +title: "render_pom" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.pom.pom_tool.render_pom" + parent: "signalwire.pom.pom_tool" + module: "signalwire.pom.pom_tool" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom_tool.py" +--- +# `render_pom` + +Render the POM in the specified format. + +## Signature + +```python +render_pom(pom, output_format) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/pom/pom_tool.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom_tool.py) + +Line 67. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/index.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/index.mdx new file mode 100644 index 0000000000..906813ef5a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/pom/pom" +title: "pom" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.pom.pom" + parent: "signalwire.pom" + module: "signalwire.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `pom` + +## Signature + +```python +module pom +``` + +## Classes + + + + A structured data format for composing, organizing, and rendering prompt instructions for large language models. + + + + Represents a section in the Prompt Object Model. + + + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/add-pom-as-subsection.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/add-pom-as-subsection.mdx new file mode 100644 index 0000000000..9f09eb38e1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/add-pom-as-subsection.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model/add-pom-as-subsection" +title: "add_pom_as_subsection" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel.add_pom_as_subsection" + parent: "signalwire.pom.pom.PromptObjectModel" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `add_pom_as_subsection` + +Add another PromptObjectModel as a subsection to a section with the given title or section object. + +## Signature + +```python +add_pom_as_subsection( + target: Union[str, Section], + pom_to_add: PromptObjectModel +) +``` + +## Parameters + + + The title of the section or the Section object to which the POM should be added as a subsection. + + + + The PromptObjectModel to add as a subsection. + + +## Throws + +- `ValueError` — If no section with the target title is found (when target is a string). + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 519. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/add-section.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/add-section.mdx new file mode 100644 index 0000000000..68862b0c56 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/add-section.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model/add-section" +title: "add_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel.add_section" + parent: "signalwire.pom.pom.PromptObjectModel" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `add_section` + +Add a top-level section to the model. + +## Signature + +```python +add_section( + title: Optional[str] = None, + *, + body: str = '', + bullets: Optional[Union[List[str], str]] = None, + numbered: Optional[bool] = None, + numberedBullets: bool = False +) -> Section +``` + +## Parameters + + + The title of the section + + + + Optional body text for the section + + + + Optional list of bullet points or a single string + + + + Whether this section should be numbered + + + + Whether bullets should be numbered + + +## Returns + +`Section` — The newly created Section object + +## Throws + +- `ValueError` — If a section without a title is added after the first section + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 363. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/find-section.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/find-section.mdx new file mode 100644 index 0000000000..2241069d3f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/find-section.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model/find-section" +title: "find_section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel.find_section" + parent: "signalwire.pom.pom.PromptObjectModel" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `find_section` + +Find a section by its title. + +Performs a recursive search through all sections and subsections. + +## Signature + +```python +find_section(title: str) -> Optional[Section] +``` + +## Parameters + + + The title to search for + + +## Returns + +`Optional[Section]` — The Section object if found, None otherwise + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 397. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/from-json.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/from-json.mdx new file mode 100644 index 0000000000..8bb604a1b1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/from-json.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model/from-json" +title: "from_json" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel.from_json" + parent: "signalwire.pom.pom.PromptObjectModel" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `from_json` + +Create a PromptObjectModel instance from JSON data. + +**Modifiers:** `static` + +## Signature + +```python +@staticmethod +from_json(json_data: Union[str, dict]) -> PromptObjectModel +``` + +## Parameters + + + Either a JSON string or a parsed dictionary + + +## Returns + +`PromptObjectModel` — A new PromptObjectModel populated with the data from the JSON + +## Throws + +- `ValueError` — If the JSON is not properly formatted + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 247. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/from-yaml.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/from-yaml.mdx new file mode 100644 index 0000000000..3efd82aa6e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/from-yaml.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model/from-yaml" +title: "from_yaml" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel.from_yaml" + parent: "signalwire.pom.pom.PromptObjectModel" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `from_yaml` + +Create a PromptObjectModel instance from YAML data. + +**Modifiers:** `static` + +## Signature + +```python +@staticmethod +from_yaml(yaml_data: Union[str, dict]) -> PromptObjectModel +``` + +## Parameters + + + Either a YAML string or a parsed dictionary + + +## Returns + +`PromptObjectModel` — A new PromptObjectModel populated with the data from the YAML + +## Throws + +- `ValueError` — If the YAML is not properly formatted + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 268. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/index.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/index.mdx new file mode 100644 index 0000000000..9b033391c6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/index.mdx @@ -0,0 +1,90 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model" +title: "PromptObjectModel" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel" + parent: "signalwire.pom.pom" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `PromptObjectModel` + +A structured data format for composing, organizing, and rendering prompt +instructions for large language models. + +The Prompt Object Model provides a tree-based representation of a prompt +document composed of nested sections, each of which can include a title, +body text, bullet points, and arbitrarily nested subsections. + +This class supports both machine-readability (via JSON/YAML) and structured +rendering (via Markdown/XML), making it ideal for prompt templating, modular +editing, and traceable documentation. + +## Signature + +```python +class PromptObjectModel +``` + +## Properties + + + + + +## Methods + + + + + + Add another PromptObjectModel as a subsection to a section with the given title or section object. + + + + Add a top-level section to the model. + + + + Find a section by its title. + + + + Create a PromptObjectModel instance from JSON data. + + + + Create a PromptObjectModel instance from YAML data. + + + + Render the entire model as markdown. + + + + Render the entire model as XML. + + + + Convert the entire model to a list of dictionaries. + + + + Convert the entire model to a JSON string. + + + + Convert the entire model to a YAML string. + + + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 234. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/init.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/init.mdx new file mode 100644 index 0000000000..5f9cc509d4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel.__init__" + parent: "signalwire.pom.pom.PromptObjectModel" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `__init__` + +## Signature + +```python +__init__(debug: bool = False) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 359. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/render-markdown.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/render-markdown.mdx new file mode 100644 index 0000000000..b26d17c11e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/render-markdown.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model/render-markdown" +title: "render_markdown" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel.render_markdown" + parent: "signalwire.pom.pom.PromptObjectModel" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `render_markdown` + +Render the entire model as markdown. + +## Signature + +```python +render_markdown() -> str +``` + +## Returns + +`str` — A string containing the markdown representation + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 448. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/render-xml.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/render-xml.mdx new file mode 100644 index 0000000000..0b37d3ce96 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/render-xml.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model/render-xml" +title: "render_xml" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel.render_xml" + parent: "signalwire.pom.pom.PromptObjectModel" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `render_xml` + +Render the entire model as XML. + +## Signature + +```python +render_xml() -> str +``` + +## Returns + +`str` — A string containing the XML representation + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 488. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/to-dict.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/to-dict.mdx new file mode 100644 index 0000000000..2bfee93b19 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model/to-dict" +title: "to_dict" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel.to_dict" + parent: "signalwire.pom.pom.PromptObjectModel" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `to_dict` + +Convert the entire model to a list of dictionaries. + +## Signature + +```python +to_dict() -> List[dict] +``` + +## Returns + +`List[dict]` — A list of dictionaries representing the model + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 439. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/to-json.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/to-json.mdx new file mode 100644 index 0000000000..af10b6ac6f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/to-json.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model/to-json" +title: "to_json" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel.to_json" + parent: "signalwire.pom.pom.PromptObjectModel" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `to_json` + +Convert the entire model to a JSON string. + +## Signature + +```python +to_json() -> str +``` + +## Returns + +`str` — A JSON string representation of the model + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 419. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/to-yaml.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/to-yaml.mdx new file mode 100644 index 0000000000..3f96ef15f2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/prompt-object-model/to-yaml.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/pom/pom/prompt-object-model/to-yaml" +title: "to_yaml" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.PromptObjectModel.to_yaml" + parent: "signalwire.pom.pom.PromptObjectModel" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `to_yaml` + +Convert the entire model to a YAML string. + +## Signature + +```python +to_yaml() -> str +``` + +## Returns + +`str` — A YAML string representation of the model + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 428. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/section/add-body.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/section/add-body.mdx new file mode 100644 index 0000000000..8f36b91068 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/section/add-body.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/pom/pom/section/add-body" +title: "add_body" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.Section.add_body" + parent: "signalwire.pom.pom.Section" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `add_body` + +Add or replace the body text for this section. + +## Signature + +```python +add_body(body: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 39. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/section/add-bullets.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/section/add-bullets.mdx new file mode 100644 index 0000000000..fc11b2debd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/section/add-bullets.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/pom/pom/section/add-bullets" +title: "add_bullets" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.Section.add_bullets" + parent: "signalwire.pom.pom.Section" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `add_bullets` + +Add bullet points to this section. + +## Signature + +```python +add_bullets(bullets: List[str]) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 45. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/section/add-subsection.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/section/add-subsection.mdx new file mode 100644 index 0000000000..4847d3dbc0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/section/add-subsection.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/python/signalwire/pom/pom/section/add-subsection" +title: "add_subsection" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.Section.add_subsection" + parent: "signalwire.pom.pom.Section" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `add_subsection` + +Add a subsection to this section. + +## Signature + +```python +add_subsection( + title: str, + *, + body: str = '', + bullets: Optional[List[str]] = None, + numbered: bool = False, + numberedBullets: bool = False +) -> Section +``` + +## Parameters + + + The title of the subsection + + + + Optional body text for the subsection + + + + Optional list of bullet points + + + + Whether this section should be numbered + + + + Whether bullets should be numbered + + +## Returns + +`Section` — The newly created Section object + +## Throws + +- `ValueError` — If the title is None or if the section has neither a body nor bullets + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 51. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/section/index.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/section/index.mdx new file mode 100644 index 0000000000..bfb31fd837 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/section/index.mdx @@ -0,0 +1,88 @@ +--- +slug: "/reference/python/signalwire/pom/pom/section" +title: "Section" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.pom.pom.Section" + parent: "signalwire.pom.pom" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `Section` + +Represents a section in the Prompt Object Model. + +Each section contains a title, optional body text, optional bullet points, +and can have any number of nested subsections. + +## Signature + +```python +class Section +``` + +## Properties + + + A paragraph of text associated with the section. + + + + Bullet-pointed items. + + + + Whether this section should be numbered. + + + + Whether bullets should be numbered instead of using bullet points. + + + + Nested sections with the same structure. + + + + The name of the section. + + +## Methods + + + + + + Add or replace the body text for this section. + + + + Add bullet points to this section. + + + + Add a subsection to this section. + + + + Render this section and all its subsections as markdown. + + + + Render this section and all its subsections as XML. + + + + Convert the section to a dictionary representation. + + + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 5. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/section/init.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/section/init.mdx new file mode 100644 index 0000000000..54b2e48758 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/section/init.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/pom/pom/section/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.Section.__init__" + parent: "signalwire.pom.pom.Section" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `__init__` + +## Signature + +```python +__init__( + title: Optional[str] = None, + *, + body: str = '', + bullets: Optional[List[str]] = None, + numbered: Optional[bool] = None, + numberedBullets: bool = False +) +``` + +## Parameters + + + + + + + + + + + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/section/render-markdown.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/section/render-markdown.mdx new file mode 100644 index 0000000000..5deeb6cb0a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/section/render-markdown.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/pom/pom/section/render-markdown" +title: "render_markdown" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.Section.render_markdown" + parent: "signalwire.pom.pom.Section" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `render_markdown` + +Render this section and all its subsections as markdown. + +## Signature + +```python +render_markdown( + level: int = 2, + section_number: Optional[List[int]] = None +) -> str +``` + +## Parameters + + + The heading level to start with (default: 2, which corresponds to ##) + + + + The current section number for numbered sections + + +## Returns + +`str` — A string containing the markdown representation + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 103. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/section/render-xml.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/section/render-xml.mdx new file mode 100644 index 0000000000..9f69a74da8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/section/render-xml.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/pom/pom/section/render-xml" +title: "render_xml" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.Section.render_xml" + parent: "signalwire.pom.pom.Section" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `render_xml` + +Render this section and all its subsections as XML. + +## Signature + +```python +render_xml(indent: int = 0, section_number: Optional[List[int]] = None) -> str +``` + +## Parameters + + + The indentation level to start with (default: 0) + + + + The current section number for numbered sections + + +## Returns + +`str` — A string containing the XML representation + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 164. diff --git a/fern/products/sdk-reference/python/signalwire/pom/pom/section/to-dict.mdx b/fern/products/sdk-reference/python/signalwire/pom/pom/section/to-dict.mdx new file mode 100644 index 0000000000..2ed7013f97 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/pom/pom/section/to-dict.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/pom/pom/section/to-dict" +title: "to_dict" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.pom.pom.Section.to_dict" + parent: "signalwire.pom.pom.Section" + module: "signalwire.pom.pom" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py" +--- +# `to_dict` + +Convert the section to a dictionary representation. + +## Signature + +```python +to_dict() +``` + +## Source + +[`signalwire/signalwire/pom/pom.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/pom/pom.py) + +Line 79. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/check-availability.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/check-availability.mdx new file mode 100644 index 0000000000..3fab648b22 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/check-availability.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/prefabs/concierge/concierge-agent/check-availability" +title: "check_availability" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.concierge.ConciergeAgent.check_availability" + parent: "signalwire.prefabs.concierge.ConciergeAgent" + module: "signalwire.prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py" +--- +# `check_availability` + +Check availability for a service on a specific date and time + +This is a simulated function that would typically connect to a real booking system. +In this example, it returns a mock availability response. + +**Decorators:** `@AgentBase.tool(Any, Any, Any)` + +## Signature + +```python +check_availability(args, raw_data) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/prefabs/concierge.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py) + +Line 184. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/get-directions.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/get-directions.mdx new file mode 100644 index 0000000000..3dca273245 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/get-directions.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/prefabs/concierge/concierge-agent/get-directions" +title: "get_directions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.concierge.ConciergeAgent.get_directions" + parent: "signalwire.prefabs.concierge.ConciergeAgent" + module: "signalwire.prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py" +--- +# `get_directions` + +Provide directions to a specific location or amenity + +**Decorators:** `@AgentBase.tool(Any, Any, Any)` + +## Signature + +```python +get_directions(args, raw_data) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/prefabs/concierge.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py) + +Line 226. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/index.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/index.mdx new file mode 100644 index 0000000000..8cfcada48e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/python/signalwire/prefabs/concierge/concierge-agent" +title: "ConciergeAgent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.prefabs.concierge.ConciergeAgent" + parent: "signalwire.prefabs.concierge" + module: "signalwire.prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py" +--- +# `ConciergeAgent` + +A prefab agent designed to act as a virtual concierge, providing information +and services to users. + +This agent will: + +1. Welcome users and explain available services +2. Answer questions about amenities, hours, and directions +3. Help with bookings and reservations +4. Provide personalized recommendations + +> \[!NOTE] +> agent = ConciergeAgent( +> venue\_name="Grand Hotel", +> services=\["room service", "spa bookings", "restaurant reservations"], +> amenities=\{ +> "pool": \{"hours": "7 AM - 10 PM", "location": "2nd Floor"\}, +> "gym": \{"hours": "24 hours", "location": "3rd Floor"\} +> \} +> ) + +## Signature + +```python +class ConciergeAgent(AgentBase) +``` + +## Inheritance + +**Extends:** [AgentBase](/reference/python/signalwire/core/agent-base/agent-base) + +## Properties + + + + + + + + + + + +## Methods + + + + Initialize a concierge agent + + + + Check availability for a service on a specific date and time + + + + Provide directions to a specific location or amenity + + + + Process the interaction summary + + + +## Source + +[`signalwire/signalwire/prefabs/concierge.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/init.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/init.mdx new file mode 100644 index 0000000000..7568aaa4f3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/init.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/python/signalwire/prefabs/concierge/concierge-agent/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.concierge.ConciergeAgent.__init__" + parent: "signalwire.prefabs.concierge.ConciergeAgent" + module: "signalwire.prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py" +--- +# `__init__` + +Initialize a concierge agent + +## Signature + +```python +__init__( + venue_name: str, + services: List[str], + amenities: Dict[str, Dict[str, str]], + hours_of_operation: Optional[Dict[str, str]] = None, + special_instructions: Optional[List[str]] = None, + welcome_message: Optional[str] = None, + name: str = 'concierge', + route: str = '/concierge', + **kwargs = {} +) +``` + +## Parameters + + + Name of the venue or business + + + + List of services offered + + + + Dictionary of amenities with details + + + + Optional dictionary of operating hours + + + + Optional list of special instructions + + + + Optional custom welcome message + + + + Agent name for the route + + + + HTTP route for this agent + + + + +## Source + +[`signalwire/signalwire/prefabs/concierge.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py) + +Line 45. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/on-summary.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/on-summary.mdx new file mode 100644 index 0000000000..6e766af9a4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/concierge-agent/on-summary.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/prefabs/concierge/concierge-agent/on-summary" +title: "on_summary" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.concierge.ConciergeAgent.on_summary" + parent: "signalwire.prefabs.concierge.ConciergeAgent" + module: "signalwire.prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py" +--- +# `on_summary` + +Process the interaction summary + +## Signature + +```python +on_summary(summary, raw_data = None) +``` + +## Parameters + + + Summary data from the conversation + + + + The complete raw POST data from the request + + +## Source + +[`signalwire/signalwire/prefabs/concierge.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py) + +Line 253. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/concierge/index.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/index.mdx new file mode 100644 index 0000000000..a17e48080c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/concierge/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/prefabs/concierge" +title: "concierge" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.prefabs.concierge" + parent: "signalwire.prefabs" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py" +--- +# `concierge` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module concierge +``` + +## Classes + + + + A prefab agent designed to act as a virtual concierge, providing information and services to users. + + + +## Source + +[`signalwire/signalwire/prefabs/concierge.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/concierge.py) diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/index.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/index.mdx new file mode 100644 index 0000000000..aac6516a83 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/index.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/python/signalwire/prefabs/faq-bot/faq-bot-agent" +title: "FAQBotAgent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.prefabs.faq_bot.FAQBotAgent" + parent: "signalwire.prefabs.faq_bot" + module: "signalwire.prefabs.faq_bot" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/faq_bot.py" +--- +# `FAQBotAgent` + +A prefab agent designed to answer frequently asked questions based on +a provided list of question/answer pairs. + +This agent will: + +1. Match user questions against the FAQ database +2. Provide the most relevant answer +3. Suggest other relevant questions when appropriate + +> \[!NOTE] +> agent = FAQBotAgent( +> faqs=\[ +> \{ +> "question": "What is SignalWire?", +> "answer": "SignalWire is a developer-friendly cloud communications platform." +> \}, +> \{ +> "question": "How much does it cost?", +> "answer": "SignalWire offers pay-as-you-go pricing with no monthly fees." +> \} +> ] +> ) + +## Signature + +```python +class FAQBotAgent(AgentBase) +``` + +## Inheritance + +**Extends:** [AgentBase](/reference/python/signalwire/core/agent-base/agent-base) + +## Properties + + + + + + + +## Methods + + + + Initialize an FAQ bot agent + + + + Process the interaction summary + + + + Search for FAQs matching a specific query or category + + + +## Source + +[`signalwire/signalwire/prefabs/faq_bot.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/faq_bot.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/init.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/init.mdx new file mode 100644 index 0000000000..33cb1690e9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/init.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.faq_bot.FAQBotAgent.__init__" + parent: "signalwire.prefabs.faq_bot.FAQBotAgent" + module: "signalwire.prefabs.faq_bot" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/faq_bot.py" +--- +# `__init__` + +Initialize an FAQ bot agent + +## Signature + +```python +__init__( + faqs: List[Dict[str, str]], + suggest_related: bool = True, + persona: Optional[str] = None, + name: str = 'faq_bot', + route: str = '/faq', + **kwargs = {} +) +``` + +## Parameters + + + List of FAQ items, each with: + + + + Whether to suggest related questions + + + + Optional custom personality description + + + + Agent name for the route + + + + HTTP route for this agent + + + + +## Source + +[`signalwire/signalwire/prefabs/faq_bot.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/faq_bot.py) + +Line 47. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/on-summary.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/on-summary.mdx new file mode 100644 index 0000000000..67f5215d13 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/on-summary.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/on-summary" +title: "on_summary" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.faq_bot.FAQBotAgent.on_summary" + parent: "signalwire.prefabs.faq_bot.FAQBotAgent" + module: "signalwire.prefabs.faq_bot" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/faq_bot.py" +--- +# `on_summary` + +Process the interaction summary + +## Signature + +```python +on_summary(summary, raw_data = None) +``` + +## Parameters + + + Summary data from the conversation + + + + The complete raw POST data from the request + + +## Source + +[`signalwire/signalwire/prefabs/faq_bot.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/faq_bot.py) + +Line 287. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/search-faqs.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/search-faqs.mdx new file mode 100644 index 0000000000..1c5c6f34ff --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/search-faqs.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/prefabs/faq-bot/faq-bot-agent/search-faqs" +title: "search_faqs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.faq_bot.FAQBotAgent.search_faqs" + parent: "signalwire.prefabs.faq_bot.FAQBotAgent" + module: "signalwire.prefabs.faq_bot" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/faq_bot.py" +--- +# `search_faqs` + +Search for FAQs matching a specific query or category + +This function helps find relevant FAQs based on a search query or category. +It returns matching FAQs in order of relevance. + +**Decorators:** `@AgentBase.tool(Any, Any, Any)` + +## Signature + +```python +search_faqs(args, raw_data) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/prefabs/faq_bot.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/faq_bot.py) + +Line 216. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/index.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/index.mdx new file mode 100644 index 0000000000..30103d76c6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/faq-bot/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/prefabs/faq-bot" +title: "faq_bot" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.prefabs.faq_bot" + parent: "signalwire.prefabs" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/faq_bot.py" +--- +# `faq_bot` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module faq_bot +``` + +## Classes + + + + A prefab agent designed to answer frequently asked questions based on a provided list of question/answer pairs. + + + +## Source + +[`signalwire/signalwire/prefabs/faq_bot.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/faq_bot.py) diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/index.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/index.mdx new file mode 100644 index 0000000000..3f2e636cf1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/prefabs" +title: "prefabs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.prefabs" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/__init__.py" +--- +# `prefabs` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module prefabs +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/prefabs/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/index.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/index.mdx new file mode 100644 index 0000000000..2e300425b0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/prefabs/info-gatherer" +title: "info_gatherer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.prefabs.info_gatherer" + parent: "signalwire.prefabs" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py" +--- +# `info_gatherer` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module info_gatherer +``` + +## Classes + + + + A prefab agent designed to collect answers to a series of questions. + + + +## Source + +[`signalwire/signalwire/prefabs/info_gatherer.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py) diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/index.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/index.mdx new file mode 100644 index 0000000000..211c1cc00a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent" +title: "InfoGathererAgent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.prefabs.info_gatherer.InfoGathererAgent" + parent: "signalwire.prefabs.info_gatherer" + module: "signalwire.prefabs.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py" +--- +# `InfoGathererAgent` + +A prefab agent designed to collect answers to a series of questions. + +This agent will: + +1. Ask if the user is ready to begin +2. Ask each question in sequence +3. Store the answers for later use + +> \[!NOTE] +> agent = InfoGathererAgent( +> questions=\[ +> \{"key\_name": "full\_name", "question\_text": "What is your full name?"\}, +> \{"key\_name": "email", "question\_text": "What is your email address?", "confirm": True\}, +> \{"key\_name": "reason", "question\_text": "How can I help you today?"\} +> ] +> ) + +## Signature + +```python +class InfoGathererAgent(AgentBase) +``` + +## Inheritance + +**Extends:** [AgentBase](/reference/python/signalwire/core/agent-base/agent-base) + +## Methods + + + + Initialize an information gathering agent + + + + Handle dynamic configuration using the callback function + + + + Set a callback function for dynamic question configuration + + + + Start the question sequence by retrieving the first question + + + + Submit an answer to the current question and move to the next one + + + +## Source + +[`signalwire/signalwire/prefabs/info_gatherer.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py) + +Line 24. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/init.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/init.mdx new file mode 100644 index 0000000000..16dd9d47a7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/init.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.info_gatherer.InfoGathererAgent.__init__" + parent: "signalwire.prefabs.info_gatherer.InfoGathererAgent" + module: "signalwire.prefabs.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py" +--- +# `__init__` + +Initialize an information gathering agent + +## Signature + +```python +__init__( + questions: Optional[List[Dict[str, str]]] = None, + name: str = 'info_gatherer', + route: str = '/info_gatherer', + **kwargs = {} +) +``` + +## Parameters + + + Optional list of questions to ask. If None, questions will be determined dynamically via a callback function. Each question dict should have: + + + + Agent name for the route + + + + HTTP route for this agent + + + + +## Source + +[`signalwire/signalwire/prefabs/info_gatherer.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py) + +Line 43. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/on-swml-request.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/on-swml-request.mdx new file mode 100644 index 0000000000..28689a92d2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/on-swml-request.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/on-swml-request" +title: "on_swml_request" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.info_gatherer.InfoGathererAgent.on_swml_request" + parent: "signalwire.prefabs.info_gatherer.InfoGathererAgent" + module: "signalwire.prefabs.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py" +--- +# `on_swml_request` + +Handle dynamic configuration using the callback function + +This method is called when SWML is requested and allows us to configure +the agent just-in-time using the provided callback. + +## Signature + +```python +on_swml_request(request_data = None, callback_path = None, request = None) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/prefabs/info_gatherer.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py) + +Line 158. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/set-question-callback.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/set-question-callback.mdx new file mode 100644 index 0000000000..2acb95bb77 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/set-question-callback.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/set-question-callback" +title: "set_question_callback" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.info_gatherer.InfoGathererAgent.set_question_callback" + parent: "signalwire.prefabs.info_gatherer.InfoGathererAgent" + module: "signalwire.prefabs.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py" +--- +# `set_question_callback` + +Set a callback function for dynamic question configuration + +> \[!NOTE] +> def my\_question\_callback(query\_params, body\_params, headers): +> question\_set = query\_params.get('set', 'default') +> if question\_set == 'support': +> return \[ +> \{"key\_name": "name", "question\_text": "What is your name?"\}, +> \{"key\_name": "issue", "question\_text": "What's the issue?"\} +> ] +> else: +> return \[\{"key\_name": "name", "question\_text": "What is your name?"\}] +> +> agent.set\_question\_callback(my\_question\_callback) + +## Signature + +```python +set_question_callback( + callback: Callable[dict, dict, dict, List[Dict[str, str]]] +) +``` + +## Parameters + + + Function that takes (query\_params, body\_params, headers) and returns a list of question dictionaries. Each question dict should have: - key\_name: Identifier for storing the answer - question\_text: The actual question to ask the user - confirm: (Optional) If True, agent will confirm answer before submitting + + +## Examples + +```python +agent.set_question_callback(my_question_callback) +``` + +## Source + +[`signalwire/signalwire/prefabs/info_gatherer.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py) + +Line 93. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/start-questions.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/start-questions.mdx new file mode 100644 index 0000000000..50c3121f5d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/start-questions.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/start-questions" +title: "start_questions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.info_gatherer.InfoGathererAgent.start_questions" + parent: "signalwire.prefabs.info_gatherer.InfoGathererAgent" + module: "signalwire.prefabs.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py" +--- +# `start_questions` + +Start the question sequence by retrieving the first question + +This function gets the current question index from global\_data +and returns the corresponding question. + +**Decorators:** `@AgentBase.tool(Any, Any, Any)` + +## Signature + +```python +start_questions(args, raw_data) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/prefabs/info_gatherer.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py) + +Line 258. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/submit-answer.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/submit-answer.mdx new file mode 100644 index 0000000000..0618cc7416 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/submit-answer.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/prefabs/info-gatherer/info-gatherer-agent/submit-answer" +title: "submit_answer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.info_gatherer.InfoGathererAgent.submit_answer" + parent: "signalwire.prefabs.info_gatherer.InfoGathererAgent" + module: "signalwire.prefabs.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py" +--- +# `submit_answer` + +Submit an answer to the current question and move to the next one + +This function: + +1. Stores the answer in global\_data +2. Increments the question index +3. Returns the next question or completion message + +**Decorators:** `@AgentBase.tool(Any, Any, Any)` + +## Signature + +```python +submit_answer(args, raw_data) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/prefabs/info_gatherer.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/info_gatherer.py) + +Line 296. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/index.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/index.mdx new file mode 100644 index 0000000000..ac947a6c73 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/prefabs/receptionist" +title: "receptionist" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.prefabs.receptionist" + parent: "signalwire.prefabs" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/receptionist.py" +--- +# `receptionist` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module receptionist +``` + +## Classes + + + + A prefab agent designed to act as a receptionist that: 1. Greets callers 2. Collects basic information about their needs 3. Transfers them to the appropriate department + + + +## Source + +[`signalwire/signalwire/prefabs/receptionist.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/receptionist.py) diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/receptionist-agent/index.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/receptionist-agent/index.mdx new file mode 100644 index 0000000000..e2761501eb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/receptionist-agent/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/prefabs/receptionist/receptionist-agent" +title: "ReceptionistAgent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.prefabs.receptionist.ReceptionistAgent" + parent: "signalwire.prefabs.receptionist" + module: "signalwire.prefabs.receptionist" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/receptionist.py" +--- +# `ReceptionistAgent` + +A prefab agent designed to act as a receptionist that: + +1. Greets callers +2. Collects basic information about their needs +3. Transfers them to the appropriate department + +> \[!NOTE] +> agent = ReceptionistAgent( +> departments=\[ +> \{"name": "sales", "description": "For product inquiries, pricing, and purchasing", "number": "+15551235555"\}, +> \{"name": "support", "description": "For technical help and troubleshooting", "number": "+15551236666"\} +> ] +> ) + +## Signature + +```python +class ReceptionistAgent(AgentBase) +``` + +## Inheritance + +**Extends:** [AgentBase](/reference/python/signalwire/core/agent-base/agent-base) + +## Methods + + + + Initialize a receptionist agent + + + + Process the conversation summary + + + +## Source + +[`signalwire/signalwire/prefabs/receptionist.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/receptionist.py) + +Line 21. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/receptionist-agent/init.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/receptionist-agent/init.mdx new file mode 100644 index 0000000000..03d1407a80 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/receptionist-agent/init.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/prefabs/receptionist/receptionist-agent/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.receptionist.ReceptionistAgent.__init__" + parent: "signalwire.prefabs.receptionist.ReceptionistAgent" + module: "signalwire.prefabs.receptionist" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/receptionist.py" +--- +# `__init__` + +Initialize a receptionist agent + +## Signature + +```python +__init__( + departments: List[Dict[str, str]], + name: str = 'receptionist', + route: str = '/receptionist', + greeting: str = 'Thank you for calling. How can I help you today?', + voice: str = 'rime.spore', + **kwargs = {} +) +``` + +## Parameters + + + List of departments to transfer to, each with: + + + + Agent name for the route + + + + HTTP route for this agent + + + + Initial greeting message + + + + Voice ID to use + + + + +## Source + +[`signalwire/signalwire/prefabs/receptionist.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/receptionist.py) + +Line 37. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/receptionist-agent/on-summary.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/receptionist-agent/on-summary.mdx new file mode 100644 index 0000000000..a5c8743f7c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/receptionist/receptionist-agent/on-summary.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/prefabs/receptionist/receptionist-agent/on-summary" +title: "on_summary" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.receptionist.ReceptionistAgent.on_summary" + parent: "signalwire.prefabs.receptionist.ReceptionistAgent" + module: "signalwire.prefabs.receptionist" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/receptionist.py" +--- +# `on_summary` + +Process the conversation summary + +## Signature + +```python +on_summary(summary, raw_data = None) +``` + +## Parameters + + + Summary data from the conversation + + + + The complete raw POST data from the request + + +## Source + +[`signalwire/signalwire/prefabs/receptionist.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/receptionist.py) + +Line 278. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/survey/index.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/survey/index.mdx new file mode 100644 index 0000000000..7e0fba9519 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/survey/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/prefabs/survey" +title: "survey" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.prefabs.survey" + parent: "signalwire.prefabs" + module: "signalwire.prefabs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py" +--- +# `survey` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module survey +``` + +## Classes + + + + A prefab agent designed to conduct automated surveys with users. + + + +## Source + +[`signalwire/signalwire/prefabs/survey.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py) diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/index.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/index.mdx new file mode 100644 index 0000000000..fe100dbb9f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/index.mdx @@ -0,0 +1,95 @@ +--- +slug: "/reference/python/signalwire/prefabs/survey/survey-agent" +title: "SurveyAgent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.prefabs.survey.SurveyAgent" + parent: "signalwire.prefabs.survey" + module: "signalwire.prefabs.survey" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py" +--- +# `SurveyAgent` + +A prefab agent designed to conduct automated surveys with users. + +This agent will: + +1. Introduce the survey purpose and structure +2. Ask predefined questions in sequence +3. Collect and validate responses +4. Provide a summary of collected responses + +> \[!NOTE] +> agent = SurveyAgent( +> survey\_name="Customer Satisfaction Survey", +> introduction="We'd like to get your feedback on your recent experience.", +> questions=\[ +> \{ +> "id": "satisfaction", +> "text": "How satisfied were you with our service?", +> "type": "rating", +> "scale": 5, +> "required": True +> \}, +> \{ +> "id": "comments", +> "text": "Do you have any additional comments?", +> "type": "open\_ended", +> "required": False +> \} +> ] +> ) + +## Signature + +```python +class SurveyAgent(AgentBase) +``` + +## Inheritance + +**Extends:** [AgentBase](/reference/python/signalwire/core/agent-base/agent-base) + +## Properties + + + + + + + + + + + + + +## Methods + + + + Initialize a survey agent + + + + Log a validated response to a survey question + + + + Process the survey results summary + + + + Validate if a response meets the requirements for a specific question + + + +## Source + +[`signalwire/signalwire/prefabs/survey.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/init.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/init.mdx new file mode 100644 index 0000000000..0ecc43a78a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/init.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/python/signalwire/prefabs/survey/survey-agent/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.survey.SurveyAgent.__init__" + parent: "signalwire.prefabs.survey.SurveyAgent" + module: "signalwire.prefabs.survey" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py" +--- +# `__init__` + +Initialize a survey agent + +## Signature + +```python +__init__( + survey_name: str, + questions: List[Dict[str, Any]], + introduction: Optional[str] = None, + conclusion: Optional[str] = None, + brand_name: Optional[str] = None, + max_retries: int = 2, + name: str = 'survey', + route: str = '/survey', + **kwargs = {} +) +``` + +## Parameters + + + Name of the survey + + + + List of question objects with the following keys: + + + + Optional custom introduction message + + + + Optional custom conclusion message + + + + Optional brand or company name + + + + Maximum number of times to retry invalid answers + + + + Name for the agent (default: "survey") + + + + HTTP route for the agent (default: "/survey") + + + + +## Source + +[`signalwire/signalwire/prefabs/survey.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py) + +Line 55. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/log-response.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/log-response.mdx new file mode 100644 index 0000000000..ef03354c86 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/log-response.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/prefabs/survey/survey-agent/log-response" +title: "log_response" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.survey.SurveyAgent.log_response" + parent: "signalwire.prefabs.survey.SurveyAgent" + module: "signalwire.prefabs.survey" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py" +--- +# `log_response` + +Log a validated response to a survey question + +This function would typically connect to a database or API to store the response. +In this example, it just acknowledges that the response was received. + +**Decorators:** `@AgentBase.tool(Any, Any, Any)` + +## Signature + +```python +log_response(args, raw_data) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/prefabs/survey.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py) + +Line 314. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/on-summary.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/on-summary.mdx new file mode 100644 index 0000000000..01d1b9e526 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/on-summary.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/prefabs/survey/survey-agent/on-summary" +title: "on_summary" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.survey.SurveyAgent.on_summary" + parent: "signalwire.prefabs.survey.SurveyAgent" + module: "signalwire.prefabs.survey" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py" +--- +# `on_summary` + +Process the survey results summary + +## Signature + +```python +on_summary(summary, raw_data = None) +``` + +## Parameters + + + Summary data containing survey responses + + + + The complete raw POST data from the request + + +## Source + +[`signalwire/signalwire/prefabs/survey.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py) + +Line 351. diff --git a/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/validate-response.mdx b/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/validate-response.mdx new file mode 100644 index 0000000000..74d8a101b2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/prefabs/survey/survey-agent/validate-response.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/prefabs/survey/survey-agent/validate-response" +title: "validate_response" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.prefabs.survey.SurveyAgent.validate_response" + parent: "signalwire.prefabs.survey.SurveyAgent" + module: "signalwire.prefabs.survey" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py" +--- +# `validate_response` + +Validate if a response meets the requirements for a specific question + +This function checks if a user's response is valid for the specified question +based on the question type and constraints. + +**Decorators:** `@AgentBase.tool(Any, Any, Any)` + +## Signature + +```python +validate_response(args, raw_data) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/prefabs/survey.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/prefabs/survey.py) + +Line 246. diff --git a/fern/products/sdk-reference/python/signalwire/register-skill.mdx b/fern/products/sdk-reference/python/signalwire/register-skill.mdx new file mode 100644 index 0000000000..3e8d4aed31 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/register-skill.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/register-skill" +title: "register_skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.register_skill" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py" +--- +# `register_skill` + +Register a custom skill class + +This allows third-party code to register skill classes directly without +requiring them to be in a specific directory structure. + +> \[!NOTE] +> +> > > > from my\_custom\_skills import MyWeatherSkill +> > > > register\_skill(MyWeatherSkill) +> > > > +> > > > # Now you can use it in agents: +> > > > +> > > > agent.add\_skill('my\_weather') + +## Signature + +```python +register_skill(skill_class) +``` + +## Parameters + + + A class that inherits from SkillBase + + +## Source + +[`signalwire/signalwire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py) + +Line 95. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/action/index.mdx new file mode 100644 index 0000000000..d4fba0895c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/action/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/python/signalwire/relay/call/action" +title: "Action" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.Action" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `Action` + +Base class for async action handles (play, record, detect, etc.). + +Holds a control\_id and back-reference to the Call. Resolves when the +server sends a terminal event for this control\_id. + +## Signature + +```python +class Action +``` + +## Properties + + + + + + + + + + + +## Methods + + + + + + Wait for the action to complete. Returns the terminal event. + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 43. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/action/init.mdx new file mode 100644 index 0000000000..4638593f12 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/action/init.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/relay/call/action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Action.__init__" + parent: "signalwire.relay.call.Action" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__( + call: 'Call', + control_id: str, + terminal_event: str, + terminal_states: tuple[str, ...] +) +``` + +## Parameters + + + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 50. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/action/wait.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/action/wait.mdx new file mode 100644 index 0000000000..675243f88b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/action/wait.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/relay/call/action/wait" +title: "wait" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Action.wait" + parent: "signalwire.relay.call.Action" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `wait` + +Wait for the action to complete. Returns the terminal event. + +**Modifiers:** `async` + +## Signature + +```python +async wait(timeout: Optional[float] = None) -> RelayEvent +``` + +## Parameters + + + +## Returns + +`RelayEvent` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 80. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/ai-action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/ai-action/index.mdx new file mode 100644 index 0000000000..0d9c4440e0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/ai-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/ai-action" +title: "AIAction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.AIAction" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `AIAction` + +Handle for an active AI agent session. + +## Signature + +```python +class AIAction(Action) +``` + +## Inheritance + +**Extends:** [Action](/reference/python/signalwire/relay/call/action) + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 266. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/ai-action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/ai-action/init.mdx new file mode 100644 index 0000000000..9c93ec1a13 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/ai-action/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/ai-action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.AIAction.__init__" + parent: "signalwire.relay.call.AIAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__(call: 'Call', control_id: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 269. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/ai-action/stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/ai-action/stop.mdx new file mode 100644 index 0000000000..9f495cbe6c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/ai-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/ai-action/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.AIAction.stop" + parent: "signalwire.relay.call.AIAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stop` + +**Modifiers:** `async` + +## Signature + +```python +async stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 276. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/ai-hold.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/ai-hold.mdx new file mode 100644 index 0000000000..35552e6a17 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/ai-hold.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/ai-hold" +title: "ai_hold" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.ai_hold" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `ai_hold` + +Put an AI agent session on hold. + +**Modifiers:** `async` + +## Signature + +```python +async ai_hold( + *, + timeout: Optional[str] = None, + prompt: Optional[str] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1218. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/ai-message.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/ai-message.mdx new file mode 100644 index 0000000000..26639befeb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/ai-message.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/ai-message" +title: "ai_message" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.ai_message" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `ai_message` + +Send a message to an active AI agent session. + +**Modifiers:** `async` + +## Signature + +```python +async ai_message( + *, + message_text: Optional[str] = None, + role: Optional[str] = None, + reset: Optional[dict[str, Any]] = None, + global_data: Optional[dict[str, Any]] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1196. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/ai-unhold.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/ai-unhold.mdx new file mode 100644 index 0000000000..e81da1cdec --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/ai-unhold.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/ai-unhold" +title: "ai_unhold" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.ai_unhold" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `ai_unhold` + +Resume an AI agent session from hold. + +**Modifiers:** `async` + +## Signature + +```python +async ai_unhold(*, prompt: Optional[str] = None, **kwargs: Any = {}) -> dict +``` + +## Parameters + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1234. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/ai.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/ai.mdx new file mode 100644 index 0000000000..20504ca3e3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/ai.mdx @@ -0,0 +1,84 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/ai" +title: "ai" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.ai" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `ai` + +Start an AI agent session on the call. Returns an AIAction. + +**Modifiers:** `async` + +## Signature + +```python +async ai( + *, + control_id: Optional[str] = None, + agent: Optional[str] = None, + prompt: Optional[dict[str, Any]] = None, + post_prompt: Optional[dict[str, Any]] = None, + post_prompt_url: Optional[str] = None, + post_prompt_auth_user: Optional[str] = None, + post_prompt_auth_password: Optional[str] = None, + global_data: Optional[dict[str, Any]] = None, + pronounce: Optional[list[dict[str, Any]]] = None, + hints: Optional[list[str]] = None, + languages: Optional[list[dict[str, Any]]] = None, + SWAIG: Optional[dict[str, Any]] = None, + ai_params: Optional[dict[str, Any]] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> AIAction +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`AIAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1118. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/amazon-bedrock.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/amazon-bedrock.mdx new file mode 100644 index 0000000000..30b2fba811 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/amazon-bedrock.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/amazon-bedrock" +title: "amazon_bedrock" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.amazon_bedrock" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `amazon_bedrock` + +Connect to an Amazon Bedrock AI agent. + +**Modifiers:** `async` + +## Signature + +```python +async amazon_bedrock( + *, + prompt: Optional[Any] = None, + SWAIG: Optional[dict[str, Any]] = None, + ai_params: Optional[dict[str, Any]] = None, + global_data: Optional[dict[str, Any]] = None, + post_prompt: Optional[dict[str, Any]] = None, + post_prompt_url: Optional[str] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1168. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/answer.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/answer.mdx new file mode 100644 index 0000000000..308ef54b14 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/answer.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/answer" +title: "answer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.answer" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `answer` + +Answer an inbound call. + +**Modifiers:** `async` + +## Signature + +```python +async answer(**kwargs: Any = {}) -> dict +``` + +## Parameters + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 478. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/bind-digit.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/bind-digit.mdx new file mode 100644 index 0000000000..ea14ba0a2b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/bind-digit.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/bind-digit" +title: "bind_digit" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.bind_digit" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `bind_digit` + +Bind a DTMF digit sequence to trigger a RELAY method. + +**Modifiers:** `async` + +## Signature + +```python +async bind_digit( + digits: str, + bind_method: str, + *, + bind_params: Optional[dict[str, Any]] = None, + realm: Optional[str] = None, + max_triggers: Optional[int] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1027. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/clear-digit-bindings.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/clear-digit-bindings.mdx new file mode 100644 index 0000000000..b787b60e7c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/clear-digit-bindings.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/clear-digit-bindings" +title: "clear_digit_bindings" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.clear_digit_bindings" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `clear_digit_bindings` + +Clear all digit bindings, optionally filtered by realm. + +**Modifiers:** `async` + +## Signature + +```python +async clear_digit_bindings( + *, + realm: Optional[str] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1051. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/collect.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/collect.mdx new file mode 100644 index 0000000000..3a40930454 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/collect.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/collect" +title: "collect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.collect" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `collect` + +Collect digit/speech input without playing media. + +**Modifiers:** `async` + +## Signature + +```python +async collect( + *, + digits: Optional[dict[str, Any]] = None, + speech: Optional[dict[str, Any]] = None, + initial_timeout: Optional[float] = None, + partial_results: Optional[bool] = None, + continuous: Optional[bool] = None, + send_start_of_input: Optional[bool] = None, + start_input_timers: Optional[bool] = None, + control_id: Optional[str] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> StandaloneCollectAction +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + +## Returns + +`StandaloneCollectAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 565. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/connect.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/connect.mdx new file mode 100644 index 0000000000..caf5d036db --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/connect.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/connect" +title: "connect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.connect" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `connect` + +Bridge the call to one or more destinations. + +**Modifiers:** `async` + +## Signature + +```python +async connect( + devices: list[list[dict[str, Any]]], + *, + ringback: Optional[list[dict[str, Any]]] = None, + tag: Optional[str] = None, + max_duration: Optional[int] = None, + max_price_per_minute: Optional[float] = None, + status_url: Optional[str] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 604. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/denoise-stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/denoise-stop.mdx new file mode 100644 index 0000000000..e79ca810ee --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/denoise-stop.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/denoise-stop" +title: "denoise_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.denoise_stop" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `denoise_stop` + +Stop noise reduction on the call. + +**Modifiers:** `async` + +## Signature + +```python +async denoise_stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 978. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/denoise.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/denoise.mdx new file mode 100644 index 0000000000..dfbb075382 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/denoise.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/denoise" +title: "denoise" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.denoise" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `denoise` + +Start noise reduction on the call. + +**Modifiers:** `async` + +## Signature + +```python +async denoise() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 974. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/detect.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/detect.mdx new file mode 100644 index 0000000000..f88e66e30e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/detect.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/detect" +title: "detect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.detect" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `detect` + +Start audio detection (machine, fax, digit). Returns a DetectAction. + +**Modifiers:** `async` + +## Signature + +```python +async detect( + detect: dict[str, Any], + *, + timeout: Optional[float] = None, + control_id: Optional[str] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> DetectAction +``` + +## Parameters + + + + + + + + + + + +## Returns + +`DetectAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 654. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/disconnect.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/disconnect.mdx new file mode 100644 index 0000000000..ef6d7d1b81 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/disconnect.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/disconnect" +title: "disconnect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.disconnect" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `disconnect` + +Disconnect (unbridge) a connected call. + +**Modifiers:** `async` + +## Signature + +```python +async disconnect() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 630. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/echo.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/echo.mdx new file mode 100644 index 0000000000..65a807b2ef --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/echo.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/echo" +title: "echo" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.echo" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `echo` + +Echo audio back to the caller (useful for testing). + +**Modifiers:** `async` + +## Signature + +```python +async echo( + *, + timeout: Optional[float] = None, + status_url: Optional[str] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1007. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/hangup.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/hangup.mdx new file mode 100644 index 0000000000..7bd5d7a1b8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/hangup.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/hangup" +title: "hangup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.hangup" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `hangup` + +End/hang up the call. + +**Modifiers:** `async` + +## Signature + +```python +async hangup(reason: str = 'hangup') -> dict +``` + +## Parameters + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 482. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/hold.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/hold.mdx new file mode 100644 index 0000000000..f8cf579eda --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/hold.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/hold" +title: "hold" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.hold" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `hold` + +Put the call on hold. + +**Modifiers:** `async` + +## Signature + +```python +async hold() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 962. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/index.mdx new file mode 100644 index 0000000000..017e93d585 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/index.mdx @@ -0,0 +1,232 @@ +--- +slug: "/reference/python/signalwire/relay/call/call" +title: "Call" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.Call" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `Call` + +Represents a live RELAY call. + +Created by RelayClient on inbound `calling.call.receive` events or +outbound `dial`/`begin` responses. + +## Signature + +```python +class Call +``` + +## Properties + + + + + + + + + + + + + + + + + + + +## Methods + + + + + + + + Start an AI agent session on the call. Returns an AIAction. + + + + Put an AI agent session on hold. + + + + Send a message to an active AI agent session. + + + + Resume an AI agent session from hold. + + + + Connect to an Amazon Bedrock AI agent. + + + + Answer an inbound call. + + + + Bind a DTMF digit sequence to trigger a RELAY method. + + + + Clear all digit bindings, optionally filtered by realm. + + + + Collect digit/speech input without playing media. + + + + Bridge the call to one or more destinations. + + + + Start noise reduction on the call. + + + + Stop noise reduction on the call. + + + + Start audio detection (machine, fax, digit). Returns a DetectAction. + + + + Disconnect (unbridge) a connected call. + + + + Echo audio back to the caller (useful for testing). + + + + End/hang up the call. + + + + Put the call on hold. + + + + Join an ad-hoc audio conference. + + + + Join a video/audio room. + + + + Leave an audio conference. + + + + Leave the current room. + + + + Start or stop live transcription on the call. + + + + Start or stop live translation on the call. + + + + Register an event listener for this call. + + + + Decline control of an inbound call, returning it to routing. + + + + Start a payment collection. Returns a PayAction. + + + + Play audio content. Returns a PlayAction for stop/pause/resume/wait. + + + + Play audio and collect digit/speech input. + + + + Place the call in a queue. + + + + Remove the call from a queue. + + + + Receive a fax. Returns a FaxAction. + + + + Record audio from the call. Returns a RecordAction. + + + + Transfer a SIP call to an external SIP endpoint via REFER. + + + + Send DTMF digits on the call. + + + + Send a fax document. Returns a FaxAction. + + + + Start streaming call audio to a WebSocket endpoint. Returns a StreamAction. + + + + Intercept call media and stream it. Returns a TapAction. + + + + Start transcribing the call. Returns a TranscribeAction. + + + + Transfer call control to another RELAY app or SWML script. + + + + Release the call from hold. + + + + Send a custom user-defined event. + + + + Wait for a specific event, optionally filtered by predicate. + + + + Wait for the call to reach the ended state. + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 284. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/init.mdx new file mode 100644 index 0000000000..40980835c9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/init.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.__init__" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__( + client: 'RelayClient', + call_id: str, + node_id: str, + project_id: str, + context: str, + *, + tag: str = '', + direction: str = '', + device: Optional[dict[str, Any]] = None, + state: str = '', + segment_id: str = '' +) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 291. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/join-conference.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/join-conference.mdx new file mode 100644 index 0000000000..a46b000a9d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/join-conference.mdx @@ -0,0 +1,102 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/join-conference" +title: "join_conference" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.join_conference" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `join_conference` + +Join an ad-hoc audio conference. + +**Modifiers:** `async` + +## Signature + +```python +async join_conference( + name: str, + *, + muted: Optional[bool] = None, + beep: Optional[str] = None, + start_on_enter: Optional[bool] = None, + end_on_exit: Optional[bool] = None, + wait_url: Optional[str] = None, + max_participants: Optional[int] = None, + record: Optional[str] = None, + region: Optional[str] = None, + trim: Optional[str] = None, + coach: Optional[str] = None, + status_callback: Optional[str] = None, + status_callback_event: Optional[str] = None, + status_callback_event_type: Optional[str] = None, + status_callback_method: Optional[str] = None, + recording_status_callback: Optional[str] = None, + recording_status_callback_event: Optional[str] = None, + recording_status_callback_event_type: Optional[str] = None, + recording_status_callback_method: Optional[str] = None, + stream_obj: Optional[dict[str, Any]] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 884. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/join-room.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/join-room.mdx new file mode 100644 index 0000000000..9693227b48 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/join-room.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/join-room" +title: "join_room" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.join_room" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `join_room` + +Join a video/audio room. + +**Modifiers:** `async` + +## Signature + +```python +async join_room( + name: str, + *, + status_url: Optional[str] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1096. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/leave-conference.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/leave-conference.mdx new file mode 100644 index 0000000000..ff165455fc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/leave-conference.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/leave-conference" +title: "leave_conference" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.leave_conference" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `leave_conference` + +Leave an audio conference. + +**Modifiers:** `async` + +## Signature + +```python +async leave_conference(conference_id: str, **kwargs: Any = {}) -> dict +``` + +## Parameters + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 952. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/leave-room.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/leave-room.mdx new file mode 100644 index 0000000000..96ab369b37 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/leave-room.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/leave-room" +title: "leave_room" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.leave_room" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `leave_room` + +Leave the current room. + +**Modifiers:** `async` + +## Signature + +```python +async leave_room(**kwargs: Any = {}) -> dict +``` + +## Parameters + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1110. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/live-transcribe.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/live-transcribe.mdx new file mode 100644 index 0000000000..8e6b40e483 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/live-transcribe.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/live-transcribe" +title: "live_transcribe" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.live_transcribe" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `live_transcribe` + +Start or stop live transcription on the call. + +**Modifiers:** `async` + +## Signature + +```python +async live_transcribe(action: dict[str, Any], **kwargs: Any = {}) -> dict +``` + +## Parameters + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1068. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/live-translate.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/live-translate.mdx new file mode 100644 index 0000000000..7eb55c7c65 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/live-translate.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/live-translate" +title: "live_translate" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.live_translate" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `live_translate` + +Start or stop live translation on the call. + +**Modifiers:** `async` + +## Signature + +```python +async live_translate( + action: dict[str, Any], + *, + status_url: Optional[str] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1078. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/on.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/on.mdx new file mode 100644 index 0000000000..90c33345a2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/on.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/on" +title: "on" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.on" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `on` + +Register an event listener for this call. + +## Signature + +```python +on(event_type: str, handler: EventHandler) -> None +``` + +## Parameters + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 357. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/pass.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/pass.mdx new file mode 100644 index 0000000000..efc1d3503e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/pass.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/pass" +title: "pass_" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.pass_" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `pass_` + +Decline control of an inbound call, returning it to routing. + +**Modifiers:** `async` + +## Signature + +```python +async pass_() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 486. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/pay.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/pay.mdx new file mode 100644 index 0000000000..2c0a4d698c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/pay.mdx @@ -0,0 +1,102 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/pay" +title: "pay" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.pay" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `pay` + +Start a payment collection. Returns a PayAction. + +**Modifiers:** `async` + +## Signature + +```python +async pay( + payment_connector_url: str, + *, + control_id: Optional[str] = None, + input_method: Optional[str] = None, + status_url: Optional[str] = None, + payment_method: Optional[str] = None, + timeout: Optional[str] = None, + max_attempts: Optional[str] = None, + security_code: Optional[str] = None, + postal_code: Optional[str] = None, + min_postal_code_length: Optional[str] = None, + token_type: Optional[str] = None, + charge_amount: Optional[str] = None, + currency: Optional[str] = None, + language: Optional[str] = None, + voice: Optional[str] = None, + description: Optional[str] = None, + valid_card_types: Optional[str] = None, + parameters: Optional[list[dict[str, Any]]] = None, + prompts: Optional[list[dict[str, Any]]] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> PayAction +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`PayAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 694. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/play-and-collect.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/play-and-collect.mdx new file mode 100644 index 0000000000..d0fefd4f1f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/play-and-collect.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/play-and-collect" +title: "play_and_collect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.play_and_collect" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `play_and_collect` + +Play audio and collect digit/speech input. + +**Modifiers:** `async` + +## Signature + +```python +async play_and_collect( + media: list[dict[str, Any]], + collect: dict[str, Any], + *, + volume: Optional[float] = None, + control_id: Optional[str] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> CollectAction +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`CollectAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 542. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/play.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/play.mdx new file mode 100644 index 0000000000..e913eb92bf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/play.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/play" +title: "play" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.play" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `play` + +Play audio content. Returns a PlayAction for stop/pause/resume/wait. + +**Modifiers:** `async` + +## Signature + +```python +async play( + media: list[dict[str, Any]], + *, + volume: Optional[float] = None, + direction: Optional[str] = None, + loop: Optional[int] = None, + control_id: Optional[str] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> PlayAction +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`PlayAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 494. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/queue-enter.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/queue-enter.mdx new file mode 100644 index 0000000000..4615ace810 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/queue-enter.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/queue-enter" +title: "queue_enter" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.queue_enter" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `queue_enter` + +Place the call in a queue. + +**Modifiers:** `async` + +## Signature + +```python +async queue_enter( + queue_name: str, + *, + control_id: Optional[str] = None, + status_url: Optional[str] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1268. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/queue-leave.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/queue-leave.mdx new file mode 100644 index 0000000000..af2390249c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/queue-leave.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/queue-leave" +title: "queue_leave" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.queue_leave" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `queue_leave` + +Remove the call from a queue. + +**Modifiers:** `async` + +## Signature + +```python +async queue_leave( + queue_name: str, + *, + control_id: Optional[str] = None, + queue_id: Optional[str] = None, + status_url: Optional[str] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1287. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/receive-fax.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/receive-fax.mdx new file mode 100644 index 0000000000..5fb928d8a6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/receive-fax.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/receive-fax" +title: "receive_fax" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.receive_fax" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `receive_fax` + +Receive a fax. Returns a FaxAction. + +**Modifiers:** `async` + +## Signature + +```python +async receive_fax( + *, + control_id: Optional[str] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> FaxAction +``` + +## Parameters + + + + + + + +## Returns + +`FaxAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 788. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/record.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/record.mdx new file mode 100644 index 0000000000..7fb3a31103 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/record.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/record" +title: "record" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.record" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `record` + +Record audio from the call. Returns a RecordAction. + +**Modifiers:** `async` + +## Signature + +```python +async record( + audio: Optional[dict[str, Any]] = None, + *, + control_id: Optional[str] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> RecordAction +``` + +## Parameters + + + + + + + + + +## Returns + +`RecordAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 522. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/refer.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/refer.mdx new file mode 100644 index 0000000000..4916612fa0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/refer.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/refer" +title: "refer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.refer" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `refer` + +Transfer a SIP call to an external SIP endpoint via REFER. + +**Modifiers:** `async` + +## Signature + +```python +async refer( + device: dict[str, Any], + *, + status_url: Optional[str] = None, + **kwargs: Any = {} +) -> dict +``` + +## Parameters + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 676. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/repr.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/repr.mdx new file mode 100644 index 0000000000..948cafc168 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/repr.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/repr" +title: "__repr__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.__repr__" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__repr__` + +## Signature + +```python +__repr__() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1313. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/send-digits.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/send-digits.mdx new file mode 100644 index 0000000000..41b15ce9ff --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/send-digits.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/send-digits" +title: "send_digits" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.send_digits" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `send_digits` + +Send DTMF digits on the call. + +**Modifiers:** `async` + +## Signature + +```python +async send_digits(digits: str, *, control_id: Optional[str] = None) -> dict +``` + +## Parameters + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 638. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/send-fax.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/send-fax.mdx new file mode 100644 index 0000000000..5248e23a83 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/send-fax.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/send-fax" +title: "send_fax" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.send_fax" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `send_fax` + +Send a fax document. Returns a FaxAction. + +**Modifiers:** `async` + +## Signature + +```python +async send_fax( + document: str, + *, + identity: Optional[str] = None, + header_info: Optional[str] = None, + control_id: Optional[str] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> FaxAction +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`FaxAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 767. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/stream.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/stream.mdx new file mode 100644 index 0000000000..2d64015c76 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/stream.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/stream" +title: "stream" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.stream" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stream` + +Start streaming call audio to a WebSocket endpoint. Returns a StreamAction. + +**Modifiers:** `async` + +## Signature + +```python +async stream( + url: str, + *, + name: Optional[str] = None, + codec: Optional[str] = None, + track: Optional[str] = None, + status_url: Optional[str] = None, + status_url_method: Optional[str] = None, + authorization_bearer_token: Optional[str] = None, + custom_parameters: Optional[dict[str, Any]] = None, + control_id: Optional[str] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> StreamAction +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`StreamAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 830. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/tap.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/tap.mdx new file mode 100644 index 0000000000..ec978ab1ab --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/tap.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/tap" +title: "tap" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.tap" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `tap` + +Intercept call media and stream it. Returns a TapAction. + +**Modifiers:** `async` + +## Signature + +```python +async tap( + tap: dict[str, Any], + device: dict[str, Any], + *, + control_id: Optional[str] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> TapAction +``` + +## Parameters + + + + + + + + + + + +## Returns + +`TapAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 806. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/transcribe.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/transcribe.mdx new file mode 100644 index 0000000000..4bae3800bf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/transcribe.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/transcribe" +title: "transcribe" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.transcribe" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `transcribe` + +Start transcribing the call. Returns a TranscribeAction. + +**Modifiers:** `async` + +## Signature + +```python +async transcribe( + *, + control_id: Optional[str] = None, + status_url: Optional[str] = None, + on_completed: Optional[Callable[RelayEvent, Any]] = None, + **kwargs: Any = {} +) -> TranscribeAction +``` + +## Parameters + + + + + + + + + +## Returns + +`TranscribeAction` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 986. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/transfer.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/transfer.mdx new file mode 100644 index 0000000000..fcd3d56efb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/transfer.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/transfer" +title: "transfer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.transfer" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `transfer` + +Transfer call control to another RELAY app or SWML script. + +**Modifiers:** `async` + +## Signature + +```python +async transfer(dest: str, **kwargs: Any = {}) -> dict +``` + +## Parameters + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 870. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/unhold.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/unhold.mdx new file mode 100644 index 0000000000..cf9a1fac60 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/unhold.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/unhold" +title: "unhold" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.unhold" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `unhold` + +Release the call from hold. + +**Modifiers:** `async` + +## Signature + +```python +async unhold() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 966. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/user-event.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/user-event.mdx new file mode 100644 index 0000000000..bd330ce10d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/user-event.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/user-event" +title: "user_event" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.user_event" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `user_event` + +Send a custom user-defined event. + +**Modifiers:** `async` + +## Signature + +```python +async user_event(*, event: Optional[str] = None, **kwargs: Any = {}) -> dict +``` + +## Parameters + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 1251. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/wait-for-ended.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/wait-for-ended.mdx new file mode 100644 index 0000000000..5cf8dee91c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/wait-for-ended.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/wait-for-ended" +title: "wait_for_ended" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.wait_for_ended" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `wait_for_ended` + +Wait for the call to reach the ended state. + +**Modifiers:** `async` + +## Signature + +```python +async wait_for_ended(timeout: Optional[float] = None) -> RelayEvent +``` + +## Parameters + + + +## Returns + +`RelayEvent` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 419. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/call/wait-for.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/call/wait-for.mdx new file mode 100644 index 0000000000..cf4fd4b76d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/call/wait-for.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/relay/call/call/wait-for" +title: "wait_for" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.Call.wait_for" + parent: "signalwire.relay.call.Call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `wait_for` + +Wait for a specific event, optionally filtered by predicate. + +**Modifiers:** `async` + +## Signature + +```python +async wait_for( + event_type: str, + predicate: Optional[Callable[RelayEvent, bool]] = None, + timeout: Optional[float] = None +) -> RelayEvent +``` + +## Parameters + + + + + + + +## Returns + +`RelayEvent` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 391. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/index.mdx new file mode 100644 index 0000000000..805074cbc4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/relay/call/collect-action" +title: "CollectAction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.CollectAction" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `CollectAction` + +Handle for play\_and\_collect or standalone collect. + +## Signature + +```python +class CollectAction(Action) +``` + +## Inheritance + +**Extends:** [Action](/reference/python/signalwire/relay/call/action) + +## Methods + + + + + + Start the initial\_timeout timer on an active collect. + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 151. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/init.mdx new file mode 100644 index 0000000000..4745fa971a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/collect-action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.CollectAction.__init__" + parent: "signalwire.relay.call.CollectAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__(call: 'Call', control_id: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 154. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/start-input-timers.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..add15cd656 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/start-input-timers.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/relay/call/collect-action/start-input-timers" +title: "start_input_timers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.CollectAction.start_input_timers" + parent: "signalwire.relay.call.CollectAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `start_input_timers` + +Start the initial\_timeout timer on an active collect. + +**Modifiers:** `async` + +## Signature + +```python +async start_input_timers() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 178. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/stop.mdx new file mode 100644 index 0000000000..68ccbcbea7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/collect-action/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.CollectAction.stop" + parent: "signalwire.relay.call.CollectAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stop` + +**Modifiers:** `async` + +## Signature + +```python +async stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 169. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/volume.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/volume.mdx new file mode 100644 index 0000000000..dc51115ea2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/collect-action/volume.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/relay/call/collect-action/volume" +title: "volume" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.CollectAction.volume" + parent: "signalwire.relay.call.CollectAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `volume` + +**Modifiers:** `async` + +## Signature + +```python +async volume(volume: float) -> dict +``` + +## Parameters + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 173. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/detect-action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/detect-action/index.mdx new file mode 100644 index 0000000000..6a6d4088c5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/detect-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/detect-action" +title: "DetectAction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.DetectAction" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `DetectAction` + +Handle for an active detect operation. + +## Signature + +```python +class DetectAction(Action) +``` + +## Inheritance + +**Extends:** [Action](/reference/python/signalwire/relay/call/action) + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 133. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/detect-action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/detect-action/init.mdx new file mode 100644 index 0000000000..29efa9e4a9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/detect-action/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/detect-action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.DetectAction.__init__" + parent: "signalwire.relay.call.DetectAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__(call: 'Call', control_id: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 136. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/detect-action/stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/detect-action/stop.mdx new file mode 100644 index 0000000000..5590e3be72 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/detect-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/detect-action/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.DetectAction.stop" + parent: "signalwire.relay.call.DetectAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stop` + +**Modifiers:** `async` + +## Signature + +```python +async stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 147. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/fax-action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/fax-action/index.mdx new file mode 100644 index 0000000000..7495ab9564 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/fax-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/fax-action" +title: "FaxAction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.FaxAction" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `FaxAction` + +Handle for an active send\_fax or receive\_fax operation. + +## Signature + +```python +class FaxAction(Action) +``` + +## Inheritance + +**Extends:** [Action](/reference/python/signalwire/relay/call/action) + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 209. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/fax-action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/fax-action/init.mdx new file mode 100644 index 0000000000..7a7483500b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/fax-action/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/relay/call/fax-action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.FaxAction.__init__" + parent: "signalwire.relay.call.FaxAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__(call: 'Call', control_id: str, method_prefix: str) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 212. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/fax-action/stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/fax-action/stop.mdx new file mode 100644 index 0000000000..f9722b24da --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/fax-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/fax-action/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.FaxAction.stop" + parent: "signalwire.relay.call.FaxAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stop` + +**Modifiers:** `async` + +## Signature + +```python +async stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 217. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/index.mdx new file mode 100644 index 0000000000..96d9f4c1d4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/index.mdx @@ -0,0 +1,89 @@ +--- +slug: "/reference/python/signalwire/relay/call" +title: "call" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.relay.call" + parent: "signalwire.relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `call` + +Call object — represents a live RELAY call with command methods. + +## Signature + +```python +module call +``` + +## Properties + + + + + +## Classes + + + + Base class for async action handles (play, record, detect, etc.). + + + + Handle for an active AI agent session. + + + + Represents a live RELAY call. + + + + Handle for play\_and\_collect or standalone collect. + + + + Handle for an active detect operation. + + + + Handle for an active send\_fax or receive\_fax operation. + + + + Handle for an active pay operation. + + + + Handle for an active play operation. + + + + Handle for an active record operation. + + + + Handle for standalone calling.collect (without play). + + + + Handle for an active stream operation. + + + + Handle for an active tap operation. + + + + Handle for an active transcribe operation. + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/pay-action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/pay-action/index.mdx new file mode 100644 index 0000000000..bcceec6118 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/pay-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/pay-action" +title: "PayAction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.PayAction" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `PayAction` + +Handle for an active pay operation. + +## Signature + +```python +class PayAction(Action) +``` + +## Inheritance + +**Extends:** [Action](/reference/python/signalwire/relay/call/action) + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 244. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/pay-action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/pay-action/init.mdx new file mode 100644 index 0000000000..1727759600 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/pay-action/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/pay-action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.PayAction.__init__" + parent: "signalwire.relay.call.PayAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__(call: 'Call', control_id: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 247. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/pay-action/stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/pay-action/stop.mdx new file mode 100644 index 0000000000..719d95a09d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/pay-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/pay-action/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.PayAction.stop" + parent: "signalwire.relay.call.PayAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stop` + +**Modifiers:** `async` + +## Signature + +```python +async stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 251. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/play-action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/index.mdx new file mode 100644 index 0000000000..b1e4560310 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/relay/call/play-action" +title: "PlayAction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.PlayAction" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `PlayAction` + +Handle for an active play operation. + +## Signature + +```python +class PlayAction(Action) +``` + +## Inheritance + +**Extends:** [Action](/reference/python/signalwire/relay/call/action) + +## Methods + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 91. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/play-action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/init.mdx new file mode 100644 index 0000000000..994141b5a2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/play-action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.PlayAction.__init__" + parent: "signalwire.relay.call.PlayAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__(call: 'Call', control_id: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 94. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/play-action/pause.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/pause.mdx new file mode 100644 index 0000000000..dfc914fbbe --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/pause.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/play-action/pause" +title: "pause" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.PlayAction.pause" + parent: "signalwire.relay.call.PlayAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `pause` + +**Modifiers:** `async` + +## Signature + +```python +async pause() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 101. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/play-action/resume.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/resume.mdx new file mode 100644 index 0000000000..3a9d36f0fc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/resume.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/play-action/resume" +title: "resume" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.PlayAction.resume" + parent: "signalwire.relay.call.PlayAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `resume` + +**Modifiers:** `async` + +## Signature + +```python +async resume() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 104. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/play-action/stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/stop.mdx new file mode 100644 index 0000000000..be2f5ab047 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/play-action/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.PlayAction.stop" + parent: "signalwire.relay.call.PlayAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stop` + +**Modifiers:** `async` + +## Signature + +```python +async stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 98. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/play-action/volume.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/volume.mdx new file mode 100644 index 0000000000..d6fa780157 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/play-action/volume.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/relay/call/play-action/volume" +title: "volume" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.PlayAction.volume" + parent: "signalwire.relay.call.PlayAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `volume` + +**Modifiers:** `async` + +## Signature + +```python +async volume(volume: float) -> dict +``` + +## Parameters + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 107. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/record-action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/record-action/index.mdx new file mode 100644 index 0000000000..12f3bf18f9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/record-action/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/relay/call/record-action" +title: "RecordAction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.RecordAction" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `RecordAction` + +Handle for an active record operation. + +## Signature + +```python +class RecordAction(Action) +``` + +## Inheritance + +**Extends:** [Action](/reference/python/signalwire/relay/call/action) + +## Methods + + + + + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 113. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/record-action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/record-action/init.mdx new file mode 100644 index 0000000000..0b93dca7f0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/record-action/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/record-action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.RecordAction.__init__" + parent: "signalwire.relay.call.RecordAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__(call: 'Call', control_id: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 116. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/record-action/pause.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/record-action/pause.mdx new file mode 100644 index 0000000000..07bb67f028 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/record-action/pause.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/relay/call/record-action/pause" +title: "pause" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.RecordAction.pause" + parent: "signalwire.relay.call.RecordAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `pause` + +**Modifiers:** `async` + +## Signature + +```python +async pause(behavior: Optional[str] = None) -> dict +``` + +## Parameters + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 123. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/record-action/resume.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/record-action/resume.mdx new file mode 100644 index 0000000000..8841d2f430 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/record-action/resume.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/record-action/resume" +title: "resume" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.RecordAction.resume" + parent: "signalwire.relay.call.RecordAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `resume` + +**Modifiers:** `async` + +## Signature + +```python +async resume() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 129. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/record-action/stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/record-action/stop.mdx new file mode 100644 index 0000000000..8bac7e3059 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/record-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/record-action/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.RecordAction.stop" + parent: "signalwire.relay.call.RecordAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stop` + +**Modifiers:** `async` + +## Signature + +```python +async stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 120. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/index.mdx new file mode 100644 index 0000000000..cc83f34bd3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/relay/call/standalone-collect-action" +title: "StandaloneCollectAction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.StandaloneCollectAction" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `StandaloneCollectAction` + +Handle for standalone calling.collect (without play). + +## Signature + +```python +class StandaloneCollectAction(Action) +``` + +## Inheritance + +**Extends:** [Action](/reference/python/signalwire/relay/call/action) + +## Methods + + + + + + Start the initial\_timeout timer on an active collect. + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 184. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/init.mdx new file mode 100644 index 0000000000..a03218054c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/standalone-collect-action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.StandaloneCollectAction.__init__" + parent: "signalwire.relay.call.StandaloneCollectAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__(call: 'Call', control_id: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 187. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/start-input-timers.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..720896171c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/start-input-timers.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/relay/call/standalone-collect-action/start-input-timers" +title: "start_input_timers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.StandaloneCollectAction.start_input_timers" + parent: "signalwire.relay.call.StandaloneCollectAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `start_input_timers` + +Start the initial\_timeout timer on an active collect. + +**Modifiers:** `async` + +## Signature + +```python +async start_input_timers() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 203. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/stop.mdx new file mode 100644 index 0000000000..0be5ce123d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/standalone-collect-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/standalone-collect-action/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.StandaloneCollectAction.stop" + parent: "signalwire.relay.call.StandaloneCollectAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stop` + +**Modifiers:** `async` + +## Signature + +```python +async stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 199. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/stream-action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/stream-action/index.mdx new file mode 100644 index 0000000000..f59047edc1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/stream-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/stream-action" +title: "StreamAction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.StreamAction" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `StreamAction` + +Handle for an active stream operation. + +## Signature + +```python +class StreamAction(Action) +``` + +## Inheritance + +**Extends:** [Action](/reference/python/signalwire/relay/call/action) + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 233. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/stream-action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/stream-action/init.mdx new file mode 100644 index 0000000000..71372aacba --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/stream-action/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/stream-action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.StreamAction.__init__" + parent: "signalwire.relay.call.StreamAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__(call: 'Call', control_id: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 236. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/stream-action/stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/stream-action/stop.mdx new file mode 100644 index 0000000000..1a9db2a5d2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/stream-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/stream-action/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.StreamAction.stop" + parent: "signalwire.relay.call.StreamAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stop` + +**Modifiers:** `async` + +## Signature + +```python +async stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 240. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/tap-action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/tap-action/index.mdx new file mode 100644 index 0000000000..2a0754cebb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/tap-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/tap-action" +title: "TapAction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.TapAction" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `TapAction` + +Handle for an active tap operation. + +## Signature + +```python +class TapAction(Action) +``` + +## Inheritance + +**Extends:** [Action](/reference/python/signalwire/relay/call/action) + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 222. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/tap-action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/tap-action/init.mdx new file mode 100644 index 0000000000..117a47df9e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/tap-action/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/tap-action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.TapAction.__init__" + parent: "signalwire.relay.call.TapAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__(call: 'Call', control_id: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 225. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/tap-action/stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/tap-action/stop.mdx new file mode 100644 index 0000000000..bed060020e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/tap-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/tap-action/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.TapAction.stop" + parent: "signalwire.relay.call.TapAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stop` + +**Modifiers:** `async` + +## Signature + +```python +async stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 229. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/transcribe-action/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/transcribe-action/index.mdx new file mode 100644 index 0000000000..2d55c953ac --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/transcribe-action/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/relay/call/transcribe-action" +title: "TranscribeAction" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.call.TranscribeAction" + parent: "signalwire.relay.call" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `TranscribeAction` + +Handle for an active transcribe operation. + +## Signature + +```python +class TranscribeAction(Action) +``` + +## Inheritance + +**Extends:** [Action](/reference/python/signalwire/relay/call/action) + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 255. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/transcribe-action/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/transcribe-action/init.mdx new file mode 100644 index 0000000000..b403576a06 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/transcribe-action/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/transcribe-action/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.TranscribeAction.__init__" + parent: "signalwire.relay.call.TranscribeAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `__init__` + +## Signature + +```python +__init__(call: 'Call', control_id: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 258. diff --git a/fern/products/sdk-reference/python/signalwire/relay/call/transcribe-action/stop.mdx b/fern/products/sdk-reference/python/signalwire/relay/call/transcribe-action/stop.mdx new file mode 100644 index 0000000000..ea1da9199c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/call/transcribe-action/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/call/transcribe-action/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.call.TranscribeAction.stop" + parent: "signalwire.relay.call.TranscribeAction" + module: "signalwire.relay.call" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py" +--- +# `stop` + +**Modifiers:** `async` + +## Signature + +```python +async stop() -> dict +``` + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/call.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/call.py) + +Line 262. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/index.mdx new file mode 100644 index 0000000000..f8083234d7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/python/signalwire/relay/client" +title: "client" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.relay.client" + parent: "signalwire.relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `client` + +RelayClient — WebSocket + JSON-RPC 2.0 protocol + event dispatch. + +One instance = one persistent WebSocket connection to SignalWire RELAY. + +Architecture notes (mirrors the JS SDK): + +- JSON-RPC requests are tracked by `id` in `_pending`; responses resolve + the corresponding Future. +- `signalwire.event` messages are acknowledged back to the server (event ACK) + and then dispatched by `event_type` → Call object → Action object. +- Each Action registers with a `control_id` and listens for its own + event\_type (e.g. `calling.call.play`). Actions filter events by + `control_id` so multiple concurrent actions on the same call work. +- Result code checking accepts any 2xx (matching the JS SDK regex /^2\[0-9]\[0-9]$/). + `signalwire.connect` responses skip code checking entirely. +- Execute has a configurable timeout (default 10s) to detect half-open connections. +- Requests made while disconnected are queued and flushed after re-auth. +- Server pings are tracked; if no ping arrives within the check interval the + connection is assumed half-open and force-closed for reconnect. + +## Signature + +```python +module client +``` + +## Properties + + + + + + + +## Classes + + + + Manages a WebSocket connection to SignalWire RELAY. + + + + Error returned by the RELAY server. + + + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/aenter.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/aenter.mdx new file mode 100644 index 0000000000..badc34e1af --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/aenter.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/aenter" +title: "__aenter__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.__aenter__" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `__aenter__` + +**Modifiers:** `async` + +## Signature + +```python +async __aenter__() -> 'RelayClient' +``` + +## Returns + +`'RelayClient'` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 186. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/aexit.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/aexit.mdx new file mode 100644 index 0000000000..108ce55b2c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/aexit.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/aexit" +title: "__aexit__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.__aexit__" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `__aexit__` + +**Modifiers:** `async` + +## Signature + +```python +async __aexit__(*exc: Any = ()) -> None +``` + +## Parameters + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 190. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/connect.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/connect.mdx new file mode 100644 index 0000000000..c3eac23852 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/connect.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/connect" +title: "connect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.connect" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `connect` + +Connect to RELAY and authenticate. + +**Modifiers:** `async` + +## Signature + +```python +async connect() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 216. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/del.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/del.mdx new file mode 100644 index 0000000000..6ca9af2e16 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/del.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/del" +title: "__del__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.__del__" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `__del__` + +## Signature + +```python +__del__() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 183. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/dial.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/dial.mdx new file mode 100644 index 0000000000..0a679871e9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/dial.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/dial" +title: "dial" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.dial" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `dial` + +Initiate an outbound call using dial. Returns a Call object. + +The `calling.dial` RPC response only contains +`{"code": "200", "message": "Dialing"}` — no call\_id. The real +call\_id and node\_id arrive via `calling.call.dial` events +matched by `tag`. This method waits for that event so the +returned Call always has valid identifiers. + +**Modifiers:** `async` + +## Signature + +```python +async dial( + devices: list[list[dict[str, Any]]], + *, + tag: Optional[str] = None, + max_duration: Optional[int] = None, + dial_timeout: Optional[float] = None +) -> Call +``` + +## Parameters + + + Array of device lists (serial/parallel dial). + + + + Client-provided tag for event correlation. Auto-generated if not supplied. + + + + Optional max call duration in minutes. + + + + How long (seconds) to wait for the dial to complete before raising TimeoutError. Defaults to 120s. + + +## Returns + +`Call` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 343. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/disconnect.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/disconnect.mdx new file mode 100644 index 0000000000..afc32cd171 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/disconnect.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/disconnect" +title: "disconnect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.disconnect" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `disconnect` + +Cleanly close the connection. + +**Modifiers:** `async` + +## Signature + +```python +async disconnect() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 286. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/execute.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/execute.mdx new file mode 100644 index 0000000000..b5945a4b69 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/execute.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/execute" +title: "execute" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.execute" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `execute` + +Send a JSON-RPC request and await the response. + +For calling methods, `method` is the full name (e.g. +`"calling.answer"`, `"calling.play"`) with `node_id` +and `call_id` in `params`. + +If the connection is not ready, the request is queued and sent +after re-authentication completes. + +**Modifiers:** `async` + +## Signature + +```python +async execute(method: str, params: dict[str, Any]) -> dict +``` + +## Parameters + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 331. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/index.mdx new file mode 100644 index 0000000000..801bb8e18b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/index.mdx @@ -0,0 +1,123 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client" +title: "RelayClient" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient" + parent: "signalwire.relay.client" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `RelayClient` + +Manages a WebSocket connection to SignalWire RELAY. + +Usage:: + +``` +client = RelayClient(project="...", token="...", contexts=["default"]) + +@client.on_call +async def handle(call): + await call.answer() + await call.hangup() + +client.run() +``` + +## Signature + +```python +class RelayClient +``` + +## Examples + +```python +client = RelayClient(project="...", token="...", contexts=["default"]) + +@client.on_call +async def handle(call): + await call.answer() + await call.hangup() + +client.run() +``` + +## Properties + + + + + + + + + + + Server-assigned protocol string from the connect response. + + + + +## Methods + + + + + + + + + + + + Connect to RELAY and authenticate. + + + + Initiate an outbound call using dial. Returns a Call object. + + + + Cleanly close the connection. + + + + Send a JSON-RPC request and await the response. + + + + Register the inbound call handler (decorator). + + + + Register the inbound message handler (decorator). + + + + Subscribe to additional contexts for inbound events. + + + + Blocking entry point — runs the event loop until interrupted. + + + + Send an outbound SMS/MMS message. + + + + Unsubscribe from contexts for inbound events. + + + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 91. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/init.mdx new file mode 100644 index 0000000000..995b160781 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/init.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.__init__" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `__init__` + +## Signature + +```python +__init__( + project: Optional[str] = None, + token: Optional[str] = None, + jwt_token: Optional[str] = None, + host: Optional[str] = None, + contexts: Optional[list[str]] = None, + max_active_calls: Optional[int] = None +) +``` + +## Parameters + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 106. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/on-call.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/on-call.mdx new file mode 100644 index 0000000000..a3d621ed95 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/on-call.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/on-call" +title: "on_call" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.on_call" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `on_call` + +Register the inbound call handler (decorator). + +## Signature + +```python +on_call(handler: CallHandler) -> CallHandler +``` + +## Parameters + + + +## Returns + +`CallHandler` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 202. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/on-message.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/on-message.mdx new file mode 100644 index 0000000000..c1fb024f39 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/on-message.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/on-message" +title: "on_message" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.on_message" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `on_message` + +Register the inbound message handler (decorator). + +## Signature + +```python +on_message(handler: MessageHandler) -> MessageHandler +``` + +## Parameters + + + +## Returns + +`MessageHandler` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 207. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/receive.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/receive.mdx new file mode 100644 index 0000000000..a729e2056e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/receive.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/receive" +title: "receive" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.receive" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `receive` + +Subscribe to additional contexts for inbound events. + +Sends `signalwire.receive` on the assigned protocol to start +receiving inbound calls on the given contexts. Can be called +after `connect()` to dynamically add contexts without reconnecting. + +**Modifiers:** `async` + +## Signature + +```python +async receive(contexts: list[str]) -> None +``` + +## Parameters + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 481. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/run.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/run.mdx new file mode 100644 index 0000000000..8616d9d5e1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/run.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/run" +title: "run" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.run" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `run` + +Blocking entry point — runs the event loop until interrupted. + +## Signature + +```python +run() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 512. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/send-message.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/send-message.mdx new file mode 100644 index 0000000000..0d72f2390e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/send-message.mdx @@ -0,0 +1,85 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/send-message" +title: "send_message" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.send_message" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `send_message` + +Send an outbound SMS/MMS message. + +At least one of `body` or `media` must be provided. + +Returns a Message object that tracks state changes. Use +`await message.wait()` to block until delivery confirmation +(or failure). + +**Modifiers:** `async` + +## Signature + +```python +async send_message( + *, + to_number: str, + from_number: str, + context: Optional[str] = None, + body: Optional[str] = None, + media: Optional[list[str]] = None, + tags: Optional[list[str]] = None, + region: Optional[str] = None, + on_completed: Optional[Callable] = None +) -> Message +``` + +## Parameters + + + Destination phone number in E.164 format. + + + + Sender phone number in E.164 format. + + + + Context for receiving state events. Defaults to the relay protocol. + + + + Text body of the message. + + + + List of media URLs for MMS. + + + + Optional tags for the message. + + + + Optional origination region. + + + + Optional callback fired when a terminal state (delivered/undelivered/failed) is reached. + + +## Returns + +`Message` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 406. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/unreceive.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/unreceive.mdx new file mode 100644 index 0000000000..16a9a71609 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-client/unreceive.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-client/unreceive" +title: "unreceive" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayClient.unreceive" + parent: "signalwire.relay.client.RelayClient" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `unreceive` + +Unsubscribe from contexts for inbound events. + +Sends `signalwire.unreceive` to stop receiving inbound calls +on the given contexts. + +**Modifiers:** `async` + +## Signature + +```python +async unreceive(contexts: list[str]) -> None +``` + +## Parameters + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 495. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-error/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-error/index.mdx new file mode 100644 index 0000000000..4a04fec6de --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-error/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-error" +title: "RelayError" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.client.RelayError" + parent: "signalwire.relay.client" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `RelayError` + +Error returned by the RELAY server. + +## Signature + +```python +class RelayError(Exception) +``` + +## Inheritance + +**Extends:** `Exception` + +## Properties + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 1106. diff --git a/fern/products/sdk-reference/python/signalwire/relay/client/relay-error/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/client/relay-error/init.mdx new file mode 100644 index 0000000000..7c87005b94 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/client/relay-error/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/relay/client/relay-error/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.client.RelayError.__init__" + parent: "signalwire.relay.client.RelayError" + module: "signalwire.relay.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py" +--- +# `__init__` + +## Signature + +```python +__init__(code: int, message: str) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/relay/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/client.py) + +Line 1109. diff --git a/fern/products/sdk-reference/python/signalwire/relay/constants/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/constants/index.mdx new file mode 100644 index 0000000000..a69b061985 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/constants/index.mdx @@ -0,0 +1,183 @@ +--- +slug: "/reference/python/signalwire/relay/constants" +title: "constants" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.relay.constants" + parent: "signalwire.relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/constants.py" +--- +# `constants` + +Protocol constants for the SignalWire RELAY calling API. + +## Signature + +```python +module constants +``` + +## Constants + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/relay/constants.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/constants.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/call-receive-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/call-receive-event/from-payload.mdx new file mode 100644 index 0000000000..eb9c6cce0b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/call-receive-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/call-receive-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.CallReceiveEvent.from_payload" + parent: "signalwire.relay.event.CallReceiveEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'CallReceiveEvent' +``` + +## Parameters + + + +## Returns + +`'CallReceiveEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 72. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/call-receive-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/call-receive-event/index.mdx new file mode 100644 index 0000000000..23bc08ac4c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/call-receive-event/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/python/signalwire/relay/event/call-receive-event" +title: "CallReceiveEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.CallReceiveEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `CallReceiveEvent` + +Event for calling.call.receive — inbound call notification. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class CallReceiveEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + + + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 59. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/call-receive-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/call-receive-event/init.mdx new file mode 100644 index 0000000000..cb1bb4b54e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/call-receive-event/init.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/python/signalwire/relay/event/call-receive-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.CallReceiveEvent.__init__" + parent: "signalwire.relay.event.CallReceiveEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + call_state: str = '', + direction: str = '', + device: dict[str, Any] = dict(), + node_id: str = '', + project_id: str = '', + context: str = '', + segment_id: str = '', + tag: str = '' +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/call-state-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/call-state-event/from-payload.mdx new file mode 100644 index 0000000000..ec94a46a97 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/call-state-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/call-state-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.CallStateEvent.from_payload" + parent: "signalwire.relay.event.CallStateEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'CallStateEvent' +``` + +## Parameters + + + +## Returns + +`'CallStateEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 43. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/call-state-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/call-state-event/index.mdx new file mode 100644 index 0000000000..54a21f7a49 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/call-state-event/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/python/signalwire/relay/event/call-state-event" +title: "CallStateEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.CallStateEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `CallStateEvent` + +Event for calling.call.state. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class CallStateEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 34. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/call-state-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/call-state-event/init.mdx new file mode 100644 index 0000000000..a6c7de1c5c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/call-state-event/init.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/relay/event/call-state-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.CallStateEvent.__init__" + parent: "signalwire.relay.event.CallStateEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + call_state: str = '', + end_reason: str = '', + direction: str = '', + device: dict[str, Any] = dict() +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/calling-error-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/calling-error-event/from-payload.mdx new file mode 100644 index 0000000000..86b8384402 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/calling-error-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/calling-error-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.CallingErrorEvent.from_payload" + parent: "signalwire.relay.event.CallingErrorEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'CallingErrorEvent' +``` + +## Parameters + + + +## Returns + +`'CallingErrorEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 516. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/calling-error-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/calling-error-event/index.mdx new file mode 100644 index 0000000000..35acaaeb5e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/calling-error-event/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/relay/event/calling-error-event" +title: "CallingErrorEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.CallingErrorEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `CallingErrorEvent` + +Event for calling.error. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class CallingErrorEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 509. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/calling-error-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/calling-error-event/init.mdx new file mode 100644 index 0000000000..ba7bcb883b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/calling-error-event/init.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/python/signalwire/relay/event/calling-error-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.CallingErrorEvent.__init__" + parent: "signalwire.relay.event.CallingErrorEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + code: str = '', + message: str = '' +) -> None +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/collect-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/collect-event/from-payload.mdx new file mode 100644 index 0000000000..ae7298c3b5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/collect-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/collect-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.CollectEvent.from_payload" + parent: "signalwire.relay.event.CollectEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'CollectEvent' +``` + +## Parameters + + + +## Returns + +`'CollectEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 152. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/collect-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/collect-event/index.mdx new file mode 100644 index 0000000000..3d287c2950 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/collect-event/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/python/signalwire/relay/event/collect-event" +title: "CollectEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.CollectEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `CollectEvent` + +Event for calling.call.collect. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class CollectEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 143. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/collect-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/collect-event/init.mdx new file mode 100644 index 0000000000..5c8eed8f60 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/collect-event/init.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/relay/event/collect-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.CollectEvent.__init__" + parent: "signalwire.relay.event.CollectEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + control_id: str = '', + state: str = '', + result: dict[str, Any] = dict(), + final: Optional[bool] = None +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/conference-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/conference-event/from-payload.mdx new file mode 100644 index 0000000000..d35b686ebd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/conference-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/conference-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.ConferenceEvent.from_payload" + parent: "signalwire.relay.event.ConferenceEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'ConferenceEvent' +``` + +## Parameters + + + +## Returns + +`'ConferenceEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 494. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/conference-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/conference-event/index.mdx new file mode 100644 index 0000000000..d8cfc6046a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/conference-event/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/python/signalwire/relay/event/conference-event" +title: "ConferenceEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.ConferenceEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `ConferenceEvent` + +Event for calling.conference. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class ConferenceEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 486. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/conference-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/conference-event/init.mdx new file mode 100644 index 0000000000..df46c1659c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/conference-event/init.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/python/signalwire/relay/event/conference-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.ConferenceEvent.__init__" + parent: "signalwire.relay.event.ConferenceEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + conference_id: str = '', + name: str = '', + status: str = '' +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/connect-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/connect-event/from-payload.mdx new file mode 100644 index 0000000000..9baab4037d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/connect-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/connect-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.ConnectEvent.from_payload" + parent: "signalwire.relay.event.ConnectEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'ConnectEvent' +``` + +## Parameters + + + +## Returns + +`'ConnectEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 175. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/connect-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/connect-event/index.mdx new file mode 100644 index 0000000000..59421ec884 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/connect-event/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/relay/event/connect-event" +title: "ConnectEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.ConnectEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `ConnectEvent` + +Event for calling.call.connect. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class ConnectEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 168. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/connect-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/connect-event/init.mdx new file mode 100644 index 0000000000..ba35dcc1d3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/connect-event/init.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/python/signalwire/relay/event/connect-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.ConnectEvent.__init__" + parent: "signalwire.relay.event.ConnectEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + connect_state: str = '', + peer: dict[str, Any] = dict() +) -> None +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/denoise-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/denoise-event/from-payload.mdx new file mode 100644 index 0000000000..da14d357bb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/denoise-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/denoise-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.DenoiseEvent.from_payload" + parent: "signalwire.relay.event.DenoiseEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'DenoiseEvent' +``` + +## Parameters + + + +## Returns + +`'DenoiseEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 356. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/denoise-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/denoise-event/index.mdx new file mode 100644 index 0000000000..bfdf8e732c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/denoise-event/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/relay/event/denoise-event" +title: "DenoiseEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.DenoiseEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `DenoiseEvent` + +Event for calling.call.denoise. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class DenoiseEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 350. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/denoise-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/denoise-event/init.mdx new file mode 100644 index 0000000000..cccd88cdb3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/denoise-event/init.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/relay/event/denoise-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.DenoiseEvent.__init__" + parent: "signalwire.relay.event.DenoiseEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + denoised: bool = False +) -> None +``` + +## Parameters + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/detect-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/detect-event/from-payload.mdx new file mode 100644 index 0000000000..17388d000a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/detect-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/detect-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.DetectEvent.from_payload" + parent: "signalwire.relay.event.DetectEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'DetectEvent' +``` + +## Parameters + + + +## Returns + +`'DetectEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 196. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/detect-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/detect-event/index.mdx new file mode 100644 index 0000000000..a005efc942 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/detect-event/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/relay/event/detect-event" +title: "DetectEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.DetectEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `DetectEvent` + +Event for calling.call.detect. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class DetectEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 189. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/detect-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/detect-event/init.mdx new file mode 100644 index 0000000000..79aa8e827e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/detect-event/init.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/python/signalwire/relay/event/detect-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.DetectEvent.__init__" + parent: "signalwire.relay.event.DetectEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + control_id: str = '', + detect: dict[str, Any] = dict() +) -> None +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/dial-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/dial-event/from-payload.mdx new file mode 100644 index 0000000000..870028846f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/dial-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/dial-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.DialEvent.from_payload" + parent: "signalwire.relay.event.DialEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'DialEvent' +``` + +## Parameters + + + +## Returns + +`'DialEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 310. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/dial-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/dial-event/index.mdx new file mode 100644 index 0000000000..ced2d74053 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/dial-event/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/python/signalwire/relay/event/dial-event" +title: "DialEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.DialEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `DialEvent` + +Event for calling.call.dial. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class DialEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 302. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/dial-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/dial-event/init.mdx new file mode 100644 index 0000000000..a12ec61f72 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/dial-event/init.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/python/signalwire/relay/event/dial-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.DialEvent.__init__" + parent: "signalwire.relay.event.DialEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + tag: str = '', + dial_state: str = '', + call: dict[str, Any] = dict() +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/echo-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/echo-event/from-payload.mdx new file mode 100644 index 0000000000..dd95138a18 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/echo-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/echo-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.EchoEvent.from_payload" + parent: "signalwire.relay.event.EchoEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'EchoEvent' +``` + +## Parameters + + + +## Returns + +`'EchoEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 425. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/echo-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/echo-event/index.mdx new file mode 100644 index 0000000000..90b4cd1666 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/echo-event/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/relay/event/echo-event" +title: "EchoEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.EchoEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `EchoEvent` + +Event for calling.call.echo. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class EchoEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 419. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/echo-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/echo-event/init.mdx new file mode 100644 index 0000000000..b1652e8045 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/echo-event/init.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/relay/event/echo-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.EchoEvent.__init__" + parent: "signalwire.relay.event.EchoEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + state: str = '' +) -> None +``` + +## Parameters + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/fax-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/fax-event/from-payload.mdx new file mode 100644 index 0000000000..650d30a15c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/fax-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/fax-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.FaxEvent.from_payload" + parent: "signalwire.relay.event.FaxEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'FaxEvent' +``` + +## Parameters + + + +## Returns + +`'FaxEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 217. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/fax-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/fax-event/index.mdx new file mode 100644 index 0000000000..848501c9db --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/fax-event/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/relay/event/fax-event" +title: "FaxEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.FaxEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `FaxEvent` + +Event for calling.call.fax. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class FaxEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 210. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/fax-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/fax-event/init.mdx new file mode 100644 index 0000000000..13936e08c6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/fax-event/init.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/python/signalwire/relay/event/fax-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.FaxEvent.__init__" + parent: "signalwire.relay.event.FaxEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + control_id: str = '', + fax: dict[str, Any] = dict() +) -> None +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/hold-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/hold-event/from-payload.mdx new file mode 100644 index 0000000000..4e8ca3dd70 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/hold-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/hold-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.HoldEvent.from_payload" + parent: "signalwire.relay.event.HoldEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'HoldEvent' +``` + +## Parameters + + + +## Returns + +`'HoldEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 473. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/hold-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/hold-event/index.mdx new file mode 100644 index 0000000000..8316ca5cf8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/hold-event/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/relay/event/hold-event" +title: "HoldEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.HoldEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `HoldEvent` + +Event for calling.call.hold. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class HoldEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 467. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/hold-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/hold-event/init.mdx new file mode 100644 index 0000000000..e0b6729e65 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/hold-event/init.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/relay/event/hold-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.HoldEvent.__init__" + parent: "signalwire.relay.event.HoldEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + state: str = '' +) -> None +``` + +## Parameters + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/index.mdx new file mode 100644 index 0000000000..aa0e505654 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/index.mdx @@ -0,0 +1,142 @@ +--- +slug: "/reference/python/signalwire/relay/event" +title: "event" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.relay.event" + parent: "signalwire.relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `event` + +Typed event wrappers for RELAY calling events. + +These are convenience dataclasses over raw event dicts. All Call event handlers +also accept the raw dict, so these are optional. + +## Signature + +```python +module event +``` + +## Constants + + + +## Functions + + + + Parse a raw signalwire.event params dict into a typed event object. + + + +## Classes + + + + Event for calling.error. + + + + Event for calling.call.receive — inbound call notification. + + + + Event for calling.call.state. + + + + Event for calling.call.collect. + + + + Event for calling.conference. + + + + Event for calling.call.connect. + + + + Event for calling.call.denoise. + + + + Event for calling.call.detect. + + + + Event for calling.call.dial. + + + + Event for calling.call.echo. + + + + Event for calling.call.fax. + + + + Event for calling.call.hold. + + + + Event for messaging.receive — inbound message notification. + + + + Event for messaging.state — outbound message state change. + + + + Event for calling.call.pay. + + + + Event for calling.call.play. + + + + Event for calling.call.queue. + + + + Event for calling.call.record. + + + + Event for calling.call.refer. + + + + Base event — wraps the raw params dict from a signalwire.event message. + + + + Event for calling.call.send\_digits. + + + + Event for calling.call.stream. + + + + Event for calling.call.tap. + + + + Event for calling.call.transcribe. + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/message-receive-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/message-receive-event/from-payload.mdx new file mode 100644 index 0000000000..285a4e61f9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/message-receive-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/message-receive-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.MessageReceiveEvent.from_payload" + parent: "signalwire.relay.event.MessageReceiveEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'MessageReceiveEvent' +``` + +## Parameters + + + +## Returns + +`'MessageReceiveEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 545. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/message-receive-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/message-receive-event/index.mdx new file mode 100644 index 0000000000..31f40d0718 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/message-receive-event/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/python/signalwire/relay/event/message-receive-event" +title: "MessageReceiveEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.MessageReceiveEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `MessageReceiveEvent` + +Event for messaging.receive — inbound message notification. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class MessageReceiveEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 530. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/message-receive-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/message-receive-event/init.mdx new file mode 100644 index 0000000000..59b267a953 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/message-receive-event/init.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/python/signalwire/relay/event/message-receive-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.MessageReceiveEvent.__init__" + parent: "signalwire.relay.event.MessageReceiveEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + message_id: str = '', + context: str = '', + direction: str = '', + from_number: str = '', + to_number: str = '', + body: str = '', + media: list[str] = list(), + segments: int = 0, + message_state: str = '', + tags: list[str] = list() +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/message-state-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/message-state-event/from-payload.mdx new file mode 100644 index 0000000000..eeb883f68a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/message-state-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/message-state-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.MessageStateEvent.from_payload" + parent: "signalwire.relay.event.MessageStateEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'MessageStateEvent' +``` + +## Parameters + + + +## Returns + +`'MessageStateEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 583. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/message-state-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/message-state-event/index.mdx new file mode 100644 index 0000000000..0374adcc1a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/message-state-event/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/python/signalwire/relay/event/message-state-event" +title: "MessageStateEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.MessageStateEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `MessageStateEvent` + +Event for messaging.state — outbound message state change. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class MessageStateEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 567. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/message-state-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/message-state-event/init.mdx new file mode 100644 index 0000000000..ba9db704fd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/message-state-event/init.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/python/signalwire/relay/event/message-state-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.MessageStateEvent.__init__" + parent: "signalwire.relay.event.MessageStateEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + message_id: str = '', + context: str = '', + direction: str = '', + from_number: str = '', + to_number: str = '', + body: str = '', + media: list[str] = list(), + segments: int = 0, + message_state: str = '', + reason: str = '', + tags: list[str] = list() +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/parse-event.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/parse-event.mdx new file mode 100644 index 0000000000..f3b5f4075f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/parse-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/relay/event/parse-event" +title: "parse_event" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.relay.event.parse_event" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `parse_event` + +Parse a raw signalwire.event params dict into a typed event object. + +## Signature + +```python +parse_event(payload: dict[str, Any]) -> RelayEvent +``` + +## Parameters + + + +## Returns + +`RelayEvent` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 634. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/pay-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/pay-event/from-payload.mdx new file mode 100644 index 0000000000..5bcc4b48eb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/pay-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/pay-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.PayEvent.from_payload" + parent: "signalwire.relay.event.PayEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'PayEvent' +``` + +## Parameters + + + +## Returns + +`'PayEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 376. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/pay-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/pay-event/index.mdx new file mode 100644 index 0000000000..8089543a13 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/pay-event/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/relay/event/pay-event" +title: "PayEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.PayEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `PayEvent` + +Event for calling.call.pay. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class PayEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 369. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/pay-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/pay-event/init.mdx new file mode 100644 index 0000000000..8bffe2a855 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/pay-event/init.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/python/signalwire/relay/event/pay-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.PayEvent.__init__" + parent: "signalwire.relay.event.PayEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + control_id: str = '', + state: str = '' +) -> None +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/play-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/play-event/from-payload.mdx new file mode 100644 index 0000000000..ff6a1a72b0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/play-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/play-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.PlayEvent.from_payload" + parent: "signalwire.relay.event.PlayEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'PlayEvent' +``` + +## Parameters + + + +## Returns + +`'PlayEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 99. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/play-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/play-event/index.mdx new file mode 100644 index 0000000000..e3f2f73531 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/play-event/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/relay/event/play-event" +title: "PlayEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.PlayEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `PlayEvent` + +Event for calling.call.play. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class PlayEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 92. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/play-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/play-event/init.mdx new file mode 100644 index 0000000000..7f787dbf8b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/play-event/init.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/python/signalwire/relay/event/play-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.PlayEvent.__init__" + parent: "signalwire.relay.event.PlayEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + control_id: str = '', + state: str = '' +) -> None +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/queue-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/queue-event/from-payload.mdx new file mode 100644 index 0000000000..a9b1ab06f8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/queue-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/queue-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.QueueEvent.from_payload" + parent: "signalwire.relay.event.QueueEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'QueueEvent' +``` + +## Parameters + + + +## Returns + +`'QueueEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 401. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/queue-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/queue-event/index.mdx new file mode 100644 index 0000000000..acab7271c3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/queue-event/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/python/signalwire/relay/event/queue-event" +title: "QueueEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.QueueEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `QueueEvent` + +Event for calling.call.queue. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class QueueEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 390. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/queue-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/queue-event/init.mdx new file mode 100644 index 0000000000..0de7d8fac8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/queue-event/init.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/python/signalwire/relay/event/queue-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.QueueEvent.__init__" + parent: "signalwire.relay.event.QueueEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + control_id: str = '', + status: str = '', + queue_id: str = '', + queue_name: str = '', + position: int = 0, + size: int = 0 +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/record-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/record-event/from-payload.mdx new file mode 100644 index 0000000000..4964f40710 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/record-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/record-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.RecordEvent.from_payload" + parent: "signalwire.relay.event.RecordEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'RecordEvent' +``` + +## Parameters + + + +## Returns + +`'RecordEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 124. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/record-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/record-event/index.mdx new file mode 100644 index 0000000000..f0da897642 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/record-event/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/python/signalwire/relay/event/record-event" +title: "RecordEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.RecordEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `RecordEvent` + +Event for calling.call.record. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class RecordEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 113. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/record-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/record-event/init.mdx new file mode 100644 index 0000000000..22afafc550 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/record-event/init.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/python/signalwire/relay/event/record-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.RecordEvent.__init__" + parent: "signalwire.relay.event.RecordEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + control_id: str = '', + state: str = '', + url: str = '', + duration: float = 0.0, + size: int = 0, + record: dict[str, Any] = dict() +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/refer-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/refer-event/from-payload.mdx new file mode 100644 index 0000000000..7b2b332bb2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/refer-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/refer-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.ReferEvent.from_payload" + parent: "signalwire.relay.event.ReferEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'ReferEvent' +``` + +## Parameters + + + +## Returns + +`'ReferEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 334. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/refer-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/refer-event/index.mdx new file mode 100644 index 0000000000..e38a7d5726 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/refer-event/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/python/signalwire/relay/event/refer-event" +title: "ReferEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.ReferEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `ReferEvent` + +Event for calling.call.refer. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class ReferEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 325. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/refer-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/refer-event/init.mdx new file mode 100644 index 0000000000..6f235cce05 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/refer-event/init.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/relay/event/refer-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.ReferEvent.__init__" + parent: "signalwire.relay.event.ReferEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + state: str = '', + sip_refer_to: str = '', + sip_refer_response_code: str = '', + sip_notify_response_code: str = '' +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/relay-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/relay-event/from-payload.mdx new file mode 100644 index 0000000000..413131e1a5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/relay-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/relay-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.RelayEvent.from_payload" + parent: "signalwire.relay.event.RelayEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'RelayEvent' +``` + +## Parameters + + + +## Returns + +`'RelayEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/relay-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/relay-event/index.mdx new file mode 100644 index 0000000000..8f598a8db3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/relay-event/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/relay/event/relay-event" +title: "RelayEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.RelayEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `RelayEvent` + +Base event — wraps the raw params dict from a signalwire.event message. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class RelayEvent +``` + +## Properties + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 13. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/relay-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/relay-event/init.mdx new file mode 100644 index 0000000000..3c9465a6fa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/relay-event/init.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/relay/event/relay-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.RelayEvent.__init__" + parent: "signalwire.relay.event.RelayEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0 +) -> None +``` + +## Parameters + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/send-digits-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/send-digits-event/from-payload.mdx new file mode 100644 index 0000000000..9851833742 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/send-digits-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/send-digits-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.SendDigitsEvent.from_payload" + parent: "signalwire.relay.event.SendDigitsEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'SendDigitsEvent' +``` + +## Parameters + + + +## Returns + +`'SendDigitsEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 288. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/send-digits-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/send-digits-event/index.mdx new file mode 100644 index 0000000000..d4b3213470 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/send-digits-event/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/relay/event/send-digits-event" +title: "SendDigitsEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.SendDigitsEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `SendDigitsEvent` + +Event for calling.call.send\_digits. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class SendDigitsEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 281. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/send-digits-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/send-digits-event/init.mdx new file mode 100644 index 0000000000..9bea5e4caf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/send-digits-event/init.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/python/signalwire/relay/event/send-digits-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.SendDigitsEvent.__init__" + parent: "signalwire.relay.event.SendDigitsEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + control_id: str = '', + state: str = '' +) -> None +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/stream-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/stream-event/from-payload.mdx new file mode 100644 index 0000000000..d5a1151b0c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/stream-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/stream-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.StreamEvent.from_payload" + parent: "signalwire.relay.event.StreamEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'StreamEvent' +``` + +## Parameters + + + +## Returns + +`'StreamEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 265. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/stream-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/stream-event/index.mdx new file mode 100644 index 0000000000..ab4398ff31 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/stream-event/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/python/signalwire/relay/event/stream-event" +title: "StreamEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.StreamEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `StreamEvent` + +Event for calling.call.stream. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class StreamEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 256. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/stream-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/stream-event/init.mdx new file mode 100644 index 0000000000..f35373c0d2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/stream-event/init.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/relay/event/stream-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.StreamEvent.__init__" + parent: "signalwire.relay.event.StreamEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + control_id: str = '', + state: str = '', + url: str = '', + name: str = '' +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/tap-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/tap-event/from-payload.mdx new file mode 100644 index 0000000000..a05f170ef5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/tap-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/tap-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.TapEvent.from_payload" + parent: "signalwire.relay.event.TapEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'TapEvent' +``` + +## Parameters + + + +## Returns + +`'TapEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 240. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/tap-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/tap-event/index.mdx new file mode 100644 index 0000000000..4f8f6b1dc0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/tap-event/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/python/signalwire/relay/event/tap-event" +title: "TapEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.TapEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `TapEvent` + +Event for calling.call.tap. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class TapEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 231. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/tap-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/tap-event/init.mdx new file mode 100644 index 0000000000..fd03e15b94 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/tap-event/init.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/relay/event/tap-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.TapEvent.__init__" + parent: "signalwire.relay.event.TapEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + control_id: str = '', + state: str = '', + tap: dict[str, Any] = dict(), + device: dict[str, Any] = dict() +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/transcribe-event/from-payload.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/transcribe-event/from-payload.mdx new file mode 100644 index 0000000000..2c8c7e966c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/transcribe-event/from-payload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/relay/event/transcribe-event/from-payload" +title: "from_payload" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.TranscribeEvent.from_payload" + parent: "signalwire.relay.event.TranscribeEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `from_payload` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +from_payload(payload: dict[str, Any]) -> 'TranscribeEvent' +``` + +## Parameters + + + +## Returns + +`'TranscribeEvent'` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 449. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/transcribe-event/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/transcribe-event/index.mdx new file mode 100644 index 0000000000..1d9f195c8a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/transcribe-event/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/python/signalwire/relay/event/transcribe-event" +title: "TranscribeEvent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.event.TranscribeEvent" + parent: "signalwire.relay.event" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `TranscribeEvent` + +Event for calling.call.transcribe. + +**Modifiers:** `dataclass` + +**Decorators:** `@dataclass` + +## Signature + +```python +class TranscribeEvent(RelayEvent) +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/python/signalwire/relay/event/relay-event) + +## Properties + + + + + + + + + + + + + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) + +Line 438. diff --git a/fern/products/sdk-reference/python/signalwire/relay/event/transcribe-event/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/event/transcribe-event/init.mdx new file mode 100644 index 0000000000..18bc08d266 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/event/transcribe-event/init.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/python/signalwire/relay/event/transcribe-event/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.event.TranscribeEvent.__init__" + parent: "signalwire.relay.event.TranscribeEvent" + module: "signalwire.relay.event" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py" +--- +# `__init__` + +## Signature + +```python +__init__( + event_type: str, + params: dict[str, Any], + call_id: str = '', + timestamp: float = 0.0, + control_id: str = '', + state: str = '', + url: str = '', + recording_id: str = '', + duration: float = 0.0, + size: int = 0 +) -> None +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/event.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/event.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/index.mdx new file mode 100644 index 0000000000..01aca934cc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/python/signalwire/relay" +title: "relay" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.relay" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/__init__.py" +--- +# `relay` + +SignalWire RELAY client — real-time call control over WebSocket. + +## Signature + +```python +module relay +``` + +## Properties + + + +## Modules + + + + Call object — represents a live RELAY call with command methods. + + + + RelayClient — WebSocket + JSON-RPC 2.0 protocol + event dispatch. + + + + Protocol constants for the SignalWire RELAY calling API. + + + + Typed event wrappers for RELAY calling events. + + + + Message object — represents an SMS/MMS message in the RELAY messaging namespace. + + + +## Source + +[`signalwire/signalwire/relay/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/message/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/message/index.mdx new file mode 100644 index 0000000000..bd2ee1bd7d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/message/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/relay/message" +title: "message" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.relay.message" + parent: "signalwire.relay" + module: "signalwire.relay" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py" +--- +# `message` + +Message object — represents an SMS/MMS message in the RELAY messaging namespace. + +A Message tracks the lifecycle of a sent or received message via state events. +Outbound messages progress through: queued → initiated → sent → delivered (or +undelivered/failed). Inbound messages arrive fully formed with state "received". + +## Signature + +```python +module message +``` + +## Properties + + + +## Classes + + + + Represents a single SMS/MMS message. + + + +## Source + +[`signalwire/signalwire/relay/message.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py) diff --git a/fern/products/sdk-reference/python/signalwire/relay/message/message/index.mdx b/fern/products/sdk-reference/python/signalwire/relay/message/message/index.mdx new file mode 100644 index 0000000000..ef83d08dce --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/message/message/index.mdx @@ -0,0 +1,80 @@ +--- +slug: "/reference/python/signalwire/relay/message/message" +title: "Message" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.relay.message.Message" + parent: "signalwire.relay.message" + module: "signalwire.relay.message" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py" +--- +# `Message` + +Represents a single SMS/MMS message. + +For outbound messages, use `await message.wait()` to block until a +terminal state (delivered, undelivered, failed) is reached. + +## Signature + +```python +class Message +``` + +## Properties + + + + + + + + + + + True if the message has reached a terminal state. + + + + + + + + + + The terminal RelayEvent, or None if not yet done. + + + + + + + + + + +## Methods + + + + + + + + Register an event listener for state changes on this message. + + + + Block until the message reaches a terminal state. + + + +## Source + +[`signalwire/signalwire/relay/message.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py) + +Line 21. diff --git a/fern/products/sdk-reference/python/signalwire/relay/message/message/init.mdx b/fern/products/sdk-reference/python/signalwire/relay/message/message/init.mdx new file mode 100644 index 0000000000..6b0d729c40 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/message/message/init.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/python/signalwire/relay/message/message/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.message.Message.__init__" + parent: "signalwire.relay.message.Message" + module: "signalwire.relay.message" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py" +--- +# `__init__` + +## Signature + +```python +__init__( + *, + message_id: str = '', + context: str = '', + direction: str = '', + from_number: str = '', + to_number: str = '', + body: str = '', + media: Optional[list[str]] = None, + segments: int = 0, + state: str = '', + reason: str = '', + tags: Optional[list[str]] = None +) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/relay/message.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py) + +Line 28. diff --git a/fern/products/sdk-reference/python/signalwire/relay/message/message/on.mdx b/fern/products/sdk-reference/python/signalwire/relay/message/message/on.mdx new file mode 100644 index 0000000000..38077bc4b0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/message/message/on.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/relay/message/message/on" +title: "on" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.message.Message.on" + parent: "signalwire.relay.message.Message" + module: "signalwire.relay.message" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py" +--- +# `on` + +Register an event listener for state changes on this message. + +## Signature + +```python +on(handler: Callable) -> None +``` + +## Parameters + + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/relay/message.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py) + +Line 72. diff --git a/fern/products/sdk-reference/python/signalwire/relay/message/message/repr.mdx b/fern/products/sdk-reference/python/signalwire/relay/message/message/repr.mdx new file mode 100644 index 0000000000..ed1c41611b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/message/message/repr.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/relay/message/message/repr" +title: "__repr__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.message.Message.__repr__" + parent: "signalwire.relay.message.Message" + module: "signalwire.relay.message" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py" +--- +# `__repr__` + +## Signature + +```python +__repr__() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/relay/message.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py) + +Line 123. diff --git a/fern/products/sdk-reference/python/signalwire/relay/message/message/wait.mdx b/fern/products/sdk-reference/python/signalwire/relay/message/message/wait.mdx new file mode 100644 index 0000000000..e5496e7109 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/relay/message/message/wait.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/relay/message/message/wait" +title: "wait" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.relay.message.Message.wait" + parent: "signalwire.relay.message.Message" + module: "signalwire.relay.message" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py" +--- +# `wait` + +Block until the message reaches a terminal state. + +Returns the terminal RelayEvent. Raises asyncio.TimeoutError if +timeout is specified and exceeded. + +**Modifiers:** `async` + +## Signature + +```python +async wait(timeout: Optional[float] = None) -> RelayEvent +``` + +## Parameters + + + +## Returns + +`RelayEvent` + +## Source + +[`signalwire/signalwire/relay/message.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/relay/message.py) + +Line 76. diff --git a/fern/products/sdk-reference/python/signalwire/rest-client.mdx b/fern/products/sdk-reference/python/signalwire/rest-client.mdx new file mode 100644 index 0000000000..b554ec26b9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest-client.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/rest-client" +title: "RestClient" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.RestClient" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py" +--- +# `RestClient` + +Create a SignalWire REST API client (lazy import) + +## Signature + +```python +RestClient(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py) + +Line 131. diff --git a/fern/products/sdk-reference/python/signalwire/rest/call-handler/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/call-handler/index.mdx new file mode 100644 index 0000000000..5848773bb7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/call-handler/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/call-handler" +title: "call_handler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.call_handler" + parent: "signalwire.rest" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/call_handler.py" +--- +# `call_handler` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module call_handler +``` + +## Classes + + + + `call_handler` values for `phone_numbers.update`. + + + +## Source + +[`signalwire/signalwire/rest/call_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/call_handler.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/call-handler/phone-call-handler/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/call-handler/phone-call-handler/index.mdx new file mode 100644 index 0000000000..168570dd38 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/call-handler/phone-call-handler/index.mdx @@ -0,0 +1,80 @@ +--- +slug: "/reference/python/signalwire/rest/call-handler/phone-call-handler" +title: "PhoneCallHandler" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.call_handler.PhoneCallHandler" + parent: "signalwire.rest.call_handler" + module: "signalwire.rest.call_handler" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/call_handler.py" +--- +# `PhoneCallHandler` + +`call_handler` values for `phone_numbers.update`. + +Each value is a `str` subclass, so passing the enum member directly into +`phone_numbers.update(..., call_handler=PhoneCallHandler.RELAY_SCRIPT)` +serializes to the wire value without `.value` indirection. + +\================= ============================= ======================= +Enum member Companion field (required) Auto-creates resource +\================= ============================= ======================= +RELAY\_SCRIPT call\_relay\_script\_url swml\_webhook +LAML\_WEBHOOKS call\_request\_url cxml\_webhook +LAML\_APPLICATION call\_laml\_application\_id cxml\_application +AI\_AGENT call\_ai\_agent\_id ai\_agent +CALL\_FLOW call\_flow\_id call\_flow +RELAY\_APPLICATION call\_relay\_application relay\_application +RELAY\_TOPIC call\_relay\_topic (routes via RELAY) +RELAY\_CONTEXT call\_relay\_context (legacy, prefer topic) +RELAY\_CONNECTOR (connector config) (internal) +VIDEO\_ROOM call\_video\_room\_id (routes to Video API) +DIALOGFLOW call\_dialogflow\_agent\_id (none) +\================= ============================= ======================= + +Note: `LAML_WEBHOOKS` (wire value `laml_webhooks`) produces a **cXML** +handler, not a generic webhook. For SWML, use `RELAY_SCRIPT`. + +## Signature + +```python +class PhoneCallHandler(str, Enum) +``` + +## Inheritance + +**Extends:** `str`, `Enum` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/call_handler.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/call_handler.py) + +Line 25. diff --git a/fern/products/sdk-reference/python/signalwire/rest/client/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/client/index.mdx new file mode 100644 index 0000000000..3b9de2ec50 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/client/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/client" +title: "client" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.client" + parent: "signalwire.rest" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/client.py" +--- +# `client` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module client +``` + +## Classes + + + + REST client for the SignalWire platform APIs. + + + +## Source + +[`signalwire/signalwire/rest/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/client.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/client/rest-client/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/client/rest-client/index.mdx new file mode 100644 index 0000000000..4d8db3f1d4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/client/rest-client/index.mdx @@ -0,0 +1,115 @@ +--- +slug: "/reference/python/signalwire/rest/client/rest-client" +title: "RestClient" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.client.RestClient" + parent: "signalwire.rest.client" + module: "signalwire.rest.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/client.py" +--- +# `RestClient` + +REST client for the SignalWire platform APIs. + +> \[!NOTE] +> client = RestClient( +> project="your-project-id", +> token="your-api-token", +> host="your-space.signalwire.com", +> ) +> +> # Or use environment variables: +> +> # SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, SIGNALWIRE\_SPACE +> +> client = RestClient() +> +> # Use namespaced resources +> +> client.fabric.ai\_agents.list() +> client.calling.play(call\_id, play=\[...]) +> client.phone\_numbers.search(area\_code="512") +> client.video.rooms.create(name="standup") +> client.compat.calls.list() + +## Signature + +```python +class RestClient +``` + +## Examples + +```python +# Or use environment variables: +# SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, SIGNALWIRE_SPACE +client = RestClient() + +# Use namespaced resources +client.fabric.ai_agents.list() +client.calling.play(call_id, play=[...]) +client.phone_numbers.search(area_code="512") +client.video.rooms.create(name="standup") +client.compat.calls.list() +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/client.py) + +Line 39. diff --git a/fern/products/sdk-reference/python/signalwire/rest/client/rest-client/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/client/rest-client/init.mdx new file mode 100644 index 0000000000..81413cca19 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/client/rest-client/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/rest/client/rest-client/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.client.RestClient.__init__" + parent: "signalwire.rest.client.RestClient" + module: "signalwire.rest.client" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/client.py" +--- +# `__init__` + +## Signature + +```python +__init__(project = None, token = None, host = None) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/rest/client.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/client.py) + +Line 61. diff --git a/fern/products/sdk-reference/python/signalwire/rest/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/index.mdx new file mode 100644 index 0000000000..203ea05a0f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/rest" +title: "rest" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/__init__.py" +--- +# `rest` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module rest +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/rest/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/create.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/create.mdx new file mode 100644 index 0000000000..6307484f5c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/create.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/addresses/addresses-resource/create" +title: "create" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.addresses.AddressesResource.create" + parent: "signalwire.rest.namespaces.addresses.AddressesResource" + module: "signalwire.rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py" +--- +# `create` + +## Signature + +```python +create(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/addresses.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/delete.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/delete.mdx new file mode 100644 index 0000000000..024c0f2e03 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/delete.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/addresses/addresses-resource/delete" +title: "delete" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.addresses.AddressesResource.delete" + parent: "signalwire.rest.namespaces.addresses.AddressesResource" + module: "signalwire.rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py" +--- +# `delete` + +## Signature + +```python +delete(address_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/addresses.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py) + +Line 32. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/get.mdx new file mode 100644 index 0000000000..b49714f706 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/addresses/addresses-resource/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.addresses.AddressesResource.get" + parent: "signalwire.rest.namespaces.addresses.AddressesResource" + module: "signalwire.rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py" +--- +# `get` + +## Signature + +```python +get(address_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/addresses.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/index.mdx new file mode 100644 index 0000000000..e8efefd275 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/addresses/addresses-resource" +title: "AddressesResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.addresses.AddressesResource" + parent: "signalwire.rest.namespaces.addresses" + module: "signalwire.rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py" +--- +# `AddressesResource` + +Address management (no update endpoint). + +## Signature + +```python +class AddressesResource(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/addresses.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/init.mdx new file mode 100644 index 0000000000..2282bfc741 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/addresses/addresses-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.addresses.AddressesResource.__init__" + parent: "signalwire.rest.namespaces.addresses.AddressesResource" + module: "signalwire.rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/addresses.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/list.mdx new file mode 100644 index 0000000000..75f78c73dc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/addresses-resource/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/addresses/addresses-resource/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.addresses.AddressesResource.list" + parent: "signalwire.rest.namespaces.addresses.AddressesResource" + module: "signalwire.rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/addresses.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/index.mdx new file mode 100644 index 0000000000..a7c90056b8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/addresses/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/addresses" +title: "addresses" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.addresses" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py" +--- +# `addresses` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module addresses +``` + +## Classes + + + + Address management (no update endpoint). + + + +## Source + +[`signalwire/signalwire/rest/namespaces/addresses.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/addresses.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-hold.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-hold.mdx new file mode 100644 index 0000000000..7dba274246 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-hold.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-hold" +title: "ai_hold" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.ai_hold" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `ai_hold` + +## Signature + +```python +ai_hold(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 125. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-message.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-message.mdx new file mode 100644 index 0000000000..57886fa207 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-message.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-message" +title: "ai_message" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.ai_message" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `ai_message` + +## Signature + +```python +ai_message(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 122. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-stop.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-stop.mdx new file mode 100644 index 0000000000..5abb42f45d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-stop" +title: "ai_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.ai_stop" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `ai_stop` + +## Signature + +```python +ai_stop(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 131. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-unhold.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-unhold.mdx new file mode 100644 index 0000000000..213881ed56 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-unhold.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/ai-unhold" +title: "ai_unhold" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.ai_unhold" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `ai_unhold` + +## Signature + +```python +ai_unhold(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 128. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect-start-input-timers.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect-start-input-timers.mdx new file mode 100644 index 0000000000..f470888c5a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect-start-input-timers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect-start-input-timers" +title: "collect_start_input_timers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.collect_start_input_timers" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `collect_start_input_timers` + +## Signature + +```python +collect_start_input_timers(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 83. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect-stop.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect-stop.mdx new file mode 100644 index 0000000000..d669257d3d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect-stop" +title: "collect_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.collect_stop" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `collect_stop` + +## Signature + +```python +collect_stop(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 80. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect.mdx new file mode 100644 index 0000000000..4f08b229e1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/collect" +title: "collect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.collect" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `collect` + +## Signature + +```python +collect(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 77. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/denoise-stop.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/denoise-stop.mdx new file mode 100644 index 0000000000..f2b5bce27f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/denoise-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/denoise-stop" +title: "denoise_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.denoise_stop" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `denoise_stop` + +## Signature + +```python +denoise_stop(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 111. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/denoise.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/denoise.mdx new file mode 100644 index 0000000000..3f1e5c3792 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/denoise.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/denoise" +title: "denoise" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.denoise" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `denoise` + +## Signature + +```python +denoise(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 108. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/detect-stop.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/detect-stop.mdx new file mode 100644 index 0000000000..8609130909 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/detect-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/detect-stop" +title: "detect_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.detect_stop" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `detect_stop` + +## Signature + +```python +detect_stop(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 90. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/detect.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/detect.mdx new file mode 100644 index 0000000000..5ae971d303 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/detect.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/detect" +title: "detect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.detect" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `detect` + +## Signature + +```python +detect(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 87. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/dial.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/dial.mdx new file mode 100644 index 0000000000..68cab94ccd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/dial.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/dial" +title: "dial" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.dial" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `dial` + +## Signature + +```python +dial(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 32. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/disconnect.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/disconnect.mdx new file mode 100644 index 0000000000..18a2c3c16a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/disconnect.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/disconnect" +title: "disconnect" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.disconnect" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `disconnect` + +## Signature + +```python +disconnect(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 44. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/end.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/end.mdx new file mode 100644 index 0000000000..13f0356185 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/end.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/end" +title: "end" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.end" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `end` + +## Signature + +```python +end(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 38. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/index.mdx new file mode 100644 index 0000000000..24ec8ab87e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/index.mdx @@ -0,0 +1,113 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace" +title: "CallingNamespace" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace" + parent: "signalwire.rest.namespaces.calling" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `CallingNamespace` + +REST call control — all 37 commands dispatched via single POST endpoint. + +## Signature + +```python +class CallingNamespace(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 19. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/init.mdx new file mode 100644 index 0000000000..9233edc67c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.__init__" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/live-transcribe.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/live-transcribe.mdx new file mode 100644 index 0000000000..37de6a482c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/live-transcribe.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/live-transcribe" +title: "live_transcribe" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.live_transcribe" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `live_transcribe` + +## Signature + +```python +live_transcribe(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 135. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/live-translate.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/live-translate.mdx new file mode 100644 index 0000000000..d9b62b9525 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/live-translate.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/live-translate" +title: "live_translate" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.live_translate" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `live_translate` + +## Signature + +```python +live_translate(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 138. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-pause.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-pause.mdx new file mode 100644 index 0000000000..ffc7bd68c7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-pause.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-pause" +title: "play_pause" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.play_pause" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `play_pause` + +## Signature + +```python +play_pause(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 51. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-resume.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-resume.mdx new file mode 100644 index 0000000000..78d35c1f8e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-resume.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-resume" +title: "play_resume" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.play_resume" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `play_resume` + +## Signature + +```python +play_resume(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 54. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-stop.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-stop.mdx new file mode 100644 index 0000000000..0bb56fa851 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-stop" +title: "play_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.play_stop" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `play_stop` + +## Signature + +```python +play_stop(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 57. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-volume.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-volume.mdx new file mode 100644 index 0000000000..bee2b88ffd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-volume.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/play-volume" +title: "play_volume" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.play_volume" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `play_volume` + +## Signature + +```python +play_volume(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 60. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play.mdx new file mode 100644 index 0000000000..7121498fb4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/play.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/play" +title: "play" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.play" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `play` + +## Signature + +```python +play(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 48. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/receive-fax-stop.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/receive-fax-stop.mdx new file mode 100644 index 0000000000..9df955724a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/receive-fax-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/receive-fax-stop" +title: "receive_fax_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.receive_fax_stop" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `receive_fax_stop` + +## Signature + +```python +receive_fax_stop(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 145. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-pause.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-pause.mdx new file mode 100644 index 0000000000..1d30d2a212 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-pause.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-pause" +title: "record_pause" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.record_pause" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `record_pause` + +## Signature + +```python +record_pause(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 67. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-resume.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-resume.mdx new file mode 100644 index 0000000000..04c5cbb277 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-resume.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-resume" +title: "record_resume" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.record_resume" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `record_resume` + +## Signature + +```python +record_resume(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 70. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-stop.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-stop.mdx new file mode 100644 index 0000000000..6524787430 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/record-stop" +title: "record_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.record_stop" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `record_stop` + +## Signature + +```python +record_stop(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 73. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record.mdx new file mode 100644 index 0000000000..b01250380a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/record.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/record" +title: "record" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.record" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `record` + +## Signature + +```python +record(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 64. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/refer.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/refer.mdx new file mode 100644 index 0000000000..367934811f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/refer.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/refer" +title: "refer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.refer" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `refer` + +## Signature + +```python +refer(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 149. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/send-fax-stop.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/send-fax-stop.mdx new file mode 100644 index 0000000000..19a8b51fb9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/send-fax-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/send-fax-stop" +title: "send_fax_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.send_fax_stop" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `send_fax_stop` + +## Signature + +```python +send_fax_stop(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 142. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/stream-stop.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/stream-stop.mdx new file mode 100644 index 0000000000..f72c4d9916 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/stream-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/stream-stop" +title: "stream_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.stream_stop" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `stream_stop` + +## Signature + +```python +stream_stop(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 104. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/stream.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/stream.mdx new file mode 100644 index 0000000000..1c32dddafc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/stream.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/stream" +title: "stream" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.stream" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `stream` + +## Signature + +```python +stream(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 101. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/tap-stop.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/tap-stop.mdx new file mode 100644 index 0000000000..1e97a4df8b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/tap-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/tap-stop" +title: "tap_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.tap_stop" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `tap_stop` + +## Signature + +```python +tap_stop(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 97. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/tap.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/tap.mdx new file mode 100644 index 0000000000..afc4824b4c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/tap.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/tap" +title: "tap" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.tap" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `tap` + +## Signature + +```python +tap(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 94. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/transcribe-stop.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/transcribe-stop.mdx new file mode 100644 index 0000000000..47ab9b981c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/transcribe-stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/transcribe-stop" +title: "transcribe_stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.transcribe_stop" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `transcribe_stop` + +## Signature + +```python +transcribe_stop(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 118. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/transcribe.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/transcribe.mdx new file mode 100644 index 0000000000..a1cf301655 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/transcribe.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/transcribe" +title: "transcribe" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.transcribe" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `transcribe` + +## Signature + +```python +transcribe(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 115. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/transfer.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/transfer.mdx new file mode 100644 index 0000000000..cbd5c50bb5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/transfer.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/transfer" +title: "transfer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.transfer" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `transfer` + +## Signature + +```python +transfer(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 41. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/update.mdx new file mode 100644 index 0000000000..955edbb842 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/update.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.update" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `update` + +## Signature + +```python +update(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 35. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/user-event.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/user-event.mdx new file mode 100644 index 0000000000..67765f3f41 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/calling-namespace/user-event.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling/calling-namespace/user-event" +title: "user_event" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling.CallingNamespace.user_event" + parent: "signalwire.rest.namespaces.calling.CallingNamespace" + module: "signalwire.rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `user_event` + +## Signature + +```python +user_event(call_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) + +Line 153. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/index.mdx new file mode 100644 index 0000000000..a643f3a00c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/calling/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/calling" +title: "calling" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.calling" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py" +--- +# `calling` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module calling +``` + +## Classes + + + + REST call control — all 37 commands dispatched via single POST endpoint. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/calling.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/calling.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/chat-resource/create-token.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/chat-resource/create-token.mdx new file mode 100644 index 0000000000..321f409ade --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/chat-resource/create-token.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/chat/chat-resource/create-token" +title: "create_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.chat.ChatResource.create_token" + parent: "signalwire.rest.namespaces.chat.ChatResource" + module: "signalwire.rest.namespaces.chat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/chat.py" +--- +# `create_token` + +## Signature + +```python +create_token(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/chat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/chat.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/chat-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/chat-resource/index.mdx new file mode 100644 index 0000000000..448d184053 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/chat-resource/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/chat/chat-resource" +title: "ChatResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.chat.ChatResource" + parent: "signalwire.rest.namespaces.chat" + module: "signalwire.rest.namespaces.chat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/chat.py" +--- +# `ChatResource` + +Chat token generation. + +## Signature + +```python +class ChatResource(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/chat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/chat.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/chat-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/chat-resource/init.mdx new file mode 100644 index 0000000000..7695b77ce4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/chat-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/chat/chat-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.chat.ChatResource.__init__" + parent: "signalwire.rest.namespaces.chat.ChatResource" + module: "signalwire.rest.namespaces.chat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/chat.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/chat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/chat.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/index.mdx new file mode 100644 index 0000000000..0fbfb41b2e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/chat/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/chat" +title: "chat" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.chat" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/chat.py" +--- +# `chat` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module chat +``` + +## Classes + + + + Chat token generation. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/chat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/chat.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/create.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/create.mdx new file mode 100644 index 0000000000..c1427b95e1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/create.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-accounts/create" +title: "create" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatAccounts.create" + parent: "signalwire.rest.namespaces.compat.CompatAccounts" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `create` + +## Signature + +```python +create(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/get.mdx new file mode 100644 index 0000000000..58a1c1a904 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-accounts/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatAccounts.get" + parent: "signalwire.rest.namespaces.compat.CompatAccounts" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `get` + +## Signature + +```python +get(sid) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/index.mdx new file mode 100644 index 0000000000..e890ea7f4d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-accounts" +title: "CompatAccounts" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatAccounts" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatAccounts` + +Compat account/subproject management. + +## Signature + +```python +class CompatAccounts(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/init.mdx new file mode 100644 index 0000000000..b72f52ceb4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-accounts/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatAccounts.__init__" + parent: "signalwire.rest.namespaces.compat.CompatAccounts" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/list.mdx new file mode 100644 index 0000000000..e202e8f802 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-accounts/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatAccounts.list" + parent: "signalwire.rest.namespaces.compat.CompatAccounts" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/update.mdx new file mode 100644 index 0000000000..55049895d9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-accounts/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-accounts/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatAccounts.update" + parent: "signalwire.rest.namespaces.compat.CompatAccounts" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update` + +## Signature + +```python +update(sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 32. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-applications/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-applications/index.mdx new file mode 100644 index 0000000000..7aa7a5973d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-applications/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-applications" +title: "CompatApplications" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatApplications" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatApplications` + +Compat application management. + +## Signature + +```python +class CompatApplications(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 184. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-applications/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-applications/update.mdx new file mode 100644 index 0000000000..5a0046dba6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-applications/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-applications/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatApplications.update" + parent: "signalwire.rest.namespaces.compat.CompatApplications" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update` + +## Signature + +```python +update(sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 187. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/index.mdx new file mode 100644 index 0000000000..18ba38d399 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-calls" +title: "CompatCalls" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatCalls" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatCalls` + +Compat call management with recording and stream sub-resources. + +## Signature + +```python +class CompatCalls(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 36. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/start-recording.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/start-recording.mdx new file mode 100644 index 0000000000..77d2080dc2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/start-recording.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-calls/start-recording" +title: "start_recording" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatCalls.start_recording" + parent: "signalwire.rest.namespaces.compat.CompatCalls" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `start_recording` + +## Signature + +```python +start_recording(call_sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 42. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/start-stream.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/start-stream.mdx new file mode 100644 index 0000000000..568a1b193d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/start-stream.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-calls/start-stream" +title: "start_stream" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatCalls.start_stream" + parent: "signalwire.rest.namespaces.compat.CompatCalls" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `start_stream` + +## Signature + +```python +start_stream(call_sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 48. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/stop-stream.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/stop-stream.mdx new file mode 100644 index 0000000000..e803bc8584 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/stop-stream.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-calls/stop-stream" +title: "stop_stream" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatCalls.stop_stream" + parent: "signalwire.rest.namespaces.compat.CompatCalls" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `stop_stream` + +## Signature + +```python +stop_stream(call_sid, stream_sid, **kwargs = {}) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 51. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/update-recording.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/update-recording.mdx new file mode 100644 index 0000000000..5b138ef4b8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/update-recording.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-calls/update-recording" +title: "update_recording" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatCalls.update_recording" + parent: "signalwire.rest.namespaces.compat.CompatCalls" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update_recording` + +## Signature + +```python +update_recording(call_sid, recording_sid, **kwargs = {}) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 45. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/update.mdx new file mode 100644 index 0000000000..0ca6a1a90c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-calls/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-calls/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatCalls.update" + parent: "signalwire.rest.namespaces.compat.CompatCalls" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update` + +## Signature + +```python +update(sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 39. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/delete-recording.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/delete-recording.mdx new file mode 100644 index 0000000000..072cad828a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/delete-recording.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/delete-recording" +title: "delete_recording" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.delete_recording" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `delete_recording` + +## Signature + +```python +delete_recording(conference_sid, recording_sid) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 134. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/get-participant.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/get-participant.mdx new file mode 100644 index 0000000000..da4192a0ef --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/get-participant.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/get-participant" +title: "get_participant" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.get_participant" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `get_participant` + +## Signature + +```python +get_participant(conference_sid, call_sid) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 106. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/get-recording.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/get-recording.mdx new file mode 100644 index 0000000000..afd1b7b0fd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/get-recording.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/get-recording" +title: "get_recording" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.get_recording" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `get_recording` + +## Signature + +```python +get_recording(conference_sid, recording_sid) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 125. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/get.mdx new file mode 100644 index 0000000000..61187db534 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.get" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `get` + +## Signature + +```python +get(sid) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 93. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/index.mdx new file mode 100644 index 0000000000..4e05857c8b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences" +title: "CompatConferences" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatConferences` + +Compat conference management with participants, recordings, and streams. + +## Signature + +```python +class CompatConferences(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 87. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/list-participants.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/list-participants.mdx new file mode 100644 index 0000000000..954916e146 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/list-participants.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/list-participants" +title: "list_participants" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.list_participants" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `list_participants` + +## Signature + +```python +list_participants(conference_sid, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 100. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/list-recordings.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/list-recordings.mdx new file mode 100644 index 0000000000..331024a68e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/list-recordings.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/list-recordings" +title: "list_recordings" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.list_recordings" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `list_recordings` + +## Signature + +```python +list_recordings(conference_sid, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 119. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/list.mdx new file mode 100644 index 0000000000..2088fcb1f1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.list" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 90. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/remove-participant.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/remove-participant.mdx new file mode 100644 index 0000000000..dea6b0bf1f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/remove-participant.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/remove-participant" +title: "remove_participant" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.remove_participant" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `remove_participant` + +## Signature + +```python +remove_participant(conference_sid, call_sid) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 115. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/start-stream.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/start-stream.mdx new file mode 100644 index 0000000000..98def32716 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/start-stream.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/start-stream" +title: "start_stream" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.start_stream" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `start_stream` + +## Signature + +```python +start_stream(conference_sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 138. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/stop-stream.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/stop-stream.mdx new file mode 100644 index 0000000000..fdb2444928 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/stop-stream.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/stop-stream" +title: "stop_stream" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.stop_stream" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `stop_stream` + +## Signature + +```python +stop_stream(conference_sid, stream_sid, **kwargs = {}) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 141. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/update-participant.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/update-participant.mdx new file mode 100644 index 0000000000..fe992ef70f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/update-participant.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/update-participant" +title: "update_participant" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.update_participant" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update_participant` + +## Signature + +```python +update_participant(conference_sid, call_sid, **kwargs = {}) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 109. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/update-recording.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/update-recording.mdx new file mode 100644 index 0000000000..4caeb8af54 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/update-recording.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/update-recording" +title: "update_recording" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.update_recording" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update_recording` + +## Signature + +```python +update_recording(conference_sid, recording_sid, **kwargs = {}) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 128. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/update.mdx new file mode 100644 index 0000000000..2ed53deb6d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-conferences/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-conferences/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatConferences.update" + parent: "signalwire.rest.namespaces.compat.CompatConferences" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update` + +## Signature + +```python +update(sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 96. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/delete-media.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/delete-media.mdx new file mode 100644 index 0000000000..2297bde4f4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/delete-media.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-faxes/delete-media" +title: "delete_media" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatFaxes.delete_media" + parent: "signalwire.rest.namespaces.compat.CompatFaxes" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `delete_media` + +## Signature + +```python +delete_media(fax_sid, media_sid) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 83. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/get-media.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/get-media.mdx new file mode 100644 index 0000000000..497cc690c4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/get-media.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-faxes/get-media" +title: "get_media" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatFaxes.get_media" + parent: "signalwire.rest.namespaces.compat.CompatFaxes" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `get_media` + +## Signature + +```python +get_media(fax_sid, media_sid) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 80. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/index.mdx new file mode 100644 index 0000000000..ca5bc35ea0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-faxes" +title: "CompatFaxes" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatFaxes" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatFaxes` + +Compat fax management with media sub-resources. + +## Signature + +```python +class CompatFaxes(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 71. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/list-media.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/list-media.mdx new file mode 100644 index 0000000000..e73fc81e6b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/list-media.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-faxes/list-media" +title: "list_media" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatFaxes.list_media" + parent: "signalwire.rest.namespaces.compat.CompatFaxes" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `list_media` + +## Signature + +```python +list_media(fax_sid, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 77. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/update.mdx new file mode 100644 index 0000000000..f883a7c001 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-faxes/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-faxes/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatFaxes.update" + parent: "signalwire.rest.namespaces.compat.CompatFaxes" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update` + +## Signature + +```python +update(sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 74. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-laml-bins/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-laml-bins/index.mdx new file mode 100644 index 0000000000..4923847b7f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-laml-bins/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-laml-bins" +title: "CompatLamlBins" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatLamlBins" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatLamlBins` + +Compat cXML/LaML script management. + +## Signature + +```python +class CompatLamlBins(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 191. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-laml-bins/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-laml-bins/update.mdx new file mode 100644 index 0000000000..e0988bc650 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-laml-bins/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-laml-bins/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatLamlBins.update" + parent: "signalwire.rest.namespaces.compat.CompatLamlBins" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update` + +## Signature + +```python +update(sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 194. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/delete-media.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/delete-media.mdx new file mode 100644 index 0000000000..c6ecf3a1b9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/delete-media.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-messages/delete-media" +title: "delete_media" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatMessages.delete_media" + parent: "signalwire.rest.namespaces.compat.CompatMessages" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `delete_media` + +## Signature + +```python +delete_media(message_sid, media_sid) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 67. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/get-media.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/get-media.mdx new file mode 100644 index 0000000000..84852f45bd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/get-media.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-messages/get-media" +title: "get_media" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatMessages.get_media" + parent: "signalwire.rest.namespaces.compat.CompatMessages" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `get_media` + +## Signature + +```python +get_media(message_sid, media_sid) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 64. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/index.mdx new file mode 100644 index 0000000000..f92c11f81f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-messages" +title: "CompatMessages" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatMessages" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatMessages` + +Compat message management with media sub-resources. + +## Signature + +```python +class CompatMessages(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 55. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/list-media.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/list-media.mdx new file mode 100644 index 0000000000..968aeb328c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/list-media.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-messages/list-media" +title: "list_media" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatMessages.list_media" + parent: "signalwire.rest.namespaces.compat.CompatMessages" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `list_media` + +## Signature + +```python +list_media(message_sid, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 61. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/update.mdx new file mode 100644 index 0000000000..216f3e6487 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-messages/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-messages/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatMessages.update" + parent: "signalwire.rest.namespaces.compat.CompatMessages" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update` + +## Signature + +```python +update(sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 58. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-namespace/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-namespace/index.mdx new file mode 100644 index 0000000000..81e2870ebe --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-namespace/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-namespace" +title: "CompatNamespace" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatNamespace" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatNamespace` + +Twilio-compatible LAML API namespace with AccountSid scoping. + +## Signature + +```python +class CompatNamespace +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 253. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-namespace/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-namespace/init.mdx new file mode 100644 index 0000000000..038ba57214 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-namespace/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-namespace/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatNamespace.__init__" + parent: "signalwire.rest.namespaces.compat.CompatNamespace" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `__init__` + +## Signature + +```python +__init__(http, account_sid) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 256. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/delete.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/delete.mdx new file mode 100644 index 0000000000..383fa37bdd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/delete.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/delete" +title: "delete" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatPhoneNumbers.delete" + parent: "signalwire.rest.namespaces.compat.CompatPhoneNumbers" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `delete` + +## Signature + +```python +delete(sid) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 167. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/get.mdx new file mode 100644 index 0000000000..f55b4384a4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatPhoneNumbers.get" + parent: "signalwire.rest.namespaces.compat.CompatPhoneNumbers" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `get` + +## Signature + +```python +get(sid) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 161. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/import-number.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/import-number.mdx new file mode 100644 index 0000000000..5f2d9f0ef6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/import-number.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/import-number" +title: "import_number" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatPhoneNumbers.import_number" + parent: "signalwire.rest.namespaces.compat.CompatPhoneNumbers" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `import_number` + +## Signature + +```python +import_number(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 170. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/index.mdx new file mode 100644 index 0000000000..fcc6c470de --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers" +title: "CompatPhoneNumbers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatPhoneNumbers" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatPhoneNumbers` + +Compat phone number management. + +## Signature + +```python +class CompatPhoneNumbers(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 148. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/init.mdx new file mode 100644 index 0000000000..ca6980a14d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatPhoneNumbers.__init__" + parent: "signalwire.rest.namespaces.compat.CompatPhoneNumbers" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `__init__` + +## Signature + +```python +__init__(http, base) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 151. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/list-available-countries.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/list-available-countries.mdx new file mode 100644 index 0000000000..2822955ffc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/list-available-countries.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/list-available-countries" +title: "list_available_countries" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatPhoneNumbers.list_available_countries" + parent: "signalwire.rest.namespaces.compat.CompatPhoneNumbers" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `list_available_countries` + +## Signature + +```python +list_available_countries(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 174. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/list.mdx new file mode 100644 index 0000000000..4b1db003e0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatPhoneNumbers.list" + parent: "signalwire.rest.namespaces.compat.CompatPhoneNumbers" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 155. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/purchase.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/purchase.mdx new file mode 100644 index 0000000000..69ab1c623b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/purchase.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/purchase" +title: "purchase" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatPhoneNumbers.purchase" + parent: "signalwire.rest.namespaces.compat.CompatPhoneNumbers" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `purchase` + +## Signature + +```python +purchase(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 158. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/search-local.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/search-local.mdx new file mode 100644 index 0000000000..9d7b637b9b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/search-local.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/search-local" +title: "search_local" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatPhoneNumbers.search_local" + parent: "signalwire.rest.namespaces.compat.CompatPhoneNumbers" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `search_local` + +## Signature + +```python +search_local(country, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 177. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/search-toll-free.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/search-toll-free.mdx new file mode 100644 index 0000000000..50c1178633 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/search-toll-free.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/search-toll-free" +title: "search_toll_free" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatPhoneNumbers.search_toll_free" + parent: "signalwire.rest.namespaces.compat.CompatPhoneNumbers" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `search_toll_free` + +## Signature + +```python +search_toll_free(country, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 180. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/update.mdx new file mode 100644 index 0000000000..0c4da3cbc0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-phone-numbers/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatPhoneNumbers.update" + parent: "signalwire.rest.namespaces.compat.CompatPhoneNumbers" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update` + +## Signature + +```python +update(sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 164. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/dequeue-member.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/dequeue-member.mdx new file mode 100644 index 0000000000..01846a6666 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/dequeue-member.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-queues/dequeue-member" +title: "dequeue_member" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatQueues.dequeue_member" + parent: "signalwire.rest.namespaces.compat.CompatQueues" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `dequeue_member` + +## Signature + +```python +dequeue_member(queue_sid, call_sid, **kwargs = {}) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 210. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/get-member.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/get-member.mdx new file mode 100644 index 0000000000..7722290056 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/get-member.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-queues/get-member" +title: "get_member" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatQueues.get_member" + parent: "signalwire.rest.namespaces.compat.CompatQueues" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `get_member` + +## Signature + +```python +get_member(queue_sid, call_sid) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 207. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/index.mdx new file mode 100644 index 0000000000..2b51ec1782 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-queues" +title: "CompatQueues" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatQueues" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatQueues` + +Compat queue management with members. + +## Signature + +```python +class CompatQueues(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 198. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/list-members.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/list-members.mdx new file mode 100644 index 0000000000..7463f60146 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/list-members.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-queues/list-members" +title: "list_members" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatQueues.list_members" + parent: "signalwire.rest.namespaces.compat.CompatQueues" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `list_members` + +## Signature + +```python +list_members(queue_sid, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 204. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/update.mdx new file mode 100644 index 0000000000..d5c735006a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-queues/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-queues/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatQueues.update" + parent: "signalwire.rest.namespaces.compat.CompatQueues" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update` + +## Signature + +```python +update(sid, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 201. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/delete.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/delete.mdx new file mode 100644 index 0000000000..1c195936f5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/delete.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-recordings/delete" +title: "delete" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatRecordings.delete" + parent: "signalwire.rest.namespaces.compat.CompatRecordings" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `delete` + +## Signature + +```python +delete(sid) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 223. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/get.mdx new file mode 100644 index 0000000000..0af8312da4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-recordings/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatRecordings.get" + parent: "signalwire.rest.namespaces.compat.CompatRecordings" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `get` + +## Signature + +```python +get(sid) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 220. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/index.mdx new file mode 100644 index 0000000000..b036fa3382 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-recordings" +title: "CompatRecordings" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatRecordings" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatRecordings` + +Compat recording management. + +## Signature + +```python +class CompatRecordings(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 214. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/list.mdx new file mode 100644 index 0000000000..1f2ce26807 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-recordings/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-recordings/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatRecordings.list" + parent: "signalwire.rest.namespaces.compat.CompatRecordings" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 217. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/create.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/create.mdx new file mode 100644 index 0000000000..dd06d8f6b7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/create.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-tokens/create" +title: "create" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatTokens.create" + parent: "signalwire.rest.namespaces.compat.CompatTokens" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `create` + +## Signature + +```python +create(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 243. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/delete.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/delete.mdx new file mode 100644 index 0000000000..0697dcad2b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/delete.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-tokens/delete" +title: "delete" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatTokens.delete" + parent: "signalwire.rest.namespaces.compat.CompatTokens" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `delete` + +## Signature + +```python +delete(token_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 249. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/index.mdx new file mode 100644 index 0000000000..c6fdaa2d13 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-tokens" +title: "CompatTokens" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatTokens" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatTokens` + +Compat API token management. + +## Signature + +```python +class CompatTokens(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 240. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/update.mdx new file mode 100644 index 0000000000..6419be7dbf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-tokens/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-tokens/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatTokens.update" + parent: "signalwire.rest.namespaces.compat.CompatTokens" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `update` + +## Signature + +```python +update(token_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 246. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/delete.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/delete.mdx new file mode 100644 index 0000000000..d5ff7574ef --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/delete.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/delete" +title: "delete" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatTranscriptions.delete" + parent: "signalwire.rest.namespaces.compat.CompatTranscriptions" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `delete` + +## Signature + +```python +delete(sid) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 236. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/get.mdx new file mode 100644 index 0000000000..8edf1b615e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatTranscriptions.get" + parent: "signalwire.rest.namespaces.compat.CompatTranscriptions" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `get` + +## Signature + +```python +get(sid) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 233. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/index.mdx new file mode 100644 index 0000000000..ba43471902 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-transcriptions" +title: "CompatTranscriptions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatTranscriptions" + parent: "signalwire.rest.namespaces.compat" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `CompatTranscriptions` + +Compat transcription management. + +## Signature + +```python +class CompatTranscriptions(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 227. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/list.mdx new file mode 100644 index 0000000000..66714274ed --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat/compat-transcriptions/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat.CompatTranscriptions.list" + parent: "signalwire.rest.namespaces.compat.CompatTranscriptions" + module: "signalwire.rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) + +Line 230. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/index.mdx new file mode 100644 index 0000000000..95efe6e4a0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/compat/index.mdx @@ -0,0 +1,88 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/compat" +title: "compat" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.compat" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py" +--- +# `compat` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module compat +``` + +## Classes + + + + Compat account/subproject management. + + + + Compat application management. + + + + Compat call management with recording and stream sub-resources. + + + + Compat conference management with participants, recordings, and streams. + + + + Compat fax management with media sub-resources. + + + + Compat cXML/LaML script management. + + + + Compat message management with media sub-resources. + + + + Twilio-compatible LAML API namespace with AccountSid scoping. + + + + Compat phone number management. + + + + Compat queue management with members. + + + + Compat recording management. + + + + Compat API token management. + + + + Compat transcription management. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/compat.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/compat.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/delete-chunk.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/delete-chunk.mdx new file mode 100644 index 0000000000..aff099475c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/delete-chunk.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/delete-chunk" +title: "delete_chunk" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.datasphere.DatasphereDocuments.delete_chunk" + parent: "signalwire.rest.namespaces.datasphere.DatasphereDocuments" + module: "signalwire.rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py" +--- +# `delete_chunk` + +## Signature + +```python +delete_chunk(document_id, chunk_id) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/datasphere.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py) + +Line 32. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/get-chunk.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/get-chunk.mdx new file mode 100644 index 0000000000..f2967ea691 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/get-chunk.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/get-chunk" +title: "get_chunk" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.datasphere.DatasphereDocuments.get_chunk" + parent: "signalwire.rest.namespaces.datasphere.DatasphereDocuments" + module: "signalwire.rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py" +--- +# `get_chunk` + +## Signature + +```python +get_chunk(document_id, chunk_id) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/datasphere.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/index.mdx new file mode 100644 index 0000000000..bda2f0ec55 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents" +title: "DatasphereDocuments" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.datasphere.DatasphereDocuments" + parent: "signalwire.rest.namespaces.datasphere" + module: "signalwire.rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py" +--- +# `DatasphereDocuments` + +Document management with search and chunk operations. + +## Signature + +```python +class DatasphereDocuments(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/datasphere.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/init.mdx new file mode 100644 index 0000000000..70e54d7b57 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.datasphere.DatasphereDocuments.__init__" + parent: "signalwire.rest.namespaces.datasphere.DatasphereDocuments" + module: "signalwire.rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/datasphere.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/list-chunks.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/list-chunks.mdx new file mode 100644 index 0000000000..e8fb5b463e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/list-chunks.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/list-chunks" +title: "list_chunks" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.datasphere.DatasphereDocuments.list_chunks" + parent: "signalwire.rest.namespaces.datasphere.DatasphereDocuments" + module: "signalwire.rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py" +--- +# `list_chunks` + +## Signature + +```python +list_chunks(document_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/datasphere.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/search.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/search.mdx new file mode 100644 index 0000000000..088e64bbe7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/search.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/datasphere/datasphere-documents/search" +title: "search" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.datasphere.DatasphereDocuments.search" + parent: "signalwire.rest.namespaces.datasphere.DatasphereDocuments" + module: "signalwire.rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py" +--- +# `search` + +## Signature + +```python +search(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/datasphere.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-namespace/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-namespace/index.mdx new file mode 100644 index 0000000000..3d016f7d8b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-namespace/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/datasphere/datasphere-namespace" +title: "DatasphereNamespace" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.datasphere.DatasphereNamespace" + parent: "signalwire.rest.namespaces.datasphere" + module: "signalwire.rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py" +--- +# `DatasphereNamespace` + +Datasphere API namespace. + +## Signature + +```python +class DatasphereNamespace +``` + +## Properties + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/datasphere.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py) + +Line 36. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-namespace/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-namespace/init.mdx new file mode 100644 index 0000000000..121e718c11 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/datasphere-namespace/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/datasphere/datasphere-namespace/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.datasphere.DatasphereNamespace.__init__" + parent: "signalwire.rest.namespaces.datasphere.DatasphereNamespace" + module: "signalwire.rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/datasphere.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py) + +Line 39. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/index.mdx new file mode 100644 index 0000000000..425f933df9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/datasphere/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/datasphere" +title: "datasphere" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.datasphere" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py" +--- +# `datasphere` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module datasphere +``` + +## Classes + + + + Document management with search and chunk operations. + + + + Datasphere API namespace. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/datasphere.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/datasphere.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/auto-materialized-webhook/create.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/auto-materialized-webhook/create.mdx new file mode 100644 index 0000000000..e9a5174742 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/auto-materialized-webhook/create.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/auto-materialized-webhook/create" +title: "create" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.AutoMaterializedWebhook.create" + parent: "signalwire.rest.namespaces.fabric.AutoMaterializedWebhook" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `create` + +## Signature + +```python +create(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 41. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/auto-materialized-webhook/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/auto-materialized-webhook/index.mdx new file mode 100644 index 0000000000..6382b8c8f0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/auto-materialized-webhook/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/auto-materialized-webhook" +title: "AutoMaterializedWebhook" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.AutoMaterializedWebhook" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `AutoMaterializedWebhook` + +Fabric webhook resource that's normally auto-created by phone\_numbers.set\_\*. + +Exposed for backwards compatibility. The binding model for these resources +is on the phone number (see `phone_numbers.set_swml_webhook` / +`set_cxml_webhook`) — setting `call_handler` on a phone number +auto-materializes the webhook. Calling `create` here produces an orphan +resource that isn't bound to any phone number. + +## Signature + +```python +class AutoMaterializedWebhook(FabricResource) +``` + +## Inheritance + +**Extends:** [FabricResource](/reference/python/signalwire/rest/namespaces/fabric/fabric-resource) + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/deploy-version.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/deploy-version.mdx new file mode 100644 index 0000000000..ca7b02186a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/deploy-version.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/deploy-version" +title: "deploy_version" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.CallFlowsResource.deploy_version" + parent: "signalwire.rest.namespaces.fabric.CallFlowsResource" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `deploy_version` + +## Signature + +```python +deploy_version(resource_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 76. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/index.mdx new file mode 100644 index 0000000000..839e298c7b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/call-flows-resource" +title: "CallFlowsResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.CallFlowsResource" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `CallFlowsResource` + +Call flows with version management. + +Note: call\_flow (singular) is used in address/version paths per the API spec. + +## Signature + +```python +class CallFlowsResource(FabricResourcePUT) +``` + +## Inheritance + +**Extends:** [FabricResourcePUT](/reference/python/signalwire/rest/namespaces/fabric/fabric-resource-put) + +## Methods + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 61. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/list-addresses.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/list-addresses.mdx new file mode 100644 index 0000000000..14aa216a0b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/list-addresses.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/list-addresses" +title: "list_addresses" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.CallFlowsResource.list_addresses" + parent: "signalwire.rest.namespaces.fabric.CallFlowsResource" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `list_addresses` + +## Signature + +```python +list_addresses(resource_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 67. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/list-versions.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/list-versions.mdx new file mode 100644 index 0000000000..fbc2a3d557 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/list-versions.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/call-flows-resource/list-versions" +title: "list_versions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.CallFlowsResource.list_versions" + parent: "signalwire.rest.namespaces.fabric.CallFlowsResource" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `list_versions` + +## Signature + +```python +list_versions(resource_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 72. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/conference-rooms-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/conference-rooms-resource/index.mdx new file mode 100644 index 0000000000..158f0b056a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/conference-rooms-resource/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/conference-rooms-resource" +title: "ConferenceRoomsResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.ConferenceRoomsResource" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `ConferenceRoomsResource` + +Conference rooms — uses singular 'conference\_room' for sub-resource paths. + +## Signature + +```python +class ConferenceRoomsResource(FabricResourcePUT) +``` + +## Inheritance + +**Extends:** [FabricResourcePUT](/reference/python/signalwire/rest/namespaces/fabric/fabric-resource-put) + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 81. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/conference-rooms-resource/list-addresses.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/conference-rooms-resource/list-addresses.mdx new file mode 100644 index 0000000000..71d1786f1b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/conference-rooms-resource/list-addresses.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/conference-rooms-resource/list-addresses" +title: "list_addresses" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.ConferenceRoomsResource.list_addresses" + parent: "signalwire.rest.namespaces.fabric.ConferenceRoomsResource" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `list_addresses` + +## Signature + +```python +list_addresses(resource_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 84. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/cxml-applications-resource/create.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/cxml-applications-resource/create.mdx new file mode 100644 index 0000000000..2785fef38f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/cxml-applications-resource/create.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/cxml-applications-resource/create" +title: "create" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.CxmlApplicationsResource.create" + parent: "signalwire.rest.namespaces.fabric.CxmlApplicationsResource" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `create` + +## Signature + +```python +create(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 124. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/cxml-applications-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/cxml-applications-resource/index.mdx new file mode 100644 index 0000000000..19c932f42f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/cxml-applications-resource/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/cxml-applications-resource" +title: "CxmlApplicationsResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.CxmlApplicationsResource" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `CxmlApplicationsResource` + +cXML applications — no create method (read/update/delete only). + +## Signature + +```python +class CxmlApplicationsResource(FabricResourcePUT) +``` + +## Inheritance + +**Extends:** [FabricResourcePUT](/reference/python/signalwire/rest/namespaces/fabric/fabric-resource-put) + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 121. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/cxml-webhooks-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/cxml-webhooks-resource/index.mdx new file mode 100644 index 0000000000..08bef8fb69 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/cxml-webhooks-resource/index.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/cxml-webhooks-resource" +title: "CxmlWebhooksResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.CxmlWebhooksResource" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `CxmlWebhooksResource` + +## Signature + +```python +class CxmlWebhooksResource(AutoMaterializedWebhook) +``` + +## Inheritance + +**Extends:** [AutoMaterializedWebhook](/reference/python/signalwire/rest/namespaces/fabric/auto-materialized-webhook) + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 57. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-addresses/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-addresses/get.mdx new file mode 100644 index 0000000000..2e8c3c7832 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-addresses/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-addresses/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricAddresses.get" + parent: "signalwire.rest.namespaces.fabric.FabricAddresses" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `get` + +## Signature + +```python +get(address_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 178. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-addresses/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-addresses/index.mdx new file mode 100644 index 0000000000..7bb03878cf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-addresses/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-addresses" +title: "FabricAddresses" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricAddresses" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `FabricAddresses` + +Read-only fabric addresses. + +## Signature + +```python +class FabricAddresses(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 172. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-addresses/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-addresses/list.mdx new file mode 100644 index 0000000000..522d2d4558 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-addresses/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-addresses/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricAddresses.list" + parent: "signalwire.rest.namespaces.fabric.FabricAddresses" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 175. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-namespace/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-namespace/index.mdx new file mode 100644 index 0000000000..8361ee8569 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-namespace/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-namespace" +title: "FabricNamespace" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricNamespace" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `FabricNamespace` + +Fabric API namespace grouping all resource types. + +## Signature + +```python +class FabricNamespace +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 204. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-namespace/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-namespace/init.mdx new file mode 100644 index 0000000000..2a2837657a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-namespace/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-namespace/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricNamespace.__init__" + parent: "signalwire.rest.namespaces.fabric.FabricNamespace" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 207. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-resource-put/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-resource-put/index.mdx new file mode 100644 index 0000000000..df98434f74 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-resource-put/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-resource-put" +title: "FabricResourcePUT" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricResourcePUT" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `FabricResourcePUT` + +Fabric resource that uses PUT for updates. + +## Signature + +```python +class FabricResourcePUT(CrudWithAddresses) +``` + +## Inheritance + +**Extends:** `CrudWithAddresses` + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 24. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-resource/index.mdx new file mode 100644 index 0000000000..b6c3e51e63 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-resource/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-resource" +title: "FabricResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricResource" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `FabricResource` + +Standard fabric resource with CRUD + addresses. + +## Signature + +```python +class FabricResource(CrudWithAddresses) +``` + +## Inheritance + +**Extends:** `CrudWithAddresses` + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 19. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-embed-token.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-embed-token.mdx new file mode 100644 index 0000000000..4110696f54 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-embed-token.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-embed-token" +title: "create_embed_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricTokens.create_embed_token" + parent: "signalwire.rest.namespaces.fabric.FabricTokens" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `create_embed_token` + +## Signature + +```python +create_embed_token(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 200. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-guest-token.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-guest-token.mdx new file mode 100644 index 0000000000..d2cd5ce8c7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-guest-token.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-guest-token" +title: "create_guest_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricTokens.create_guest_token" + parent: "signalwire.rest.namespaces.fabric.FabricTokens" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `create_guest_token` + +## Signature + +```python +create_guest_token(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 197. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-invite-token.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-invite-token.mdx new file mode 100644 index 0000000000..4c29f4345c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-invite-token.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-invite-token" +title: "create_invite_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricTokens.create_invite_token" + parent: "signalwire.rest.namespaces.fabric.FabricTokens" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `create_invite_token` + +## Signature + +```python +create_invite_token(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 194. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-subscriber-token.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-subscriber-token.mdx new file mode 100644 index 0000000000..ca016ab4a6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-subscriber-token.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/create-subscriber-token" +title: "create_subscriber_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricTokens.create_subscriber_token" + parent: "signalwire.rest.namespaces.fabric.FabricTokens" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `create_subscriber_token` + +## Signature + +```python +create_subscriber_token(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 188. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/index.mdx new file mode 100644 index 0000000000..03f3b1abaf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-tokens" +title: "FabricTokens" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricTokens" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `FabricTokens` + +Subscriber, guest, invite, and embed token creation. + +## Signature + +```python +class FabricTokens(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 182. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/init.mdx new file mode 100644 index 0000000000..44c7b209df --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricTokens.__init__" + parent: "signalwire.rest.namespaces.fabric.FabricTokens" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 185. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token.mdx new file mode 100644 index 0000000000..7c3bb67212 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token" +title: "refresh_subscriber_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.FabricTokens.refresh_subscriber_token" + parent: "signalwire.rest.namespaces.fabric.FabricTokens" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `refresh_subscriber_token` + +## Signature + +```python +refresh_subscriber_token(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 191. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/assign-domain-application.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/assign-domain-application.mdx new file mode 100644 index 0000000000..eac33845d0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/assign-domain-application.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/generic-resources/assign-domain-application" +title: "assign_domain_application" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.GenericResources.assign_domain_application" + parent: "signalwire.rest.namespaces.fabric.GenericResources" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `assign_domain_application` + +## Signature + +```python +assign_domain_application(resource_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 168. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/assign-phone-route.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/assign-phone-route.mdx new file mode 100644 index 0000000000..e36f7b55d8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/assign-phone-route.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/generic-resources/assign-phone-route" +title: "assign_phone_route" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.GenericResources.assign_phone_route" + parent: "signalwire.rest.namespaces.fabric.GenericResources" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `assign_phone_route` + +Deprecated for the common binding cases. Use `phone_numbers.set_*` helpers. + +This endpoint (`POST /api/fabric/resources/{id}/phone_routes`) accepts +only a narrow set of legacy resource types as the attach target. It +**does not work** for `swml_webhook` / `cxml_webhook` / `ai_agent` +bindings — those are configured on the phone number and the Fabric +resource is auto-materialized (see `phone_numbers.set_swml_webhook` +etc.). The authoritative list of accepting resource types lives in the +OpenAPI spec; routing here for those types returns 404 or 422. + +## Signature + +```python +assign_phone_route(resource_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 146. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/delete.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/delete.mdx new file mode 100644 index 0000000000..576774eaf1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/delete.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/generic-resources/delete" +title: "delete" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.GenericResources.delete" + parent: "signalwire.rest.namespaces.fabric.GenericResources" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `delete` + +## Signature + +```python +delete(resource_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 137. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/get.mdx new file mode 100644 index 0000000000..9902a42864 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/generic-resources/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.GenericResources.get" + parent: "signalwire.rest.namespaces.fabric.GenericResources" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `get` + +## Signature + +```python +get(resource_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 134. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/index.mdx new file mode 100644 index 0000000000..4012df17e6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/generic-resources" +title: "GenericResources" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.GenericResources" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `GenericResources` + +Generic resource operations across all fabric resource types. + +## Signature + +```python +class GenericResources(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Deprecated for the common binding cases. Use `phone_numbers.set_*` helpers. + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 128. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/list-addresses.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/list-addresses.mdx new file mode 100644 index 0000000000..6e5c311d06 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/list-addresses.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/generic-resources/list-addresses" +title: "list_addresses" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.GenericResources.list_addresses" + parent: "signalwire.rest.namespaces.fabric.GenericResources" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `list_addresses` + +## Signature + +```python +list_addresses(resource_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 140. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/list.mdx new file mode 100644 index 0000000000..21064052d8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/generic-resources/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/generic-resources/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.GenericResources.list" + parent: "signalwire.rest.namespaces.fabric.GenericResources" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 131. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/index.mdx new file mode 100644 index 0000000000..c51566673d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/index.mdx @@ -0,0 +1,84 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric" +title: "fabric" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `fabric` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module fabric +``` + +## Classes + + + + Fabric webhook resource that's normally auto-created by phone\_numbers.set\_\*. + + + + Call flows with version management. + + + + Conference rooms — uses singular 'conference\_room' for sub-resource paths. + + + + cXML applications — no create method (read/update/delete only). + + + + + + Read-only fabric addresses. + + + + Fabric API namespace grouping all resource types. + + + + Standard fabric resource with CRUD + addresses. + + + + Fabric resource that uses PUT for updates. + + + + Subscriber, guest, invite, and embed token creation. + + + + Generic resource operations across all fabric resource types. + + + + Subscribers with SIP endpoint management. + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint.mdx new file mode 100644 index 0000000000..7a7874f933 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint" +title: "create_sip_endpoint" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.SubscribersResource.create_sip_endpoint" + parent: "signalwire.rest.namespaces.fabric.SubscribersResource" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `create_sip_endpoint` + +## Signature + +```python +create_sip_endpoint(subscriber_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 98. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint.mdx new file mode 100644 index 0000000000..6202b4ad5e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint" +title: "delete_sip_endpoint" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.SubscribersResource.delete_sip_endpoint" + parent: "signalwire.rest.namespaces.fabric.SubscribersResource" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `delete_sip_endpoint` + +## Signature + +```python +delete_sip_endpoint(subscriber_id, endpoint_id) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 115. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint.mdx new file mode 100644 index 0000000000..3276d9d554 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint" +title: "get_sip_endpoint" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.SubscribersResource.get_sip_endpoint" + parent: "signalwire.rest.namespaces.fabric.SubscribersResource" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `get_sip_endpoint` + +## Signature + +```python +get_sip_endpoint(subscriber_id, endpoint_id) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 104. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/index.mdx new file mode 100644 index 0000000000..f3b71690be --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/subscribers-resource" +title: "SubscribersResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.SubscribersResource" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `SubscribersResource` + +Subscribers with SIP endpoint management. + +## Signature + +```python +class SubscribersResource(FabricResourcePUT) +``` + +## Inheritance + +**Extends:** [FabricResourcePUT](/reference/python/signalwire/rest/namespaces/fabric/fabric-resource-put) + +## Methods + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 89. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints.mdx new file mode 100644 index 0000000000..51f3bb5c09 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints" +title: "list_sip_endpoints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.SubscribersResource.list_sip_endpoints" + parent: "signalwire.rest.namespaces.fabric.SubscribersResource" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `list_sip_endpoints` + +## Signature + +```python +list_sip_endpoints(subscriber_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 92. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint.mdx new file mode 100644 index 0000000000..c084259dca --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint" +title: "update_sip_endpoint" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.SubscribersResource.update_sip_endpoint" + parent: "signalwire.rest.namespaces.fabric.SubscribersResource" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `update_sip_endpoint` + +## Signature + +```python +update_sip_endpoint(subscriber_id, endpoint_id, **kwargs = {}) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 109. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/swml-webhooks-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/swml-webhooks-resource/index.mdx new file mode 100644 index 0000000000..401c5c3c36 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/fabric/swml-webhooks-resource/index.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/fabric/swml-webhooks-resource" +title: "SwmlWebhooksResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.fabric.SwmlWebhooksResource" + parent: "signalwire.rest.namespaces.fabric" + module: "signalwire.rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py" +--- +# `SwmlWebhooksResource` + +## Signature + +```python +class SwmlWebhooksResource(AutoMaterializedWebhook) +``` + +## Inheritance + +**Extends:** [AutoMaterializedWebhook](/reference/python/signalwire/rest/namespaces/fabric/auto-materialized-webhook) + +## Source + +[`signalwire/signalwire/rest/namespaces/fabric.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/fabric.py) + +Line 53. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource/create.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource/create.mdx new file mode 100644 index 0000000000..5388950c2d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource/create.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource/create" +title: "create" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.imported_numbers.ImportedNumbersResource.create" + parent: "signalwire.rest.namespaces.imported_numbers.ImportedNumbersResource" + module: "signalwire.rest.namespaces.imported_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/imported_numbers.py" +--- +# `create` + +## Signature + +```python +create(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/imported_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/imported_numbers.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource/index.mdx new file mode 100644 index 0000000000..fb23518297 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource" +title: "ImportedNumbersResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.imported_numbers.ImportedNumbersResource" + parent: "signalwire.rest.namespaces.imported_numbers" + module: "signalwire.rest.namespaces.imported_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/imported_numbers.py" +--- +# `ImportedNumbersResource` + +Import externally-hosted phone numbers. + +## Signature + +```python +class ImportedNumbersResource(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/imported_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/imported_numbers.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource/init.mdx new file mode 100644 index 0000000000..8a76cc9cf6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/imported-numbers/imported-numbers-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.imported_numbers.ImportedNumbersResource.__init__" + parent: "signalwire.rest.namespaces.imported_numbers.ImportedNumbersResource" + module: "signalwire.rest.namespaces.imported_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/imported_numbers.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/imported_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/imported_numbers.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/index.mdx new file mode 100644 index 0000000000..f9fce37b62 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/imported-numbers/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/imported-numbers" +title: "imported_numbers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.imported_numbers" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/imported_numbers.py" +--- +# `imported_numbers` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module imported_numbers +``` + +## Classes + + + + Import externally-hosted phone numbers. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/imported_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/imported_numbers.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/index.mdx new file mode 100644 index 0000000000..28f8fd8424 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/index.mdx @@ -0,0 +1,120 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces" +title: "namespaces" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces" + parent: "signalwire.rest" + module: "signalwire.rest" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/__init__.py" +--- +# `namespaces` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module namespaces +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/rest/namespaces/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/conference-logs/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/conference-logs/index.mdx new file mode 100644 index 0000000000..225409c6fc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/conference-logs/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/conference-logs" +title: "ConferenceLogs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.ConferenceLogs" + parent: "signalwire.rest.namespaces.logs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `ConferenceLogs` + +Conference log queries. + +## Signature + +```python +class ConferenceLogs(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 50. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/conference-logs/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/conference-logs/list.mdx new file mode 100644 index 0000000000..40238913b2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/conference-logs/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/conference-logs/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.ConferenceLogs.list" + parent: "signalwire.rest.namespaces.logs.ConferenceLogs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 53. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/fax-logs/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/fax-logs/get.mdx new file mode 100644 index 0000000000..542451e238 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/fax-logs/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/fax-logs/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.FaxLogs.get" + parent: "signalwire.rest.namespaces.logs.FaxLogs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `get` + +## Signature + +```python +get(log_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 46. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/fax-logs/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/fax-logs/index.mdx new file mode 100644 index 0000000000..b2b9e1a080 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/fax-logs/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/fax-logs" +title: "FaxLogs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.FaxLogs" + parent: "signalwire.rest.namespaces.logs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `FaxLogs` + +Fax log queries. + +## Signature + +```python +class FaxLogs(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 40. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/fax-logs/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/fax-logs/list.mdx new file mode 100644 index 0000000000..1c6f337f7d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/fax-logs/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/fax-logs/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.FaxLogs.list" + parent: "signalwire.rest.namespaces.logs.FaxLogs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 43. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/index.mdx new file mode 100644 index 0000000000..cb136f1242 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs" +title: "logs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `logs` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module logs +``` + +## Classes + + + + Conference log queries. + + + + Fax log queries. + + + + Logs API namespace. + + + + Message log queries. + + + + Voice log queries. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/logs-namespace/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/logs-namespace/index.mdx new file mode 100644 index 0000000000..38148d50a4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/logs-namespace/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/logs-namespace" +title: "LogsNamespace" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.LogsNamespace" + parent: "signalwire.rest.namespaces.logs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `LogsNamespace` + +Logs API namespace. + +## Signature + +```python +class LogsNamespace +``` + +## Properties + + + + + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 57. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/logs-namespace/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/logs-namespace/init.mdx new file mode 100644 index 0000000000..7e1638cb05 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/logs-namespace/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/logs-namespace/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.LogsNamespace.__init__" + parent: "signalwire.rest.namespaces.logs.LogsNamespace" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 60. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/message-logs/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/message-logs/get.mdx new file mode 100644 index 0000000000..101cea4fd6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/message-logs/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/message-logs/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.MessageLogs.get" + parent: "signalwire.rest.namespaces.logs.MessageLogs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `get` + +## Signature + +```python +get(log_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/message-logs/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/message-logs/index.mdx new file mode 100644 index 0000000000..28da3ed3c3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/message-logs/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/message-logs" +title: "MessageLogs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.MessageLogs" + parent: "signalwire.rest.namespaces.logs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `MessageLogs` + +Message log queries. + +## Signature + +```python +class MessageLogs(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/message-logs/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/message-logs/list.mdx new file mode 100644 index 0000000000..f10f29340b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/message-logs/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/message-logs/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.MessageLogs.list" + parent: "signalwire.rest.namespaces.logs.MessageLogs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/get.mdx new file mode 100644 index 0000000000..e34a774faf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/voice-logs/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.VoiceLogs.get" + parent: "signalwire.rest.namespaces.logs.VoiceLogs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `get` + +## Signature + +```python +get(log_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 33. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/index.mdx new file mode 100644 index 0000000000..3f1821052a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/voice-logs" +title: "VoiceLogs" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.VoiceLogs" + parent: "signalwire.rest.namespaces.logs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `VoiceLogs` + +Voice log queries. + +## Signature + +```python +class VoiceLogs(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 27. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/list-events.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/list-events.mdx new file mode 100644 index 0000000000..36ca370e54 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/list-events.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/voice-logs/list-events" +title: "list_events" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.VoiceLogs.list_events" + parent: "signalwire.rest.namespaces.logs.VoiceLogs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `list_events` + +## Signature + +```python +list_events(log_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 36. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/list.mdx new file mode 100644 index 0000000000..288b21c690 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/logs/voice-logs/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/logs/voice-logs/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.logs.VoiceLogs.list" + parent: "signalwire.rest.namespaces.logs.VoiceLogs" + module: "signalwire.rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/logs.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/logs.py) + +Line 30. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/index.mdx new file mode 100644 index 0000000000..0f40162dc3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/lookup" +title: "lookup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.lookup" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/lookup.py" +--- +# `lookup` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module lookup +``` + +## Classes + + + + Phone number lookup (carrier, CNAM). + + + +## Source + +[`signalwire/signalwire/rest/namespaces/lookup.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/lookup.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/lookup-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/lookup-resource/index.mdx new file mode 100644 index 0000000000..46bb1c7747 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/lookup-resource/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/lookup/lookup-resource" +title: "LookupResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.lookup.LookupResource" + parent: "signalwire.rest.namespaces.lookup" + module: "signalwire.rest.namespaces.lookup" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/lookup.py" +--- +# `LookupResource` + +Phone number lookup (carrier, CNAM). + +## Signature + +```python +class LookupResource(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/lookup.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/lookup.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/lookup-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/lookup-resource/init.mdx new file mode 100644 index 0000000000..7ccc2726f0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/lookup-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/lookup/lookup-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.lookup.LookupResource.__init__" + parent: "signalwire.rest.namespaces.lookup.LookupResource" + module: "signalwire.rest.namespaces.lookup" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/lookup.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/lookup.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/lookup.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/lookup-resource/phone-number.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/lookup-resource/phone-number.mdx new file mode 100644 index 0000000000..80b45785bd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/lookup/lookup-resource/phone-number.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/lookup/lookup-resource/phone-number" +title: "phone_number" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.lookup.LookupResource.phone_number" + parent: "signalwire.rest.namespaces.lookup.LookupResource" + module: "signalwire.rest.namespaces.lookup" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/lookup.py" +--- +# `phone_number` + +## Signature + +```python +phone_number(e164, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/lookup.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/lookup.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/index.mdx new file mode 100644 index 0000000000..0adc8183b4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/mfa" +title: "mfa" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.mfa" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py" +--- +# `mfa` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module mfa +``` + +## Classes + + + + Multi-factor authentication via SMS or phone call. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/mfa.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/call.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/call.mdx new file mode 100644 index 0000000000..651b76d262 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/call.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/mfa/mfa-resource/call" +title: "call" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.mfa.MfaResource.call" + parent: "signalwire.rest.namespaces.mfa.MfaResource" + module: "signalwire.rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py" +--- +# `call` + +## Signature + +```python +call(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/mfa.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/index.mdx new file mode 100644 index 0000000000..ecb334c9a2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/mfa/mfa-resource" +title: "MfaResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.mfa.MfaResource" + parent: "signalwire.rest.namespaces.mfa" + module: "signalwire.rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py" +--- +# `MfaResource` + +Multi-factor authentication via SMS or phone call. + +## Signature + +```python +class MfaResource(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/mfa.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/init.mdx new file mode 100644 index 0000000000..7655d0bbd4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/mfa/mfa-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.mfa.MfaResource.__init__" + parent: "signalwire.rest.namespaces.mfa.MfaResource" + module: "signalwire.rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/mfa.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/sms.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/sms.mdx new file mode 100644 index 0000000000..fa7f7d2cf5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/sms.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/mfa/mfa-resource/sms" +title: "sms" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.mfa.MfaResource.sms" + parent: "signalwire.rest.namespaces.mfa.MfaResource" + module: "signalwire.rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py" +--- +# `sms` + +## Signature + +```python +sms(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/mfa.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/verify.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/verify.mdx new file mode 100644 index 0000000000..981ea98761 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/mfa/mfa-resource/verify.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/mfa/mfa-resource/verify" +title: "verify" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.mfa.MfaResource.verify" + parent: "signalwire.rest.namespaces.mfa.MfaResource" + module: "signalwire.rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py" +--- +# `verify` + +## Signature + +```python +verify(request_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/mfa.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/mfa.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/index.mdx new file mode 100644 index 0000000000..e687dcc370 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/number-groups" +title: "number_groups" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.number_groups" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py" +--- +# `number_groups` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module number_groups +``` + +## Classes + + + + Number group management with membership operations. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/number_groups.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/add-membership.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/add-membership.mdx new file mode 100644 index 0000000000..5efe1890ab --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/add-membership.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/add-membership" +title: "add_membership" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.number_groups.NumberGroupsResource.add_membership" + parent: "signalwire.rest.namespaces.number_groups.NumberGroupsResource" + module: "signalwire.rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py" +--- +# `add_membership` + +## Signature + +```python +add_membership(group_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/number_groups.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py) + +Line 31. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/delete-membership.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/delete-membership.mdx new file mode 100644 index 0000000000..0ddd2e10f2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/delete-membership.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/delete-membership" +title: "delete_membership" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.number_groups.NumberGroupsResource.delete_membership" + parent: "signalwire.rest.namespaces.number_groups.NumberGroupsResource" + module: "signalwire.rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py" +--- +# `delete_membership` + +## Signature + +```python +delete_membership(membership_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/number_groups.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py) + +Line 40. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/get-membership.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/get-membership.mdx new file mode 100644 index 0000000000..181ddbf3ac --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/get-membership.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/get-membership" +title: "get_membership" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.number_groups.NumberGroupsResource.get_membership" + parent: "signalwire.rest.namespaces.number_groups.NumberGroupsResource" + module: "signalwire.rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py" +--- +# `get_membership` + +## Signature + +```python +get_membership(membership_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/number_groups.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py) + +Line 37. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/index.mdx new file mode 100644 index 0000000000..b8eb8193ac --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource" +title: "NumberGroupsResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.number_groups.NumberGroupsResource" + parent: "signalwire.rest.namespaces.number_groups" + module: "signalwire.rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py" +--- +# `NumberGroupsResource` + +Number group management with membership operations. + +## Signature + +```python +class NumberGroupsResource(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/number_groups.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/init.mdx new file mode 100644 index 0000000000..a83239060b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.number_groups.NumberGroupsResource.__init__" + parent: "signalwire.rest.namespaces.number_groups.NumberGroupsResource" + module: "signalwire.rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/number_groups.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/list-memberships.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/list-memberships.mdx new file mode 100644 index 0000000000..346227b37a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/list-memberships.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/number-groups/number-groups-resource/list-memberships" +title: "list_memberships" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.number_groups.NumberGroupsResource.list_memberships" + parent: "signalwire.rest.namespaces.number_groups.NumberGroupsResource" + module: "signalwire.rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py" +--- +# `list_memberships` + +## Signature + +```python +list_memberships(group_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/number_groups.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/number_groups.py) + +Line 25. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/index.mdx new file mode 100644 index 0000000000..c67dd346fc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/phone-numbers" +title: "phone_numbers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.phone_numbers" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py" +--- +# `phone_numbers` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module phone_numbers +``` + +## Classes + + + + Phone number management. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/phone_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/index.mdx new file mode 100644 index 0000000000..25b04e287c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource" +title: "PhoneNumbersResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource" + parent: "signalwire.rest.namespaces.phone_numbers" + module: "signalwire.rest.namespaces.phone_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py" +--- +# `PhoneNumbersResource` + +Phone number management. + +Supports the standard CRUD surface plus typed helpers for binding an +inbound call to a handler (SWML webhook, cXML webhook, AI agent, call +flow, RELAY application/topic). The binding model is: set +`call_handler` + the handler-specific companion field on the phone +number; the server auto-materializes the matching Fabric resource. +See :mod:`signalwire.rest.call_handler` for the enum, and the +porting-sdk's `phone-binding.md` for the full model. + +## Signature + +```python +class PhoneNumbersResource(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + + + Route inbound calls to an AI Agent Fabric resource by ID. + + + + Route inbound calls to a Call Flow by ID. + + + + Route inbound calls to an existing cXML application by ID. + + + + Route inbound calls to a cXML (Twilio-compat / LAML) webhook. + + + + Route inbound calls to a named RELAY application. + + + + Route inbound calls to a RELAY topic (client subscription). + + + + Route inbound calls to an SWML webhook URL. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/phone_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/init.mdx new file mode 100644 index 0000000000..588e825818 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource.__init__" + parent: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource" + module: "signalwire.rest.namespaces.phone_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/phone_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py) + +Line 34. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/search.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/search.mdx new file mode 100644 index 0000000000..9ab4615153 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/search.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/search" +title: "search" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource.search" + parent: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource" + module: "signalwire.rest.namespaces.phone_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py" +--- +# `search` + +## Signature + +```python +search(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/phone_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py) + +Line 37. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-ai-agent.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-ai-agent.mdx new file mode 100644 index 0000000000..5284d083f2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-ai-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-ai-agent" +title: "set_ai_agent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource.set_ai_agent" + parent: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource" + module: "signalwire.rest.namespaces.phone_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py" +--- +# `set_ai_agent` + +Route inbound calls to an AI Agent Fabric resource by ID. + +## Signature + +```python +set_ai_agent(resource_id: str, agent_id: str, **extra = {}) -> dict +``` + +## Parameters + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/rest/namespaces/phone_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py) + +Line 95. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-call-flow.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-call-flow.mdx new file mode 100644 index 0000000000..beef7f8352 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-call-flow.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-call-flow" +title: "set_call_flow" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource.set_call_flow" + parent: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource" + module: "signalwire.rest.namespaces.phone_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py" +--- +# `set_call_flow` + +Route inbound calls to a Call Flow by ID. + +`version` accepts `"working_copy"` or `"current_deployed"` +(server default when omitted). + +## Signature + +```python +set_call_flow( + resource_id: str, + flow_id: str, + version: Optional[str] = None, + **extra = {} +) -> dict +``` + +## Parameters + + + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/rest/namespaces/phone_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py) + +Line 104. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-application.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-application.mdx new file mode 100644 index 0000000000..0eb9f3ad3d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-application.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-application" +title: "set_cxml_application" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource.set_cxml_application" + parent: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource" + module: "signalwire.rest.namespaces.phone_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py" +--- +# `set_cxml_application` + +Route inbound calls to an existing cXML application by ID. + +## Signature + +```python +set_cxml_application( + resource_id: str, + application_id: str, + **extra = {} +) -> dict +``` + +## Parameters + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/rest/namespaces/phone_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py) + +Line 86. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-webhook.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-webhook.mdx new file mode 100644 index 0000000000..7732256b7f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-webhook.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-webhook" +title: "set_cxml_webhook" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource.set_cxml_webhook" + parent: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource" + module: "signalwire.rest.namespaces.phone_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py" +--- +# `set_cxml_webhook` + +Route inbound calls to a cXML (Twilio-compat / LAML) webhook. + +Despite the wire value `laml_webhooks` being plural, this creates +a single `cxml_webhook` Fabric resource. `fallback_url` is used +when the primary URL fails; `status_callback_url` receives call +status updates. + +## Signature + +```python +set_cxml_webhook( + resource_id: str, + url: str, + fallback_url: Optional[str] = None, + status_callback_url: Optional[str] = None, + **extra = {} +) -> dict +``` + +## Parameters + + + + + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/rest/namespaces/phone_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py) + +Line 60. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-application.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-application.mdx new file mode 100644 index 0000000000..a28f418f31 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-application.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-application" +title: "set_relay_application" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource.set_relay_application" + parent: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource" + module: "signalwire.rest.namespaces.phone_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py" +--- +# `set_relay_application` + +Route inbound calls to a named RELAY application. + +## Signature + +```python +set_relay_application(resource_id: str, name: str, **extra = {}) -> dict +``` + +## Parameters + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/rest/namespaces/phone_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py) + +Line 125. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-topic.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-topic.mdx new file mode 100644 index 0000000000..17cd978d52 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-topic.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-topic" +title: "set_relay_topic" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource.set_relay_topic" + parent: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource" + module: "signalwire.rest.namespaces.phone_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py" +--- +# `set_relay_topic` + +Route inbound calls to a RELAY topic (client subscription). + +## Signature + +```python +set_relay_topic( + resource_id: str, + topic: str, + status_callback_url: Optional[str] = None, + **extra = {} +) -> dict +``` + +## Parameters + + + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/rest/namespaces/phone_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py) + +Line 134. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook.mdx new file mode 100644 index 0000000000..5813719101 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook" +title: "set_swml_webhook" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource.set_swml_webhook" + parent: "signalwire.rest.namespaces.phone_numbers.PhoneNumbersResource" + module: "signalwire.rest.namespaces.phone_numbers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py" +--- +# `set_swml_webhook` + +Route inbound calls to an SWML webhook URL. + +Your backend returns an SWML document per call. The server +auto-creates a `swml_webhook` Fabric resource keyed off this URL. + +## Signature + +```python +set_swml_webhook(resource_id: str, url: str, **extra = {}) -> dict +``` + +## Parameters + + + + + + + +## Returns + +`dict` + +## Source + +[`signalwire/signalwire/rest/namespaces/phone_numbers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/phone_numbers.py) + +Line 47. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/index.mdx new file mode 100644 index 0000000000..91e6a19192 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/project" +title: "project" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.project" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py" +--- +# `project` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module project +``` + +## Classes + + + + Project API namespace. + + + + Project API token management. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-namespace/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-namespace/index.mdx new file mode 100644 index 0000000000..06576cf2eb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-namespace/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/project/project-namespace" +title: "ProjectNamespace" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.project.ProjectNamespace" + parent: "signalwire.rest.namespaces.project" + module: "signalwire.rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py" +--- +# `ProjectNamespace` + +Project API namespace. + +## Signature + +```python +class ProjectNamespace +``` + +## Properties + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py) + +Line 33. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-namespace/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-namespace/init.mdx new file mode 100644 index 0000000000..de160e64ed --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-namespace/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/project/project-namespace/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.project.ProjectNamespace.__init__" + parent: "signalwire.rest.namespaces.project.ProjectNamespace" + module: "signalwire.rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py) + +Line 36. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/create.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/create.mdx new file mode 100644 index 0000000000..7e671e6d05 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/create.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/project/project-tokens/create" +title: "create" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.project.ProjectTokens.create" + parent: "signalwire.rest.namespaces.project.ProjectTokens" + module: "signalwire.rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py" +--- +# `create` + +## Signature + +```python +create(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/delete.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/delete.mdx new file mode 100644 index 0000000000..ecad747849 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/delete.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/project/project-tokens/delete" +title: "delete" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.project.ProjectTokens.delete" + parent: "signalwire.rest.namespaces.project.ProjectTokens" + module: "signalwire.rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py" +--- +# `delete` + +## Signature + +```python +delete(token_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/index.mdx new file mode 100644 index 0000000000..fd5ec728b7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/project/project-tokens" +title: "ProjectTokens" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.project.ProjectTokens" + parent: "signalwire.rest.namespaces.project" + module: "signalwire.rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py" +--- +# `ProjectTokens` + +Project API token management. + +## Signature + +```python +class ProjectTokens(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/init.mdx new file mode 100644 index 0000000000..087a86e58a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/project/project-tokens/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.project.ProjectTokens.__init__" + parent: "signalwire.rest.namespaces.project.ProjectTokens" + module: "signalwire.rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/update.mdx new file mode 100644 index 0000000000..ca546b292c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/project/project-tokens/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/project/project-tokens/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.project.ProjectTokens.update" + parent: "signalwire.rest.namespaces.project.ProjectTokens" + module: "signalwire.rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py" +--- +# `update` + +## Signature + +```python +update(token_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/project.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/project.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/index.mdx new file mode 100644 index 0000000000..79835ecb0f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/pubsub" +title: "pubsub" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.pubsub" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/pubsub.py" +--- +# `pubsub` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module pubsub +``` + +## Classes + + + + PubSub token generation. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/pubsub.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/pubsub.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource/create-token.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource/create-token.mdx new file mode 100644 index 0000000000..86d60a415d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource/create-token.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource/create-token" +title: "create_token" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.pubsub.PubSubResource.create_token" + parent: "signalwire.rest.namespaces.pubsub.PubSubResource" + module: "signalwire.rest.namespaces.pubsub" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/pubsub.py" +--- +# `create_token` + +## Signature + +```python +create_token(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/pubsub.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/pubsub.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource/index.mdx new file mode 100644 index 0000000000..fa12cab96e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource" +title: "PubSubResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.pubsub.PubSubResource" + parent: "signalwire.rest.namespaces.pubsub" + module: "signalwire.rest.namespaces.pubsub" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/pubsub.py" +--- +# `PubSubResource` + +PubSub token generation. + +## Signature + +```python +class PubSubResource(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/pubsub.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/pubsub.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource/init.mdx new file mode 100644 index 0000000000..97484c6455 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/pubsub/pub-sub-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.pubsub.PubSubResource.__init__" + parent: "signalwire.rest.namespaces.pubsub.PubSubResource" + module: "signalwire.rest.namespaces.pubsub" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/pubsub.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/pubsub.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/pubsub.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/index.mdx new file mode 100644 index 0000000000..16ebba151a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/queues" +title: "queues" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.queues" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py" +--- +# `queues` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module queues +``` + +## Classes + + + + Queue management with member operations. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/queues.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/get-member.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/get-member.mdx new file mode 100644 index 0000000000..c2d8042b01 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/get-member.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/queues/queues-resource/get-member" +title: "get_member" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.queues.QueuesResource.get_member" + parent: "signalwire.rest.namespaces.queues.QueuesResource" + module: "signalwire.rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py" +--- +# `get_member` + +## Signature + +```python +get_member(queue_id, member_id) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/queues.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py) + +Line 31. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/get-next-member.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/get-next-member.mdx new file mode 100644 index 0000000000..50775c6380 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/get-next-member.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/queues/queues-resource/get-next-member" +title: "get_next_member" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.queues.QueuesResource.get_next_member" + parent: "signalwire.rest.namespaces.queues.QueuesResource" + module: "signalwire.rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py" +--- +# `get_next_member` + +## Signature + +```python +get_next_member(queue_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/queues.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py) + +Line 28. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/index.mdx new file mode 100644 index 0000000000..d1679c6397 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/queues/queues-resource" +title: "QueuesResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.queues.QueuesResource" + parent: "signalwire.rest.namespaces.queues" + module: "signalwire.rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py" +--- +# `QueuesResource` + +Queue management with member operations. + +## Signature + +```python +class QueuesResource(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/queues.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/init.mdx new file mode 100644 index 0000000000..89196a6c25 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/queues/queues-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.queues.QueuesResource.__init__" + parent: "signalwire.rest.namespaces.queues.QueuesResource" + module: "signalwire.rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/queues.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/list-members.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/list-members.mdx new file mode 100644 index 0000000000..c2b4e91925 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/queues/queues-resource/list-members.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/queues/queues-resource/list-members" +title: "list_members" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.queues.QueuesResource.list_members" + parent: "signalwire.rest.namespaces.queues.QueuesResource" + module: "signalwire.rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py" +--- +# `list_members` + +## Signature + +```python +list_members(queue_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/queues.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/queues.py) + +Line 25. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/index.mdx new file mode 100644 index 0000000000..a4a4a73648 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/recordings" +title: "recordings" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.recordings" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py" +--- +# `recordings` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module recordings +``` + +## Classes + + + + Recording management (read-only + delete). + + + +## Source + +[`signalwire/signalwire/rest/namespaces/recordings.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/delete.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/delete.mdx new file mode 100644 index 0000000000..83ebb75fe8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/delete.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/recordings/recordings-resource/delete" +title: "delete" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.recordings.RecordingsResource.delete" + parent: "signalwire.rest.namespaces.recordings.RecordingsResource" + module: "signalwire.rest.namespaces.recordings" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py" +--- +# `delete` + +## Signature + +```python +delete(recording_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/recordings.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/get.mdx new file mode 100644 index 0000000000..4b15ec7dc3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/recordings/recordings-resource/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.recordings.RecordingsResource.get" + parent: "signalwire.rest.namespaces.recordings.RecordingsResource" + module: "signalwire.rest.namespaces.recordings" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py" +--- +# `get` + +## Signature + +```python +get(recording_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/recordings.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/index.mdx new file mode 100644 index 0000000000..41dd269f52 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/recordings/recordings-resource" +title: "RecordingsResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.recordings.RecordingsResource" + parent: "signalwire.rest.namespaces.recordings" + module: "signalwire.rest.namespaces.recordings" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py" +--- +# `RecordingsResource` + +Recording management (read-only + delete). + +## Signature + +```python +class RecordingsResource(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/recordings.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/init.mdx new file mode 100644 index 0000000000..c31dc36829 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/recordings/recordings-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.recordings.RecordingsResource.__init__" + parent: "signalwire.rest.namespaces.recordings.RecordingsResource" + module: "signalwire.rest.namespaces.recordings" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/recordings.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/list.mdx new file mode 100644 index 0000000000..aa3d4edb06 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/recordings/recordings-resource/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/recordings/recordings-resource/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.recordings.RecordingsResource.list" + parent: "signalwire.rest.namespaces.recordings.RecordingsResource" + module: "signalwire.rest.namespaces.recordings" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/recordings.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/recordings.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/index.mdx new file mode 100644 index 0000000000..fb68a21ff7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry" +title: "registry" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `registry` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module registry +``` + +## Classes + + + + 10DLC brand management. + + + + 10DLC campaign management. + + + + 10DLC Campaign Registry namespace. + + + + 10DLC number assignment management. + + + + 10DLC assignment order management. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/create-campaign.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/create-campaign.mdx new file mode 100644 index 0000000000..2796e0eb29 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/create-campaign.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-brands/create-campaign" +title: "create_campaign" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryBrands.create_campaign" + parent: "signalwire.rest.namespaces.registry.RegistryBrands" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `create_campaign` + +## Signature + +```python +create_campaign(brand_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 32. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/create.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/create.mdx new file mode 100644 index 0000000000..079a671288 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/create.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-brands/create" +title: "create" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryBrands.create" + parent: "signalwire.rest.namespaces.registry.RegistryBrands" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `create` + +## Signature + +```python +create(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/get.mdx new file mode 100644 index 0000000000..91b3eb62e7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-brands/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryBrands.get" + parent: "signalwire.rest.namespaces.registry.RegistryBrands" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `get` + +## Signature + +```python +get(brand_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/index.mdx new file mode 100644 index 0000000000..a6108b13ce --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-brands" +title: "RegistryBrands" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryBrands" + parent: "signalwire.rest.namespaces.registry" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `RegistryBrands` + +10DLC brand management. + +## Signature + +```python +class RegistryBrands(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/list-campaigns.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/list-campaigns.mdx new file mode 100644 index 0000000000..eca0867cf1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/list-campaigns.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-brands/list-campaigns" +title: "list_campaigns" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryBrands.list_campaigns" + parent: "signalwire.rest.namespaces.registry.RegistryBrands" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `list_campaigns` + +## Signature + +```python +list_campaigns(brand_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/list.mdx new file mode 100644 index 0000000000..878885431a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-brands/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-brands/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryBrands.list" + parent: "signalwire.rest.namespaces.registry.RegistryBrands" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/create-order.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/create-order.mdx new file mode 100644 index 0000000000..62b74fc529 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/create-order.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-campaigns/create-order" +title: "create_order" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryCampaigns.create_order" + parent: "signalwire.rest.namespaces.registry.RegistryCampaigns" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `create_order` + +## Signature + +```python +create_order(campaign_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 51. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/get.mdx new file mode 100644 index 0000000000..1a7220ecbb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-campaigns/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryCampaigns.get" + parent: "signalwire.rest.namespaces.registry.RegistryCampaigns" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `get` + +## Signature + +```python +get(campaign_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 39. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/index.mdx new file mode 100644 index 0000000000..13a9e8bdaa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-campaigns" +title: "RegistryCampaigns" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryCampaigns" + parent: "signalwire.rest.namespaces.registry" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `RegistryCampaigns` + +10DLC campaign management. + +## Signature + +```python +class RegistryCampaigns(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 36. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/list-numbers.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/list-numbers.mdx new file mode 100644 index 0000000000..61d3db27c0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/list-numbers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-campaigns/list-numbers" +title: "list_numbers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryCampaigns.list_numbers" + parent: "signalwire.rest.namespaces.registry.RegistryCampaigns" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `list_numbers` + +## Signature + +```python +list_numbers(campaign_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 45. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/list-orders.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/list-orders.mdx new file mode 100644 index 0000000000..753abdd5be --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/list-orders.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-campaigns/list-orders" +title: "list_orders" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryCampaigns.list_orders" + parent: "signalwire.rest.namespaces.registry.RegistryCampaigns" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `list_orders` + +## Signature + +```python +list_orders(campaign_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 48. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/update.mdx new file mode 100644 index 0000000000..0b3ea79e25 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-campaigns/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-campaigns/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryCampaigns.update" + parent: "signalwire.rest.namespaces.registry.RegistryCampaigns" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `update` + +## Signature + +```python +update(campaign_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 42. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-namespace/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-namespace/index.mdx new file mode 100644 index 0000000000..1301fd83bc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-namespace/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-namespace" +title: "RegistryNamespace" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryNamespace" + parent: "signalwire.rest.namespaces.registry" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `RegistryNamespace` + +10DLC Campaign Registry namespace. + +## Signature + +```python +class RegistryNamespace +``` + +## Properties + + + + + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 69. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-namespace/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-namespace/init.mdx new file mode 100644 index 0000000000..7e234be794 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-namespace/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-namespace/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryNamespace.__init__" + parent: "signalwire.rest.namespaces.registry.RegistryNamespace" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 72. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-numbers/delete.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-numbers/delete.mdx new file mode 100644 index 0000000000..76ef49b131 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-numbers/delete.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-numbers/delete" +title: "delete" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryNumbers.delete" + parent: "signalwire.rest.namespaces.registry.RegistryNumbers" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `delete` + +## Signature + +```python +delete(number_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 65. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-numbers/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-numbers/index.mdx new file mode 100644 index 0000000000..f286396985 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-numbers/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-numbers" +title: "RegistryNumbers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryNumbers" + parent: "signalwire.rest.namespaces.registry" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `RegistryNumbers` + +10DLC number assignment management. + +## Signature + +```python +class RegistryNumbers(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 62. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-orders/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-orders/get.mdx new file mode 100644 index 0000000000..6b84eef08b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-orders/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-orders/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryOrders.get" + parent: "signalwire.rest.namespaces.registry.RegistryOrders" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `get` + +## Signature + +```python +get(order_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 58. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-orders/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-orders/index.mdx new file mode 100644 index 0000000000..d87fc99c65 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/registry/registry-orders/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/registry/registry-orders" +title: "RegistryOrders" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.registry.RegistryOrders" + parent: "signalwire.rest.namespaces.registry" + module: "signalwire.rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py" +--- +# `RegistryOrders` + +10DLC assignment order management. + +## Signature + +```python +class RegistryOrders(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/registry.py) + +Line 55. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/index.mdx new file mode 100644 index 0000000000..0d49471162 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/short-codes" +title: "short_codes" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.short_codes" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py" +--- +# `short_codes` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module short_codes +``` + +## Classes + + + + Short code management (read + update only). + + + +## Source + +[`signalwire/signalwire/rest/namespaces/short_codes.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/get.mdx new file mode 100644 index 0000000000..7dce6caef3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.short_codes.ShortCodesResource.get" + parent: "signalwire.rest.namespaces.short_codes.ShortCodesResource" + module: "signalwire.rest.namespaces.short_codes" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py" +--- +# `get` + +## Signature + +```python +get(short_code_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/short_codes.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/index.mdx new file mode 100644 index 0000000000..afcc3f268b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource" +title: "ShortCodesResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.short_codes.ShortCodesResource" + parent: "signalwire.rest.namespaces.short_codes" + module: "signalwire.rest.namespaces.short_codes" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py" +--- +# `ShortCodesResource` + +Short code management (read + update only). + +## Signature + +```python +class ShortCodesResource(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/short_codes.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/init.mdx new file mode 100644 index 0000000000..90bde3befb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.short_codes.ShortCodesResource.__init__" + parent: "signalwire.rest.namespaces.short_codes.ShortCodesResource" + module: "signalwire.rest.namespaces.short_codes" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/short_codes.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/list.mdx new file mode 100644 index 0000000000..f75283a703 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.short_codes.ShortCodesResource.list" + parent: "signalwire.rest.namespaces.short_codes.ShortCodesResource" + module: "signalwire.rest.namespaces.short_codes" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/short_codes.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/update.mdx new file mode 100644 index 0000000000..4587616a01 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/short-codes/short-codes-resource/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.short_codes.ShortCodesResource.update" + parent: "signalwire.rest.namespaces.short_codes.ShortCodesResource" + module: "signalwire.rest.namespaces.short_codes" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py" +--- +# `update` + +## Signature + +```python +update(short_code_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/short_codes.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/short_codes.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/index.mdx new file mode 100644 index 0000000000..56591e4acb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/sip-profile" +title: "sip_profile" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.sip_profile" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/sip_profile.py" +--- +# `sip_profile` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module sip_profile +``` + +## Classes + + + + Project SIP profile (singleton resource). + + + +## Source + +[`signalwire/signalwire/rest/namespaces/sip_profile.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/sip_profile.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/get.mdx new file mode 100644 index 0000000000..db9e6c11c7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/get.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.sip_profile.SipProfileResource.get" + parent: "signalwire.rest.namespaces.sip_profile.SipProfileResource" + module: "signalwire.rest.namespaces.sip_profile" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/sip_profile.py" +--- +# `get` + +## Signature + +```python +get() +``` + +## Source + +[`signalwire/signalwire/rest/namespaces/sip_profile.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/sip_profile.py) + +Line 23. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/index.mdx new file mode 100644 index 0000000000..52ad395fc7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource" +title: "SipProfileResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.sip_profile.SipProfileResource" + parent: "signalwire.rest.namespaces.sip_profile" + module: "signalwire.rest.namespaces.sip_profile" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/sip_profile.py" +--- +# `SipProfileResource` + +Project SIP profile (singleton resource). + +## Signature + +```python +class SipProfileResource(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/sip_profile.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/sip_profile.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/init.mdx new file mode 100644 index 0000000000..f70bd34e8d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.sip_profile.SipProfileResource.__init__" + parent: "signalwire.rest.namespaces.sip_profile.SipProfileResource" + module: "signalwire.rest.namespaces.sip_profile" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/sip_profile.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/sip_profile.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/sip_profile.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/update.mdx new file mode 100644 index 0000000000..630ab9a15f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/update.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/sip-profile/sip-profile-resource/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.sip_profile.SipProfileResource.update" + parent: "signalwire.rest.namespaces.sip_profile.SipProfileResource" + module: "signalwire.rest.namespaces.sip_profile" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/sip_profile.py" +--- +# `update` + +## Signature + +```python +update(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/sip_profile.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/sip_profile.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/index.mdx new file mode 100644 index 0000000000..67f882ee04 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/verified-callers" +title: "verified_callers" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.verified_callers" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/verified_callers.py" +--- +# `verified_callers` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module verified_callers +``` + +## Classes + + + + Verified caller ID management with verification flow. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/verified_callers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/verified_callers.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/index.mdx new file mode 100644 index 0000000000..86fa371196 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource" +title: "VerifiedCallersResource" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.verified_callers.VerifiedCallersResource" + parent: "signalwire.rest.namespaces.verified_callers" + module: "signalwire.rest.namespaces.verified_callers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/verified_callers.py" +--- +# `VerifiedCallersResource` + +Verified caller ID management with verification flow. + +## Signature + +```python +class VerifiedCallersResource(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/verified_callers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/verified_callers.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/init.mdx new file mode 100644 index 0000000000..93ac368aa7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.verified_callers.VerifiedCallersResource.__init__" + parent: "signalwire.rest.namespaces.verified_callers.VerifiedCallersResource" + module: "signalwire.rest.namespaces.verified_callers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/verified_callers.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/verified_callers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/verified_callers.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/redial-verification.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/redial-verification.mdx new file mode 100644 index 0000000000..cf78d24410 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/redial-verification.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/redial-verification" +title: "redial_verification" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.verified_callers.VerifiedCallersResource.redial_verification" + parent: "signalwire.rest.namespaces.verified_callers.VerifiedCallersResource" + module: "signalwire.rest.namespaces.verified_callers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/verified_callers.py" +--- +# `redial_verification` + +## Signature + +```python +redial_verification(caller_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/verified_callers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/verified_callers.py) + +Line 25. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/submit-verification.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/submit-verification.mdx new file mode 100644 index 0000000000..9a16cc390b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/submit-verification.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/verified-callers/verified-callers-resource/submit-verification" +title: "submit_verification" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.verified_callers.VerifiedCallersResource.submit_verification" + parent: "signalwire.rest.namespaces.verified_callers.VerifiedCallersResource" + module: "signalwire.rest.namespaces.verified_callers" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/verified_callers.py" +--- +# `submit_verification` + +## Signature + +```python +submit_verification(caller_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/verified_callers.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/verified_callers.py) + +Line 28. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/index.mdx new file mode 100644 index 0000000000..6c01e5a59c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video" +title: "video" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.rest.namespaces.video" + parent: "signalwire.rest.namespaces" + module: "signalwire.rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `video` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module video +``` + +## Classes + + + + Video conference management with tokens and streams. + + + + Video conference token management. + + + + Video API namespace. + + + + Video room recording management. + + + + Video room management with streams. + + + + Video room session management. + + + + Video room token generation. + + + + Video stream management. + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conference-tokens/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conference-tokens/get.mdx new file mode 100644 index 0000000000..321b2789a0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conference-tokens/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-conference-tokens/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoConferenceTokens.get" + parent: "signalwire.rest.namespaces.video.VideoConferenceTokens" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `get` + +## Signature + +```python +get(token_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 92. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conference-tokens/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conference-tokens/index.mdx new file mode 100644 index 0000000000..dd839256e8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conference-tokens/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-conference-tokens" +title: "VideoConferenceTokens" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoConferenceTokens" + parent: "signalwire.rest.namespaces.video" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `VideoConferenceTokens` + +Video conference token management. + +## Signature + +```python +class VideoConferenceTokens(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 89. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conference-tokens/reset.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conference-tokens/reset.mdx new file mode 100644 index 0000000000..1d4743e119 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conference-tokens/reset.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-conference-tokens/reset" +title: "reset" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoConferenceTokens.reset" + parent: "signalwire.rest.namespaces.video.VideoConferenceTokens" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `reset` + +## Signature + +```python +reset(token_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 95. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/create-stream.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/create-stream.mdx new file mode 100644 index 0000000000..a23685235a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/create-stream.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-conferences/create-stream" +title: "create_stream" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoConferences.create_stream" + parent: "signalwire.rest.namespaces.video.VideoConferences" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `create_stream` + +## Signature + +```python +create_stream(conference_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 85. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/index.mdx new file mode 100644 index 0000000000..539d2aee26 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-conferences" +title: "VideoConferences" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoConferences" + parent: "signalwire.rest.namespaces.video" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `VideoConferences` + +Video conference management with tokens and streams. + +## Signature + +```python +class VideoConferences(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 71. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/list-conference-tokens.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/list-conference-tokens.mdx new file mode 100644 index 0000000000..7d067aaab0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/list-conference-tokens.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-conferences/list-conference-tokens" +title: "list_conference_tokens" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoConferences.list_conference_tokens" + parent: "signalwire.rest.namespaces.video.VideoConferences" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `list_conference_tokens` + +## Signature + +```python +list_conference_tokens(conference_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 76. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/list-streams.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/list-streams.mdx new file mode 100644 index 0000000000..c964c5c42e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-conferences/list-streams.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-conferences/list-streams" +title: "list_streams" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoConferences.list_streams" + parent: "signalwire.rest.namespaces.video.VideoConferences" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `list_streams` + +## Signature + +```python +list_streams(conference_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 82. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-namespace/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-namespace/index.mdx new file mode 100644 index 0000000000..c4245353a8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-namespace/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-namespace" +title: "VideoNamespace" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoNamespace" + parent: "signalwire.rest.namespaces.video" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `VideoNamespace` + +Video API namespace. + +## Signature + +```python +class VideoNamespace +``` + +## Properties + + + + + + + + + + + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 112. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-namespace/init.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-namespace/init.mdx new file mode 100644 index 0000000000..9e57841ece --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-namespace/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-namespace/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoNamespace.__init__" + parent: "signalwire.rest.namespaces.video.VideoNamespace" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `__init__` + +## Signature + +```python +__init__(http) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 115. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/delete.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/delete.mdx new file mode 100644 index 0000000000..4d9403c500 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/delete.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-recordings/delete" +title: "delete" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomRecordings.delete" + parent: "signalwire.rest.namespaces.video.VideoRoomRecordings" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `delete` + +## Signature + +```python +delete(recording_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 64. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/get.mdx new file mode 100644 index 0000000000..0f3a07d142 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-recordings/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomRecordings.get" + parent: "signalwire.rest.namespaces.video.VideoRoomRecordings" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `get` + +## Signature + +```python +get(recording_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 61. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/index.mdx new file mode 100644 index 0000000000..b66b557c73 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-recordings" +title: "VideoRoomRecordings" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomRecordings" + parent: "signalwire.rest.namespaces.video" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `VideoRoomRecordings` + +Video room recording management. + +## Signature + +```python +class VideoRoomRecordings(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 55. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/list-events.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/list-events.mdx new file mode 100644 index 0000000000..38ccb472ab --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/list-events.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-recordings/list-events" +title: "list_events" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomRecordings.list_events" + parent: "signalwire.rest.namespaces.video.VideoRoomRecordings" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `list_events` + +## Signature + +```python +list_events(recording_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 67. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/list.mdx new file mode 100644 index 0000000000..648e33d53e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-recordings/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-recordings/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomRecordings.list" + parent: "signalwire.rest.namespaces.video.VideoRoomRecordings" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 58. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/get.mdx new file mode 100644 index 0000000000..f09bdd6806 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-sessions/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomSessions.get" + parent: "signalwire.rest.namespaces.video.VideoRoomSessions" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `get` + +## Signature + +```python +get(session_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 42. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/index.mdx new file mode 100644 index 0000000000..4f90af43ee --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-sessions" +title: "VideoRoomSessions" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomSessions" + parent: "signalwire.rest.namespaces.video" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `VideoRoomSessions` + +Video room session management. + +## Signature + +```python +class VideoRoomSessions(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 36. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-events.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-events.mdx new file mode 100644 index 0000000000..deea7546cb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-events.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-events" +title: "list_events" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomSessions.list_events" + parent: "signalwire.rest.namespaces.video.VideoRoomSessions" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `list_events` + +## Signature + +```python +list_events(session_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 45. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-members.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-members.mdx new file mode 100644 index 0000000000..d64fbaefe9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-members.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-members" +title: "list_members" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomSessions.list_members" + parent: "signalwire.rest.namespaces.video.VideoRoomSessions" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `list_members` + +## Signature + +```python +list_members(session_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 48. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-recordings.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-recordings.mdx new file mode 100644 index 0000000000..abbdf6618d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-recordings.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-sessions/list-recordings" +title: "list_recordings" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomSessions.list_recordings" + parent: "signalwire.rest.namespaces.video.VideoRoomSessions" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `list_recordings` + +## Signature + +```python +list_recordings(session_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 51. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list.mdx new file mode 100644 index 0000000000..1105b036b2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-sessions/list.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-sessions/list" +title: "list" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomSessions.list" + parent: "signalwire.rest.namespaces.video.VideoRoomSessions" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `list` + +## Signature + +```python +list(**params = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 39. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-tokens/create.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-tokens/create.mdx new file mode 100644 index 0000000000..38f02fded7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-tokens/create.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-tokens/create" +title: "create" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomTokens.create" + parent: "signalwire.rest.namespaces.video.VideoRoomTokens" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `create` + +## Signature + +```python +create(**kwargs = {}) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 32. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-tokens/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-tokens/index.mdx new file mode 100644 index 0000000000..e2598f25bb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-room-tokens/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-room-tokens" +title: "VideoRoomTokens" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRoomTokens" + parent: "signalwire.rest.namespaces.video" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `VideoRoomTokens` + +Video room token generation. + +## Signature + +```python +class VideoRoomTokens(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-rooms/create-stream.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-rooms/create-stream.mdx new file mode 100644 index 0000000000..ffefbb3e9b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-rooms/create-stream.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-rooms/create-stream" +title: "create_stream" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRooms.create_stream" + parent: "signalwire.rest.namespaces.video.VideoRooms" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `create_stream` + +## Signature + +```python +create_stream(room_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 25. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-rooms/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-rooms/index.mdx new file mode 100644 index 0000000000..c69605af5c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-rooms/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-rooms" +title: "VideoRooms" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRooms" + parent: "signalwire.rest.namespaces.video" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `VideoRooms` + +Video room management with streams. + +## Signature + +```python +class VideoRooms(CrudResource) +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-rooms/list-streams.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-rooms/list-streams.mdx new file mode 100644 index 0000000000..d00faddcd5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-rooms/list-streams.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-rooms/list-streams" +title: "list_streams" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoRooms.list_streams" + parent: "signalwire.rest.namespaces.video.VideoRooms" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `list_streams` + +## Signature + +```python +list_streams(room_id, **params = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/delete.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/delete.mdx new file mode 100644 index 0000000000..f10049b562 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/delete.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-streams/delete" +title: "delete" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoStreams.delete" + parent: "signalwire.rest.namespaces.video.VideoStreams" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `delete` + +## Signature + +```python +delete(stream_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 108. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/get.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/get.mdx new file mode 100644 index 0000000000..0091c07f7e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/get.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-streams/get" +title: "get" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoStreams.get" + parent: "signalwire.rest.namespaces.video.VideoStreams" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `get` + +## Signature + +```python +get(stream_id) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 102. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/index.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/index.mdx new file mode 100644 index 0000000000..74b44df2d6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-streams" +title: "VideoStreams" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoStreams" + parent: "signalwire.rest.namespaces.video" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `VideoStreams` + +Video stream management. + +## Signature + +```python +class VideoStreams(BaseResource) +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 99. diff --git a/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/update.mdx b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/update.mdx new file mode 100644 index 0000000000..0e36fd76e3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/rest/namespaces/video/video-streams/update.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/rest/namespaces/video/video-streams/update" +title: "update" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.rest.namespaces.video.VideoStreams.update" + parent: "signalwire.rest.namespaces.video.VideoStreams" + module: "signalwire.rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py" +--- +# `update` + +## Signature + +```python +update(stream_id, **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/rest/namespaces/video.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/rest/namespaces/video.py) + +Line 105. diff --git a/fern/products/sdk-reference/python/signalwire/run-agent.mdx b/fern/products/sdk-reference/python/signalwire/run-agent.mdx new file mode 100644 index 0000000000..3a385ce58e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/run-agent.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/run-agent" +title: "run_agent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.run_agent" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py" +--- +# `run_agent` + +Run an agent (lazy import) + +## Signature + +```python +run_agent(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py) + +Line 54. diff --git a/fern/products/sdk-reference/python/signalwire/search/document-processor/document-processor/create-chunks.mdx b/fern/products/sdk-reference/python/signalwire/search/document-processor/document-processor/create-chunks.mdx new file mode 100644 index 0000000000..5ff97b07e4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/document-processor/document-processor/create-chunks.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/search/document-processor/document-processor/create-chunks" +title: "create_chunks" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.document_processor.DocumentProcessor.create_chunks" + parent: "signalwire.search.document_processor.DocumentProcessor" + module: "signalwire.search.document_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/document_processor.py" +--- +# `create_chunks` + +Create chunks from document content using specified chunking strategy + +## Signature + +```python +create_chunks( + content: str, + filename: str, + file_type: str +) -> List[Dict[str, Any]] +``` + +## Parameters + + + Document content (string) - should be the actual content, not a file path + + + + Name of the file (for metadata) + + + + File extension/type + + +## Returns + +`List[Dict[str, Any]]` — List of chunk dictionaries + +## Source + +[`signalwire/signalwire/search/document_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/document_processor.py) + +Line 128. diff --git a/fern/products/sdk-reference/python/signalwire/search/document-processor/document-processor/index.mdx b/fern/products/sdk-reference/python/signalwire/search/document-processor/document-processor/index.mdx new file mode 100644 index 0000000000..db03b85f28 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/document-processor/document-processor/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/search/document-processor/document-processor" +title: "DocumentProcessor" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.document_processor.DocumentProcessor" + parent: "signalwire.search.document_processor" + module: "signalwire.search.document_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/document_processor.py" +--- +# `DocumentProcessor` + +Enhanced document processor with smart chunking capabilities + +## Signature + +```python +class DocumentProcessor +``` + +## Properties + + + + + + + + + + + + + + + +## Methods + + + + Initialize document processor + + + + Create chunks from document content using specified chunking strategy + + + +## Source + +[`signalwire/signalwire/search/document_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/document_processor.py) + +Line 79. diff --git a/fern/products/sdk-reference/python/signalwire/search/document-processor/document-processor/init.mdx b/fern/products/sdk-reference/python/signalwire/search/document-processor/document-processor/init.mdx new file mode 100644 index 0000000000..9b55ecf7f0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/document-processor/document-processor/init.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/python/signalwire/search/document-processor/document-processor/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.document_processor.DocumentProcessor.__init__" + parent: "signalwire.search.document_processor.DocumentProcessor" + module: "signalwire.search.document_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/document_processor.py" +--- +# `__init__` + +Initialize document processor + +## Signature + +```python +__init__( + chunking_strategy: str = 'sentence', + max_sentences_per_chunk: int = 5, + chunk_size: int = 50, + chunk_overlap: int = 10, + split_newlines: Optional[int] = None, + index_nlp_backend: str = 'nltk', + verbose: bool = False, + semantic_threshold: float = 0.5, + topic_threshold: float = 0.3 +) +``` + +## Parameters + + + Strategy for chunking documents: + + + + For sentence strategy (default: 5) + + + + For sliding strategy - words per chunk (default: 50) + + + + For sliding strategy - overlap in words (default: 10) + + + + For sentence strategy - split on multiple newlines (optional) + + + + NLP backend for indexing (default: 'nltk') + + + + Whether to enable verbose logging (default: False) + + + + Similarity threshold for semantic chunking (default: 0.5) + + + + Similarity threshold for topic chunking (default: 0.3) + + +## Source + +[`signalwire/signalwire/search/document_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/document_processor.py) + +Line 82. diff --git a/fern/products/sdk-reference/python/signalwire/search/document-processor/index.mdx b/fern/products/sdk-reference/python/signalwire/search/document-processor/index.mdx new file mode 100644 index 0000000000..217750d8e3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/document-processor/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/document-processor" +title: "DocumentProcessor" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.DocumentProcessor" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py" +--- +# `DocumentProcessor` + +## Signature + +```python +class DocumentProcessor +``` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py) + +Line 114. diff --git a/fern/products/sdk-reference/python/signalwire/search/document-processor/index__2.mdx b/fern/products/sdk-reference/python/signalwire/search/document-processor/index__2.mdx new file mode 100644 index 0000000000..c49691e0dc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/document-processor/index__2.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/search/document-processor/index__2" +title: "document_processor" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.search.document_processor" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/document_processor.py" +--- +# `document_processor` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module document_processor +``` + +## Properties + + + +## Classes + + + + Enhanced document processor with smart chunking capabilities + + + +## Source + +[`signalwire/signalwire/search/document_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/document_processor.py) diff --git a/fern/products/sdk-reference/python/signalwire/search/document-processor/init.mdx b/fern/products/sdk-reference/python/signalwire/search/document-processor/init.mdx new file mode 100644 index 0000000000..c8c3e02254 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/document-processor/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/document-processor/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.DocumentProcessor.__init__" + parent: "signalwire.search.DocumentProcessor" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py) + +Line 115. diff --git a/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/build-index-from-sources.mdx b/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/build-index-from-sources.mdx new file mode 100644 index 0000000000..44dcfd7f5b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/build-index-from-sources.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/python/signalwire/search/index-builder/index-builder/build-index-from-sources" +title: "build_index_from_sources" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.index_builder.IndexBuilder.build_index_from_sources" + parent: "signalwire.search.index_builder.IndexBuilder" + module: "signalwire.search.index_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py" +--- +# `build_index_from_sources` + +Build complete search index from multiple sources (files and directories) + +## Signature + +```python +build_index_from_sources( + sources: List[Path], + output_file: str, + file_types: List[str], + exclude_patterns: Optional[List[str]] = None, + languages: List[str] = None, + tags: Optional[List[str]] = None, + overwrite: bool = False +) +``` + +## Parameters + + + List of Path objects (files and/or directories) + + + + Output .swsearch file path + + + + List of file extensions to include for directories + + + + Glob patterns to exclude + + + + List of languages to support + + + + Global tags to add to all chunks + + + + +## Source + +[`signalwire/signalwire/search/index_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py) + +Line 164. diff --git a/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/build-index.mdx b/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/build-index.mdx new file mode 100644 index 0000000000..4ad67f99b1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/build-index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/python/signalwire/search/index-builder/index-builder/build-index" +title: "build_index" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.index_builder.IndexBuilder.build_index" + parent: "signalwire.search.index_builder.IndexBuilder" + module: "signalwire.search.index_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py" +--- +# `build_index` + +Build complete search index from a single directory + +## Signature + +```python +build_index( + source_dir: str, + output_file: str, + file_types: List[str], + exclude_patterns: Optional[List[str]] = None, + languages: List[str] = None, + tags: Optional[List[str]] = None +) +``` + +## Parameters + + + Directory to scan for documents + + + + Output .swsearch file path + + + + List of file extensions to include + + + + Glob patterns to exclude + + + + List of languages to support + + + + Global tags to add to all chunks + + +## Source + +[`signalwire/signalwire/search/index_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py) + +Line 283. diff --git a/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/index.mdx b/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/index.mdx new file mode 100644 index 0000000000..279098a7b1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/python/signalwire/search/index-builder/index-builder" +title: "IndexBuilder" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.index_builder.IndexBuilder" + parent: "signalwire.search.index_builder" + module: "signalwire.search.index_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py" +--- +# `IndexBuilder` + +Build searchable indexes from document directories + +## Signature + +```python +class IndexBuilder +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + Initialize the index builder + + + + Build complete search index from a single directory + + + + Build complete search index from multiple sources (files and directories) + + + + Validate an existing search index + + + +## Source + +[`signalwire/signalwire/search/index_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py) + +Line 35. diff --git a/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/init.mdx b/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/init.mdx new file mode 100644 index 0000000000..5b2179978c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/init.mdx @@ -0,0 +1,92 @@ +--- +slug: "/reference/python/signalwire/search/index-builder/index-builder/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.index_builder.IndexBuilder.__init__" + parent: "signalwire.search.index_builder.IndexBuilder" + module: "signalwire.search.index_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py" +--- +# `__init__` + +Initialize the index builder + +## Signature + +```python +__init__( + model_name: str = 'sentence-transformers/all-mpnet-base-v2', + chunking_strategy: str = 'sentence', + max_sentences_per_chunk: int = 5, + chunk_size: int = 50, + chunk_overlap: int = 10, + split_newlines: Optional[int] = None, + index_nlp_backend: str = 'nltk', + verbose: bool = False, + semantic_threshold: float = 0.5, + topic_threshold: float = 0.3, + backend: str = 'sqlite', + connection_string: Optional[str] = None +) +``` + +## Parameters + + + Name of the sentence transformer model to use + + + + Strategy for chunking documents ('sentence', 'sliding', 'paragraph', 'page', 'semantic', 'topic', 'qa', 'json') + + + + For sentence strategy (default: 5) + + + + For sliding strategy - words per chunk (default: 50) + + + + For sliding strategy - overlap in words (default: 10) + + + + For sentence strategy - split on multiple newlines (optional) + + + + NLP backend for indexing (default: 'nltk') + + + + Whether to enable verbose logging (default: False) + + + + Similarity threshold for semantic chunking (default: 0.5) + + + + Similarity threshold for topic chunking (default: 0.3) + + + + Storage backend ('sqlite' or 'pgvector') (default: 'sqlite') + + + + PostgreSQL connection string for pgvector backend + + +## Source + +[`signalwire/signalwire/search/index_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py) + +Line 38. diff --git a/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/validate-index.mdx b/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/validate-index.mdx new file mode 100644 index 0000000000..5a96f5bb70 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/index-builder/index-builder/validate-index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/search/index-builder/index-builder/validate-index" +title: "validate_index" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.index_builder.IndexBuilder.validate_index" + parent: "signalwire.search.index_builder.IndexBuilder" + module: "signalwire.search.index_builder" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py" +--- +# `validate_index` + +Validate an existing search index + +## Signature + +```python +validate_index(index_file: str) -> Dict[str, Any] +``` + +## Parameters + + + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/search/index_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py) + +Line 687. diff --git a/fern/products/sdk-reference/python/signalwire/search/index-builder/index.mdx b/fern/products/sdk-reference/python/signalwire/search/index-builder/index.mdx new file mode 100644 index 0000000000..951e2989f3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/index-builder/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/index-builder" +title: "IndexBuilder" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.IndexBuilder" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py" +--- +# `IndexBuilder` + +## Signature + +```python +class IndexBuilder +``` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py) + +Line 118. diff --git a/fern/products/sdk-reference/python/signalwire/search/index-builder/index__2.mdx b/fern/products/sdk-reference/python/signalwire/search/index-builder/index__2.mdx new file mode 100644 index 0000000000..07c22a0bdd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/index-builder/index__2.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/search/index-builder/index__2" +title: "index_builder" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.search.index_builder" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py" +--- +# `index_builder` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module index_builder +``` + +## Properties + + + +## Classes + + + + Build searchable indexes from document directories + + + +## Source + +[`signalwire/signalwire/search/index_builder.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/index_builder.py) diff --git a/fern/products/sdk-reference/python/signalwire/search/index-builder/init.mdx b/fern/products/sdk-reference/python/signalwire/search/index-builder/init.mdx new file mode 100644 index 0000000000..f1043a0a11 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/index-builder/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/index-builder/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.IndexBuilder.__init__" + parent: "signalwire.search.IndexBuilder" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py) + +Line 119. diff --git a/fern/products/sdk-reference/python/signalwire/search/index.mdx b/fern/products/sdk-reference/python/signalwire/search/index.mdx new file mode 100644 index 0000000000..df039b4673 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/index.mdx @@ -0,0 +1,92 @@ +--- +slug: "/reference/python/signalwire/search" +title: "search" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.search" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py" +--- +# `search` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module search +``` + +## Properties + + + +## Functions + + + + + + + +## Classes + + + + + + + + + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/search/migration/index.mdx b/fern/products/sdk-reference/python/signalwire/search/migration/index.mdx new file mode 100644 index 0000000000..c6b97b3df9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/migration/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/search/migration" +title: "migration" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.search.migration" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py" +--- +# `migration` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module migration +``` + +## Properties + + + +## Classes + + + + Migrate search indexes between different backends + + + +## Source + +[`signalwire/signalwire/search/migration.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py) diff --git a/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/get-index-info.mdx b/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/get-index-info.mdx new file mode 100644 index 0000000000..4fef0895ce --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/get-index-info.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/search/migration/search-index-migrator/get-index-info" +title: "get_index_info" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.migration.SearchIndexMigrator.get_index_info" + parent: "signalwire.search.migration.SearchIndexMigrator" + module: "signalwire.search.migration" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py" +--- +# `get_index_info` + +Get information about a search index + +## Signature + +```python +get_index_info(index_path: str) -> Dict[str, Any] +``` + +## Parameters + + + Path to index file or pgvector collection identifier + + +## Returns + +`Dict[str, Any]` — Index information including type, config, and statistics + +## Source + +[`signalwire/signalwire/search/migration.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py) + +Line 382. diff --git a/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/index.mdx b/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/index.mdx new file mode 100644 index 0000000000..2a2a603356 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/python/signalwire/search/migration/search-index-migrator" +title: "SearchIndexMigrator" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.migration.SearchIndexMigrator" + parent: "signalwire.search.migration" + module: "signalwire.search.migration" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py" +--- +# `SearchIndexMigrator` + +Migrate search indexes between different backends + +## Signature + +```python +class SearchIndexMigrator +``` + +## Properties + + + +## Methods + + + + Initialize the migrator + + + + Get information about a search index + + + + Migrate a pgvector collection to SQLite .swsearch format + + + + Migrate a .swsearch SQLite index to pgvector + + + +## Source + +[`signalwire/signalwire/search/migration.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/init.mdx b/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/init.mdx new file mode 100644 index 0000000000..1b53ec6d57 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/search/migration/search-index-migrator/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.migration.SearchIndexMigrator.__init__" + parent: "signalwire.search.migration.SearchIndexMigrator" + module: "signalwire.search.migration" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py" +--- +# `__init__` + +Initialize the migrator + +## Signature + +```python +__init__(verbose: bool = False) +``` + +## Parameters + + + Enable verbose output + + +## Source + +[`signalwire/signalwire/search/migration.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/migrate-pgvector-to-sqlite.mdx b/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/migrate-pgvector-to-sqlite.mdx new file mode 100644 index 0000000000..1f41b3112c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/migrate-pgvector-to-sqlite.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/search/migration/search-index-migrator/migrate-pgvector-to-sqlite" +title: "migrate_pgvector_to_sqlite" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.migration.SearchIndexMigrator.migrate_pgvector_to_sqlite" + parent: "signalwire.search.migration.SearchIndexMigrator" + module: "signalwire.search.migration" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py" +--- +# `migrate_pgvector_to_sqlite` + +Migrate a pgvector collection to SQLite .swsearch format + +## Signature + +```python +migrate_pgvector_to_sqlite( + connection_string: str, + collection_name: str, + output_path: str, + batch_size: int = 100 +) -> Dict[str, Any] +``` + +## Parameters + + + PostgreSQL connection string + + + + Name of the pgvector collection + + + + Output .swsearch file path + + + + Number of chunks to fetch at once + + +## Returns + +`Dict[str, Any]` — Migration statistics + +## Source + +[`signalwire/signalwire/search/migration.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py) + +Line 237. diff --git a/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/migrate-sqlite-to-pgvector.mdx b/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/migrate-sqlite-to-pgvector.mdx new file mode 100644 index 0000000000..da07450d08 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/migration/search-index-migrator/migrate-sqlite-to-pgvector.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/python/signalwire/search/migration/search-index-migrator/migrate-sqlite-to-pgvector" +title: "migrate_sqlite_to_pgvector" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.migration.SearchIndexMigrator.migrate_sqlite_to_pgvector" + parent: "signalwire.search.migration.SearchIndexMigrator" + module: "signalwire.search.migration" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py" +--- +# `migrate_sqlite_to_pgvector` + +Migrate a .swsearch SQLite index to pgvector + +## Signature + +```python +migrate_sqlite_to_pgvector( + sqlite_path: str, + connection_string: str, + collection_name: str, + overwrite: bool = False, + batch_size: int = 100 +) -> Dict[str, Any] +``` + +## Parameters + + + Path to .swsearch file + + + + PostgreSQL connection string + + + + Name for the pgvector collection + + + + Whether to overwrite existing collection + + + + Number of chunks to insert at once + + +## Returns + +`Dict[str, Any]` — Migration statistics + +## Source + +[`signalwire/signalwire/search/migration.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/migration.py) + +Line 38. diff --git a/fern/products/sdk-reference/python/signalwire/search/models/index.mdx b/fern/products/sdk-reference/python/signalwire/search/models/index.mdx new file mode 100644 index 0000000000..3b9a943280 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/models/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/search/models" +title: "models" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.search.models" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/models.py" +--- +# `models` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module models +``` + +## Constants + + + + + +## Functions + + + + Resolve model alias to full model name + + + +## Source + +[`signalwire/signalwire/search/models.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/models.py) diff --git a/fern/products/sdk-reference/python/signalwire/search/models/resolve-model-alias.mdx b/fern/products/sdk-reference/python/signalwire/search/models/resolve-model-alias.mdx new file mode 100644 index 0000000000..215f7c3339 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/models/resolve-model-alias.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/search/models/resolve-model-alias" +title: "resolve_model_alias" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.models.resolve_model_alias" + parent: "signalwire.search.models" + module: "signalwire.search.models" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/models.py" +--- +# `resolve_model_alias` + +Resolve model alias to full model name + +## Signature + +```python +resolve_model_alias(model_name: str) -> str +``` + +## Parameters + + + Model name or alias (mini, base, large) + + +## Returns + +`str` — Full model name + +## Source + +[`signalwire/signalwire/search/models.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/models.py) + +Line 20. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/index.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/index.mdx new file mode 100644 index 0000000000..7209ba70a8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend" +title: "pgvector_backend" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.search.pgvector_backend" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `pgvector_backend` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module pgvector_backend +``` + +## Properties + + + +## Constants + + + +## Classes + + + + PostgreSQL pgvector backend for search indexing and retrieval + + + + PostgreSQL pgvector backend for search operations + + + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/close.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/close.mdx new file mode 100644 index 0000000000..ec93fc3fb8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/close.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-backend/close" +title: "close" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorBackend.close" + parent: "signalwire.search.pgvector_backend.PgVectorBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `close` + +Close database connection + +## Signature + +```python +close() +``` + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 396. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/create-schema.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/create-schema.mdx new file mode 100644 index 0000000000..444ca4b4d3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/create-schema.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-backend/create-schema" +title: "create_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorBackend.create_schema" + parent: "signalwire.search.pgvector_backend.PgVectorBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `create_schema` + +Create database schema for a collection + +## Signature + +```python +create_schema(collection_name: str, embedding_dim: int = 768) +``` + +## Parameters + + + Name of the collection + + + + Dimension of embeddings + + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 84. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/delete-collection.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/delete-collection.mdx new file mode 100644 index 0000000000..2dac38629d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/delete-collection.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-backend/delete-collection" +title: "delete_collection" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorBackend.delete_collection" + parent: "signalwire.search.pgvector_backend.PgVectorBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `delete_collection` + +Delete a collection and its data + +## Signature + +```python +delete_collection(collection_name: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 378. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/get-stats.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/get-stats.mdx new file mode 100644 index 0000000000..e0cdd9b17f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/get-stats.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-backend/get-stats" +title: "get_stats" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorBackend.get_stats" + parent: "signalwire.search.pgvector_backend.PgVectorBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `get_stats` + +Get statistics for a collection + +## Signature + +```python +get_stats(collection_name: str) -> Dict[str, Any] +``` + +## Parameters + + + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 328. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/index.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/index.mdx new file mode 100644 index 0000000000..1798a4ff91 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-backend" +title: "PgVectorBackend" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorBackend" + parent: "signalwire.search.pgvector_backend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `PgVectorBackend` + +PostgreSQL pgvector backend for search indexing and retrieval + +## Signature + +```python +class PgVectorBackend +``` + +## Properties + + + + + +## Methods + + + + Initialize pgvector backend + + + + Close database connection + + + + Create database schema for a collection + + + + Delete a collection and its data + + + + Get statistics for a collection + + + + List all collections in the database + + + + Store document chunks in the database + + + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 42. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/init.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/init.mdx new file mode 100644 index 0000000000..82942cff9e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-backend/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorBackend.__init__" + parent: "signalwire.search.pgvector_backend.PgVectorBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `__init__` + +Initialize pgvector backend + +## Signature + +```python +__init__(connection_string: str) +``` + +## Parameters + + + PostgreSQL connection string + + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 45. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/list-collections.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/list-collections.mdx new file mode 100644 index 0000000000..896a271784 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/list-collections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-backend/list-collections" +title: "list_collections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorBackend.list_collections" + parent: "signalwire.search.pgvector_backend.PgVectorBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `list_collections` + +List all collections in the database + +## Signature + +```python +list_collections() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 370. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/store-chunks.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/store-chunks.mdx new file mode 100644 index 0000000000..0c3c3e43df --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-backend/store-chunks.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-backend/store-chunks" +title: "store_chunks" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorBackend.store_chunks" + parent: "signalwire.search.pgvector_backend.PgVectorBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `store_chunks` + +Store document chunks in the database + +## Signature + +```python +store_chunks( + chunks: List[Dict[str, Any]], + collection_name: str, + config: Dict[str, Any] +) +``` + +## Parameters + + + List of processed chunks with embeddings + + + + Name of the collection + + + + Configuration metadata + + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 209. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/close.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/close.mdx new file mode 100644 index 0000000000..1de58c6df0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/close.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/close" +title: "close" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorSearchBackend.close" + parent: "signalwire.search.pgvector_backend.PgVectorSearchBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `close` + +Close database connection + +## Signature + +```python +close() +``` + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 1010. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/fetch-candidates.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/fetch-candidates.mdx new file mode 100644 index 0000000000..a76237d339 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/fetch-candidates.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/fetch-candidates" +title: "fetch_candidates" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorSearchBackend.fetch_candidates" + parent: "signalwire.search.pgvector_backend.PgVectorSearchBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `fetch_candidates` + +Fetch raw candidates with per-source signal scores. + +Runs vector/keyword/metadata/filename searches, applies similarity +threshold to raw vector scores pre-merge (keeps threshold intuitive), +and merges into a candidate list keyed by chunk id. Does NOT compute +final scores, boost exact matches, dedupe, or apply diversity - +those run uniformly in SearchEngine for every backend. + +Result shape per candidate (matches sqlite path): +\{ +'id', 'content', 'metadata': \{filename, section, tags, \*\*custom\}, +'search\_type', 'vector\_score' (if vector matched), +'vector\_distance' (if vector matched), +'sources': \{source\_type: True, ...\}, +'source\_scores': \{source\_type: raw\_score, ...\}, +\} + +## Signature + +```python +fetch_candidates( + query_vector: List[float], + enhanced_text: str, + count: int, + similarity_threshold: float = 0.0, + tags: Optional[List[str]] = None, + original_query: Optional[str] = None +) -> List[Dict[str, Any]] +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 847. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/get-stats.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/get-stats.mdx new file mode 100644 index 0000000000..88e49f1abe --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/get-stats.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/get-stats" +title: "get_stats" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorSearchBackend.get_stats" + parent: "signalwire.search.pgvector_backend.PgVectorSearchBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `get_stats` + +Get statistics for the collection + +## Signature + +```python +get_stats() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 1003. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/index.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/index.mdx new file mode 100644 index 0000000000..5ea55a6303 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend" +title: "PgVectorSearchBackend" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorSearchBackend" + parent: "signalwire.search.pgvector_backend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `PgVectorSearchBackend` + +PostgreSQL pgvector backend for search operations + +## Signature + +```python +class PgVectorSearchBackend +``` + +## Properties + + + + + + + + + + + +## Methods + + + + Initialize search backend + + + + Close database connection + + + + Fetch raw candidates with per-source signal scores. + + + + Get statistics for the collection + + + + Perform hybrid search (vector + keyword + metadata). + + + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 403. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/init.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/init.mdx new file mode 100644 index 0000000000..41f7f596be --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/init.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorSearchBackend.__init__" + parent: "signalwire.search.pgvector_backend.PgVectorSearchBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `__init__` + +Initialize search backend + +## Signature + +```python +__init__(connection_string: str, collection_name: str) +``` + +## Parameters + + + PostgreSQL connection string + + + + Name of the collection to search + + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 406. diff --git a/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/search.mdx b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/search.mdx new file mode 100644 index 0000000000..1421fbb9b7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/search.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/python/signalwire/search/pgvector-backend/pg-vector-search-backend/search" +title: "search" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.pgvector_backend.PgVectorSearchBackend.search" + parent: "signalwire.search.pgvector_backend.PgVectorSearchBackend" + module: "signalwire.search.pgvector_backend" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py" +--- +# `search` + +Perform hybrid search (vector + keyword + metadata). + +NOTE: As of the unified-pipeline refactor, production traffic flows +through SearchEngine.search() which calls fetch\_candidates() here +and then runs all post-processing (scoring, dedup, diversity) in +SearchEngine. This method remains as a self-contained search path +for direct backend use and test coverage, but does NOT receive the +SearchEngine's exact-match boost, filename diversity, or match-type +diversity logic. For consistent behavior, call SearchEngine.search(). + +## Signature + +```python +search( + query_vector: List[float], + enhanced_text: str, + count: int = 5, + similarity_threshold: float = 0.0, + tags: Optional[List[str]] = None, + keyword_weight: Optional[float] = None +) -> List[Dict[str, Any]] +``` + +## Parameters + + + Embedding vector for the query + + + + Processed query text for keyword search + + + + Number of results to return + + + + Minimum similarity score + + + + Filter by tags + + + + Manual keyword weight (0.0-1.0). If None, uses default weighting + + +## Returns + +`List[Dict[str, Any]]` — List of search results with scores and metadata + +## Source + +[`signalwire/signalwire/search/pgvector_backend.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/pgvector_backend.py) + +Line 471. diff --git a/fern/products/sdk-reference/python/signalwire/search/preprocess-document-content.mdx b/fern/products/sdk-reference/python/signalwire/search/preprocess-document-content.mdx new file mode 100644 index 0000000000..7a608ea29e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/preprocess-document-content.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/preprocess-document-content" +title: "preprocess_document_content" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.preprocess_document_content" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py" +--- +# `preprocess_document_content` + +## Signature + +```python +preprocess_document_content(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py) + +Line 111. diff --git a/fern/products/sdk-reference/python/signalwire/search/preprocess-query.mdx b/fern/products/sdk-reference/python/signalwire/search/preprocess-query.mdx new file mode 100644 index 0000000000..ba4903ab75 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/preprocess-query.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/preprocess-query" +title: "preprocess_query" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.preprocess_query" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py" +--- +# `preprocess_query` + +## Signature + +```python +preprocess_query(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py) + +Line 108. diff --git a/fern/products/sdk-reference/python/signalwire/search/query-processor/detect-language.mdx b/fern/products/sdk-reference/python/signalwire/search/query-processor/detect-language.mdx new file mode 100644 index 0000000000..c467af05a3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/query-processor/detect-language.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/search/query-processor/detect-language" +title: "detect_language" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.query_processor.detect_language" + parent: "signalwire.search.query_processor" + module: "signalwire.search.query_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py" +--- +# `detect_language` + +Detect language of input text +Simple implementation - can be enhanced with langdetect library + +## Signature + +```python +detect_language(text: str) -> str +``` + +## Parameters + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/search/query_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py) + +Line 25. diff --git a/fern/products/sdk-reference/python/signalwire/search/query-processor/ensure-nltk-resources.mdx b/fern/products/sdk-reference/python/signalwire/search/query-processor/ensure-nltk-resources.mdx new file mode 100644 index 0000000000..7bbdc8ac9c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/query-processor/ensure-nltk-resources.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/search/query-processor/ensure-nltk-resources" +title: "ensure_nltk_resources" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.query_processor.ensure_nltk_resources" + parent: "signalwire.search.query_processor" + module: "signalwire.search.query_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py" +--- +# `ensure_nltk_resources` + +Download required NLTK resources if not already present + +## Signature + +```python +ensure_nltk_resources() +``` + +## Source + +[`signalwire/signalwire/search/query_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py) + +Line 195. diff --git a/fern/products/sdk-reference/python/signalwire/search/query-processor/get-synonyms.mdx b/fern/products/sdk-reference/python/signalwire/search/query-processor/get-synonyms.mdx new file mode 100644 index 0000000000..b7f0360218 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/query-processor/get-synonyms.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/search/query-processor/get-synonyms" +title: "get_synonyms" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.query_processor.get_synonyms" + parent: "signalwire.search.query_processor" + module: "signalwire.search.query_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py" +--- +# `get_synonyms` + +Get synonyms for a word using WordNet + +## Signature + +```python +get_synonyms(word: str, pos_tag: str, max_synonyms: int = 5) -> List[str] +``` + +## Parameters + + + + + + + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/search/query_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py) + +Line 236. diff --git a/fern/products/sdk-reference/python/signalwire/search/query-processor/get-wordnet-pos.mdx b/fern/products/sdk-reference/python/signalwire/search/query-processor/get-wordnet-pos.mdx new file mode 100644 index 0000000000..ed7ac88ce8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/query-processor/get-wordnet-pos.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/query-processor/get-wordnet-pos" +title: "get_wordnet_pos" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.query_processor.get_wordnet_pos" + parent: "signalwire.search.query_processor" + module: "signalwire.search.query_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py" +--- +# `get_wordnet_pos` + +Map spaCy POS tags to WordNet POS tags. + +## Signature + +```python +get_wordnet_pos(spacy_pos) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/search/query_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py) + +Line 232. diff --git a/fern/products/sdk-reference/python/signalwire/search/query-processor/index.mdx b/fern/products/sdk-reference/python/signalwire/search/query-processor/index.mdx new file mode 100644 index 0000000000..458dea2d29 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/query-processor/index.mdx @@ -0,0 +1,84 @@ +--- +slug: "/reference/python/signalwire/search/query-processor" +title: "query_processor" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.search.query_processor" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py" +--- +# `query_processor` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module query_processor +``` + +## Properties + + + + + + + +## Functions + + + + Detect language of input text Simple implementation - can be enhanced with langdetect library + + + + Download required NLTK resources if not already present + + + + Get synonyms for a word using WordNet + + + + Map spaCy POS tags to WordNet POS tags. + + + + Load spaCy model for the given language Returns None if spaCy is not available or model not found + + + + Preprocess document content for better searchability + + + + Advanced query preprocessing with language detection, POS tagging, synonym expansion, and vectorization + + + + Remove duplicate words from the input string while preserving the order and punctuation. + + + + Legacy function - adds model to cache instead of setting globally + + + + Vectorize query using sentence transformers Returns numpy array of embeddings + + + +## Source + +[`signalwire/signalwire/search/query_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py) diff --git a/fern/products/sdk-reference/python/signalwire/search/query-processor/load-spacy-model.mdx b/fern/products/sdk-reference/python/signalwire/search/query-processor/load-spacy-model.mdx new file mode 100644 index 0000000000..6bf7f01de3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/query-processor/load-spacy-model.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/python/signalwire/search/query-processor/load-spacy-model" +title: "load_spacy_model" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.query_processor.load_spacy_model" + parent: "signalwire.search.query_processor" + module: "signalwire.search.query_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py" +--- +# `load_spacy_model` + +Load spaCy model for the given language +Returns None if spaCy is not available or model not found + +## Signature + +```python +load_spacy_model(language: str) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/search/query_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py) + +Line 44. diff --git a/fern/products/sdk-reference/python/signalwire/search/query-processor/preprocess-document-content.mdx b/fern/products/sdk-reference/python/signalwire/search/query-processor/preprocess-document-content.mdx new file mode 100644 index 0000000000..947a128d69 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/query-processor/preprocess-document-content.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/python/signalwire/search/query-processor/preprocess-document-content" +title: "preprocess_document_content" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.query_processor.preprocess_document_content" + parent: "signalwire.search.query_processor" + module: "signalwire.search.query_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py" +--- +# `preprocess_document_content` + +Preprocess document content for better searchability + +## Signature + +```python +preprocess_document_content( + content: str, + language: str = 'en', + nlp_backend: str = None, + index_nlp_backend: str = 'nltk' +) -> Dict[str, Any] +``` + +## Parameters + + + Document content to process + + + + Language code for processing + + + + DEPRECATED - use index\_nlp\_backend instead + + + + NLP backend for document processing ('nltk' for fast, 'spacy' for better quality) + + +## Returns + +`Dict[str, Any]` — Dict containing enhanced text and extracted keywords + +## Source + +[`signalwire/signalwire/search/query_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py) + +Line 462. diff --git a/fern/products/sdk-reference/python/signalwire/search/query-processor/preprocess-query.mdx b/fern/products/sdk-reference/python/signalwire/search/query-processor/preprocess-query.mdx new file mode 100644 index 0000000000..8251ded0c9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/query-processor/preprocess-query.mdx @@ -0,0 +1,87 @@ +--- +slug: "/reference/python/signalwire/search/query-processor/preprocess-query" +title: "preprocess_query" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.query_processor.preprocess_query" + parent: "signalwire.search.query_processor" + module: "signalwire.search.query_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py" +--- +# `preprocess_query` + +Advanced query preprocessing with language detection, POS tagging, synonym expansion, and vectorization + +## Signature + +```python +preprocess_query( + query: str, + language: str = 'en', + pos_to_expand: Optional[List[str]] = None, + max_synonyms: int = 5, + debug: bool = False, + vector: bool = False, + vectorize_query_param: bool = False, + nlp_backend: str = None, + query_nlp_backend: str = 'nltk', + model_name: str = None, + preserve_original: bool = True +) -> Dict[str, Any] +``` + +## Parameters + + + Input query string + + + + Language code ('en', 'es', etc.) or 'auto' for detection + + + + List of POS tags to expand with synonyms + + + + Maximum synonyms per word + + + + Enable debug output + + + + Include vector embedding in output + + + + If True, just vectorize without other processing + + + + DEPRECATED - use query\_nlp\_backend instead + + + + NLP backend for query processing ('nltk' for fast, 'spacy' for better quality) + + + + + + +## Returns + +`Dict[str, Any]` — Dict containing processed query, language, POS tags, and optionally vector + +## Source + +[`signalwire/signalwire/search/query_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py) + +Line 276. diff --git a/fern/products/sdk-reference/python/signalwire/search/query-processor/remove-duplicate-words.mdx b/fern/products/sdk-reference/python/signalwire/search/query-processor/remove-duplicate-words.mdx new file mode 100644 index 0000000000..e547b3a3ee --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/query-processor/remove-duplicate-words.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/search/query-processor/remove-duplicate-words" +title: "remove_duplicate_words" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.query_processor.remove_duplicate_words" + parent: "signalwire.search.query_processor" + module: "signalwire.search.query_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py" +--- +# `remove_duplicate_words` + +Remove duplicate words from the input string while preserving the order and punctuation. + +## Signature + +```python +remove_duplicate_words(input_string: str) -> str +``` + +## Parameters + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/search/query_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py) + +Line 255. diff --git a/fern/products/sdk-reference/python/signalwire/search/query-processor/set-global-model.mdx b/fern/products/sdk-reference/python/signalwire/search/query-processor/set-global-model.mdx new file mode 100644 index 0000000000..ff3c5a2f8e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/query-processor/set-global-model.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/query-processor/set-global-model" +title: "set_global_model" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.query_processor.set_global_model" + parent: "signalwire.search.query_processor" + module: "signalwire.search.query_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py" +--- +# `set_global_model` + +Legacy function - adds model to cache instead of setting globally + +## Signature + +```python +set_global_model(model) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/search/query_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py) + +Line 86. diff --git a/fern/products/sdk-reference/python/signalwire/search/query-processor/vectorize-query.mdx b/fern/products/sdk-reference/python/signalwire/search/query-processor/vectorize-query.mdx new file mode 100644 index 0000000000..aa5ba59c2e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/query-processor/vectorize-query.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/search/query-processor/vectorize-query" +title: "vectorize_query" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.search.query_processor.vectorize_query" + parent: "signalwire.search.query_processor" + module: "signalwire.search.query_processor" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py" +--- +# `vectorize_query` + +Vectorize query using sentence transformers +Returns numpy array of embeddings + +## Signature + +```python +vectorize_query(query: str, model = None, model_name: str = None) +``` + +## Parameters + + + Query string to vectorize + + + + Optional pre-loaded model instance. If not provided, uses cached model. + + + + Optional model name to use if loading a new model + + +## Source + +[`signalwire/signalwire/search/query_processor.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/query_processor.py) + +Line 145. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-engine/index.mdx b/fern/products/sdk-reference/python/signalwire/search/search-engine/index.mdx new file mode 100644 index 0000000000..a13790450b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-engine/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/search-engine" +title: "SearchEngine" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.SearchEngine" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py" +--- +# `SearchEngine` + +## Signature + +```python +class SearchEngine +``` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py) + +Line 122. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-engine/index__2.mdx b/fern/products/sdk-reference/python/signalwire/search/search-engine/index__2.mdx new file mode 100644 index 0000000000..1094efa6d9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-engine/index__2.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/search/search-engine/index__2" +title: "search_engine" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.search.search_engine" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_engine.py" +--- +# `search_engine` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module search_engine +``` + +## Properties + + + + + +## Classes + + + + Hybrid search engine for vector and keyword search + + + +## Source + +[`signalwire/signalwire/search/search_engine.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_engine.py) diff --git a/fern/products/sdk-reference/python/signalwire/search/search-engine/init.mdx b/fern/products/sdk-reference/python/signalwire/search/search-engine/init.mdx new file mode 100644 index 0000000000..f88b7abc02 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-engine/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/search-engine/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.SearchEngine.__init__" + parent: "signalwire.search.SearchEngine" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py) + +Line 123. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/get-stats.mdx b/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/get-stats.mdx new file mode 100644 index 0000000000..1b7087d569 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/get-stats.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/search-engine/search-engine/get-stats" +title: "get_stats" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.search_engine.SearchEngine.get_stats" + parent: "signalwire.search.search_engine.SearchEngine" + module: "signalwire.search.search_engine" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_engine.py" +--- +# `get_stats` + +Get statistics about the search index + +## Signature + +```python +get_stats() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/search/search_engine.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_engine.py) + +Line 1346. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/index.mdx b/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/index.mdx new file mode 100644 index 0000000000..23253bbb46 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/search/search-engine/search-engine" +title: "SearchEngine" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.search_engine.SearchEngine" + parent: "signalwire.search.search_engine" + module: "signalwire.search.search_engine" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_engine.py" +--- +# `SearchEngine` + +Hybrid search engine for vector and keyword search + +## Signature + +```python +class SearchEngine +``` + +## Properties + + + + + + + + + + + +## Methods + + + + Initialize search engine + + + + Get statistics about the search index + + + + Unified hybrid search: backends fetch candidates, SearchEngine post-processes. + + + +## Source + +[`signalwire/signalwire/search/search_engine.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_engine.py) + +Line 27. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/init.mdx b/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/init.mdx new file mode 100644 index 0000000000..e123e0200b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/init.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/search/search-engine/search-engine/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.search_engine.SearchEngine.__init__" + parent: "signalwire.search.search_engine.SearchEngine" + module: "signalwire.search.search_engine" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_engine.py" +--- +# `__init__` + +Initialize search engine + +## Signature + +```python +__init__( + backend: str = 'sqlite', + index_path: Optional[str] = None, + connection_string: Optional[str] = None, + collection_name: Optional[str] = None, + model = None +) +``` + +## Parameters + + + Storage backend ('sqlite' or 'pgvector') + + + + Path to .swsearch file (for sqlite backend) + + + + PostgreSQL connection string (for pgvector backend) + + + + Collection name (for pgvector backend) + + + + Optional sentence transformer model + + +## Source + +[`signalwire/signalwire/search/search_engine.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_engine.py) + +Line 30. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/search.mdx b/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/search.mdx new file mode 100644 index 0000000000..d8e9d05e2a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-engine/search-engine/search.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/python/signalwire/search/search-engine/search-engine/search" +title: "search" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.search_engine.SearchEngine.search" + parent: "signalwire.search.search_engine.SearchEngine" + module: "signalwire.search.search_engine" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_engine.py" +--- +# `search` + +Unified hybrid search: backends fetch candidates, SearchEngine post-processes. + +> \[!NOTE] +> +> 1. fetch\_candidates(k = count \* search\_multiplier) — per-source signals +> 2. \_process\_candidates — score / boost / dedupe / diversity +> 3. return top `count` + +Backends (sqlite, pgvector, future) only implement candidate fetching. +All quality logic (max-signal scoring with agreement boost, exact-match +boosting, content dedup, filename diversity, match-type diversity) runs +once here and therefore applies to every backend uniformly. + +## Signature + +```python +search( + query_vector: List[float], + enhanced_text: str, + count: int = 3, + similarity_threshold: float = 0.0, + tags: Optional[List[str]] = None, + keyword_weight: Optional[float] = None, + original_query: Optional[str] = None +) -> List[Dict[str, Any]] +``` + +## Parameters + + + Embedding vector for the query + + + + Processed query text for keyword search + + + + Number of results to return + + + + Minimum similarity score (applied to raw vector pre-merge so the threshold is intuitive) + + + + Filter by tags + + + + Accepted for API stability; scoring is max-signal-wins with agreement boost, so this is no-op currently + + + + Original query for exact matching / filename match + + +## Returns + +`List[Dict[str, Any]]` — List of search results with scores and metadata + +## Source + +[`signalwire/signalwire/search/search_engine.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_engine.py) + +Line 79. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/index.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/index.mdx new file mode 100644 index 0000000000..697d35b90d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/search-service" +title: "SearchService" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.SearchService" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py" +--- +# `SearchService` + +## Signature + +```python +class SearchService +``` + +## Methods + + + + + +## Source + +[`signalwire/signalwire/search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py) + +Line 126. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/index__2.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/index__2.mdx new file mode 100644 index 0000000000..11c74c6d95 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/index__2.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/python/signalwire/search/search-service/index__2" +title: "search_service" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.search.search_service" + parent: "signalwire.search" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `search_service` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module search_service +``` + +## Properties + + + +## Classes + + + + + + + + + + Local search service with HTTP API supporting both SQLite and pgvector backends + + + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/init.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/init.mdx new file mode 100644 index 0000000000..89dc88ea9f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/search/search-service/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.SearchService.__init__" + parent: "signalwire.search.SearchService" + module: "signalwire.search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py" +--- +# `__init__` + +## Signature + +```python +__init__(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/__init__.py) + +Line 127. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/search-request/index.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/search-request/index.mdx new file mode 100644 index 0000000000..a66ab9069d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/search-request/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/python/signalwire/search/search-service/search-request" +title: "SearchRequest" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.search_service.SearchRequest" + parent: "signalwire.search.search_service" + module: "signalwire.search.search_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `SearchRequest` + +## Signature + +```python +class SearchRequest +``` + +## Properties + + + + + + + + + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) + +Line 67. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/search-request/init.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/search-request/init.mdx new file mode 100644 index 0000000000..5249641cac --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/search-request/init.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/search/search-service/search-request/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.search_service.SearchRequest.__init__" + parent: "signalwire.search.search_service.SearchRequest" + module: "signalwire.search.search_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `__init__` + +## Signature + +```python +__init__( + query: str, + index_name: str = 'default', + count: int = 3, + similarity_threshold: float = 0.0, + tags: Optional[List[str]] = None, + language: Optional[str] = None +) +``` + +## Parameters + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) + +Line 68. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/search-response/index.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/search-response/index.mdx new file mode 100644 index 0000000000..5971fe40a4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/search-response/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/search/search-service/search-response" +title: "SearchResponse" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.search_service.SearchResponse" + parent: "signalwire.search.search_service" + module: "signalwire.search.search_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `SearchResponse` + +## Signature + +```python +class SearchResponse +``` + +## Properties + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) + +Line 84. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/search-response/init.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/search-response/init.mdx new file mode 100644 index 0000000000..f2c540b0df --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/search-response/init.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/search/search-service/search-response/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.search_service.SearchResponse.__init__" + parent: "signalwire.search.search_service.SearchResponse" + module: "signalwire.search.search_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `__init__` + +## Signature + +```python +__init__( + results: List[SearchResult], + query_analysis: Optional[Dict[str, Any]] = None +) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) + +Line 85. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/search-result/index.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/search-result/index.mdx new file mode 100644 index 0000000000..16be99bebc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/search-result/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/search/search-service/search-result" +title: "SearchResult" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.search_service.SearchResult" + parent: "signalwire.search.search_service" + module: "signalwire.search.search_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `SearchResult` + +## Signature + +```python +class SearchResult +``` + +## Properties + + + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) + +Line 78. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/search-result/init.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/search-result/init.mdx new file mode 100644 index 0000000000..102574daa3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/search-result/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/search/search-service/search-result/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.search_service.SearchResult.__init__" + parent: "signalwire.search.search_service.SearchResult" + module: "signalwire.search.search_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `__init__` + +## Signature + +```python +__init__(content: str, score: float, metadata: Dict[str, Any]) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) + +Line 79. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/index.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/index.mdx new file mode 100644 index 0000000000..b3997f4965 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/python/signalwire/search/search-service/search-service" +title: "SearchService" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.search.search_service.SearchService" + parent: "signalwire.search.search_service" + module: "signalwire.search.search_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `SearchService` + +Local search service with HTTP API supporting both SQLite and pgvector backends + +## Signature + +```python +class SearchService +``` + +## Properties + + + + + + + + + + + + + + + + + +## Methods + + + + + + Direct search method (non-async) for programmatic use + + + + Start the service with optional HTTPS support. + + + + Stop the service (placeholder for cleanup) + + + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) + +Line 100. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/init.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/init.mdx new file mode 100644 index 0000000000..1b28bad2e2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/init.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/search/search-service/search-service/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.search_service.SearchService.__init__" + parent: "signalwire.search.search_service.SearchService" + module: "signalwire.search.search_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `__init__` + +## Signature + +```python +__init__( + port: int = 8001, + indexes: Dict[str, str] = None, + basic_auth: Optional[Tuple[str, str]] = None, + config_file: Optional[str] = None, + backend: str = 'sqlite', + connection_string: Optional[str] = None +) +``` + +## Parameters + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) + +Line 103. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/search-direct.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/search-direct.mdx new file mode 100644 index 0000000000..48ca489955 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/search-direct.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/python/signalwire/search/search-service/search-service/search-direct" +title: "search_direct" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.search_service.SearchService.search_direct" + parent: "signalwire.search.search_service.SearchService" + module: "signalwire.search.search_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `search_direct` + +Direct search method (non-async) for programmatic use + +## Signature + +```python +search_direct( + query: str, + index_name: str = 'default', + count: int = 3, + distance: float = 0.0, + tags: Optional[List[str]] = None, + language: Optional[str] = None +) -> Dict[str, Any] +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) + +Line 483. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/start.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/start.mdx new file mode 100644 index 0000000000..d6ec2e56c6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/start.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/search/search-service/search-service/start" +title: "start" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.search_service.SearchService.start" + parent: "signalwire.search.search_service.SearchService" + module: "signalwire.search.search_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `start` + +Start the service with optional HTTPS support. + +## Signature + +```python +start( + host: str = '0.0.0.0', + port: Optional[int] = None, + ssl_cert: Optional[str] = None, + ssl_key: Optional[str] = None +) +``` + +## Parameters + + + Host to bind to (default: "0.0.0.0") + + + + Port to bind to (default: self.port) + + + + Path to SSL certificate file (overrides environment) + + + + Path to SSL key file (overrides environment) + + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) + +Line 521. diff --git a/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/stop.mdx b/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/stop.mdx new file mode 100644 index 0000000000..57dd698567 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/search/search-service/search-service/stop.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/search/search-service/search-service/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.search.search_service.SearchService.stop" + parent: "signalwire.search.search_service.SearchService" + module: "signalwire.search.search_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py" +--- +# `stop` + +Stop the service (placeholder for cleanup) + +## Signature + +```python +stop() +``` + +## Source + +[`signalwire/signalwire/search/search_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/search/search_service.py) + +Line 585. diff --git a/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/index.mdx new file mode 100644 index 0000000000..5eade1a033 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/api-ninjas-trivia" +title: "api_ninjas_trivia" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.api_ninjas_trivia" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/__init__.py" +--- +# `api_ninjas_trivia` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module api_ninjas_trivia +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/api_ninjas_trivia/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-instance-key.mdx new file mode 100644 index 0000000000..4366ba1521 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-instance-key.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill.get_instance_key" + parent: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill" + module: "signalwire.skills.api_ninjas_trivia.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py" +--- +# `get_instance_key` + +Generate a unique instance key for this skill configuration. + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` — Unique key combining skill name and tool name + +## Source + +[`signalwire/signalwire/skills/api_ninjas_trivia/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py) + +Line 139. diff --git a/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..6f82080889 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-parameter-schema.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill.get_parameter_schema" + parent: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill" + module: "signalwire.skills.api_ninjas_trivia.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py" +--- +# `get_parameter_schema` + +Get the parameter schema for the API Ninjas Trivia skill. + +Returns parameter definitions for GUI configuration. + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/api_ninjas_trivia/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py) + +Line 203. diff --git a/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-tools.mdx new file mode 100644 index 0000000000..6f720c3f08 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/get-tools" +title: "get_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill.get_tools" + parent: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill" + module: "signalwire.skills.api_ninjas_trivia.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py" +--- +# `get_tools` + +Generate the SWAIG tool with DataMap webhook. + +## Signature + +```python +get_tools() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` — List containing the generated tool configuration + +## Source + +[`signalwire/signalwire/skills/api_ninjas_trivia/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py) + +Line 148. diff --git a/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/index.mdx new file mode 100644 index 0000000000..85de942f6b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/index.mdx @@ -0,0 +1,112 @@ +--- +slug: "/reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill" +title: "ApiNinjasTriviaSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill" + parent: "signalwire.skills.api_ninjas_trivia.skill" + module: "signalwire.skills.api_ninjas_trivia.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py" +--- +# `ApiNinjasTriviaSkill` + +Skill for getting trivia questions from API Ninjas with configurable categories. + +Supports multiple instances with different tool names and category combinations. +Uses DataMap for serverless execution with dynamic enum generation. + +Configuration: + +- tool\_name: Custom name for the generated SWAIG function +- api\_key: API Ninjas API key +- categories: Array of category strings to enable + +Available categories: + +- artliterature: Art and Literature +- language: Language +- sciencenature: Science and Nature +- general: General Knowledge +- fooddrink: Food and Drink +- peopleplaces: People and Places +- geography: Geography +- historyholidays: History and Holidays +- entertainment: Entertainment +- toysgames: Toys and Games +- music: Music +- mathematics: Mathematics +- religionmythology: Religion and Mythology +- sportsleisure: Sports and Leisure + +> \[!NOTE] +> agent.add\_skill("api\_ninjas\_trivia", \{ +> "tool\_name": "get\_science\_trivia", +> "api\_key": "your\_api\_key", +> "categories": \["sciencenature", "mathematics", "general"] +> \}) + +## Signature + +```python +class ApiNinjasTriviaSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + + + + + +## Methods + + + + Initialize the skill with configuration parameters. + + + + Generate a unique instance key for this skill configuration. + + + + Get the parameter schema for the API Ninjas Trivia skill. + + + + Generate the SWAIG tool with DataMap webhook. + + + + Register SWAIG tools with the agent + + + + Setup the skill - validates API key is available. + + + +## Source + +[`signalwire/signalwire/skills/api_ninjas_trivia/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/init.mdx b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/init.mdx new file mode 100644 index 0000000000..89033e4424 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/init.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill.__init__" + parent: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill" + module: "signalwire.skills.api_ninjas_trivia.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py" +--- +# `__init__` + +Initialize the skill with configuration parameters. + +## Signature + +```python +__init__(agent, params: Dict[str, Any] = None) +``` + +## Parameters + + + The agent instance this skill belongs to + + + + Configuration dictionary containing: + + +## Source + +[`signalwire/signalwire/skills/api_ninjas_trivia/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py) + +Line 81. diff --git a/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/register-tools.mdx new file mode 100644 index 0000000000..14cc499355 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill.register_tools" + parent: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill" + module: "signalwire.skills.api_ninjas_trivia.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py" +--- +# `register_tools` + +Register SWAIG tools with the agent + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/api_ninjas_trivia/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py) + +Line 130. diff --git a/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/setup.mdx new file mode 100644 index 0000000000..dd6b1d92ab --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/api-ninjas-trivia/skill/api-ninjas-trivia-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill.setup" + parent: "signalwire.skills.api_ninjas_trivia.skill.ApiNinjasTriviaSkill" + module: "signalwire.skills.api_ninjas_trivia.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py" +--- +# `setup` + +Setup the skill - validates API key is available. + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` — True if setup successful + +## Source + +[`signalwire/signalwire/skills/api_ninjas_trivia/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py) + +Line 120. diff --git a/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/index.mdx new file mode 100644 index 0000000000..c8d2784985 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/api-ninjas-trivia/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/api-ninjas-trivia/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.api_ninjas_trivia.skill" + parent: "signalwire.skills.api_ninjas_trivia" + module: "signalwire.skills.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Skill for getting trivia questions from API Ninjas with configurable categories. + + + +## Source + +[`signalwire/signalwire/skills/api_ninjas_trivia/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/api_ninjas_trivia/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/claude-skills/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/index.mdx new file mode 100644 index 0000000000..5822aba6b7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/claude-skills" +title: "claude_skills" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.claude_skills" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/__init__.py" +--- +# `claude_skills` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module claude_skills +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/claude_skills/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-hints.mdx new file mode 100644 index 0000000000..ca828c9ede --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.claude_skills.skill.ClaudeSkillsSkill.get_hints" + parent: "signalwire.skills.claude_skills.skill.ClaudeSkillsSkill" + module: "signalwire.skills.claude_skills.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py" +--- +# `get_hints` + +Return speech recognition hints based on loaded skills. + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/claude_skills/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py) + +Line 610. diff --git a/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-instance-key.mdx new file mode 100644 index 0000000000..4dbdaac8c6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-instance-key.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.claude_skills.skill.ClaudeSkillsSkill.get_instance_key" + parent: "signalwire.skills.claude_skills.skill.ClaudeSkillsSkill" + module: "signalwire.skills.claude_skills.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py" +--- +# `get_instance_key` + +Return unique key for this skill instance. + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/claude_skills/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py) + +Line 667. diff --git a/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..ed6e5880aa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.claude_skills.skill.ClaudeSkillsSkill.get_parameter_schema" + parent: "signalwire.skills.claude_skills.skill.ClaudeSkillsSkill" + module: "signalwire.skills.claude_skills.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py" +--- +# `get_parameter_schema` + +Get the parameter schema for the Claude skills loader. + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/claude_skills/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py) + +Line 673. diff --git a/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/index.mdx new file mode 100644 index 0000000000..a7ad449653 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/index.mdx @@ -0,0 +1,91 @@ +--- +slug: "/reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill" +title: "ClaudeSkillsSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.claude_skills.skill.ClaudeSkillsSkill" + parent: "signalwire.skills.claude_skills.skill" + module: "signalwire.skills.claude_skills.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py" +--- +# `ClaudeSkillsSkill` + +Load Claude-style SKILL.md files as SignalWire agent tools. + +This skill parses Claude Code skill directories and makes them available +as SWAIG tools that the AI can call. Each Claude skill becomes a tool +that returns the skill's instructions when invoked. + +> ## \[!NOTE] +> +> name: skill-name +> description: When to use this skill +> ----------------------------------- +> +> Markdown instructions here... +> Use $ARGUMENTS for passed args. + +## Signature + +```python +class ClaudeSkillsSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Examples + +```python +Markdown instructions here... +Use $ARGUMENTS for passed args. +``` + +## Properties + + + + + + + + + + + + + +## Methods + + + + Return speech recognition hints based on loaded skills. + + + + Return unique key for this skill instance. + + + + Get the parameter schema for the Claude skills loader. + + + + Register a SWAIG tool for each discovered Claude skill. + + + + Setup the Claude skills loader. + + + +## Source + +[`signalwire/signalwire/skills/claude_skills/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py) + +Line 38. diff --git a/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/register-tools.mdx new file mode 100644 index 0000000000..99b4c4a43c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.claude_skills.skill.ClaudeSkillsSkill.register_tools" + parent: "signalwire.skills.claude_skills.skill.ClaudeSkillsSkill" + module: "signalwire.skills.claude_skills.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py" +--- +# `register_tools` + +Register a SWAIG tool for each discovered Claude skill. + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/claude_skills/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py) + +Line 518. diff --git a/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/setup.mdx new file mode 100644 index 0000000000..abb6ce136e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/setup.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/skills/claude-skills/skill/claude-skills-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.claude_skills.skill.ClaudeSkillsSkill.setup" + parent: "signalwire.skills.claude_skills.skill.ClaudeSkillsSkill" + module: "signalwire.skills.claude_skills.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py" +--- +# `setup` + +Setup the Claude skills loader. + +Discovers and parses all SKILL.md files in the configured directory. + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/claude_skills/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py) + +Line 63. diff --git a/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/index.mdx new file mode 100644 index 0000000000..830728d737 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/claude-skills/skill/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/claude-skills/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.claude_skills.skill" + parent: "signalwire.skills.claude_skills" + module: "signalwire.skills.claude_skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Properties + + + +## Classes + + + + Load Claude-style SKILL.md files as SignalWire agent tools. + + + +## Source + +[`signalwire/signalwire/skills/claude_skills/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/claude_skills/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/index.mdx new file mode 100644 index 0000000000..0b9bcdcfdb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere-serverless" +title: "datasphere_serverless" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.datasphere_serverless" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/__init__.py" +--- +# `datasphere_serverless` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module datasphere_serverless +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/datasphere_serverless/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-global-data.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-global-data.mdx new file mode 100644 index 0000000000..4d3948d9ed --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-global-data" +title: "get_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill.get_global_data" + parent: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill" + module: "signalwire.skills.datasphere_serverless.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py" +--- +# `get_global_data` + +Return global data for agent context + +## Signature + +```python +get_global_data() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/skills/datasphere_serverless/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py) + +Line 216. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-hints.mdx new file mode 100644 index 0000000000..1dffd910f1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill.get_hints" + parent: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill" + module: "signalwire.skills.datasphere_serverless.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py" +--- +# `get_hints` + +Return speech recognition hints + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/datasphere_serverless/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py) + +Line 212. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-instance-key.mdx new file mode 100644 index 0000000000..8e7a4dcd19 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-instance-key.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill.get_instance_key" + parent: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill" + module: "signalwire.skills.datasphere_serverless.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py" +--- +# `get_instance_key` + +Get the key used to track this skill instance + +For DataSphere Serverless, we use 'search\_knowledge' as the default tool name + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/datasphere_serverless/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py) + +Line 111. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..c2f2a16ceb --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill.get_parameter_schema" + parent: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill" + module: "signalwire.skills.datasphere_serverless.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py" +--- +# `get_parameter_schema` + +Get parameter schema for DataSphere Serverless skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/datasphere_serverless/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..f2dc1331f4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill.get_prompt_sections" + parent: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill" + module: "signalwire.skills.datasphere_serverless.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/datasphere_serverless/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py) + +Line 224. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/index.mdx new file mode 100644 index 0000000000..3ea4513f63 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill" +title: "DataSphereServerlessSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill" + parent: "signalwire.skills.datasphere_serverless.skill" + module: "signalwire.skills.datasphere_serverless.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py" +--- +# `DataSphereServerlessSkill` + +SignalWire DataSphere knowledge search using DataMap (serverless execution) + +## Signature + +```python +class DataSphereServerlessSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + +## Methods + + + + Return global data for agent context + + + + Return speech recognition hints + + + + Get the key used to track this skill instance + + + + Get parameter schema for DataSphere Serverless skill + + + + Return prompt sections to add to agent + + + + Register knowledge search tool using DataMap + + + + Setup the datasphere serverless skill + + + +## Source + +[`signalwire/signalwire/skills/datasphere_serverless/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/register-tools.mdx new file mode 100644 index 0000000000..ec8df560d8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill.register_tools" + parent: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill" + module: "signalwire.skills.datasphere_serverless.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py" +--- +# `register_tools` + +Register knowledge search tool using DataMap + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/datasphere_serverless/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py) + +Line 161. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/setup.mdx new file mode 100644 index 0000000000..069f4d0723 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere-serverless/skill/data-sphere-serverless-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill.setup" + parent: "signalwire.skills.datasphere_serverless.skill.DataSphereServerlessSkill" + module: "signalwire.skills.datasphere_serverless.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py" +--- +# `setup` + +Setup the datasphere serverless skill + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/datasphere_serverless/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py) + +Line 120. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/index.mdx new file mode 100644 index 0000000000..ea4212efdc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere-serverless/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere-serverless/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.datasphere_serverless.skill" + parent: "signalwire.skills.datasphere_serverless" + module: "signalwire.skills.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + SignalWire DataSphere knowledge search using DataMap (serverless execution) + + + +## Source + +[`signalwire/signalwire/skills/datasphere_serverless/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere_serverless/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere/index.mdx new file mode 100644 index 0000000000..a985087983 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere" +title: "datasphere" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.datasphere" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/__init__.py" +--- +# `datasphere` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module datasphere +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/datasphere/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/cleanup.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/cleanup.mdx new file mode 100644 index 0000000000..9b654d9913 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/cleanup" +title: "cleanup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere.skill.DataSphereSkill.cleanup" + parent: "signalwire.skills.datasphere.skill.DataSphereSkill" + module: "signalwire.skills.datasphere.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py" +--- +# `cleanup` + +Clean up resources when skill is unloaded. + +## Signature + +```python +cleanup() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/datasphere/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py) + +Line 280. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-global-data.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-global-data.mdx new file mode 100644 index 0000000000..7801d18257 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-global-data" +title: "get_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere.skill.DataSphereSkill.get_global_data" + parent: "signalwire.skills.datasphere.skill.DataSphereSkill" + module: "signalwire.skills.datasphere.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py" +--- +# `get_global_data` + +Return global data for agent context + +## Signature + +```python +get_global_data() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/skills/datasphere/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py) + +Line 294. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-hints.mdx new file mode 100644 index 0000000000..2b91fc6182 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere.skill.DataSphereSkill.get_hints" + parent: "signalwire.skills.datasphere.skill.DataSphereSkill" + module: "signalwire.skills.datasphere.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py" +--- +# `get_hints` + +Return speech recognition hints + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/datasphere/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py) + +Line 285. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-instance-key.mdx new file mode 100644 index 0000000000..6506487e32 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-instance-key.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere.skill.DataSphereSkill.get_instance_key" + parent: "signalwire.skills.datasphere.skill.DataSphereSkill" + module: "signalwire.skills.datasphere.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py" +--- +# `get_instance_key` + +Get the key used to track this skill instance + +For DataSphere, we use 'search\_knowledge' as the default tool name instead of 'datasphere' + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/datasphere/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py) + +Line 111. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..0076b31275 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere.skill.DataSphereSkill.get_parameter_schema" + parent: "signalwire.skills.datasphere.skill.DataSphereSkill" + module: "signalwire.skills.datasphere.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py" +--- +# `get_parameter_schema` + +Get parameter schema for DataSphere skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/datasphere/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py) + +Line 29. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..e0cb5e96c0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere.skill.DataSphereSkill.get_prompt_sections" + parent: "signalwire.skills.datasphere.skill.DataSphereSkill" + module: "signalwire.skills.datasphere.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/datasphere/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py) + +Line 302. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/index.mdx new file mode 100644 index 0000000000..4886512363 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere/skill/data-sphere-skill" +title: "DataSphereSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.datasphere.skill.DataSphereSkill" + parent: "signalwire.skills.datasphere.skill" + module: "signalwire.skills.datasphere.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py" +--- +# `DataSphereSkill` + +SignalWire DataSphere knowledge search capability + +## Signature + +```python +class DataSphereSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + +## Methods + + + + Clean up resources when skill is unloaded. + + + + Return global data for agent context + + + + Return speech recognition hints + + + + Get the key used to track this skill instance + + + + Get parameter schema for DataSphere skill + + + + Return prompt sections to add to agent + + + + Register knowledge search tool with the agent + + + + Setup the datasphere skill + + + +## Source + +[`signalwire/signalwire/skills/datasphere/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/register-tools.mdx new file mode 100644 index 0000000000..79ecb254ae --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere.skill.DataSphereSkill.register_tools" + parent: "signalwire.skills.datasphere.skill.DataSphereSkill" + module: "signalwire.skills.datasphere.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py" +--- +# `register_tools` + +Register knowledge search tool with the agent + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/datasphere/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py) + +Line 160. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/setup.mdx new file mode 100644 index 0000000000..3e17f3f310 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere/skill/data-sphere-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datasphere.skill.DataSphereSkill.setup" + parent: "signalwire.skills.datasphere.skill.DataSphereSkill" + module: "signalwire.skills.datasphere.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py" +--- +# `setup` + +Setup the datasphere skill + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/datasphere/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py) + +Line 120. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/index.mdx new file mode 100644 index 0000000000..41f6efdb85 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datasphere/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/datasphere/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.datasphere.skill" + parent: "signalwire.skills.datasphere" + module: "signalwire.skills.datasphere" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + SignalWire DataSphere knowledge search capability + + + +## Source + +[`signalwire/signalwire/skills/datasphere/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datasphere/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/datetime/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/datetime/index.mdx new file mode 100644 index 0000000000..eb4a658ae2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datetime/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/datetime" +title: "datetime" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.datetime" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/__init__.py" +--- +# `datetime` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module datetime +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/datetime/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/get-hints.mdx new file mode 100644 index 0000000000..2be465af38 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datetime/skill/date-time-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datetime.skill.DateTimeSkill.get_hints" + parent: "signalwire.skills.datetime.skill.DateTimeSkill" + module: "signalwire.skills.datetime.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py" +--- +# `get_hints` + +Return speech recognition hints + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/datetime/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py) + +Line 93. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..97266394e1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/get-parameter-schema.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/skills/datetime/skill/date-time-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datetime.skill.DateTimeSkill.get_parameter_schema" + parent: "signalwire.skills.datetime.skill.DateTimeSkill" + module: "signalwire.skills.datetime.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py" +--- +# `get_parameter_schema` + +Get the parameter schema for the datetime skill + +The datetime skill has no custom parameters - it inherits only +the base parameters from SkillBase. + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/datetime/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py) + +Line 113. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..0d3d8fb9db --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datetime/skill/date-time-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datetime.skill.DateTimeSkill.get_prompt_sections" + parent: "signalwire.skills.datetime.skill.DateTimeSkill" + module: "signalwire.skills.datetime.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/datetime/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py) + +Line 99. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/index.mdx new file mode 100644 index 0000000000..b65141e180 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/python/signalwire/skills/datetime/skill/date-time-skill" +title: "DateTimeSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.datetime.skill.DateTimeSkill" + parent: "signalwire.skills.datetime.skill" + module: "signalwire.skills.datetime.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py" +--- +# `DateTimeSkill` + +Provides current date, time, and timezone information + +## Signature + +```python +class DateTimeSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + +## Methods + + + + Return speech recognition hints + + + + Get the parameter schema for the datetime skill + + + + Return prompt sections to add to agent + + + + Register datetime tools with the agent + + + + Setup the datetime skill + + + +## Source + +[`signalwire/signalwire/skills/datetime/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/register-tools.mdx new file mode 100644 index 0000000000..935d4a7434 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datetime/skill/date-time-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datetime.skill.DateTimeSkill.register_tools" + parent: "signalwire.skills.datetime.skill.DateTimeSkill" + module: "signalwire.skills.datetime.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py" +--- +# `register_tools` + +Register datetime tools with the agent + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/datetime/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py) + +Line 30. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/setup.mdx new file mode 100644 index 0000000000..fd0da22a1e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/date-time-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/datetime/skill/date-time-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.datetime.skill.DateTimeSkill.setup" + parent: "signalwire.skills.datetime.skill.DateTimeSkill" + module: "signalwire.skills.datetime.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py" +--- +# `setup` + +Setup the datetime skill + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/datetime/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/index.mdx new file mode 100644 index 0000000000..a86bf1df36 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/datetime/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/datetime/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.datetime.skill" + parent: "signalwire.skills.datetime" + module: "signalwire.skills.datetime" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Provides current date, time, and timezone information + + + +## Source + +[`signalwire/signalwire/skills/datetime/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/datetime/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/index.mdx new file mode 100644 index 0000000000..28dd738a1e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps" +title: "google_maps" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.google_maps" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/__init__.py" +--- +# `google_maps` + +Google Maps skill for SignalWire Agents + +## Signature + +```python +module google_maps +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/google_maps/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/compute-route.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/compute-route.mdx new file mode 100644 index 0000000000..1a41afcaca --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/compute-route.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps/skill/google-maps-client/compute-route" +title: "compute_route" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.google_maps.skill.GoogleMapsClient.compute_route" + parent: "signalwire.skills.google_maps.skill.GoogleMapsClient" + module: "signalwire.skills.google_maps.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py" +--- +# `compute_route` + +Compute route using Google Routes API. + +Returns: \{"distance\_meters": int, "duration\_seconds": int\} or None + +## Signature + +```python +compute_route(origin_lat, origin_lng, dest_lat, dest_lng) +``` + +## Parameters + + + + + + + + + +## Source + +[`signalwire/signalwire/skills/google_maps/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py) + +Line 316. diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/index.mdx new file mode 100644 index 0000000000..c3d3d21427 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps/skill/google-maps-client" +title: "GoogleMapsClient" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.google_maps.skill.GoogleMapsClient" + parent: "signalwire.skills.google_maps.skill" + module: "signalwire.skills.google_maps.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py" +--- +# `GoogleMapsClient` + +## Signature + +```python +class GoogleMapsClient +``` + +## Properties + + + +## Methods + + + + + + Compute route using Google Routes API. + + + + Validate and geocode an address or business name. + + + +## Source + +[`signalwire/signalwire/skills/google_maps/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py) + +Line 116. diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/init.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/init.mdx new file mode 100644 index 0000000000..0ceebe9b2d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/init.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps/skill/google-maps-client/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.google_maps.skill.GoogleMapsClient.__init__" + parent: "signalwire.skills.google_maps.skill.GoogleMapsClient" + module: "signalwire.skills.google_maps.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py" +--- +# `__init__` + +## Signature + +```python +__init__(api_key) +``` + +## Parameters + + + +## Source + +[`signalwire/signalwire/skills/google_maps/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py) + +Line 117. diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/validate-address.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/validate-address.mdx new file mode 100644 index 0000000000..c805a4a6f1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-client/validate-address.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps/skill/google-maps-client/validate-address" +title: "validate_address" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.google_maps.skill.GoogleMapsClient.validate_address" + parent: "signalwire.skills.google_maps.skill.GoogleMapsClient" + module: "signalwire.skills.google_maps.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py" +--- +# `validate_address` + +Validate and geocode an address or business name. + +When bias\_lat/bias\_lng are provided (destination search with known pickup): + +1. First tries Nearby Search with rankby=distance to find the CLOSEST + matching business (e.g. "Walmart" → nearest Walmart to pickup). +2. Falls back to Autocomplete with location bias (no strictbounds) for + street addresses or if Nearby Search finds nothing. + +Without bias coords (pickup search): uses plain Autocomplete. + +Returns: \{"address": str, "lat": float, "lng": float\} or None + +## Signature + +```python +validate_address(input_text, bias_lat = None, bias_lng = None) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/skills/google_maps/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py) + +Line 120. diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-hints.mdx new file mode 100644 index 0000000000..f8d0bf6e65 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.google_maps.skill.GoogleMapsSkill.get_hints" + parent: "signalwire.skills.google_maps.skill.GoogleMapsSkill" + module: "signalwire.skills.google_maps.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py" +--- +# `get_hints` + +Return speech recognition hints + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/google_maps/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py) + +Line 530. diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..547422ff4a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.google_maps.skill.GoogleMapsSkill.get_parameter_schema" + parent: "signalwire.skills.google_maps.skill.GoogleMapsSkill" + module: "signalwire.skills.google_maps.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py" +--- +# `get_parameter_schema` + +Get parameter schema for google\_maps skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/google_maps/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py) + +Line 387. diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..25ed92df4b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps/skill/google-maps-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.google_maps.skill.GoogleMapsSkill.get_prompt_sections" + parent: "signalwire.skills.google_maps.skill.GoogleMapsSkill" + module: "signalwire.skills.google_maps.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/google_maps/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py) + +Line 534. diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/index.mdx new file mode 100644 index 0000000000..2ed58ed48d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps/skill/google-maps-skill" +title: "GoogleMapsSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.google_maps.skill.GoogleMapsSkill" + parent: "signalwire.skills.google_maps.skill" + module: "signalwire.skills.google_maps.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py" +--- +# `GoogleMapsSkill` + +Validate addresses and compute driving routes using Google Maps + +## Signature + +```python +class GoogleMapsSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + +## Methods + + + + Return speech recognition hints + + + + Get parameter schema for google\_maps skill + + + + Return prompt sections to add to agent + + + + Register address lookup and route computation tools + + + + Setup the Google Maps skill + + + +## Source + +[`signalwire/signalwire/skills/google_maps/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py) + +Line 378. diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/register-tools.mdx new file mode 100644 index 0000000000..c571650344 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps/skill/google-maps-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.google_maps.skill.GoogleMapsSkill.register_tools" + parent: "signalwire.skills.google_maps.skill.GoogleMapsSkill" + module: "signalwire.skills.google_maps.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py" +--- +# `register_tools` + +Register address lookup and route computation tools + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/google_maps/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py) + +Line 429. diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/setup.mdx new file mode 100644 index 0000000000..ad60cf391c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/google-maps-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps/skill/google-maps-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.google_maps.skill.GoogleMapsSkill.setup" + parent: "signalwire.skills.google_maps.skill.GoogleMapsSkill" + module: "signalwire.skills.google_maps.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py" +--- +# `setup` + +Setup the Google Maps skill + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/google_maps/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py) + +Line 414. diff --git a/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/index.mdx new file mode 100644 index 0000000000..8c21b38b27 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/google-maps/skill/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/skills/google-maps/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.google_maps.skill" + parent: "signalwire.skills.google_maps" + module: "signalwire.skills.google_maps" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Properties + + + +## Classes + + + + + + Validate addresses and compute driving routes using Google Maps + + + +## Source + +[`signalwire/signalwire/skills/google_maps/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/google_maps/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/index.mdx new file mode 100644 index 0000000000..d91cfe3a9b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/index.mdx @@ -0,0 +1,112 @@ +--- +slug: "/reference/python/signalwire/skills" +title: "skills" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/__init__.py" +--- +# `skills` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skills +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Google Maps skill for SignalWire Agents + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/index.mdx new file mode 100644 index 0000000000..dfe1279d70 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/info-gatherer" +title: "info_gatherer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.info_gatherer" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/__init__.py" +--- +# `info_gatherer` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module info_gatherer +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/info_gatherer/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/index.mdx new file mode 100644 index 0000000000..f1ee83b5a3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/info-gatherer/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.info_gatherer.skill" + parent: "signalwire.skills.info_gatherer" + module: "signalwire.skills.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Skill that guides an AI agent through a series of questions, collecting and storing answers in namespaced global\_data. + + + +## Source + +[`signalwire/signalwire/skills/info_gatherer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-global-data.mdx b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-global-data.mdx new file mode 100644 index 0000000000..3a8e73d38d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-global-data.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-global-data" +title: "get_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.info_gatherer.skill.InfoGathererSkill.get_global_data" + parent: "signalwire.skills.info_gatherer.skill.InfoGathererSkill" + module: "signalwire.skills.info_gatherer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py" +--- +# `get_global_data` + +## Signature + +```python +get_global_data() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/skills/info_gatherer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py) + +Line 127. diff --git a/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-instance-key.mdx new file mode 100644 index 0000000000..21161d2f08 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-instance-key.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.info_gatherer.skill.InfoGathererSkill.get_instance_key" + parent: "signalwire.skills.info_gatherer.skill.InfoGathererSkill" + module: "signalwire.skills.info_gatherer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py" +--- +# `get_instance_key` + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/info_gatherer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py) + +Line 81. diff --git a/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..ca0d2dc944 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-parameter-schema.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.info_gatherer.skill.InfoGathererSkill.get_parameter_schema" + parent: "signalwire.skills.info_gatherer.skill.InfoGathererSkill" + module: "signalwire.skills.info_gatherer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py" +--- +# `get_parameter_schema` + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/info_gatherer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py) + +Line 33. diff --git a/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/index.mdx new file mode 100644 index 0000000000..3097933451 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill" +title: "InfoGathererSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.info_gatherer.skill.InfoGathererSkill" + parent: "signalwire.skills.info_gatherer.skill" + module: "signalwire.skills.info_gatherer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py" +--- +# `InfoGathererSkill` + +Skill that guides an AI agent through a series of questions, collecting +and storing answers in namespaced global\_data. + +Supports multiple instances with different prefixes so several +question sets can coexist on a single agent (e.g. "intake" and +"medical" questionnaires running side by side). + +## Signature + +```python +class InfoGathererSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + +## Methods + + + + + + + + + + + + + +## Source + +[`signalwire/signalwire/skills/info_gatherer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py) + +Line 16. diff --git a/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/register-tools.mdx new file mode 100644 index 0000000000..a8a9a41c08 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.info_gatherer.skill.InfoGathererSkill.register_tools" + parent: "signalwire.skills.info_gatherer.skill.InfoGathererSkill" + module: "signalwire.skills.info_gatherer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py" +--- +# `register_tools` + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/info_gatherer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py) + +Line 162. diff --git a/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/setup.mdx new file mode 100644 index 0000000000..fa65a8ca06 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/setup.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/python/signalwire/skills/info-gatherer/skill/info-gatherer-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.info_gatherer.skill.InfoGathererSkill.setup" + parent: "signalwire.skills.info_gatherer.skill.InfoGathererSkill" + module: "signalwire.skills.info_gatherer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py" +--- +# `setup` + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/info_gatherer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/info_gatherer/skill.py) + +Line 91. diff --git a/fern/products/sdk-reference/python/signalwire/skills/joke/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/joke/index.mdx new file mode 100644 index 0000000000..06459a8340 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/joke/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/joke" +title: "joke" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.joke" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/__init__.py" +--- +# `joke` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module joke +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/joke/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/joke/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/index.mdx new file mode 100644 index 0000000000..93b0bb7f08 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/joke/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.joke.skill" + parent: "signalwire.skills.joke" + module: "signalwire.skills.joke" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Joke telling capability using API Ninjas with DataMap + + + +## Source + +[`signalwire/signalwire/skills/joke/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-global-data.mdx b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-global-data.mdx new file mode 100644 index 0000000000..322b400aca --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/joke/skill/joke-skill/get-global-data" +title: "get_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.joke.skill.JokeSkill.get_global_data" + parent: "signalwire.skills.joke.skill.JokeSkill" + module: "signalwire.skills.joke.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py" +--- +# `get_global_data` + +Return global data to be available in DataMap variables + +## Signature + +```python +get_global_data() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/skills/joke/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py) + +Line 91. diff --git a/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-hints.mdx new file mode 100644 index 0000000000..b27a75c18c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/joke/skill/joke-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.joke.skill.JokeSkill.get_hints" + parent: "signalwire.skills.joke.skill.JokeSkill" + module: "signalwire.skills.joke.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py" +--- +# `get_hints` + +Return speech recognition hints + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/joke/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py) + +Line 82. diff --git a/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..4865ee8951 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/joke/skill/joke-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.joke.skill.JokeSkill.get_parameter_schema" + parent: "signalwire.skills.joke.skill.JokeSkill" + module: "signalwire.skills.joke.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py" +--- +# `get_parameter_schema` + +Get parameter schema for joke skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/joke/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..0fe1afa646 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/joke/skill/joke-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.joke.skill.JokeSkill.get_prompt_sections" + parent: "signalwire.skills.joke.skill.JokeSkill" + module: "signalwire.skills.joke.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/joke/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py) + +Line 97. diff --git a/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/index.mdx new file mode 100644 index 0000000000..4db04954f8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/python/signalwire/skills/joke/skill/joke-skill" +title: "JokeSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.joke.skill.JokeSkill" + parent: "signalwire.skills.joke.skill" + module: "signalwire.skills.joke.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py" +--- +# `JokeSkill` + +Joke telling capability using API Ninjas with DataMap + +## Signature + +```python +class JokeSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + +## Methods + + + + Return global data to be available in DataMap variables + + + + Return speech recognition hints + + + + Get parameter schema for joke skill + + + + Return prompt sections to add to agent + + + + Register joke tool using DataMap + + + + Setup the joke skill + + + +## Source + +[`signalwire/signalwire/skills/joke/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/register-tools.mdx new file mode 100644 index 0000000000..905ee9e46c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/joke/skill/joke-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.joke.skill.JokeSkill.register_tools" + parent: "signalwire.skills.joke.skill.JokeSkill" + module: "signalwire.skills.joke.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py" +--- +# `register_tools` + +Register joke tool using DataMap + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/joke/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py) + +Line 64. diff --git a/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/setup.mdx new file mode 100644 index 0000000000..6baf666d83 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/joke/skill/joke-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/joke/skill/joke-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.joke.skill.JokeSkill.setup" + parent: "signalwire.skills.joke.skill.JokeSkill" + module: "signalwire.skills.joke.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py" +--- +# `setup` + +Setup the joke skill + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/joke/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/joke/skill.py) + +Line 47. diff --git a/fern/products/sdk-reference/python/signalwire/skills/math/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/math/index.mdx new file mode 100644 index 0000000000..8efdfec663 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/math/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/math" +title: "math" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.math" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/__init__.py" +--- +# `math` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module math +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/math/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/math/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/math/skill/index.mdx new file mode 100644 index 0000000000..910484b11e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/math/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/math/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.math.skill" + parent: "signalwire.skills.math" + module: "signalwire.skills.math" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Provides basic mathematical calculation capabilities + + + +## Source + +[`signalwire/signalwire/skills/math/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/get-hints.mdx new file mode 100644 index 0000000000..632e0309ce --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/math/skill/math-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.math.skill.MathSkill.get_hints" + parent: "signalwire.skills.math.skill.MathSkill" + module: "signalwire.skills.math.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py" +--- +# `get_hints` + +Return speech recognition hints + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/math/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py) + +Line 108. diff --git a/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..d7c904abf7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/get-parameter-schema.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/skills/math/skill/math-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.math.skill.MathSkill.get_parameter_schema" + parent: "signalwire.skills.math.skill.MathSkill" + module: "signalwire.skills.math.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py" +--- +# `get_parameter_schema` + +Get the parameter schema for the math skill + +The math skill has no custom parameters - it inherits only +the base parameters from SkillBase. + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/math/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py) + +Line 131. diff --git a/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..90e7105165 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/math/skill/math-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.math.skill.MathSkill.get_prompt_sections" + parent: "signalwire.skills.math.skill.MathSkill" + module: "signalwire.skills.math.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/math/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py) + +Line 117. diff --git a/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/index.mdx new file mode 100644 index 0000000000..b8a88850b1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/python/signalwire/skills/math/skill/math-skill" +title: "MathSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.math.skill.MathSkill" + parent: "signalwire.skills.math.skill" + module: "signalwire.skills.math.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py" +--- +# `MathSkill` + +Provides basic mathematical calculation capabilities + +## Signature + +```python +class MathSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + +## Methods + + + + Return speech recognition hints + + + + Get the parameter schema for the math skill + + + + Return prompt sections to add to agent + + + + Register math tools with the agent + + + + Setup the math skill + + + +## Source + +[`signalwire/signalwire/skills/math/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py) + +Line 17. diff --git a/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/register-tools.mdx new file mode 100644 index 0000000000..50f85df788 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/math/skill/math-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.math.skill.MathSkill.register_tools" + parent: "signalwire.skills.math.skill.MathSkill" + module: "signalwire.skills.math.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py" +--- +# `register_tools` + +Register math tools with the agent + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/math/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py) + +Line 30. diff --git a/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/setup.mdx new file mode 100644 index 0000000000..15c9cee9c0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/math/skill/math-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/math/skill/math-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.math.skill.MathSkill.setup" + parent: "signalwire.skills.math.skill.MathSkill" + module: "signalwire.skills.math.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py" +--- +# `setup` + +Setup the math skill + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/math/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/math/skill.py) + +Line 26. diff --git a/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/index.mdx new file mode 100644 index 0000000000..9c26819cc1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/mcp-gateway" +title: "mcp_gateway" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.mcp_gateway" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/__init__.py" +--- +# `mcp_gateway` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module mcp_gateway +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/mcp_gateway/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/index.mdx new file mode 100644 index 0000000000..424be07e94 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/mcp-gateway/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.mcp_gateway.skill" + parent: "signalwire.skills.mcp_gateway" + module: "signalwire.skills.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Properties + + + +## Classes + + + + MCP Gateway Skill - Bridge MCP servers with SWAIG functions + + + +## Source + +[`signalwire/signalwire/skills/mcp_gateway/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-global-data.mdx b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-global-data.mdx new file mode 100644 index 0000000000..b61fa31eaa --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-global-data" +title: "get_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill.get_global_data" + parent: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill" + module: "signalwire.skills.mcp_gateway.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py" +--- +# `get_global_data` + +Return global data for DataMap variables + +## Signature + +```python +get_global_data() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/skills/mcp_gateway/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py) + +Line 392. diff --git a/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-hints.mdx new file mode 100644 index 0000000000..d9aaaa1d36 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill.get_hints" + parent: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill" + module: "signalwire.skills.mcp_gateway.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py" +--- +# `get_hints` + +Return speech recognition hints + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/mcp_gateway/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py) + +Line 381. diff --git a/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..39a87aa026 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill.get_parameter_schema" + parent: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill" + module: "signalwire.skills.mcp_gateway.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py" +--- +# `get_parameter_schema` + +Get parameter schema for MCP Gateway skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/mcp_gateway/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py) + +Line 36. diff --git a/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..cf4178c0c0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill.get_prompt_sections" + parent: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill" + module: "signalwire.skills.mcp_gateway.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/mcp_gateway/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py) + +Line 401. diff --git a/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/index.mdx new file mode 100644 index 0000000000..deb3a3abbd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/index.mdx @@ -0,0 +1,76 @@ +--- +slug: "/reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill" +title: "MCPGatewaySkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill" + parent: "signalwire.skills.mcp_gateway.skill" + module: "signalwire.skills.mcp_gateway.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py" +--- +# `MCPGatewaySkill` + +MCP Gateway Skill - Bridge MCP servers with SWAIG functions + +This skill connects SignalWire agents to MCP (Model Context Protocol) servers +through a gateway service, dynamically creating SWAIG functions for MCP tools. + +## Signature + +```python +class MCPGatewaySkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + +## Methods + + + + Return global data for DataMap variables + + + + Return speech recognition hints + + + + Get parameter schema for MCP Gateway skill + + + + Return prompt sections to add to agent + + + + Register SWAIG tools from MCP services + + + + Setup and validate skill configuration + + + +## Source + +[`signalwire/signalwire/skills/mcp_gateway/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/register-tools.mdx new file mode 100644 index 0000000000..3d44f30722 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill.register_tools" + parent: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill" + module: "signalwire.skills.mcp_gateway.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py" +--- +# `register_tools` + +Register SWAIG tools from MCP services + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/mcp_gateway/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py) + +Line 185. diff --git a/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/setup.mdx new file mode 100644 index 0000000000..b01e37f675 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/mcp-gateway/skill/mcp-gateway-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill.setup" + parent: "signalwire.skills.mcp_gateway.skill.MCPGatewaySkill" + module: "signalwire.skills.mcp_gateway.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py" +--- +# `setup` + +Setup and validate skill configuration + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/mcp_gateway/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/mcp_gateway/skill.py) + +Line 118. diff --git a/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/index.mdx new file mode 100644 index 0000000000..d951ebcd9e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/native-vector-search" +title: "native_vector_search" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.native_vector_search" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/__init__.py" +--- +# `native_vector_search` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module native_vector_search +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/native_vector_search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/index.mdx new file mode 100644 index 0000000000..7364b5c150 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/native-vector-search/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.native_vector_search.skill" + parent: "signalwire.skills.native_vector_search" + module: "signalwire.skills.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Native vector search capability using local document indexes or remote search servers + + + +## Source + +[`signalwire/signalwire/skills/native_vector_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/cleanup.mdx b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/cleanup.mdx new file mode 100644 index 0000000000..6032c0ea75 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/cleanup" +title: "cleanup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill.cleanup" + parent: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill" + module: "signalwire.skills.native_vector_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py" +--- +# `cleanup` + +Cleanup when skill is removed or agent shuts down + +## Signature + +```python +cleanup() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/native_vector_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py) + +Line 818. diff --git a/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-global-data.mdx b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..b4bf305659 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-global-data" +title: "get_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill.get_global_data" + parent: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill" + module: "signalwire.skills.native_vector_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py" +--- +# `get_global_data` + +Return data to add to agent's global context + +## Signature + +```python +get_global_data() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/skills/native_vector_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py) + +Line 783. diff --git a/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-hints.mdx new file mode 100644 index 0000000000..a2bab7b9e3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill.get_hints" + parent: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill" + module: "signalwire.skills.native_vector_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py" +--- +# `get_hints` + +Return speech recognition hints for this skill + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/native_vector_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py) + +Line 767. diff --git a/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-instance-key.mdx new file mode 100644 index 0000000000..2bb043a28e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-instance-key.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill.get_instance_key" + parent: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill" + module: "signalwire.skills.native_vector_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py" +--- +# `get_instance_key` + +Get the key used to track this skill instance + +For native vector search, we use the tool name to differentiate instances + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/native_vector_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py) + +Line 231. diff --git a/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..090361abe6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-parameter-schema.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill.get_parameter_schema" + parent: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill" + module: "signalwire.skills.native_vector_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py" +--- +# `get_parameter_schema` + +Get parameter schema for Native Vector Search skill + +This skill supports three modes of operation: + +1. Network Mode: Set 'remote\_url' to connect to a remote search server +2. Local pgvector: Set backend='pgvector' with connection\_string and collection\_name +3. Local SQLite: Set 'index\_file' to use a local .swsearch file (default) + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/native_vector_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py) + +Line 31. diff --git a/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..c5794f029b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill.get_prompt_sections" + parent: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill" + module: "signalwire.skills.native_vector_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/native_vector_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py) + +Line 796. diff --git a/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/index.mdx new file mode 100644 index 0000000000..67a7a20a8c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill" +title: "NativeVectorSearchSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill" + parent: "signalwire.skills.native_vector_search.skill" + module: "signalwire.skills.native_vector_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py" +--- +# `NativeVectorSearchSkill` + +Native vector search capability using local document indexes or remote search servers + +## Signature + +```python +class NativeVectorSearchSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + +## Methods + + + + Cleanup when skill is removed or agent shuts down + + + + Return data to add to agent's global context + + + + Return speech recognition hints for this skill + + + + Get the key used to track this skill instance + + + + Get parameter schema for Native Vector Search skill + + + + Return prompt sections to add to agent + + + + Register native vector search tool with the agent + + + + Setup the native vector search skill + + + +## Source + +[`signalwire/signalwire/skills/native_vector_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py) + +Line 19. diff --git a/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/register-tools.mdx new file mode 100644 index 0000000000..9cf4b3d29e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill.register_tools" + parent: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill" + module: "signalwire.skills.native_vector_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py" +--- +# `register_tools` + +Register native vector search tool with the agent + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/native_vector_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py) + +Line 468. diff --git a/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/setup.mdx new file mode 100644 index 0000000000..1c5fc14a8b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/native-vector-search/skill/native-vector-search-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill.setup" + parent: "signalwire.skills.native_vector_search.skill.NativeVectorSearchSkill" + module: "signalwire.skills.native_vector_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py" +--- +# `setup` + +Setup the native vector search skill + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/native_vector_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/native_vector_search/skill.py) + +Line 241. diff --git a/fern/products/sdk-reference/python/signalwire/skills/play-background-file/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/index.mdx new file mode 100644 index 0000000000..66ed16995d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/play-background-file" +title: "play_background_file" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.play_background_file" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/__init__.py" +--- +# `play_background_file` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module play_background_file +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/play_background_file/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/index.mdx new file mode 100644 index 0000000000..2abd199a7a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/play-background-file/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.play_background_file.skill" + parent: "signalwire.skills.play_background_file" + module: "signalwire.skills.play_background_file" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Skill for playing background files (audio/video) with configurable tool names. + + + +## Source + +[`signalwire/signalwire/skills/play_background_file/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-instance-key.mdx new file mode 100644 index 0000000000..cbb81c9a4a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-instance-key.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill.get_instance_key" + parent: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill" + module: "signalwire.skills.play_background_file.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py" +--- +# `get_instance_key` + +Generate a unique instance key for this skill configuration. + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` — Unique key combining skill name and tool name + +## Source + +[`signalwire/signalwire/skills/play_background_file/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py) + +Line 131. diff --git a/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..4b30c2c376 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill.get_parameter_schema" + parent: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill" + module: "signalwire.skills.play_background_file.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py" +--- +# `get_parameter_schema` + +Get parameter schema for Play Background File skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/play_background_file/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py) + +Line 51. diff --git a/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-tools.mdx new file mode 100644 index 0000000000..e4a76c1170 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/get-tools" +title: "get_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill.get_tools" + parent: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill" + module: "signalwire.skills.play_background_file.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py" +--- +# `get_tools` + +Generate the SWAIG tool with DataMap expressions. + +## Signature + +```python +get_tools() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` — List containing the generated tool configuration + +## Source + +[`signalwire/signalwire/skills/play_background_file/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py) + +Line 158. diff --git a/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/index.mdx new file mode 100644 index 0000000000..2a10b538a4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/index.mdx @@ -0,0 +1,94 @@ +--- +slug: "/reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill" +title: "PlayBackgroundFileSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill" + parent: "signalwire.skills.play_background_file.skill" + module: "signalwire.skills.play_background_file.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py" +--- +# `PlayBackgroundFileSkill` + +Skill for playing background files (audio/video) with configurable tool names. + +Supports multiple instances with different tool names and file collections. +Uses DataMap for serverless execution with dynamic enum generation. + +Configuration: + +- tool\_name: Custom name for the generated SWAIG function +- files: Array of file objects with key, description, url, and optional wait + +> \[!NOTE] +> agent.add\_skill("play\_background\_file", \{ +> "tool\_name": "play\_testimonial", +> "files": \[ +> \{ +> "key": "massey", +> "description": "Customer success story from Massey Energy", +> "url": "https://example.com/massey.mp4", +> "wait": True +> \} +> ] +> \}) + +## Signature + +```python +class PlayBackgroundFileSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + +## Methods + + + + Initialize the skill with configuration parameters. + + + + Generate a unique instance key for this skill configuration. + + + + Get parameter schema for Play Background File skill + + + + Generate the SWAIG tool with DataMap expressions. + + + + Register SWAIG tools with the agent + + + + Setup the skill - no external dependencies needed. + + + +## Source + +[`signalwire/signalwire/skills/play_background_file/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/init.mdx b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/init.mdx new file mode 100644 index 0000000000..c0c22bd3d0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/init.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill.__init__" + parent: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill" + module: "signalwire.skills.play_background_file.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py" +--- +# `__init__` + +Initialize the skill with configuration parameters. + +## Signature + +```python +__init__(agent, params: Dict[str, Any] = None) +``` + +## Parameters + + + The agent instance this skill belongs to + + + + Configuration dictionary containing: + + +## Source + +[`signalwire/signalwire/skills/play_background_file/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py) + +Line 87. diff --git a/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/register-tools.mdx new file mode 100644 index 0000000000..0dd7598a88 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill.register_tools" + parent: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill" + module: "signalwire.skills.play_background_file.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py" +--- +# `register_tools` + +Register SWAIG tools with the agent + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/play_background_file/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py) + +Line 149. diff --git a/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/setup.mdx new file mode 100644 index 0000000000..d4ca73cf2c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/play-background-file/skill/play-background-file-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill.setup" + parent: "signalwire.skills.play_background_file.skill.PlayBackgroundFileSkill" + module: "signalwire.skills.play_background_file.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py" +--- +# `setup` + +Setup the skill - no external dependencies needed. + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` — True if setup successful + +## Source + +[`signalwire/signalwire/skills/play_background_file/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/play_background_file/skill.py) + +Line 140. diff --git a/fern/products/sdk-reference/python/signalwire/skills/registry/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/registry/index.mdx new file mode 100644 index 0000000000..fd34fcf98e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/registry/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/registry" +title: "registry" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.registry" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py" +--- +# `registry` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module registry +``` + +## Properties + + + +## Classes + + + + Global registry for on-demand skill loading + + + +## Source + +[`signalwire/signalwire/skills/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/add-skill-directory.mdx b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/add-skill-directory.mdx new file mode 100644 index 0000000000..3d763b43b1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/add-skill-directory.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/python/signalwire/skills/registry/skill-registry/add-skill-directory" +title: "add_skill_directory" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.registry.SkillRegistry.add_skill_directory" + parent: "signalwire.skills.registry.SkillRegistry" + module: "signalwire.skills.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py" +--- +# `add_skill_directory` + +Add a directory to search for skills + +This allows third-party skill collections to be registered by path. +Skills in these directories should follow the same structure as built-in skills: + +- Each skill in its own subdirectory +- skill.py file containing the skill class + +> \[!NOTE] +> skill\_registry.add\_skill\_directory('/opt/custom\_skills') +> +> # Now agent.add\_skill('my\_custom\_skill') will search in this directory + +## Signature + +```python +add_skill_directory(path: str) -> None +``` + +## Parameters + + + Path to directory containing skill subdirectories + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py) + +Line 350. diff --git a/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/discover-skills.mdx b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/discover-skills.mdx new file mode 100644 index 0000000000..4aba179a86 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/discover-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/registry/skill-registry/discover-skills" +title: "discover_skills" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.registry.SkillRegistry.discover_skills" + parent: "signalwire.skills.registry.SkillRegistry" + module: "signalwire.skills.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py" +--- +# `discover_skills` + +Deprecated: Skills are now loaded on-demand + +## Signature + +```python +discover_skills() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py) + +Line 122. diff --git a/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/get-all-skills-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/get-all-skills-schema.mdx new file mode 100644 index 0000000000..8bc2d44a93 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/get-all-skills-schema.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/python/signalwire/skills/registry/skill-registry/get-all-skills-schema" +title: "get_all_skills_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.registry.SkillRegistry.get_all_skills_schema" + parent: "signalwire.skills.registry.SkillRegistry" + module: "signalwire.skills.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py" +--- +# `get_all_skills_schema` + +Get complete schema for all available skills including parameter metadata + +This method scans all available skills and returns a comprehensive schema +that includes skill metadata and parameter definitions suitable for GUI +configuration or API documentation. + +> \[!NOTE] +> \{ +> "web\_search": \{ +> "name": "web\_search", +> "description": "Search the web for information", +> "version": "1.0.0", +> "supports\_multiple\_instances": True, +> "required\_packages": \["bs4", "requests"], +> "required\_env\_vars": \[], +> "parameters": \{ +> "api\_key": \{ +> "type": "string", +> "description": "Google API key", +> "required": True, +> "hidden": True, +> "env\_var": "GOOGLE\_SEARCH\_API\_KEY" +> \}, +> ... +> \}, +> "source": "built-in" +> \} +> \} + +## Signature + +```python +get_all_skills_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` — Dict\[str, Dict\[str, Any]]: Complete skill schema where keys are skill names and values contain: + +## Source + +[`signalwire/signalwire/skills/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py) + +Line 229. diff --git a/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/get-skill-class.mdx b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/get-skill-class.mdx new file mode 100644 index 0000000000..7cefb0e71f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/get-skill-class.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/skills/registry/skill-registry/get-skill-class" +title: "get_skill_class" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.registry.SkillRegistry.get_skill_class" + parent: "signalwire.skills.registry.SkillRegistry" + module: "signalwire.skills.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py" +--- +# `get_skill_class` + +Get skill class by name, loading on-demand if needed + +## Signature + +```python +get_skill_class(skill_name: str) -> Optional[Type[SkillBase]] +``` + +## Parameters + + + +## Returns + +`Optional[Type[SkillBase]]` + +## Source + +[`signalwire/signalwire/skills/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py) + +Line 196. diff --git a/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/index.mdx new file mode 100644 index 0000000000..947d4ea8a4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/python/signalwire/skills/registry/skill-registry" +title: "SkillRegistry" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.registry.SkillRegistry" + parent: "signalwire.skills.registry" + module: "signalwire.skills.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py" +--- +# `SkillRegistry` + +Global registry for on-demand skill loading + +## Signature + +```python +class SkillRegistry +``` + +## Properties + + + +## Methods + + + + + + Add a directory to search for skills + + + + Deprecated: Skills are now loaded on-demand + + + + Get complete schema for all available skills including parameter metadata + + + + Get skill class by name, loading on-demand if needed + + + + List all skill sources and the skills available from each + + + + List all available skills by scanning directories (only when explicitly requested) + + + + Register a skill class directly + + + +## Source + +[`signalwire/signalwire/skills/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/init.mdx b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/init.mdx new file mode 100644 index 0000000000..380e9e18fd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/init.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/python/signalwire/skills/registry/skill-registry/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.registry.SkillRegistry.__init__" + parent: "signalwire.skills.registry.SkillRegistry" + module: "signalwire.skills.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py" +--- +# `__init__` + +## Signature + +```python +__init__() +``` + +## Source + +[`signalwire/signalwire/skills/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py) + +Line 25. diff --git a/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/list-all-skill-sources.mdx b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/list-all-skill-sources.mdx new file mode 100644 index 0000000000..bd0a5158e4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/list-all-skill-sources.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/skills/registry/skill-registry/list-all-skill-sources" +title: "list_all_skill_sources" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.registry.SkillRegistry.list_all_skill_sources" + parent: "signalwire.skills.registry.SkillRegistry" + module: "signalwire.skills.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py" +--- +# `list_all_skill_sources` + +List all skill sources and the skills available from each + +Returns a dictionary mapping source types to lists of skill names: +\{ +'built-in': \['datetime', 'math', ...], +'external\_paths': \['custom\_skill1', ...], +'entry\_points': \['weather', ...], +'registered': \['my\_skill', ...] +\} + +## Signature + +```python +list_all_skill_sources() -> Dict[str, List[str]] +``` + +## Returns + +`Dict[str, List[str]]` + +## Source + +[`signalwire/signalwire/skills/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py) + +Line 436. diff --git a/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/list-skills.mdx b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/list-skills.mdx new file mode 100644 index 0000000000..2b800a16e4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/list-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/registry/skill-registry/list-skills" +title: "list_skills" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.registry.SkillRegistry.list_skills" + parent: "signalwire.skills.registry.SkillRegistry" + module: "signalwire.skills.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py" +--- +# `list_skills` + +List all available skills by scanning directories (only when explicitly requested) + +## Signature + +```python +list_skills() -> List[Dict[str, str]] +``` + +## Returns + +`List[Dict[str, str]]` + +## Source + +[`signalwire/signalwire/skills/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py) + +Line 205. diff --git a/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/register-skill.mdx b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/register-skill.mdx new file mode 100644 index 0000000000..bb4ed14e7b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/registry/skill-registry/register-skill.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/python/signalwire/skills/registry/skill-registry/register-skill" +title: "register_skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.registry.SkillRegistry.register_skill" + parent: "signalwire.skills.registry.SkillRegistry" + module: "signalwire.skills.registry" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py" +--- +# `register_skill` + +Register a skill class directly + +This allows third-party code to register skill classes without +requiring them to be in a specific directory structure. + +> \[!NOTE] +> from my\_custom\_skills import MyWeatherSkill +> skill\_registry.register\_skill(MyWeatherSkill) + +## Signature + +```python +register_skill(skill_class: Type[SkillBase]) -> None +``` + +## Parameters + + + A class that inherits from SkillBase + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/registry.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/registry.py) + +Line 132. diff --git a/fern/products/sdk-reference/python/signalwire/skills/spider/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/spider/index.mdx new file mode 100644 index 0000000000..e60a697bdc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/spider/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/spider" +title: "spider" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.spider" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/__init__.py" +--- +# `spider` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module spider +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/spider/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/spider/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/index.mdx new file mode 100644 index 0000000000..2106382b91 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/spider/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.spider.skill" + parent: "signalwire.skills.spider" + module: "signalwire.skills.spider" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Fast web scraping skill optimized for speed and token efficiency. + + + +## Source + +[`signalwire/signalwire/skills/spider/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/cleanup.mdx b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/cleanup.mdx new file mode 100644 index 0000000000..3846970787 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/spider/skill/spider-skill/cleanup" +title: "cleanup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.spider.skill.SpiderSkill.cleanup" + parent: "signalwire.skills.spider.skill.SpiderSkill" + module: "signalwire.skills.spider.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py" +--- +# `cleanup` + +Clean up resources when skill is unloaded. + +## Signature + +```python +cleanup() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/spider/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py) + +Line 620. diff --git a/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/get-hints.mdx new file mode 100644 index 0000000000..60d2dc8e0b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/spider/skill/spider-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.spider.skill.SpiderSkill.get_hints" + parent: "signalwire.skills.spider.skill.SpiderSkill" + module: "signalwire.skills.spider.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py" +--- +# `get_hints` + +Return speech recognition hints for this skill. + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/spider/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py) + +Line 613. diff --git a/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/get-instance-key.mdx new file mode 100644 index 0000000000..6ae75e4192 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/get-instance-key.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/spider/skill/spider-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.spider.skill.SpiderSkill.get_instance_key" + parent: "signalwire.skills.spider.skill.SpiderSkill" + module: "signalwire.skills.spider.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py" +--- +# `get_instance_key` + +Return unique key for this skill instance. + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/spider/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py) + +Line 191. diff --git a/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..ad2cb96034 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/spider/skill/spider-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.spider.skill.SpiderSkill.get_parameter_schema" + parent: "signalwire.skills.spider.skill.SpiderSkill" + module: "signalwire.skills.spider.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py" +--- +# `get_parameter_schema` + +Get parameter schema for Spider skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/spider/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py) + +Line 37. diff --git a/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/index.mdx new file mode 100644 index 0000000000..9cb02b7cad --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/index.mdx @@ -0,0 +1,111 @@ +--- +slug: "/reference/python/signalwire/skills/spider/skill/spider-skill" +title: "SpiderSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.spider.skill.SpiderSkill" + parent: "signalwire.skills.spider.skill" + module: "signalwire.skills.spider.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py" +--- +# `SpiderSkill` + +Fast web scraping skill optimized for speed and token efficiency. + +## Signature + +```python +class SpiderSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + Initialize the spider skill with configuration parameters. + + + + Clean up resources when skill is unloaded. + + + + Return speech recognition hints for this skill. + + + + Return unique key for this skill instance. + + + + Get parameter schema for Spider skill + + + + Register the web scraping tools with the agent. + + + + Validate configuration and setup the skill. + + + +## Source + +[`signalwire/signalwire/skills/spider/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py) + +Line 24. diff --git a/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/init.mdx b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/init.mdx new file mode 100644 index 0000000000..b588b32493 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/skills/spider/skill/spider-skill/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.spider.skill.SpiderSkill.__init__" + parent: "signalwire.skills.spider.skill.SpiderSkill" + module: "signalwire.skills.spider.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py" +--- +# `__init__` + +Initialize the spider skill with configuration parameters. + +## Signature + +```python +__init__(agent, params: Dict[str, Any]) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/skills/spider/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py) + +Line 150. diff --git a/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/register-tools.mdx new file mode 100644 index 0000000000..c578ddd4c8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/spider/skill/spider-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.spider.skill.SpiderSkill.register_tools" + parent: "signalwire.skills.spider.skill.SpiderSkill" + module: "signalwire.skills.spider.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py" +--- +# `register_tools` + +Register the web scraping tools with the agent. + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/spider/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py) + +Line 229. diff --git a/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/setup.mdx new file mode 100644 index 0000000000..9c9a961ec7 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/spider/skill/spider-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/spider/skill/spider-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.spider.skill.SpiderSkill.setup" + parent: "signalwire.skills.spider.skill.SpiderSkill" + module: "signalwire.skills.spider.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py" +--- +# `setup` + +Validate configuration and setup the skill. + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/spider/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/spider/skill.py) + +Line 196. diff --git a/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/index.mdx new file mode 100644 index 0000000000..1fe3afd3da --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/swml-transfer" +title: "swml_transfer" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.swml_transfer" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/__init__.py" +--- +# `swml_transfer` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module swml_transfer +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/swml_transfer/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/index.mdx new file mode 100644 index 0000000000..1da8a564d9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/swml-transfer/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.swml_transfer.skill" + parent: "signalwire.skills.swml_transfer" + module: "signalwire.skills.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Skill for transferring calls between agents using SWML with pattern matching + + + +## Source + +[`signalwire/signalwire/skills/swml_transfer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-hints.mdx new file mode 100644 index 0000000000..62a161a25f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill.get_hints" + parent: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill" + module: "signalwire.skills.swml_transfer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py" +--- +# `get_hints` + +Return speech recognition hints + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/swml_transfer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py) + +Line 266. diff --git a/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-instance-key.mdx new file mode 100644 index 0000000000..d565886ed1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-instance-key.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill.get_instance_key" + parent: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill" + module: "signalwire.skills.swml_transfer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py" +--- +# `get_instance_key` + +Get the key used to track this skill instance + +For SWML transfer, we use the tool name to differentiate instances + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/swml_transfer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py) + +Line 120. diff --git a/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..7fc04e7cd6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill.get_parameter_schema" + parent: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill" + module: "signalwire.skills.swml_transfer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py" +--- +# `get_parameter_schema` + +Get parameter schema for SWML Transfer skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/swml_transfer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py) + +Line 30. diff --git a/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..aa05887bd1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill.get_prompt_sections" + parent: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill" + module: "signalwire.skills.swml_transfer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/swml_transfer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py) + +Line 297. diff --git a/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/index.mdx new file mode 100644 index 0000000000..5a632368e4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/index.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill" +title: "SWMLTransferSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill" + parent: "signalwire.skills.swml_transfer.skill" + module: "signalwire.skills.swml_transfer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py" +--- +# `SWMLTransferSkill` + +Skill for transferring calls between agents using SWML with pattern matching + +## Signature + +```python +class SWMLTransferSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + +## Methods + + + + Return speech recognition hints + + + + Get the key used to track this skill instance + + + + Get parameter schema for SWML Transfer skill + + + + Return prompt sections to add to agent + + + + Register the transfer tool with pattern matching + + + + Setup and validate skill configuration + + + +## Source + +[`signalwire/signalwire/skills/swml_transfer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py) + +Line 18. diff --git a/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/register-tools.mdx new file mode 100644 index 0000000000..354836834b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill.register_tools" + parent: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill" + module: "signalwire.skills.swml_transfer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py" +--- +# `register_tools` + +Register the transfer tool with pattern matching + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/swml_transfer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py) + +Line 180. diff --git a/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/setup.mdx new file mode 100644 index 0000000000..010564484d --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/swml-transfer/skill/swml-transfer-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill.setup" + parent: "signalwire.skills.swml_transfer.skill.SWMLTransferSkill" + module: "signalwire.skills.swml_transfer.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py" +--- +# `setup` + +Setup and validate skill configuration + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/swml_transfer/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/swml_transfer/skill.py) + +Line 129. diff --git a/fern/products/sdk-reference/python/signalwire/skills/weather-api/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/weather-api/index.mdx new file mode 100644 index 0000000000..abd743d584 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/weather-api/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/weather-api" +title: "weather_api" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.weather_api" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/__init__.py" +--- +# `weather_api` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module weather_api +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/weather_api/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/index.mdx new file mode 100644 index 0000000000..3773152ba6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/weather-api/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.weather_api.skill" + parent: "signalwire.skills.weather_api" + module: "signalwire.skills.weather_api" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Skill for getting weather information from WeatherAPI.com. + + + +## Source + +[`signalwire/signalwire/skills/weather_api/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..a6a299194b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/weather-api/skill/weather-api-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.weather_api.skill.WeatherApiSkill.get_parameter_schema" + parent: "signalwire.skills.weather_api.skill.WeatherApiSkill" + module: "signalwire.skills.weather_api.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py" +--- +# `get_parameter_schema` + +Get parameter schema for weather API skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/weather_api/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py) + +Line 47. diff --git a/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/get-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/get-tools.mdx new file mode 100644 index 0000000000..d5f5438cdf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/get-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/weather-api/skill/weather-api-skill/get-tools" +title: "get_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.weather_api.skill.WeatherApiSkill.get_tools" + parent: "signalwire.skills.weather_api.skill.WeatherApiSkill" + module: "signalwire.skills.weather_api.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py" +--- +# `get_tools` + +Generate the SWAIG tool with DataMap webhook. + +## Signature + +```python +get_tools() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` — List containing the generated tool configuration + +## Source + +[`signalwire/signalwire/skills/weather_api/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py) + +Line 125. diff --git a/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/index.mdx new file mode 100644 index 0000000000..f7ce176266 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/index.mdx @@ -0,0 +1,89 @@ +--- +slug: "/reference/python/signalwire/skills/weather-api/skill/weather-api-skill" +title: "WeatherApiSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.weather_api.skill.WeatherApiSkill" + parent: "signalwire.skills.weather_api.skill" + module: "signalwire.skills.weather_api.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py" +--- +# `WeatherApiSkill` + +Skill for getting weather information from WeatherAPI.com. + +Provides current weather data with configurable temperature units and +TTS-optimized natural language responses. + +Configuration: + +- tool\_name: Custom name for the generated SWAIG function +- api\_key: WeatherAPI.com API key +- temperature\_unit: "fahrenheit" or "celsius" for temperature display + +> \[!NOTE] +> agent.add\_skill("weather\_api", \{ +> "tool\_name": "get\_weather", +> "api\_key": "your\_weatherapi\_key", +> "temperature\_unit": "fahrenheit" +> \}) + +## Signature + +```python +class WeatherApiSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + + + +## Methods + + + + Initialize the skill with configuration parameters. + + + + Get parameter schema for weather API skill + + + + Generate the SWAIG tool with DataMap webhook. + + + + Register SWAIG tools with the agent + + + + Setup the skill - validates API key is available. + + + +## Source + +[`signalwire/signalwire/skills/weather_api/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/init.mdx b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/init.mdx new file mode 100644 index 0000000000..9f65cc078f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/init.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/skills/weather-api/skill/weather-api-skill/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.weather_api.skill.WeatherApiSkill.__init__" + parent: "signalwire.skills.weather_api.skill.WeatherApiSkill" + module: "signalwire.skills.weather_api.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py" +--- +# `__init__` + +Initialize the skill with configuration parameters. + +## Signature + +```python +__init__(agent, params: Dict[str, Any] = None) +``` + +## Parameters + + + The agent instance this skill belongs to + + + + Configuration dictionary containing: + + +## Source + +[`signalwire/signalwire/skills/weather_api/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py) + +Line 75. diff --git a/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/register-tools.mdx new file mode 100644 index 0000000000..8465f71daf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/weather-api/skill/weather-api-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.weather_api.skill.WeatherApiSkill.register_tools" + parent: "signalwire.skills.weather_api.skill.WeatherApiSkill" + module: "signalwire.skills.weather_api.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py" +--- +# `register_tools` + +Register SWAIG tools with the agent + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/weather_api/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py) + +Line 116. diff --git a/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/setup.mdx new file mode 100644 index 0000000000..5353d443b0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/weather-api/skill/weather-api-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/weather-api/skill/weather-api-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.weather_api.skill.WeatherApiSkill.setup" + parent: "signalwire.skills.weather_api.skill.WeatherApiSkill" + module: "signalwire.skills.weather_api.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py" +--- +# `setup` + +Setup the skill - validates API key is available. + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` — True if setup successful + +## Source + +[`signalwire/signalwire/skills/weather_api/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/weather_api/skill.py) + +Line 106. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/index.mdx new file mode 100644 index 0000000000..c4ccdb3eb1 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/skills/web-search" +title: "web_search" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.web_search" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/__init__.py" +--- +# `web_search` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module web_search +``` + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/web_search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/extract-text-from-url.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/extract-text-from-url.mdx new file mode 100644 index 0000000000..badd832184 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/extract-text-from-url.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/extract-text-from-url" +title: "extract_text_from_url" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.GoogleSearchScraper.extract_text_from_url" + parent: "signalwire.skills.web_search.skill_improved.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `extract_text_from_url` + +Scrape a URL and extract readable text content with quality metrics + +## Signature + +```python +extract_text_from_url( + url: str, + content_limit: int = None, + timeout: int = 10 +) -> Tuple[str, Dict[str, Any]] +``` + +## Parameters + + + + + + + +## Returns + +`Tuple[str, Dict[str, Any]]` — Tuple of (text\_content, quality\_metrics) + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 66. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/index.mdx new file mode 100644 index 0000000000..c143d76584 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper" +title: "GoogleSearchScraper" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.GoogleSearchScraper" + parent: "signalwire.skills.web_search.skill_improved" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `GoogleSearchScraper` + +Google Search and Web Scraping functionality with quality scoring + +## Signature + +```python +class GoogleSearchScraper +``` + +## Properties + + + + + + + + + +## Methods + + + + + + Scrape a URL and extract readable text content with quality metrics + + + + Backward compatible method that uses the improved search + + + + Search and scrape with quality filtering + + + + Search Google using Custom Search JSON API + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/init.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/init.mdx new file mode 100644 index 0000000000..4fb2d46fa4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.GoogleSearchScraper.__init__" + parent: "signalwire.skills.web_search.skill_improved.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `__init__` + +## Signature + +```python +__init__(api_key: str, search_engine_id: str, max_content_length: int = 32768) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 25. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-and-scrape-best.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-and-scrape-best.mdx new file mode 100644 index 0000000000..55831e5cf0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-and-scrape-best.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-and-scrape-best" +title: "search_and_scrape_best" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.GoogleSearchScraper.search_and_scrape_best" + parent: "signalwire.skills.web_search.skill_improved.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `search_and_scrape_best` + +Search and scrape with quality filtering + +## Signature + +```python +search_and_scrape_best( + query: str, + num_results: int = 3, + oversample_factor: float = 2.5, + delay: float = 0.5, + min_quality_score: float = 0.3 +) -> str +``` + +## Parameters + + + Search query + + + + Number of best results to return + + + + How many extra results to fetch (e.g., 2.5 = fetch 2.5x) + + + + Delay between requests + + + + Minimum quality score to include a result + + +## Returns + +`str` — Formatted string with the best N results + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 243. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-and-scrape.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-and-scrape.mdx new file mode 100644 index 0000000000..9a254de62c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-and-scrape.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-and-scrape" +title: "search_and_scrape" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.GoogleSearchScraper.search_and_scrape" + parent: "signalwire.skills.web_search.skill_improved.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `search_and_scrape` + +Backward compatible method that uses the improved search + +## Signature + +```python +search_and_scrape(query: str, num_results: int = 3, delay: float = 0.5) -> str +``` + +## Parameters + + + + + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 328. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-google.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-google.mdx new file mode 100644 index 0000000000..126ac4e5c6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-google.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/google-search-scraper/search-google" +title: "search_google" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.GoogleSearchScraper.search_google" + parent: "signalwire.skills.web_search.skill_improved.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `search_google` + +Search Google using Custom Search JSON API + +## Signature + +```python +search_google(query: str, num_results: int = 5) -> list +``` + +## Parameters + + + + + +## Returns + +`list` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 34. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/index.mdx new file mode 100644 index 0000000000..80976dde4f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved" +title: "skill_improved" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved" + parent: "signalwire.skills.web_search" + module: "signalwire.skills.web_search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `skill_improved` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill_improved +``` + +## Classes + + + + Google Search and Web Scraping functionality with quality scoring + + + + Web search capability using Google Custom Search API with quality filtering + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-global-data.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..cdafd92eaf --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-global-data" +title: "get_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.WebSearchSkill.get_global_data" + parent: "signalwire.skills.web_search.skill_improved.WebSearchSkill" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `get_global_data` + +Return global data for agent context + +## Signature + +```python +get_global_data() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 457. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-hints.mdx new file mode 100644 index 0000000000..87fe46bc15 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.WebSearchSkill.get_hints" + parent: "signalwire.skills.web_search.skill_improved.WebSearchSkill" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `get_hints` + +Return speech recognition hints + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 453. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-instance-key.mdx new file mode 100644 index 0000000000..af5adf40d9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-instance-key.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.WebSearchSkill.get_instance_key" + parent: "signalwire.skills.web_search.skill_improved.WebSearchSkill" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `get_instance_key` + +Get the key used to track this skill instance + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 353. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..15f27cd18b --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.WebSearchSkill.get_parameter_schema" + parent: "signalwire.skills.web_search.skill_improved.WebSearchSkill" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `get_parameter_schema` + +Get the parameter schema for the web search skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 480. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..e11f7ed8fe --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.WebSearchSkill.get_prompt_sections" + parent: "signalwire.skills.web_search.skill_improved.WebSearchSkill" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 465. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/index.mdx new file mode 100644 index 0000000000..fd80632cf6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/web-search-skill" +title: "WebSearchSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.WebSearchSkill" + parent: "signalwire.skills.web_search.skill_improved" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `WebSearchSkill` + +Web search capability using Google Custom Search API with quality filtering + +## Signature + +```python +class WebSearchSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + +## Methods + + + + Return global data for agent context + + + + Return speech recognition hints + + + + Get the key used to track this skill instance + + + + Get the parameter schema for the web search skill + + + + Return prompt sections to add to agent + + + + Register web search tool with the agent + + + + Setup the web search skill + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 341. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/register-tools.mdx new file mode 100644 index 0000000000..adcae5ef99 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.WebSearchSkill.register_tools" + parent: "signalwire.skills.web_search.skill_improved.WebSearchSkill" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `register_tools` + +Register web search tool with the agent + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 402. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/setup.mdx new file mode 100644 index 0000000000..1047ab0083 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-improved/web-search-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_improved.WebSearchSkill.setup" + parent: "signalwire.skills.web_search.skill_improved.WebSearchSkill" + module: "signalwire.skills.web_search.skill_improved" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py" +--- +# `setup` + +Setup the web search skill + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_improved.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_improved.py) + +Line 359. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/extract-text-from-url.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/extract-text-from-url.mdx new file mode 100644 index 0000000000..ea601d58f0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/extract-text-from-url.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/extract-text-from-url" +title: "extract_text_from_url" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.GoogleSearchScraper.extract_text_from_url" + parent: "signalwire.skills.web_search.skill_original.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `extract_text_from_url` + +Scrape a URL and extract readable text content + +## Signature + +```python +extract_text_from_url( + url: str, + content_limit: int = None, + timeout: int = 10 +) -> str +``` + +## Parameters + + + URL to scrape + + + + Maximum characters to return (uses self.max\_content\_length if not provided) + + + + Request timeout in seconds + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 65. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/index.mdx new file mode 100644 index 0000000000..834be26d15 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/google-search-scraper" +title: "GoogleSearchScraper" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.GoogleSearchScraper" + parent: "signalwire.skills.web_search.skill_original" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `GoogleSearchScraper` + +Google Search and Web Scraping functionality + +## Signature + +```python +class GoogleSearchScraper +``` + +## Properties + + + + + + + + + +## Methods + + + + + + Scrape a URL and extract readable text content + + + + Main function: search Google and scrape the resulting pages + + + + Search Google using Custom Search JSON API + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 21. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/init.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/init.mdx new file mode 100644 index 0000000000..6cc2594382 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.GoogleSearchScraper.__init__" + parent: "signalwire.skills.web_search.skill_original.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `__init__` + +## Signature + +```python +__init__(api_key: str, search_engine_id: str, max_content_length: int = 32768) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 24. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/search-and-scrape.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/search-and-scrape.mdx new file mode 100644 index 0000000000..7d86130eba --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/search-and-scrape.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/search-and-scrape" +title: "search_and_scrape" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.GoogleSearchScraper.search_and_scrape" + parent: "signalwire.skills.web_search.skill_original.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `search_and_scrape` + +Main function: search Google and scrape the resulting pages + +Dynamically calculates per-result content limit based on total max\_content\_length +and number of results to ensure total response stays within bounds. + +## Signature + +```python +search_and_scrape(query: str, num_results: int = 3, delay: float = 0.5) -> str +``` + +## Parameters + + + + + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 100. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/search-google.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/search-google.mdx new file mode 100644 index 0000000000..d1e28d631e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/search-google.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/google-search-scraper/search-google" +title: "search_google" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.GoogleSearchScraper.search_google" + parent: "signalwire.skills.web_search.skill_original.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `search_google` + +Search Google using Custom Search JSON API + +## Signature + +```python +search_google(query: str, num_results: int = 5) -> list +``` + +## Parameters + + + + + +## Returns + +`list` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 33. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/index.mdx new file mode 100644 index 0000000000..9554575b1e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original" +title: "skill_original" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original" + parent: "signalwire.skills.web_search" + module: "signalwire.skills.web_search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `skill_original` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill_original +``` + +## Classes + + + + Google Search and Web Scraping functionality + + + + Web search capability using Google Custom Search API + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-global-data.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..d99a58789f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-global-data" +title: "get_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.WebSearchSkill.get_global_data" + parent: "signalwire.skills.web_search.skill_original.WebSearchSkill" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `get_global_data` + +Return global data for agent context + +## Signature + +```python +get_global_data() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 265. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-hints.mdx new file mode 100644 index 0000000000..5242138747 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.WebSearchSkill.get_hints" + parent: "signalwire.skills.web_search.skill_original.WebSearchSkill" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `get_hints` + +Return speech recognition hints + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 256. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-instance-key.mdx new file mode 100644 index 0000000000..4e3f60e5f8 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-instance-key.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.WebSearchSkill.get_instance_key" + parent: "signalwire.skills.web_search.skill_original.WebSearchSkill" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `get_instance_key` + +Get the key used to track this skill instance + +For web search, we use the search\_engine\_id to differentiate instances + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 158. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..5d867c3926 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-parameter-schema.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.WebSearchSkill.get_parameter_schema" + parent: "signalwire.skills.web_search.skill_original.WebSearchSkill" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `get_parameter_schema` + +Get the parameter schema for the web search skill + +Returns all configurable parameters for web search including +API credentials, search settings, and response customization. + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 287. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..3e9e17c006 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/web-search-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.WebSearchSkill.get_prompt_sections" + parent: "signalwire.skills.web_search.skill_original.WebSearchSkill" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 272. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/index.mdx new file mode 100644 index 0000000000..b586944385 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/web-search-skill" +title: "WebSearchSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.WebSearchSkill" + parent: "signalwire.skills.web_search.skill_original" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `WebSearchSkill` + +Web search capability using Google Custom Search API + +## Signature + +```python +class WebSearchSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + +## Methods + + + + Return global data for agent context + + + + Return speech recognition hints + + + + Get the key used to track this skill instance + + + + Get the parameter schema for the web search skill + + + + Return prompt sections to add to agent + + + + Register web search tool with the agent + + + + Setup the web search skill + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 146. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/register-tools.mdx new file mode 100644 index 0000000000..e0160264e3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/web-search-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.WebSearchSkill.register_tools" + parent: "signalwire.skills.web_search.skill_original.WebSearchSkill" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `register_tools` + +Register web search tool with the agent + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 206. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/setup.mdx new file mode 100644 index 0000000000..fef98f9a60 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill-original/web-search-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill-original/web-search-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill_original.WebSearchSkill.setup" + parent: "signalwire.skills.web_search.skill_original.WebSearchSkill" + module: "signalwire.skills.web_search.skill_original" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py" +--- +# `setup` + +Setup the web search skill + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/web_search/skill_original.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill_original.py) + +Line 168. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-html-content.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-html-content.mdx new file mode 100644 index 0000000000..0a23618298 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-html-content.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-html-content" +title: "extract_html_content" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.GoogleSearchScraper.extract_html_content" + parent: "signalwire.skills.web_search.skill.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `extract_html_content` + +Original HTML extraction method (renamed from extract\_text\_from\_url) + +## Signature + +```python +extract_html_content( + url: str, + content_limit: int = None, + timeout: int = 10 +) -> Tuple[str, Dict[str, Any]] +``` + +## Parameters + + + + + + + +## Returns + +`Tuple[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 204. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-reddit-content.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-reddit-content.mdx new file mode 100644 index 0000000000..c9c7b9b76a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-reddit-content.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-reddit-content" +title: "extract_reddit_content" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.GoogleSearchScraper.extract_reddit_content" + parent: "signalwire.skills.web_search.skill.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `extract_reddit_content` + +Extract Reddit content using JSON API for better quality + +## Signature + +```python +extract_reddit_content( + url: str, + content_limit: int = None, + timeout: int = 10 +) -> Tuple[str, Dict[str, Any]] +``` + +## Parameters + + + + + + + +## Returns + +`Tuple[str, Dict[str, Any]]` — Tuple of (text\_content, quality\_metrics) + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 71. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-text-from-url.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-text-from-url.mdx new file mode 100644 index 0000000000..3848d149bd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-text-from-url.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/google-search-scraper/extract-text-from-url" +title: "extract_text_from_url" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.GoogleSearchScraper.extract_text_from_url" + parent: "signalwire.skills.web_search.skill.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `extract_text_from_url` + +Main extraction method that routes to appropriate extractor + +## Signature + +```python +extract_text_from_url( + url: str, + content_limit: int = None, + timeout: int = 10 +) -> Tuple[str, Dict[str, Any]] +``` + +## Parameters + + + + + + + +## Returns + +`Tuple[str, Dict[str, Any]]` — Tuple of (text\_content, quality\_metrics) + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 192. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/index.mdx new file mode 100644 index 0000000000..3b4f3aa795 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/google-search-scraper" +title: "GoogleSearchScraper" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.GoogleSearchScraper" + parent: "signalwire.skills.web_search.skill" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `GoogleSearchScraper` + +Google Search and Web Scraping functionality with quality scoring + +## Signature + +```python +class GoogleSearchScraper +``` + +## Properties + + + + + + + + + +## Methods + + + + + + Original HTML extraction method (renamed from extract\_text\_from\_url) + + + + Extract Reddit content using JSON API for better quality + + + + Main extraction method that routes to appropriate extractor + + + + Check if URL is from Reddit + + + + Backward compatible method that uses the improved search + + + + Search and scrape with quality filtering and source diversity + + + + Search Google using Custom Search JSON API + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/init.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/init.mdx new file mode 100644 index 0000000000..9990d584e5 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/init.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/google-search-scraper/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.GoogleSearchScraper.__init__" + parent: "signalwire.skills.web_search.skill.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `__init__` + +## Signature + +```python +__init__(api_key: str, search_engine_id: str, max_content_length: int = 32768) +``` + +## Parameters + + + + + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 25. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/is-reddit-url.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/is-reddit-url.mdx new file mode 100644 index 0000000000..4bff0fa105 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/is-reddit-url.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/google-search-scraper/is-reddit-url" +title: "is_reddit_url" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.GoogleSearchScraper.is_reddit_url" + parent: "signalwire.skills.web_search.skill.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `is_reddit_url` + +Check if URL is from Reddit + +## Signature + +```python +is_reddit_url(url: str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 66. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-and-scrape-best.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-and-scrape-best.mdx new file mode 100644 index 0000000000..b148bc54a6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-and-scrape-best.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-and-scrape-best" +title: "search_and_scrape_best" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.GoogleSearchScraper.search_and_scrape_best" + parent: "signalwire.skills.web_search.skill.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `search_and_scrape_best` + +Search and scrape with quality filtering and source diversity + +## Signature + +```python +search_and_scrape_best( + query: str, + num_results: int = 3, + oversample_factor: float = 4.0, + delay: float = 0.5, + min_quality_score: float = 0.2 +) -> str +``` + +## Parameters + + + Search query + + + + Number of best results to return + + + + How many extra results to fetch (e.g., 4.0 = fetch 4x) + + + + Delay between requests + + + + Minimum quality score to include a result + + +## Returns + +`str` — Formatted string with the best N results from diverse sources + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 416. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-and-scrape.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-and-scrape.mdx new file mode 100644 index 0000000000..1dfe82be93 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-and-scrape.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-and-scrape" +title: "search_and_scrape" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.GoogleSearchScraper.search_and_scrape" + parent: "signalwire.skills.web_search.skill.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `search_and_scrape` + +Backward compatible method that uses the improved search + +## Signature + +```python +search_and_scrape(query: str, num_results: int = 3, delay: float = 0.5) -> str +``` + +## Parameters + + + + + + + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 528. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-google.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-google.mdx new file mode 100644 index 0000000000..f36d4bdfb9 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-google.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/google-search-scraper/search-google" +title: "search_google" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.GoogleSearchScraper.search_google" + parent: "signalwire.skills.web_search.skill.GoogleSearchScraper" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `search_google` + +Search Google using Custom Search JSON API + +## Signature + +```python +search_google(query: str, num_results: int = 5) -> list +``` + +## Parameters + + + + + +## Returns + +`list` + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 34. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/index.mdx new file mode 100644 index 0000000000..3876c72e6e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.web_search.skill" + parent: "signalwire.skills.web_search" + module: "signalwire.skills.web_search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Google Search and Web Scraping functionality with quality scoring + + + + Web search capability using Google Custom Search API with quality filtering + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-global-data.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..3d2713d6db --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/web-search-skill/get-global-data" +title: "get_global_data" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.WebSearchSkill.get_global_data" + parent: "signalwire.skills.web_search.skill.WebSearchSkill" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `get_global_data` + +Return global data for agent context + +## Signature + +```python +get_global_data() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 669. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-hints.mdx new file mode 100644 index 0000000000..df4bd21c14 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/web-search-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.WebSearchSkill.get_hints" + parent: "signalwire.skills.web_search.skill.WebSearchSkill" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `get_hints` + +Return speech recognition hints + +## Signature + +```python +get_hints() -> List[str] +``` + +## Returns + +`List[str]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 665. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-instance-key.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-instance-key.mdx new file mode 100644 index 0000000000..185e85db34 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-instance-key.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/web-search-skill/get-instance-key" +title: "get_instance_key" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.WebSearchSkill.get_instance_key" + parent: "signalwire.skills.web_search.skill.WebSearchSkill" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `get_instance_key` + +Get the key used to track this skill instance + +## Signature + +```python +get_instance_key() -> str +``` + +## Returns + +`str` + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 553. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..05d4b74f0f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/web-search-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.WebSearchSkill.get_parameter_schema" + parent: "signalwire.skills.web_search.skill.WebSearchSkill" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `get_parameter_schema` + +Get the parameter schema for the web search skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 692. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..7e9d7fd339 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/web-search-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.WebSearchSkill.get_prompt_sections" + parent: "signalwire.skills.web_search.skill.WebSearchSkill" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `get_prompt_sections` + +Return prompt sections to add to agent + +## Signature + +```python +get_prompt_sections() -> List[Dict[str, Any]] +``` + +## Returns + +`List[Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 677. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/index.mdx new file mode 100644 index 0000000000..d0e4a70cfd --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/web-search-skill" +title: "WebSearchSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.WebSearchSkill" + parent: "signalwire.skills.web_search.skill" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `WebSearchSkill` + +Web search capability using Google Custom Search API with quality filtering + +## Signature + +```python +class WebSearchSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + +## Methods + + + + Return global data for agent context + + + + Return speech recognition hints + + + + Get the key used to track this skill instance + + + + Get the parameter schema for the web search skill + + + + Return prompt sections to add to agent + + + + Register web search tool with the agent + + + + Setup the web search skill + + + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 541. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/register-tools.mdx new file mode 100644 index 0000000000..fc55d9e4e3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/web-search-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.WebSearchSkill.register_tools" + parent: "signalwire.skills.web_search.skill.WebSearchSkill" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `register_tools` + +Register web search tool with the agent + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 610. diff --git a/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/setup.mdx new file mode 100644 index 0000000000..093b7f799a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/web-search/skill/web-search-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/web-search/skill/web-search-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.web_search.skill.WebSearchSkill.setup" + parent: "signalwire.skills.web_search.skill.WebSearchSkill" + module: "signalwire.skills.web_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py" +--- +# `setup` + +Setup the web search skill + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` + +## Source + +[`signalwire/signalwire/skills/web_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/web_search/skill.py) + +Line 559. diff --git a/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/index.mdx new file mode 100644 index 0000000000..df9a172149 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/skills/wikipedia-search" +title: "wikipedia_search" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.wikipedia_search" + parent: "signalwire.skills" + module: "signalwire.skills" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/__init__.py" +--- +# `wikipedia_search` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module wikipedia_search +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/skills/wikipedia_search/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/index.mdx new file mode 100644 index 0000000000..d8e0d8b317 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/python/signalwire/skills/wikipedia-search/skill" +title: "skill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.skills.wikipedia_search.skill" + parent: "signalwire.skills.wikipedia_search" + module: "signalwire.skills.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py" +--- +# `skill` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module skill +``` + +## Classes + + + + Skill for searching Wikipedia articles and retrieving content. + + + +## Source + +[`signalwire/signalwire/skills/wikipedia_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py) diff --git a/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-hints.mdx b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-hints.mdx new file mode 100644 index 0000000000..12aebbbf2c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-hints" +title: "get_hints" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill.get_hints" + parent: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill" + module: "signalwire.skills.wikipedia_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py" +--- +# `get_hints` + +Return speech recognition hints for better accuracy. + +## Signature + +```python +get_hints() -> list +``` + +## Returns + +`list` — List of words/phrases to help with speech recognition + +## Source + +[`signalwire/signalwire/skills/wikipedia_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py) + +Line 198. diff --git a/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..9c7093f040 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-parameter-schema.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill.get_parameter_schema" + parent: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill" + module: "signalwire.skills.wikipedia_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py" +--- +# `get_parameter_schema` + +Get parameter schema for Wikipedia search skill + +**Modifiers:** `classmethod` + +## Signature + +```python +@classmethod +get_parameter_schema() -> Dict[str, Dict[str, Any]] +``` + +## Returns + +`Dict[str, Dict[str, Any]]` + +## Source + +[`signalwire/signalwire/skills/wikipedia_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py) + +Line 40. diff --git a/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..41b9b4637f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill.get_prompt_sections" + parent: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill" + module: "signalwire.skills.wikipedia_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py" +--- +# `get_prompt_sections` + +Return additional context for the agent prompt. + +## Signature + +```python +get_prompt_sections() -> list +``` + +## Returns + +`list` — List of prompt sections to add to the agent + +## Source + +[`signalwire/signalwire/skills/wikipedia_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py) + +Line 181. diff --git a/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/index.mdx b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/index.mdx new file mode 100644 index 0000000000..562b514b11 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/index.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill" +title: "WikipediaSearchSkill" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill" + parent: "signalwire.skills.wikipedia_search.skill" + module: "signalwire.skills.wikipedia_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py" +--- +# `WikipediaSearchSkill` + +Skill for searching Wikipedia articles and retrieving content. + +This skill uses the Wikipedia API to search for articles and retrieve +their introductory content, similar to getting a summary of a topic. + +## Signature + +```python +class WikipediaSearchSkill(SkillBase) +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/python/signalwire/core/skill-base/skill-base) + +## Properties + + + + + + + + + + + + + +## Methods + + + + Return speech recognition hints for better accuracy. + + + + Get parameter schema for Wikipedia search skill + + + + Return additional context for the agent prompt. + + + + Register the SWAIG tool for Wikipedia search. + + + + Search Wikipedia for articles matching the query. + + + + Setup the Wikipedia search skill. + + + +## Source + +[`signalwire/signalwire/skills/wikipedia_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py) + +Line 22. diff --git a/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/register-tools.mdx b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/register-tools.mdx new file mode 100644 index 0000000000..276ba04aae --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/register-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/register-tools" +title: "register_tools" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill.register_tools" + parent: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill" + module: "signalwire.skills.wikipedia_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py" +--- +# `register_tools` + +Register the SWAIG tool for Wikipedia search. + +## Signature + +```python +register_tools() -> None +``` + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/skills/wikipedia_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py) + +Line 83. diff --git a/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/search-wiki.mdx b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/search-wiki.mdx new file mode 100644 index 0000000000..0e3ca4bfa3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/search-wiki.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/search-wiki" +title: "search_wiki" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill.search_wiki" + parent: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill" + module: "signalwire.skills.wikipedia_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py" +--- +# `search_wiki` + +Search Wikipedia for articles matching the query. + +## Signature + +```python +search_wiki(query: str) -> str +``` + +## Parameters + + + The search term to look up + + +## Returns + +`str` — String containing the Wikipedia article content or error message + +## Source + +[`signalwire/signalwire/skills/wikipedia_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py) + +Line 110. diff --git a/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/setup.mdx b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/setup.mdx new file mode 100644 index 0000000000..55a344dc23 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/setup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/skills/wikipedia-search/skill/wikipedia-search-skill/setup" +title: "setup" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill.setup" + parent: "signalwire.skills.wikipedia_search.skill.WikipediaSearchSkill" + module: "signalwire.skills.wikipedia_search.skill" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py" +--- +# `setup` + +Setup the Wikipedia search skill. + +## Signature + +```python +setup() -> bool +``` + +## Returns + +`bool` — True if setup successful, False otherwise + +## Source + +[`signalwire/signalwire/skills/wikipedia_search/skill.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/skills/wikipedia_search/skill.py) + +Line 62. diff --git a/fern/products/sdk-reference/python/signalwire/start-agent.mdx b/fern/products/sdk-reference/python/signalwire/start-agent.mdx new file mode 100644 index 0000000000..02e3ed37db --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/start-agent.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/python/signalwire/start-agent" +title: "start_agent" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.start_agent" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py" +--- +# `start_agent` + +Start an agent (lazy import) + +## Signature + +```python +start_agent(*args = (), **kwargs = {}) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/__init__.py) + +Line 46. diff --git a/fern/products/sdk-reference/python/signalwire/utils/index.mdx b/fern/products/sdk-reference/python/signalwire/utils/index.mdx new file mode 100644 index 0000000000..c6ae1a11c2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/python/signalwire/utils" +title: "utils" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.utils" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/__init__.py" +--- +# `utils` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module utils +``` + +## Properties + + + +## Functions + + + + Check if running in any serverless environment. + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/utils/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/utils/is-serverless-mode.mdx b/fern/products/sdk-reference/python/signalwire/utils/is-serverless-mode.mdx new file mode 100644 index 0000000000..08bb8c2c7e --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/is-serverless-mode.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/utils/is-serverless-mode" +title: "is_serverless_mode" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.utils.is_serverless_mode" + parent: "signalwire.utils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/__init__.py" +--- +# `is_serverless_mode` + +Check if running in any serverless environment. + +## Signature + +```python +is_serverless_mode() -> bool +``` + +## Returns + +`bool` — True if in serverless mode, False if in server mode + +## Source + +[`signalwire/signalwire/utils/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/__init__.py) + +Line 14. diff --git a/fern/products/sdk-reference/python/signalwire/utils/pom-utils/index.mdx b/fern/products/sdk-reference/python/signalwire/utils/pom-utils/index.mdx new file mode 100644 index 0000000000..75db294754 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/pom-utils/index.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/python/signalwire/utils/pom-utils" +title: "pom_utils" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.utils.pom_utils" + parent: "signalwire.utils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/pom_utils.py" +--- +# `pom_utils` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module pom_utils +``` + +## Source + +[`signalwire/signalwire/utils/pom_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/pom_utils.py) diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/index.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/index.mdx new file mode 100644 index 0000000000..9861b12cdc --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils" +title: "schema_utils" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.utils.schema_utils" + parent: "signalwire.utils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `schema_utils` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module schema_utils +``` + +## Properties + + + +## Classes + + + + Utility class for loading and working with SWML schemas + + + + Raised when SWML schema validation fails. + + + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/generate-method-body.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/generate-method-body.mdx new file mode 100644 index 0000000000..5959b1f963 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/generate-method-body.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-utils/generate-method-body" +title: "generate_method_body" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaUtils.generate_method_body" + parent: "signalwire.utils.schema_utils.SchemaUtils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `generate_method_body` + +Generate the method body implementation for a verb + +## Signature + +```python +generate_method_body(verb_name: str) -> str +``` + +## Parameters + + + The name of the verb + + +## Returns + +`str` — The method body as a string + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 460. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/generate-method-signature.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/generate-method-signature.mdx new file mode 100644 index 0000000000..ff0fa43012 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/generate-method-signature.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-utils/generate-method-signature" +title: "generate_method_signature" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaUtils.generate_method_signature" + parent: "signalwire.utils.schema_utils.SchemaUtils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `generate_method_signature` + +Generate a Python method signature for a verb + +## Signature + +```python +generate_method_signature(verb_name: str) -> str +``` + +## Parameters + + + The name of the verb + + +## Returns + +`str` — A Python method signature string + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 403. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-all-verb-names.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-all-verb-names.mdx new file mode 100644 index 0000000000..f8c3d3b23c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-all-verb-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-utils/get-all-verb-names" +title: "get_all_verb_names" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaUtils.get_all_verb_names" + parent: "signalwire.utils.schema_utils.SchemaUtils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `get_all_verb_names` + +Get all verb names defined in the schema + +## Signature + +```python +get_all_verb_names() -> List[str] +``` + +## Returns + +`List[str]` — List of verb names + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 379. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-parameters.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-parameters.mdx new file mode 100644 index 0000000000..3e10cc7b2a --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-parameters.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-parameters" +title: "get_verb_parameters" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaUtils.get_verb_parameters" + parent: "signalwire.utils.schema_utils.SchemaUtils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `get_verb_parameters` + +Get the parameter definitions for a specific verb + +## Signature + +```python +get_verb_parameters(verb_name: str) -> Dict[str, Any] +``` + +## Parameters + + + The name of the verb (e.g., "ai", "answer", etc.) + + +## Returns + +`Dict[str, Any]` — Dictionary mapping parameter names to their definitions + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 388. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-properties.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-properties.mdx new file mode 100644 index 0000000000..4e52d58472 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-properties.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-properties" +title: "get_verb_properties" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaUtils.get_verb_properties" + parent: "signalwire.utils.schema_utils.SchemaUtils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `get_verb_properties` + +Get the properties for a specific verb + +## Signature + +```python +get_verb_properties(verb_name: str) -> Dict[str, Any] +``` + +## Parameters + + + The name of the verb (e.g., "ai", "answer", etc.) + + +## Returns + +`Dict[str, Any]` — The properties for the verb or an empty dict if not found + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 227. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-required-properties.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-required-properties.mdx new file mode 100644 index 0000000000..fb9c0f71c2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-required-properties.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-utils/get-verb-required-properties" +title: "get_verb_required_properties" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaUtils.get_verb_required_properties" + parent: "signalwire.utils.schema_utils.SchemaUtils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `get_verb_required_properties` + +Get the required properties for a specific verb + +## Signature + +```python +get_verb_required_properties(verb_name: str) -> List[str] +``` + +## Parameters + + + The name of the verb (e.g., "ai", "answer", etc.) + + +## Returns + +`List[str]` — List of required property names for the verb or an empty list if not found + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 243. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/index.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/index.mdx new file mode 100644 index 0000000000..75c5681737 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/index.mdx @@ -0,0 +1,87 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-utils" +title: "SchemaUtils" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaUtils" + parent: "signalwire.utils.schema_utils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `SchemaUtils` + +Utility class for loading and working with SWML schemas + +## Signature + +```python +class SchemaUtils +``` + +## Properties + + + Check if full JSON Schema validation is available. + + + + + + + + + + +## Methods + + + + Initialize the schema utilities. + + + + Generate the method body implementation for a verb + + + + Generate a Python method signature for a verb + + + + Get all verb names defined in the schema + + + + Get the parameter definitions for a specific verb + + + + Get the properties for a specific verb + + + + Get the required properties for a specific verb + + + + Load the JSON schema from the specified path + + + + Validate a complete SWML document against the schema. + + + + Validate a verb configuration against the schema. + + + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 40. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/init.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/init.mdx new file mode 100644 index 0000000000..9b31f5a7df --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/init.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-utils/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaUtils.__init__" + parent: "signalwire.utils.schema_utils.SchemaUtils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `__init__` + +Initialize the schema utilities. + +## Signature + +```python +__init__(schema_path: Optional[str] = None, schema_validation: bool = True) +``` + +## Parameters + + + Path to the schema file + + + + Enable schema validation. Can also be disabled via SWML\_SKIP\_SCHEMA\_VALIDATION=1 environment variable. + + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 45. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/load-schema.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/load-schema.mdx new file mode 100644 index 0000000000..d807ff2161 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/load-schema.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-utils/load-schema" +title: "load_schema" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaUtils.load_schema" + parent: "signalwire.utils.schema_utils.SchemaUtils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `load_schema` + +Load the JSON schema from the specified path + +## Signature + +```python +load_schema() -> Dict[str, Any] +``` + +## Returns + +`Dict[str, Any]` — The schema as a dictionary + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 148. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/validate-document.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/validate-document.mdx new file mode 100644 index 0000000000..d0faa30515 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/validate-document.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-utils/validate-document" +title: "validate_document" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaUtils.validate_document" + parent: "signalwire.utils.schema_utils.SchemaUtils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `validate_document` + +Validate a complete SWML document against the schema. + +## Signature + +```python +validate_document(document: Dict[str, Any]) -> Tuple[bool, List[str]] +``` + +## Parameters + + + The complete SWML document to validate + + +## Returns + +`Tuple[bool, List[str]]` — (is\_valid, error\_messages) tuple + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 357. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/validate-verb.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/validate-verb.mdx new file mode 100644 index 0000000000..7fab5d9902 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-utils/validate-verb.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-utils/validate-verb" +title: "validate_verb" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaUtils.validate_verb" + parent: "signalwire.utils.schema_utils.SchemaUtils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `validate_verb` + +Validate a verb configuration against the schema. + +Performs full JSON Schema validation including type checking and nested +object validation using jsonschema-rs. + +## Signature + +```python +validate_verb( + verb_name: str, + verb_config: Dict[str, Any] +) -> Tuple[bool, List[str]] +``` + +## Parameters + + + The name of the verb (e.g., "ai", "answer", etc.) + + + + The configuration for the verb + + +## Returns + +`Tuple[bool, List[str]]` — (is\_valid, error\_messages) tuple + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 260. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-validation-error/index.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-validation-error/index.mdx new file mode 100644 index 0000000000..53f2668915 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-validation-error/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-validation-error" +title: "SchemaValidationError" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaValidationError" + parent: "signalwire.utils.schema_utils" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `SchemaValidationError` + +Raised when SWML schema validation fails. + +## Signature + +```python +class SchemaValidationError(Exception) +``` + +## Inheritance + +**Extends:** `Exception` + +## Properties + + + + + +## Methods + + + + + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 27. diff --git a/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-validation-error/init.mdx b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-validation-error/init.mdx new file mode 100644 index 0000000000..42946c6650 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/schema-utils/schema-validation-error/init.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/python/signalwire/utils/schema-utils/schema-validation-error/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.utils.schema_utils.SchemaValidationError.__init__" + parent: "signalwire.utils.schema_utils.SchemaValidationError" + module: "signalwire.utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py" +--- +# `__init__` + +## Signature + +```python +__init__(verb_name: str, errors: List[str]) +``` + +## Parameters + + + + + +## Source + +[`signalwire/signalwire/utils/schema_utils.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/schema_utils.py) + +Line 30. diff --git a/fern/products/sdk-reference/python/signalwire/utils/token-generators/index.mdx b/fern/products/sdk-reference/python/signalwire/utils/token-generators/index.mdx new file mode 100644 index 0000000000..71aaa4a9e4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/token-generators/index.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/python/signalwire/utils/token-generators" +title: "token_generators" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.utils.token_generators" + parent: "signalwire.utils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/token_generators.py" +--- +# `token_generators` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module token_generators +``` + +## Source + +[`signalwire/signalwire/utils/token_generators.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/token_generators.py) diff --git a/fern/products/sdk-reference/python/signalwire/utils/url-validator/index.mdx b/fern/products/sdk-reference/python/signalwire/utils/url-validator/index.mdx new file mode 100644 index 0000000000..c6f99db93f --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/url-validator/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/utils/url-validator" +title: "url_validator" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.utils.url_validator" + parent: "signalwire.utils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/url_validator.py" +--- +# `url_validator` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module url_validator +``` + +## Properties + + + +## Functions + + + + Validate that a URL is safe to fetch (not pointing to private/internal resources). + + + +## Source + +[`signalwire/signalwire/utils/url_validator.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/url_validator.py) diff --git a/fern/products/sdk-reference/python/signalwire/utils/url-validator/validate-url.mdx b/fern/products/sdk-reference/python/signalwire/utils/url-validator/validate-url.mdx new file mode 100644 index 0000000000..eb7d965ed6 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/url-validator/validate-url.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/utils/url-validator/validate-url" +title: "validate_url" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "function" + language: "python" + qualified_name: "signalwire.utils.url_validator.validate_url" + parent: "signalwire.utils.url_validator" + module: "signalwire.utils.url_validator" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/url_validator.py" +--- +# `validate_url` + +Validate that a URL is safe to fetch (not pointing to private/internal resources). + +## Signature + +```python +validate_url(url: str, allow_private: bool = False) -> bool +``` + +## Parameters + + + The URL to validate + + + + If True, allow private IP ranges (default: False) + + +## Returns + +`bool` — True if the URL is safe to fetch, False otherwise + +## Source + +[`signalwire/signalwire/utils/url_validator.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/url_validator.py) + +Line 34. diff --git a/fern/products/sdk-reference/python/signalwire/utils/validators/index.mdx b/fern/products/sdk-reference/python/signalwire/utils/validators/index.mdx new file mode 100644 index 0000000000..81407e3cc3 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/utils/validators/index.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/python/signalwire/utils/validators" +title: "validators" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.utils.validators" + parent: "signalwire.utils" + module: "signalwire.utils" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/validators.py" +--- +# `validators` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module validators +``` + +## Source + +[`signalwire/signalwire/utils/validators.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/utils/validators.py) diff --git a/fern/products/sdk-reference/python/signalwire/web/index.mdx b/fern/products/sdk-reference/python/signalwire/web/index.mdx new file mode 100644 index 0000000000..2522b68ca4 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/web/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/web" +title: "web" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.web" + parent: "signalwire" + module: "signalwire" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/__init__.py" +--- +# `web` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module web +``` + +## Properties + + + +## Modules + + + + Copyright (c) 2025 SignalWire + + + +## Source + +[`signalwire/signalwire/web/__init__.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/__init__.py) diff --git a/fern/products/sdk-reference/python/signalwire/web/web-service/index.mdx b/fern/products/sdk-reference/python/signalwire/web/web-service/index.mdx new file mode 100644 index 0000000000..769df42221 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/web/web-service/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/python/signalwire/web/web-service" +title: "web_service" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "module" + language: "python" + qualified_name: "signalwire.web.web_service" + parent: "signalwire.web" + module: "signalwire.web" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py" +--- +# `web_service` + +Copyright (c) 2025 SignalWire + +This file is part of the SignalWire SDK. + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```python +module web_service +``` + +## Properties + + + +## Classes + + + + Static file serving service with HTTP API + + + +## Source + +[`signalwire/signalwire/web/web_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py) diff --git a/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/add-directory.mdx b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/add-directory.mdx new file mode 100644 index 0000000000..63c2583f0c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/add-directory.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/python/signalwire/web/web-service/web-service/add-directory" +title: "add_directory" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.web.web_service.WebService.add_directory" + parent: "signalwire.web.web_service.WebService" + module: "signalwire.web.web_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py" +--- +# `add_directory` + +Add a new directory to serve + +## Signature + +```python +add_directory(route: str, directory: str) -> None +``` + +## Parameters + + + URL path to mount at (e.g., "/docs") + + + + Local directory path to serve + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/web/web_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py) + +Line 461. diff --git a/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/index.mdx b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/index.mdx new file mode 100644 index 0000000000..84831a5de2 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/python/signalwire/web/web-service/web-service" +title: "WebService" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "class" + language: "python" + qualified_name: "signalwire.web.web_service.WebService" + parent: "signalwire.web.web_service" + module: "signalwire.web.web_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py" +--- +# `WebService` + +Static file serving service with HTTP API + +## Signature + +```python +class WebService +``` + +## Properties + + + + + + + + + + + + + + + + + + + +## Methods + + + + Initialize WebService + + + + Add a new directory to serve + + + + Remove a directory from being served + + + + Start the service with optional HTTPS support + + + + Stop the service (placeholder for cleanup) + + + +## Source + +[`signalwire/signalwire/web/web_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py) + +Line 41. diff --git a/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/init.mdx b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/init.mdx new file mode 100644 index 0000000000..ace64825b0 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/init.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/python/signalwire/web/web-service/web-service/init" +title: "__init__" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.web.web_service.WebService.__init__" + parent: "signalwire.web.web_service.WebService" + module: "signalwire.web.web_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py" +--- +# `__init__` + +Initialize WebService + +## Signature + +```python +__init__( + port: int = 8002, + directories: Dict[str, str] = None, + basic_auth: Optional[Tuple[str, str]] = None, + config_file: Optional[str] = None, + enable_directory_browsing: bool = False, + allowed_extensions: Optional[list] = None, + blocked_extensions: Optional[list] = None, + max_file_size: int = 100 * 1024 * 1024, + enable_cors: bool = True +) +``` + +## Parameters + + + Port to bind to (default: 8002) + + + + Dict mapping URL paths to local directories + + + + Optional tuple of (username, password) + + + + Optional configuration file path + + + + Allow directory listing + + + + List of allowed file extensions (e.g., \['.html', '.css']) + + + + List of blocked extensions (e.g., \['.env', '.git']) + + + + Maximum file size in bytes to serve + + + + Enable CORS support + + +## Source + +[`signalwire/signalwire/web/web_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py) + +Line 44. diff --git a/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/remove-directory.mdx b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/remove-directory.mdx new file mode 100644 index 0000000000..380f3440ec --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/remove-directory.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/python/signalwire/web/web-service/web-service/remove-directory" +title: "remove_directory" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.web.web_service.WebService.remove_directory" + parent: "signalwire.web.web_service.WebService" + module: "signalwire.web.web_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py" +--- +# `remove_directory` + +Remove a directory from being served + +## Signature + +```python +remove_directory(route: str) -> None +``` + +## Parameters + + + URL path to remove + + +## Returns + +`None` + +## Source + +[`signalwire/signalwire/web/web_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py) + +Line 487. diff --git a/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/start.mdx b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/start.mdx new file mode 100644 index 0000000000..36148f2464 --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/start.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/python/signalwire/web/web-service/web-service/start" +title: "start" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.web.web_service.WebService.start" + parent: "signalwire.web.web_service.WebService" + module: "signalwire.web.web_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py" +--- +# `start` + +Start the service with optional HTTPS support + +## Signature + +```python +start( + host: str = '0.0.0.0', + port: Optional[int] = None, + ssl_cert: Optional[str] = None, + ssl_key: Optional[str] = None +) +``` + +## Parameters + + + Host to bind to (default: "0.0.0.0") + + + + Port to bind to (default: self.port) + + + + Path to SSL certificate file (overrides environment) + + + + Path to SSL key file (overrides environment) + + +## Source + +[`signalwire/signalwire/web/web_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py) + +Line 501. diff --git a/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/stop.mdx b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/stop.mdx new file mode 100644 index 0000000000..3c3e14725c --- /dev/null +++ b/fern/products/sdk-reference/python/signalwire/web/web-service/web-service/stop.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/python/signalwire/web/web-service/web-service/stop" +title: "stop" +sdk_label: "Python SDK" +icon: "python" +lustri: + auto_generated: true + kind: "method" + language: "python" + qualified_name: "signalwire.web.web_service.WebService.stop" + parent: "signalwire.web.web_service.WebService" + module: "signalwire.web.web_service" + source_url: "https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py" +--- +# `stop` + +Stop the service (placeholder for cleanup) + +## Signature + +```python +stop() +``` + +## Source + +[`signalwire/signalwire/web/web_service.py`](https://github.com/signalwire/signalwire-python/blob/main/signalwire/signalwire/web/web_service.py) + +Line 566. diff --git a/fern/products/sdk-reference/ruby/_meta.json b/fern/products/sdk-reference/ruby/_meta.json new file mode 100644 index 0000000000..ef89f179b5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/_meta.json @@ -0,0 +1,10 @@ +{ + "language": "ruby", + "sdk_name": "ruby-sdk", + "version": null, + "source_repo": "https://github.com/signalwire/signalwire-ruby", + "format": "mdx", + "platform": "fern", + "base_slug": "/reference/ruby", + "item_count": 1542 +} \ No newline at end of file diff --git a/fern/products/sdk-reference/ruby/index.mdx b/fern/products/sdk-reference/ruby/index.mdx new file mode 100644 index 0000000000..7df7b4ee8a --- /dev/null +++ b/fern/products/sdk-reference/ruby/index.mdx @@ -0,0 +1,14 @@ +--- +title: "Ruby SDK" +slug: "/reference/ruby" +lustri: + auto_generated: true + language: "ruby" + kind: "sdk" +--- +# Ruby SDK Reference + +## Modules + +- [`SignalWire`](/reference/ruby/signal-wire) + diff --git a/fern/products/sdk-reference/ruby/signal-wire/add-skill-directory.mdx b/fern/products/sdk-reference/ruby/signal-wire/add-skill-directory.mdx new file mode 100644 index 0000000000..7a040556c6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/add-skill-directory.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/ruby/signal-wire/add-skill-directory" +title: "add_skill_directory" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire.add_skill_directory" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire.rb" + visibility: "public" +--- +# `add_skill_directory` + +Add a directory to search for skills. + +Mirrors Python's `signalwire.add_skill_directory(path)` — delegates +to the singleton \{SignalWire::Skills::SkillRegistry\} instance so +third-party skill collections can be registered by path. Subsequent +calls accumulate (de-duplicated) into a shared external paths list. + +## Signature + +```ruby +def add_skill_directory(path) +``` + +## Parameters + + + absolute or relative path to a skill directory. + + +## Returns + +`void` + +## Throws + +- `ArgumentError` — when the path doesn't exist or isn't a directory. + +## Source + +[`lib/signalwire.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire.rb) + +Line 83. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-answer-verb.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-answer-verb.mdx new file mode 100644 index 0000000000..6fc3896277 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-answer-verb.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-answer-verb" +title: "add_answer_verb" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_answer_verb" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_answer_verb` + +## Signature + +```ruby +def add_answer_verb(config) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 995. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-function-include.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-function-include.mdx new file mode 100644 index 0000000000..12d28717f6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-function-include.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-function-include" +title: "add_function_include" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_function_include" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_function_include` + +## Signature + +```ruby +def add_function_include(url, functions, meta_data: nil) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 959. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-hint.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-hint.mdx new file mode 100644 index 0000000000..e5df668604 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-hint.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-hint" +title: "add_hint" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_hint" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_hint` + +\================================================================== +AI Config methods +================= + +## Signature + +```ruby +def add_hint(hint) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 655. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-hints.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-hints.mdx new file mode 100644 index 0000000000..7d4a652fe8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-hints" +title: "add_hints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_hints" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_hints` + +## Signature + +```ruby +def add_hints(hints) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 660. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-internal-filler.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-internal-filler.mdx new file mode 100644 index 0000000000..addb6680e5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-internal-filler.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-internal-filler" +title: "add_internal_filler" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_internal_filler" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_internal_filler` + +Add internal fillers for a single internal function and language. + +See +set\_internal\_fillers+ for the complete list of supported ++func\_name+ values (SUPPORTED\_INTERNAL\_FILLER\_NAMES) and what +fillers do. Names outside the supported set log a warning and are +stored but the runtime will not play them. + +## Signature + +```ruby +def add_internal_filler(func_name, lang_code, fillers) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 936. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-language.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-language.mdx new file mode 100644 index 0000000000..96c90ccc65 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-language.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-language" +title: "add_language" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_language" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_language` + +Add a language configuration. + +Python parity: `add_language(name, code, voice, speech_fillers=None, +function_fillers=None, engine=None, model=None)`. Ruby supports +both the Python-style positional shape AND the original +`add_language(config)` hash form. + +Voice argument can be either a simple voice id (`"en-US-Neural2-F"`) +or a combined `"engine.voice:model"` string +(`"elevenlabs.josh:eleven_turbo_v2_5"`); the combined form is +parsed into `engine`/`voice`/`model` keys when `engine` +and `model` aren't supplied explicitly. + +## Signature + + + + ```ruby + add_language(config) + ``` + + + + ```ruby + add_language(name, code, voice, speech_fillers: nil, + ``` + + + +## Parameters (Overload 1) + + + preformed language config + + +## Parameters (Overload 2) + + + language name (e.g. `"English"`) + + + + BCP47 language code (e.g. `"en-US"`) + + + + voice id or `engine.voice:model` string + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 750. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-mcp-server.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-mcp-server.mdx new file mode 100644 index 0000000000..7fda040cb3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-mcp-server.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-mcp-server" +title: "add_mcp_server" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_mcp_server" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_mcp_server` + +Add an external MCP server for tool discovery and invocation. + +## Signature + +```ruby +def add_mcp_server(url, headers: nil, resources: false, resource_vars: nil) +``` + +## Parameters + + + MCP server HTTP endpoint URL + + + + + + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1280. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-pattern-hint.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-pattern-hint.mdx new file mode 100644 index 0000000000..7da186fffd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-pattern-hint.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-pattern-hint" +title: "add_pattern_hint" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_pattern_hint" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_pattern_hint` + +Add a complex (pattern-matched) hint. + +Python parity: +`add_pattern_hint(hint, pattern, replace, ignore_case=False)`. +Ruby supports both the Python-style positional form and the +legacy keyword form (`add_pattern_hint(pattern, hint:, language:)`) +for backward compat. + +## Signature + + + + ```ruby + add_pattern_hint(hint, pattern, replace, ignore_case: false) + ``` + + + + ```ruby + add_pattern_hint(pattern, hint:, language: 'en-US') + ``` + + + +## Parameters (Overload 1) + + + hint to match + + + + regex pattern + + + + replacement text + + + + +## Parameters (Overload 2) + + + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 682. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-post-ai-verb.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-post-ai-verb.mdx new file mode 100644 index 0000000000..57040bb5a6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-post-ai-verb.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-post-ai-verb" +title: "add_post_ai_verb" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_post_ai_verb" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_post_ai_verb` + +## Signature + +```ruby +def add_post_ai_verb(verb_name, config) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1010. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-post-answer-verb.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-post-answer-verb.mdx new file mode 100644 index 0000000000..cabff8da65 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-post-answer-verb.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-post-answer-verb" +title: "add_post_answer_verb" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_post_answer_verb" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_post_answer_verb` + +## Signature + +```ruby +def add_post_answer_verb(verb_name, config) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1000. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-pre-answer-verb.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..52bd623fa6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-pre-answer-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-pre-answer-verb" +title: "add_pre_answer_verb" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_pre_answer_verb" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_pre_answer_verb` + +\================================================================== +Verb management +=============== + +## Signature + +```ruby +def add_pre_answer_verb(verb_name, config) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 985. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-pronunciation.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-pronunciation.mdx new file mode 100644 index 0000000000..f5e4de66b9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-pronunciation.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-pronunciation" +title: "add_pronunciation" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_pronunciation" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_pronunciation` + +## Signature + +```ruby +def add_pronunciation(phrase, pronunciation, language_code: 'en-US') +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 835. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-skill.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-skill.mdx new file mode 100644 index 0000000000..a7ca6f2a14 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-skill.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-skill" +title: "add_skill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_skill" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_skill` + +Load and register a skill by name. + +## Signature + +```ruby +def add_skill(skill_name, params = {}) +``` + +## Parameters + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1099. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-swaig-query-params.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-swaig-query-params.mdx new file mode 100644 index 0000000000..90ded37947 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/add-swaig-query-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/add-swaig-query-params" +title: "add_swaig_query_params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#add_swaig_query_params" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `add_swaig_query_params` + +## Signature + +```ruby +def add_swaig_query_params(params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1188. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-body-limit-middleware/call.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-body-limit-middleware/call.mdx new file mode 100644 index 0000000000..9b8e32cace --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-body-limit-middleware/call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/agent-body-limit-middleware/call" +title: "call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase::AgentBodyLimitMiddleware#call" + parent: "SignalWire::AgentBase::AgentBodyLimitMiddleware" + module: "SignalWire.AgentBase.AgentBodyLimitMiddleware" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `call` + +## Signature + +```ruby +def call(env) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 2086. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-body-limit-middleware/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-body-limit-middleware/index.mdx new file mode 100644 index 0000000000..956baab3db --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-body-limit-middleware/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/agent-body-limit-middleware" +title: "AgentBodyLimitMiddleware" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::AgentBase::AgentBodyLimitMiddleware" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `AgentBodyLimitMiddleware` + +## Signature + +```ruby +class AgentBodyLimitMiddleware < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 2080. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-body-limit-middleware/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-body-limit-middleware/initialize.mdx new file mode 100644 index 0000000000..d86fe87959 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-body-limit-middleware/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/agent-body-limit-middleware/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase::AgentBodyLimitMiddleware#initialize" + parent: "SignalWire::AgentBase::AgentBodyLimitMiddleware" + module: "SignalWire.AgentBase.AgentBodyLimitMiddleware" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(app, max_size) +``` + +## Parameters + + + + + +## Returns + +`AgentBodyLimitMiddleware` — a new instance of AgentBodyLimitMiddleware + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 2081. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-id.mdx new file mode 100644 index 0000000000..5779c4814d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-id.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/agent-id" +title: "agent_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#agent_id" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `agent_id` + +Python parity: + +- `logger` — agent-specific structured logger (Python: `self.log`). +- `skill_manager` — owning SkillManager (Python's `self.skill_manager`). +- `agent_id` — UUID identifier from constructor or auto-generated. +- `default_webhook_url` — base URL for SWAIG webhook fallbacks. +- `native_functions` — names of built-in SWAIG functions to advertise. +- `use_pom` — whether prompt-object-model rendering is enabled. + +## Signature + +```ruby +attr_reader agent_id -> Object +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-security-headers-middleware/call.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-security-headers-middleware/call.mdx new file mode 100644 index 0000000000..c19d9aa353 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-security-headers-middleware/call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/agent-security-headers-middleware/call" +title: "call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase::AgentSecurityHeadersMiddleware#call" + parent: "SignalWire::AgentBase::AgentSecurityHeadersMiddleware" + module: "SignalWire.AgentBase.AgentSecurityHeadersMiddleware" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `call` + +## Signature + +```ruby +def call(env) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 2073. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-security-headers-middleware/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-security-headers-middleware/index.mdx new file mode 100644 index 0000000000..750baafb9a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-security-headers-middleware/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/agent-security-headers-middleware" +title: "AgentSecurityHeadersMiddleware" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::AgentBase::AgentSecurityHeadersMiddleware" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `AgentSecurityHeadersMiddleware` + +\================================================================== +Rack Middleware +=============== + +## Signature + +```ruby +class AgentSecurityHeadersMiddleware < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Constants + + + +## Methods + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 2062. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-security-headers-middleware/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-security-headers-middleware/initialize.mdx new file mode 100644 index 0000000000..16427e45cf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-security-headers-middleware/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/agent-security-headers-middleware/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase::AgentSecurityHeadersMiddleware#initialize" + parent: "SignalWire::AgentBase::AgentSecurityHeadersMiddleware" + module: "SignalWire.AgentBase.AgentSecurityHeadersMiddleware" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(app) +``` + +## Parameters + + + +## Returns + +`AgentSecurityHeadersMiddleware` — a new instance of AgentSecurityHeadersMiddleware + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 2069. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth/call.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth/call.mdx new file mode 100644 index 0000000000..b2aa122a51 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth/call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth/call" +title: "call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase::AgentTimingSafeBasicAuth#call" + parent: "SignalWire::AgentBase::AgentTimingSafeBasicAuth" + module: "SignalWire.AgentBase.AgentTimingSafeBasicAuth" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `call` + +## Signature + +```ruby +def call(env) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 2101. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth/index.mdx new file mode 100644 index 0000000000..629b0dd9a9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth" +title: "AgentTimingSafeBasicAuth" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::AgentBase::AgentTimingSafeBasicAuth" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `AgentTimingSafeBasicAuth` + +## Signature + +```ruby +class AgentTimingSafeBasicAuth < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 2095. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth/initialize.mdx new file mode 100644 index 0000000000..74881de245 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/agent-timing-safe-basic-auth/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase::AgentTimingSafeBasicAuth#initialize" + parent: "SignalWire::AgentBase::AgentTimingSafeBasicAuth" + module: "SignalWire.AgentBase.AgentTimingSafeBasicAuth" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(app, agent) +``` + +## Parameters + + + + + +## Returns + +`AgentTimingSafeBasicAuth` — a new instance of AgentTimingSafeBasicAuth + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 2096. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/as-rack-app.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/as-rack-app.mdx new file mode 100644 index 0000000000..0ca0e80052 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/as-rack-app.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/as-rack-app" +title: "as_rack_app" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#as_rack_app" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `as_rack_app` + +Return a Rack-compatible application for mounting. + +## Signature + +```ruby +def rack_app +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1554. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..81953a6864 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-post-ai-verbs.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/clear-post-ai-verbs" +title: "clear_post_ai_verbs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#clear_post_ai_verbs" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `clear_post_ai_verbs` + +## Signature + +```ruby +def clear_post_ai_verbs +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1015. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..4f7de16457 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-post-answer-verbs.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/clear-post-answer-verbs" +title: "clear_post_answer_verbs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#clear_post_answer_verbs" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `clear_post_answer_verbs` + +## Signature + +```ruby +def clear_post_answer_verbs +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1005. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..51c2b57172 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-pre-answer-verbs.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/clear-pre-answer-verbs" +title: "clear_pre_answer_verbs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#clear_pre_answer_verbs" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `clear_pre_answer_verbs` + +## Signature + +```ruby +def clear_pre_answer_verbs +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 990. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-swaig-query-params.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..93579128f5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/clear-swaig-query-params.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/clear-swaig-query-params" +title: "clear_swaig_query_params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#clear_swaig_query_params" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `clear_swaig_query_params` + +## Signature + +```ruby +def clear_swaig_query_params +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1193. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/contexts.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/contexts.mdx new file mode 100644 index 0000000000..08d2d89c48 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/contexts.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/contexts" +title: "contexts" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#contexts" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `contexts` + +Define / retrieve the ContextBuilder for this agent. + +Python parity: `define_contexts(contexts)` accepts either a +`ContextBuilder` (calls `.to_dict()` to materialise) or a +raw `dict` and stores it on the agent. Ruby supports both +forms PLUS the original lazy-getter idiom: + +1. **Lazy getter** (Ruby idiom) — `agent.define_contexts` + returns the existing builder, creating one if needed. +2. **Override with builder** — `agent.define_contexts(other_cb)` + replaces the current builder with the supplied one (Python + parity). +3. **Override with hash** — `agent.define_contexts({...})` + builds a fresh builder using the provided contexts hash + (Python parity for raw-dict input). + +## Signature + +```ruby +def define_contexts(contexts = nil) +``` + +## Returns + +`SignalWire::Contexts::ContextBuilder` — the active builder + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1076. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/create-tool-token.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/create-tool-token.mdx new file mode 100644 index 0000000000..5d6841cada --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/create-tool-token.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/create-tool-token" +title: "create_tool_token" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#create_tool_token" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `create_tool_token` + +Mint a per-call SWAIG-function token via the agent's SessionManager. + +Python parity: state\_mixin.StateMixin#\_create\_tool\_token — +delegates to SessionManager#create\_token and returns "" on any +raised error (Python rescues all exceptions and returns ""). + +## Signature + +```ruby +def create_tool_token(tool_name, call_id) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 587. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/default-webhook-url.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/default-webhook-url.mdx new file mode 100644 index 0000000000..254eea5e9b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/default-webhook-url.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/default-webhook-url" +title: "default_webhook_url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#default_webhook_url" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `default_webhook_url` + +Python parity: + +- `logger` — agent-specific structured logger (Python: `self.log`). +- `skill_manager` — owning SkillManager (Python's `self.skill_manager`). +- `agent_id` — UUID identifier from constructor or auto-generated. +- `default_webhook_url` — base URL for SWAIG webhook fallbacks. +- `native_functions` — names of built-in SWAIG functions to advertise. +- `use_pom` — whether prompt-object-model rendering is enabled. + +## Signature + +```ruby +attr_reader default_webhook_url -> Object +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/define-contexts.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/define-contexts.mdx new file mode 100644 index 0000000000..671898814f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/define-contexts.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/define-contexts" +title: "define_contexts" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#define_contexts" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `define_contexts` + +Define / retrieve the ContextBuilder for this agent. + +Python parity: `define_contexts(contexts)` accepts either a +`ContextBuilder` (calls `.to_dict()` to materialise) or a +raw `dict` and stores it on the agent. Ruby supports both +forms PLUS the original lazy-getter idiom: + +1. **Lazy getter** (Ruby idiom) — `agent.define_contexts` + returns the existing builder, creating one if needed. +2. **Override with builder** — `agent.define_contexts(other_cb)` + replaces the current builder with the supplied one (Python + parity). +3. **Override with hash** — `agent.define_contexts({...})` + builds a fresh builder using the provided contexts hash + (Python parity for raw-dict input). + +## Signature + +```ruby +def define_contexts(contexts = nil) +``` + +## Parameters + + + optional override + + +## Returns + +`SignalWire::Contexts::ContextBuilder` — the active builder + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1043. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/define-tool.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/define-tool.mdx new file mode 100644 index 0000000000..17ad20059e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/define-tool.mdx @@ -0,0 +1,122 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/define-tool" +title: "define_tool" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#define_tool" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `define_tool` + +Register a SWAIG tool (function) that the AI can invoke during a +call. + +\== How this becomes a tool the model sees + +A SWAIG function is _exactly the same concept_ as a "tool" in +native OpenAI / Anthropic tool calling. On every LLM turn, the +SDK renders each registered SWAIG function into the OpenAI tool +schema: + +``` +{ + "type": "function", + "function": { + "name": "your_name_here", + "description": "your description text", + "parameters": { ... your JSON schema ... } + } +} +``` + +That schema is sent to the model as part of the same API call +that produces the next assistant message. The model reads: + +- the function +description+ to decide WHEN to call this tool +- each parameter +description+ (inside +parameters+) to decide + HOW to fill in that argument from the user's utterance + +This means _descriptions are prompt engineering_, not developer +comments. A vague description is the #1 cause of "the model has +the right tool but doesn't call it" failures. + +\== Bad vs good descriptions + +BAD : description: "Lookup function" +GOOD: description: "Look up a customer's account details by " \ +"account number. Use this BEFORE quoting " \ +"any account-specific info (balance, plan, " \ +"status). Do not use for general product " \ +"questions." + +BAD : parameters: \{ id: \{ type: 'string', description: 'the id' \} \} +GOOD: parameters: \{ account\_number: \{ type: 'string', +description: "The customer's 8-digit account " \ +"number, no dashes or spaces. Ask the user if they " \ +"don't provide it." \} \} + +\== Tool count matters + +LLM tool selection accuracy degrades past ~7-8 +simultaneously-active tools per call. Use +Contexts::Step#set\_functions to partition tools across steps so +only the relevant subset is active at any moment. + +Define a SWAIG tool. + +Python parity: +`define_tool(name, description, parameters, handler, +secure=True, fillers=None, wait_file=None, wait_file_loops=None, +webhook_url=None, required=None, is_typed_handler=False, **swaig_fields)`. + +## Signature + +```ruby +def define_tool(name:, description:, parameters: {}, handler: nil, secure: false, fillers: nil, wait_file: nil, wait_file_loops: nil, webhook_url: nil, required: nil, is_typed_handler: false, swaig_fields: nil, &block) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Yields + +- `args, raw_data` — the tool handler +- `args, raw_data` — tool handler body (alternative to passing `handler:`) + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 523. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/define-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/define-tools.mdx new file mode 100644 index 0000000000..6ea9e26b56 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/define-tools.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/define-tools" +title: "define_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#define_tools" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `define_tools` + +Return an array of all tool definitions (for SWML rendering). + +## Signature + +```ruby +def define_tools +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 577. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-debug-events.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-debug-events.mdx new file mode 100644 index 0000000000..5e2373a1d5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-debug-events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/enable-debug-events" +title: "enable_debug_events" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#enable_debug_events" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `enable_debug_events` + +## Signature + +```ruby +def enable_debug_events(level = 1) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 953. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-debug-routes.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-debug-routes.mdx new file mode 100644 index 0000000000..0fbbb07e2e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-debug-routes.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/enable-debug-routes" +title: "enable_debug_routes" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#enable_debug_routes" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `enable_debug_routes` + +## Signature + +```ruby +def enable_debug_routes +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-mcp-server.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-mcp-server.mdx new file mode 100644 index 0000000000..61ad2fbcd6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-mcp-server.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/enable-mcp-server" +title: "enable_mcp_server" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#enable_mcp_server" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `enable_mcp_server` + +Expose this agent's tools as an MCP server endpoint at /mcp. + +## Signature + +```ruby +def enable_mcp_server +``` + +## Returns + +`self` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1292. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-sip-routing.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-sip-routing.mdx new file mode 100644 index 0000000000..04c343b223 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/enable-sip-routing.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/enable-sip-routing" +title: "enable_sip_routing" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#enable_sip_routing" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `enable_sip_routing` + +\================================================================== +SIP +=== + +## Signature + +```ruby +def enable_sip_routing(auto_map: true, path: '/sip') +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1207. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/extract-sip-username-from-request.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/extract-sip-username-from-request.mdx new file mode 100644 index 0000000000..8f883079c1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/extract-sip-username-from-request.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/extract-sip-username-from-request" +title: "extract_sip_username_from_request" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase.extract_sip_username_from_request" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `extract_sip_username_from_request` + +Extract the SIP username from request body data. + +Looks for SIP URI in common request body fields +(e.g., "to", "from", "sip\_uri", "call.to", "call.from"). + +## Signature + +```ruby +def extract_sip_username_from_request(request_data) +``` + +## Parameters + + + the parsed request body + + +## Returns + +`String | nil` — the extracted SIP username, or nil + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1249. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/extract-sip-username.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/extract-sip-username.mdx new file mode 100644 index 0000000000..6e2253a3fd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/extract-sip-username.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/extract-sip-username" +title: "extract_sip_username" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase.extract_sip_username" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `extract_sip_username` + +Extract a SIP username from a SIP URI string. + +Parses URIs of the form "sip:user@domain" and returns the user part. +Handles optional "sip:" or "sips:" scheme prefixes. + +## Signature + +```ruby +def extract_sip_username(sip_uri) +``` + +## Parameters + + + a SIP URI, e.g. "sip:alice@example.com" + + +## Returns + +`String | nil` — the username, or nil if the URI cannot be parsed + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1226. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..b2ec9429b6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-basic-auth-credentials.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/get-basic-auth-credentials" +title: "get_basic_auth_credentials" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#get_basic_auth_credentials" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `get_basic_auth_credentials` + +Get the configured basic-auth credentials. + +Python parity: `get_basic_auth_credentials(include_source=False)`. +When `include_source` is true, returns a 3-tuple `[user, +pass, source]` (`"environment"` / `"auto-generated"` / +`"provided"`). Otherwise returns `[user, pass]`. + +## Signature + +```ruby +def get_basic_auth_credentials(include_source: false) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1635. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-contexts.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-contexts.mdx new file mode 100644 index 0000000000..3a7e1e8968 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-contexts.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/get-contexts" +title: "get_contexts" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#get_contexts" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `get_contexts` + +Returns the contexts dictionary as a serialised hash, or nil when +no contexts have been defined yet. + +Mirrors Python's PromptManager#get\_contexts which returns the +contexts dict or None. + +## Signature + +```ruby +def get_contexts +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 423. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-language-params.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-language-params.mdx new file mode 100644 index 0000000000..d4c71a8c60 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-language-params.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/get-language-params" +title: "get_language_params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#get_language_params" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `get_language_params` + +Read the per-language `params` hash for a previously-added +language. + +## Signature + +```ruby +def get_language_params(code) +``` + +## Parameters + + + language code as previously passed to `add_language`. + + +## Returns + +`Hash | nil` — the params hash if set, `nil` otherwise (including when the code is unknown). + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 823. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-post-prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-post-prompt.mdx new file mode 100644 index 0000000000..89a24c71d9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-post-prompt.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/get-post-prompt" +title: "get_post_prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#get_post_prompt" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `get_post_prompt` + +Returns the post-prompt text whatever set\_post\_prompt stored, or +nil when no post-prompt has been set. + +Mirrors Python's PromptManager#get\_post\_prompt / +PromptMixin#get\_post\_prompt — used by SWML rendering when a +post-prompt is configured. + +## Signature + +```ruby +def get_post_prompt +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 405. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-prompt.mdx new file mode 100644 index 0000000000..13a73ebc9a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-prompt.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/get-prompt" +title: "get_prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#get_prompt" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `get_prompt` + +Return the current prompt: either a string (text mode) or an array (POM). + +## Signature + +```ruby +def get_prompt +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 351. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-raw-prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-raw-prompt.mdx new file mode 100644 index 0000000000..c91429468b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/get-raw-prompt.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/get-raw-prompt" +title: "get_raw_prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#get_raw_prompt" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `get_raw_prompt` + +Returns the raw prompt text whatever set\_prompt\_text stored, or +nil when no raw prompt has been set. Distinct from #get\_prompt +which may return the POM array when use\_pom is true. + +Mirrors Python's PromptManager#get\_raw\_prompt. + +## Signature + +```ruby +def get_raw_prompt +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 414. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/handle-additional-route.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/handle-additional-route.mdx new file mode 100644 index 0000000000..fd1cd06cdc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/handle-additional-route.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/handle-additional-route" +title: "handle_additional_route" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#handle_additional_route" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `handle_additional_route` + +## Signature + +```ruby +def handle_additional_route(sub_path, request_data, env) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1984. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/has-skill.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/has-skill.mdx new file mode 100644 index 0000000000..d4c30da918 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/has-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/has-skill" +title: "has_skill?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#has_skill?" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `has_skill?` + +## Signature + +```ruby +def has_skill?(skill_name) +``` + +## Parameters + + + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1160. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/index.mdx new file mode 100644 index 0000000000..893b79527b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/index.mdx @@ -0,0 +1,354 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base" +title: "AgentBase" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::AgentBase" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `AgentBase` + +Central agent class that composes SWML rendering, tool dispatch, +prompt management, AI config, and HTTP serving. + +AgentBase extends SWMLService with agent-specific capabilities: + +- Prompt management (POM sections and raw text) +- Tool (SWAIG function) registration & dispatch +- AI configuration (hints, languages, pronunciations, params) +- Verb management (pre/post answer, post-AI) +- Context & step workflows +- Skill integration +- Dynamic configuration via per-request ephemeral copies + +All configuration methods return +self+ for method chaining. + +## Signature + +```ruby +class AgentBase < SignalWire::SWML::Service +``` + +## Inheritance + +**Extends:** [SignalWire::SWML::Service](/reference/ruby/signal-wire/swml/service) + +## Constants + + + Maximum request body size (1 MB) + + + + The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — +set\_internal\_fillers+ and +add\_internal\_filler+ warn if you pass an unknown name. Notable absences: +change\_step+, +gather\_submit+, or arbitrary user-defined SWAIG function names are NOT supported. + + +## Methods + + + + + + + + \================================================================== AI Config methods ================================================================== + + + + + + Add internal fillers for a single internal function and language. + + + + Add a language configuration. + + + + Add an external MCP server for tool discovery and invocation. + + + + Add a complex (pattern-matched) hint. + + + + + + + + \================================================================== Verb management ================================================================== + + + + + + Load and register a skill by name. + + + + + + Python parity: - `logger` — agent-specific structured logger (Python: `self.log`). - `skill_manager` — owning SkillManager (Python's `self.skill_manager`). - `agent_id` — UUID identifier from constructor or auto-generated. - `default_webhook_url` — base URL for SWAIG webhook fallbacks. - `native_functions` — names of built-in SWAIG functions to advertise. - `use_pom` — whether prompt-object-model rendering is enabled. + + + + Return a Rack-compatible application for mounting. + + + + + + + + + + + + Define / retrieve the ContextBuilder for this agent. + + + + Mint a per-call SWAIG-function token via the agent's SessionManager. + + + + Python parity: - `logger` — agent-specific structured logger (Python: `self.log`). - `skill_manager` — owning SkillManager (Python's `self.skill_manager`). - `agent_id` — UUID identifier from constructor or auto-generated. - `default_webhook_url` — base URL for SWAIG webhook fallbacks. - `native_functions` — names of built-in SWAIG functions to advertise. - `use_pom` — whether prompt-object-model rendering is enabled. + + + + Define / retrieve the ContextBuilder for this agent. + + + + Register a SWAIG tool (function) that the AI can invoke during a call. + + + + Return an array of all tool definitions (for SWML rendering). + + + + + + + + Expose this agent's tools as an MCP server endpoint at /mcp. + + + + \================================================================== SIP ================================================================== + + + + Extract a SIP username from a SIP URI string. + + + + Extract the SIP username from request body data. + + + + Get the configured basic-auth credentials. + + + + Returns the contexts dictionary as a serialised hash, or nil when no contexts have been defined yet. + + + + Read the per-language `params` hash for a previously-added language. + + + + Returns the post-prompt text whatever set\_post\_prompt stored, or nil when no post-prompt has been set. + + + + Return the current prompt: either a string (text mode) or an array (POM). + + + + Returns the raw prompt text whatever set\_prompt\_text stored, or nil when no raw prompt has been set. Distinct from #get\_prompt which may return the POM array when use\_pom is true. + + + + + + + + \------------------------------------------------------------------ Construction ------------------------------------------------------------------ + + + + + + Return the names of all registered SWAIG tools in insertion order. Used by ContextBuilder#validate! to detect collisions with reserved native tool names. + + + + Python parity: - `logger` — agent-specific structured logger (Python: `self.log`). - `skill_manager` — owning SkillManager (Python's `self.skill_manager`). - `agent_id` — UUID identifier from constructor or auto-generated. - `default_webhook_url` — base URL for SWAIG webhook fallbacks. - `native_functions` — names of built-in SWAIG functions to advertise. - `use_pom` — whether prompt-object-model rendering is enabled. + + + + + + Python parity: - `logger` — agent-specific structured logger (Python: `self.log`). - `skill_manager` — owning SkillManager (Python's `self.skill_manager`). - `agent_id` — UUID identifier from constructor or auto-generated. - `default_webhook_url` — base URL for SWAIG webhook fallbacks. - `native_functions` — names of built-in SWAIG functions to advertise. - `use_pom` — whether prompt-object-model rendering is enabled. + + + + + + Dispatch a function call to the registered handler. + + + + Python parity: `on_summary(self, summary, raw_data=None)` is a virtual hook called when a post-prompt summary is received. Ruby supports two equivalent shapes: + + + + Read-only snapshot of the agent's POM as a typed \{SignalWire::POM::PromptObjectModel\} instance. + + + + Add a POM section. + + + + Add a subsection under a parent section. + + + + Append content to an existing POM section, creating it if absent. + + + + Check whether a POM section with the given title exists. + + + + Return a Rack-compatible application for mounting. + + + + + + Register a raw SWAIG function definition (e.g. from DataMap#to\_swaig\_function). + + + + + + Build the complete SWML document hash. + + + + Remove all contexts, returning the agent to a no-contexts state. This is a convenience wrapper around +define\_contexts.reset+. Use it in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + + + + Universal run method — mirrors Python's `WebMixin.run(event=None, context=None, force_mode=None, host=None, port=None)`. + + + + Start the HTTP server (blocking). + + + + \================================================================== Web / HTTP configuration ================================================================== + + + + + + + + Set internal fillers for native SWAIG functions. + + + + Set (or replace) the per-language `params` dict on an already-added language. Useful when language entries are built up via add\_language first and engine-specific tuning is added later (e.g. from a config loader). Returns self for chaining. + + + + + + + + + + + + Set post-prompt text. + + + + + + + + + + Set POM array directly. + + + + Set prompt as raw text. Clears any POM state. + + + + + + + + Python parity: - `logger` — agent-specific structured logger (Python: `self.log`). - `skill_manager` — owning SkillManager (Python's `self.skill_manager`). - `agent_id` — UUID identifier from constructor or auto-generated. - `default_webhook_url` — base URL for SWAIG webhook fallbacks. - `native_functions` — names of built-in SWAIG functions to advertise. - `use_pom` — whether prompt-object-model rendering is enabled. + + + + Python parity: - `logger` — agent-specific structured logger (Python: `self.log`). - `skill_manager` — owning SkillManager (Python's `self.skill_manager`). - `agent_id` — UUID identifier from constructor or auto-generated. - `default_webhook_url` — base URL for SWAIG webhook fallbacks. - `native_functions` — names of built-in SWAIG functions to advertise. - `use_pom` — whether prompt-object-model rendering is enabled. + + + + + + Python parity: - `logger` — agent-specific structured logger (Python: `self.log`). - `skill_manager` — owning SkillManager (Python's `self.skill_manager`). - `agent_id` — UUID identifier from constructor or auto-generated. - `default_webhook_url` — base URL for SWAIG webhook fallbacks. - `native_functions` — names of built-in SWAIG functions to advertise. - `use_pom` — whether prompt-object-model rendering is enabled. + + + + Validate a per-call SWAIG-function token. Returns false when the function is not registered, when the SessionManager rejects the token, or on any underlying exception. + + + +## Classes + + + + + + \================================================================== Rack Middleware ================================================================== + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 41. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/initialize.mdx new file mode 100644 index 0000000000..9d3138eb0b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/initialize.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#initialize" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `initialize` + +*** + +## Construction + +## Signature + +```ruby +def initialize(name: 'agent', route: '/', host: '0.0.0.0', port: nil, basic_auth: nil, use_pom: true, token_expiry_secs: 3600, auto_answer: true, record_call: false, record_format: 'mp4', record_stereo: true, default_webhook_url: nil, agent_id: nil, native_functions: nil, schema_path: nil, suppress_logs: false, enable_post_prompt_override: false, check_for_input_override: false, config_file: nil, schema_validation: true, signing_key: nil, trust_proxy_for_signature: false) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`AgentBase` — a new instance of AgentBase + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 59. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/list-skills.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/list-skills.mdx new file mode 100644 index 0000000000..1b6ca82e39 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/list-skills.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/list-skills" +title: "list_skills" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#list_skills" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `list_skills` + +## Signature + +```ruby +def list_skills +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1156. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/list-tool-names.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/list-tool-names.mdx new file mode 100644 index 0000000000..989c066285 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/list-tool-names.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/list-tool-names" +title: "list_tool_names" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#list_tool_names" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `list_tool_names` + +Return the names of all registered SWAIG tools in insertion +order. Used by ContextBuilder#validate! to detect collisions with +reserved native tool names. + +## Signature + +```ruby +def list_tool_names +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1090. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/logger.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/logger.mdx new file mode 100644 index 0000000000..32627af306 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/logger.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/logger" +title: "logger" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#logger" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `logger` + +Python parity: + +- `logger` — agent-specific structured logger (Python: `self.log`). +- `skill_manager` — owning SkillManager (Python's `self.skill_manager`). +- `agent_id` — UUID identifier from constructor or auto-generated. +- `default_webhook_url` — base URL for SWAIG webhook fallbacks. +- `native_functions` — names of built-in SWAIG functions to advertise. +- `use_pom` — whether prompt-object-model rendering is enabled. + +## Signature + +```ruby +attr_reader logger -> Object +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/manual-set-proxy-url.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..eb6bc709e6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/manual-set-proxy-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/manual-set-proxy-url" +title: "manual_set_proxy_url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#manual_set_proxy_url" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `manual_set_proxy_url` + +## Signature + +```ruby +def manual_set_proxy_url(url) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1173. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/native-functions.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/native-functions.mdx new file mode 100644 index 0000000000..2cd9762c4f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/native-functions.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/native-functions" +title: "native_functions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#native_functions" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `native_functions` + +Python parity: + +- `logger` — agent-specific structured logger (Python: `self.log`). +- `skill_manager` — owning SkillManager (Python's `self.skill_manager`). +- `agent_id` — UUID identifier from constructor or auto-generated. +- `default_webhook_url` — base URL for SWAIG webhook fallbacks. +- `native_functions` — names of built-in SWAIG functions to advertise. +- `use_pom` — whether prompt-object-model rendering is enabled. + +## Signature + +```ruby +attr_reader native_functions -> Object +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/on-debug-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/on-debug-event.mdx new file mode 100644 index 0000000000..9b3b3f1e5b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/on-debug-event.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/on-debug-event" +title: "on_debug_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#on_debug_event" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `on_debug_event` + +## Signature + +```ruby +def on_debug_event(&block) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1434. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/on-function-call.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/on-function-call.mdx new file mode 100644 index 0000000000..25619bb879 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/on-function-call.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/on-function-call" +title: "on_function_call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#on_function_call" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `on_function_call` + +Dispatch a function call to the registered handler. + +## Signature + +```ruby +def on_function_call(name, args, raw_data) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 607. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/on-summary.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/on-summary.mdx new file mode 100644 index 0000000000..b5834c1573 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/on-summary.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/on-summary" +title: "on_summary" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#on_summary" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `on_summary` + +Python parity: `on_summary(self, summary, raw_data=None)` is a +virtual hook called when a post-prompt summary is received. +Ruby supports two equivalent shapes: + +1. **Registration** (Ruby idiom) — pass a block to install a + callback. The block receives `(summary, raw_data)` when a + summary is delivered. `on_summary { |sum, raw| ... }` +2. **Override** (Python idiom) — subclass and override + `on_summary(summary, raw_data = nil)`. Default + implementation calls the registered block (if any) and + otherwise no-ops. + +## Signature + +```ruby +def on_summary(summary = nil, raw_data = nil, &block) +``` + +## Parameters + + + the post-prompt summary + + + + the complete raw POST data + + + + +## Yields + +- `summary, raw_data` — optional callback registration + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1424. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/pom.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/pom.mdx new file mode 100644 index 0000000000..82488caf82 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/pom.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/pom" +title: "pom" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#pom" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `pom` + +Read-only snapshot of the agent's POM as a typed +\{SignalWire::POM::PromptObjectModel\} instance. + +Python parity: `agent.pom` instance attribute (agent\_base.py +line 209) is a `PromptObjectModel` instance. Returns `nil` when +raw-text prompt mode is in effect (`set_prompt_text` was called) +— mirrors Python's `self.pom = None when use_pom=False`. + +The returned PromptObjectModel is a fresh build of the agent's +current section state, so caller mutations do not leak into agent +state. Use `agent.pom.to_h` to retrieve the legacy +array-of-hashes representation. + +## Signature + +```ruby +def pom +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 370. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-add-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-add-section.mdx new file mode 100644 index 0000000000..7b9123f248 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-add-section.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/prompt-add-section" +title: "prompt_add_section" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#prompt_add_section" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `prompt_add_section` + +Add a POM section. + +Python parity: +`prompt_add_section(title, body="", bullets=None, +numbered=False, numbered_bullets=False, subsections=None)`. + +## Signature + +```ruby +def prompt_add_section(title, body = nil, bullets: nil, numbered: false, numbered_bullets: false, subsections: nil) +``` + +## Parameters + + + section title + + + + optional body text + + + + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 269. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-add-subsection.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-add-subsection.mdx new file mode 100644 index 0000000000..5f1109b0fa --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-add-subsection.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/prompt-add-subsection" +title: "prompt_add_subsection" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#prompt_add_subsection" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `prompt_add_subsection` + +Add a subsection under a parent section. + +## Signature + +```ruby +def prompt_add_subsection(parent_title, title, body = nil, bullets: nil) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 333. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-add-to-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-add-to-section.mdx new file mode 100644 index 0000000000..47d93f6774 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-add-to-section.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/prompt-add-to-section" +title: "prompt_add_to_section" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#prompt_add_to_section" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `prompt_add_to_section` + +Append content to an existing POM section, creating it if absent. + +Python parity: +`prompt_add_to_section(title, body=None, bullet=None, +bullets=None)`. Supports appending body text, a single bullet, +or a list of bullets. + +**Backwards compat:** the original Ruby signature was +`prompt_add_to_section(title, text)`. When called with two +positional arguments the second becomes `body`; this preserves +existing call sites while still supporting Python's keyword form. + +## Signature + +```ruby +def prompt_add_to_section(title, body_arg = nil, body: nil, bullet: nil, bullets: nil) +``` + +## Parameters + + + section title + + + + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 309. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-has-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-has-section.mdx new file mode 100644 index 0000000000..3b91b9512a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/prompt-has-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/prompt-has-section" +title: "prompt_has_section?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#prompt_has_section?" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `prompt_has_section?` + +Check whether a POM section with the given title exists. + +## Signature + +```ruby +def prompt_has_section?(title) +``` + +## Parameters + + + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 346. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/rack-app.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/rack-app.mdx new file mode 100644 index 0000000000..5a5ae4a191 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/rack-app.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/rack-app" +title: "rack_app" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#rack_app" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `rack_app` + +Return a Rack-compatible application for mounting. + +## Signature + +```ruby +def rack_app +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1550. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/register-sip-username.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/register-sip-username.mdx new file mode 100644 index 0000000000..75efc1aa08 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/register-sip-username.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/register-sip-username" +title: "register_sip_username" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#register_sip_username" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `register_sip_username` + +## Signature + +```ruby +def register_sip_username(username) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1214. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/register-swaig-function.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/register-swaig-function.mdx new file mode 100644 index 0000000000..9ddd2e9468 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/register-swaig-function.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/register-swaig-function" +title: "register_swaig_function" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#register_swaig_function" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `register_swaig_function` + +Register a raw SWAIG function definition (e.g. from DataMap#to\_swaig\_function). + +## Signature + +```ruby +def register_swaig_function(func_def) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 569. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/remove-skill.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/remove-skill.mdx new file mode 100644 index 0000000000..8ec9f3db38 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/remove-skill.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/remove-skill" +title: "remove_skill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#remove_skill" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `remove_skill` + +## Signature + +```ruby +def remove_skill(skill_name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1150. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/render-swml.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/render-swml.mdx new file mode 100644 index 0000000000..ca61daa092 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/render-swml.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/render-swml" +title: "render_swml" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#render_swml" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `render_swml` + +Build the complete SWML document hash. + +## Signature + +```ruby +def render_swml(request_data = nil, request: nil) +``` + +## Parameters + + + parsed request body + + + + +## Returns + +`Hash` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1565. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/reset-contexts.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/reset-contexts.mdx new file mode 100644 index 0000000000..ff38769953 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/reset-contexts.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/reset-contexts" +title: "reset_contexts" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#reset_contexts" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `reset_contexts` + +Remove all contexts, returning the agent to a no-contexts state. +This is a convenience wrapper around +define\_contexts.reset+. +Use it in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```ruby +def reset_contexts +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1082. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/run.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/run.mdx new file mode 100644 index 0000000000..184634f22b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/run.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/run" +title: "run" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#run" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `run` + +Universal run method — mirrors Python's +`WebMixin.run(event=None, context=None, force_mode=None, +host=None, port=None)`. + +Detects execution mode (server / lambda / cgi) and routes +accordingly. `force_mode` overrides auto-detection. + +## Signature + +```ruby +def run(event: nil, context: nil, force_mode: nil, host: nil, port: nil) +``` + +## Parameters + + + + + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1452. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/serve.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/serve.mdx new file mode 100644 index 0000000000..8778478358 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/serve.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/serve" +title: "serve" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#serve" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `serve` + +Start the HTTP server (blocking). + +Python parity: `serve(host=None, port=None)`. `host` / +`port` overrides default to constructor-supplied values. + +## Signature + +```ruby +def serve(host: nil, port: nil) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1518. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..ce56f53010 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-dynamic-config-callback.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-dynamic-config-callback" +title: "set_dynamic_config_callback" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_dynamic_config_callback" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_dynamic_config_callback` + +\================================================================== +Web / HTTP configuration +======================== + +## Signature + +```ruby +def set_dynamic_config_callback(callable = nil, &block) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1168. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-function-includes.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-function-includes.mdx new file mode 100644 index 0000000000..8a70d75ee0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-function-includes.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-function-includes" +title: "set_function_includes" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_function_includes" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_function_includes` + +## Signature + +```ruby +def set_function_includes(includes) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 966. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-global-data.mdx new file mode 100644 index 0000000000..5e2b39680e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-global-data" +title: "set_global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_global_data" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_global_data` + +## Signature + +```ruby +def set_global_data(data) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 859. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-internal-fillers.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-internal-fillers.mdx new file mode 100644 index 0000000000..d8322c2641 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-internal-fillers.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-internal-fillers" +title: "set_internal_fillers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_internal_fillers" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_internal_fillers` + +Set internal fillers for native SWAIG functions. + +Internal fillers are short phrases the AI agent speaks (via TTS) +while an internal/native function is running, so the caller +doesn't hear dead air during transitions or background work. + +Supported function names (match the SWAIGInternalFiller schema): ++hangup+, +check\_time+, +wait\_for\_user+, +wait\_seconds+, ++adjust\_response\_latency+, +next\_step+, +change\_context+, ++get\_visual\_input+, +get\_ideal\_strategy+. See +SUPPORTED\_INTERNAL\_FILLER\_NAMES. + +Notably NOT supported: +change\_step+, +gather\_submit+, or +arbitrary user-defined SWAIG function names. The runtime only +honors fillers for the names listed above; everything else is +silently ignored at the SWML level. This method warns at +registration time if you pass an unknown name so you catch the +typo early. + +Expected format: +\{ function\_name => \{ language\_code => \[phrases] \} \}+ + +## Signature + +```ruby +def set_internal_fillers(fillers) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 914. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-language-params.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-language-params.mdx new file mode 100644 index 0000000000..4bf7cc8968 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-language-params.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-language-params" +title: "set_language_params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_language_params" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_language_params` + +Set (or replace) the per-language `params` dict on an +already-added language. Useful when language entries are built up +via add\_language first and engine-specific tuning is added later +(e.g. from a config loader). Returns self for chaining. + +## Signature + +```ruby +def set_language_params(code, params) +``` + +## Parameters + + + language code as previously passed to `add_language` (e.g. `"en-US"`). + + + + engine-specific params hash to attach. Empty hash removes the key. + + +## Returns + +`self` — No-op if the code isn't found. + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 804. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-languages.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-languages.mdx new file mode 100644 index 0000000000..472ea17005 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-languages.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-languages" +title: "set_languages" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_languages" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_languages` + +## Signature + +```ruby +def set_languages(languages) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 830. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-native-functions.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-native-functions.mdx new file mode 100644 index 0000000000..453e50b466 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-native-functions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-native-functions" +title: "set_native_functions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_native_functions" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_native_functions` + +## Signature + +```ruby +def set_native_functions(names) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 868. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-param.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-param.mdx new file mode 100644 index 0000000000..f0fc315aff --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-param.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-param" +title: "set_param" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_param" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_param` + +## Signature + +```ruby +def set_param(key, value) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 847. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-params.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-params.mdx new file mode 100644 index 0000000000..e3438b43ef --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-params" +title: "set_params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_params" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_params` + +## Signature + +```ruby +def set_params(params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 852. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..260ffc063c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-post-prompt-llm-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-post-prompt-llm-params" +title: "set_post_prompt_llm_params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_post_prompt_llm_params" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_post_prompt_llm_params` + +## Signature + +```ruby +def set_post_prompt_llm_params(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 976. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-post-prompt-url.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-post-prompt-url.mdx new file mode 100644 index 0000000000..6128b4950d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-post-prompt-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-post-prompt-url" +title: "set_post_prompt_url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_post_prompt_url" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_post_prompt_url` + +## Signature + +```ruby +def set_post_prompt_url(url) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1183. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-post-prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-post-prompt.mdx new file mode 100644 index 0000000000..43c5397346 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-post-prompt.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-post-prompt" +title: "set_post_prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_post_prompt" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_post_prompt` + +Set post-prompt text. + +## Signature + +```ruby +def set_post_prompt(text) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 243. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-prompt-llm-params.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..9d4d5768f1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-prompt-llm-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-prompt-llm-params" +title: "set_prompt_llm_params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_prompt_llm_params" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_prompt_llm_params` + +## Signature + +```ruby +def set_prompt_llm_params(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 971. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-prompt-pom.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-prompt-pom.mdx new file mode 100644 index 0000000000..d97e4ba127 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-prompt-pom.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-prompt-pom" +title: "set_prompt_pom" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_prompt_pom" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_prompt_pom` + +Set POM array directly. + +## Signature + +```ruby +def set_prompt_pom(pom) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 249. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-prompt-text.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-prompt-text.mdx new file mode 100644 index 0000000000..e1d5d6086d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-prompt-text.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-prompt-text" +title: "set_prompt_text" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_prompt_text" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_prompt_text` + +Set prompt as raw text. Clears any POM state. + +## Signature + +```ruby +def set_prompt_text(text) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 235. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-pronunciations.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-pronunciations.mdx new file mode 100644 index 0000000000..14eaebfb0b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-pronunciations.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-pronunciations" +title: "set_pronunciations" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_pronunciations" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_pronunciations` + +## Signature + +```ruby +def set_pronunciations(pronunciations) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 842. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-web-hook-url.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-web-hook-url.mdx new file mode 100644 index 0000000000..45323d6254 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/set-web-hook-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/set-web-hook-url" +title: "set_web_hook_url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#set_web_hook_url" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `set_web_hook_url` + +## Signature + +```ruby +def set_web_hook_url(url) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 1178. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/signing-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/signing-key.mdx new file mode 100644 index 0000000000..2e0662cfb0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/signing-key.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/signing-key" +title: "signing_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#signing_key" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `signing_key` + +Python parity: + +- `logger` — agent-specific structured logger (Python: `self.log`). +- `skill_manager` — owning SkillManager (Python's `self.skill_manager`). +- `agent_id` — UUID identifier from constructor or auto-generated. +- `default_webhook_url` — base URL for SWAIG webhook fallbacks. +- `native_functions` — names of built-in SWAIG functions to advertise. +- `use_pom` — whether prompt-object-model rendering is enabled. + +## Signature + +```ruby +attr_reader signing_key -> Object +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/skill-manager.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/skill-manager.mdx new file mode 100644 index 0000000000..5567cbc431 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/skill-manager.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/skill-manager" +title: "skill_manager" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#skill_manager" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `skill_manager` + +Python parity: + +- `logger` — agent-specific structured logger (Python: `self.log`). +- `skill_manager` — owning SkillManager (Python's `self.skill_manager`). +- `agent_id` — UUID identifier from constructor or auto-generated. +- `default_webhook_url` — base URL for SWAIG webhook fallbacks. +- `native_functions` — names of built-in SWAIG functions to advertise. +- `use_pom` — whether prompt-object-model rendering is enabled. + +## Signature + +```ruby +attr_reader skill_manager -> Object +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/update-global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/update-global-data.mdx new file mode 100644 index 0000000000..0171d661cf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/update-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/update-global-data" +title: "update_global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#update_global_data" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `update_global_data` + +## Signature + +```ruby +def update_global_data(data) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 864. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/use-pom.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/use-pom.mdx new file mode 100644 index 0000000000..066c0ca368 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/use-pom.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/use-pom" +title: "use_pom" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#use_pom" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `use_pom` + +Python parity: + +- `logger` — agent-specific structured logger (Python: `self.log`). +- `skill_manager` — owning SkillManager (Python's `self.skill_manager`). +- `agent_id` — UUID identifier from constructor or auto-generated. +- `default_webhook_url` — base URL for SWAIG webhook fallbacks. +- `native_functions` — names of built-in SWAIG functions to advertise. +- `use_pom` — whether prompt-object-model rendering is enabled. + +## Signature + +```ruby +attr_reader use_pom -> Object +``` + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-base/validate-tool-token.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-base/validate-tool-token.mdx new file mode 100644 index 0000000000..64fe276821 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-base/validate-tool-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/ruby/signal-wire/agent-base/validate-tool-token" +title: "validate_tool_token" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentBase#validate_tool_token" + parent: "SignalWire::AgentBase" + module: "SignalWire.AgentBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb" + visibility: "public" +--- +# `validate_tool_token` + +Validate a per-call SWAIG-function token. Returns false when the +function is not registered, when the SessionManager rejects the +token, or on any underlying exception. + +Python parity: state\_mixin.StateMixin#validate\_tool\_token — +rejects unknown function names up-front and rescues exceptions. + +## Signature + +```ruby +def validate_tool_token(function_name, token, call_id) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/agent/agent_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/agent/agent_base.rb) + +Line 599. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/app.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/app.mdx new file mode 100644 index 0000000000..182254b9f8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/app.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/app" +title: "app" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#app" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `app` + +Public Rack application — Python parity: `server.app` exposes +the underlying FastAPI instance. Ruby exposes the cached Rack +app (a Proc) so callers can mount it on their own server or +pass it to Rack-compatible test harnesses. + +## Signature + +```ruby +def app +``` + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 27. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/get-agent.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/get-agent.mdx new file mode 100644 index 0000000000..1333544bdf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/get-agent.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/get-agent" +title: "get_agent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#get_agent" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `get_agent` + +Get a specific agent by route. + +## Signature + +```ruby +def get_agent(route) +``` + +## Parameters + + + +## Returns + +`Object | nil` + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 154. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/get-agents.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/get-agents.mdx new file mode 100644 index 0000000000..5776521c94 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/get-agents.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/get-agents" +title: "get_agents" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#get_agents" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `get_agents` + +Get all registered agents. + +## Signature + +```ruby +def get_agents +``` + +## Returns + +`Hash` — route => agent + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 147. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/host.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/host.mdx new file mode 100644 index 0000000000..ca9eb76bdd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/host.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/host" +title: "host" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#host" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `host` + +Returns the value of attribute host. + +## Signature + +```ruby +attr_reader host -> Object +``` + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/index.mdx new file mode 100644 index 0000000000..0857f99276 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/index.mdx @@ -0,0 +1,127 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server" +title: "AgentServer" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::AgentServer" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `AgentServer` + +Multi-agent hosting on a single Rack application. + +server = AgentServer.new(host: '0.0.0.0', port: 3000) +server.register(my\_agent, route: '/agent1') +server.register(my\_agent2, route: '/agent2') +server.run + +## Signature + +```ruby +class AgentServer < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Constants + + + MIME types for static file serving. + + + + Security headers applied to static file responses. + + +## Methods + + + + Public Rack application — Python parity: `server.app` exposes the underlying FastAPI instance. Ruby exposes the cached Rack app (a Proc) so callers can mount it on their own server or pass it to Rack-compatible test harnesses. + + + + Get a specific agent by route. + + + + Get all registered agents. + + + + Returns the value of attribute host. + + + + Construct an AgentServer. + + + + Returns the value of attribute log\_level. + + + + Returns the value of attribute logger. + + + + Returns the value of attribute port. + + + + Build a Rack application that routes requests to the appropriate agent. + + + + Register an agent at a given route. + + + + Register a SIP username mapping to a route. + + + + Universal run method — mirrors Python's `AgentServer.run(event=None, context=None, host=None, port=None)`. + + + + Serve static files from a directory at a given route. + + + + Set up SIP-based routing. + + + + Unregister an agent by route. + + + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 20. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/initialize.mdx new file mode 100644 index 0000000000..7cdf03bd63 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/initialize.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#initialize" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `initialize` + +Construct an AgentServer. + +Python parity: `AgentServer(host, port, log_level)` — +`log_level` controls the AgentServer's logger verbosity. The +Ruby port maps it through `SignalWire::Logging.logger` so the +WARN/INFO/DEBUG semantics match Python's `logging` levels. + +## Signature + +```ruby +def initialize(host: '0.0.0.0', port: 3000, log_level: 'info') +``` + +## Parameters + + + + + + + +## Returns + +`AgentServer` — a new instance of AgentServer + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 74. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/log-level.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/log-level.mdx new file mode 100644 index 0000000000..83e8d508a4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/log-level.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/log-level" +title: "log_level" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#log_level" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `log_level` + +Returns the value of attribute log\_level. + +## Signature + +```ruby +attr_reader log_level -> Object +``` + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/logger.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/logger.mdx new file mode 100644 index 0000000000..946e2bee36 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/logger.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/logger" +title: "logger" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#logger" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `logger` + +Returns the value of attribute logger. + +## Signature + +```ruby +attr_reader logger -> Object +``` + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/port.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/port.mdx new file mode 100644 index 0000000000..712e92f793 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/port.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/port" +title: "port" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#port" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `port` + +Returns the value of attribute port. + +## Signature + +```ruby +attr_reader port -> Object +``` + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/rack-app.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/rack-app.mdx new file mode 100644 index 0000000000..d3dc5b9eba --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/rack-app.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/rack-app" +title: "rack_app" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#rack_app" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `rack_app` + +Build a Rack application that routes requests to the appropriate agent. + +## Signature + +```ruby +def rack_app +``` + +## Returns + +`Proc` — a Rack-compatible app + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 307. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/register-sip-username.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/register-sip-username.mdx new file mode 100644 index 0000000000..3b6ad993b9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/register-sip-username.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/register-sip-username" +title: "register_sip_username" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#register_sip_username" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `register_sip_username` + +Register a SIP username mapping to a route. + +## Signature + +```ruby +def register_sip_username(username, route) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 176. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/register.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/register.mdx new file mode 100644 index 0000000000..43479f9a6e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/register.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/register" +title: "register" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#register" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `register` + +Register an agent at a given route. + +## Signature + +```ruby +def register(agent, route: nil) +``` + +## Parameters + + + an agent object (e.g. AgentBase or prefab) + + + + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 126. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/run.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/run.mdx new file mode 100644 index 0000000000..54442f64b7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/run.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/run" +title: "run" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#run" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `run` + +Universal run method — mirrors Python's +`AgentServer.run(event=None, context=None, host=None, port=None)`. + +Detects execution mode and routes appropriately: + +- **Server mode** — starts WEBrick (Ruby's stdlib HTTP server) + bound to `host`/`port` (overrides honoured if supplied). +- **Lambda mode** (`AWS_LAMBDA_FUNCTION_NAME` env var present) + — invokes `_handle_lambda_request(event, context)` and + returns the Lambda response Hash. +- **CGI mode** (`GATEWAY_INTERFACE` env var present) — invokes + `_handle_cgi_request` and returns the CGI response String. + +## Signature + +```ruby +def run(event: nil, context: nil, host: nil, port: nil) +``` + +## Parameters + + + + + + + + + +## Returns + +`Object | nil` — response for serverless modes, nil for server mode (blocking until shutdown). + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 216. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/serve-static-files.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/serve-static-files.mdx new file mode 100644 index 0000000000..0e067ee5b9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/serve-static-files.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/serve-static-files" +title: "serve_static_files" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#serve_static_files" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `serve_static_files` + +Serve static files from a directory at a given route. + +## Signature + +```ruby +def serve_static_files(directory, route) +``` + +## Parameters + + + absolute or relative path to the directory + + + + the URL prefix to serve files at + + +## Returns + +`self` + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 187. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/setup-sip-routing.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/setup-sip-routing.mdx new file mode 100644 index 0000000000..c2586ff02e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/setup-sip-routing.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/setup-sip-routing" +title: "setup_sip_routing" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#setup_sip_routing" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `setup_sip_routing` + +Set up SIP-based routing. + +## Signature + +```ruby +def setup_sip_routing(route: '/sip', auto_map: true) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 162. diff --git a/fern/products/sdk-reference/ruby/signal-wire/agent-server/unregister.mdx b/fern/products/sdk-reference/ruby/signal-wire/agent-server/unregister.mdx new file mode 100644 index 0000000000..d410043261 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/agent-server/unregister.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/agent-server/unregister" +title: "unregister" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::AgentServer#unregister" + parent: "SignalWire::AgentServer" + module: "SignalWire.AgentServer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb" + visibility: "public" +--- +# `unregister` + +Unregister an agent by route. + +## Signature + +```ruby +def unregister(route) +``` + +## Parameters + + + +## Returns + +`Object | nil` — the removed agent + +## Source + +[`lib/signalwire/server/agent_server.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/server/agent_server.rb) + +Line 140. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/add-context.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/add-context.mdx new file mode 100644 index 0000000000..7f4ed6bd61 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/add-context.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context-builder/add-context" +title: "add_context" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::ContextBuilder#add_context" + parent: "SignalWire::Contexts::ContextBuilder" + module: "SignalWire.Contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_context` + +Add a new context. Returns the Context object. + +## Signature + +```ruby +def add_context(name) +``` + +## Parameters + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 696. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/attach-agent.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/attach-agent.mdx new file mode 100644 index 0000000000..c4af79aaac --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/attach-agent.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context-builder/attach-agent" +title: "attach_agent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::ContextBuilder#attach_agent" + parent: "SignalWire::Contexts::ContextBuilder" + module: "SignalWire.Contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `attach_agent` + +Attach an agent reference so +validate!+ can check +user-defined tool names against RESERVED\_NATIVE\_TOOL\_NAMES. +Called internally by AgentBase#define\_contexts. + +## Signature + +```ruby +def attach_agent(agent) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 681. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/get-context.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/get-context.mdx new file mode 100644 index 0000000000..51db71a37d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/get-context.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context-builder/get-context" +title: "get_context" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::ContextBuilder#get_context" + parent: "SignalWire::Contexts::ContextBuilder" + module: "SignalWire.Contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `get_context` + +Get an existing context by name. Returns Context or nil. + +## Signature + +```ruby +def get_context(name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 707. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/index.mdx new file mode 100644 index 0000000000..c0f82d33f2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/index.mdx @@ -0,0 +1,101 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context-builder" +title: "ContextBuilder" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Contexts::ContextBuilder" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `ContextBuilder` + +Builder for multi-step, multi-context AI agent workflows. + +A ContextBuilder owns one or more Contexts; each Context owns an +ordered list of Steps. Only one context and one step is active at +a time. Per chat turn, the runtime injects the current step's +instructions as a system message, then asks the LLM for a +response. + +\== Native tools auto-injected by the runtime + +When a step (or its enclosing context) declares +valid\_steps+ or ++valid\_contexts+, the runtime auto-injects two native tools so +the model can navigate the flow: + +- +next\_step(step: enum)+ — present when valid\_steps is set +- +change\_context(context: enum)+ — present when valid\_contexts is set + +Their +enum+ schemas are rewritten on every turn to match +whatever valid\_steps / valid\_contexts apply to the current step. +You do NOT need to define these tools yourself; they appear +automatically. + +A third native tool — +gather\_submit+ — is injected during +gather\_info questioning (see Step#set\_gather\_info / +Step#add\_gather\_question). + +These three names — +next\_step+, +change\_context+, ++gather\_submit+ — are reserved. +validate!+ will reject any agent +that defines a SWAIG tool with one of these names. See +RESERVED\_NATIVE\_TOOL\_NAMES. + +\== Function whitelisting (Step#set\_functions) + +Each step may declare a +functions+ whitelist. The whitelist is +applied in-memory at the start of each LLM turn. CRITICALLY: if a +step does NOT declare a +functions+ field, it INHERITS the +previous step's active set. See Step#set\_functions for details +and examples. + +## Signature + +```ruby +class ContextBuilder < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Add a new context. Returns the Context object. + + + + Attach an agent reference so +validate!+ can check user-defined tool names against RESERVED\_NATIVE\_TOOL\_NAMES. Called internally by AgentBase#define\_contexts. + + + + Get an existing context by name. Returns Context or nil. + + + + Python parity: `ContextBuilder.__init__(self, agent)` accepts an owning agent so `validate!` can introspect registered SWAIG tools when checking for reserved-name collisions. Ruby allows nil for standalone use (tests, idiom of building a builder before attaching). + + + + Remove all contexts, returning the builder to its initial state. Use this in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + + + + + + Validate the full configuration. Raises ArgumentError on problems. + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 666. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/initialize.mdx new file mode 100644 index 0000000000..feb57b364d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/initialize.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context-builder/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::ContextBuilder#initialize" + parent: "SignalWire::Contexts::ContextBuilder" + module: "SignalWire.Contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `initialize` + +Python parity: `ContextBuilder.__init__(self, agent)` accepts +an owning agent so `validate!` can introspect registered +SWAIG tools when checking for reserved-name collisions. +Ruby allows nil for standalone use (tests, idiom of building +a builder before attaching). + +## Signature + +```ruby +def initialize(agent = nil) +``` + +## Parameters + + + +## Returns + +`ContextBuilder` — a new instance of ContextBuilder + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 672. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/reset.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/reset.mdx new file mode 100644 index 0000000000..cb707f8839 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context-builder/reset" +title: "reset" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::ContextBuilder#reset" + parent: "SignalWire::Contexts::ContextBuilder" + module: "SignalWire.Contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `reset` + +Remove all contexts, returning the builder to its initial state. +Use this in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```ruby +def reset +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 689. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/to-h.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/to-h.mdx new file mode 100644 index 0000000000..facad95b45 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/to-h.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context-builder/to-h" +title: "to_h" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::ContextBuilder#to_h" + parent: "SignalWire::Contexts::ContextBuilder" + module: "SignalWire.Contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `to_h` + +## Signature + +```ruby +def to_h +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 846. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/validate.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/validate.mdx new file mode 100644 index 0000000000..86f1d38947 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context-builder/validate.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context-builder/validate" +title: "validate!" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::ContextBuilder#validate!" + parent: "SignalWire::Contexts::ContextBuilder" + module: "SignalWire.Contexts.ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `validate!` + +Validate the full configuration. Raises ArgumentError on problems. + +## Signature + +```ruby +def validate! +``` + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 712. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-bullets.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-bullets.mdx new file mode 100644 index 0000000000..1352fb366d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-bullets.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/add-bullets" +title: "add_bullets" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#add_bullets" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_bullets` + +Add a POM section with bullets to the context prompt. + +## Signature + +```ruby +def add_bullets(title, bullets) +``` + +## Parameters + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 516. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-enter-filler.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-enter-filler.mdx new file mode 100644 index 0000000000..cda4c873d0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-enter-filler.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/add-enter-filler" +title: "add_enter_filler" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#add_enter_filler" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_enter_filler` + +## Signature + +```ruby +def add_enter_filler(lang_code, fillers) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 549. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-exit-filler.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-exit-filler.mdx new file mode 100644 index 0000000000..119891b327 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-exit-filler.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/add-exit-filler" +title: "add_exit_filler" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#add_exit_filler" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_exit_filler` + +## Signature + +```ruby +def add_exit_filler(lang_code, fillers) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 557. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-section.mdx new file mode 100644 index 0000000000..b57bba3534 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/add-section" +title: "add_section" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#add_section" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_section` + +Add a POM section to the context prompt. + +## Signature + +```ruby +def add_section(title, body) +``` + +## Parameters + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 508. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-step.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-step.mdx new file mode 100644 index 0000000000..8ba9cce980 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-step.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/add-step" +title: "add_step" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#add_step" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_step` + +Add a new step. Returns the new Step object (not self). + +Python parity: `Context.add_step(name, *, task=None, bullets=None, +criteria=None, functions=None, valid_steps=None)`. The optional +keyword arguments give a one-call configuration shortcut: + +ctx.add\_step("greet", +task: "Greet the caller", +bullets: \["Say hi", "Ask how can I help"], +criteria: "User has been greeted", +functions: \["weather"], +valid\_steps: \["help"]) + +Without the optional args this stays the bare `add_step("greet")` +form that returns a Step for further fluent configuration. + +## Signature + +```ruby +def add_step(name, task: nil, bullets: nil, criteria: nil, functions: nil, valid_steps: nil) +``` + +## Parameters + + + + + + + + + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 388. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-system-bullets.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-system-bullets.mdx new file mode 100644 index 0000000000..3bd7414d59 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-system-bullets.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/add-system-bullets" +title: "add_system_bullets" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#add_system_bullets" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_system_bullets` + +Add a POM section with bullets to the system prompt. + +## Signature + +```ruby +def add_system_bullets(title, bullets) +``` + +## Parameters + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 532. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-system-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-system-section.mdx new file mode 100644 index 0000000000..d95e6de162 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/add-system-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/add-system-section" +title: "add_system_section" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#add_system_section" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_system_section` + +Add a POM section to the system prompt. + +## Signature + +```ruby +def add_system_section(title, body) +``` + +## Parameters + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 524. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/get-step.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/get-step.mdx new file mode 100644 index 0000000000..3f387ed9db --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/get-step.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/get-step" +title: "get_step" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#get_step" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `get_step` + +Get an existing step by name. Returns Step or nil. + +## Signature + +```ruby +def get_step(name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 407. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/index.mdx new file mode 100644 index 0000000000..4bf46398d4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/index.mdx @@ -0,0 +1,114 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context" +title: "Context" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `Context` + +Represents a single context containing multiple steps. + +## Signature + +```ruby +class Context < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + + + + + Add a POM section with bullets to the context prompt. + + + + + + + + Add a POM section to the context prompt. + + + + Add a new step. Returns the new Step object (not self). + + + + Add a POM section with bullets to the system prompt. + + + + Add a POM section to the system prompt. + + + + Get an existing step by name. Returns Step or nil. + + + + + + Move an existing step to a specific position. Returns self. + + + + Returns the value of attribute name. + + + + Remove a step by name. Returns self. + + + + + + + + + + + + Set which step the context starts on when entered. + + + + Mark this context as isolated — entering it wipes conversation history. + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 342. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/initial-step.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/initial-step.mdx new file mode 100644 index 0000000000..6efec574c8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/initial-step.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/initial-step" +title: "_initial_step" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#_initial_step" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `_initial_step` + +## Signature + +```ruby +def _initial_step +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 601. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/initialize.mdx new file mode 100644 index 0000000000..b0b9eae72f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#initialize" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(name) +``` + +## Parameters + + + +## Returns + +`Context` — a new instance of Context + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 345. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/move-step.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/move-step.mdx new file mode 100644 index 0000000000..ce3dff35e2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/move-step.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/move-step" +title: "move_step" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#move_step" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `move_step` + +Move an existing step to a specific position. Returns self. + +## Signature + +```ruby +def move_step(name, position) +``` + +## Parameters + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 421. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/name.mdx new file mode 100644 index 0000000000..cecf5dd334 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#name" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `name` + +Returns the value of attribute name. + +## Signature + +```ruby +attr_reader name -> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 343. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/remove-step.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/remove-step.mdx new file mode 100644 index 0000000000..8cba3efec7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/remove-step.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/remove-step" +title: "remove_step" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#remove_step" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `remove_step` + +Remove a step by name. Returns self. + +## Signature + +```ruby +def remove_step(name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 412. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-consolidate.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-consolidate.mdx new file mode 100644 index 0000000000..587767c8f0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-consolidate.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-consolidate" +title: "set_consolidate" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_consolidate" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_consolidate` + +## Signature + +```ruby +def set_consolidate(val) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 469. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-enter-fillers.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-enter-fillers.mdx new file mode 100644 index 0000000000..567980cbf0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-enter-fillers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-enter-fillers" +title: "set_enter_fillers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_enter_fillers" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_enter_fillers` + +## Signature + +```ruby +def set_enter_fillers(fillers) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 539. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-exit-fillers.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-exit-fillers.mdx new file mode 100644 index 0000000000..087abaab3a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-exit-fillers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-exit-fillers" +title: "set_exit_fillers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_exit_fillers" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_exit_fillers` + +## Signature + +```ruby +def set_exit_fillers(fillers) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 544. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-full-reset.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-full-reset.mdx new file mode 100644 index 0000000000..adc620d99d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-full-reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-full-reset" +title: "set_full_reset" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_full_reset" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_full_reset` + +## Signature + +```ruby +def set_full_reset(val) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 474. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-initial-step.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-initial-step.mdx new file mode 100644 index 0000000000..3544412dde --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-initial-step.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-initial-step" +title: "set_initial_step" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_initial_step" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_initial_step` + +Set which step the context starts on when entered. + +By default, a context starts on its first step (index 0). Use +this to skip a preamble step on re-entry via +change\_context+. + +## Signature + +```ruby +def set_initial_step(step_name) +``` + +## Parameters + + + name of the step to start on. + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 435. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-isolated.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-isolated.mdx new file mode 100644 index 0000000000..cbf07af55d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-isolated.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-isolated" +title: "set_isolated" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_isolated" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_isolated` + +Mark this context as isolated — entering it wipes conversation +history. + +When +val+ = true and the context is entered via change\_context, +the runtime wipes the conversation array. The model starts +fresh with only the new context's system\_prompt + step +instructions, with no memory of prior turns. + +EXCEPTION — reset overrides the wipe: +If the context also has a reset configuration (via ++set\_consolidate+ or +set\_full\_reset+), the wipe is skipped in +favor of the reset behavior. Use reset with consolidate=true +to summarize prior history into a single message instead of +dropping it entirely. + +Use cases: switching to a sensitive billing flow that should +not see prior small-talk; handing off to a different agent +persona; resetting after a long off-topic detour. + +## Signature + +```ruby +def set_isolated(val) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 502. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-post-prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-post-prompt.mdx new file mode 100644 index 0000000000..b2140d3834 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-post-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-post-prompt" +title: "set_post_prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_post_prompt" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_post_prompt` + +## Signature + +```ruby +def set_post_prompt(prompt) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 450. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-prompt.mdx new file mode 100644 index 0000000000..93dcd7985d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-prompt" +title: "set_prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_prompt" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_prompt` + +## Signature + +```ruby +def set_prompt(prompt) +``` + +## Parameters + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 462. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-system-prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-system-prompt.mdx new file mode 100644 index 0000000000..b1a5dede0a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-system-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-system-prompt" +title: "set_system_prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_system_prompt" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_system_prompt` + +## Signature + +```ruby +def set_system_prompt(prompt) +``` + +## Parameters + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 455. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-user-prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-user-prompt.mdx new file mode 100644 index 0000000000..71b304679f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-user-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-user-prompt" +title: "set_user_prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_user_prompt" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_user_prompt` + +## Signature + +```ruby +def set_user_prompt(prompt) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 479. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-valid-contexts.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-valid-contexts.mdx new file mode 100644 index 0000000000..fb6717b483 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-valid-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-valid-contexts" +title: "set_valid_contexts" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_valid_contexts" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_valid_contexts` + +## Signature + +```ruby +def set_valid_contexts(contexts) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 440. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-valid-steps.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-valid-steps.mdx new file mode 100644 index 0000000000..3677cd3a3b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/set-valid-steps.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/set-valid-steps" +title: "set_valid_steps" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#set_valid_steps" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_valid_steps` + +## Signature + +```ruby +def set_valid_steps(steps) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 445. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/step-order.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/step-order.mdx new file mode 100644 index 0000000000..ff4764f597 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/step-order.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/step-order" +title: "_step_order" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#_step_order" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `_step_order` + +## Signature + +```ruby +def _step_order +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 600. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/context/to-h.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/to-h.mdx new file mode 100644 index 0000000000..0ac2c2e873 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/context/to-h.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/context/to-h" +title: "to_h" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Context#to_h" + parent: "SignalWire::Contexts::Context" + module: "SignalWire.Contexts.Context" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `to_h` + +## Signature + +```ruby +def to_h +``` + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 565. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/create-simple-context.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/create-simple-context.mdx new file mode 100644 index 0000000000..870a2ed7fa --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/create-simple-context.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/create-simple-context" +title: "create_simple_context" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts.create_simple_context" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `create_simple_context` + +Helper to create a standalone context (not via ContextBuilder). + +## Signature + +```ruby +def create_simple_context(name = 'default') +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 857. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/add-question.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/add-question.mdx new file mode 100644 index 0000000000..432e5e3088 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/add-question.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-info/add-question" +title: "add_question" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherInfo#add_question" + parent: "SignalWire::Contexts::GatherInfo" + module: "SignalWire.Contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_question` + +Add a question. Returns +self+ for chaining. + +## Signature + +```ruby +def add_question(key:, question:, **opts) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 63. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/completion-action.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/completion-action.mdx new file mode 100644 index 0000000000..f4108b142c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/completion-action.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-info/completion-action" +title: "completion_action" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherInfo#completion_action" + parent: "SignalWire::Contexts::GatherInfo" + module: "SignalWire.Contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `completion_action` + +Returns the value of attribute completion\_action. + +## Signature + +```ruby +attr_accessor completion_action <-> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 52. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/completion-action__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/completion-action__2.mdx new file mode 100644 index 0000000000..bde7640504 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/completion-action__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-info/completion-action__2" +title: "completion_action=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherInfo#completion_action=" + parent: "SignalWire::Contexts::GatherInfo" + module: "SignalWire.Contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `completion_action=` + +Sets the attribute completion\_action + +## Signature + +```ruby +attr_accessor completion_action= <-> Object +``` + +## Parameters + + + the value to set the attribute completion\_action to. + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 52. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/index.mdx new file mode 100644 index 0000000000..587f70bd14 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-info" +title: "GatherInfo" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherInfo" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `GatherInfo` + +Configuration for gathering information in a step via the C-side gather\_info system. + +## Signature + +```ruby +class GatherInfo < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Add a question. Returns +self+ for chaining. + + + + Returns the value of attribute completion\_action. + + + + Sets the attribute completion\_action + + + + + + Returns the value of attribute output\_key. + + + + Sets the attribute output\_key + + + + Returns the value of attribute prompt. + + + + Sets the attribute prompt + + + + Returns the value of attribute questions. + + + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 51. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/initialize.mdx new file mode 100644 index 0000000000..69ad355ec0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/initialize.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-info/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherInfo#initialize" + parent: "SignalWire::Contexts::GatherInfo" + module: "SignalWire.Contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(output_key: nil, completion_action: nil, prompt: nil) +``` + +## Parameters + + + + + + + +## Returns + +`GatherInfo` — a new instance of GatherInfo + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 55. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/output-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/output-key.mdx new file mode 100644 index 0000000000..9682d0e4ec --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/output-key.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-info/output-key" +title: "output_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherInfo#output_key" + parent: "SignalWire::Contexts::GatherInfo" + module: "SignalWire.Contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `output_key` + +Returns the value of attribute output\_key. + +## Signature + +```ruby +attr_accessor output_key <-> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 52. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/output-key__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/output-key__2.mdx new file mode 100644 index 0000000000..082f8dadaa --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/output-key__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-info/output-key__2" +title: "output_key=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherInfo#output_key=" + parent: "SignalWire::Contexts::GatherInfo" + module: "SignalWire.Contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `output_key=` + +Sets the attribute output\_key + +## Signature + +```ruby +attr_accessor output_key= <-> Object +``` + +## Parameters + + + the value to set the attribute output\_key to. + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 52. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/prompt.mdx new file mode 100644 index 0000000000..648d9b4ba8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/prompt.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-info/prompt" +title: "prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherInfo#prompt" + parent: "SignalWire::Contexts::GatherInfo" + module: "SignalWire.Contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `prompt` + +Returns the value of attribute prompt. + +## Signature + +```ruby +attr_accessor prompt <-> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 52. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/prompt__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/prompt__2.mdx new file mode 100644 index 0000000000..8755e8c3e8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/prompt__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-info/prompt__2" +title: "prompt=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherInfo#prompt=" + parent: "SignalWire::Contexts::GatherInfo" + module: "SignalWire.Contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `prompt=` + +Sets the attribute prompt + +## Signature + +```ruby +attr_accessor prompt= <-> Object +``` + +## Parameters + + + the value to set the attribute prompt to. + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 52. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/questions.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/questions.mdx new file mode 100644 index 0000000000..0479663429 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/questions.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-info/questions" +title: "questions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherInfo#questions" + parent: "SignalWire::Contexts::GatherInfo" + module: "SignalWire.Contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `questions` + +Returns the value of attribute questions. + +## Signature + +```ruby +attr_reader questions -> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 53. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/to-h.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/to-h.mdx new file mode 100644 index 0000000000..6cfb0df357 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-info/to-h.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-info/to-h" +title: "to_h" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherInfo#to_h" + parent: "SignalWire::Contexts::GatherInfo" + module: "SignalWire.Contexts.GatherInfo" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `to_h` + +## Signature + +```ruby +def to_h +``` + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 75. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/confirm.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/confirm.mdx new file mode 100644 index 0000000000..47312f9d36 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/confirm.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/confirm" +title: "confirm" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#confirm" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `confirm` + +Returns the value of attribute confirm. + +## Signature + +```ruby +attr_accessor confirm <-> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/confirm__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/confirm__2.mdx new file mode 100644 index 0000000000..5f4ee3cd16 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/confirm__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/confirm__2" +title: "confirm=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#confirm=" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `confirm=` + +Sets the attribute confirm + +## Signature + +```ruby +attr_accessor confirm= <-> Object +``` + +## Parameters + + + the value to set the attribute confirm to. + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/functions.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/functions.mdx new file mode 100644 index 0000000000..cd33fde99c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/functions.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/functions" +title: "functions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#functions" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `functions` + +Returns the value of attribute functions. + +## Signature + +```ruby +attr_accessor functions <-> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/functions__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/functions__2.mdx new file mode 100644 index 0000000000..92d95e8f7a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/functions__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/functions__2" +title: "functions=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#functions=" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `functions=` + +Sets the attribute functions + +## Signature + +```ruby +attr_accessor functions= <-> Object +``` + +## Parameters + + + the value to set the attribute functions to. + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/index.mdx new file mode 100644 index 0000000000..cfcb0e1d55 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/index.mdx @@ -0,0 +1,90 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question" +title: "GatherQuestion" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `GatherQuestion` + +Represents a single question in a gather\_info configuration. + +## Signature + +```ruby +class GatherQuestion < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute confirm. + + + + Sets the attribute confirm + + + + Returns the value of attribute functions. + + + + Sets the attribute functions + + + + + + Returns the value of attribute key. + + + + Sets the attribute key + + + + Returns the value of attribute prompt. + + + + Sets the attribute prompt + + + + Returns the value of attribute question. + + + + Sets the attribute question + + + + + + Returns the value of attribute type. + + + + Sets the attribute type + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 28. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/initialize.mdx new file mode 100644 index 0000000000..faba845e3e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/initialize.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#initialize" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(key:, question:, type: 'string', confirm: false, prompt: nil, functions: nil) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`GatherQuestion` — a new instance of GatherQuestion + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/key.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/key.mdx new file mode 100644 index 0000000000..9939bd9989 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/key.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/key" +title: "key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#key" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `key` + +Returns the value of attribute key. + +## Signature + +```ruby +attr_accessor key <-> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/key__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/key__2.mdx new file mode 100644 index 0000000000..7e8015a905 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/key__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/key__2" +title: "key=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#key=" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `key=` + +Sets the attribute key + +## Signature + +```ruby +attr_accessor key= <-> Object +``` + +## Parameters + + + the value to set the attribute key to. + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/prompt.mdx new file mode 100644 index 0000000000..7c6ff44c69 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/prompt.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/prompt" +title: "prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#prompt" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `prompt` + +Returns the value of attribute prompt. + +## Signature + +```ruby +attr_accessor prompt <-> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/prompt__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/prompt__2.mdx new file mode 100644 index 0000000000..1b8c50011e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/prompt__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/prompt__2" +title: "prompt=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#prompt=" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `prompt=` + +Sets the attribute prompt + +## Signature + +```ruby +attr_accessor prompt= <-> Object +``` + +## Parameters + + + the value to set the attribute prompt to. + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/question.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/question.mdx new file mode 100644 index 0000000000..27f3b68ce5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/question.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/question" +title: "question" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#question" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `question` + +Returns the value of attribute question. + +## Signature + +```ruby +attr_accessor question <-> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/question__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/question__2.mdx new file mode 100644 index 0000000000..832a23fcd1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/question__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/question__2" +title: "question=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#question=" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `question=` + +Sets the attribute question + +## Signature + +```ruby +attr_accessor question= <-> Object +``` + +## Parameters + + + the value to set the attribute question to. + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/to-h.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/to-h.mdx new file mode 100644 index 0000000000..db06f4d376 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/to-h.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/to-h" +title: "to_h" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#to_h" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `to_h` + +## Signature + +```ruby +def to_h +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 40. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/type.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/type.mdx new file mode 100644 index 0000000000..d339e332dc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/type.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/type" +title: "type" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#type" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `type` + +Returns the value of attribute type. + +## Signature + +```ruby +attr_accessor type <-> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/type__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/type__2.mdx new file mode 100644 index 0000000000..738ab484f6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/gather-question/type__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/gather-question/type__2" +title: "type=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::GatherQuestion#type=" + parent: "SignalWire::Contexts::GatherQuestion" + module: "SignalWire.Contexts.GatherQuestion" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `type=` + +Sets the attribute type + +## Signature + +```ruby +attr_accessor type= <-> Object +``` + +## Parameters + + + the value to set the attribute type to. + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/index.mdx new file mode 100644 index 0000000000..dd11778fa5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/index.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/ruby/signal-wire/contexts" +title: "Contexts" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Contexts" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `Contexts` + +## Signature + +```ruby +module Contexts +``` + +## Constants + + + + + + + Reserved tool names auto-injected by the runtime when contexts/steps are present. User-defined SWAIG tools must not collide with these names. ContextBuilder#validate! rejects any agent that registers a user tool sharing one of these names — the runtime would never call the user tool because the native one wins. + + +## Methods + + + + Helper to create a standalone context (not via ContextBuilder). + + + +## Classes + + + + Represents a single context containing multiple steps. + + + + Builder for multi-step, multi-context AI agent workflows. + + + + Configuration for gathering information in a step via the C-side gather\_info system. + + + + Represents a single question in a gather\_info configuration. + + + + Represents a single step within a context. + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 9. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/add-bullets.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/add-bullets.mdx new file mode 100644 index 0000000000..8dd4eb5ecc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/add-bullets.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/add-bullets" +title: "add_bullets" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#add_bullets" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_bullets` + +Add a POM section with bullet points. Mutually exclusive with +set\_text+. + +## Signature + +```ruby +def add_bullets(title, bullets) +``` + +## Parameters + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 131. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/add-gather-question.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/add-gather-question.mdx new file mode 100644 index 0000000000..f1ecafedcc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/add-gather-question.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/add-gather-question" +title: "add_gather_question" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#add_gather_question" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_gather_question` + +Add a question to this step's gather\_info configuration. ++set\_gather\_info+ must be called first. + +IMPORTANT — gather mode locks function access: +While the model is asking gather questions, the runtime +forcibly deactivates ALL of the step's other functions. The +only callable tools during a gather question are: + +``` +- +gather_submit+ (the native answer-submission tool) +- Whatever names you pass in this question's +functions:+ + option +``` + ++next\_step+ and +change\_context+ are also filtered out — the +model cannot navigate away until the gather completes. This +is by design: it forces a tight ask → submit → next-question +loop. + +If a question needs to call out to a tool (e.g. validate an +email, geocode a ZIP), pass that tool name in this question's ++functions:+ option. Functions listed here are active ONLY for +this question. +Python parity: `add_gather_question(key, question, type='string', +confirm=False, prompt=None, functions=None)`. Ruby exposes the +same parameter set as keyword args. + +## Signature + +```ruby +def add_gather_question(key:, question:, type: 'string', confirm: false, prompt: nil, functions: nil) +``` + +## Parameters + + + + + + + + + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 251. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/add-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/add-section.mdx new file mode 100644 index 0000000000..d475637a4a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/add-section" +title: "add_section" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#add_section" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `add_section` + +Add a POM section (title + body). Mutually exclusive with +set\_text+. + +## Signature + +```ruby +def add_section(title, body) +``` + +## Parameters + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 123. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/clear-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/clear-sections.mdx new file mode 100644 index 0000000000..8cf2b7718f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/clear-sections.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/clear-sections" +title: "clear_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#clear_sections" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `clear_sections` + +Remove all POM sections and direct text. + +## Signature + +```ruby +def clear_sections +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 267. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/index.mdx new file mode 100644 index 0000000000..762f26601b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/index.mdx @@ -0,0 +1,98 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step" +title: "Step" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step" + parent: "SignalWire::Contexts" + module: "SignalWire.Contexts" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `Step` + +Represents a single step within a context. + +All mutator methods return +self+ for fluent chaining. + +## Signature + +```ruby +class Step < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Add a POM section with bullet points. Mutually exclusive with +set\_text+. + + + + Add a question to this step's gather\_info configuration. +set\_gather\_info+ must be called first. + + + + Add a POM section (title + body). Mutually exclusive with +set\_text+. + + + + Remove all POM sections and direct text. + + + + + + Returns the value of attribute name. + + + + Mark this step as terminal for the step flow. + + + + Set which non-internal functions are callable while this step is active. + + + + Enable info gathering for this step. Returns +self+. After calling this, use +add\_gather\_question+ to define questions. + + + + + + + + + + + + + + + + + + Set the step's prompt text directly. Mutually exclusive with POM sections. + + + + + + + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 89. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/initialize.mdx new file mode 100644 index 0000000000..3f2d54cf2e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#initialize" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(name) +``` + +## Parameters + + + +## Returns + +`Step` — a new instance of Step + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 92. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/name.mdx new file mode 100644 index 0000000000..919ad242b6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#name" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `name` + +Returns the value of attribute name. + +## Signature + +```ruby +attr_reader name -> Object +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 90. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-end.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-end.mdx new file mode 100644 index 0000000000..a6e7689382 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-end.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-end" +title: "set_end" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_end" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_end` + +Mark this step as terminal for the step flow. + +IMPORTANT: +is\_end+ = true does NOT end the conversation or hang +up the call. It exits step mode entirely after this step +executes — clearing the steps list, current step index, +valid\_steps, and valid\_contexts. The agent keeps running, but +operates only under the base system prompt and the +context-level prompt; no more step instructions are injected +and no more +next\_step+ tool is offered. + +To actually end the call, call a hangup tool or define a +hangup hook. + +## Signature + +```ruby +def set_end(is_end) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 201. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-functions.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-functions.mdx new file mode 100644 index 0000000000..5616eb4118 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-functions.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-functions" +title: "set_functions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_functions" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_functions` + +Set which non-internal functions are callable while this step is +active. + +IMPORTANT — inheritance behavior: +If you do NOT call this method, the step inherits whichever +function set was active on the previous step (or the previous +context's last step). The server-side runtime only resets the +active set when a step explicitly declares its +functions+ +field. This is the most common source of bugs in multi-step +agents: forgetting +set\_functions+ on a later step lets the +previous step's tools leak through. Best practice is to call ++set\_functions+ explicitly on every step that should differ +from the previous one. + +Keep the per-step active set small: LLM tool selection accuracy +degrades noticeably past ~7-8 simultaneously-active tools per +call. Use per-step whitelisting to partition large tool +collections. + +Internal functions (e.g. +gather\_submit+, hangup hook) are +ALWAYS protected and cannot be deactivated by this whitelist. +The native navigation tools +next\_step+ and +change\_context+ are +injected automatically when +set\_valid\_steps+/+set\_valid\_contexts+ +is used; they are not affected by this list and do not need to +appear in it. + +## Signature + +```ruby +def set_functions(functions) +``` + +## Parameters + + + one of: + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 174. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-gather-info.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-gather-info.mdx new file mode 100644 index 0000000000..7cc6f6e611 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-gather-info.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-gather-info" +title: "set_gather_info" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_gather_info" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_gather_info` + +Enable info gathering for this step. Returns +self+. +After calling this, use +add\_gather\_question+ to define questions. + +## Signature + +```ruby +def set_gather_info(output_key: nil, completion_action: nil, prompt: nil) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 218. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-consolidate.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-consolidate.mdx new file mode 100644 index 0000000000..264fee5bfd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-consolidate.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-reset-consolidate" +title: "set_reset_consolidate" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_reset_consolidate" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_reset_consolidate` + +## Signature + +```ruby +def set_reset_consolidate(val) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 283. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-full-reset.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-full-reset.mdx new file mode 100644 index 0000000000..1dc3e864d0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-full-reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-reset-full-reset" +title: "set_reset_full_reset" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_reset_full_reset" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_reset_full_reset` + +## Signature + +```ruby +def set_reset_full_reset(val) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 288. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-system-prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-system-prompt.mdx new file mode 100644 index 0000000000..c4f2292340 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-system-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-reset-system-prompt" +title: "set_reset_system_prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_reset_system_prompt" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_reset_system_prompt` + +## Signature + +```ruby +def set_reset_system_prompt(prompt) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 273. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-user-prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-user-prompt.mdx new file mode 100644 index 0000000000..ffa9dcf281 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-reset-user-prompt.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-reset-user-prompt" +title: "set_reset_user_prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_reset_user_prompt" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_reset_user_prompt` + +## Signature + +```ruby +def set_reset_user_prompt(prompt) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 278. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-skip-to-next-step.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-skip-to-next-step.mdx new file mode 100644 index 0000000000..e9aa8ae8a9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-skip-to-next-step.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-skip-to-next-step" +title: "set_skip_to_next_step" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_skip_to_next_step" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_skip_to_next_step` + +## Signature + +```ruby +def set_skip_to_next_step(skip) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 211. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-skip-user-turn.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-skip-user-turn.mdx new file mode 100644 index 0000000000..6609eb980c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-skip-user-turn.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-skip-user-turn" +title: "set_skip_user_turn" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_skip_user_turn" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_skip_user_turn` + +## Signature + +```ruby +def set_skip_user_turn(skip) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-step-criteria.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-step-criteria.mdx new file mode 100644 index 0000000000..e1983ae69c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-step-criteria.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-step-criteria" +title: "set_step_criteria" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_step_criteria" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_step_criteria` + +## Signature + +```ruby +def set_step_criteria(criteria) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 138. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-text.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-text.mdx new file mode 100644 index 0000000000..fe76e5e7a6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-text.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-text" +title: "set_text" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_text" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_text` + +Set the step's prompt text directly. Mutually exclusive with POM sections. + +## Signature + +```ruby +def set_text(text) +``` + +## Parameters + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 115. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-valid-contexts.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-valid-contexts.mdx new file mode 100644 index 0000000000..ef4d2e55f7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-valid-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-valid-contexts" +title: "set_valid_contexts" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_valid_contexts" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_valid_contexts` + +## Signature + +```ruby +def set_valid_contexts(contexts) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 184. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-valid-steps.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-valid-steps.mdx new file mode 100644 index 0000000000..b3c42e84f8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/set-valid-steps.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/set-valid-steps" +title: "set_valid_steps" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#set_valid_steps" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `set_valid_steps` + +## Signature + +```ruby +def set_valid_steps(steps) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 179. diff --git a/fern/products/sdk-reference/ruby/signal-wire/contexts/step/to-h.mdx b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/to-h.mdx new file mode 100644 index 0000000000..7356a62e38 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/contexts/step/to-h.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/contexts/step/to-h" +title: "to_h" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Contexts::Step#to_h" + parent: "SignalWire::Contexts::Step" + module: "SignalWire.Contexts.Step" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb" + visibility: "public" +--- +# `to_h` + +## Signature + +```ruby +def to_h +``` + +## Source + +[`lib/signalwire/contexts/context_builder.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/contexts/context_builder.rb) + +Line 293. diff --git a/fern/products/sdk-reference/ruby/signal-wire/core/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/core/index.mdx new file mode 100644 index 0000000000..3b19b5db47 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/core/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/core" +title: "Core" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Core" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/core/logging_config.rb" + visibility: "public" +--- +# `Core` + +## Signature + +```ruby +module Core +``` + +## Modules + + + + + +## Source + +[`lib/signalwire/core/logging_config.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/core/logging_config.rb) + +Line 19. diff --git a/fern/products/sdk-reference/ruby/signal-wire/core/logging-config/get-execution-mode.mdx b/fern/products/sdk-reference/ruby/signal-wire/core/logging-config/get-execution-mode.mdx new file mode 100644 index 0000000000..ffca1e21cf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/core/logging-config/get-execution-mode.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/core/logging-config/get-execution-mode" +title: "get_execution_mode" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Core::LoggingConfig.get_execution_mode" + parent: "SignalWire::Core::LoggingConfig" + module: "SignalWire.Core.LoggingConfig" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/core/logging_config.rb" + visibility: "public" +--- +# `get_execution_mode` + +Detect the SDK's deployment environment based on well-known +environment variables. + +## Signature + +```ruby +def get_execution_mode +``` + +## Returns + +`String` — one of 'cgi', 'lambda', 'google\_cloud\_function', 'azure\_function', or 'server'. + +## Source + +[`lib/signalwire/core/logging_config.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/core/logging_config.rb) + +Line 28. diff --git a/fern/products/sdk-reference/ruby/signal-wire/core/logging-config/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/core/logging-config/index.mdx new file mode 100644 index 0000000000..d04265ce17 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/core/logging-config/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/core/logging-config" +title: "LoggingConfig" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Core::LoggingConfig" + parent: "SignalWire::Core" + module: "SignalWire.Core" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/core/logging_config.rb" + visibility: "public" +--- +# `LoggingConfig` + +## Signature + +```ruby +module LoggingConfig +``` + +## Methods + + + + Detect the SDK's deployment environment based on well-known environment variables. + + + +## Source + +[`lib/signalwire/core/logging_config.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/core/logging_config.rb) + +Line 20. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/body.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/body.mdx new file mode 100644 index 0000000000..ab86560619 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/body.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/body" +title: "body" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#body" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `body` + +Set the request body for the most-recently-added webhook (POST / PUT). + +## Signature + +```ruby +def body(data) +``` + +## Parameters + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 156. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/create-expression-tool.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/create-expression-tool.mdx new file mode 100644 index 0000000000..ba18a64c98 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/create-expression-tool.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/create-expression-tool" +title: "create_expression_tool" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap.create_expression_tool" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `create_expression_tool` + +Build an expression-only tool (no HTTP calls). + +## Signature + +```ruby +def create_expression_tool(name:, patterns:, parameters: nil) +``` + +## Parameters + + + + + + + +## Returns + +`DataMap` + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 294. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/create-simple-api-tool.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/create-simple-api-tool.mdx new file mode 100644 index 0000000000..f125bb185c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/create-simple-api-tool.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/create-simple-api-tool" +title: "create_simple_api_tool" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap.create_simple_api_tool" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `create_simple_api_tool` + +Build a simple API-calling tool in one shot. + +## Signature + +```ruby +def create_simple_api_tool(name:, url:, response_template:, parameters: nil, method: 'GET', headers: nil, body: nil, error_keys: nil) +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`DataMap` + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 266. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/description.mdx new file mode 100644 index 0000000000..cfaa6477af --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/description.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#description" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `description` + +Alias for +purpose+. Sets the LLM-facing tool description. This +string is read by the model to decide WHEN to call this tool. +See +purpose+ for bad-vs-good examples. + +## Signature + +```ruby +def description(desc) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 64. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/error-keys.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/error-keys.mdx new file mode 100644 index 0000000000..7e25ec465b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/error-keys.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/error-keys" +title: "error_keys" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#error_keys" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `error_keys` + +Set error keys on the most-recently-added webhook, or at the top level +if no webhook has been added yet. + +## Signature + +```ruby +def error_keys(keys) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/expression.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/expression.mdx new file mode 100644 index 0000000000..6ed8060be9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/expression.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/expression" +title: "expression" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#expression" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `expression` + +Add an expression (pattern-matching rule). + +## Signature + +```ruby +def expression(test_value, pattern, output, nomatch_output: nil) +``` + +## Parameters + + + template string to test, e.g. "$\{args.command\}" + + + + regex pattern to match against + + + + result when pattern matches + + + + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 107. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/fallback-output.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/fallback-output.mdx new file mode 100644 index 0000000000..753e47d42c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/fallback-output.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/fallback-output" +title: "fallback_output" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#fallback_output" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `fallback_output` + +Set a fallback output used when all webhooks fail. + +## Signature + +```ruby +def fallback_output(result) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 199. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/foreach.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/foreach.mdx new file mode 100644 index 0000000000..addfcf717f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/foreach.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/foreach" +title: "foreach" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#foreach" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `foreach` + +Configure array processing on the most-recently-added webhook response. + +## Signature + +```ruby +def foreach(config) +``` + +## Parameters + + + must include keys: input\_key, output\_key, append. Optional: max. + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 174. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/function-name.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/function-name.mdx new file mode 100644 index 0000000000..13e0730cd1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/function-name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/function-name" +title: "function_name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#function_name" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `function_name` + +Returns the value of attribute function\_name. + +## Signature + +```ruby +attr_reader function_name -> Object +``` + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 26. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/global-error-keys.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/global-error-keys.mdx new file mode 100644 index 0000000000..d8959785a0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/global-error-keys.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/global-error-keys" +title: "global_error_keys" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#global_error_keys" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `global_error_keys` + +Set top-level error keys (applies to all webhooks). + +## Signature + +```ruby +def global_error_keys(keys) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 216. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/index.mdx new file mode 100644 index 0000000000..f1af13d169 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/index.mdx @@ -0,0 +1,120 @@ +--- +slug: "/reference/ruby/signal-wire/data-map" +title: "DataMap" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::DataMap" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `DataMap` + +Fluent builder for server-side DataMap tools. + +DataMap tools execute on SignalWire servers without requiring webhook +endpoints. This class provides a chainable API for building data\_map +configurations that become SWAIG function definitions. + +All mutator methods return +self+ so calls can be chained: + +dm = DataMap.new('get\_weather') +.purpose('Get current weather') +.parameter('location', 'string', 'City name', required: true) +.webhook('GET', 'https://api.weather.com/v1/current?q=$\{location\}') +.output(Swaig::FunctionResult.new('Weather: $\{response.current.temp\_f\}F')) + +## Signature + +```ruby +class DataMap < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Set the request body for the most-recently-added webhook (POST / PUT). + + + + Build an expression-only tool (no HTTP calls). + + + + Build a simple API-calling tool in one shot. + + + + Alias for +purpose+. Sets the LLM-facing tool description. This string is read by the model to decide WHEN to call this tool. See +purpose+ for bad-vs-good examples. + + + + Set error keys on the most-recently-added webhook, or at the top level if no webhook has been added yet. + + + + Add an expression (pattern-matching rule). + + + + Set a fallback output used when all webhooks fail. + + + + Configure array processing on the most-recently-added webhook response. + + + + Returns the value of attribute function\_name. + + + + Set top-level error keys (applies to all webhooks). + + + + + + Set the output result for the most-recently-added webhook. + + + + Add a typed parameter to the function signature — the +desc+ is LLM-FACING. + + + + Set request params for the most-recently-added webhook. + + + + Set the LLM-facing tool description (a.k.a. "purpose"). _PROMPT ENGINEERING_, not developer documentation. + + + + Serialize this DataMap into a complete SWAIG function definition Hash. + + + + Add a webhook (HTTP call) to the data\_map pipeline. + + + + Add expressions to run after the most-recently-added webhook completes. + + + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/initialize.mdx new file mode 100644 index 0000000000..2b88c595df --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#initialize" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(function_name) +``` + +## Parameters + + + +## Returns + +`DataMap` — a new instance of DataMap + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 28. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/output.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/output.mdx new file mode 100644 index 0000000000..685edba06e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/output.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/output" +title: "output" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#output" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `output` + +Set the output result for the most-recently-added webhook. + +## Signature + +```ruby +def output(result) +``` + +## Parameters + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 189. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/parameter.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/parameter.mdx new file mode 100644 index 0000000000..0afc1f54dc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/parameter.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/parameter" +title: "parameter" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#parameter" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `parameter` + +Add a typed parameter to the function signature — the +desc+ is +LLM-FACING. + +Each parameter description is rendered into the OpenAI tool +schema under +parameters.properties.<name>.description+ and sent +to the model. The model uses it to decide HOW to fill in the +argument from user speech. It is prompt engineering, not +developer FYI. + +\== Bad vs good + +BAD : .parameter("city", "string", "the city") +GOOD: .parameter("city", "string", +"The name of the city to get weather for, e.g. " \ +"'San Francisco'. Ask the user if they did not " \ +"provide one. Include the state or country if the " \ +"city name is ambiguous.") + +## Signature + +```ruby +def parameter(name, type, desc, required: false, enum: nil) +``` + +## Parameters + + + + + JSON-Schema type (string, number, boolean, array, object) + + + + LLM-facing prompt-engineering description telling the model how to extract this value from the user's utterance + + + + + + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 93. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/params.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/params.mdx new file mode 100644 index 0000000000..29bbddf6c7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/params.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/params" +title: "params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#params" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `params` + +Set request params for the most-recently-added webhook. + +## Signature + +```ruby +def params(data) +``` + +## Parameters + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 164. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/purpose.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/purpose.mdx new file mode 100644 index 0000000000..1e0930ad5c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/purpose.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/purpose" +title: "purpose" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#purpose" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `purpose` + +Set the LLM-facing tool description (a.k.a. "purpose"). _PROMPT +ENGINEERING_, not developer documentation. + +The description string is rendered into the OpenAI tool schema ++description+ field on every LLM turn. The model reads it to +decide WHEN to call this tool. A vague +purpose+ is the #1 cause +of "the model has the right tool but doesn't call it" failures +with data-map tools. + +\== Bad vs good + +BAD : .purpose("weather api") +GOOD: .purpose("Get the current weather conditions and " \ +"forecast for a specific city. Use this " \ +"whenever the user asks about weather, " \ +"temperature, rain, or similar conditions in a " \ +"named location.") + +## Signature + +```ruby +def purpose(desc) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 56. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/to-swaig-function.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/to-swaig-function.mdx new file mode 100644 index 0000000000..71d286f019 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/to-swaig-function.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/to-swaig-function" +title: "to_swaig_function" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#to_swaig_function" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `to_swaig_function` + +Serialize this DataMap into a complete SWAIG function definition Hash. + +## Signature + +```ruby +def to_swaig_function +``` + +## Returns + +`Hash` — with keys: "function", "description", "parameters", "data\_map" + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 224. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/webhook-expressions.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/webhook-expressions.mdx new file mode 100644 index 0000000000..ee567f1b57 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/webhook-expressions.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/webhook-expressions" +title: "webhook_expressions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#webhook_expressions" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `webhook_expressions` + +Add expressions to run after the most-recently-added webhook completes. + +## Signature + +```ruby +def webhook_expressions(expressions) +``` + +## Parameters + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 148. diff --git a/fern/products/sdk-reference/ruby/signal-wire/data-map/webhook.mdx b/fern/products/sdk-reference/ruby/signal-wire/data-map/webhook.mdx new file mode 100644 index 0000000000..293aa53024 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/data-map/webhook.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/data-map/webhook" +title: "webhook" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::DataMap#webhook" + parent: "SignalWire::DataMap" + module: "SignalWire.DataMap" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb" + visibility: "public" +--- +# `webhook` + +Add a webhook (HTTP call) to the data\_map pipeline. + +## Signature + +```ruby +def webhook(method, url, headers: nil, form_param: nil, input_args_as_params: false, require_args: nil) +``` + +## Parameters + + + HTTP method (GET, POST, PUT, DELETE, etc.) + + + + endpoint URL (may contain $\{variable\} substitutions) + + + + + + + + + + +## Source + +[`lib/signalwire/datamap/data_map.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/datamap/data_map.rb) + +Line 134. diff --git a/fern/products/sdk-reference/ruby/signal-wire/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/index.mdx new file mode 100644 index 0000000000..235726c83a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/index.mdx @@ -0,0 +1,105 @@ +--- +slug: "/reference/ruby/signal-wire" +title: "SignalWire" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb" + visibility: "public" +--- +# `SignalWire` + +Copyright (c) 2025 SignalWire + +Licensed under the MIT License. +See LICENSE file in the project root for full license information. + +## Signature + +```ruby +module SignalWire +``` + +## Constants + + + +## Methods + + + + Add a directory to search for skills. + + + + Get complete schema for all available skills, including parameter metadata. + + + + Register a custom skill class with the global skill registry. + + + + Construct a \{SignalWire::REST::RestClient\} instance. + + + +## Classes + + + + Central agent class that composes SWML rendering, tool dispatch, prompt management, AI config, and HTTP serving. + + + + Multi-agent hosting on a single Rack application. + + + + Fluent builder for server-side DataMap tools. + + + +## Modules + + + + + + + + + + + + + + + + + + Runtime environment detection. + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/runtime.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/list-skills-with-params.mdx b/fern/products/sdk-reference/ruby/signal-wire/list-skills-with-params.mdx new file mode 100644 index 0000000000..b54fe3d1ba --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/list-skills-with-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/list-skills-with-params" +title: "list_skills_with_params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire.list_skills_with_params" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire.rb" + visibility: "public" +--- +# `list_skills_with_params` + +Get complete schema for all available skills, including parameter metadata. + +Mirrors Python's `signalwire.list_skills_with_params()`. Keys are +skill names; values describe metadata + parameter schema. Useful for +GUI configuration tools, API documentation, or programmatic skill +discovery. + +## Signature + +```ruby +def list_skills_with_params +``` + +## Returns + +`Hash{String => Hash}` + +## Source + +[`lib/signalwire.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire.rb) + +Line 96. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/global-level.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/global-level.mdx new file mode 100644 index 0000000000..4635f669fc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/global-level.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/logging/global-level" +title: "global_level" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Logging.global_level" + parent: "SignalWire::Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `global_level` + +Returns the current global log level, derived from: + +1. SIGNALWIRE\_LOG\_MODE=off -> :off (suppresses everything) +2. SIGNALWIRE\_LOG\_LEVEL env -> the named level +3. Default -> :info + +## Signature + +```ruby +def global_level +``` + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/global-level__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/global-level__2.mdx new file mode 100644 index 0000000000..20fcc5d847 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/global-level__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/logging/global-level__2" +title: "global_level=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Logging.global_level=" + parent: "SignalWire::Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `global_level=` + +## Signature + +```ruby +def global_level=(level) +``` + +## Parameters + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/index.mdx new file mode 100644 index 0000000000..a216db1457 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/ruby/signal-wire/logging" +title: "Logging" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Logging" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `Logging` + +## Signature + +```ruby +module Logging +``` + +## Constants + + + +## Methods + + + + Returns the current global log level, derived from: 1. SIGNALWIRE\_LOG\_MODE=off -> :off (suppresses everything) 2. SIGNALWIRE\_LOG\_LEVEL env -> the named level 3. Default -> :info + + + + + + Convenience factory + + + + + + + +## Classes + + + + \------------------------------------------------------------------- + + + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 4. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/logger.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/logger.mdx new file mode 100644 index 0000000000..d2509d6a8f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/logger.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/logging/logger" +title: "logger" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Logging.logger" + parent: "SignalWire::Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `logger` + +Convenience factory + +## Signature + +```ruby +def logger(name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/logger/debug.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/debug.mdx new file mode 100644 index 0000000000..702f3bc880 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/debug.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/logging/logger/debug" +title: "debug" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Logging::Logger#debug" + parent: "SignalWire::Logging::Logger" + module: "SignalWire.Logging.Logger" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `debug` + +## Signature + +```ruby +def debug(msg) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 44. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/logger/error.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/error.mdx new file mode 100644 index 0000000000..9d49b04119 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/error.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/logging/logger/error" +title: "error" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Logging::Logger#error" + parent: "SignalWire::Logging::Logger" + module: "SignalWire.Logging.Logger" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `error` + +## Signature + +```ruby +def error(msg) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 56. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/logger/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/index.mdx new file mode 100644 index 0000000000..a77b891f54 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/logging/logger" +title: "Logger" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Logging::Logger" + parent: "SignalWire::Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `Logger` + +*** + +## Signature + +```ruby +class Logger < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + + + + + + + + + Returns the value of attribute name. + + + + + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 36. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/logger/info.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/info.mdx new file mode 100644 index 0000000000..52ff552ee7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/info.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/logging/logger/info" +title: "info" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Logging::Logger#info" + parent: "SignalWire::Logging::Logger" + module: "SignalWire.Logging.Logger" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `info` + +## Signature + +```ruby +def info(msg) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 48. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/logger/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/initialize.mdx new file mode 100644 index 0000000000..e0e7fdc859 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/logging/logger/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Logging::Logger#initialize" + parent: "SignalWire::Logging::Logger" + module: "SignalWire.Logging.Logger" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(name) +``` + +## Parameters + + + +## Returns + +`Logger` — a new instance of Logger + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 39. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/logger/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/name.mdx new file mode 100644 index 0000000000..d872af2153 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/logging/logger/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Logging::Logger#name" + parent: "SignalWire::Logging::Logger" + module: "SignalWire.Logging.Logger" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `name` + +Returns the value of attribute name. + +## Signature + +```ruby +attr_reader name -> Object +``` + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 37. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/logger/warn.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/warn.mdx new file mode 100644 index 0000000000..a992ce5457 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/logger/warn.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/logging/logger/warn" +title: "warn" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Logging::Logger#warn" + parent: "SignalWire::Logging::Logger" + module: "SignalWire.Logging.Logger" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `warn` + +## Signature + +```ruby +def warn(msg) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 52. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/reset.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/reset.mdx new file mode 100644 index 0000000000..5731176cc4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/reset.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/logging/reset" +title: "reset!" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Logging.reset!" + parent: "SignalWire::Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `reset!` + +## Signature + +```ruby +def reset! +``` + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/logging/suppressed.mdx b/fern/products/sdk-reference/ruby/signal-wire/logging/suppressed.mdx new file mode 100644 index 0000000000..bd0311b2cb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/logging/suppressed.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/logging/suppressed" +title: "suppressed?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Logging.suppressed?" + parent: "SignalWire::Logging" + module: "SignalWire.Logging" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb" + visibility: "public" +--- +# `suppressed?` + +## Signature + +```ruby +def suppressed? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/logging.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/logging.rb) + +Line 26. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/index.mdx new file mode 100644 index 0000000000..a7c867618a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/pom" +title: "POM" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::POM" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `POM` + +## Signature + +```ruby +module POM +``` + +## Classes + + + + A structured data format for composing, organising, and rendering prompt instructions for large language models. + + + + Represents a section in the Prompt Object Model. + + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 4. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/add-pom-as-subsection.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/add-pom-as-subsection.mdx new file mode 100644 index 0000000000..6a43835ee4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/add-pom-as-subsection.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/add-pom-as-subsection" +title: "add_pom_as_subsection" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#add_pom_as_subsection" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `add_pom_as_subsection` + +Add another PromptObjectModel as a subsection of an existing +section identified either by title or by Section reference. + +Mirrors Python's +`PromptObjectModel.add_pom_as_subsection(target, pom_to_add)`. + +## Signature + +```ruby +def add_pom_as_subsection(target, pom_to_add) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 252. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/add-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/add-section.mdx new file mode 100644 index 0000000000..51029d3b67 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/add-section.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/add-section" +title: "add_section" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#add_section" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `add_section` + +Add a top-level section to the model and return the new Section. + +Mirrors Python's `PromptObjectModel.add_section`. If +bullets+ +is a String it is wrapped into a single-element Array (Python +parity). Raises ArgumentError when +title+ is nil and the model +already has at least one section (only the first section may +be untitled). + +## Signature + +```ruby +def add_section(title = nil, body: '', bullets: nil, numbered: nil, numbered_bullets: false) +``` + +## Parameters + + + + + + + + + + + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 126. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/build-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/build-section.mdx new file mode 100644 index 0000000000..a6d1595127 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/build-section.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/build-section" +title: "_build_section" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel._build_section" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `_build_section` + +Internal: build a Section (recursively) from a Hash section +descriptor. Mirrors Python's `build_section` inner helper. + +## Signature + +```ruby +def _build_section(hash, is_subsection: false) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 71. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/debug.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/debug.mdx new file mode 100644 index 0000000000..7e03b97270 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/debug.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/debug" +title: "debug" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#debug" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `debug` + +Returns the value of attribute debug. + +## Signature + +```ruby +attr_accessor debug <-> Object +``` + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/debug__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/debug__2.mdx new file mode 100644 index 0000000000..ba19db247d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/debug__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/debug__2" +title: "debug=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#debug=" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `debug=` + +Sets the attribute debug + +## Signature + +```ruby +attr_accessor debug= <-> Object +``` + +## Parameters + + + the value to set the attribute debug to. + + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/find-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/find-section.mdx new file mode 100644 index 0000000000..bd83b83c2a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/find-section.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/find-section" +title: "find_section" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#find_section" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `find_section` + +Find a section by title, recursing into subsections. Returns ++nil+ when the title is not present anywhere in the tree. + +## Signature + +```ruby +def find_section(title) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 141. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/from-array.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/from-array.mdx new file mode 100644 index 0000000000..c846ae2872 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/from-array.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/from-array" +title: "_from_array" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel._from_array" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `_from_array` + +Internal: build a PromptObjectModel from a raw Array of Hash +section descriptors. Mirrors Python's `_from_dict` (which +confusingly takes a list, not a dict). + +## Signature + +```ruby +def _from_array(data) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 53. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/from-json.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/from-json.mdx new file mode 100644 index 0000000000..d65a25eb5e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/from-json.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/from-json" +title: "from_json" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel.from_json" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `from_json` + +Build a PromptObjectModel from JSON. + ++json\_data+ may be either a JSON string or an already-parsed +Array. Mirrors Python's +`PromptObjectModel.from_json(json_data: Union[str, dict])`. + +## Signature + +```ruby +def from_json(json_data) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 35. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/from-yaml.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/from-yaml.mdx new file mode 100644 index 0000000000..afa9bc934c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/from-yaml.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/from-yaml" +title: "from_yaml" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel.from_yaml" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `from_yaml` + +Build a PromptObjectModel from YAML. + ++yaml\_data+ may be either a YAML string or an already-parsed +Array. Mirrors Python's +`PromptObjectModel.from_yaml(yaml_data: Union[str, dict])`. + +## Signature + +```ruby +def from_yaml(yaml_data) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 45. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/index.mdx new file mode 100644 index 0000000000..3ed32ed65f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/index.mdx @@ -0,0 +1,115 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model" +title: "PromptObjectModel" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel" + parent: "SignalWire::POM" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `PromptObjectModel` + +A structured data format for composing, organising, and rendering +prompt instructions for large language models. + +The Prompt Object Model provides a tree-based representation of a +prompt document composed of nested Section objects, each of which +can include a title, body text, bullet points, and arbitrarily +nested subsections. + +Mirrors Python's `signalwire.pom.pom.PromptObjectModel`. The +rendered output (Markdown / XML / JSON / YAML) is byte-for-byte +identical to the Python reference so cross-language POM documents +interoperate. + +## Signature + +```ruby +class PromptObjectModel < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Internal: build a Section (recursively) from a Hash section descriptor. Mirrors Python's `build_section` inner helper. + + + + Internal: build a PromptObjectModel from a raw Array of Hash section descriptors. Mirrors Python's `_from_dict` (which confusingly takes a list, not a dict). + + + + Add another PromptObjectModel as a subsection of an existing section identified either by title or by Section reference. + + + + Add a top-level section to the model and return the new Section. + + + + Returns the value of attribute debug. + + + + Sets the attribute debug + + + + Find a section by title, recursing into subsections. Returns +nil+ when the title is not present anywhere in the tree. + + + + Build a PromptObjectModel from JSON. + + + + Build a PromptObjectModel from YAML. + + + + + + Render the entire model as Markdown. Output is byte-for-byte identical to Python's `PromptObjectModel.render_markdown`. + + + + Render the entire model as XML. Output is byte-for-byte identical to Python's `PromptObjectModel.render_xml`. + + + + Returns the value of attribute sections. + + + + Sets the attribute sections + + + + Convert the model to an Array of Hash section descriptors. Mirrors Python's `PromptObjectModel.to_dict` (Ruby idiom uses `to_h`). + + + + Convert the model to a JSON string. Output matches Python's `json.dumps(..., indent=2)` byte-for-byte, with one special case: an empty model serializes to `"[]"` (Ruby's default `JSON.pretty_generate([])` emits `"[\n\n]"`). + + + + Convert the model to a YAML string. Output matches Python's `yaml.dump(..., default_flow_style=False, sort_keys=False)` byte-for-byte. Ruby's `YAML.dump` prepends `---\n`; we strip it. The empty-list case (Ruby emits `--- []\n`) is normalised to Python's `[]\n`. + + + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/initialize.mdx new file mode 100644 index 0000000000..27b115fb04 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#initialize" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(debug: false) +``` + +## Parameters + + + +## Returns + +`PromptObjectModel` — a new instance of PromptObjectModel + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/render-markdown.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/render-markdown.mdx new file mode 100644 index 0000000000..424c460d66 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/render-markdown.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/render-markdown" +title: "render_markdown" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#render_markdown" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `render_markdown` + +Render the entire model as Markdown. Output is byte-for-byte +identical to Python's `PromptObjectModel.render_markdown`. + +## Signature + +```ruby +def render_markdown +``` + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 185. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/render-xml.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/render-xml.mdx new file mode 100644 index 0000000000..133f657b1c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/render-xml.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/render-xml" +title: "render_xml" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#render_xml" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `render_xml` + +Render the entire model as XML. Output is byte-for-byte identical +to Python's `PromptObjectModel.render_xml`. + +## Signature + +```ruby +def render_xml +``` + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 222. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/sections.mdx new file mode 100644 index 0000000000..ec8bada11a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/sections.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/sections" +title: "sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#sections" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `sections` + +Returns the value of attribute sections. + +## Signature + +```ruby +attr_accessor sections <-> Object +``` + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/sections__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/sections__2.mdx new file mode 100644 index 0000000000..7a0b3b296a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/sections__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/sections__2" +title: "sections=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#sections=" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `sections=` + +Sets the attribute sections + +## Signature + +```ruby +attr_accessor sections= <-> Object +``` + +## Parameters + + + the value to set the attribute sections to. + + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/to-h.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/to-h.mdx new file mode 100644 index 0000000000..71f9193bec --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/to-h.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/to-h" +title: "to_h" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#to_h" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `to_h` + +Convert the model to an Array of Hash section descriptors. +Mirrors Python's `PromptObjectModel.to_dict` (Ruby idiom uses +`to_h`). + +## Signature + +```ruby +def to_h +``` + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 179. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/to-json.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/to-json.mdx new file mode 100644 index 0000000000..a13dadcc4d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/to-json.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/to-json" +title: "to_json" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#to_json" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `to_json` + +Convert the model to a JSON string. Output matches Python's +`json.dumps(..., indent=2)` byte-for-byte, with one +special case: an empty model serializes to `"[]"` (Ruby's +default `JSON.pretty_generate([])` emits `"[\n\n]"`). + +## Signature + +```ruby +def to_json(*_args) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 158. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/to-yaml.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/to-yaml.mdx new file mode 100644 index 0000000000..03858974cb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/prompt-object-model/to-yaml.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/pom/prompt-object-model/to-yaml" +title: "to_yaml" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::PromptObjectModel#to_yaml" + parent: "SignalWire::POM::PromptObjectModel" + module: "SignalWire.POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb" + visibility: "public" +--- +# `to_yaml` + +Convert the model to a YAML string. Output matches Python's +`yaml.dump(..., default_flow_style=False, sort_keys=False)` +byte-for-byte. Ruby's `YAML.dump` prepends `---\n`; we strip +it. The empty-list case (Ruby emits `--- []\n`) is normalised +to Python's `[]\n`. + +## Signature + +```ruby +def to_yaml +``` + +## Source + +[`lib/signalwire/pom/prompt_object_model.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/prompt_object_model.rb) + +Line 169. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/add-body.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/add-body.mdx new file mode 100644 index 0000000000..32df75eec4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/add-body.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/add-body" +title: "add_body" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#add_body" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `add_body` + +Add or replace the body text for this section. Mirrors Python's +`Section.add_body` (which is documented to "Add or replace"). + +## Signature + +```ruby +def add_body(body) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 55. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/add-bullets.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/add-bullets.mdx new file mode 100644 index 0000000000..148e6db14c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/add-bullets.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/add-bullets" +title: "add_bullets" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#add_bullets" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `add_bullets` + +Append bullet points to this section. Does not replace existing +bullets — mirrors Python's `self.bullets.extend(bullets)`. + +## Signature + +```ruby +def add_bullets(bullets) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 65. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/add-subsection.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/add-subsection.mdx new file mode 100644 index 0000000000..cad08d2d30 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/add-subsection.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/add-subsection" +title: "add_subsection" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#add_subsection" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `add_subsection` + +Add a subsection to this section, returning the new Section. + +Raises ArgumentError when +title+ is nil (Python raises +`ValueError("Subsections must have a title")`; Ruby idiom +is ArgumentError for invalid arguments). + +## Signature + +```ruby +def add_subsection(title, body: '', bullets: nil, numbered: false, numbered_bullets: false) +``` + +## Parameters + + + + + + + + + + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 78. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/body.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/body.mdx new file mode 100644 index 0000000000..a1abc7f03a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/body.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/body" +title: "body" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#body" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `body` + +Returns the value of attribute body. + +## Signature + +```ruby +attr_accessor body <-> Object +``` + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/body__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/body__2.mdx new file mode 100644 index 0000000000..91ab5b2192 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/body__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/body__2" +title: "body=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#body=" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `body=` + +Sets the attribute body + +## Signature + +```ruby +attr_accessor body= <-> Object +``` + +## Parameters + + + the value to set the attribute body to. + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/bullets.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/bullets.mdx new file mode 100644 index 0000000000..60e3382a13 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/bullets.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/bullets" +title: "bullets" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#bullets" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `bullets` + +Returns the value of attribute bullets. + +## Signature + +```ruby +attr_accessor bullets <-> Object +``` + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/bullets__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/bullets__2.mdx new file mode 100644 index 0000000000..0bfbe64fd7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/bullets__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/bullets__2" +title: "bullets=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#bullets=" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `bullets=` + +Sets the attribute bullets + +## Signature + +```ruby +attr_accessor bullets= <-> Object +``` + +## Parameters + + + the value to set the attribute bullets to. + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/index.mdx new file mode 100644 index 0000000000..e978275d7f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/index.mdx @@ -0,0 +1,133 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section" +title: "Section" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::POM::Section" + parent: "SignalWire::POM" + module: "SignalWire.POM" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `Section` + +Represents a section in the Prompt Object Model. + +Each section contains a title, optional body text, optional bullet +points, and can have any number of nested subsections. + +Mirrors Python's `signalwire.pom.pom.Section` exactly. See +`signalwire-python/signalwire/signalwire/pom/pom.py` for the +source-of-truth specification; rendering output (markdown / XML / +JSON / YAML) must match Python byte-for-byte so cross-language POM +documents are interoperable. + +Attributes: + +- +title+ — the name of the section. +- +body+ — a paragraph of text associated with the section. +- +bullets+ — bullet-pointed items (Array<String>). +- +subsections+ — nested Section objects. +- +numbered+ — whether this section should be numbered. +- +numbered\_bullets+ — whether bullets should be numbered (rendered + to/from the JSON/YAML key +numberedBullets+ for Python parity). + +## Signature + +```ruby +class Section < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Add or replace the body text for this section. Mirrors Python's `Section.add_body` (which is documented to "Add or replace"). + + + + Append bullet points to this section. Does not replace existing bullets — mirrors Python's `self.bullets.extend(bullets)`. + + + + Add a subsection to this section, returning the new Section. + + + + Returns the value of attribute body. + + + + Sets the attribute body + + + + Returns the value of attribute bullets. + + + + Sets the attribute bullets + + + + Construct a Section. + + + + Returns the value of attribute numbered. + + + + Returns the value of attribute numbered\_bullets. + + + + Sets the attribute numbered\_bullets + + + + Sets the attribute numbered + + + + Render this section and all its subsections as Markdown. The output is byte-for-byte identical to Python's `Section.render_markdown`. + + + + Render this section and all its subsections as XML. Output is byte-for-byte identical to Python's `Section.render_xml`. + + + + Returns the value of attribute subsections. + + + + Sets the attribute subsections + + + + Returns the value of attribute title. + + + + Sets the attribute title + + + + Convert the section to a Hash representation suitable for JSON or YAML serialization. Keys are emitted in the same order as Python so cross-port string comparisons line up. + + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/initialize.mdx new file mode 100644 index 0000000000..4b6a8168a1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/initialize.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#initialize" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `initialize` + +Construct a Section. + +All arguments after +title+ are keyword arguments mirroring the +Python `Section.__init__` signature. `numbered_bullets` is +snake\_case in Ruby; the camelCase `numberedBullets` form used +by Python's JSON/YAML serialization is preserved on the wire. + +## Signature + +```ruby +def initialize(title = nil, body: '', bullets: nil, numbered: nil, numbered_bullets: false) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`Section` — a new instance of Section + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 33. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered-bullets.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered-bullets.mdx new file mode 100644 index 0000000000..1e66cf74bf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered-bullets.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/numbered-bullets" +title: "numbered_bullets" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#numbered_bullets" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `numbered_bullets` + +Returns the value of attribute numbered\_bullets. + +## Signature + +```ruby +attr_accessor numbered_bullets <-> Object +``` + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered-bullets__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered-bullets__2.mdx new file mode 100644 index 0000000000..26265d7834 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered-bullets__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/numbered-bullets__2" +title: "numbered_bullets=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#numbered_bullets=" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `numbered_bullets=` + +Sets the attribute numbered\_bullets + +## Signature + +```ruby +attr_accessor numbered_bullets= <-> Object +``` + +## Parameters + + + the value to set the attribute numbered\_bullets to. + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered.mdx new file mode 100644 index 0000000000..1e62763a64 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/numbered" +title: "numbered" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#numbered" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `numbered` + +Returns the value of attribute numbered. + +## Signature + +```ruby +attr_accessor numbered <-> Object +``` + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered__2.mdx new file mode 100644 index 0000000000..98311d78e3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/numbered__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/numbered__2" +title: "numbered=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#numbered=" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `numbered=` + +Sets the attribute numbered + +## Signature + +```ruby +attr_accessor numbered= <-> Object +``` + +## Parameters + + + the value to set the attribute numbered to. + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/render-markdown.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/render-markdown.mdx new file mode 100644 index 0000000000..aef0287ef9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/render-markdown.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/render-markdown" +title: "render_markdown" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#render_markdown" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `render_markdown` + +Render this section and all its subsections as Markdown. The +output is byte-for-byte identical to Python's +`Section.render_markdown`. + +## Signature + +```ruby +def render_markdown(level: 2, section_number: nil) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 104. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/render-xml.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/render-xml.mdx new file mode 100644 index 0000000000..4c8c62f646 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/render-xml.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/render-xml" +title: "render_xml" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#render_xml" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `render_xml` + +Render this section and all its subsections as XML. Output is +byte-for-byte identical to Python's `Section.render_xml`. + +## Signature + +```ruby +def render_xml(indent: 0, section_number: nil) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 150. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/subsections.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/subsections.mdx new file mode 100644 index 0000000000..e38ac59201 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/subsections.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/subsections" +title: "subsections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#subsections" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `subsections` + +Returns the value of attribute subsections. + +## Signature + +```ruby +attr_accessor subsections <-> Object +``` + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/subsections__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/subsections__2.mdx new file mode 100644 index 0000000000..ddab1d9c1b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/subsections__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/subsections__2" +title: "subsections=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#subsections=" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `subsections=` + +Sets the attribute subsections + +## Signature + +```ruby +attr_accessor subsections= <-> Object +``` + +## Parameters + + + the value to set the attribute subsections to. + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/title.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/title.mdx new file mode 100644 index 0000000000..a72b9ae8b8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/title.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/title" +title: "title" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#title" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `title` + +Returns the value of attribute title. + +## Signature + +```ruby +attr_accessor title <-> Object +``` + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/title__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/title__2.mdx new file mode 100644 index 0000000000..75ed719452 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/title__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/title__2" +title: "title=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#title=" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `title=` + +Sets the attribute title + +## Signature + +```ruby +attr_accessor title= <-> Object +``` + +## Parameters + + + the value to set the attribute title to. + + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/pom/section/to-h.mdx b/fern/products/sdk-reference/ruby/signal-wire/pom/section/to-h.mdx new file mode 100644 index 0000000000..7f6025cd6d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/pom/section/to-h.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/pom/section/to-h" +title: "to_h" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::POM::Section#to_h" + parent: "SignalWire::POM::Section" + module: "SignalWire.POM.Section" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb" + visibility: "public" +--- +# `to_h` + +Convert the section to a Hash representation suitable for JSON or +YAML serialization. Keys are emitted in the same order as Python +so cross-port string comparisons line up. + +## Signature + +```ruby +def to_h +``` + +## Source + +[`lib/signalwire/pom/section.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/pom/section.rb) + +Line 90. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/amenities.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/amenities.mdx new file mode 100644 index 0000000000..3340fd6dd3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/amenities.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge/amenities" +title: "amenities" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge#amenities" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `amenities` + +Returns the value of attribute amenities. + +## Signature + +```ruby +attr_reader amenities -> Object +``` + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/global-data.mdx new file mode 100644 index 0000000000..796a695354 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge/global-data" +title: "global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge#global_data" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `global_data` + +## Signature + +```ruby +def global_data +``` + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 62. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/handle-amenity-info.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/handle-amenity-info.mdx new file mode 100644 index 0000000000..d8f11f0a7a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/handle-amenity-info.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge/handle-amenity-info" +title: "handle_amenity_info" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge#handle_amenity_info" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `handle_amenity_info` + +## Signature + +```ruby +def handle_amenity_info(args, _raw_data) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 70. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/handle-service-info.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/handle-service-info.mdx new file mode 100644 index 0000000000..769a83f118 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/handle-service-info.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge/handle-service-info" +title: "handle_service_info" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge#handle_service_info" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `handle_service_info` + +## Signature + +```ruby +def handle_service_info(args, _raw_data) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 81. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/index.mdx new file mode 100644 index 0000000000..03274ec1cd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/index.mdx @@ -0,0 +1,76 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge" +title: "Concierge" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge" + parent: "SignalWire::Prefabs" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `Concierge` + +Prefab agent for providing virtual concierge services. + +agent = Concierge.new( +venue\_name: 'Grand Hotel', +services: \['room service', 'spa bookings'], +amenities: \{ 'pool' => \{ 'hours' => '7 AM - 10 PM', 'location' => '2nd Floor' \} \} +) + +## Signature + +```ruby +class Concierge < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute amenities. + + + + + + + + + + + + Returns the value of attribute name. + + + + + + Returns the value of attribute route. + + + + Returns the value of attribute services. + + + + + + Returns the value of attribute venue\_name. + + + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 20. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/initialize.mdx new file mode 100644 index 0000000000..b42a42c43b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/initialize.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge#initialize" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(venue_name:, services:, amenities:, hours_of_operation: nil, special_instructions: nil, welcome_message: nil, name: 'concierge', route: '/concierge', **_opts) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + +## Returns + +`Concierge` — a new instance of Concierge + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/name.mdx new file mode 100644 index 0000000000..65359e2b65 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge#name" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `name` + +Returns the value of attribute name. + +## Signature + +```ruby +attr_reader name -> Object +``` + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/prompt-sections.mdx new file mode 100644 index 0000000000..6fa10963fe --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge/prompt-sections" +title: "prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge#prompt_sections" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `prompt_sections` + +## Signature + +```ruby +def prompt_sections +``` + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 40. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/route.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/route.mdx new file mode 100644 index 0000000000..d1fbd19d28 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/route.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge/route" +title: "route" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge#route" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `route` + +Returns the value of attribute route. + +## Signature + +```ruby +attr_reader route -> Object +``` + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/services.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/services.mdx new file mode 100644 index 0000000000..c59cd2d0cb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/services.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge/services" +title: "services" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge#services" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `services` + +Returns the value of attribute services. + +## Signature + +```ruby +attr_reader services -> Object +``` + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/tools.mdx new file mode 100644 index 0000000000..514049aaa3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge/tools" +title: "tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge#tools" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `tools` + +## Signature + +```ruby +def tools +``` + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 36. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/venue-name.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/venue-name.mdx new file mode 100644 index 0000000000..513a40a237 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/concierge/venue-name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/concierge/venue-name" +title: "venue_name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Concierge#venue_name" + parent: "SignalWire::Prefabs::Concierge" + module: "SignalWire.Prefabs.Concierge" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb" + visibility: "public" +--- +# `venue_name` + +Returns the value of attribute venue\_name. + +## Signature + +```ruby +attr_reader venue_name -> Object +``` + +## Source + +[`lib/signalwire/prefabs/concierge.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/concierge.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/faqs.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/faqs.mdx new file mode 100644 index 0000000000..5b2191e8d2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/faqs.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/faq-bot/faqs" +title: "faqs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::FaqBot#faqs" + parent: "SignalWire::Prefabs::FaqBot" + module: "SignalWire.Prefabs.FaqBot" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb" + visibility: "public" +--- +# `faqs` + +Returns the value of attribute faqs. + +## Signature + +```ruby +attr_reader faqs -> Object +``` + +## Source + +[`lib/signalwire/prefabs/faq_bot.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/global-data.mdx new file mode 100644 index 0000000000..841dee23c8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/faq-bot/global-data" +title: "global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::FaqBot#global_data" + parent: "SignalWire::Prefabs::FaqBot" + module: "SignalWire.Prefabs.FaqBot" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb" + visibility: "public" +--- +# `global_data` + +## Signature + +```ruby +def global_data +``` + +## Source + +[`lib/signalwire/prefabs/faq_bot.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/handle-search.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/handle-search.mdx new file mode 100644 index 0000000000..6ce7274836 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/handle-search.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/faq-bot/handle-search" +title: "handle_search" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::FaqBot#handle_search" + parent: "SignalWire::Prefabs::FaqBot" + module: "SignalWire.Prefabs.FaqBot" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb" + visibility: "public" +--- +# `handle_search` + +## Signature + +```ruby +def handle_search(args, _raw_data) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/prefabs/faq_bot.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb) + +Line 56. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/index.mdx new file mode 100644 index 0000000000..5b458d8049 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/faq-bot" +title: "FaqBot" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Prefabs::FaqBot" + parent: "SignalWire::Prefabs" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb" + visibility: "public" +--- +# `FaqBot` + +Prefab agent for answering frequently asked questions. + +agent = FaqBot.new( +faqs: \[ +\{ 'question' => 'What is SignalWire?', 'answer' => 'A cloud communications platform.' \} +] +) + +## Signature + +```ruby +class FaqBot < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute faqs. + + + + + + + + + + Returns the value of attribute name. + + + + + + Returns the value of attribute route. + + + + + +## Source + +[`lib/signalwire/prefabs/faq_bot.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb) + +Line 20. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/initialize.mdx new file mode 100644 index 0000000000..cf345649a2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/initialize.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/faq-bot/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::FaqBot#initialize" + parent: "SignalWire::Prefabs::FaqBot" + module: "SignalWire.Prefabs.FaqBot" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(faqs:, suggest_related: true, persona: nil, name: 'faq_bot', route: '/faq', **_opts) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`FaqBot` — a new instance of FaqBot + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/prefabs/faq_bot.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/name.mdx new file mode 100644 index 0000000000..f8d874f50d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/faq-bot/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::FaqBot#name" + parent: "SignalWire::Prefabs::FaqBot" + module: "SignalWire.Prefabs.FaqBot" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb" + visibility: "public" +--- +# `name` + +Returns the value of attribute name. + +## Signature + +```ruby +attr_reader name -> Object +``` + +## Source + +[`lib/signalwire/prefabs/faq_bot.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/prompt-sections.mdx new file mode 100644 index 0000000000..037e6f26bf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/faq-bot/prompt-sections" +title: "prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::FaqBot#prompt_sections" + parent: "SignalWire::Prefabs::FaqBot" + module: "SignalWire.Prefabs.FaqBot" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb" + visibility: "public" +--- +# `prompt_sections` + +## Signature + +```ruby +def prompt_sections +``` + +## Source + +[`lib/signalwire/prefabs/faq_bot.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb) + +Line 38. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/route.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/route.mdx new file mode 100644 index 0000000000..ad7cd98fd2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/route.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/faq-bot/route" +title: "route" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::FaqBot#route" + parent: "SignalWire::Prefabs::FaqBot" + module: "SignalWire.Prefabs.FaqBot" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb" + visibility: "public" +--- +# `route` + +Returns the value of attribute route. + +## Signature + +```ruby +attr_reader route -> Object +``` + +## Source + +[`lib/signalwire/prefabs/faq_bot.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/tools.mdx new file mode 100644 index 0000000000..5c0df4214c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/faq-bot/tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/faq-bot/tools" +title: "tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::FaqBot#tools" + parent: "SignalWire::Prefabs::FaqBot" + module: "SignalWire.Prefabs.FaqBot" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb" + visibility: "public" +--- +# `tools` + +## Signature + +```ruby +def tools +``` + +## Source + +[`lib/signalwire/prefabs/faq_bot.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/faq_bot.rb) + +Line 34. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/index.mdx new file mode 100644 index 0000000000..130314c51e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs" +title: "Prefabs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Prefabs" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `Prefabs` + +## Signature + +```ruby +module Prefabs +``` + +## Classes + + + + Prefab agent for providing virtual concierge services. + + + + Prefab agent for answering frequently asked questions. + + + + Prefab agent for collecting answers to a series of questions. + + + + Prefab agent for greeting callers and transferring them to departments. + + + + Prefab agent for conducting automated surveys. + + + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/global-data.mdx new file mode 100644 index 0000000000..08211e2149 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/global-data.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/info-gatherer/global-data" +title: "global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::InfoGatherer#global_data" + parent: "SignalWire::Prefabs::InfoGatherer" + module: "SignalWire.Prefabs.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb" + visibility: "public" +--- +# `global_data` + +Global data for initial state. + +## Signature + +```ruby +def global_data +``` + +## Source + +[`lib/signalwire/prefabs/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb) + +Line 53. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/handle-start.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/handle-start.mdx new file mode 100644 index 0000000000..53e1e20131 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/handle-start.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/info-gatherer/handle-start" +title: "handle_start" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::InfoGatherer#handle_start" + parent: "SignalWire::Prefabs::InfoGatherer" + module: "SignalWire.Prefabs.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb" + visibility: "public" +--- +# `handle_start` + +Tool handler: start\_questions + +## Signature + +```ruby +def handle_start(_args, _raw_data) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/prefabs/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb) + +Line 64. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/handle-submit.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/handle-submit.mdx new file mode 100644 index 0000000000..0b61ea4ae1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/handle-submit.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/info-gatherer/handle-submit" +title: "handle_submit" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::InfoGatherer#handle_submit" + parent: "SignalWire::Prefabs::InfoGatherer" + module: "SignalWire.Prefabs.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb" + visibility: "public" +--- +# `handle_submit` + +Tool handler: submit\_answer + +## Signature + +```ruby +def handle_submit(args, _raw_data) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/prefabs/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb) + +Line 72. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/index.mdx new file mode 100644 index 0000000000..742f6ad823 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/info-gatherer" +title: "InfoGatherer" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Prefabs::InfoGatherer" + parent: "SignalWire::Prefabs" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb" + visibility: "public" +--- +# `InfoGatherer` + +Prefab agent for collecting answers to a series of questions. + +agent = InfoGatherer.new( +questions: \[ +\{ 'key\_name' => 'full\_name', 'question\_text' => 'What is your full name?' \}, +\{ 'key\_name' => 'email', 'question\_text' => 'Email?', 'confirm' => true \} +] +) + +## Signature + +```ruby +class InfoGatherer < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Global data for initial state. + + + + Tool handler: start\_questions + + + + Tool handler: submit\_answer + + + + + + Returns the value of attribute name. + + + + Build the prompt sections. + + + + Returns the value of attribute questions. + + + + Returns the value of attribute route. + + + + Tool definitions this prefab provides. + + + +## Source + +[`lib/signalwire/prefabs/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/initialize.mdx new file mode 100644 index 0000000000..0fc8041dee --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/initialize.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/info-gatherer/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::InfoGatherer#initialize" + parent: "SignalWire::Prefabs::InfoGatherer" + module: "SignalWire.Prefabs.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(questions:, name: 'info_gatherer', route: '/info_gatherer', **_opts) +``` + +## Parameters + + + + + + + + + +## Returns + +`InfoGatherer` — a new instance of InfoGatherer + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/prefabs/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/name.mdx new file mode 100644 index 0000000000..2576fcbb7d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/info-gatherer/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::InfoGatherer#name" + parent: "SignalWire::Prefabs::InfoGatherer" + module: "SignalWire.Prefabs.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb" + visibility: "public" +--- +# `name` + +Returns the value of attribute name. + +## Signature + +```ruby +attr_reader name -> Object +``` + +## Source + +[`lib/signalwire/prefabs/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/prompt-sections.mdx new file mode 100644 index 0000000000..c2b4376eed --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/prompt-sections.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/info-gatherer/prompt-sections" +title: "prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::InfoGatherer#prompt_sections" + parent: "SignalWire::Prefabs::InfoGatherer" + module: "SignalWire.Prefabs.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb" + visibility: "public" +--- +# `prompt_sections` + +Build the prompt sections. + +## Signature + +```ruby +def prompt_sections +``` + +## Source + +[`lib/signalwire/prefabs/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb) + +Line 42. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/questions.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/questions.mdx new file mode 100644 index 0000000000..bf83ea1f1b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/questions.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/info-gatherer/questions" +title: "questions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::InfoGatherer#questions" + parent: "SignalWire::Prefabs::InfoGatherer" + module: "SignalWire.Prefabs.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb" + visibility: "public" +--- +# `questions` + +Returns the value of attribute questions. + +## Signature + +```ruby +attr_reader questions -> Object +``` + +## Source + +[`lib/signalwire/prefabs/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/route.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/route.mdx new file mode 100644 index 0000000000..43192e1deb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/route.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/info-gatherer/route" +title: "route" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::InfoGatherer#route" + parent: "SignalWire::Prefabs::InfoGatherer" + module: "SignalWire.Prefabs.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb" + visibility: "public" +--- +# `route` + +Returns the value of attribute route. + +## Signature + +```ruby +attr_reader route -> Object +``` + +## Source + +[`lib/signalwire/prefabs/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/tools.mdx new file mode 100644 index 0000000000..901edbaadc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/info-gatherer/tools.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/info-gatherer/tools" +title: "tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::InfoGatherer#tools" + parent: "SignalWire::Prefabs::InfoGatherer" + module: "SignalWire.Prefabs.InfoGatherer" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb" + visibility: "public" +--- +# `tools` + +Tool definitions this prefab provides. + +## Signature + +```ruby +def tools +``` + +## Source + +[`lib/signalwire/prefabs/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/info_gatherer.rb) + +Line 37. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/departments.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/departments.mdx new file mode 100644 index 0000000000..3f292edc72 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/departments.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/receptionist/departments" +title: "departments" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Receptionist#departments" + parent: "SignalWire::Prefabs::Receptionist" + module: "SignalWire.Prefabs.Receptionist" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb" + visibility: "public" +--- +# `departments` + +Returns the value of attribute departments. + +## Signature + +```ruby +attr_reader departments -> Object +``` + +## Source + +[`lib/signalwire/prefabs/receptionist.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/global-data.mdx new file mode 100644 index 0000000000..c74766bf39 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/receptionist/global-data" +title: "global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Receptionist#global_data" + parent: "SignalWire::Prefabs::Receptionist" + module: "SignalWire.Prefabs.Receptionist" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb" + visibility: "public" +--- +# `global_data` + +## Signature + +```ruby +def global_data +``` + +## Source + +[`lib/signalwire/prefabs/receptionist.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb) + +Line 54. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/greeting.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/greeting.mdx new file mode 100644 index 0000000000..467d20c847 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/greeting.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/receptionist/greeting" +title: "greeting" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Receptionist#greeting" + parent: "SignalWire::Prefabs::Receptionist" + module: "SignalWire.Prefabs.Receptionist" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb" + visibility: "public" +--- +# `greeting` + +Returns the value of attribute greeting. + +## Signature + +```ruby +attr_reader greeting -> Object +``` + +## Source + +[`lib/signalwire/prefabs/receptionist.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/handle-transfer.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/handle-transfer.mdx new file mode 100644 index 0000000000..169e234ce6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/handle-transfer.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/receptionist/handle-transfer" +title: "handle_transfer" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Receptionist#handle_transfer" + parent: "SignalWire::Prefabs::Receptionist" + module: "SignalWire.Prefabs.Receptionist" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb" + visibility: "public" +--- +# `handle_transfer` + +## Signature + +```ruby +def handle_transfer(args, _raw_data) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/prefabs/receptionist.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb) + +Line 61. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/index.mdx new file mode 100644 index 0000000000..357d9cd766 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/receptionist" +title: "Receptionist" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Receptionist" + parent: "SignalWire::Prefabs" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb" + visibility: "public" +--- +# `Receptionist` + +Prefab agent for greeting callers and transferring them to departments. + +agent = Receptionist.new( +departments: \[ +\{ 'name' => 'sales', 'description' => 'Product inquiries', 'number' => '+15551235555' \}, +\{ 'name' => 'support', 'description' => 'Technical help', 'number' => '+15551236666' \} +] +) + +## Signature + +```ruby +class Receptionist < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute departments. + + + + + + Returns the value of attribute greeting. + + + + + + + + Returns the value of attribute name. + + + + + + Returns the value of attribute route. + + + + + +## Source + +[`lib/signalwire/prefabs/receptionist.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/initialize.mdx new file mode 100644 index 0000000000..55b431d7f6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/initialize.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/receptionist/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Receptionist#initialize" + parent: "SignalWire::Prefabs::Receptionist" + module: "SignalWire.Prefabs.Receptionist" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(departments:, name: 'receptionist', route: '/receptionist', greeting: 'Thank you for calling. How can I help you today?', **_opts) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`Receptionist` — a new instance of Receptionist + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/prefabs/receptionist.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/name.mdx new file mode 100644 index 0000000000..0585f8f30b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/receptionist/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Receptionist#name" + parent: "SignalWire::Prefabs::Receptionist" + module: "SignalWire.Prefabs.Receptionist" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb" + visibility: "public" +--- +# `name` + +Returns the value of attribute name. + +## Signature + +```ruby +attr_reader name -> Object +``` + +## Source + +[`lib/signalwire/prefabs/receptionist.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/prompt-sections.mdx new file mode 100644 index 0000000000..ba85556930 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/receptionist/prompt-sections" +title: "prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Receptionist#prompt_sections" + parent: "SignalWire::Prefabs::Receptionist" + module: "SignalWire.Prefabs.Receptionist" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb" + visibility: "public" +--- +# `prompt_sections` + +## Signature + +```ruby +def prompt_sections +``` + +## Source + +[`lib/signalwire/prefabs/receptionist.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb) + +Line 43. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/route.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/route.mdx new file mode 100644 index 0000000000..9217f787e6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/route.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/receptionist/route" +title: "route" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Receptionist#route" + parent: "SignalWire::Prefabs::Receptionist" + module: "SignalWire.Prefabs.Receptionist" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb" + visibility: "public" +--- +# `route` + +Returns the value of attribute route. + +## Signature + +```ruby +attr_reader route -> Object +``` + +## Source + +[`lib/signalwire/prefabs/receptionist.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/tools.mdx new file mode 100644 index 0000000000..3e28858b8c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/receptionist/tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/receptionist/tools" +title: "tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Receptionist#tools" + parent: "SignalWire::Prefabs::Receptionist" + module: "SignalWire.Prefabs.Receptionist" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb" + visibility: "public" +--- +# `tools` + +## Signature + +```ruby +def tools +``` + +## Source + +[`lib/signalwire/prefabs/receptionist.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/receptionist.rb) + +Line 39. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/global-data.mdx new file mode 100644 index 0000000000..4500e6ce53 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey/global-data" +title: "global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey#global_data" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `global_data` + +## Signature + +```ruby +def global_data +``` + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/handle-start.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/handle-start.mdx new file mode 100644 index 0000000000..ae76f75485 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/handle-start.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey/handle-start" +title: "handle_start" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey#handle_start" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `handle_start` + +## Signature + +```ruby +def handle_start(_args, _raw_data) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 61. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/handle-submit.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/handle-submit.mdx new file mode 100644 index 0000000000..f4835584c0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/handle-submit.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey/handle-submit" +title: "handle_submit" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey#handle_submit" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `handle_submit` + +## Signature + +```ruby +def handle_submit(args, _raw_data) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 66. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/handle-summary.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/handle-summary.mdx new file mode 100644 index 0000000000..e32409b216 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/handle-summary.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey/handle-summary" +title: "handle_summary" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey#handle_summary" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `handle_summary` + +## Signature + +```ruby +def handle_summary(_args, _raw_data) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 70. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/index.mdx new file mode 100644 index 0000000000..a08a435980 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/index.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey" +title: "Survey" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey" + parent: "SignalWire::Prefabs" + module: "SignalWire.Prefabs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `Survey` + +Prefab agent for conducting automated surveys. + +agent = Survey.new( +survey\_name: 'Customer Satisfaction', +questions: \[ +\{ 'id' => 'satisfaction', 'text' => 'How satisfied were you?', 'type' => 'rating', 'scale' => 5 \} +] +) + +## Signature + +```ruby +class Survey < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + + + + + + + + + + + Returns the value of attribute name. + + + + + + Returns the value of attribute questions. + + + + Returns the value of attribute route. + + + + Returns the value of attribute survey\_name. + + + + + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/initialize.mdx new file mode 100644 index 0000000000..ec11a27d6e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/initialize.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey#initialize" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(survey_name:, questions:, introduction: nil, conclusion: nil, name: 'survey', route: '/survey', **_opts) +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`Survey` — a new instance of Survey + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/name.mdx new file mode 100644 index 0000000000..5b24d46cc3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey#name" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `name` + +Returns the value of attribute name. + +## Signature + +```ruby +attr_reader name -> Object +``` + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/prompt-sections.mdx new file mode 100644 index 0000000000..adf68e22b6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey/prompt-sections" +title: "prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey#prompt_sections" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `prompt_sections` + +## Signature + +```ruby +def prompt_sections +``` + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 40. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/questions.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/questions.mdx new file mode 100644 index 0000000000..fec5c18930 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/questions.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey/questions" +title: "questions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey#questions" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `questions` + +Returns the value of attribute questions. + +## Signature + +```ruby +attr_reader questions -> Object +``` + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/route.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/route.mdx new file mode 100644 index 0000000000..1d0c478b4b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/route.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey/route" +title: "route" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey#route" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `route` + +Returns the value of attribute route. + +## Signature + +```ruby +attr_reader route -> Object +``` + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/survey-name.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/survey-name.mdx new file mode 100644 index 0000000000..70477327ad --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/survey-name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey/survey-name" +title: "survey_name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey#survey_name" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `survey_name` + +Returns the value of attribute survey\_name. + +## Signature + +```ruby +attr_reader survey_name -> Object +``` + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/tools.mdx new file mode 100644 index 0000000000..5b89483a71 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/prefabs/survey/tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/prefabs/survey/tools" +title: "tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Prefabs::Survey#tools" + parent: "SignalWire::Prefabs::Survey" + module: "SignalWire.Prefabs.Survey" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb" + visibility: "public" +--- +# `tools` + +## Signature + +```ruby +def tools +``` + +## Source + +[`lib/signalwire/prefabs/survey.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/prefabs/survey.rb) + +Line 36. diff --git a/fern/products/sdk-reference/ruby/signal-wire/register-skill.mdx b/fern/products/sdk-reference/ruby/signal-wire/register-skill.mdx new file mode 100644 index 0000000000..97a875cde0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/register-skill.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/ruby/signal-wire/register-skill" +title: "register_skill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire.register_skill" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire.rb" + visibility: "public" +--- +# `register_skill` + +Register a custom skill class with the global skill registry. + +Mirrors Python's `signalwire.register_skill(skill_class)` — the +Ruby singleton registry stores factories by name. The class is +expected to expose a `::skill_name` (or `SKILL_NAME` constant) +so we can derive the registration key. + +## Signature + +```ruby +def register_skill(skill_class) +``` + +## Parameters + + + A subclass of \{SignalWire::Skills::SkillBase\} + + +## Returns + +`void` + +## Source + +[`lib/signalwire.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire.rb) + +Line 60. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action-timeout-error/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action-timeout-error/index.mdx new file mode 100644 index 0000000000..4da016ae3b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action-timeout-error/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action-timeout-error" +title: "ActionTimeoutError" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::ActionTimeoutError" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `ActionTimeoutError` + +Raised when an action times out waiting for completion. + +## Signature + +```ruby +class ActionTimeoutError < StandardError +``` + +## Inheritance + +**Extends:** `StandardError` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/call.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/call.mdx new file mode 100644 index 0000000000..b298d2d3ec --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/call.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/call" +title: "call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#call" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `call` + +Returns the value of attribute call. + +## Signature + +```ruby +attr_reader call -> Object +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/check-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/check-event.mdx new file mode 100644 index 0000000000..b5eef04ae9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/check-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/check-event" +title: "_check_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#_check_event" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `_check_event` + +Called by Call when an event matches our control\_id. + +## Signature + +```ruby +def _check_event(event) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 42. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/completed.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/completed.mdx new file mode 100644 index 0000000000..07fdcb2d54 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/completed.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/completed" +title: "completed" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#completed" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `completed` + +Returns the value of attribute completed. + +## Signature + +```ruby +attr_reader completed -> Object +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/control-id.mdx new file mode 100644 index 0000000000..f3ac07d768 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#control_id" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/done.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/done.mdx new file mode 100644 index 0000000000..4296687347 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/done" +title: "done?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#done?" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `done?` + +## Signature + +```ruby +def done? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 89. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/index.mdx new file mode 100644 index 0000000000..70f7bc96fb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/index.mdx @@ -0,0 +1,85 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action" +title: "Action" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::Action" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `Action` + +Base class for async action handles (play, record, detect, etc.). + +Holds a control\_id and back-reference to the Call. Resolves when the +server sends a terminal event for this control\_id. + +Uses Ruby's Queue for blocking wait semantics. + +## Signature + +```ruby +class Action < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Called by Call when an event matches our control\_id. + + + + Mark the action as completed and fire the on\_completed callback. + + + + Called internally to set the on\_completed callback from options. + + + + Returns the value of attribute call. + + + + Returns the value of attribute completed. + + + + Returns the value of attribute control\_id. + + + + + + + + + + Set the on\_completed callback. + + + + Returns the value of attribute result. + + + + Wait for the action to complete. Returns the terminal event. Raises ActionTimeoutError if timeout is specified and exceeded. + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/initialize.mdx new file mode 100644 index 0000000000..5a7a3ea8f7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/initialize.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#initialize" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id, terminal_event, terminal_states) +``` + +## Parameters + + + + + + + + + +## Returns + +`Action` — a new instance of Action + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 19. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/is-done.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/is-done.mdx new file mode 100644 index 0000000000..5cc9342b9e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/is-done" +title: "is_done?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#is_done?" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `is_done?` + +## Signature + +```ruby +def done? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 93. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/on-completed.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/on-completed.mdx new file mode 100644 index 0000000000..7065eda37c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/on-completed.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/on-completed" +title: "on_completed" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#on_completed" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `on_completed` + +Set the on\_completed callback. + +## Signature + +```ruby +def on_completed(&block) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 32. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/resolve.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/resolve.mdx new file mode 100644 index 0000000000..c6cee3aa51 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/resolve.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/resolve" +title: "_resolve" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#_resolve" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `_resolve` + +Mark the action as completed and fire the on\_completed callback. + +## Signature + +```ruby +def _resolve(event) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/result.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/result.mdx new file mode 100644 index 0000000000..3347c6e849 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/result.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/result" +title: "result" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#result" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `result` + +Returns the value of attribute result. + +## Signature + +```ruby +attr_reader result -> Object +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/set-on-completed.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/set-on-completed.mdx new file mode 100644 index 0000000000..41bb2cfb5e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/set-on-completed.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/set-on-completed" +title: "_set_on_completed" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#_set_on_completed" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `_set_on_completed` + +Called internally to set the on\_completed callback from options. + +## Signature + +```ruby +def _set_on_completed(callback) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 37. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/action/wait.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/action/wait.mdx new file mode 100644 index 0000000000..5a6fa5b846 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/action/wait.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/relay/action/wait" +title: "wait" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Action#wait" + parent: "SignalWire::Relay::Action" + module: "SignalWire.Relay.Action" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `wait` + +Wait for the action to complete. Returns the terminal event. +Raises ActionTimeoutError if timeout is specified and exceeded. + +## Signature + +```ruby +def wait(timeout: nil) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 69. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/ai-action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/ai-action/index.mdx new file mode 100644 index 0000000000..22f878f4e1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/ai-action/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/ai-action" +title: "AIAction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::AIAction" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `AIAction` + +Handle for an active AI agent session. + +## Signature + +```ruby +class AIAction < SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/ruby/signal-wire/relay/action) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 281. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/ai-action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/ai-action/initialize.mdx new file mode 100644 index 0000000000..b6be1a313f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/ai-action/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/ai-action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::AIAction#initialize" + parent: "SignalWire::Relay::AIAction" + module: "SignalWire.Relay.AIAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id) +``` + +## Parameters + + + + + +## Returns + +`AIAction` — a new instance of AIAction + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 282. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/ai-action/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/ai-action/stop.mdx new file mode 100644 index 0000000000..b6d9c55963 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/ai-action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/ai-action/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::AIAction#stop" + parent: "SignalWire::Relay::AIAction" + module: "SignalWire.Relay.AIAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `stop` + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 286. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/call-state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/call-state.mdx new file mode 100644 index 0000000000..6ac22f6709 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/call-state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-receive-event/call-state" +title: "call_state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallReceiveEvent#call_state" + parent: "SignalWire::Relay::CallReceiveEvent" + module: "SignalWire.Relay.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `call_state` + +Returns the value of attribute call\_state. + +## Signature + +```ruby +attr_reader call_state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/context.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/context.mdx new file mode 100644 index 0000000000..23adf7ecc0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/context.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-receive-event/context" +title: "context" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallReceiveEvent#context" + parent: "SignalWire::Relay::CallReceiveEvent" + module: "SignalWire.Relay.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `context` + +Returns the value of attribute context. + +## Signature + +```ruby +attr_reader context -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/device.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/device.mdx new file mode 100644 index 0000000000..57c9a8fa5a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/device.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-receive-event/device" +title: "device" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallReceiveEvent#device" + parent: "SignalWire::Relay::CallReceiveEvent" + module: "SignalWire.Relay.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `device` + +Returns the value of attribute device. + +## Signature + +```ruby +attr_reader device -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/direction.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/direction.mdx new file mode 100644 index 0000000000..b9acea4884 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/direction.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-receive-event/direction" +title: "direction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallReceiveEvent#direction" + parent: "SignalWire::Relay::CallReceiveEvent" + module: "SignalWire.Relay.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `direction` + +Returns the value of attribute direction. + +## Signature + +```ruby +attr_reader direction -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/from-payload.mdx new file mode 100644 index 0000000000..5502babf31 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-receive-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallReceiveEvent.from_payload" + parent: "SignalWire::Relay::CallReceiveEvent" + module: "SignalWire.Relay.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 60. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/index.mdx new file mode 100644 index 0000000000..6bfe417588 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-receive-event" +title: "CallReceiveEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::CallReceiveEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `CallReceiveEvent` + +calling.call.receive + +## Signature + +```ruby +class CallReceiveEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute call\_state. + + + + Returns the value of attribute context. + + + + Returns the value of attribute device. + + + + Returns the value of attribute direction. + + + + + + + + Returns the value of attribute node\_id. + + + + Returns the value of attribute project\_id. + + + + Returns the value of attribute segment\_id. + + + + Returns the value of attribute tag. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 56. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/initialize.mdx new file mode 100644 index 0000000000..623574550b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/initialize.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-receive-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallReceiveEvent#initialize" + parent: "SignalWire::Relay::CallReceiveEvent" + module: "SignalWire.Relay.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call_state: '', direction: '', device: {}, node_id: '', project_id: '', context: '', segment_id: '', tag: '', **base) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + +## Returns + +`CallReceiveEvent` — a new instance of CallReceiveEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 77. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/node-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/node-id.mdx new file mode 100644 index 0000000000..b78fd6ca70 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/node-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-receive-event/node-id" +title: "node_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallReceiveEvent#node_id" + parent: "SignalWire::Relay::CallReceiveEvent" + module: "SignalWire.Relay.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `node_id` + +Returns the value of attribute node\_id. + +## Signature + +```ruby +attr_reader node_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/project-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/project-id.mdx new file mode 100644 index 0000000000..4c60d430ec --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/project-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-receive-event/project-id" +title: "project_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallReceiveEvent#project_id" + parent: "SignalWire::Relay::CallReceiveEvent" + module: "SignalWire.Relay.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `project_id` + +Returns the value of attribute project\_id. + +## Signature + +```ruby +attr_reader project_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/segment-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/segment-id.mdx new file mode 100644 index 0000000000..9299a06803 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/segment-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-receive-event/segment-id" +title: "segment_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallReceiveEvent#segment_id" + parent: "SignalWire::Relay::CallReceiveEvent" + module: "SignalWire.Relay.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `segment_id` + +Returns the value of attribute segment\_id. + +## Signature + +```ruby +attr_reader segment_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/tag.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/tag.mdx new file mode 100644 index 0000000000..641daa2c73 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-receive-event/tag.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-receive-event/tag" +title: "tag" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallReceiveEvent#tag" + parent: "SignalWire::Relay::CallReceiveEvent" + module: "SignalWire.Relay.CallReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `tag` + +Returns the value of attribute tag. + +## Signature + +```ruby +attr_reader tag -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/call-state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/call-state.mdx new file mode 100644 index 0000000000..391afd9902 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/call-state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-state-event/call-state" +title: "call_state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallStateEvent#call_state" + parent: "SignalWire::Relay::CallStateEvent" + module: "SignalWire.Relay.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `call_state` + +Returns the value of attribute call\_state. + +## Signature + +```ruby +attr_reader call_state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/device.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/device.mdx new file mode 100644 index 0000000000..c41a319c05 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/device.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-state-event/device" +title: "device" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallStateEvent#device" + parent: "SignalWire::Relay::CallStateEvent" + module: "SignalWire.Relay.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `device` + +Returns the value of attribute device. + +## Signature + +```ruby +attr_reader device -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/direction.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/direction.mdx new file mode 100644 index 0000000000..dc4c5bc3af --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/direction.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-state-event/direction" +title: "direction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallStateEvent#direction" + parent: "SignalWire::Relay::CallStateEvent" + module: "SignalWire.Relay.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `direction` + +Returns the value of attribute direction. + +## Signature + +```ruby +attr_reader direction -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/end-reason.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/end-reason.mdx new file mode 100644 index 0000000000..02cb185b45 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/end-reason.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-state-event/end-reason" +title: "end_reason" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallStateEvent#end_reason" + parent: "SignalWire::Relay::CallStateEvent" + module: "SignalWire.Relay.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `end_reason` + +Returns the value of attribute end\_reason. + +## Signature + +```ruby +attr_reader end_reason -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/from-payload.mdx new file mode 100644 index 0000000000..e75655cd17 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-state-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallStateEvent.from_payload" + parent: "SignalWire::Relay::CallStateEvent" + module: "SignalWire.Relay.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 33. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/index.mdx new file mode 100644 index 0000000000..363ed9ed08 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-state-event" +title: "CallStateEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::CallStateEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `CallStateEvent` + +calling.call.state + +## Signature + +```ruby +class CallStateEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute call\_state. + + + + Returns the value of attribute device. + + + + Returns the value of attribute direction. + + + + Returns the value of attribute end\_reason. + + + + + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 30. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/initialize.mdx new file mode 100644 index 0000000000..1ce85ee181 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call-state-event/initialize.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call-state-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallStateEvent#initialize" + parent: "SignalWire::Relay::CallStateEvent" + module: "SignalWire.Relay.CallStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call_state: '', end_reason: '', direction: '', device: {}, **base) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`CallStateEvent` — a new instance of CallStateEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 46. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai-hold.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai-hold.mdx new file mode 100644 index 0000000000..7c753fe0e5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai-hold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/ai-hold" +title: "ai_hold" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#ai_hold" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `ai_hold` + +## Signature + +```ruby +def ai_hold(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 356. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai-message.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai-message.mdx new file mode 100644 index 0000000000..ff644fde9d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/ai-message" +title: "ai_message" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#ai_message" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `ai_message` + +*** + +## AI + +## Signature + +```ruby +def ai_message(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 352. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai-unhold.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai-unhold.mdx new file mode 100644 index 0000000000..a3cb8e1632 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai-unhold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/ai-unhold" +title: "ai_unhold" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#ai_unhold" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `ai_unhold` + +## Signature + +```ruby +def ai_unhold(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 360. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai.mdx new file mode 100644 index 0000000000..a9def4513a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/ai.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/ai" +title: "ai" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#ai" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `ai` + +*** + +## AI (returns AIAction) + +## Signature + +```ruby +def ai(control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 506. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/amazon-bedrock.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/amazon-bedrock.mdx new file mode 100644 index 0000000000..a3e13004a5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/amazon-bedrock.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/amazon-bedrock" +title: "amazon_bedrock" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#amazon_bedrock" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `amazon_bedrock` + +## Signature + +```ruby +def amazon_bedrock(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 364. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/answer.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/answer.mdx new file mode 100644 index 0000000000..ce837dc46a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/answer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/answer" +title: "answer" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#answer" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `answer` + +*** + +## Call lifecycle methods + +## Signature + +```ruby +def answer(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 172. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/bind-digit.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/bind-digit.mdx new file mode 100644 index 0000000000..5dd2a38104 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/bind-digit.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/bind-digit" +title: "bind_digit" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#bind_digit" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `bind_digit` + +*** + +## Digit binding + +## Signature + +```ruby +def bind_digit(digits:, bind_method:, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 258. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/call-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/call-id.mdx new file mode 100644 index 0000000000..4f55262e00 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/call-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/call-id" +title: "call_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#call_id" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `call_id` + +Returns the value of attribute call\_id. + +## Signature + +```ruby +attr_reader call_id -> Object +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/clear-digit-bindings.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/clear-digit-bindings.mdx new file mode 100644 index 0000000000..83bc89caca --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/clear-digit-bindings.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/clear-digit-bindings" +title: "clear_digit_bindings" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#clear_digit_bindings" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `clear_digit_bindings` + +## Signature + +```ruby +def clear_digit_bindings(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 264. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/collect.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/collect.mdx new file mode 100644 index 0000000000..9e04b79685 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/collect.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/collect" +title: "collect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#collect" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `collect` + +## Signature + +```ruby +def collect(collect_opts, control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 411. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/connect.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/connect.mdx new file mode 100644 index 0000000000..8f05ea3291 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/connect.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/connect" +title: "connect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#connect" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `connect` + +*** + +## Connect + +## Signature + +```ruby +def connect(devices:, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 188. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/context.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/context.mdx new file mode 100644 index 0000000000..31ffd21eed --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/context.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/context" +title: "context" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#context" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `context` + +Returns the value of attribute context. + +## Signature + +```ruby +attr_reader context -> Object +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/denoise-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/denoise-stop.mdx new file mode 100644 index 0000000000..dd2523a2ee --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/denoise-stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/denoise-stop" +title: "denoise_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#denoise_stop" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `denoise_stop` + +## Signature + +```ruby +def denoise_stop +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 218. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/denoise.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/denoise.mdx new file mode 100644 index 0000000000..93ae92cc89 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/denoise.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/denoise" +title: "denoise" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#denoise" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `denoise` + +*** + +## Denoise + +## Signature + +```ruby +def denoise +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 214. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/detect.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/detect.mdx new file mode 100644 index 0000000000..f43980cfc3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/detect.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/detect" +title: "detect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#detect" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `detect` + +*** + +## Detect + +## Signature + +```ruby +def detect(detect_opts, timeout: nil, control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 424. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/device.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/device.mdx new file mode 100644 index 0000000000..1fd8dd94f5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/device.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/device" +title: "device" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#device" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `device` + +Returns the value of attribute device. + +## Signature + +```ruby +attr_reader device -> Object +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/direction.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/direction.mdx new file mode 100644 index 0000000000..391b90710a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/direction.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/direction" +title: "direction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#direction" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `direction` + +Returns the value of attribute direction. + +## Signature + +```ruby +attr_reader direction -> Object +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/disconnect.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/disconnect.mdx new file mode 100644 index 0000000000..4c01104c72 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/disconnect.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/disconnect" +title: "disconnect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#disconnect" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `disconnect` + +## Signature + +```ruby +def disconnect +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 194. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/dispatch-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/dispatch-event.mdx new file mode 100644 index 0000000000..7c06035476 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/dispatch-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/dispatch-event" +title: "_dispatch_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#_dispatch_event" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `_dispatch_event` + +Called by RelayClient when an event arrives for this call. + +## Signature + +```ruby +def _dispatch_event(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 76. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/echo.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/echo.mdx new file mode 100644 index 0000000000..81dafaaf28 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/echo.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/echo" +title: "echo" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#echo" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `echo` + +*** + +## Echo + +## Signature + +```ruby +def echo(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 250. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/ended.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/ended.mdx new file mode 100644 index 0000000000..9d747fc503 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/ended.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/ended" +title: "ended?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#ended?" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `ended?` + +## Signature + +```ruby +def ended? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 133. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/execute.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/execute.mdx new file mode 100644 index 0000000000..72c8b8c02b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/execute.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/execute" +title: "_execute" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#_execute" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `_execute` + +Send a calling.<method> JSON-RPC request for this call. + +## Signature + +```ruby +def _execute(method, extra_params = nil) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 45. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/hangup.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/hangup.mdx new file mode 100644 index 0000000000..a2601d8788 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/hangup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/hangup" +title: "hangup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#hangup" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `hangup` + +## Signature + +```ruby +def hangup(reason: 'hangup') +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 176. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/hold.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/hold.mdx new file mode 100644 index 0000000000..2fdf0aa479 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/hold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/hold" +title: "hold" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#hold" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `hold` + +*** + +## Hold / Unhold + +## Signature + +```ruby +def hold +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 202. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/index.mdx new file mode 100644 index 0000000000..3341ec706f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/index.mdx @@ -0,0 +1,239 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call" +title: "Call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::Call" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `Call` + +Represents a live RELAY call. + +Created by RelayClient on inbound calling.call.receive events or +outbound dial responses. + +## Signature + +```ruby +class Call < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Called by RelayClient when an event arrives for this call. + + + + Send a calling.<method> JSON-RPC request for this call. + + + + \------------------------------------------------------------------ Action helper ------------------------------------------------------------------ + + + + \------------------------------------------------------------------ AI (returns AIAction) ------------------------------------------------------------------ + + + + + + \------------------------------------------------------------------ AI ------------------------------------------------------------------ + + + + + + + + \------------------------------------------------------------------ Call lifecycle methods ------------------------------------------------------------------ + + + + \------------------------------------------------------------------ Digit binding ------------------------------------------------------------------ + + + + Returns the value of attribute call\_id. + + + + + + + + \------------------------------------------------------------------ Connect ------------------------------------------------------------------ + + + + Returns the value of attribute context. + + + + \------------------------------------------------------------------ Denoise ------------------------------------------------------------------ + + + + + + \------------------------------------------------------------------ Detect ------------------------------------------------------------------ + + + + Returns the value of attribute device. + + + + Returns the value of attribute direction. + + + + + + \------------------------------------------------------------------ Echo ------------------------------------------------------------------ + + + + + + + + \------------------------------------------------------------------ Hold / Unhold ------------------------------------------------------------------ + + + + + + + + \------------------------------------------------------------------ Conference ------------------------------------------------------------------ + + + + \------------------------------------------------------------------ Room ------------------------------------------------------------------ + + + + + + + + \------------------------------------------------------------------ Live transcribe / translate ------------------------------------------------------------------ + + + + + + Returns the value of attribute node\_id. + + + + Register an event listener for this call. + + + + + + \------------------------------------------------------------------ Pay ------------------------------------------------------------------ + + + + \------------------------------------------------------------------ Audio playback (returns PlayAction) ------------------------------------------------------------------ + + + + \------------------------------------------------------------------ Input collection ------------------------------------------------------------------ + + + + Returns the value of attribute project\_id. + + + + \------------------------------------------------------------------ Queue ------------------------------------------------------------------ + + + + + + + + \------------------------------------------------------------------ Recording (returns RecordAction) ------------------------------------------------------------------ + + + + \------------------------------------------------------------------ Refer (SIP REFER) ------------------------------------------------------------------ + + + + Returns the value of attribute segment\_id. + + + + \------------------------------------------------------------------ Send digits ------------------------------------------------------------------ + + + + \------------------------------------------------------------------ Fax ------------------------------------------------------------------ + + + + Returns the value of attribute state. + + + + Sets the attribute state + + + + \------------------------------------------------------------------ Stream ------------------------------------------------------------------ + + + + Returns the value of attribute tag. + + + + \------------------------------------------------------------------ Tap ------------------------------------------------------------------ + + + + + + \------------------------------------------------------------------ Transcribe ------------------------------------------------------------------ + + + + \------------------------------------------------------------------ Transfer ------------------------------------------------------------------ + + + + + + \------------------------------------------------------------------ User events ------------------------------------------------------------------ + + + + Wait for the call to reach the ended state. + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/initialize.mdx new file mode 100644 index 0000000000..c0113eb1ee --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/initialize.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#initialize" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(client, call_id:, node_id:, project_id: '', context: '', tag: '', direction: '', device: {}, state: '', segment_id: '') +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + +## Returns + +`Call` — a new instance of Call + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/inspect.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/inspect.mdx new file mode 100644 index 0000000000..02b20bd9fa --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/inspect.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/inspect" +title: "inspect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#inspect" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `inspect` + +## Signature + +```ruby +def inspect +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 518. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/join-conference.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/join-conference.mdx new file mode 100644 index 0000000000..f71dd506f0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/join-conference.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/join-conference" +title: "join_conference" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#join_conference" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `join_conference` + +*** + +## Conference + +## Signature + +```ruby +def join_conference(name:, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 236. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/join-room.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/join-room.mdx new file mode 100644 index 0000000000..267d31bb9f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/join-room.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/join-room" +title: "join_room" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#join_room" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `join_room` + +*** + +## Room + +## Signature + +```ruby +def join_room(name:, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 327. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/leave-conference.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/leave-conference.mdx new file mode 100644 index 0000000000..c09133e1c1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/leave-conference.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/leave-conference" +title: "leave_conference" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#leave_conference" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `leave_conference` + +## Signature + +```ruby +def leave_conference(conference_id:) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 242. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/leave-room.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/leave-room.mdx new file mode 100644 index 0000000000..c4630e414e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/leave-room.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/leave-room" +title: "leave_room" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#leave_room" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `leave_room` + +## Signature + +```ruby +def leave_room +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 333. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/live-transcribe.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/live-transcribe.mdx new file mode 100644 index 0000000000..cda351e115 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/live-transcribe.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/live-transcribe" +title: "live_transcribe" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#live_transcribe" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `live_transcribe` + +*** + +## Live transcribe / translate + +## Signature + +```ruby +def live_transcribe(action:, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 311. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/live-translate.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/live-translate.mdx new file mode 100644 index 0000000000..27563f83c7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/live-translate.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/live-translate" +title: "live_translate" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#live_translate" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `live_translate` + +## Signature + +```ruby +def live_translate(action:, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 317. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/node-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/node-id.mdx new file mode 100644 index 0000000000..2c34c836b2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/node-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/node-id" +title: "node_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#node_id" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `node_id` + +Returns the value of attribute node\_id. + +## Signature + +```ruby +attr_reader node_id -> Object +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/on.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/on.mdx new file mode 100644 index 0000000000..a1225d8489 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/on.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/on" +title: "on" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#on" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `on` + +Register an event listener for this call. + +## Signature + +```ruby +def on(event_type, &handler) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 69. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/pass-call.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/pass-call.mdx new file mode 100644 index 0000000000..09d3bb2f54 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/pass-call.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/pass-call" +title: "pass_call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#pass_call" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `pass_call` + +## Signature + +```ruby +def pass_call +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 180. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/pay.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/pay.mdx new file mode 100644 index 0000000000..14d35e549c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/pay.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/pay" +title: "pay" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#pay" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `pay` + +*** + +## Pay + +## Signature + +```ruby +def pay(payment_connector_url:, control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 494. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/play-and-collect.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/play-and-collect.mdx new file mode 100644 index 0000000000..a4e6a53c31 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/play-and-collect.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/play-and-collect" +title: "play_and_collect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#play_and_collect" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `play_and_collect` + +*** + +## Input collection + +## Signature + +```ruby +def play_and_collect(media, collect, volume: nil, control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 401. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/play.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/play.mdx new file mode 100644 index 0000000000..97956dff0c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/play.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/play" +title: "play" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#play" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `play` + +*** + +## Audio playback (returns PlayAction) + +## Signature + +```ruby +def play(media, volume: nil, direction: nil, loop_count: nil, control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 372. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/project-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/project-id.mdx new file mode 100644 index 0000000000..674ea20df0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/project-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/project-id" +title: "project_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#project_id" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `project_id` + +Returns the value of attribute project\_id. + +## Signature + +```ruby +attr_reader project_id -> Object +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/queue-enter.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/queue-enter.mdx new file mode 100644 index 0000000000..a30c739654 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/queue-enter.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/queue-enter" +title: "queue_enter" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#queue_enter" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `queue_enter` + +*** + +## Queue + +## Signature + +```ruby +def queue_enter(queue_name:, control_id: nil, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 272. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/queue-leave.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/queue-leave.mdx new file mode 100644 index 0000000000..87f8d79968 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/queue-leave.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/queue-leave" +title: "queue_leave" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#queue_leave" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `queue_leave` + +## Signature + +```ruby +def queue_leave(queue_name:, control_id: nil, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 279. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/receive-fax.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/receive-fax.mdx new file mode 100644 index 0000000000..3fdeb01622 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/receive-fax.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/receive-fax" +title: "receive_fax" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#receive_fax" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `receive_fax` + +## Signature + +```ruby +def receive_fax(control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 446. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/record.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/record.mdx new file mode 100644 index 0000000000..60c925fa10 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/record.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/record" +title: "record" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#record" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `record` + +*** + +## Recording (returns RecordAction) + +## Signature + +```ruby +def record(audio: nil, control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 388. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/refer.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/refer.mdx new file mode 100644 index 0000000000..c5d3f34381 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/refer.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/refer" +title: "refer" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#refer" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `refer` + +*** + +## Refer (SIP REFER) + +## Signature + +```ruby +def refer(device:, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 290. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/segment-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/segment-id.mdx new file mode 100644 index 0000000000..6a14a5a3bc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/segment-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/segment-id" +title: "segment_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#segment_id" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `segment_id` + +Returns the value of attribute segment\_id. + +## Signature + +```ruby +attr_reader segment_id -> Object +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/send-digits.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/send-digits.mdx new file mode 100644 index 0000000000..73495f6bef --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/send-digits.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/send-digits" +title: "send_digits" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#send_digits" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `send_digits` + +*** + +## Send digits + +## Signature + +```ruby +def send_digits(digits:, control_id: nil, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 300. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/send-fax.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/send-fax.mdx new file mode 100644 index 0000000000..fc4749e051 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/send-fax.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/send-fax" +title: "send_fax" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#send_fax" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `send_fax` + +*** + +## Fax + +## Signature + +```ruby +def send_fax(document:, control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 438. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/start-action.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/start-action.mdx new file mode 100644 index 0000000000..9b8a5e376f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/start-action.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/start-action" +title: "_start_action" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#_start_action" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `_start_action` + +*** + +## Action helper + +## Signature + +```ruby +def _start_action(action, method, params, on_completed: nil) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 141. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/state.mdx new file mode 100644 index 0000000000..b5d88a7cd5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#state" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_accessor state <-> Object +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/state__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/state__2.mdx new file mode 100644 index 0000000000..30149cfb54 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/state__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/state__2" +title: "state=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#state=" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `state=` + +Sets the attribute state + +## Signature + +```ruby +attr_accessor state= <-> Object +``` + +## Parameters + + + the value to set the attribute state to. + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/stream.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/stream.mdx new file mode 100644 index 0000000000..a9de7f6a28 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/stream.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/stream" +title: "stream" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#stream" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `stream` + +*** + +## Stream + +## Signature + +```ruby +def stream(url:, control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 470. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/tag.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/tag.mdx new file mode 100644 index 0000000000..19623675e8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/tag.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/tag" +title: "tag" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#tag" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `tag` + +Returns the value of attribute tag. + +## Signature + +```ruby +attr_reader tag -> Object +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/tap-audio.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/tap-audio.mdx new file mode 100644 index 0000000000..aa335f0386 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/tap-audio.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/tap-audio" +title: "tap_audio" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#tap_audio" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `tap_audio` + +*** + +## Tap + +## Signature + +```ruby +def tap_audio(tap_opts, device:, control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 458. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/to-s.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/to-s.mdx new file mode 100644 index 0000000000..b6f528c316 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/to-s.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/to-s" +title: "to_s" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#to_s" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `to_s` + +## Signature + +```ruby +def to_s +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 514. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/transcribe.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/transcribe.mdx new file mode 100644 index 0000000000..db5287f704 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/transcribe.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/transcribe" +title: "transcribe" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#transcribe" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `transcribe` + +*** + +## Transcribe + +## Signature + +```ruby +def transcribe(control_id: nil, on_completed: nil, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 482. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/transfer.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/transfer.mdx new file mode 100644 index 0000000000..717c5cf22d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/transfer.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/transfer" +title: "transfer" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#transfer" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `transfer` + +*** + +## Transfer + +## Signature + +```ruby +def transfer(dest:, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 226. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/unhold.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/unhold.mdx new file mode 100644 index 0000000000..07fdff118e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/unhold.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/unhold" +title: "unhold" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#unhold" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `unhold` + +## Signature + +```ruby +def unhold +``` + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/user-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/user-event.mdx new file mode 100644 index 0000000000..d5af7500f1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/user-event.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/user-event" +title: "user_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#user_event" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `user_event` + +*** + +## User events + +## Signature + +```ruby +def user_event(event: nil, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 341. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/call/wait-for-ended.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/call/wait-for-ended.mdx new file mode 100644 index 0000000000..1c5504a029 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/call/wait-for-ended.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/call/wait-for-ended" +title: "wait_for_ended" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Call#wait_for_ended" + parent: "SignalWire::Relay::Call" + module: "SignalWire.Relay.Call" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `wait_for_ended` + +Wait for the call to reach the ended state. + +## Signature + +```ruby +def wait_for_ended(timeout: nil) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 115. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/code.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/code.mdx new file mode 100644 index 0000000000..4b9538b97c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/code.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/calling-error-event/code" +title: "code" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallingErrorEvent#code" + parent: "SignalWire::Relay::CallingErrorEvent" + module: "SignalWire.Relay.CallingErrorEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `code` + +Returns the value of attribute code. + +## Signature + +```ruby +attr_reader code -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 532. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/from-payload.mdx new file mode 100644 index 0000000000..db1ba83459 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/calling-error-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallingErrorEvent.from_payload" + parent: "SignalWire::Relay::CallingErrorEvent" + module: "SignalWire.Relay.CallingErrorEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 534. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/index.mdx new file mode 100644 index 0000000000..8f7ba6d1b8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/relay/calling-error-event" +title: "CallingErrorEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::CallingErrorEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `CallingErrorEvent` + +calling.error + +## Signature + +```ruby +class CallingErrorEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute code. + + + + + + + + Returns the value of attribute message. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 531. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/initialize.mdx new file mode 100644 index 0000000000..a435839088 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/initialize.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/calling-error-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallingErrorEvent#initialize" + parent: "SignalWire::Relay::CallingErrorEvent" + module: "SignalWire.Relay.CallingErrorEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(code: '', message: '', **base) +``` + +## Parameters + + + + + + + +## Returns + +`CallingErrorEvent` — a new instance of CallingErrorEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 545. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/message.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/message.mdx new file mode 100644 index 0000000000..4b27d87cbf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/calling-error-event/message.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/calling-error-event/message" +title: "message" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CallingErrorEvent#message" + parent: "SignalWire::Relay::CallingErrorEvent" + module: "SignalWire.Relay.CallingErrorEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `message` + +Returns the value of attribute message. + +## Signature + +```ruby +attr_reader message -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 532. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/authorization-state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/authorization-state.mdx new file mode 100644 index 0000000000..f276e417cf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/authorization-state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/authorization-state" +title: "_authorization_state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#_authorization_state" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `_authorization_state` + +Return the SDK's tracked authorization-state blob (Python parity: ++RelayClient.\_authorization\_state+). Captured from ++signalwire.authorization.state+ events for use on reconnect. + +## Signature + +```ruby +def _authorization_state +``` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 155. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/calls-snapshot.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/calls-snapshot.mdx new file mode 100644 index 0000000000..8a1beb15f6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/calls-snapshot.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/calls-snapshot" +title: "_calls_snapshot" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#_calls_snapshot" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `_calls_snapshot` + +Return the current call\_id -> Call registry (a snapshot copy). +Test/audit-only surface for asserting on internal routing state; +the Python reference exposes the same via +RelayClient.\_calls+. + +## Signature + +```ruby +def _calls_snapshot +``` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 140. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/connected.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/connected.mdx new file mode 100644 index 0000000000..b08ea468cb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/connected.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/connected" +title: "_connected?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#_connected?" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `_connected?` + +True when the client believes the WebSocket is open. Exposed for +tests that need to assert the recv loop is still alive after an +injected error / handler exception. + +## Signature + +```ruby +def _connected? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 162. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/dial.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/dial.mdx new file mode 100644 index 0000000000..37f92ea40f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/dial.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/dial" +title: "dial" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#dial" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `dial` + +Dial outbound call(s). Returns a Call object. + +## Signature + +```ruby +def dial(devices, timeout: 120, tag: nil, **kwargs) +``` + +## Parameters + + + + + + + + + +## Throws + +- `RelayError` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 211. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/execute.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/execute.mdx new file mode 100644 index 0000000000..8aec973331 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/execute.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/execute" +title: "execute" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#execute" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `execute` + +Send a JSON-RPC request and wait for the response. +Returns the result hash. Raises RelayError on error. + +## Signature + +```ruby +def execute(method, params = {}) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 307. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/host.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/host.mdx new file mode 100644 index 0000000000..7f065b1a20 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/host.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/host" +title: "host" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#host" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `host` + +Returns the value of attribute host. + +## Signature + +```ruby +attr_reader host -> Object +``` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 36. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/index.mdx new file mode 100644 index 0000000000..85848d977f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/index.mdx @@ -0,0 +1,125 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client" +title: "Client" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::Client" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `Client` + +RelayClient -- WebSocket + JSON-RPC 2.0 protocol + event dispatch. + +One instance = one persistent WebSocket connection to SignalWire RELAY. + +Implements the 4 correlation mechanisms: + +1. JSON-RPC id -> pending hash with ConditionVariable +2. call\_id -> Call routing +3. control\_id -> Action tracking per Call +4. tag -> dial correlation + +## Signature + +```ruby +class Client < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Return the SDK's tracked authorization-state blob (Python parity: +RelayClient.\_authorization\_state+). Captured from +signalwire.authorization.state+ events for use on reconnect. + + + + Return the current call\_id -> Call registry (a snapshot copy). Test/audit-only surface for asserting on internal routing state; the Python reference exposes the same via +RelayClient.\_calls+. + + + + True when the client believes the WebSocket is open. Exposed for tests that need to assert the recv loop is still alive after an injected error / handler exception. + + + + Test/reconnect surface: stamp a previously issued protocol string before calling +run+ so the next signalwire.connect frame carries it (the production server replies with +session\_restored: true+). Mirrors Python's +RelayClient.\_relay\_protocol = ...+. + + + + Dial outbound call(s). Returns a Call object. + + + + Send a JSON-RPC request and wait for the response. Returns the result hash. Raises RelayError on error. + + + + Returns the value of attribute host. + + + + Python parity: `RelayClient(project=None, token=None, jwt_token=None, host=None, contexts=None, max_active_calls=None)`. Ruby v1 accepted `space:` for the same purpose; both keyword names are honoured for backwards compat. `host` is the canonical Python name and now drives the WebSocket endpoint. + + + + Returns the value of attribute max\_active\_calls. + + + + Register inbound call handler. + + + + Register a generic inbound-event handler. Called for every +signalwire.event+ frame BEFORE the type-specific handlers (call/message/dial) run. Used by integration probes (e.g. the audit harness) that need to react to raw events. + + + + Register inbound message handler. + + + + Returns the value of attribute project\_id. + + + + Returns the value of attribute protocol. + + + + \------------------------------------------------------------------ Dynamic context subscription ------------------------------------------------------------------ + + + + Connect, authenticate, subscribe, and enter the read loop. Blocks until stop is called. + + + + Send an arbitrary JSON-RPC frame to the server. Public surface for tests, the audit harness, and one-off RELAY methods that don't have a high-level wrapper. Returns nothing; outbound failures are silently ignored (matching +\_send\_json+ semantics). + + + + Send an SMS/MMS message. Returns a Message object. + + + + Graceful shutdown. + + + + + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 35. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/initialize.mdx new file mode 100644 index 0000000000..86d72a4cb8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/initialize.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#initialize" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `initialize` + +Python parity: +`RelayClient(project=None, token=None, jwt_token=None, +host=None, contexts=None, max_active_calls=None)`. Ruby v1 +accepted `space:` for the same purpose; both keyword names +are honoured for backwards compat. `host` is the canonical +Python name and now drives the WebSocket endpoint. + +## Signature + +```ruby +def initialize(project: nil, token: nil, jwt_token: nil, host: nil, contexts: ['default'], max_active_calls: nil, space: nil) +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`Client` — a new instance of Client + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 56. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/max-active-calls.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/max-active-calls.mdx new file mode 100644 index 0000000000..6a4bb4b7bd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/max-active-calls.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/max-active-calls" +title: "max_active_calls" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#max_active_calls" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `max_active_calls` + +Returns the value of attribute max\_active\_calls. + +## Signature + +```ruby +attr_reader max_active_calls -> Object +``` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 36. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/on-call.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/on-call.mdx new file mode 100644 index 0000000000..4ccab2b93c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/on-call.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/on-call" +title: "on_call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#on_call" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `on_call` + +Register inbound call handler. + +## Signature + +```ruby +def on_call(&block) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 112. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/on-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/on-event.mdx new file mode 100644 index 0000000000..2c13bf3a9a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/on-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/on-event" +title: "on_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#on_event" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `on_event` + +Register a generic inbound-event handler. Called for every ++signalwire.event+ frame BEFORE the type-specific handlers +(call/message/dial) run. Used by integration probes (e.g. the +audit harness) that need to react to raw events. + +## Signature + +```ruby +def on_event(&block) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 125. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/on-message.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/on-message.mdx new file mode 100644 index 0000000000..94a7e4032e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/on-message.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/on-message" +title: "on_message" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#on_message" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `on_message` + +Register inbound message handler. + +## Signature + +```ruby +def on_message(&block) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 117. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/project-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/project-id.mdx new file mode 100644 index 0000000000..4495000608 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/project-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/project-id" +title: "project_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#project_id" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `project_id` + +Returns the value of attribute project\_id. + +## Signature + +```ruby +attr_reader project_id -> Object +``` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 36. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/protocol.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/protocol.mdx new file mode 100644 index 0000000000..3a243d187c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/protocol.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/protocol" +title: "protocol" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#protocol" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `protocol` + +Returns the value of attribute protocol. + +## Signature + +```ruby +attr_reader protocol -> Object +``` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 36. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/receive.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/receive.mdx new file mode 100644 index 0000000000..817df7141e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/receive.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/receive" +title: "receive" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#receive" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `receive` + +*** + +## Dynamic context subscription + +## Signature + +```ruby +def receive(contexts) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 293. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/run.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/run.mdx new file mode 100644 index 0000000000..0fbe69874b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/run.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/run" +title: "run" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#run" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `run` + +Connect, authenticate, subscribe, and enter the read loop. +Blocks until stop is called. + +## Signature + +```ruby +def run +``` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 168. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/send-json.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/send-json.mdx new file mode 100644 index 0000000000..b1aab6c10d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/send-json.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/send-json" +title: "send_json" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#send_json" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `send_json` + +Send an arbitrary JSON-RPC frame to the server. Public surface for +tests, the audit harness, and one-off RELAY methods that don't +have a high-level wrapper. Returns nothing; outbound failures are +silently ignored (matching +\_send\_json+ semantics). + +## Signature + +```ruby +def send_json(msg) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 133. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/send-message.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/send-message.mdx new file mode 100644 index 0000000000..0feb8485ec --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/send-message.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/send-message" +title: "send_message" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#send_message" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `send_message` + +Send an SMS/MMS message. Returns a Message object. + +Mirrors Python's RelayClient.send\_message keyword-only signature +exactly. At least one of body: or media: is required. + +## Signature + +```ruby +def send_message(to_number:, from_number:, context: nil, body: nil, media: nil, tags: nil, region: nil, on_completed: nil) +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 253. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/set-protocol.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/set-protocol.mdx new file mode 100644 index 0000000000..a71ae76ae6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/set-protocol.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/set-protocol" +title: "_set_protocol" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#_set_protocol" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `_set_protocol` + +Test/reconnect surface: stamp a previously issued protocol +string before calling +run+ so the next signalwire.connect frame +carries it (the production server replies with ++session\_restored: true+). Mirrors Python's +RelayClient.\_relay\_protocol = ...+. + +## Signature + +```ruby +def _set_protocol(value) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 148. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/stop.mdx new file mode 100644 index 0000000000..bf716a3955 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#stop" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `stop` + +Graceful shutdown. + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 192. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/client/unreceive.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/client/unreceive.mdx new file mode 100644 index 0000000000..ddfce1dbe5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/client/unreceive.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/client/unreceive" +title: "unreceive" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Client#unreceive" + parent: "SignalWire::Relay::Client" + module: "SignalWire.Relay.Client" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `unreceive` + +## Signature + +```ruby +def unreceive(contexts) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 297. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/check-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/check-event.mdx new file mode 100644 index 0000000000..3b24dcbf42 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/check-event.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-action/check-event" +title: "_check_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectAction#_check_event" + parent: "SignalWire::Relay::CollectAction" + module: "SignalWire.Relay.CollectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `_check_event` + +play\_and\_collect shares a control\_id across play and collect +phases. Only resolve on collect events, not play events. + +## Signature + +```ruby +def _check_event(event) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 172. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/index.mdx new file mode 100644 index 0000000000..7ef93791a5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-action" +title: "CollectAction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectAction" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `CollectAction` + +Handle for play\_and\_collect or standalone collect. + +## Signature + +```ruby +class CollectAction < SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/ruby/signal-wire/relay/action) + +## Methods + + + + play\_and\_collect shares a control\_id across play and collect phases. Only resolve on collect events, not play events. + + + + + + + + + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 164. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/initialize.mdx new file mode 100644 index 0000000000..b10347b816 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectAction#initialize" + parent: "SignalWire::Relay::CollectAction" + module: "SignalWire.Relay.CollectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id) +``` + +## Parameters + + + + + +## Returns + +`CollectAction` — a new instance of CollectAction + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 165. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/start-input-timers.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..4aa7ab949f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/start-input-timers.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-action/start-input-timers" +title: "start_input_timers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectAction#start_input_timers" + parent: "SignalWire::Relay::CollectAction" + module: "SignalWire.Relay.CollectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `start_input_timers` + +## Signature + +```ruby +def start_input_timers +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 193. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/stop.mdx new file mode 100644 index 0000000000..610575d1af --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-action/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectAction#stop" + parent: "SignalWire::Relay::CollectAction" + module: "SignalWire.Relay.CollectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `stop` + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 183. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/volume.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/volume.mdx new file mode 100644 index 0000000000..0563dc4d5f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-action/volume.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-action/volume" +title: "volume" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectAction#volume" + parent: "SignalWire::Relay::CollectAction" + module: "SignalWire.Relay.CollectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `volume` + +## Signature + +```ruby +def volume(vol) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 187. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/control-id.mdx new file mode 100644 index 0000000000..cfd07bfab8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-event/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectEvent#control_id" + parent: "SignalWire::Relay::CollectEvent" + module: "SignalWire.Relay.CollectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 146. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/final.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/final.mdx new file mode 100644 index 0000000000..2992becfb4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/final.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-event/final" +title: "final" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectEvent#final" + parent: "SignalWire::Relay::CollectEvent" + module: "SignalWire.Relay.CollectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `final` + +Returns the value of attribute final. + +## Signature + +```ruby +attr_reader final -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 146. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/from-payload.mdx new file mode 100644 index 0000000000..6b352c4b3c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectEvent.from_payload" + parent: "SignalWire::Relay::CollectEvent" + module: "SignalWire.Relay.CollectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 148. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/index.mdx new file mode 100644 index 0000000000..69a6b43643 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-event" +title: "CollectEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `CollectEvent` + +calling.call.collect + +## Signature + +```ruby +class CollectEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute control\_id. + + + + Returns the value of attribute final. + + + + + + + + Returns the value of attribute result\_data. + + + + Returns the value of attribute state. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 145. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/initialize.mdx new file mode 100644 index 0000000000..0f38cb2060 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/initialize.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectEvent#initialize" + parent: "SignalWire::Relay::CollectEvent" + module: "SignalWire.Relay.CollectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(control_id: '', state: '', result_data: {}, final: nil, **base) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`CollectEvent` — a new instance of CollectEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 161. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/result-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/result-data.mdx new file mode 100644 index 0000000000..3682908df9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/result-data.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-event/result-data" +title: "result_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectEvent#result_data" + parent: "SignalWire::Relay::CollectEvent" + module: "SignalWire.Relay.CollectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `result_data` + +Returns the value of attribute result\_data. + +## Signature + +```ruby +attr_reader result_data -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 146. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/state.mdx new file mode 100644 index 0000000000..7a069d4ebd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/collect-event/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/collect-event/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::CollectEvent#state" + parent: "SignalWire::Relay::CollectEvent" + module: "SignalWire.Relay.CollectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_reader state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 146. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/conference-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/conference-id.mdx new file mode 100644 index 0000000000..cd487b06cc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/conference-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/conference-event/conference-id" +title: "conference_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ConferenceEvent#conference_id" + parent: "SignalWire::Relay::ConferenceEvent" + module: "SignalWire.Relay.ConferenceEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `conference_id` + +Returns the value of attribute conference\_id. + +## Signature + +```ruby +attr_reader conference_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 508. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/from-payload.mdx new file mode 100644 index 0000000000..3a655b5d72 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/conference-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ConferenceEvent.from_payload" + parent: "SignalWire::Relay::ConferenceEvent" + module: "SignalWire.Relay.ConferenceEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 510. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/index.mdx new file mode 100644 index 0000000000..4e29e824bb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/relay/conference-event" +title: "ConferenceEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::ConferenceEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `ConferenceEvent` + +calling.conference + +## Signature + +```ruby +class ConferenceEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute conference\_id. + + + + + + + + Returns the value of attribute name. + + + + Returns the value of attribute status. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 507. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/initialize.mdx new file mode 100644 index 0000000000..c60e4ec960 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/initialize.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/conference-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ConferenceEvent#initialize" + parent: "SignalWire::Relay::ConferenceEvent" + module: "SignalWire.Relay.ConferenceEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(conference_id: '', name: '', status: '', **base) +``` + +## Parameters + + + + + + + + + +## Returns + +`ConferenceEvent` — a new instance of ConferenceEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 522. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/name.mdx new file mode 100644 index 0000000000..181d74a789 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/conference-event/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ConferenceEvent#name" + parent: "SignalWire::Relay::ConferenceEvent" + module: "SignalWire.Relay.ConferenceEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `name` + +Returns the value of attribute name. + +## Signature + +```ruby +attr_reader name -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 508. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/status.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/status.mdx new file mode 100644 index 0000000000..25d0e9fe92 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/conference-event/status.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/conference-event/status" +title: "status" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ConferenceEvent#status" + parent: "SignalWire::Relay::ConferenceEvent" + module: "SignalWire.Relay.ConferenceEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `status` + +Returns the value of attribute status. + +## Signature + +```ruby +attr_reader status -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 508. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/connect-state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/connect-state.mdx new file mode 100644 index 0000000000..02507db362 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/connect-state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/connect-event/connect-state" +title: "connect_state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ConnectEvent#connect_state" + parent: "SignalWire::Relay::ConnectEvent" + module: "SignalWire.Relay.ConnectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `connect_state` + +Returns the value of attribute connect\_state. + +## Signature + +```ruby +attr_reader connect_state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 172. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/from-payload.mdx new file mode 100644 index 0000000000..7754f04893 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/connect-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ConnectEvent.from_payload" + parent: "SignalWire::Relay::ConnectEvent" + module: "SignalWire.Relay.ConnectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 174. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/index.mdx new file mode 100644 index 0000000000..7a0345da37 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/relay/connect-event" +title: "ConnectEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::ConnectEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `ConnectEvent` + +calling.call.connect + +## Signature + +```ruby +class ConnectEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute connect\_state. + + + + + + + + Returns the value of attribute peer. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 171. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/initialize.mdx new file mode 100644 index 0000000000..48896e5261 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/initialize.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/connect-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ConnectEvent#initialize" + parent: "SignalWire::Relay::ConnectEvent" + module: "SignalWire.Relay.ConnectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(connect_state: '', peer: {}, **base) +``` + +## Parameters + + + + + + + +## Returns + +`ConnectEvent` — a new instance of ConnectEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 185. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/peer.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/peer.mdx new file mode 100644 index 0000000000..c94d1b3a01 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/connect-event/peer.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/connect-event/peer" +title: "peer" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ConnectEvent#peer" + parent: "SignalWire::Relay::ConnectEvent" + module: "SignalWire.Relay.ConnectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `peer` + +Returns the value of attribute peer. + +## Signature + +```ruby +attr_reader peer -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 172. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/denoised.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/denoised.mdx new file mode 100644 index 0000000000..a2d77a6f13 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/denoised.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/denoise-event/denoised" +title: "denoised" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DenoiseEvent#denoised" + parent: "SignalWire::Relay::DenoiseEvent" + module: "SignalWire.Relay.DenoiseEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `denoised` + +Returns the value of attribute denoised. + +## Signature + +```ruby +attr_reader denoised -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 364. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/from-payload.mdx new file mode 100644 index 0000000000..827480de37 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/denoise-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DenoiseEvent.from_payload" + parent: "SignalWire::Relay::DenoiseEvent" + module: "SignalWire.Relay.DenoiseEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 366. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/index.mdx new file mode 100644 index 0000000000..26dc5e92ce --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/relay/denoise-event" +title: "DenoiseEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::DenoiseEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `DenoiseEvent` + +calling.call.denoise + +## Signature + +```ruby +class DenoiseEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute denoised. + + + + + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 363. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/initialize.mdx new file mode 100644 index 0000000000..8c14136326 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/denoise-event/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/denoise-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DenoiseEvent#initialize" + parent: "SignalWire::Relay::DenoiseEvent" + module: "SignalWire.Relay.DenoiseEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(denoised: false, **base) +``` + +## Parameters + + + + + +## Returns + +`DenoiseEvent` — a new instance of DenoiseEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 376. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/check-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/check-event.mdx new file mode 100644 index 0000000000..3e2f154616 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/check-event.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/relay/detect-action/check-event" +title: "_check_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DetectAction#_check_event" + parent: "SignalWire::Relay::DetectAction" + module: "SignalWire.Relay.DetectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `_check_event` + +Detect delivers results continuously. Resolve on first result or +when finished/error. + +## Signature + +```ruby +def _check_event(event) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 150. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/index.mdx new file mode 100644 index 0000000000..5207ef1bb2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/relay/detect-action" +title: "DetectAction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::DetectAction" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `DetectAction` + +Handle for an active detect operation. + +## Signature + +```ruby +class DetectAction < SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/ruby/signal-wire/relay/action) + +## Methods + + + + Detect delivers results continuously. Resolve on first result or when finished/error. + + + + + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 143. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/initialize.mdx new file mode 100644 index 0000000000..5cf0d2765f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/detect-action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DetectAction#initialize" + parent: "SignalWire::Relay::DetectAction" + module: "SignalWire.Relay.DetectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id) +``` + +## Parameters + + + + + +## Returns + +`DetectAction` — a new instance of DetectAction + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 144. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/stop.mdx new file mode 100644 index 0000000000..1cd242a7b6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/detect-action/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DetectAction#stop" + parent: "SignalWire::Relay::DetectAction" + module: "SignalWire.Relay.DetectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `stop` + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 158. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/control-id.mdx new file mode 100644 index 0000000000..cb58ef7ccf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/detect-event/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DetectEvent#control_id" + parent: "SignalWire::Relay::DetectEvent" + module: "SignalWire.Relay.DetectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 194. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/detect.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/detect.mdx new file mode 100644 index 0000000000..698114cd48 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/detect.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/detect-event/detect" +title: "detect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DetectEvent#detect" + parent: "SignalWire::Relay::DetectEvent" + module: "SignalWire.Relay.DetectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `detect` + +Returns the value of attribute detect. + +## Signature + +```ruby +attr_reader detect -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 194. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/from-payload.mdx new file mode 100644 index 0000000000..b68b264f05 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/detect-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DetectEvent.from_payload" + parent: "SignalWire::Relay::DetectEvent" + module: "SignalWire.Relay.DetectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 196. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/index.mdx new file mode 100644 index 0000000000..7f940aba06 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/relay/detect-event" +title: "DetectEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::DetectEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `DetectEvent` + +calling.call.detect + +## Signature + +```ruby +class DetectEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute control\_id. + + + + Returns the value of attribute detect. + + + + + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 193. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/initialize.mdx new file mode 100644 index 0000000000..8b86196572 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/detect-event/initialize.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/detect-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DetectEvent#initialize" + parent: "SignalWire::Relay::DetectEvent" + module: "SignalWire.Relay.DetectEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(control_id: '', detect: {}, **base) +``` + +## Parameters + + + + + + + +## Returns + +`DetectEvent` — a new instance of DetectEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 207. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/call-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/call-data.mdx new file mode 100644 index 0000000000..24dc2efbe4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/call-data.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/dial-event/call-data" +title: "call_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DialEvent#call_data" + parent: "SignalWire::Relay::DialEvent" + module: "SignalWire.Relay.DialEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `call_data` + +Returns the value of attribute call\_data. + +## Signature + +```ruby +attr_reader call_data -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 312. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/dial-state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/dial-state.mdx new file mode 100644 index 0000000000..c07f5f8b72 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/dial-state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/dial-event/dial-state" +title: "dial_state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DialEvent#dial_state" + parent: "SignalWire::Relay::DialEvent" + module: "SignalWire.Relay.DialEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `dial_state` + +Returns the value of attribute dial\_state. + +## Signature + +```ruby +attr_reader dial_state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 312. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/from-payload.mdx new file mode 100644 index 0000000000..5466c19ae8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/dial-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DialEvent.from_payload" + parent: "SignalWire::Relay::DialEvent" + module: "SignalWire.Relay.DialEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 314. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/index.mdx new file mode 100644 index 0000000000..1186f4c48e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/relay/dial-event" +title: "DialEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::DialEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `DialEvent` + +calling.call.dial + +## Signature + +```ruby +class DialEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute call\_data. + + + + Returns the value of attribute dial\_state. + + + + + + + + Returns the value of attribute tag. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 311. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/initialize.mdx new file mode 100644 index 0000000000..a8d0d3547c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/initialize.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/dial-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DialEvent#initialize" + parent: "SignalWire::Relay::DialEvent" + module: "SignalWire.Relay.DialEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(tag: '', dial_state: '', call_data: {}, **base) +``` + +## Parameters + + + + + + + + + +## Returns + +`DialEvent` — a new instance of DialEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 326. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/tag.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/tag.mdx new file mode 100644 index 0000000000..f2f791e52a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/dial-event/tag.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/dial-event/tag" +title: "tag" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::DialEvent#tag" + parent: "SignalWire::Relay::DialEvent" + module: "SignalWire.Relay.DialEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `tag` + +Returns the value of attribute tag. + +## Signature + +```ruby +attr_reader tag -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 312. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/from-payload.mdx new file mode 100644 index 0000000000..26f12f872f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/echo-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::EchoEvent.from_payload" + parent: "SignalWire::Relay::EchoEvent" + module: "SignalWire.Relay.EchoEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 439. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/index.mdx new file mode 100644 index 0000000000..3b2a76a793 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/relay/echo-event" +title: "EchoEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::EchoEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `EchoEvent` + +calling.call.echo + +## Signature + +```ruby +class EchoEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + + + + + Returns the value of attribute state. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 436. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/initialize.mdx new file mode 100644 index 0000000000..2d5a26fce2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/echo-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::EchoEvent#initialize" + parent: "SignalWire::Relay::EchoEvent" + module: "SignalWire.Relay.EchoEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(state: '', **base) +``` + +## Parameters + + + + + +## Returns + +`EchoEvent` — a new instance of EchoEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 449. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/state.mdx new file mode 100644 index 0000000000..9993eda64d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/echo-event/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/echo-event/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::EchoEvent#state" + parent: "SignalWire::Relay::EchoEvent" + module: "SignalWire.Relay.EchoEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_reader state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 437. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/fax-action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-action/index.mdx new file mode 100644 index 0000000000..5a02b9fd0f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-action/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/fax-action" +title: "FaxAction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::FaxAction" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `FaxAction` + +Handle for send\_fax or receive\_fax. + +## Signature + +```ruby +class FaxAction < SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/ruby/signal-wire/relay/action) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 225. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/fax-action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-action/initialize.mdx new file mode 100644 index 0000000000..854a2f3aa9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-action/initialize.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/fax-action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::FaxAction#initialize" + parent: "SignalWire::Relay::FaxAction" + module: "SignalWire.Relay.FaxAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id, method_prefix) +``` + +## Parameters + + + + + + + +## Returns + +`FaxAction` — a new instance of FaxAction + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 226. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/fax-action/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-action/stop.mdx new file mode 100644 index 0000000000..645cb4b06e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/fax-action/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::FaxAction#stop" + parent: "SignalWire::Relay::FaxAction" + module: "SignalWire.Relay.FaxAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `stop` + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 231. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/control-id.mdx new file mode 100644 index 0000000000..ef1ad10170 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/fax-event/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::FaxEvent#control_id" + parent: "SignalWire::Relay::FaxEvent" + module: "SignalWire.Relay.FaxEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 216. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/fax.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/fax.mdx new file mode 100644 index 0000000000..c15ff0480e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/fax.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/fax-event/fax" +title: "fax" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::FaxEvent#fax" + parent: "SignalWire::Relay::FaxEvent" + module: "SignalWire.Relay.FaxEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `fax` + +Returns the value of attribute fax. + +## Signature + +```ruby +attr_reader fax -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 216. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/from-payload.mdx new file mode 100644 index 0000000000..8b02144d78 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/fax-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::FaxEvent.from_payload" + parent: "SignalWire::Relay::FaxEvent" + module: "SignalWire.Relay.FaxEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 218. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/index.mdx new file mode 100644 index 0000000000..73a19d30f0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/relay/fax-event" +title: "FaxEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::FaxEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `FaxEvent` + +calling.call.fax + +## Signature + +```ruby +class FaxEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute control\_id. + + + + Returns the value of attribute fax. + + + + + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 215. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/initialize.mdx new file mode 100644 index 0000000000..b2cb156d5e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/fax-event/initialize.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/fax-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::FaxEvent#initialize" + parent: "SignalWire::Relay::FaxEvent" + module: "SignalWire.Relay.FaxEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(control_id: '', fax: {}, **base) +``` + +## Parameters + + + + + + + +## Returns + +`FaxEvent` — a new instance of FaxEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 229. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/from-payload.mdx new file mode 100644 index 0000000000..af43a4c7f4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/hold-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::HoldEvent.from_payload" + parent: "SignalWire::Relay::HoldEvent" + module: "SignalWire.Relay.HoldEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 490. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/index.mdx new file mode 100644 index 0000000000..e82c519682 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/relay/hold-event" +title: "HoldEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::HoldEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `HoldEvent` + +calling.call.hold + +## Signature + +```ruby +class HoldEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + + + + + Returns the value of attribute state. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 487. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/initialize.mdx new file mode 100644 index 0000000000..10ad19da35 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/hold-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::HoldEvent#initialize" + parent: "SignalWire::Relay::HoldEvent" + module: "SignalWire.Relay.HoldEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(state: '', **base) +``` + +## Parameters + + + + + +## Returns + +`HoldEvent` — a new instance of HoldEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 500. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/state.mdx new file mode 100644 index 0000000000..9fbd427850 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/hold-event/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/hold-event/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::HoldEvent#state" + parent: "SignalWire::Relay::HoldEvent" + module: "SignalWire.Relay.HoldEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_reader state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 488. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/index.mdx new file mode 100644 index 0000000000..767d353117 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/index.mdx @@ -0,0 +1,415 @@ +--- +slug: "/reference/ruby/signal-wire/relay" +title: "Relay" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Relay" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb" + visibility: "public" +--- +# `Relay` + +## Signature + +```ruby +module Relay +``` + +## Constants + + + + + + + Call states + + + + + + + + + + + + + + Connect states + + + + + + + + Default host + + + + + + + + Detect types + + + + + + + + + + + + + + End reasons + + + + + + + + + + Authorization state event + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Event types — calling + + + + + + + + + + + + Map event\_type string to typed event class + + + + + + Messaging event types + + + + + + + + + + + + Message states + + + + + + + + + + + + JSON-RPC methods + + + + + + + + + + + + + + + + + + + + Play states + + + + Protocol version sent during signalwire.connect + + + + + + + + Reconnect settings + + + + + + + + + + Record states + + + + + + Join room states + + + + + + +## Methods + + + + Parse a raw signalwire.event params hash into a typed event object. + + + +## Classes + + + + Base class for async action handles (play, record, detect, etc.). + + + + Raised when an action times out waiting for completion. + + + + Handle for an active AI agent session. + + + + Represents a live RELAY call. + + + + calling.error + + + + calling.call.receive + + + + calling.call.state + + + + RelayClient -- WebSocket + JSON-RPC 2.0 protocol + event dispatch. + + + + Handle for play\_and\_collect or standalone collect. + + + + calling.call.collect + + + + calling.conference + + + + calling.call.connect + + + + calling.call.denoise + + + + Handle for an active detect operation. + + + + calling.call.detect + + + + calling.call.dial + + + + calling.call.echo + + + + Handle for send\_fax or receive\_fax. + + + + calling.call.fax + + + + calling.call.hold + + + + Represents a single SMS/MMS message. + + + + messaging.receive + + + + messaging.state + + + + Handle for an active pay operation. + + + + calling.call.pay + + + + Handle for an active play operation. + + + + calling.call.play + + + + calling.call.queue + + + + Handle for an active record operation. + + + + calling.call.record + + + + calling.call.refer + + + + Raised for RELAY JSON-RPC errors. + + + + Base event wrapper for raw signalwire.event payloads. Subclasses provide typed accessors for specific event types. + + + + calling.call.send\_digits + + + + Handle for standalone calling.collect (without play). + + + + Handle for an active stream operation. + + + + calling.call.stream + + + + Handle for an active tap operation. + + + + calling.call.tap + + + + Handle for an active transcribe operation. + + + + calling.call.transcribe + + + +## Source + +[`lib/signalwire/relay/call.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/call.rb) + +Line 6. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/body.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/body.mdx new file mode 100644 index 0000000000..4effbe68db --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/body.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/body" +title: "body" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent#body" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `body` + +Returns the value of attribute body. + +## Signature + +```ruby +attr_reader body -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 554. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/context.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/context.mdx new file mode 100644 index 0000000000..0ff0578c2d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/context.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/context" +title: "context" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent#context" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `context` + +Returns the value of attribute context. + +## Signature + +```ruby +attr_reader context -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 554. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/direction.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/direction.mdx new file mode 100644 index 0000000000..446ceec3b0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/direction.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/direction" +title: "direction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent#direction" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `direction` + +Returns the value of attribute direction. + +## Signature + +```ruby +attr_reader direction -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 554. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/from-number.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/from-number.mdx new file mode 100644 index 0000000000..76a6cdceab --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/from-number.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/from-number" +title: "from_number" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent#from_number" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_number` + +Returns the value of attribute from\_number. + +## Signature + +```ruby +attr_reader from_number -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 554. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/from-payload.mdx new file mode 100644 index 0000000000..081a4c575a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent.from_payload" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 557. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/index.mdx new file mode 100644 index 0000000000..dfd15e1528 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/index.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event" +title: "MessageReceiveEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `MessageReceiveEvent` + +messaging.receive + +## Signature + +```ruby +class MessageReceiveEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute body. + + + + Returns the value of attribute context. + + + + Returns the value of attribute direction. + + + + Returns the value of attribute from\_number. + + + + + + + + Returns the value of attribute media. + + + + Returns the value of attribute message\_id. + + + + Returns the value of attribute message\_state. + + + + Returns the value of attribute segments. + + + + Returns the value of attribute tags. + + + + Returns the value of attribute to\_number. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 553. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/initialize.mdx new file mode 100644 index 0000000000..c4f4233e06 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/initialize.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent#initialize" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(message_id: '', context: '', direction: '', from_number: '', to_number: '', body: '', media: [], segments: 0, message_state: '', tags: [], **base) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`MessageReceiveEvent` — a new instance of MessageReceiveEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 576. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/media.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/media.mdx new file mode 100644 index 0000000000..8a04880a30 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/media.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/media" +title: "media" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent#media" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `media` + +Returns the value of attribute media. + +## Signature + +```ruby +attr_reader media -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 554. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/message-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/message-id.mdx new file mode 100644 index 0000000000..4aee342392 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/message-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/message-id" +title: "message_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent#message_id" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `message_id` + +Returns the value of attribute message\_id. + +## Signature + +```ruby +attr_reader message_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 554. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/message-state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/message-state.mdx new file mode 100644 index 0000000000..ec4f073d07 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/message-state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/message-state" +title: "message_state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent#message_state" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `message_state` + +Returns the value of attribute message\_state. + +## Signature + +```ruby +attr_reader message_state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 554. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/segments.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/segments.mdx new file mode 100644 index 0000000000..f67eba4954 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/segments.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/segments" +title: "segments" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent#segments" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `segments` + +Returns the value of attribute segments. + +## Signature + +```ruby +attr_reader segments -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 554. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/tags.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/tags.mdx new file mode 100644 index 0000000000..8d6170687f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/tags.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/tags" +title: "tags" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent#tags" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `tags` + +Returns the value of attribute tags. + +## Signature + +```ruby +attr_reader tags -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 554. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/to-number.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/to-number.mdx new file mode 100644 index 0000000000..d1aa49d9ed --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-receive-event/to-number.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-receive-event/to-number" +title: "to_number" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageReceiveEvent#to_number" + parent: "SignalWire::Relay::MessageReceiveEvent" + module: "SignalWire.Relay.MessageReceiveEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `to_number` + +Returns the value of attribute to\_number. + +## Signature + +```ruby +attr_reader to_number -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 554. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/body.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/body.mdx new file mode 100644 index 0000000000..c97f90257d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/body.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/body" +title: "body" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#body" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `body` + +Returns the value of attribute body. + +## Signature + +```ruby +attr_reader body -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 595. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/context.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/context.mdx new file mode 100644 index 0000000000..1492d54e7d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/context.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/context" +title: "context" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#context" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `context` + +Returns the value of attribute context. + +## Signature + +```ruby +attr_reader context -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 595. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/direction.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/direction.mdx new file mode 100644 index 0000000000..2ba7a6ef45 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/direction.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/direction" +title: "direction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#direction" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `direction` + +Returns the value of attribute direction. + +## Signature + +```ruby +attr_reader direction -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 595. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/from-number.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/from-number.mdx new file mode 100644 index 0000000000..48d785bed2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/from-number.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/from-number" +title: "from_number" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#from_number" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_number` + +Returns the value of attribute from\_number. + +## Signature + +```ruby +attr_reader from_number -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 595. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/from-payload.mdx new file mode 100644 index 0000000000..ed320e6290 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent.from_payload" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 598. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/index.mdx new file mode 100644 index 0000000000..7adddf6834 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/index.mdx @@ -0,0 +1,86 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event" +title: "MessageStateEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `MessageStateEvent` + +messaging.state + +## Signature + +```ruby +class MessageStateEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute body. + + + + Returns the value of attribute context. + + + + Returns the value of attribute direction. + + + + Returns the value of attribute from\_number. + + + + + + + + Returns the value of attribute media. + + + + Returns the value of attribute message\_id. + + + + Returns the value of attribute message\_state. + + + + Returns the value of attribute reason. + + + + Returns the value of attribute segments. + + + + Returns the value of attribute tags. + + + + Returns the value of attribute to\_number. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 594. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/initialize.mdx new file mode 100644 index 0000000000..a9deed9ab8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/initialize.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#initialize" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(message_id: '', context: '', direction: '', from_number: '', to_number: '', body: '', media: [], segments: 0, message_state: '', reason: '', tags: [], **base) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`MessageStateEvent` — a new instance of MessageStateEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 618. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/media.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/media.mdx new file mode 100644 index 0000000000..9a752e78a7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/media.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/media" +title: "media" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#media" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `media` + +Returns the value of attribute media. + +## Signature + +```ruby +attr_reader media -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 595. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/message-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/message-id.mdx new file mode 100644 index 0000000000..28e974e7fd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/message-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/message-id" +title: "message_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#message_id" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `message_id` + +Returns the value of attribute message\_id. + +## Signature + +```ruby +attr_reader message_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 595. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/message-state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/message-state.mdx new file mode 100644 index 0000000000..eba46f620b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/message-state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/message-state" +title: "message_state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#message_state" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `message_state` + +Returns the value of attribute message\_state. + +## Signature + +```ruby +attr_reader message_state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 595. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/reason.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/reason.mdx new file mode 100644 index 0000000000..895a42cfb8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/reason.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/reason" +title: "reason" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#reason" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `reason` + +Returns the value of attribute reason. + +## Signature + +```ruby +attr_reader reason -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 595. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/segments.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/segments.mdx new file mode 100644 index 0000000000..87e0c8a105 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/segments.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/segments" +title: "segments" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#segments" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `segments` + +Returns the value of attribute segments. + +## Signature + +```ruby +attr_reader segments -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 595. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/tags.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/tags.mdx new file mode 100644 index 0000000000..6d0a4a85d0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/tags.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/tags" +title: "tags" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#tags" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `tags` + +Returns the value of attribute tags. + +## Signature + +```ruby +attr_reader tags -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 595. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/to-number.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/to-number.mdx new file mode 100644 index 0000000000..040dff2c55 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message-state-event/to-number.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message-state-event/to-number" +title: "to_number" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::MessageStateEvent#to_number" + parent: "SignalWire::Relay::MessageStateEvent" + module: "SignalWire.Relay.MessageStateEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `to_number` + +Returns the value of attribute to\_number. + +## Signature + +```ruby +attr_reader to_number -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 595. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/body.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/body.mdx new file mode 100644 index 0000000000..da37a9fdfe --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/body.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/body" +title: "body" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#body" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `body` + +Returns the value of attribute body. + +## Signature + +```ruby +attr_reader body -> Object +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/context.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/context.mdx new file mode 100644 index 0000000000..25dd520539 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/context.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/context" +title: "context" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#context" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `context` + +Returns the value of attribute context. + +## Signature + +```ruby +attr_reader context -> Object +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/direction.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/direction.mdx new file mode 100644 index 0000000000..0b3b497ae1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/direction.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/direction" +title: "direction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#direction" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `direction` + +Returns the value of attribute direction. + +## Signature + +```ruby +attr_reader direction -> Object +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/dispatch-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/dispatch-event.mdx new file mode 100644 index 0000000000..38a1465896 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/dispatch-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/dispatch-event" +title: "_dispatch_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#_dispatch_event" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `_dispatch_event` + +Handle a messaging.state event for this message. + +## Signature + +```ruby +def _dispatch_event(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 86. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/done.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/done.mdx new file mode 100644 index 0000000000..aa3855a719 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/done" +title: "done?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#done?" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `done?` + +## Signature + +```ruby +def done? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 53. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/from-number.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/from-number.mdx new file mode 100644 index 0000000000..5038523b54 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/from-number.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/from-number" +title: "from_number" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#from_number" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `from_number` + +Returns the value of attribute from\_number. + +## Signature + +```ruby +attr_reader from_number -> Object +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/index.mdx new file mode 100644 index 0000000000..0e1f6088fe --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/index.mdx @@ -0,0 +1,121 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message" +title: "Message" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::Message" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `Message` + +Represents a single SMS/MMS message. + +For outbound messages, use message.wait to block until a terminal state +(delivered, undelivered, failed) is reached. + +## Signature + +```ruby +class Message < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Handle a messaging.state event for this message. + + + + Set the on\_completed callback from options. + + + + Returns the value of attribute body. + + + + Returns the value of attribute context. + + + + Returns the value of attribute direction. + + + + + + Returns the value of attribute from\_number. + + + + + + + + + + Returns the value of attribute media. + + + + Returns the value of attribute message\_id. + + + + Set the on\_completed callback. + + + + Register an event listener for state changes. + + + + Returns the value of attribute reason. + + + + + + Returns the value of attribute segments. + + + + Returns the value of attribute state. + + + + Sets the attribute state + + + + Returns the value of attribute tags. + + + + Returns the value of attribute to\_number. + + + + + + Wait for the message to reach a terminal state. Raises ActionTimeoutError if timeout exceeded. + + + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 9. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/initialize.mdx new file mode 100644 index 0000000000..851ff01238 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/initialize.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#initialize" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(message_id: '', context: '', direction: '', from_number: '', to_number: '', body: '', media: nil, segments: 0, state: '', reason: '', tags: nil) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`Message` — a new instance of Message + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/inspect.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/inspect.mdx new file mode 100644 index 0000000000..dd674742c9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/inspect.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/inspect" +title: "inspect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#inspect" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `inspect` + +## Signature + +```ruby +def inspect +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 113. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/is-done.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/is-done.mdx new file mode 100644 index 0000000000..0b67e31846 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/is-done" +title: "is_done?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#is_done?" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `is_done?` + +## Signature + +```ruby +def done? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/media.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/media.mdx new file mode 100644 index 0000000000..1fddf0b324 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/media.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/media" +title: "media" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#media" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `media` + +Returns the value of attribute media. + +## Signature + +```ruby +attr_reader media -> Object +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/message-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/message-id.mdx new file mode 100644 index 0000000000..9d59088b51 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/message-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/message-id" +title: "message_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#message_id" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `message_id` + +Returns the value of attribute message\_id. + +## Signature + +```ruby +attr_reader message_id -> Object +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/on-completed.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/on-completed.mdx new file mode 100644 index 0000000000..49595a489b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/on-completed.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/on-completed" +title: "on_completed" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#on_completed" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `on_completed` + +Set the on\_completed callback. + +## Signature + +```ruby +def on_completed(&block) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 39. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/on-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/on-event.mdx new file mode 100644 index 0000000000..257218b11e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/on-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/on-event" +title: "on_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#on_event" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `on_event` + +Register an event listener for state changes. + +## Signature + +```ruby +def on_event(&handler) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/reason.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/reason.mdx new file mode 100644 index 0000000000..6f9ea67ca4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/reason.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/reason" +title: "reason" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#reason" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `reason` + +Returns the value of attribute reason. + +## Signature + +```ruby +attr_reader reason -> Object +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/result.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/result.mdx new file mode 100644 index 0000000000..43d77ceb5d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/result.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/result" +title: "result" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#result" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `result` + +## Signature + +```ruby +def result +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 59. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/segments.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/segments.mdx new file mode 100644 index 0000000000..6bc53c48ee --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/segments.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/segments" +title: "segments" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#segments" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `segments` + +Returns the value of attribute segments. + +## Signature + +```ruby +attr_reader segments -> Object +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/set-on-completed.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/set-on-completed.mdx new file mode 100644 index 0000000000..996c2b926e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/set-on-completed.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/set-on-completed" +title: "_set_on_completed" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#_set_on_completed" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `_set_on_completed` + +Set the on\_completed callback from options. + +## Signature + +```ruby +def _set_on_completed(callback) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 44. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/state.mdx new file mode 100644 index 0000000000..b90a49d9b6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#state" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_accessor state <-> Object +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/state__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/state__2.mdx new file mode 100644 index 0000000000..e7a28050ab --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/state__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/state__2" +title: "state=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#state=" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `state=` + +Sets the attribute state + +## Signature + +```ruby +attr_accessor state= <-> Object +``` + +## Parameters + + + the value to set the attribute state to. + + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/tags.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/tags.mdx new file mode 100644 index 0000000000..6e202f727a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/tags.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/tags" +title: "tags" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#tags" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `tags` + +Returns the value of attribute tags. + +## Signature + +```ruby +attr_reader tags -> Object +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/to-number.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/to-number.mdx new file mode 100644 index 0000000000..ed0f47ffe9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/to-number.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/to-number" +title: "to_number" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#to_number" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `to_number` + +Returns the value of attribute to\_number. + +## Signature + +```ruby +attr_reader to_number -> Object +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/to-s.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/to-s.mdx new file mode 100644 index 0000000000..ba0d859ea8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/to-s.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/to-s" +title: "to_s" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#to_s" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `to_s` + +## Signature + +```ruby +def to_s +``` + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 108. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/message/wait.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/message/wait.mdx new file mode 100644 index 0000000000..b1c05b741b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/message/wait.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/relay/message/wait" +title: "wait" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::Message#wait" + parent: "SignalWire::Relay::Message" + module: "SignalWire.Relay.Message" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb" + visibility: "public" +--- +# `wait` + +Wait for the message to reach a terminal state. +Raises ActionTimeoutError if timeout exceeded. + +## Signature + +```ruby +def wait(timeout: nil) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/message.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/message.rb) + +Line 65. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/parse-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/parse-event.mdx new file mode 100644 index 0000000000..5bafed04e3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/parse-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/relay/parse-event" +title: "parse_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay.parse_event" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `parse_event` + +Parse a raw signalwire.event params hash into a typed event object. + +## Signature + +```ruby +def parse_event(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 664. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/pay-action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-action/index.mdx new file mode 100644 index 0000000000..af218e53cd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-action/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/pay-action" +title: "PayAction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::PayAction" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `PayAction` + +Handle for an active pay operation. + +## Signature + +```ruby +class PayAction < SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/ruby/signal-wire/relay/action) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 259. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/pay-action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-action/initialize.mdx new file mode 100644 index 0000000000..bedd7eba08 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-action/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/pay-action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PayAction#initialize" + parent: "SignalWire::Relay::PayAction" + module: "SignalWire.Relay.PayAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id) +``` + +## Parameters + + + + + +## Returns + +`PayAction` — a new instance of PayAction + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 260. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/pay-action/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-action/stop.mdx new file mode 100644 index 0000000000..a92188af4e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/pay-action/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PayAction#stop" + parent: "SignalWire::Relay::PayAction" + module: "SignalWire.Relay.PayAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `stop` + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 264. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/control-id.mdx new file mode 100644 index 0000000000..3c3605fdda --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/pay-event/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PayEvent#control_id" + parent: "SignalWire::Relay::PayEvent" + module: "SignalWire.Relay.PayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 384. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/from-payload.mdx new file mode 100644 index 0000000000..6d45f331a2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/pay-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PayEvent.from_payload" + parent: "SignalWire::Relay::PayEvent" + module: "SignalWire.Relay.PayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 386. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/index.mdx new file mode 100644 index 0000000000..04d32aaa77 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/relay/pay-event" +title: "PayEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::PayEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `PayEvent` + +calling.call.pay + +## Signature + +```ruby +class PayEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute control\_id. + + + + + + + + Returns the value of attribute state. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 383. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/initialize.mdx new file mode 100644 index 0000000000..a26af9c73b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/initialize.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/pay-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PayEvent#initialize" + parent: "SignalWire::Relay::PayEvent" + module: "SignalWire.Relay.PayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(control_id: '', state: '', **base) +``` + +## Parameters + + + + + + + +## Returns + +`PayEvent` — a new instance of PayEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 397. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/state.mdx new file mode 100644 index 0000000000..1f9bc65989 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/pay-event/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/pay-event/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PayEvent#state" + parent: "SignalWire::Relay::PayEvent" + module: "SignalWire.Relay.PayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_reader state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 384. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/index.mdx new file mode 100644 index 0000000000..ebe278244d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/relay/play-action" +title: "PlayAction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::PlayAction" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `PlayAction` + +Handle for an active play operation. + +## Signature + +```ruby +class PlayAction < SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/ruby/signal-wire/relay/action) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 97. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/initialize.mdx new file mode 100644 index 0000000000..36fd0e7db5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/play-action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PlayAction#initialize" + parent: "SignalWire::Relay::PlayAction" + module: "SignalWire.Relay.PlayAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id) +``` + +## Parameters + + + + + +## Returns + +`PlayAction` — a new instance of PlayAction + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 98. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/pause.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/pause.mdx new file mode 100644 index 0000000000..c387be478d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/pause.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/play-action/pause" +title: "pause" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PlayAction#pause" + parent: "SignalWire::Relay::PlayAction" + module: "SignalWire.Relay.PlayAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `pause` + +## Signature + +```ruby +def pause +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 107. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/resume.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/resume.mdx new file mode 100644 index 0000000000..8b6c3af697 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/resume.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/play-action/resume" +title: "resume" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PlayAction#resume" + parent: "SignalWire::Relay::PlayAction" + module: "SignalWire.Relay.PlayAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `resume` + +## Signature + +```ruby +def resume +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 111. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/stop.mdx new file mode 100644 index 0000000000..1777ffdcc3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/play-action/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PlayAction#stop" + parent: "SignalWire::Relay::PlayAction" + module: "SignalWire.Relay.PlayAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `stop` + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 103. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/volume.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/volume.mdx new file mode 100644 index 0000000000..ced0c3e811 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/play-action/volume.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/play-action/volume" +title: "volume" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PlayAction#volume" + parent: "SignalWire::Relay::PlayAction" + module: "SignalWire.Relay.PlayAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `volume` + +## Signature + +```ruby +def volume(vol) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 115. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/control-id.mdx new file mode 100644 index 0000000000..b460b9f9c2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/play-event/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PlayEvent#control_id" + parent: "SignalWire::Relay::PlayEvent" + module: "SignalWire.Relay.PlayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 93. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/from-payload.mdx new file mode 100644 index 0000000000..9150b5fc6b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/play-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PlayEvent.from_payload" + parent: "SignalWire::Relay::PlayEvent" + module: "SignalWire.Relay.PlayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 95. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/index.mdx new file mode 100644 index 0000000000..d2ab4b2103 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/relay/play-event" +title: "PlayEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::PlayEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `PlayEvent` + +calling.call.play + +## Signature + +```ruby +class PlayEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute control\_id. + + + + + + + + Returns the value of attribute state. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 92. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/initialize.mdx new file mode 100644 index 0000000000..743fa2eb16 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/initialize.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/play-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PlayEvent#initialize" + parent: "SignalWire::Relay::PlayEvent" + module: "SignalWire.Relay.PlayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(control_id: '', state: '', **base) +``` + +## Parameters + + + + + + + +## Returns + +`PlayEvent` — a new instance of PlayEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 106. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/state.mdx new file mode 100644 index 0000000000..9adb47aa5d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/play-event/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/play-event/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::PlayEvent#state" + parent: "SignalWire::Relay::PlayEvent" + module: "SignalWire.Relay.PlayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_reader state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 93. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/control-id.mdx new file mode 100644 index 0000000000..2cebd975dd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/queue-event/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::QueueEvent#control_id" + parent: "SignalWire::Relay::QueueEvent" + module: "SignalWire.Relay.QueueEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 406. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/from-payload.mdx new file mode 100644 index 0000000000..c65f884f46 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/queue-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::QueueEvent.from_payload" + parent: "SignalWire::Relay::QueueEvent" + module: "SignalWire.Relay.QueueEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 408. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/index.mdx new file mode 100644 index 0000000000..230d89ccc2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/ruby/signal-wire/relay/queue-event" +title: "QueueEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::QueueEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `QueueEvent` + +calling.call.queue + +## Signature + +```ruby +class QueueEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute control\_id. + + + + + + + + Returns the value of attribute position. + + + + Returns the value of attribute queue\_id. + + + + Returns the value of attribute queue\_name. + + + + Returns the value of attribute size. + + + + Returns the value of attribute status. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 405. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/initialize.mdx new file mode 100644 index 0000000000..063cadbe8c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/initialize.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/relay/queue-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::QueueEvent#initialize" + parent: "SignalWire::Relay::QueueEvent" + module: "SignalWire.Relay.QueueEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(control_id: '', status: '', queue_id: '', queue_name: '', position: 0, size: 0, **base) +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`QueueEvent` — a new instance of QueueEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 423. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/position.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/position.mdx new file mode 100644 index 0000000000..137b43dae3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/position.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/queue-event/position" +title: "position" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::QueueEvent#position" + parent: "SignalWire::Relay::QueueEvent" + module: "SignalWire.Relay.QueueEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `position` + +Returns the value of attribute position. + +## Signature + +```ruby +attr_reader position -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 406. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/queue-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/queue-id.mdx new file mode 100644 index 0000000000..e14656b5bc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/queue-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/queue-event/queue-id" +title: "queue_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::QueueEvent#queue_id" + parent: "SignalWire::Relay::QueueEvent" + module: "SignalWire.Relay.QueueEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `queue_id` + +Returns the value of attribute queue\_id. + +## Signature + +```ruby +attr_reader queue_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 406. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/queue-name.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/queue-name.mdx new file mode 100644 index 0000000000..67da4c9496 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/queue-name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/queue-event/queue-name" +title: "queue_name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::QueueEvent#queue_name" + parent: "SignalWire::Relay::QueueEvent" + module: "SignalWire.Relay.QueueEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `queue_name` + +Returns the value of attribute queue\_name. + +## Signature + +```ruby +attr_reader queue_name -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 406. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/size.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/size.mdx new file mode 100644 index 0000000000..ed9603061a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/size.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/queue-event/size" +title: "size" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::QueueEvent#size" + parent: "SignalWire::Relay::QueueEvent" + module: "SignalWire.Relay.QueueEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `size` + +Returns the value of attribute size. + +## Signature + +```ruby +attr_reader size -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 406. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/status.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/status.mdx new file mode 100644 index 0000000000..7fcc80e00b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/queue-event/status.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/queue-event/status" +title: "status" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::QueueEvent#status" + parent: "SignalWire::Relay::QueueEvent" + module: "SignalWire.Relay.QueueEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `status` + +Returns the value of attribute status. + +## Signature + +```ruby +attr_reader status -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 406. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/index.mdx new file mode 100644 index 0000000000..cdf3dfd626 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-action" +title: "RecordAction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordAction" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `RecordAction` + +Handle for an active record operation. + +## Signature + +```ruby +class RecordAction < SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/ruby/signal-wire/relay/action) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 121. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/initialize.mdx new file mode 100644 index 0000000000..c4abe1d13e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordAction#initialize" + parent: "SignalWire::Relay::RecordAction" + module: "SignalWire.Relay.RecordAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id) +``` + +## Parameters + + + + + +## Returns + +`RecordAction` — a new instance of RecordAction + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 122. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/pause.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/pause.mdx new file mode 100644 index 0000000000..6c7e4153ea --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/pause.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-action/pause" +title: "pause" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordAction#pause" + parent: "SignalWire::Relay::RecordAction" + module: "SignalWire.Relay.RecordAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `pause` + +## Signature + +```ruby +def pause(behavior: nil) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 131. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/resume.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/resume.mdx new file mode 100644 index 0000000000..be4950d4d8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/resume.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-action/resume" +title: "resume" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordAction#resume" + parent: "SignalWire::Relay::RecordAction" + module: "SignalWire.Relay.RecordAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `resume` + +## Signature + +```ruby +def resume +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 137. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/stop.mdx new file mode 100644 index 0000000000..54631b1c85 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-action/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordAction#stop" + parent: "SignalWire::Relay::RecordAction" + module: "SignalWire.Relay.RecordAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `stop` + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 127. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/control-id.mdx new file mode 100644 index 0000000000..818fca6456 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-event/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordEvent#control_id" + parent: "SignalWire::Relay::RecordEvent" + module: "SignalWire.Relay.RecordEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 115. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/duration.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/duration.mdx new file mode 100644 index 0000000000..42b47d0eb5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/duration.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-event/duration" +title: "duration" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordEvent#duration" + parent: "SignalWire::Relay::RecordEvent" + module: "SignalWire.Relay.RecordEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `duration` + +Returns the value of attribute duration. + +## Signature + +```ruby +attr_reader duration -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 115. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/from-payload.mdx new file mode 100644 index 0000000000..d561c33895 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordEvent.from_payload" + parent: "SignalWire::Relay::RecordEvent" + module: "SignalWire.Relay.RecordEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 117. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/index.mdx new file mode 100644 index 0000000000..a56e78d543 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-event" +title: "RecordEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `RecordEvent` + +calling.call.record + +## Signature + +```ruby +class RecordEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute control\_id. + + + + Returns the value of attribute duration. + + + + + + + + Returns the value of attribute record. + + + + Returns the value of attribute size. + + + + Returns the value of attribute state. + + + + Returns the value of attribute url. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 114. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/initialize.mdx new file mode 100644 index 0000000000..4d273100a1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/initialize.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordEvent#initialize" + parent: "SignalWire::Relay::RecordEvent" + module: "SignalWire.Relay.RecordEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(control_id: '', state: '', url: '', duration: 0.0, size: 0, record: {}, **base) +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`RecordEvent` — a new instance of RecordEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 133. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/record.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/record.mdx new file mode 100644 index 0000000000..07282d9051 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/record.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-event/record" +title: "record" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordEvent#record" + parent: "SignalWire::Relay::RecordEvent" + module: "SignalWire.Relay.RecordEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `record` + +Returns the value of attribute record. + +## Signature + +```ruby +attr_reader record -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 115. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/size.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/size.mdx new file mode 100644 index 0000000000..c3fd4b836f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/size.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-event/size" +title: "size" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordEvent#size" + parent: "SignalWire::Relay::RecordEvent" + module: "SignalWire.Relay.RecordEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `size` + +Returns the value of attribute size. + +## Signature + +```ruby +attr_reader size -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 115. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/state.mdx new file mode 100644 index 0000000000..48191fc224 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-event/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordEvent#state" + parent: "SignalWire::Relay::RecordEvent" + module: "SignalWire.Relay.RecordEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_reader state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 115. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/url.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/url.mdx new file mode 100644 index 0000000000..8c981f5eae --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/record-event/url.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/record-event/url" +title: "url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RecordEvent#url" + parent: "SignalWire::Relay::RecordEvent" + module: "SignalWire.Relay.RecordEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `url` + +Returns the value of attribute url. + +## Signature + +```ruby +attr_reader url -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 115. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/from-payload.mdx new file mode 100644 index 0000000000..5d39ce75e9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/refer-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ReferEvent.from_payload" + parent: "SignalWire::Relay::ReferEvent" + module: "SignalWire.Relay.ReferEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 339. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/index.mdx new file mode 100644 index 0000000000..e68ffc761a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/ruby/signal-wire/relay/refer-event" +title: "ReferEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::ReferEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `ReferEvent` + +calling.call.refer + +## Signature + +```ruby +class ReferEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + + + + + Returns the value of attribute sip\_notify\_response\_code. + + + + Returns the value of attribute sip\_refer\_response\_code. + + + + Returns the value of attribute sip\_refer\_to. + + + + Returns the value of attribute state. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 335. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/initialize.mdx new file mode 100644 index 0000000000..aee749e6ca --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/initialize.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/relay/refer-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ReferEvent#initialize" + parent: "SignalWire::Relay::ReferEvent" + module: "SignalWire.Relay.ReferEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(state: '', sip_refer_to: '', sip_refer_response_code: '', sip_notify_response_code: '', **base) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`ReferEvent` — a new instance of ReferEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 352. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/sip-notify-response-code.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/sip-notify-response-code.mdx new file mode 100644 index 0000000000..fcb6940ef0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/sip-notify-response-code.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/refer-event/sip-notify-response-code" +title: "sip_notify_response_code" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ReferEvent#sip_notify_response_code" + parent: "SignalWire::Relay::ReferEvent" + module: "SignalWire.Relay.ReferEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `sip_notify_response_code` + +Returns the value of attribute sip\_notify\_response\_code. + +## Signature + +```ruby +attr_reader sip_notify_response_code -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 336. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/sip-refer-response-code.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/sip-refer-response-code.mdx new file mode 100644 index 0000000000..3b237996a1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/sip-refer-response-code.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/refer-event/sip-refer-response-code" +title: "sip_refer_response_code" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ReferEvent#sip_refer_response_code" + parent: "SignalWire::Relay::ReferEvent" + module: "SignalWire.Relay.ReferEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `sip_refer_response_code` + +Returns the value of attribute sip\_refer\_response\_code. + +## Signature + +```ruby +attr_reader sip_refer_response_code -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 336. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/sip-refer-to.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/sip-refer-to.mdx new file mode 100644 index 0000000000..5bc6d5b127 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/sip-refer-to.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/refer-event/sip-refer-to" +title: "sip_refer_to" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ReferEvent#sip_refer_to" + parent: "SignalWire::Relay::ReferEvent" + module: "SignalWire.Relay.ReferEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `sip_refer_to` + +Returns the value of attribute sip\_refer\_to. + +## Signature + +```ruby +attr_reader sip_refer_to -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 336. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/state.mdx new file mode 100644 index 0000000000..3ba2c00630 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/refer-event/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/refer-event/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::ReferEvent#state" + parent: "SignalWire::Relay::ReferEvent" + module: "SignalWire.Relay.ReferEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_reader state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 336. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/code.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/code.mdx new file mode 100644 index 0000000000..d1e8add644 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/code.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/relay-error/code" +title: "code" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RelayError#code" + parent: "SignalWire::Relay::RelayError" + module: "SignalWire.Relay.RelayError" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `code` + +Returns the value of attribute code. + +## Signature + +```ruby +attr_reader code -> Object +``` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/error-message.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/error-message.mdx new file mode 100644 index 0000000000..e90bfec91d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/error-message.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/relay-error/error-message" +title: "error_message" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RelayError#error_message" + parent: "SignalWire::Relay::RelayError" + module: "SignalWire.Relay.RelayError" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `error_message` + +Returns the value of attribute error\_message. + +## Signature + +```ruby +attr_reader error_message -> Object +``` + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/index.mdx new file mode 100644 index 0000000000..4f29c0e665 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/relay/relay-error" +title: "RelayError" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::RelayError" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `RelayError` + +Raised for RELAY JSON-RPC errors. + +## Signature + +```ruby +class RelayError < StandardError +``` + +## Inheritance + +**Extends:** `StandardError` + +## Methods + + + + Returns the value of attribute code. + + + + Returns the value of attribute error\_message. + + + + + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/initialize.mdx new file mode 100644 index 0000000000..f157f4f346 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-error/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/relay-error/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RelayError#initialize" + parent: "SignalWire::Relay::RelayError" + module: "SignalWire.Relay.RelayError" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(code, message) +``` + +## Parameters + + + + + +## Returns + +`RelayError` — a new instance of RelayError + +## Source + +[`lib/signalwire/relay/client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/client.rb) + +Line 19. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/call-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/call-id.mdx new file mode 100644 index 0000000000..ff7756a002 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/call-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/relay-event/call-id" +title: "call_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RelayEvent#call_id" + parent: "SignalWire::Relay::RelayEvent" + module: "SignalWire.Relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `call_id` + +Returns the value of attribute call\_id. + +## Signature + +```ruby +attr_reader call_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/event-type.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/event-type.mdx new file mode 100644 index 0000000000..334554cce4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/event-type.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/relay-event/event-type" +title: "event_type" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RelayEvent#event_type" + parent: "SignalWire::Relay::RelayEvent" + module: "SignalWire.Relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `event_type` + +Returns the value of attribute event\_type. + +## Signature + +```ruby +attr_reader event_type -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/from-payload.mdx new file mode 100644 index 0000000000..4bdbff6167 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/relay-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RelayEvent.from_payload" + parent: "SignalWire::Relay::RelayEvent" + module: "SignalWire.Relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/index.mdx new file mode 100644 index 0000000000..ff6e80afa7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/ruby/signal-wire/relay/relay-event" +title: "RelayEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::RelayEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `RelayEvent` + +Base event wrapper for raw signalwire.event payloads. +Subclasses provide typed accessors for specific event types. + +## Signature + +```ruby +class RelayEvent < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute call\_id. + + + + Returns the value of attribute event\_type. + + + + + + + + Returns the value of attribute params. + + + + Returns the value of attribute timestamp. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/initialize.mdx new file mode 100644 index 0000000000..72e1e8d97c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/initialize.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/relay-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RelayEvent#initialize" + parent: "SignalWire::Relay::RelayEvent" + module: "SignalWire.Relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(event_type:, params: {}, call_id: '', timestamp: 0.0) +``` + +## Parameters + + + + + + + + + +## Returns + +`RelayEvent` — a new instance of RelayEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/params.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/params.mdx new file mode 100644 index 0000000000..4ed1d70745 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/params.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/relay-event/params" +title: "params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RelayEvent#params" + parent: "SignalWire::Relay::RelayEvent" + module: "SignalWire.Relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `params` + +Returns the value of attribute params. + +## Signature + +```ruby +attr_reader params -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/timestamp.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/timestamp.mdx new file mode 100644 index 0000000000..2b6d9bdf2f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/relay-event/timestamp.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/relay-event/timestamp" +title: "timestamp" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::RelayEvent#timestamp" + parent: "SignalWire::Relay::RelayEvent" + module: "SignalWire.Relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `timestamp` + +Returns the value of attribute timestamp. + +## Signature + +```ruby +attr_reader timestamp -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/control-id.mdx new file mode 100644 index 0000000000..7414144c19 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/send-digits-event/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::SendDigitsEvent#control_id" + parent: "SignalWire::Relay::SendDigitsEvent" + module: "SignalWire.Relay.SendDigitsEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 290. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/from-payload.mdx new file mode 100644 index 0000000000..a923038127 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/send-digits-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::SendDigitsEvent.from_payload" + parent: "SignalWire::Relay::SendDigitsEvent" + module: "SignalWire.Relay.SendDigitsEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 292. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/index.mdx new file mode 100644 index 0000000000..e2526468ea --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/relay/send-digits-event" +title: "SendDigitsEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::SendDigitsEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `SendDigitsEvent` + +calling.call.send\_digits + +## Signature + +```ruby +class SendDigitsEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute control\_id. + + + + + + + + Returns the value of attribute state. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 289. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/initialize.mdx new file mode 100644 index 0000000000..e058e66861 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/initialize.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/relay/send-digits-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::SendDigitsEvent#initialize" + parent: "SignalWire::Relay::SendDigitsEvent" + module: "SignalWire.Relay.SendDigitsEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(control_id: '', state: '', **base) +``` + +## Parameters + + + + + + + +## Returns + +`SendDigitsEvent` — a new instance of SendDigitsEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 303. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/state.mdx new file mode 100644 index 0000000000..e235a7245e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/send-digits-event/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/send-digits-event/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::SendDigitsEvent#state" + parent: "SignalWire::Relay::SendDigitsEvent" + module: "SignalWire.Relay.SendDigitsEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_reader state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 290. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/check-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/check-event.mdx new file mode 100644 index 0000000000..bac76df8a2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/check-event.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/standalone-collect-action/check-event" +title: "_check_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StandaloneCollectAction#_check_event" + parent: "SignalWire::Relay::StandaloneCollectAction" + module: "SignalWire.Relay.StandaloneCollectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `_check_event` + +## Signature + +```ruby +def _check_event(event) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 205. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/index.mdx new file mode 100644 index 0000000000..69ff7d295c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/relay/standalone-collect-action" +title: "StandaloneCollectAction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::StandaloneCollectAction" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `StandaloneCollectAction` + +Handle for standalone calling.collect (without play). + +## Signature + +```ruby +class StandaloneCollectAction < SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/ruby/signal-wire/relay/action) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 199. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/initialize.mdx new file mode 100644 index 0000000000..d2ee2fbecd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/standalone-collect-action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StandaloneCollectAction#initialize" + parent: "SignalWire::Relay::StandaloneCollectAction" + module: "SignalWire.Relay.StandaloneCollectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id) +``` + +## Parameters + + + + + +## Returns + +`StandaloneCollectAction` — a new instance of StandaloneCollectAction + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 200. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/start-input-timers.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..fed5206b96 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/start-input-timers.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/standalone-collect-action/start-input-timers" +title: "start_input_timers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StandaloneCollectAction#start_input_timers" + parent: "SignalWire::Relay::StandaloneCollectAction" + module: "SignalWire.Relay.StandaloneCollectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `start_input_timers` + +## Signature + +```ruby +def start_input_timers +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 219. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/stop.mdx new file mode 100644 index 0000000000..2822172280 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/standalone-collect-action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/standalone-collect-action/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StandaloneCollectAction#stop" + parent: "SignalWire::Relay::StandaloneCollectAction" + module: "SignalWire.Relay.StandaloneCollectAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `stop` + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 215. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/stream-action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-action/index.mdx new file mode 100644 index 0000000000..378ca26b59 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-action/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/stream-action" +title: "StreamAction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::StreamAction" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `StreamAction` + +Handle for an active stream operation. + +## Signature + +```ruby +class StreamAction < SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/ruby/signal-wire/relay/action) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 248. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/stream-action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-action/initialize.mdx new file mode 100644 index 0000000000..95f63b40e4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-action/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/stream-action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StreamAction#initialize" + parent: "SignalWire::Relay::StreamAction" + module: "SignalWire.Relay.StreamAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id) +``` + +## Parameters + + + + + +## Returns + +`StreamAction` — a new instance of StreamAction + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 249. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/stream-action/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-action/stop.mdx new file mode 100644 index 0000000000..0dad65f15a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/stream-action/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StreamAction#stop" + parent: "SignalWire::Relay::StreamAction" + module: "SignalWire.Relay.StreamAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `stop` + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 253. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/control-id.mdx new file mode 100644 index 0000000000..12b6946f84 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/stream-event/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StreamEvent#control_id" + parent: "SignalWire::Relay::StreamEvent" + module: "SignalWire.Relay.StreamEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 264. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/from-payload.mdx new file mode 100644 index 0000000000..1f3a280d98 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/stream-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StreamEvent.from_payload" + parent: "SignalWire::Relay::StreamEvent" + module: "SignalWire.Relay.StreamEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 266. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/index.mdx new file mode 100644 index 0000000000..b49549a27c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/ruby/signal-wire/relay/stream-event" +title: "StreamEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::StreamEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `StreamEvent` + +calling.call.stream + +## Signature + +```ruby +class StreamEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute control\_id. + + + + + + + + Returns the value of attribute name. + + + + Returns the value of attribute state. + + + + Returns the value of attribute url. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 263. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/initialize.mdx new file mode 100644 index 0000000000..50cd18ac13 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/initialize.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/relay/stream-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StreamEvent#initialize" + parent: "SignalWire::Relay::StreamEvent" + module: "SignalWire.Relay.StreamEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(control_id: '', state: '', url: '', name: '', **base) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`StreamEvent` — a new instance of StreamEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 279. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/name.mdx new file mode 100644 index 0000000000..75a8dc203b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/stream-event/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StreamEvent#name" + parent: "SignalWire::Relay::StreamEvent" + module: "SignalWire.Relay.StreamEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `name` + +Returns the value of attribute name. + +## Signature + +```ruby +attr_reader name -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 264. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/state.mdx new file mode 100644 index 0000000000..7f85455f89 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/stream-event/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StreamEvent#state" + parent: "SignalWire::Relay::StreamEvent" + module: "SignalWire.Relay.StreamEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_reader state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 264. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/url.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/url.mdx new file mode 100644 index 0000000000..a52e6742c9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/stream-event/url.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/stream-event/url" +title: "url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::StreamEvent#url" + parent: "SignalWire::Relay::StreamEvent" + module: "SignalWire.Relay.StreamEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `url` + +Returns the value of attribute url. + +## Signature + +```ruby +attr_reader url -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 264. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/tap-action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-action/index.mdx new file mode 100644 index 0000000000..130070fb64 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-action/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/tap-action" +title: "TapAction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::TapAction" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `TapAction` + +Handle for an active tap operation. + +## Signature + +```ruby +class TapAction < SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/ruby/signal-wire/relay/action) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 237. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/tap-action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-action/initialize.mdx new file mode 100644 index 0000000000..e8fdef133b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-action/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/tap-action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TapAction#initialize" + parent: "SignalWire::Relay::TapAction" + module: "SignalWire.Relay.TapAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id) +``` + +## Parameters + + + + + +## Returns + +`TapAction` — a new instance of TapAction + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 238. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/tap-action/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-action/stop.mdx new file mode 100644 index 0000000000..c15fb1a88c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/tap-action/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TapAction#stop" + parent: "SignalWire::Relay::TapAction" + module: "SignalWire.Relay.TapAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `stop` + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 242. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/control-id.mdx new file mode 100644 index 0000000000..b5c37b0380 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/tap-event/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TapEvent#control_id" + parent: "SignalWire::Relay::TapEvent" + module: "SignalWire.Relay.TapEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 238. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/device.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/device.mdx new file mode 100644 index 0000000000..7add0207de --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/device.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/tap-event/device" +title: "device" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TapEvent#device" + parent: "SignalWire::Relay::TapEvent" + module: "SignalWire.Relay.TapEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `device` + +Returns the value of attribute device. + +## Signature + +```ruby +attr_reader device -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 238. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/from-payload.mdx new file mode 100644 index 0000000000..2f12e03740 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/tap-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TapEvent.from_payload" + parent: "SignalWire::Relay::TapEvent" + module: "SignalWire.Relay.TapEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 240. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/index.mdx new file mode 100644 index 0000000000..1907c40ec2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/ruby/signal-wire/relay/tap-event" +title: "TapEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::TapEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `TapEvent` + +calling.call.tap + +## Signature + +```ruby +class TapEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute control\_id. + + + + Returns the value of attribute device. + + + + + + + + Returns the value of attribute state. + + + + Returns the value of attribute tap. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 237. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/initialize.mdx new file mode 100644 index 0000000000..cd5fa4f85a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/initialize.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/relay/tap-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TapEvent#initialize" + parent: "SignalWire::Relay::TapEvent" + module: "SignalWire.Relay.TapEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(control_id: '', state: '', tap: {}, device: {}, **base) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`TapEvent` — a new instance of TapEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 253. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/state.mdx new file mode 100644 index 0000000000..15c128f46b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/tap-event/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TapEvent#state" + parent: "SignalWire::Relay::TapEvent" + module: "SignalWire.Relay.TapEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_reader state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 238. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/tap.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/tap.mdx new file mode 100644 index 0000000000..9a6d10327e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/tap-event/tap.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/tap-event/tap" +title: "tap" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TapEvent#tap" + parent: "SignalWire::Relay::TapEvent" + module: "SignalWire.Relay.TapEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `tap` + +Returns the value of attribute tap. + +## Signature + +```ruby +attr_reader tap -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 238. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-action/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-action/index.mdx new file mode 100644 index 0000000000..e59b2d97b3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-action/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-action" +title: "TranscribeAction" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeAction" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `TranscribeAction` + +Handle for an active transcribe operation. + +## Signature + +```ruby +class TranscribeAction < SignalWire::Relay::Action +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::Action](/reference/ruby/signal-wire/relay/action) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 270. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-action/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-action/initialize.mdx new file mode 100644 index 0000000000..6dacbd3f97 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-action/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-action/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeAction#initialize" + parent: "SignalWire::Relay::TranscribeAction" + module: "SignalWire.Relay.TranscribeAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(call, control_id) +``` + +## Parameters + + + + + +## Returns + +`TranscribeAction` — a new instance of TranscribeAction + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 271. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-action/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-action/stop.mdx new file mode 100644 index 0000000000..e0f4471122 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-action/stop.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-action/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeAction#stop" + parent: "SignalWire::Relay::TranscribeAction" + module: "SignalWire.Relay.TranscribeAction" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb" + visibility: "public" +--- +# `stop` + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/relay/action.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/action.rb) + +Line 275. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/control-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/control-id.mdx new file mode 100644 index 0000000000..ded727176b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/control-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-event/control-id" +title: "control_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeEvent#control_id" + parent: "SignalWire::Relay::TranscribeEvent" + module: "SignalWire.Relay.TranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `control_id` + +Returns the value of attribute control\_id. + +## Signature + +```ruby +attr_reader control_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 457. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/duration.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/duration.mdx new file mode 100644 index 0000000000..ee3d1892ab --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/duration.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-event/duration" +title: "duration" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeEvent#duration" + parent: "SignalWire::Relay::TranscribeEvent" + module: "SignalWire.Relay.TranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `duration` + +Returns the value of attribute duration. + +## Signature + +```ruby +attr_reader duration -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 457. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/from-payload.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/from-payload.mdx new file mode 100644 index 0000000000..ee8707be42 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/from-payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-event/from-payload" +title: "from_payload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeEvent.from_payload" + parent: "SignalWire::Relay::TranscribeEvent" + module: "SignalWire.Relay.TranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `from_payload` + +## Signature + +```ruby +def from_payload(payload) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 459. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/index.mdx new file mode 100644 index 0000000000..afa00a877c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-event" +title: "TranscribeEvent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeEvent" + parent: "SignalWire::Relay" + module: "SignalWire.Relay" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `TranscribeEvent` + +calling.call.transcribe + +## Signature + +```ruby +class TranscribeEvent < SignalWire::Relay::RelayEvent +``` + +## Inheritance + +**Extends:** [SignalWire::Relay::RelayEvent](/reference/ruby/signal-wire/relay/relay-event) + +## Methods + + + + Returns the value of attribute control\_id. + + + + Returns the value of attribute duration. + + + + + + + + Returns the value of attribute recording\_id. + + + + Returns the value of attribute size. + + + + Returns the value of attribute state. + + + + Returns the value of attribute url. + + + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 456. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/initialize.mdx new file mode 100644 index 0000000000..2418bcd1ca --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/initialize.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-event/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeEvent#initialize" + parent: "SignalWire::Relay::TranscribeEvent" + module: "SignalWire.Relay.TranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(control_id: '', state: '', url: '', recording_id: '', duration: 0.0, size: 0, **base) +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`TranscribeEvent` — a new instance of TranscribeEvent + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 474. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/recording-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/recording-id.mdx new file mode 100644 index 0000000000..9d273df51a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/recording-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-event/recording-id" +title: "recording_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeEvent#recording_id" + parent: "SignalWire::Relay::TranscribeEvent" + module: "SignalWire.Relay.TranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `recording_id` + +Returns the value of attribute recording\_id. + +## Signature + +```ruby +attr_reader recording_id -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 457. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/size.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/size.mdx new file mode 100644 index 0000000000..b7d5e4695b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/size.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-event/size" +title: "size" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeEvent#size" + parent: "SignalWire::Relay::TranscribeEvent" + module: "SignalWire.Relay.TranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `size` + +Returns the value of attribute size. + +## Signature + +```ruby +attr_reader size -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 457. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/state.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/state.mdx new file mode 100644 index 0000000000..d7c0c193aa --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/state.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-event/state" +title: "state" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeEvent#state" + parent: "SignalWire::Relay::TranscribeEvent" + module: "SignalWire.Relay.TranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `state` + +Returns the value of attribute state. + +## Signature + +```ruby +attr_reader state -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 457. diff --git a/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/url.mdx b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/url.mdx new file mode 100644 index 0000000000..ee7bdcb6e3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/relay/transcribe-event/url.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/relay/transcribe-event/url" +title: "url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Relay::TranscribeEvent#url" + parent: "SignalWire::Relay::TranscribeEvent" + module: "SignalWire.Relay.TranscribeEvent" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb" + visibility: "public" +--- +# `url` + +Returns the value of attribute url. + +## Signature + +```ruby +attr_reader url -> Object +``` + +## Source + +[`lib/signalwire/relay/relay_event.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/relay/relay_event.rb) + +Line 457. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest-client.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest-client.mdx new file mode 100644 index 0000000000..64fe57cf20 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest-client.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/rest-client" +title: "RestClient" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire.RestClient" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire.rb" + visibility: "public" +--- +# `RestClient` + +Construct a \{SignalWire::REST::RestClient\} instance. + +Mirrors Python's top-level `signalwire.RestClient(*args, **kwargs)` +factory — a thin wrapper that lazy-imports +`signalwire.rest.RestClient` and instantiates it. Supports both +positional credentials (matching Go-style `RestClient(project, +token, host)`) and keyword credentials (Ruby-idiomatic). + +## Signature + +```ruby +def RestClient(*args, **kwargs) +``` + +## Parameters + + + Positional credentials (compat shim). + + + + Keyword credentials forwarded to the constructor. + + +## Returns + +`SignalWire::REST::RestClient` + +## Source + +[`lib/signalwire.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire.rb) + +Line 40. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/base-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/base-resource/index.mdx new file mode 100644 index 0000000000..d5a153294e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/base-resource/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/rest/base-resource" +title: "BaseResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::BaseResource" + parent: "SignalWire::REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `BaseResource` + +Base for all namespace/resource classes. + +## Signature + +```ruby +class BaseResource < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 114. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/base-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/base-resource/initialize.mdx new file mode 100644 index 0000000000..6b1dbb145d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/base-resource/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/rest/base-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::BaseResource#initialize" + parent: "SignalWire::REST::BaseResource" + module: "SignalWire.REST.BaseResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http, base_path) +``` + +## Parameters + + + + + +## Returns + +`BaseResource` — a new instance of BaseResource + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 115. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/create.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/create.mdx new file mode 100644 index 0000000000..71d6f83574 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/crud-resource/create" +title: "create" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::CrudResource#create" + parent: "SignalWire::REST::CrudResource" + module: "SignalWire.REST.CrudResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `create` + +## Signature + +```ruby +def create(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 141. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/delete.mdx new file mode 100644 index 0000000000..0ed79d4cf0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/crud-resource/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::CrudResource#delete" + parent: "SignalWire::REST::CrudResource" + module: "SignalWire.REST.CrudResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(resource_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 154. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/get.mdx new file mode 100644 index 0000000000..9cff3eaba7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/crud-resource/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::CrudResource#get" + parent: "SignalWire::REST::CrudResource" + module: "SignalWire.REST.CrudResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(resource_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 145. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/index.mdx new file mode 100644 index 0000000000..f458791a75 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/rest/crud-resource" +title: "CrudResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::CrudResource" + parent: "SignalWire::REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `CrudResource` + +Standard CRUD resource with list/create/get/update/delete. + +## Signature + +```ruby +class CrudResource < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 128. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/list.mdx new file mode 100644 index 0000000000..aba79aec6f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/crud-resource/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::CrudResource#list" + parent: "SignalWire::REST::CrudResource" + module: "SignalWire.REST.CrudResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 137. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/update-method.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/update-method.mdx new file mode 100644 index 0000000000..0dd0fc7db4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/update-method.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/rest/crud-resource/update-method" +title: "update_method" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::CrudResource.update_method" + parent: "SignalWire::REST::CrudResource" + module: "SignalWire.REST.CrudResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `update_method` + +## Signature + +```ruby +def update_method +``` + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 129. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/update-method__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/update-method__2.mdx new file mode 100644 index 0000000000..fc7dfd4dd7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/update-method__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/crud-resource/update-method__2" +title: "update_method=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::CrudResource.update_method=" + parent: "SignalWire::REST::CrudResource" + module: "SignalWire.REST.CrudResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `update_method=` + +## Signature + +```ruby +def update_method=(m) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 133. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/update.mdx new file mode 100644 index 0000000000..15cefed097 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/crud-resource/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/crud-resource/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::CrudResource#update" + parent: "SignalWire::REST::CrudResource" + module: "SignalWire.REST.CrudResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(resource_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 149. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/base-url.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/base-url.mdx new file mode 100644 index 0000000000..9cae1feb48 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/base-url.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/http-client/base-url" +title: "base_url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::HttpClient#base_url" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `base_url` + +Returns the value of attribute base\_url. + +## Signature + +```ruby +attr_reader base_url -> Object +``` + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/delete.mdx new file mode 100644 index 0000000000..9c52b8bad9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/http-client/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::HttpClient#delete" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(path) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 63. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/get.mdx new file mode 100644 index 0000000000..b14f574fc1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/get.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/http-client/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::HttpClient#get" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(path, params = nil) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 47. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/index.mdx new file mode 100644 index 0000000000..3db4d55135 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/ruby/signal-wire/rest/http-client" +title: "HttpClient" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::HttpClient" + parent: "SignalWire::REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `HttpClient` + +Thin wrapper around Net::HTTP with Basic Auth and JSON handling. + +## Signature + +```ruby +class HttpClient < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute base\_url. + + + + + + + + +base\_url+ overrides the derived +https://\{space\}+ value when set, which is how the audit fixture and tests point the client at a loopback server. Pass either +space+ ("acme") / a host ("acme.signalwire.com") OR an explicit +base\_url+ ("http://127.0.0.1:NNNN"). + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/initialize.mdx new file mode 100644 index 0000000000..104803e6ac --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/initialize.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/ruby/signal-wire/rest/http-client/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::HttpClient#initialize" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `initialize` + ++base\_url+ overrides the derived +https://\{space\}+ value when set, +which is how the audit fixture and tests point the client at a +loopback server. Pass either +space+ ("acme") / a host +("acme.signalwire.com") OR an explicit +base\_url+ ("http://127.0.0.1:NNNN"). + +## Signature + +```ruby +def initialize(project_id, token, space, base_url: nil) +``` + +## Parameters + + + + + + + + + +## Returns + +`HttpClient` — a new instance of HttpClient + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/patch.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/patch.mdx new file mode 100644 index 0000000000..df83d7fdac --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/patch.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/http-client/patch" +title: "patch" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::HttpClient#patch" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `patch` + +## Signature + +```ruby +def patch(path, body = nil) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 59. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/post.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/post.mdx new file mode 100644 index 0000000000..f2cb380717 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/post.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/http-client/post" +title: "post" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::HttpClient#post" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `post` + +## Signature + +```ruby +def post(path, body = nil, params: nil) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 51. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/project-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/project-id.mdx new file mode 100644 index 0000000000..3d645c62d0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/project-id.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/rest/http-client/project-id" +title: "project_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::HttpClient#project_id" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `project_id` + +## Signature + +```ruby +def project_id +``` + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 43. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/put.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/put.mdx new file mode 100644 index 0000000000..18284fd0b1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/http-client/put.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/http-client/put" +title: "put" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::HttpClient#put" + parent: "SignalWire::REST::HttpClient" + module: "SignalWire.REST.HttpClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `put` + +## Signature + +```ruby +def put(path, body = nil) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 55. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/index.mdx new file mode 100644 index 0000000000..b4236649fe --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/index.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/ruby/signal-wire/rest" +title: "REST" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::REST" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `REST` + +## Signature + +```ruby +module REST +``` + +## Classes + + + + Base for all namespace/resource classes. + + + + Standard CRUD resource with list/create/get/update/delete. + + + + Thin wrapper around Net::HTTP with Basic Auth and JSON handling. + + + + Iterates items across paginated API responses. + + + + REST client for the SignalWire platform APIs. + + + + Raised when the SignalWire REST API returns a non-2xx response. + + + +## Modules + + + + + + PhoneCallHandler -- enum-like constants of the +call\_handler+ values accepted by +phone\_numbers.update+. + + + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 4. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/create.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/create.mdx new file mode 100644 index 0000000000..abc4b7f4cd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/addresses-resource/create" +title: "create" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::AddressesResource#create" + parent: "SignalWire::REST::Namespaces::AddressesResource" + module: "SignalWire.REST.Namespaces.AddressesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb" + visibility: "public" +--- +# `create` + +## Signature + +```ruby +def create(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/addresses.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/delete.mdx new file mode 100644 index 0000000000..4c1487a22d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/addresses-resource/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::AddressesResource#delete" + parent: "SignalWire::REST::Namespaces::AddressesResource" + module: "SignalWire.REST.Namespaces.AddressesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(address_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/addresses.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/get.mdx new file mode 100644 index 0000000000..952d61d19a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/addresses-resource/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::AddressesResource#get" + parent: "SignalWire::REST::Namespaces::AddressesResource" + module: "SignalWire.REST.Namespaces.AddressesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(address_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/addresses.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/index.mdx new file mode 100644 index 0000000000..8affbbc0b8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/addresses-resource" +title: "AddressesResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::AddressesResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb" + visibility: "public" +--- +# `AddressesResource` + +Address management (no update endpoint). + +## Signature + +```ruby +class AddressesResource < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/addresses.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/initialize.mdx new file mode 100644 index 0000000000..23b37fef7f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/addresses-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::AddressesResource#initialize" + parent: "SignalWire::REST::Namespaces::AddressesResource" + module: "SignalWire.REST.Namespaces.AddressesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`AddressesResource` — a new instance of AddressesResource + +## Source + +[`lib/signalwire/rest/namespaces/addresses.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/list.mdx new file mode 100644 index 0000000000..4704b65b25 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/addresses-resource/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/addresses-resource/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::AddressesResource#list" + parent: "SignalWire::REST::Namespaces::AddressesResource" + module: "SignalWire.REST.Namespaces.AddressesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/addresses.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/addresses.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/auto-materialized-webhook/create.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/auto-materialized-webhook/create.mdx new file mode 100644 index 0000000000..e76a2e6d35 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/auto-materialized-webhook/create.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/auto-materialized-webhook/create" +title: "create" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::AutoMaterializedWebhook#create" + parent: "SignalWire::REST::Namespaces::AutoMaterializedWebhook" + module: "SignalWire.REST.Namespaces.AutoMaterializedWebhook" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" + deprecated: true +--- +# `create` + + + **Deprecated.** Creating a webhook Fabric resource directly produces an orphan that isn't bound to any phone number. Use the matching +phone\_numbers.set\_\*\_webhook+ helper instead; it updates the phone number and the server auto-materializes the resource. See porting-sdk's +phone-binding.md+. + + +## Signature + +```ruby +def create(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 35. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/auto-materialized-webhook/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/auto-materialized-webhook/index.mdx new file mode 100644 index 0000000000..1d62b7378a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/auto-materialized-webhook/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/auto-materialized-webhook" +title: "AutoMaterializedWebhook" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::AutoMaterializedWebhook" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `AutoMaterializedWebhook` + +Fabric webhook resource that's normally auto-created by ++phone\_numbers.set\_\*\_webhook+. Exposed for backwards compatibility. + +The binding model for these resources is on the phone number (see ++phone\_numbers.set\_swml\_webhook+ / +set\_cxml\_webhook+) -- setting ++call\_handler+ on a phone number auto-materializes the webhook +Fabric resource. Calling +create+ directly here produces an orphan +resource that isn't bound to any phone number. + +## Signature + +```ruby +class AutoMaterializedWebhook < SignalWire::REST::Namespaces::FabricResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::FabricResource](/reference/ruby/signal-wire/rest/namespaces/fabric-resource) + +## Constants + + + Subclasses override to advertise the correct helper in the warning. + + +## Methods + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 26. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/deploy-version.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/deploy-version.mdx new file mode 100644 index 0000000000..85d91aa9f7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/deploy-version.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/call-flows-resource/deploy-version" +title: "deploy_version" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallFlowsResource#deploy_version" + parent: "SignalWire::REST::Namespaces::CallFlowsResource" + module: "SignalWire.REST.Namespaces.CallFlowsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `deploy_version` + +## Signature + +```ruby +def deploy_version(resource_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 70. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/index.mdx new file mode 100644 index 0000000000..ef763feaad --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/call-flows-resource" +title: "CallFlowsResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallFlowsResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `CallFlowsResource` + +Call flows with version management. + +## Signature + +```ruby +class CallFlowsResource < SignalWire::REST::Namespaces::FabricResourcePUT +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::FabricResourcePUT](/reference/ruby/signal-wire/rest/namespaces/fabric-resource-put) + +## Methods + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 59. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/list-addresses.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/list-addresses.mdx new file mode 100644 index 0000000000..d1adb183b8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/list-addresses.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/call-flows-resource/list-addresses" +title: "list_addresses" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallFlowsResource#list_addresses" + parent: "SignalWire::REST::Namespaces::CallFlowsResource" + module: "SignalWire.REST.Namespaces.CallFlowsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `list_addresses` + +## Signature + +```ruby +def list_addresses(resource_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 60. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/list-versions.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/list-versions.mdx new file mode 100644 index 0000000000..9b5965fff4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/call-flows-resource/list-versions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/call-flows-resource/list-versions" +title: "list_versions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallFlowsResource#list_versions" + parent: "SignalWire::REST::Namespaces::CallFlowsResource" + module: "SignalWire.REST.Namespaces.CallFlowsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `list_versions` + +## Signature + +```ruby +def list_versions(resource_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 65. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-hold.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-hold.mdx new file mode 100644 index 0000000000..4f269af66a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-hold.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-hold" +title: "ai_hold" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#ai_hold" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `ai_hold` + +## Signature + +```ruby +def ai_hold(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 129. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-message.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-message.mdx new file mode 100644 index 0000000000..f73ccdf497 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-message" +title: "ai_message" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#ai_message" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `ai_message` + +AI + +## Signature + +```ruby +def ai_message(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 125. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-stop.mdx new file mode 100644 index 0000000000..2be0dbff23 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-stop" +title: "ai_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#ai_stop" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `ai_stop` + +## Signature + +```ruby +def ai_stop(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 137. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-unhold.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-unhold.mdx new file mode 100644 index 0000000000..ad89a022cf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-unhold.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/ai-unhold" +title: "ai_unhold" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#ai_unhold" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `ai_unhold` + +## Signature + +```ruby +def ai_unhold(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 133. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect-start-input-timers.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect-start-input-timers.mdx new file mode 100644 index 0000000000..3a1fbe7b10 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect-start-input-timers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect-start-input-timers" +title: "collect_start_input_timers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#collect_start_input_timers" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `collect_start_input_timers` + +## Signature + +```ruby +def collect_start_input_timers(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 75. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect-stop.mdx new file mode 100644 index 0000000000..c072dda562 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect-stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect-stop" +title: "collect_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#collect_stop" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `collect_stop` + +## Signature + +```ruby +def collect_stop(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 71. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect.mdx new file mode 100644 index 0000000000..cb014f6a60 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/collect" +title: "collect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#collect" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `collect` + +Collect + +## Signature + +```ruby +def collect(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 67. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/denoise-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/denoise-stop.mdx new file mode 100644 index 0000000000..6482a8520e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/denoise-stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/denoise-stop" +title: "denoise_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#denoise_stop" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `denoise_stop` + +## Signature + +```ruby +def denoise_stop(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 111. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/denoise.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/denoise.mdx new file mode 100644 index 0000000000..74684a9dd8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/denoise.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/denoise" +title: "denoise" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#denoise" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `denoise` + +Denoise + +## Signature + +```ruby +def denoise(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 107. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/detect-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/detect-stop.mdx new file mode 100644 index 0000000000..b03a8abcd4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/detect-stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/detect-stop" +title: "detect_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#detect_stop" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `detect_stop` + +## Signature + +```ruby +def detect_stop(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 84. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/detect.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/detect.mdx new file mode 100644 index 0000000000..22af563fe3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/detect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/detect" +title: "detect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#detect" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `detect` + +Detect + +## Signature + +```ruby +def detect(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 80. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/dial.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/dial.mdx new file mode 100644 index 0000000000..51c6534f19 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/dial.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/dial" +title: "dial" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#dial" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `dial` + +Call lifecycle + +## Signature + +```ruby +def dial(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/disconnect.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/disconnect.mdx new file mode 100644 index 0000000000..10898a5545 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/disconnect.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/disconnect" +title: "disconnect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#disconnect" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `disconnect` + +## Signature + +```ruby +def disconnect(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/end-call.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/end-call.mdx new file mode 100644 index 0000000000..0a7307e5d5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/end-call.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/end-call" +title: "end_call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#end_call" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `end_call` + +## Signature + +```ruby +def end_call(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/index.mdx new file mode 100644 index 0000000000..fbcb827da7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/index.mdx @@ -0,0 +1,142 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace" +title: "CallingNamespace" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `CallingNamespace` + +REST call control -- all 37 commands dispatched via single POST endpoint. + +## Signature + +```ruby +class CallingNamespace < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + AI + + + + + + + + Collect + + + + + + + + Denoise + + + + + + Detect + + + + + + Call lifecycle + + + + + + + + + + Live transcribe / translate + + + + + + Play + + + + + + + + + + + + + + Record + + + + + + + + + + SIP + + + + Fax + + + + Stream + + + + + + Tap + + + + + + Transcribe + + + + + + + + + + Custom events + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/initialize.mdx new file mode 100644 index 0000000000..98dd863efd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#initialize" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`CallingNamespace` — a new instance of CallingNamespace + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/live-transcribe.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/live-transcribe.mdx new file mode 100644 index 0000000000..68794c0f81 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/live-transcribe.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/live-transcribe" +title: "live_transcribe" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#live_transcribe" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `live_transcribe` + +Live transcribe / translate + +## Signature + +```ruby +def live_transcribe(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 142. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/live-translate.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/live-translate.mdx new file mode 100644 index 0000000000..bcc8565a1e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/live-translate.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/live-translate" +title: "live_translate" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#live_translate" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `live_translate` + +## Signature + +```ruby +def live_translate(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 146. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-pause.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-pause.mdx new file mode 100644 index 0000000000..c8e2802046 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-pause.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-pause" +title: "play_pause" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#play_pause" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `play_pause` + +## Signature + +```ruby +def play_pause(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 33. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-resume.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-resume.mdx new file mode 100644 index 0000000000..2061adbd8c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-resume.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-resume" +title: "play_resume" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#play_resume" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `play_resume` + +## Signature + +```ruby +def play_resume(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 37. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-stop.mdx new file mode 100644 index 0000000000..f8ab355135 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-stop" +title: "play_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#play_stop" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `play_stop` + +## Signature + +```ruby +def play_stop(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 41. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-volume.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-volume.mdx new file mode 100644 index 0000000000..31b064c232 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-volume.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/play-volume" +title: "play_volume" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#play_volume" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `play_volume` + +## Signature + +```ruby +def play_volume(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 45. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play.mdx new file mode 100644 index 0000000000..7163c76071 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/play.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/play" +title: "play" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#play" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `play` + +Play + +## Signature + +```ruby +def play(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/receive-fax-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/receive-fax-stop.mdx new file mode 100644 index 0000000000..e546aaa017 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/receive-fax-stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/receive-fax-stop" +title: "receive_fax_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#receive_fax_stop" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `receive_fax_stop` + +## Signature + +```ruby +def receive_fax_stop(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 155. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-pause.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-pause.mdx new file mode 100644 index 0000000000..b0925c6399 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-pause.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-pause" +title: "record_pause" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#record_pause" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `record_pause` + +## Signature + +```ruby +def record_pause(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 54. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-resume.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-resume.mdx new file mode 100644 index 0000000000..132c4c7558 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-resume.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-resume" +title: "record_resume" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#record_resume" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `record_resume` + +## Signature + +```ruby +def record_resume(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 58. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-stop.mdx new file mode 100644 index 0000000000..75771cbc66 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/record-stop" +title: "record_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#record_stop" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `record_stop` + +## Signature + +```ruby +def record_stop(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 62. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record.mdx new file mode 100644 index 0000000000..912047f2e5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/record.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/record" +title: "record" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#record" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `record` + +Record + +## Signature + +```ruby +def record(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/refer.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/refer.mdx new file mode 100644 index 0000000000..ac3618d1e5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/refer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/refer" +title: "refer" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#refer" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `refer` + +SIP + +## Signature + +```ruby +def refer(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 160. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/send-fax-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/send-fax-stop.mdx new file mode 100644 index 0000000000..11cfba8025 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/send-fax-stop.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/send-fax-stop" +title: "send_fax_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#send_fax_stop" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `send_fax_stop` + +Fax + +## Signature + +```ruby +def send_fax_stop(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 151. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/stream-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/stream-stop.mdx new file mode 100644 index 0000000000..035ac00d60 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/stream-stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/stream-stop" +title: "stream_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#stream_stop" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `stream_stop` + +## Signature + +```ruby +def stream_stop(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 102. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/stream.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/stream.mdx new file mode 100644 index 0000000000..6022621650 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/stream.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/stream" +title: "stream" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#stream" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `stream` + +Stream + +## Signature + +```ruby +def stream(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 98. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/tap-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/tap-stop.mdx new file mode 100644 index 0000000000..fd24b0e283 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/tap-stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/tap-stop" +title: "tap_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#tap_stop" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `tap_stop` + +## Signature + +```ruby +def tap_stop(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 93. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/tap.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/tap.mdx new file mode 100644 index 0000000000..114b0a3832 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/tap.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/tap" +title: "tap" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#tap" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `tap` + +Tap + +## Signature + +```ruby +def tap(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 89. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/transcribe-stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/transcribe-stop.mdx new file mode 100644 index 0000000000..ce52d58fb9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/transcribe-stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/transcribe-stop" +title: "transcribe_stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#transcribe_stop" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `transcribe_stop` + +## Signature + +```ruby +def transcribe_stop(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 120. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/transcribe.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/transcribe.mdx new file mode 100644 index 0000000000..7335aed43e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/transcribe.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/transcribe" +title: "transcribe" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#transcribe" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `transcribe` + +Transcribe + +## Signature + +```ruby +def transcribe(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 116. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/transfer.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/transfer.mdx new file mode 100644 index 0000000000..461e22b1df --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/transfer.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/transfer" +title: "transfer" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#transfer" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `transfer` + +## Signature + +```ruby +def transfer(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 20. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/update.mdx new file mode 100644 index 0000000000..8499644edc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/update.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#update" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/user-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/user-event.mdx new file mode 100644 index 0000000000..8821910398 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/calling-namespace/user-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/calling-namespace/user-event" +title: "user_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CallingNamespace#user_event" + parent: "SignalWire::REST::Namespaces::CallingNamespace" + module: "SignalWire.REST.Namespaces.CallingNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb" + visibility: "public" +--- +# `user_event` + +Custom events + +## Signature + +```ruby +def user_event(call_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/calling.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/calling.rb) + +Line 165. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/chat-resource/create-token.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/chat-resource/create-token.mdx new file mode 100644 index 0000000000..31f5b8cb88 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/chat-resource/create-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/chat-resource/create-token" +title: "create_token" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ChatResource#create_token" + parent: "SignalWire::REST::Namespaces::ChatResource" + module: "SignalWire.REST.Namespaces.ChatResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/chat.rb" + visibility: "public" +--- +# `create_token` + +## Signature + +```ruby +def create_token(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/chat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/chat.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/chat-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/chat-resource/index.mdx new file mode 100644 index 0000000000..67a683b62f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/chat-resource/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/chat-resource" +title: "ChatResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ChatResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/chat.rb" + visibility: "public" +--- +# `ChatResource` + +Chat token generation. + +## Signature + +```ruby +class ChatResource < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/chat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/chat.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/chat-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/chat-resource/initialize.mdx new file mode 100644 index 0000000000..6c1a97672b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/chat-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/chat-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ChatResource#initialize" + parent: "SignalWire::REST::Namespaces::ChatResource" + module: "SignalWire.REST.Namespaces.ChatResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/chat.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`ChatResource` — a new instance of ChatResource + +## Source + +[`lib/signalwire/rest/namespaces/chat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/chat.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/create.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/create.mdx new file mode 100644 index 0000000000..b60013bdb0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-accounts/create" +title: "create" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatAccounts#create" + parent: "SignalWire::REST::Namespaces::CompatAccounts" + module: "SignalWire.REST.Namespaces.CompatAccounts" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `create` + +## Signature + +```ruby +def create(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/get.mdx new file mode 100644 index 0000000000..97eb8736f0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-accounts/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatAccounts#get" + parent: "SignalWire::REST::Namespaces::CompatAccounts" + module: "SignalWire.REST.Namespaces.CompatAccounts" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(sid) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/index.mdx new file mode 100644 index 0000000000..a90e314b38 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-accounts" +title: "CompatAccounts" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatAccounts" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatAccounts` + +Compat account/subproject management. + +## Signature + +```ruby +class CompatAccounts < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/initialize.mdx new file mode 100644 index 0000000000..8dd43a463b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-accounts/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatAccounts#initialize" + parent: "SignalWire::REST::Namespaces::CompatAccounts" + module: "SignalWire.REST.Namespaces.CompatAccounts" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`CompatAccounts` — a new instance of CompatAccounts + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/list.mdx new file mode 100644 index 0000000000..6df111f210 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-accounts/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatAccounts#list" + parent: "SignalWire::REST::Namespaces::CompatAccounts" + module: "SignalWire.REST.Namespaces.CompatAccounts" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/update.mdx new file mode 100644 index 0000000000..3bc0065586 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-accounts/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-accounts/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatAccounts#update" + parent: "SignalWire::REST::Namespaces::CompatAccounts" + module: "SignalWire.REST.Namespaces.CompatAccounts" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(sid, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-applications/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-applications/index.mdx new file mode 100644 index 0000000000..9a07c7d5e1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-applications/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-applications" +title: "CompatApplications" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatApplications" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatApplications` + +Compat application management. + +## Signature + +```ruby +class CompatApplications < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 157. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-applications/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-applications/update.mdx new file mode 100644 index 0000000000..d322122782 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-applications/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-applications/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatApplications#update" + parent: "SignalWire::REST::Namespaces::CompatApplications" + module: "SignalWire.REST.Namespaces.CompatApplications" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(sid, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 158. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/index.mdx new file mode 100644 index 0000000000..1fe574db32 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-calls" +title: "CompatCalls" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatCalls" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatCalls` + +Compat call management with recording and stream sub-resources. + +## Signature + +```ruby +class CompatCalls < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 19. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/start-recording.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/start-recording.mdx new file mode 100644 index 0000000000..264bbd6131 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/start-recording.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-calls/start-recording" +title: "start_recording" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatCalls#start_recording" + parent: "SignalWire::REST::Namespaces::CompatCalls" + module: "SignalWire.REST.Namespaces.CompatCalls" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `start_recording` + +## Signature + +```ruby +def start_recording(call_sid, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/start-stream.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/start-stream.mdx new file mode 100644 index 0000000000..dc9fb77319 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/start-stream.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-calls/start-stream" +title: "start_stream" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatCalls#start_stream" + parent: "SignalWire::REST::Namespaces::CompatCalls" + module: "SignalWire.REST.Namespaces.CompatCalls" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `start_stream` + +## Signature + +```ruby +def start_stream(call_sid, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 32. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/stop-stream.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/stop-stream.mdx new file mode 100644 index 0000000000..70ce19c9ea --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/stop-stream.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-calls/stop-stream" +title: "stop_stream" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatCalls#stop_stream" + parent: "SignalWire::REST::Namespaces::CompatCalls" + module: "SignalWire.REST.Namespaces.CompatCalls" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `stop_stream` + +## Signature + +```ruby +def stop_stream(call_sid, stream_sid, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 36. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/update-recording.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/update-recording.mdx new file mode 100644 index 0000000000..180ae091ca --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/update-recording.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-calls/update-recording" +title: "update_recording" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatCalls#update_recording" + parent: "SignalWire::REST::Namespaces::CompatCalls" + module: "SignalWire.REST.Namespaces.CompatCalls" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update_recording` + +## Signature + +```ruby +def update_recording(call_sid, recording_sid, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 28. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/update.mdx new file mode 100644 index 0000000000..1b25db94da --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-calls/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-calls/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatCalls#update" + parent: "SignalWire::REST::Namespaces::CompatCalls" + module: "SignalWire.REST.Namespaces.CompatCalls" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(sid, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 20. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/delete-recording.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/delete-recording.mdx new file mode 100644 index 0000000000..28378f919f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/delete-recording.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/delete-recording" +title: "delete_recording" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#delete_recording" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `delete_recording` + +## Signature + +```ruby +def delete_recording(conference_sid, recording_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 111. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/get-participant.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/get-participant.mdx new file mode 100644 index 0000000000..143577386d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/get-participant.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/get-participant" +title: "get_participant" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#get_participant" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `get_participant` + +## Signature + +```ruby +def get_participant(conference_sid, call_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 86. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/get-recording.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/get-recording.mdx new file mode 100644 index 0000000000..e315811fa2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/get-recording.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/get-recording" +title: "get_recording" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#get_recording" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `get_recording` + +## Signature + +```ruby +def get_recording(conference_sid, recording_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 103. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/get.mdx new file mode 100644 index 0000000000..686300284b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#get" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(sid) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 78. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/index.mdx new file mode 100644 index 0000000000..b02fdbf28f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/index.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences" +title: "CompatConferences" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatConferences` + +Compat conference management. + +## Signature + +```ruby +class CompatConferences < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + + + + Participants + + + + Conference recordings + + + + + + Conference streams + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 76. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/list-participants.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/list-participants.mdx new file mode 100644 index 0000000000..66f39e8c76 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/list-participants.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/list-participants" +title: "list_participants" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#list_participants" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `list_participants` + +Participants + +## Signature + +```ruby +def list_participants(conference_sid, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 82. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/list-recordings.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/list-recordings.mdx new file mode 100644 index 0000000000..e0ee7e8a41 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/list-recordings.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/list-recordings" +title: "list_recordings" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#list_recordings" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `list_recordings` + +Conference recordings + +## Signature + +```ruby +def list_recordings(conference_sid, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 99. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/list.mdx new file mode 100644 index 0000000000..d34a892f8c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#list" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 77. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/remove-participant.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/remove-participant.mdx new file mode 100644 index 0000000000..ced6239e9a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/remove-participant.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/remove-participant" +title: "remove_participant" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#remove_participant" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `remove_participant` + +## Signature + +```ruby +def remove_participant(conference_sid, call_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 94. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/start-stream.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/start-stream.mdx new file mode 100644 index 0000000000..b2bfcbf634 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/start-stream.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/start-stream" +title: "start_stream" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#start_stream" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `start_stream` + +Conference streams + +## Signature + +```ruby +def start_stream(conference_sid, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 116. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/stop-stream.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/stop-stream.mdx new file mode 100644 index 0000000000..79c4264683 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/stop-stream.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/stop-stream" +title: "stop_stream" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#stop_stream" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `stop_stream` + +## Signature + +```ruby +def stop_stream(conference_sid, stream_sid, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 120. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/update-participant.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/update-participant.mdx new file mode 100644 index 0000000000..80086c82c6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/update-participant.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/update-participant" +title: "update_participant" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#update_participant" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update_participant` + +## Signature + +```ruby +def update_participant(conference_sid, call_sid, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 90. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/update-recording.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/update-recording.mdx new file mode 100644 index 0000000000..b8a954739b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/update-recording.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/update-recording" +title: "update_recording" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#update_recording" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update_recording` + +## Signature + +```ruby +def update_recording(conference_sid, recording_sid, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 107. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/update.mdx new file mode 100644 index 0000000000..2e6899fe85 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-conferences/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-conferences/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatConferences#update" + parent: "SignalWire::REST::Namespaces::CompatConferences" + module: "SignalWire.REST.Namespaces.CompatConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(sid, **kw) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 79. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/delete-media.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/delete-media.mdx new file mode 100644 index 0000000000..26beb60c17 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/delete-media.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-faxes/delete-media" +title: "delete_media" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatFaxes#delete_media" + parent: "SignalWire::REST::Namespaces::CompatFaxes" + module: "SignalWire.REST.Namespaces.CompatFaxes" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `delete_media` + +## Signature + +```ruby +def delete_media(fax_sid, media_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 70. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/get-media.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/get-media.mdx new file mode 100644 index 0000000000..2e8b4f99db --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/get-media.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-faxes/get-media" +title: "get_media" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatFaxes#get_media" + parent: "SignalWire::REST::Namespaces::CompatFaxes" + module: "SignalWire.REST.Namespaces.CompatFaxes" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `get_media` + +## Signature + +```ruby +def get_media(fax_sid, media_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 66. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/index.mdx new file mode 100644 index 0000000000..c2cf8deea8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-faxes" +title: "CompatFaxes" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatFaxes" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatFaxes` + +Compat fax management with media sub-resources. + +## Signature + +```ruby +class CompatFaxes < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 59. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/list-media.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/list-media.mdx new file mode 100644 index 0000000000..704f13ba81 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/list-media.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-faxes/list-media" +title: "list_media" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatFaxes#list_media" + parent: "SignalWire::REST::Namespaces::CompatFaxes" + module: "SignalWire.REST.Namespaces.CompatFaxes" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `list_media` + +## Signature + +```ruby +def list_media(fax_sid, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 62. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/update.mdx new file mode 100644 index 0000000000..0622ca4719 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-faxes/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-faxes/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatFaxes#update" + parent: "SignalWire::REST::Namespaces::CompatFaxes" + module: "SignalWire.REST.Namespaces.CompatFaxes" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(sid, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 60. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-laml-bins/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-laml-bins/index.mdx new file mode 100644 index 0000000000..faa1775aa6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-laml-bins/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-laml-bins" +title: "CompatLamlBins" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatLamlBins" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatLamlBins` + +Compat cXML/LaML script management. + +## Signature + +```ruby +class CompatLamlBins < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 162. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-laml-bins/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-laml-bins/update.mdx new file mode 100644 index 0000000000..5a19f3f478 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-laml-bins/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-laml-bins/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatLamlBins#update" + parent: "SignalWire::REST::Namespaces::CompatLamlBins" + module: "SignalWire.REST.Namespaces.CompatLamlBins" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(sid, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 163. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/delete-media.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/delete-media.mdx new file mode 100644 index 0000000000..c753ce4c3f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/delete-media.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-messages/delete-media" +title: "delete_media" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatMessages#delete_media" + parent: "SignalWire::REST::Namespaces::CompatMessages" + module: "SignalWire.REST.Namespaces.CompatMessages" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `delete_media` + +## Signature + +```ruby +def delete_media(message_sid, media_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 53. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/get-media.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/get-media.mdx new file mode 100644 index 0000000000..96c0be7949 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/get-media.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-messages/get-media" +title: "get_media" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatMessages#get_media" + parent: "SignalWire::REST::Namespaces::CompatMessages" + module: "SignalWire.REST.Namespaces.CompatMessages" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `get_media` + +## Signature + +```ruby +def get_media(message_sid, media_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/index.mdx new file mode 100644 index 0000000000..8f32dcd641 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-messages" +title: "CompatMessages" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatMessages" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatMessages` + +Compat message management with media sub-resources. + +## Signature + +```ruby +class CompatMessages < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 42. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/list-media.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/list-media.mdx new file mode 100644 index 0000000000..bcc4d0b40f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/list-media.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-messages/list-media" +title: "list_media" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatMessages#list_media" + parent: "SignalWire::REST::Namespaces::CompatMessages" + module: "SignalWire.REST.Namespaces.CompatMessages" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `list_media` + +## Signature + +```ruby +def list_media(message_sid, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 45. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/update.mdx new file mode 100644 index 0000000000..2c11b47520 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-messages/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-messages/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatMessages#update" + parent: "SignalWire::REST::Namespaces::CompatMessages" + module: "SignalWire.REST.Namespaces.CompatMessages" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(sid, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 43. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/accounts.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/accounts.mdx new file mode 100644 index 0000000000..49a401387f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/accounts.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/accounts" +title: "accounts" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#accounts" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `accounts` + +Returns the value of attribute accounts. + +## Signature + +```ruby +attr_reader accounts -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/applications.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/applications.mdx new file mode 100644 index 0000000000..9a7a0c4d32 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/applications.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/applications" +title: "applications" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#applications" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `applications` + +Returns the value of attribute applications. + +## Signature + +```ruby +attr_reader applications -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/calls.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/calls.mdx new file mode 100644 index 0000000000..57d9413bb8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/calls.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/calls" +title: "calls" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#calls" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `calls` + +Returns the value of attribute calls. + +## Signature + +```ruby +attr_reader calls -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/conferences.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/conferences.mdx new file mode 100644 index 0000000000..5a87bc75de --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/conferences.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/conferences" +title: "conferences" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#conferences" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `conferences` + +Returns the value of attribute conferences. + +## Signature + +```ruby +attr_reader conferences -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/faxes.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/faxes.mdx new file mode 100644 index 0000000000..1e356f2d92 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/faxes.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/faxes" +title: "faxes" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#faxes" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `faxes` + +Returns the value of attribute faxes. + +## Signature + +```ruby +attr_reader faxes -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/index.mdx new file mode 100644 index 0000000000..2c9b02e1a1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/index.mdx @@ -0,0 +1,88 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace" +title: "CompatNamespace" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatNamespace` + +Twilio-compatible LAML API namespace. + +## Signature + +```ruby +class CompatNamespace < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute accounts. + + + + Returns the value of attribute applications. + + + + Returns the value of attribute calls. + + + + Returns the value of attribute conferences. + + + + Returns the value of attribute faxes. + + + + + + Returns the value of attribute laml\_bins. + + + + Returns the value of attribute messages. + + + + Returns the value of attribute phone\_numbers. + + + + Returns the value of attribute queues. + + + + Returns the value of attribute recordings. + + + + Returns the value of attribute tokens. + + + + Returns the value of attribute transcriptions. + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 205. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/initialize.mdx new file mode 100644 index 0000000000..a68c94f084 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#initialize" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http, account_sid) +``` + +## Parameters + + + + + +## Returns + +`CompatNamespace` — a new instance of CompatNamespace + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 210. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/laml-bins.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/laml-bins.mdx new file mode 100644 index 0000000000..929db184ff --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/laml-bins.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/laml-bins" +title: "laml_bins" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#laml_bins" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `laml_bins` + +Returns the value of attribute laml\_bins. + +## Signature + +```ruby +attr_reader laml_bins -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/messages.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/messages.mdx new file mode 100644 index 0000000000..19fee60606 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/messages.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/messages" +title: "messages" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#messages" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `messages` + +Returns the value of attribute messages. + +## Signature + +```ruby +attr_reader messages -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/phone-numbers.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/phone-numbers.mdx new file mode 100644 index 0000000000..1d225c2be9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/phone-numbers.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/phone-numbers" +title: "phone_numbers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#phone_numbers" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `phone_numbers` + +Returns the value of attribute phone\_numbers. + +## Signature + +```ruby +attr_reader phone_numbers -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/queues.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/queues.mdx new file mode 100644 index 0000000000..af13ad0324 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/queues.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/queues" +title: "queues" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#queues" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `queues` + +Returns the value of attribute queues. + +## Signature + +```ruby +attr_reader queues -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/recordings.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/recordings.mdx new file mode 100644 index 0000000000..2edd5c63de --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/recordings.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/recordings" +title: "recordings" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#recordings" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `recordings` + +Returns the value of attribute recordings. + +## Signature + +```ruby +attr_reader recordings -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/tokens.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/tokens.mdx new file mode 100644 index 0000000000..929c1634d8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/tokens.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/tokens" +title: "tokens" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#tokens" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `tokens` + +Returns the value of attribute tokens. + +## Signature + +```ruby +attr_reader tokens -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/transcriptions.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/transcriptions.mdx new file mode 100644 index 0000000000..aa793702b2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-namespace/transcriptions.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-namespace/transcriptions" +title: "transcriptions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatNamespace#transcriptions" + parent: "SignalWire::REST::Namespaces::CompatNamespace" + module: "SignalWire.REST.Namespaces.CompatNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `transcriptions` + +Returns the value of attribute transcriptions. + +## Signature + +```ruby +attr_reader transcriptions -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/delete.mdx new file mode 100644 index 0000000000..d012ce20b9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatPhoneNumbers#delete" + parent: "SignalWire::REST::Namespaces::CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(sid) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 136. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/get.mdx new file mode 100644 index 0000000000..606fc7a58f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatPhoneNumbers#get" + parent: "SignalWire::REST::Namespaces::CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(sid) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 134. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/import-number.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/import-number.mdx new file mode 100644 index 0000000000..178d140d83 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/import-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/import-number" +title: "import_number" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatPhoneNumbers#import_number" + parent: "SignalWire::REST::Namespaces::CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `import_number` + +## Signature + +```ruby +def import_number(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 138. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/index.mdx new file mode 100644 index 0000000000..0395e6839f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers" +title: "CompatPhoneNumbers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatPhoneNumbers" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatPhoneNumbers` + +Compat phone number management. + +## Signature + +```ruby +class CompatPhoneNumbers < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 126. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/initialize.mdx new file mode 100644 index 0000000000..9c009d514d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatPhoneNumbers#initialize" + parent: "SignalWire::REST::Namespaces::CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http, base) +``` + +## Parameters + + + + + +## Returns + +`CompatPhoneNumbers` — a new instance of CompatPhoneNumbers + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 127. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/list-available-countries.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/list-available-countries.mdx new file mode 100644 index 0000000000..d26f1f84da --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/list-available-countries.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/list-available-countries" +title: "list_available_countries" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatPhoneNumbers#list_available_countries" + parent: "SignalWire::REST::Namespaces::CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `list_available_countries` + +## Signature + +```ruby +def list_available_countries(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 143. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/list.mdx new file mode 100644 index 0000000000..455e70ab02 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatPhoneNumbers#list" + parent: "SignalWire::REST::Namespaces::CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 132. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/purchase.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/purchase.mdx new file mode 100644 index 0000000000..677cc67664 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/purchase.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/purchase" +title: "purchase" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatPhoneNumbers#purchase" + parent: "SignalWire::REST::Namespaces::CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `purchase` + +## Signature + +```ruby +def purchase(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 133. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/search-local.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/search-local.mdx new file mode 100644 index 0000000000..c60d6d6f8e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/search-local.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/search-local" +title: "search_local" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatPhoneNumbers#search_local" + parent: "SignalWire::REST::Namespaces::CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `search_local` + +## Signature + +```ruby +def search_local(country, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 147. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/search-toll-free.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/search-toll-free.mdx new file mode 100644 index 0000000000..14e8ca6261 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/search-toll-free.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/search-toll-free" +title: "search_toll_free" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatPhoneNumbers#search_toll_free" + parent: "SignalWire::REST::Namespaces::CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `search_toll_free` + +## Signature + +```ruby +def search_toll_free(country, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 151. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/update.mdx new file mode 100644 index 0000000000..f92bd56469 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-phone-numbers/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatPhoneNumbers#update" + parent: "SignalWire::REST::Namespaces::CompatPhoneNumbers" + module: "SignalWire.REST.Namespaces.CompatPhoneNumbers" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(sid, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 135. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/dequeue-member.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/dequeue-member.mdx new file mode 100644 index 0000000000..9f490aaa2f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/dequeue-member.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-queues/dequeue-member" +title: "dequeue_member" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatQueues#dequeue_member" + parent: "SignalWire::REST::Namespaces::CompatQueues" + module: "SignalWire.REST.Namespaces.CompatQueues" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `dequeue_member` + +## Signature + +```ruby +def dequeue_member(queue_sid, call_sid, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 178. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/get-member.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/get-member.mdx new file mode 100644 index 0000000000..b0ff65c93e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/get-member.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-queues/get-member" +title: "get_member" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatQueues#get_member" + parent: "SignalWire::REST::Namespaces::CompatQueues" + module: "SignalWire.REST.Namespaces.CompatQueues" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `get_member` + +## Signature + +```ruby +def get_member(queue_sid, call_sid) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 174. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/index.mdx new file mode 100644 index 0000000000..f9a743826b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-queues" +title: "CompatQueues" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatQueues" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatQueues` + +Compat queue management with members. + +## Signature + +```ruby +class CompatQueues < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 167. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/list-members.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/list-members.mdx new file mode 100644 index 0000000000..4d5de3620c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/list-members.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-queues/list-members" +title: "list_members" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatQueues#list_members" + parent: "SignalWire::REST::Namespaces::CompatQueues" + module: "SignalWire.REST.Namespaces.CompatQueues" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `list_members` + +## Signature + +```ruby +def list_members(queue_sid, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 170. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/update.mdx new file mode 100644 index 0000000000..39fcd492fd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-queues/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-queues/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatQueues#update" + parent: "SignalWire::REST::Namespaces::CompatQueues" + module: "SignalWire.REST.Namespaces.CompatQueues" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(sid, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 168. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/delete.mdx new file mode 100644 index 0000000000..b42f487947 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-recordings/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatRecordings#delete" + parent: "SignalWire::REST::Namespaces::CompatRecordings" + module: "SignalWire.REST.Namespaces.CompatRecordings" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(sid) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 187. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/get.mdx new file mode 100644 index 0000000000..014d74a2e7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-recordings/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatRecordings#get" + parent: "SignalWire::REST::Namespaces::CompatRecordings" + module: "SignalWire.REST.Namespaces.CompatRecordings" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(sid) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 186. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/index.mdx new file mode 100644 index 0000000000..02fab1af9e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-recordings" +title: "CompatRecordings" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatRecordings" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatRecordings` + +Compat recording management. + +## Signature + +```ruby +class CompatRecordings < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 184. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/list.mdx new file mode 100644 index 0000000000..2fa14053f0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-recordings/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-recordings/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatRecordings#list" + parent: "SignalWire::REST::Namespaces::CompatRecordings" + module: "SignalWire.REST.Namespaces.CompatRecordings" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 185. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/create.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/create.mdx new file mode 100644 index 0000000000..0dcaada594 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-tokens/create" +title: "create" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatTokens#create" + parent: "SignalWire::REST::Namespaces::CompatTokens" + module: "SignalWire.REST.Namespaces.CompatTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `create` + +## Signature + +```ruby +def create(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 199. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/delete.mdx new file mode 100644 index 0000000000..9b11877ca2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-tokens/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatTokens#delete" + parent: "SignalWire::REST::Namespaces::CompatTokens" + module: "SignalWire.REST.Namespaces.CompatTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(token_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 201. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/index.mdx new file mode 100644 index 0000000000..6d00e3cf21 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-tokens" +title: "CompatTokens" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatTokens" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatTokens` + +Compat API token management. + +## Signature + +```ruby +class CompatTokens < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/update.mdx new file mode 100644 index 0000000000..f4e9dd97b3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-tokens/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-tokens/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatTokens#update" + parent: "SignalWire::REST::Namespaces::CompatTokens" + module: "SignalWire.REST.Namespaces.CompatTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(token_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 200. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/delete.mdx new file mode 100644 index 0000000000..3ecb367dfe --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatTranscriptions#delete" + parent: "SignalWire::REST::Namespaces::CompatTranscriptions" + module: "SignalWire.REST.Namespaces.CompatTranscriptions" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(sid) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 194. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/get.mdx new file mode 100644 index 0000000000..762b40e209 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatTranscriptions#get" + parent: "SignalWire::REST::Namespaces::CompatTranscriptions" + module: "SignalWire.REST.Namespaces.CompatTranscriptions" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(sid) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 193. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/index.mdx new file mode 100644 index 0000000000..3180f2adec --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-transcriptions" +title: "CompatTranscriptions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatTranscriptions" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `CompatTranscriptions` + +Compat transcription management. + +## Signature + +```ruby +class CompatTranscriptions < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 191. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/list.mdx new file mode 100644 index 0000000000..751fac0344 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/compat-transcriptions/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CompatTranscriptions#list" + parent: "SignalWire::REST::Namespaces::CompatTranscriptions" + module: "SignalWire.REST.Namespaces.CompatTranscriptions" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/compat.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/compat.rb) + +Line 192. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-logs/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-logs/index.mdx new file mode 100644 index 0000000000..21874e16d8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-logs/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/conference-logs" +title: "ConferenceLogs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ConferenceLogs" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `ConferenceLogs` + +Conference log queries. + +## Signature + +```ruby +class ConferenceLogs < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-logs/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-logs/list.mdx new file mode 100644 index 0000000000..19560cbce8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-logs/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/conference-logs/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ConferenceLogs#list" + parent: "SignalWire::REST::Namespaces::ConferenceLogs" + module: "SignalWire.REST.Namespaces.ConferenceLogs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 30. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-rooms-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-rooms-resource/index.mdx new file mode 100644 index 0000000000..4d19b49fe1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-rooms-resource/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/conference-rooms-resource" +title: "ConferenceRoomsResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ConferenceRoomsResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `ConferenceRoomsResource` + +Conference rooms -- uses singular 'conference\_room' for sub-resource paths. + +## Signature + +```ruby +class ConferenceRoomsResource < SignalWire::REST::Namespaces::FabricResourcePUT +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::FabricResourcePUT](/reference/ruby/signal-wire/rest/namespaces/fabric-resource-put) + +## Methods + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 77. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-rooms-resource/list-addresses.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-rooms-resource/list-addresses.mdx new file mode 100644 index 0000000000..ca5cc896e8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/conference-rooms-resource/list-addresses.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/conference-rooms-resource/list-addresses" +title: "list_addresses" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ConferenceRoomsResource#list_addresses" + parent: "SignalWire::REST::Namespaces::ConferenceRoomsResource" + module: "SignalWire.REST.Namespaces.ConferenceRoomsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `list_addresses` + +## Signature + +```ruby +def list_addresses(resource_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 78. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/cxml-applications-resource/create.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/cxml-applications-resource/create.mdx new file mode 100644 index 0000000000..2594b78484 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/cxml-applications-resource/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/cxml-applications-resource/create" +title: "create" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CxmlApplicationsResource#create" + parent: "SignalWire::REST::Namespaces::CxmlApplicationsResource" + module: "SignalWire.REST.Namespaces.CxmlApplicationsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `create` + +## Signature + +```ruby +def create(**_kwargs) +``` + +## Parameters + + + +## Throws + +- `NotImplementedError` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 109. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/cxml-applications-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/cxml-applications-resource/index.mdx new file mode 100644 index 0000000000..789426dc91 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/cxml-applications-resource/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/cxml-applications-resource" +title: "CxmlApplicationsResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CxmlApplicationsResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `CxmlApplicationsResource` + +cXML applications -- no create method. + +## Signature + +```ruby +class CxmlApplicationsResource < SignalWire::REST::Namespaces::FabricResourcePUT +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::FabricResourcePUT](/reference/ruby/signal-wire/rest/namespaces/fabric-resource-put) + +## Methods + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 108. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/cxml-webhooks-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/cxml-webhooks-resource/index.mdx new file mode 100644 index 0000000000..43d0a5771e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/cxml-webhooks-resource/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/cxml-webhooks-resource" +title: "CxmlWebhooksResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::CxmlWebhooksResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `CxmlWebhooksResource` + +cXML webhooks -- auto-materialized by +phone\_numbers.set\_cxml\_webhook+. + +## Signature + +```ruby +class CxmlWebhooksResource < SignalWire::REST::Namespaces::AutoMaterializedWebhook +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::AutoMaterializedWebhook](/reference/ruby/signal-wire/rest/namespaces/auto-materialized-webhook) + +## Constants + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 54. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/delete-chunk.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/delete-chunk.mdx new file mode 100644 index 0000000000..e990d56699 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/delete-chunk.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/datasphere-documents/delete-chunk" +title: "delete_chunk" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::DatasphereDocuments#delete_chunk" + parent: "SignalWire::REST::Namespaces::DatasphereDocuments" + module: "SignalWire.REST.Namespaces.DatasphereDocuments" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb" + visibility: "public" +--- +# `delete_chunk` + +## Signature + +```ruby +def delete_chunk(document_id, chunk_id) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/get-chunk.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/get-chunk.mdx new file mode 100644 index 0000000000..e550130ff9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/get-chunk.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/datasphere-documents/get-chunk" +title: "get_chunk" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::DatasphereDocuments#get_chunk" + parent: "SignalWire::REST::Namespaces::DatasphereDocuments" + module: "SignalWire.REST.Namespaces.DatasphereDocuments" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb" + visibility: "public" +--- +# `get_chunk` + +## Signature + +```ruby +def get_chunk(document_id, chunk_id) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb) + +Line 20. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/index.mdx new file mode 100644 index 0000000000..08ce67a037 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/datasphere-documents" +title: "DatasphereDocuments" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::DatasphereDocuments" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb" + visibility: "public" +--- +# `DatasphereDocuments` + +Document management with search and chunk operations. + +## Signature + +```ruby +class DatasphereDocuments < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/initialize.mdx new file mode 100644 index 0000000000..99ee719387 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/datasphere-documents/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::DatasphereDocuments#initialize" + parent: "SignalWire::REST::Namespaces::DatasphereDocuments" + module: "SignalWire.REST.Namespaces.DatasphereDocuments" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`DatasphereDocuments` — a new instance of DatasphereDocuments + +## Source + +[`lib/signalwire/rest/namespaces/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/list-chunks.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/list-chunks.mdx new file mode 100644 index 0000000000..cdfbca15e2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/list-chunks.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/datasphere-documents/list-chunks" +title: "list_chunks" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::DatasphereDocuments#list_chunks" + parent: "SignalWire::REST::Namespaces::DatasphereDocuments" + module: "SignalWire.REST.Namespaces.DatasphereDocuments" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb" + visibility: "public" +--- +# `list_chunks` + +## Signature + +```ruby +def list_chunks(document_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/search.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/search.mdx new file mode 100644 index 0000000000..8211c31d9c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-documents/search.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/datasphere-documents/search" +title: "search" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::DatasphereDocuments#search" + parent: "SignalWire::REST::Namespaces::DatasphereDocuments" + module: "SignalWire.REST.Namespaces.DatasphereDocuments" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb" + visibility: "public" +--- +# `search` + +## Signature + +```ruby +def search(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-namespace/documents.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-namespace/documents.mdx new file mode 100644 index 0000000000..85c7904afd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-namespace/documents.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/datasphere-namespace/documents" +title: "documents" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::DatasphereNamespace#documents" + parent: "SignalWire::REST::Namespaces::DatasphereNamespace" + module: "SignalWire.REST.Namespaces.DatasphereNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb" + visibility: "public" +--- +# `documents` + +Returns the value of attribute documents. + +## Signature + +```ruby +attr_reader documents -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-namespace/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-namespace/index.mdx new file mode 100644 index 0000000000..62f75279df --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-namespace/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/datasphere-namespace" +title: "DatasphereNamespace" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::DatasphereNamespace" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb" + visibility: "public" +--- +# `DatasphereNamespace` + +Datasphere API namespace. + +## Signature + +```ruby +class DatasphereNamespace < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute documents. + + + + + +## Source + +[`lib/signalwire/rest/namespaces/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb) + +Line 30. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-namespace/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-namespace/initialize.mdx new file mode 100644 index 0000000000..2e169b3096 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/datasphere-namespace/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/datasphere-namespace/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::DatasphereNamespace#initialize" + parent: "SignalWire::REST::Namespaces::DatasphereNamespace" + module: "SignalWire.REST.Namespaces.DatasphereNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`DatasphereNamespace` — a new instance of DatasphereNamespace + +## Source + +[`lib/signalwire/rest/namespaces/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/datasphere.rb) + +Line 33. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-addresses/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-addresses/get.mdx new file mode 100644 index 0000000000..905e054f3f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-addresses/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-addresses/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricAddresses#get" + parent: "SignalWire::REST::Namespaces::FabricAddresses" + module: "SignalWire.REST.Namespaces.FabricAddresses" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(address_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 164. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-addresses/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-addresses/index.mdx new file mode 100644 index 0000000000..fb2e05d137 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-addresses/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-addresses" +title: "FabricAddresses" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricAddresses" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `FabricAddresses` + +Read-only fabric addresses. + +## Signature + +```ruby +class FabricAddresses < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 159. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-addresses/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-addresses/list.mdx new file mode 100644 index 0000000000..ded0224a23 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-addresses/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-addresses/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricAddresses#list" + parent: "SignalWire::REST::Namespaces::FabricAddresses" + module: "SignalWire.REST.Namespaces.FabricAddresses" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 160. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/addresses.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/addresses.mdx new file mode 100644 index 0000000000..247b82b0f7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/addresses.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/addresses" +title: "addresses" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#addresses" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `addresses` + +Returns the value of attribute addresses. + +## Signature + +```ruby +attr_reader addresses -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/ai-agents.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/ai-agents.mdx new file mode 100644 index 0000000000..6f98ddab32 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/ai-agents.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/ai-agents" +title: "ai_agents" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#ai_agents" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `ai_agents` + +Returns the value of attribute ai\_agents. + +## Signature + +```ruby +attr_reader ai_agents -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/call-flows.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/call-flows.mdx new file mode 100644 index 0000000000..a53a18eb59 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/call-flows.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/call-flows" +title: "call_flows" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#call_flows" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `call_flows` + +Returns the value of attribute call\_flows. + +## Signature + +```ruby +attr_reader call_flows -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/conference-rooms.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/conference-rooms.mdx new file mode 100644 index 0000000000..7df3d2195f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/conference-rooms.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/conference-rooms" +title: "conference_rooms" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#conference_rooms" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `conference_rooms` + +Returns the value of attribute conference\_rooms. + +## Signature + +```ruby +attr_reader conference_rooms -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-applications.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-applications.mdx new file mode 100644 index 0000000000..a7c3608def --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-applications.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-applications" +title: "cxml_applications" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#cxml_applications" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `cxml_applications` + +Returns the value of attribute cxml\_applications. + +## Signature + +```ruby +attr_reader cxml_applications -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-scripts.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-scripts.mdx new file mode 100644 index 0000000000..a972d235a7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-scripts.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-scripts" +title: "cxml_scripts" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#cxml_scripts" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `cxml_scripts` + +Returns the value of attribute cxml\_scripts. + +## Signature + +```ruby +attr_reader cxml_scripts -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-webhooks.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-webhooks.mdx new file mode 100644 index 0000000000..35d380f7eb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-webhooks.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/cxml-webhooks" +title: "cxml_webhooks" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#cxml_webhooks" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `cxml_webhooks` + +Returns the value of attribute cxml\_webhooks. + +## Signature + +```ruby +attr_reader cxml_webhooks -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/freeswitch-connectors.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/freeswitch-connectors.mdx new file mode 100644 index 0000000000..18f695207a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/freeswitch-connectors.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/freeswitch-connectors" +title: "freeswitch_connectors" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#freeswitch_connectors" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `freeswitch_connectors` + +Returns the value of attribute freeswitch\_connectors. + +## Signature + +```ruby +attr_reader freeswitch_connectors -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/index.mdx new file mode 100644 index 0000000000..4977c35b7a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/index.mdx @@ -0,0 +1,104 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace" +title: "FabricNamespace" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `FabricNamespace` + +Fabric API namespace grouping all resource types. + +## Signature + +```ruby +class FabricNamespace < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute addresses. + + + + Returns the value of attribute ai\_agents. + + + + Returns the value of attribute call\_flows. + + + + Returns the value of attribute conference\_rooms. + + + + Returns the value of attribute cxml\_applications. + + + + Returns the value of attribute cxml\_scripts. + + + + Returns the value of attribute cxml\_webhooks. + + + + Returns the value of attribute freeswitch\_connectors. + + + + + + Returns the value of attribute relay\_applications. + + + + Returns the value of attribute resources. + + + + Returns the value of attribute sip\_endpoints. + + + + Returns the value of attribute sip\_gateways. + + + + Returns the value of attribute subscribers. + + + + Returns the value of attribute swml\_scripts. + + + + Returns the value of attribute swml\_webhooks. + + + + Returns the value of attribute tokens. + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 197. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/initialize.mdx new file mode 100644 index 0000000000..0e74e950e8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#initialize" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`FabricNamespace` — a new instance of FabricNamespace + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 204. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/relay-applications.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/relay-applications.mdx new file mode 100644 index 0000000000..b403ae3ce6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/relay-applications.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/relay-applications" +title: "relay_applications" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#relay_applications" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `relay_applications` + +Returns the value of attribute relay\_applications. + +## Signature + +```ruby +attr_reader relay_applications -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/resources.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/resources.mdx new file mode 100644 index 0000000000..7419de256d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/resources.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/resources" +title: "resources" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#resources" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `resources` + +Returns the value of attribute resources. + +## Signature + +```ruby +attr_reader resources -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/sip-endpoints.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/sip-endpoints.mdx new file mode 100644 index 0000000000..72a65717a3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/sip-endpoints.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/sip-endpoints" +title: "sip_endpoints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#sip_endpoints" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `sip_endpoints` + +Returns the value of attribute sip\_endpoints. + +## Signature + +```ruby +attr_reader sip_endpoints -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/sip-gateways.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/sip-gateways.mdx new file mode 100644 index 0000000000..6f418e5dab --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/sip-gateways.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/sip-gateways" +title: "sip_gateways" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#sip_gateways" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `sip_gateways` + +Returns the value of attribute sip\_gateways. + +## Signature + +```ruby +attr_reader sip_gateways -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/subscribers.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/subscribers.mdx new file mode 100644 index 0000000000..8a6f301ff1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/subscribers.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/subscribers" +title: "subscribers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#subscribers" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `subscribers` + +Returns the value of attribute subscribers. + +## Signature + +```ruby +attr_reader subscribers -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/swml-scripts.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/swml-scripts.mdx new file mode 100644 index 0000000000..67aeb53a1f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/swml-scripts.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/swml-scripts" +title: "swml_scripts" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#swml_scripts" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `swml_scripts` + +Returns the value of attribute swml\_scripts. + +## Signature + +```ruby +attr_reader swml_scripts -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/swml-webhooks.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/swml-webhooks.mdx new file mode 100644 index 0000000000..8819252037 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/swml-webhooks.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/swml-webhooks" +title: "swml_webhooks" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#swml_webhooks" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `swml_webhooks` + +Returns the value of attribute swml\_webhooks. + +## Signature + +```ruby +attr_reader swml_webhooks -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/tokens.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/tokens.mdx new file mode 100644 index 0000000000..66f86e51b9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-namespace/tokens.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-namespace/tokens" +title: "tokens" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricNamespace#tokens" + parent: "SignalWire::REST::Namespaces::FabricNamespace" + module: "SignalWire.REST.Namespaces.FabricNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `tokens` + +Returns the value of attribute tokens. + +## Signature + +```ruby +attr_reader tokens -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-resource-put/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-resource-put/index.mdx new file mode 100644 index 0000000000..ffd98d0203 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-resource-put/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-resource-put" +title: "FabricResourcePUT" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricResourcePUT" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `FabricResourcePUT` + +Fabric resource that uses PUT for updates. + +## Signature + +```ruby +class FabricResourcePUT < SignalWire::REST::Namespaces::FabricResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::FabricResource](/reference/ruby/signal-wire/rest/namespaces/fabric-resource) + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-resource/index.mdx new file mode 100644 index 0000000000..6213a6b12b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-resource/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-resource" +title: "FabricResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `FabricResource` + +Standard fabric resource with CRUD + addresses. + +## Signature + +```ruby +class FabricResource < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-resource/list-addresses.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-resource/list-addresses.mdx new file mode 100644 index 0000000000..2312f18252 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-resource/list-addresses.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-resource/list-addresses" +title: "list_addresses" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricResource#list_addresses" + parent: "SignalWire::REST::Namespaces::FabricResource" + module: "SignalWire.REST.Namespaces.FabricResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `list_addresses` + +## Signature + +```ruby +def list_addresses(resource_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-embed-token.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-embed-token.mdx new file mode 100644 index 0000000000..69b3c89a1d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-embed-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-embed-token" +title: "create_embed_token" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricTokens#create_embed_token" + parent: "SignalWire::REST::Namespaces::FabricTokens" + module: "SignalWire.REST.Namespaces.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `create_embed_token` + +## Signature + +```ruby +def create_embed_token(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 191. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-guest-token.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-guest-token.mdx new file mode 100644 index 0000000000..0dacb00b97 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-guest-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-guest-token" +title: "create_guest_token" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricTokens#create_guest_token" + parent: "SignalWire::REST::Namespaces::FabricTokens" + module: "SignalWire.REST.Namespaces.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `create_guest_token` + +## Signature + +```ruby +def create_guest_token(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 187. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-invite-token.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-invite-token.mdx new file mode 100644 index 0000000000..b6eabf83b8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-invite-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-invite-token" +title: "create_invite_token" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricTokens#create_invite_token" + parent: "SignalWire::REST::Namespaces::FabricTokens" + module: "SignalWire.REST.Namespaces.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `create_invite_token` + +## Signature + +```ruby +def create_invite_token(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 183. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-subscriber-token.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-subscriber-token.mdx new file mode 100644 index 0000000000..75495d8aee --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-subscriber-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-tokens/create-subscriber-token" +title: "create_subscriber_token" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricTokens#create_subscriber_token" + parent: "SignalWire::REST::Namespaces::FabricTokens" + module: "SignalWire.REST.Namespaces.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `create_subscriber_token` + +## Signature + +```ruby +def create_subscriber_token(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 175. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/index.mdx new file mode 100644 index 0000000000..03d936496a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-tokens" +title: "FabricTokens" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricTokens" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `FabricTokens` + +Subscriber, guest, invite, and embed token creation. + +## Signature + +```ruby +class FabricTokens < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 170. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/initialize.mdx new file mode 100644 index 0000000000..d9decf4237 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-tokens/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricTokens#initialize" + parent: "SignalWire::REST::Namespaces::FabricTokens" + module: "SignalWire.REST.Namespaces.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`FabricTokens` — a new instance of FabricTokens + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 171. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/refresh-subscriber-token.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/refresh-subscriber-token.mdx new file mode 100644 index 0000000000..d856227ca5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fabric-tokens/refresh-subscriber-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fabric-tokens/refresh-subscriber-token" +title: "refresh_subscriber_token" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FabricTokens#refresh_subscriber_token" + parent: "SignalWire::REST::Namespaces::FabricTokens" + module: "SignalWire.REST.Namespaces.FabricTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `refresh_subscriber_token` + +## Signature + +```ruby +def refresh_subscriber_token(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 179. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fax-logs/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fax-logs/get.mdx new file mode 100644 index 0000000000..9cc1612125 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fax-logs/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fax-logs/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FaxLogs#get" + parent: "SignalWire::REST::Namespaces::FaxLogs" + module: "SignalWire.REST.Namespaces.FaxLogs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(log_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fax-logs/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fax-logs/index.mdx new file mode 100644 index 0000000000..baecd5501f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fax-logs/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fax-logs" +title: "FaxLogs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FaxLogs" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `FaxLogs` + +Fax log queries. + +## Signature + +```ruby +class FaxLogs < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fax-logs/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fax-logs/list.mdx new file mode 100644 index 0000000000..10aca6cdac --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/fax-logs/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/fax-logs/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::FaxLogs#list" + parent: "SignalWire::REST::Namespaces::FaxLogs" + module: "SignalWire.REST.Namespaces.FaxLogs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/assign-domain-application.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/assign-domain-application.mdx new file mode 100644 index 0000000000..0b532cf556 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/assign-domain-application.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/generic-resources/assign-domain-application" +title: "assign_domain_application" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::GenericResources#assign_domain_application" + parent: "SignalWire::REST::Namespaces::GenericResources" + module: "SignalWire.REST.Namespaces.GenericResources" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `assign_domain_application` + +## Signature + +```ruby +def assign_domain_application(resource_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 153. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/assign-phone-route.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/assign-phone-route.mdx new file mode 100644 index 0000000000..f56db1fcc0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/assign-phone-route.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/generic-resources/assign-phone-route" +title: "assign_phone_route" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::GenericResources#assign_phone_route" + parent: "SignalWire::REST::Namespaces::GenericResources" + module: "SignalWire.REST.Namespaces.GenericResources" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" + deprecated: true +--- +# `assign_phone_route` + + + **Deprecated.** For the common binding cases use +phone\_numbers.set\_\*+ helpers. + + +This endpoint (+POST /api/fabric/resources/\{id\}/phone\_routes+) accepts +only a narrow set of legacy resource types as the attach target. It +_does not work_ for +swml\_webhook+ / +cxml\_webhook+ / +ai\_agent+ +bindings -- those are configured on the phone number and the Fabric +resource is auto-materialized (see +phone\_numbers.set\_swml\_webhook+ +etc.). The authoritative list of accepting resource types lives in +the OpenAPI spec; routing here for those types returns 404 or 422. + +## Signature + +```ruby +def assign_phone_route(resource_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 141. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/delete.mdx new file mode 100644 index 0000000000..2a503b4bf3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/generic-resources/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::GenericResources#delete" + parent: "SignalWire::REST::Namespaces::GenericResources" + module: "SignalWire.REST.Namespaces.GenericResources" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(resource_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 124. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/get.mdx new file mode 100644 index 0000000000..11e50ce36d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/generic-resources/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::GenericResources#get" + parent: "SignalWire::REST::Namespaces::GenericResources" + module: "SignalWire.REST.Namespaces.GenericResources" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(resource_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 120. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/index.mdx new file mode 100644 index 0000000000..ed6c78a997 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/generic-resources" +title: "GenericResources" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::GenericResources" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `GenericResources` + +Generic resource operations across all fabric resource types. + +## Signature + +```ruby +class GenericResources < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + This endpoint (+POST /api/fabric/resources/\{id\}/phone\_routes+) accepts only a narrow set of legacy resource types as the attach target. It _does not work_ for +swml\_webhook+ / +cxml\_webhook+ / +ai\_agent+ bindings -- those are configured on the phone number and the Fabric resource is auto-materialized (see +phone\_numbers.set\_swml\_webhook+ etc.). The authoritative list of accepting resource types lives in the OpenAPI spec; routing here for those types returns 404 or 422. + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 115. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/list-addresses.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/list-addresses.mdx new file mode 100644 index 0000000000..63ac2d45ca --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/list-addresses.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/generic-resources/list-addresses" +title: "list_addresses" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::GenericResources#list_addresses" + parent: "SignalWire::REST::Namespaces::GenericResources" + module: "SignalWire.REST.Namespaces.GenericResources" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `list_addresses` + +## Signature + +```ruby +def list_addresses(resource_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 128. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/list.mdx new file mode 100644 index 0000000000..7ac224fc4b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/generic-resources/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/generic-resources/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::GenericResources#list" + parent: "SignalWire::REST::Namespaces::GenericResources" + module: "SignalWire.REST.Namespaces.GenericResources" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 116. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource/create.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource/create.mdx new file mode 100644 index 0000000000..139c906d6e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource/create" +title: "create" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ImportedNumbersResource#create" + parent: "SignalWire::REST::Namespaces::ImportedNumbersResource" + module: "SignalWire.REST.Namespaces.ImportedNumbersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/imported_numbers.rb" + visibility: "public" +--- +# `create` + +## Signature + +```ruby +def create(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/imported_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/imported_numbers.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource/index.mdx new file mode 100644 index 0000000000..8d64b065a6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource" +title: "ImportedNumbersResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ImportedNumbersResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/imported_numbers.rb" + visibility: "public" +--- +# `ImportedNumbersResource` + +Import externally-hosted phone numbers. + +## Signature + +```ruby +class ImportedNumbersResource < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/imported_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/imported_numbers.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource/initialize.mdx new file mode 100644 index 0000000000..51524e4946 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/imported-numbers-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ImportedNumbersResource#initialize" + parent: "SignalWire::REST::Namespaces::ImportedNumbersResource" + module: "SignalWire.REST.Namespaces.ImportedNumbersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/imported_numbers.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`ImportedNumbersResource` — a new instance of ImportedNumbersResource + +## Source + +[`lib/signalwire/rest/namespaces/imported_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/imported_numbers.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/index.mdx new file mode 100644 index 0000000000..67700899cc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/index.mdx @@ -0,0 +1,280 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces" +title: "Namespaces" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces" + parent: "SignalWire::REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb" + visibility: "public" +--- +# `Namespaces` + +## Signature + +```ruby +module Namespaces +``` + +## Classes + + + + Address management (no update endpoint). + + + + Fabric webhook resource that's normally auto-created by +phone\_numbers.set\_\*\_webhook+. Exposed for backwards compatibility. + + + + Call flows with version management. + + + + REST call control -- all 37 commands dispatched via single POST endpoint. + + + + Chat token generation. + + + + Compat account/subproject management. + + + + Compat application management. + + + + Compat call management with recording and stream sub-resources. + + + + Compat conference management. + + + + Compat fax management with media sub-resources. + + + + Compat cXML/LaML script management. + + + + Compat message management with media sub-resources. + + + + Twilio-compatible LAML API namespace. + + + + Compat phone number management. + + + + Compat queue management with members. + + + + Compat recording management. + + + + Compat API token management. + + + + Compat transcription management. + + + + Conference log queries. + + + + Conference rooms -- uses singular 'conference\_room' for sub-resource paths. + + + + cXML applications -- no create method. + + + + cXML webhooks -- auto-materialized by +phone\_numbers.set\_cxml\_webhook+. + + + + Document management with search and chunk operations. + + + + Datasphere API namespace. + + + + Read-only fabric addresses. + + + + Fabric API namespace grouping all resource types. + + + + Standard fabric resource with CRUD + addresses. + + + + Fabric resource that uses PUT for updates. + + + + Subscriber, guest, invite, and embed token creation. + + + + Fax log queries. + + + + Generic resource operations across all fabric resource types. + + + + Import externally-hosted phone numbers. + + + + Logs API namespace. + + + + Phone number lookup (carrier, CNAM). + + + + Message log queries. + + + + Multi-factor authentication via SMS or phone call. + + + + Number group management with membership operations. + + + + Phone number management. + + + + Project API namespace. + + + + Project API token management. + + + + PubSub token generation. + + + + Queue management with member operations. + + + + Recording management (read-only + delete). + + + + 10DLC brand management. + + + + 10DLC campaign management. + + + + 10DLC Campaign Registry namespace. + + + + 10DLC number assignment management. + + + + 10DLC assignment order management. + + + + Short code management (read + update only). + + + + Project SIP profile (singleton resource). + + + + Subscribers with SIP endpoint management. + + + + SWML webhooks -- auto-materialized by +phone\_numbers.set\_swml\_webhook+. + + + + Verified caller ID management with verification flow. + + + + Video conference management with tokens and streams. + + + + Video conference token management. + + + + Video API namespace. + + + + Video room recording management. + + + + Video room management with streams. + + + + Video room session management. + + + + Video room token generation. + + + + Video stream management. + + + + Voice log queries. + + + +## Source + +[`lib/signalwire/rest/namespaces/mfa.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb) + +Line 5. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/conferences.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/conferences.mdx new file mode 100644 index 0000000000..eb5c9b819b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/conferences.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/logs-namespace/conferences" +title: "conferences" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::LogsNamespace#conferences" + parent: "SignalWire::REST::Namespaces::LogsNamespace" + module: "SignalWire.REST.Namespaces.LogsNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `conferences` + +Returns the value of attribute conferences. + +## Signature + +```ruby +attr_reader conferences -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 35. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/fax.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/fax.mdx new file mode 100644 index 0000000000..8e10b7de50 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/fax.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/logs-namespace/fax" +title: "fax" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::LogsNamespace#fax" + parent: "SignalWire::REST::Namespaces::LogsNamespace" + module: "SignalWire.REST.Namespaces.LogsNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `fax` + +Returns the value of attribute fax. + +## Signature + +```ruby +attr_reader fax -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 35. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/index.mdx new file mode 100644 index 0000000000..e2e324d898 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/logs-namespace" +title: "LogsNamespace" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::LogsNamespace" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `LogsNamespace` + +Logs API namespace. + +## Signature + +```ruby +class LogsNamespace < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute conferences. + + + + Returns the value of attribute fax. + + + + + + Returns the value of attribute messages. + + + + Returns the value of attribute voice. + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 34. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/initialize.mdx new file mode 100644 index 0000000000..2960f25572 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/logs-namespace/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::LogsNamespace#initialize" + parent: "SignalWire::REST::Namespaces::LogsNamespace" + module: "SignalWire.REST.Namespaces.LogsNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`LogsNamespace` — a new instance of LogsNamespace + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 37. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/messages.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/messages.mdx new file mode 100644 index 0000000000..41863de02c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/messages.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/logs-namespace/messages" +title: "messages" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::LogsNamespace#messages" + parent: "SignalWire::REST::Namespaces::LogsNamespace" + module: "SignalWire.REST.Namespaces.LogsNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `messages` + +Returns the value of attribute messages. + +## Signature + +```ruby +attr_reader messages -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 35. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/voice.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/voice.mdx new file mode 100644 index 0000000000..0327abbad0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/logs-namespace/voice.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/logs-namespace/voice" +title: "voice" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::LogsNamespace#voice" + parent: "SignalWire::REST::Namespaces::LogsNamespace" + module: "SignalWire.REST.Namespaces.LogsNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `voice` + +Returns the value of attribute voice. + +## Signature + +```ruby +attr_reader voice -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 35. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/lookup-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/lookup-resource/index.mdx new file mode 100644 index 0000000000..06d0231691 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/lookup-resource/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/lookup-resource" +title: "LookupResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::LookupResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/lookup.rb" + visibility: "public" +--- +# `LookupResource` + +Phone number lookup (carrier, CNAM). + +## Signature + +```ruby +class LookupResource < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/lookup.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/lookup.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/lookup-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/lookup-resource/initialize.mdx new file mode 100644 index 0000000000..72746aced5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/lookup-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/lookup-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::LookupResource#initialize" + parent: "SignalWire::REST::Namespaces::LookupResource" + module: "SignalWire.REST.Namespaces.LookupResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/lookup.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`LookupResource` — a new instance of LookupResource + +## Source + +[`lib/signalwire/rest/namespaces/lookup.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/lookup.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/lookup-resource/phone-number.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/lookup-resource/phone-number.mdx new file mode 100644 index 0000000000..01b8ae61e0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/lookup-resource/phone-number.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/lookup-resource/phone-number" +title: "phone_number" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::LookupResource#phone_number" + parent: "SignalWire::REST::Namespaces::LookupResource" + module: "SignalWire.REST.Namespaces.LookupResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/lookup.rb" + visibility: "public" +--- +# `phone_number` + +## Signature + +```ruby +def phone_number(e164, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/lookup.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/lookup.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/message-logs/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/message-logs/get.mdx new file mode 100644 index 0000000000..281457bd23 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/message-logs/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/message-logs/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::MessageLogs#get" + parent: "SignalWire::REST::Namespaces::MessageLogs" + module: "SignalWire.REST.Namespaces.MessageLogs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(log_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 9. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/message-logs/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/message-logs/index.mdx new file mode 100644 index 0000000000..6e4fa54321 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/message-logs/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/message-logs" +title: "MessageLogs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::MessageLogs" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `MessageLogs` + +Message log queries. + +## Signature + +```ruby +class MessageLogs < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/message-logs/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/message-logs/list.mdx new file mode 100644 index 0000000000..12b445cd2f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/message-logs/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/message-logs/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::MessageLogs#list" + parent: "SignalWire::REST::Namespaces::MessageLogs" + module: "SignalWire.REST.Namespaces.MessageLogs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/call.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/call.mdx new file mode 100644 index 0000000000..5128b56df4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/mfa-resource/call" +title: "call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::MfaResource#call" + parent: "SignalWire::REST::Namespaces::MfaResource" + module: "SignalWire.REST.Namespaces.MfaResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb" + visibility: "public" +--- +# `call` + +## Signature + +```ruby +def call(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/mfa.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/index.mdx new file mode 100644 index 0000000000..1f3f365764 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/mfa-resource" +title: "MfaResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::MfaResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb" + visibility: "public" +--- +# `MfaResource` + +Multi-factor authentication via SMS or phone call. + +## Signature + +```ruby +class MfaResource < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/mfa.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/initialize.mdx new file mode 100644 index 0000000000..4f3d8bcb63 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/mfa-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::MfaResource#initialize" + parent: "SignalWire::REST::Namespaces::MfaResource" + module: "SignalWire.REST.Namespaces.MfaResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`MfaResource` — a new instance of MfaResource + +## Source + +[`lib/signalwire/rest/namespaces/mfa.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/sms.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/sms.mdx new file mode 100644 index 0000000000..781df59c59 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/sms.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/mfa-resource/sms" +title: "sms" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::MfaResource#sms" + parent: "SignalWire::REST::Namespaces::MfaResource" + module: "SignalWire.REST.Namespaces.MfaResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb" + visibility: "public" +--- +# `sms` + +## Signature + +```ruby +def sms(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/mfa.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/verify.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/verify.mdx new file mode 100644 index 0000000000..a16f187134 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/mfa-resource/verify.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/mfa-resource/verify" +title: "verify" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::MfaResource#verify" + parent: "SignalWire::REST::Namespaces::MfaResource" + module: "SignalWire.REST.Namespaces.MfaResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb" + visibility: "public" +--- +# `verify` + +## Signature + +```ruby +def verify(request_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/mfa.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/mfa.rb) + +Line 20. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/add-membership.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/add-membership.mdx new file mode 100644 index 0000000000..b8361a5e6a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/add-membership.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/number-groups-resource/add-membership" +title: "add_membership" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::NumberGroupsResource#add_membership" + parent: "SignalWire::REST::Namespaces::NumberGroupsResource" + module: "SignalWire.REST.Namespaces.NumberGroupsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb" + visibility: "public" +--- +# `add_membership` + +## Signature + +```ruby +def add_membership(group_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/number_groups.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb) + +Line 18. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/delete-membership.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/delete-membership.mdx new file mode 100644 index 0000000000..7a14f54f7d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/delete-membership.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/number-groups-resource/delete-membership" +title: "delete_membership" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::NumberGroupsResource#delete_membership" + parent: "SignalWire::REST::Namespaces::NumberGroupsResource" + module: "SignalWire.REST.Namespaces.NumberGroupsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb" + visibility: "public" +--- +# `delete_membership` + +## Signature + +```ruby +def delete_membership(membership_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/number_groups.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb) + +Line 26. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/get-membership.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/get-membership.mdx new file mode 100644 index 0000000000..936e00703c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/get-membership.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/number-groups-resource/get-membership" +title: "get_membership" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::NumberGroupsResource#get_membership" + parent: "SignalWire::REST::Namespaces::NumberGroupsResource" + module: "SignalWire.REST.Namespaces.NumberGroupsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb" + visibility: "public" +--- +# `get_membership` + +## Signature + +```ruby +def get_membership(membership_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/number_groups.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/index.mdx new file mode 100644 index 0000000000..6f63d64a16 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/number-groups-resource" +title: "NumberGroupsResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::NumberGroupsResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb" + visibility: "public" +--- +# `NumberGroupsResource` + +Number group management with membership operations. + +## Signature + +```ruby +class NumberGroupsResource < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/number_groups.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/initialize.mdx new file mode 100644 index 0000000000..6c5d2a5e65 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/number-groups-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::NumberGroupsResource#initialize" + parent: "SignalWire::REST::Namespaces::NumberGroupsResource" + module: "SignalWire.REST.Namespaces.NumberGroupsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`NumberGroupsResource` — a new instance of NumberGroupsResource + +## Source + +[`lib/signalwire/rest/namespaces/number_groups.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/list-memberships.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/list-memberships.mdx new file mode 100644 index 0000000000..84f929c49e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/number-groups-resource/list-memberships.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/number-groups-resource/list-memberships" +title: "list_memberships" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::NumberGroupsResource#list_memberships" + parent: "SignalWire::REST::Namespaces::NumberGroupsResource" + module: "SignalWire.REST.Namespaces.NumberGroupsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb" + visibility: "public" +--- +# `list_memberships` + +## Signature + +```ruby +def list_memberships(group_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/number_groups.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/number_groups.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/index.mdx new file mode 100644 index 0000000000..bafd8b3bf7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/index.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource" +title: "PhoneNumbersResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbersResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb" + visibility: "public" +--- +# `PhoneNumbersResource` + +Phone number management. + +Supports the standard CRUD surface plus typed helpers for binding an +inbound call to a handler (SWML webhook, cXML webhook, AI agent, call +flow, RELAY application/topic). The binding model is: set ++call\_handler+ and the handler-specific companion field on the phone +number; the server auto-materializes the matching Fabric resource. +See +SignalWire::REST::PhoneCallHandler+ for the enum, and the +porting-sdk's +phone-binding.md+ for the full model. + +## Signature + +```ruby +class PhoneNumbersResource < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + + + + Route inbound calls to an AI Agent Fabric resource by ID. + + + + Route inbound calls to a Call Flow by ID. + + + + Route inbound calls to an existing cXML application by ID. + + + + Route inbound calls to a cXML (Twilio-compat / LAML) webhook. + + + + Route inbound calls to a named RELAY application. + + + + Route inbound calls to a RELAY topic (client subscription). + + + + Route inbound calls to an SWML webhook URL. + + + +## Source + +[`lib/signalwire/rest/namespaces/phone_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/initialize.mdx new file mode 100644 index 0000000000..5fb0942d99 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbersResource#initialize" + parent: "SignalWire::REST::Namespaces::PhoneNumbersResource" + module: "SignalWire.REST.Namespaces.PhoneNumbersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`PhoneNumbersResource` — a new instance of PhoneNumbersResource + +## Source + +[`lib/signalwire/rest/namespaces/phone_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb) + +Line 20. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/search.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/search.mdx new file mode 100644 index 0000000000..2b6dfb2c3e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/search.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/search" +title: "search" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbersResource#search" + parent: "SignalWire::REST::Namespaces::PhoneNumbersResource" + module: "SignalWire.REST.Namespaces.PhoneNumbersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb" + visibility: "public" +--- +# `search` + +## Signature + +```ruby +def search(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/phone_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-ai-agent.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-ai-agent.mdx new file mode 100644 index 0000000000..db29154428 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-ai-agent.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-ai-agent" +title: "set_ai_agent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbersResource#set_ai_agent" + parent: "SignalWire::REST::Namespaces::PhoneNumbersResource" + module: "SignalWire.REST.Namespaces.PhoneNumbersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb" + visibility: "public" +--- +# `set_ai_agent` + +Route inbound calls to an AI Agent Fabric resource by ID. + +## Signature + +```ruby +def set_ai_agent(sid, agent_id:, **extra) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/phone_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb) + +Line 80. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-call-flow.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-call-flow.mdx new file mode 100644 index 0000000000..35f8459a8a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-call-flow.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-call-flow" +title: "set_call_flow" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbersResource#set_call_flow" + parent: "SignalWire::REST::Namespaces::PhoneNumbersResource" + module: "SignalWire.REST.Namespaces.PhoneNumbersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb" + visibility: "public" +--- +# `set_call_flow` + +Route inbound calls to a Call Flow by ID. + ++version+ accepts +"working\_copy"+ or +"current\_deployed"+ (server +default when omitted). + +## Signature + +```ruby +def set_call_flow(sid, flow_id:, version: nil, **extra) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/phone_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb) + +Line 93. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-cxml-application.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-cxml-application.mdx new file mode 100644 index 0000000000..70b685f64d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-cxml-application.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-cxml-application" +title: "set_cxml_application" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbersResource#set_cxml_application" + parent: "SignalWire::REST::Namespaces::PhoneNumbersResource" + module: "SignalWire.REST.Namespaces.PhoneNumbersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb" + visibility: "public" +--- +# `set_cxml_application` + +Route inbound calls to an existing cXML application by ID. + +## Signature + +```ruby +def set_cxml_application(sid, application_id:, **extra) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/phone_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb) + +Line 70. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-cxml-webhook.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-cxml-webhook.mdx new file mode 100644 index 0000000000..6fd37a0d34 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-cxml-webhook.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-cxml-webhook" +title: "set_cxml_webhook" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbersResource#set_cxml_webhook" + parent: "SignalWire::REST::Namespaces::PhoneNumbersResource" + module: "SignalWire.REST.Namespaces.PhoneNumbersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb" + visibility: "public" +--- +# `set_cxml_webhook` + +Route inbound calls to a cXML (Twilio-compat / LAML) webhook. + +Despite the wire value +laml\_webhooks+ being plural, this creates a +single +cxml\_webhook+ Fabric resource. +fallback\_url+ is used when +the primary URL fails; +status\_callback\_url+ receives call status +updates. + +## Signature + +```ruby +def set_cxml_webhook(sid, url:, fallback_url: nil, status_callback_url: nil, **extra) +``` + +## Parameters + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/phone_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb) + +Line 59. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-relay-application.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-relay-application.mdx new file mode 100644 index 0000000000..33910487a2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-relay-application.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-relay-application" +title: "set_relay_application" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbersResource#set_relay_application" + parent: "SignalWire::REST::Namespaces::PhoneNumbersResource" + module: "SignalWire.REST.Namespaces.PhoneNumbersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb" + visibility: "public" +--- +# `set_relay_application` + +Route inbound calls to a named RELAY application. + +## Signature + +```ruby +def set_relay_application(sid, name:, **extra) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/phone_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb) + +Line 103. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-relay-topic.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-relay-topic.mdx new file mode 100644 index 0000000000..9fb863828e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-relay-topic.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-relay-topic" +title: "set_relay_topic" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbersResource#set_relay_topic" + parent: "SignalWire::REST::Namespaces::PhoneNumbersResource" + module: "SignalWire.REST.Namespaces.PhoneNumbersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb" + visibility: "public" +--- +# `set_relay_topic` + +Route inbound calls to a RELAY topic (client subscription). + +## Signature + +```ruby +def set_relay_topic(sid, topic:, status_callback_url: nil, **extra) +``` + +## Parameters + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/phone_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb) + +Line 113. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-swml-webhook.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-swml-webhook.mdx new file mode 100644 index 0000000000..1131cb266a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-swml-webhook.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/phone-numbers-resource/set-swml-webhook" +title: "set_swml_webhook" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PhoneNumbersResource#set_swml_webhook" + parent: "SignalWire::REST::Namespaces::PhoneNumbersResource" + module: "SignalWire.REST.Namespaces.PhoneNumbersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb" + visibility: "public" +--- +# `set_swml_webhook` + +Route inbound calls to an SWML webhook URL. + +Your backend returns an SWML document per call. The server +auto-creates a +swml\_webhook+ Fabric resource keyed off this URL. + +## Signature + +```ruby +def set_swml_webhook(sid, url:, **extra) +``` + +## Parameters + + + the phone number SID (e.g. +pn-...+) + + + + + + additional fields passed to +update+ + + +## Returns + +`Hash` — the updated phone number representation + +## Source + +[`lib/signalwire/rest/namespaces/phone_numbers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/phone_numbers.rb) + +Line 44. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-namespace/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-namespace/index.mdx new file mode 100644 index 0000000000..a587052678 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-namespace/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/project-namespace" +title: "ProjectNamespace" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ProjectNamespace" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb" + visibility: "public" +--- +# `ProjectNamespace` + +Project API namespace. + +## Signature + +```ruby +class ProjectNamespace < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + + + Returns the value of attribute tokens. + + + +## Source + +[`lib/signalwire/rest/namespaces/project.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-namespace/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-namespace/initialize.mdx new file mode 100644 index 0000000000..cbe15f8ad5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-namespace/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/project-namespace/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ProjectNamespace#initialize" + parent: "SignalWire::REST::Namespaces::ProjectNamespace" + module: "SignalWire.REST.Namespaces.ProjectNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`ProjectNamespace` — a new instance of ProjectNamespace + +## Source + +[`lib/signalwire/rest/namespaces/project.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb) + +Line 27. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-namespace/tokens.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-namespace/tokens.mdx new file mode 100644 index 0000000000..f6cdf06f88 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-namespace/tokens.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/project-namespace/tokens" +title: "tokens" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ProjectNamespace#tokens" + parent: "SignalWire::REST::Namespaces::ProjectNamespace" + module: "SignalWire.REST.Namespaces.ProjectNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb" + visibility: "public" +--- +# `tokens` + +Returns the value of attribute tokens. + +## Signature + +```ruby +attr_reader tokens -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/project.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/create.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/create.mdx new file mode 100644 index 0000000000..8517ea0b09 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/project-tokens/create" +title: "create" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ProjectTokens#create" + parent: "SignalWire::REST::Namespaces::ProjectTokens" + module: "SignalWire.REST.Namespaces.ProjectTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb" + visibility: "public" +--- +# `create` + +## Signature + +```ruby +def create(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/project.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/delete.mdx new file mode 100644 index 0000000000..c7b70b1e62 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/project-tokens/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ProjectTokens#delete" + parent: "SignalWire::REST::Namespaces::ProjectTokens" + module: "SignalWire.REST.Namespaces.ProjectTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(token_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/project.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb) + +Line 18. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/index.mdx new file mode 100644 index 0000000000..9f3b7ee84d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/project-tokens" +title: "ProjectTokens" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ProjectTokens" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb" + visibility: "public" +--- +# `ProjectTokens` + +Project API token management. + +## Signature + +```ruby +class ProjectTokens < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/project.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/initialize.mdx new file mode 100644 index 0000000000..09322d79b4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/project-tokens/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ProjectTokens#initialize" + parent: "SignalWire::REST::Namespaces::ProjectTokens" + module: "SignalWire.REST.Namespaces.ProjectTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`ProjectTokens` — a new instance of ProjectTokens + +## Source + +[`lib/signalwire/rest/namespaces/project.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/update.mdx new file mode 100644 index 0000000000..e42ad64f0e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/project-tokens/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/project-tokens/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ProjectTokens#update" + parent: "SignalWire::REST::Namespaces::ProjectTokens" + module: "SignalWire.REST.Namespaces.ProjectTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(token_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/project.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/project.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/pub-sub-resource/create-token.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/pub-sub-resource/create-token.mdx new file mode 100644 index 0000000000..661adb79f5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/pub-sub-resource/create-token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/pub-sub-resource/create-token" +title: "create_token" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PubSubResource#create_token" + parent: "SignalWire::REST::Namespaces::PubSubResource" + module: "SignalWire.REST.Namespaces.PubSubResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/pubsub.rb" + visibility: "public" +--- +# `create_token` + +## Signature + +```ruby +def create_token(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/pubsub.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/pubsub.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/pub-sub-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/pub-sub-resource/index.mdx new file mode 100644 index 0000000000..e0156c6a7e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/pub-sub-resource/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/pub-sub-resource" +title: "PubSubResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PubSubResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/pubsub.rb" + visibility: "public" +--- +# `PubSubResource` + +PubSub token generation. + +## Signature + +```ruby +class PubSubResource < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/pubsub.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/pubsub.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/pub-sub-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/pub-sub-resource/initialize.mdx new file mode 100644 index 0000000000..96e65da52c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/pub-sub-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/pub-sub-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::PubSubResource#initialize" + parent: "SignalWire::REST::Namespaces::PubSubResource" + module: "SignalWire.REST.Namespaces.PubSubResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/pubsub.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`PubSubResource` — a new instance of PubSubResource + +## Source + +[`lib/signalwire/rest/namespaces/pubsub.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/pubsub.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/get-member.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/get-member.mdx new file mode 100644 index 0000000000..485739910b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/get-member.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/queues-resource/get-member" +title: "get_member" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::QueuesResource#get_member" + parent: "SignalWire::REST::Namespaces::QueuesResource" + module: "SignalWire.REST.Namespaces.QueuesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/queues.rb" + visibility: "public" +--- +# `get_member` + +## Signature + +```ruby +def get_member(queue_id, member_id) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/queues.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/queues.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/get-next-member.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/get-next-member.mdx new file mode 100644 index 0000000000..6adb6cb152 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/get-next-member.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/queues-resource/get-next-member" +title: "get_next_member" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::QueuesResource#get_next_member" + parent: "SignalWire::REST::Namespaces::QueuesResource" + module: "SignalWire.REST.Namespaces.QueuesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/queues.rb" + visibility: "public" +--- +# `get_next_member` + +## Signature + +```ruby +def get_next_member(queue_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/queues.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/queues.rb) + +Line 18. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/index.mdx new file mode 100644 index 0000000000..d822cdd4a0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/queues-resource" +title: "QueuesResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::QueuesResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/queues.rb" + visibility: "public" +--- +# `QueuesResource` + +Queue management with member operations. + +## Signature + +```ruby +class QueuesResource < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/queues.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/queues.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/initialize.mdx new file mode 100644 index 0000000000..e29b821067 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/queues-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::QueuesResource#initialize" + parent: "SignalWire::REST::Namespaces::QueuesResource" + module: "SignalWire.REST.Namespaces.QueuesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/queues.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`QueuesResource` — a new instance of QueuesResource + +## Source + +[`lib/signalwire/rest/namespaces/queues.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/queues.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/list-members.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/list-members.mdx new file mode 100644 index 0000000000..c3c1071e6b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/queues-resource/list-members.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/queues-resource/list-members" +title: "list_members" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::QueuesResource#list_members" + parent: "SignalWire::REST::Namespaces::QueuesResource" + module: "SignalWire.REST.Namespaces.QueuesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/queues.rb" + visibility: "public" +--- +# `list_members` + +## Signature + +```ruby +def list_members(queue_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/queues.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/queues.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/delete.mdx new file mode 100644 index 0000000000..2e8cdca0d7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/recordings-resource/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RecordingsResource#delete" + parent: "SignalWire::REST::Namespaces::RecordingsResource" + module: "SignalWire.REST.Namespaces.RecordingsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/recordings.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(recording_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/recordings.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/recordings.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/get.mdx new file mode 100644 index 0000000000..9335bf458e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/recordings-resource/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RecordingsResource#get" + parent: "SignalWire::REST::Namespaces::RecordingsResource" + module: "SignalWire.REST.Namespaces.RecordingsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/recordings.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(recording_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/recordings.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/recordings.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/index.mdx new file mode 100644 index 0000000000..dc2969c5c1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/recordings-resource" +title: "RecordingsResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RecordingsResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/recordings.rb" + visibility: "public" +--- +# `RecordingsResource` + +Recording management (read-only + delete). + +## Signature + +```ruby +class RecordingsResource < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/recordings.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/recordings.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/initialize.mdx new file mode 100644 index 0000000000..a20235cc57 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/recordings-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RecordingsResource#initialize" + parent: "SignalWire::REST::Namespaces::RecordingsResource" + module: "SignalWire.REST.Namespaces.RecordingsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/recordings.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`RecordingsResource` — a new instance of RecordingsResource + +## Source + +[`lib/signalwire/rest/namespaces/recordings.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/recordings.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/list.mdx new file mode 100644 index 0000000000..b17311e379 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/recordings-resource/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/recordings-resource/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RecordingsResource#list" + parent: "SignalWire::REST::Namespaces::RecordingsResource" + module: "SignalWire.REST.Namespaces.RecordingsResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/recordings.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/recordings.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/recordings.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/create-campaign.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/create-campaign.mdx new file mode 100644 index 0000000000..568850d27e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/create-campaign.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-brands/create-campaign" +title: "create_campaign" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryBrands#create_campaign" + parent: "SignalWire::REST::Namespaces::RegistryBrands" + module: "SignalWire.REST.Namespaces.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `create_campaign` + +## Signature + +```ruby +def create_campaign(brand_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/create.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/create.mdx new file mode 100644 index 0000000000..3bdc8a4583 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-brands/create" +title: "create" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryBrands#create" + parent: "SignalWire::REST::Namespaces::RegistryBrands" + module: "SignalWire.REST.Namespaces.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `create` + +## Signature + +```ruby +def create(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 9. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/get.mdx new file mode 100644 index 0000000000..c37f1af8d1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-brands/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryBrands#get" + parent: "SignalWire::REST::Namespaces::RegistryBrands" + module: "SignalWire.REST.Namespaces.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(brand_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/index.mdx new file mode 100644 index 0000000000..d456ccf990 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-brands" +title: "RegistryBrands" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryBrands" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `RegistryBrands` + +10DLC brand management. + +## Signature + +```ruby +class RegistryBrands < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/list-campaigns.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/list-campaigns.mdx new file mode 100644 index 0000000000..2bc3edef3c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/list-campaigns.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-brands/list-campaigns" +title: "list_campaigns" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryBrands#list_campaigns" + parent: "SignalWire::REST::Namespaces::RegistryBrands" + module: "SignalWire.REST.Namespaces.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `list_campaigns` + +## Signature + +```ruby +def list_campaigns(brand_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/list.mdx new file mode 100644 index 0000000000..4cf7711232 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-brands/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-brands/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryBrands#list" + parent: "SignalWire::REST::Namespaces::RegistryBrands" + module: "SignalWire.REST.Namespaces.RegistryBrands" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/create-order.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/create-order.mdx new file mode 100644 index 0000000000..b67807765e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/create-order.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-campaigns/create-order" +title: "create_order" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryCampaigns#create_order" + parent: "SignalWire::REST::Namespaces::RegistryCampaigns" + module: "SignalWire.REST.Namespaces.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `create_order` + +## Signature + +```ruby +def create_order(campaign_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 34. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/get.mdx new file mode 100644 index 0000000000..f8c2f6a4e3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-campaigns/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryCampaigns#get" + parent: "SignalWire::REST::Namespaces::RegistryCampaigns" + module: "SignalWire.REST.Namespaces.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(campaign_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/index.mdx new file mode 100644 index 0000000000..84158319a4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-campaigns" +title: "RegistryCampaigns" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryCampaigns" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `RegistryCampaigns` + +10DLC campaign management. + +## Signature + +```ruby +class RegistryCampaigns < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/list-numbers.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/list-numbers.mdx new file mode 100644 index 0000000000..f469ec1d6b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/list-numbers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-campaigns/list-numbers" +title: "list_numbers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryCampaigns#list_numbers" + parent: "SignalWire::REST::Namespaces::RegistryCampaigns" + module: "SignalWire.REST.Namespaces.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `list_numbers` + +## Signature + +```ruby +def list_numbers(campaign_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 26. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/list-orders.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/list-orders.mdx new file mode 100644 index 0000000000..b07225a71a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/list-orders.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-campaigns/list-orders" +title: "list_orders" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryCampaigns#list_orders" + parent: "SignalWire::REST::Namespaces::RegistryCampaigns" + module: "SignalWire.REST.Namespaces.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `list_orders` + +## Signature + +```ruby +def list_orders(campaign_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 30. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/update.mdx new file mode 100644 index 0000000000..ca2a05ed88 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-campaigns/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-campaigns/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryCampaigns#update" + parent: "SignalWire::REST::Namespaces::RegistryCampaigns" + module: "SignalWire.REST.Namespaces.RegistryCampaigns" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(campaign_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/brands.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/brands.mdx new file mode 100644 index 0000000000..410eb24e30 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/brands.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-namespace/brands" +title: "brands" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryNamespace#brands" + parent: "SignalWire::REST::Namespaces::RegistryNamespace" + module: "SignalWire.REST.Namespaces.RegistryNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `brands` + +Returns the value of attribute brands. + +## Signature + +```ruby +attr_reader brands -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 55. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/campaigns.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/campaigns.mdx new file mode 100644 index 0000000000..dc7b7133c5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/campaigns.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-namespace/campaigns" +title: "campaigns" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryNamespace#campaigns" + parent: "SignalWire::REST::Namespaces::RegistryNamespace" + module: "SignalWire.REST.Namespaces.RegistryNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `campaigns` + +Returns the value of attribute campaigns. + +## Signature + +```ruby +attr_reader campaigns -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 55. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/index.mdx new file mode 100644 index 0000000000..ff1f3bf270 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-namespace" +title: "RegistryNamespace" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryNamespace" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `RegistryNamespace` + +10DLC Campaign Registry namespace. + +## Signature + +```ruby +class RegistryNamespace < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute brands. + + + + Returns the value of attribute campaigns. + + + + + + Returns the value of attribute numbers. + + + + Returns the value of attribute orders. + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 54. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/initialize.mdx new file mode 100644 index 0000000000..173d4264ae --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-namespace/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryNamespace#initialize" + parent: "SignalWire::REST::Namespaces::RegistryNamespace" + module: "SignalWire.REST.Namespaces.RegistryNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`RegistryNamespace` — a new instance of RegistryNamespace + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/numbers.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/numbers.mdx new file mode 100644 index 0000000000..60c6088569 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/numbers.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-namespace/numbers" +title: "numbers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryNamespace#numbers" + parent: "SignalWire::REST::Namespaces::RegistryNamespace" + module: "SignalWire.REST.Namespaces.RegistryNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `numbers` + +Returns the value of attribute numbers. + +## Signature + +```ruby +attr_reader numbers -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 55. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/orders.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/orders.mdx new file mode 100644 index 0000000000..4a7ffa8195 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-namespace/orders.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-namespace/orders" +title: "orders" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryNamespace#orders" + parent: "SignalWire::REST::Namespaces::RegistryNamespace" + module: "SignalWire.REST.Namespaces.RegistryNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `orders` + +Returns the value of attribute orders. + +## Signature + +```ruby +attr_reader orders -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 55. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-numbers/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-numbers/delete.mdx new file mode 100644 index 0000000000..0253558939 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-numbers/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-numbers/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryNumbers#delete" + parent: "SignalWire::REST::Namespaces::RegistryNumbers" + module: "SignalWire.REST.Namespaces.RegistryNumbers" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(number_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 48. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-numbers/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-numbers/index.mdx new file mode 100644 index 0000000000..ab504463ca --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-numbers/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-numbers" +title: "RegistryNumbers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryNumbers" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `RegistryNumbers` + +10DLC number assignment management. + +## Signature + +```ruby +class RegistryNumbers < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 47. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-orders/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-orders/get.mdx new file mode 100644 index 0000000000..2b4ddb386e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-orders/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-orders/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryOrders#get" + parent: "SignalWire::REST::Namespaces::RegistryOrders" + module: "SignalWire.REST.Namespaces.RegistryOrders" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(order_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 41. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-orders/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-orders/index.mdx new file mode 100644 index 0000000000..6263c07695 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/registry-orders/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/registry-orders" +title: "RegistryOrders" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::RegistryOrders" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb" + visibility: "public" +--- +# `RegistryOrders` + +10DLC assignment order management. + +## Signature + +```ruby +class RegistryOrders < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + +## Source + +[`lib/signalwire/rest/namespaces/registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/registry.rb) + +Line 40. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/get.mdx new file mode 100644 index 0000000000..09bbc86ef3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/short-codes-resource/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ShortCodesResource#get" + parent: "SignalWire::REST::Namespaces::ShortCodesResource" + module: "SignalWire.REST.Namespaces.ShortCodesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/short_codes.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(short_code_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/short_codes.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/short_codes.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/index.mdx new file mode 100644 index 0000000000..b783479355 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/short-codes-resource" +title: "ShortCodesResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ShortCodesResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/short_codes.rb" + visibility: "public" +--- +# `ShortCodesResource` + +Short code management (read + update only). + +## Signature + +```ruby +class ShortCodesResource < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/short_codes.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/short_codes.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/initialize.mdx new file mode 100644 index 0000000000..b40b3b71cd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/short-codes-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ShortCodesResource#initialize" + parent: "SignalWire::REST::Namespaces::ShortCodesResource" + module: "SignalWire.REST.Namespaces.ShortCodesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/short_codes.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`ShortCodesResource` — a new instance of ShortCodesResource + +## Source + +[`lib/signalwire/rest/namespaces/short_codes.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/short_codes.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/list.mdx new file mode 100644 index 0000000000..3089b742ff --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/short-codes-resource/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ShortCodesResource#list" + parent: "SignalWire::REST::Namespaces::ShortCodesResource" + module: "SignalWire.REST.Namespaces.ShortCodesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/short_codes.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/short_codes.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/short_codes.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/update.mdx new file mode 100644 index 0000000000..35df65001b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/short-codes-resource/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/short-codes-resource/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::ShortCodesResource#update" + parent: "SignalWire::REST::Namespaces::ShortCodesResource" + module: "SignalWire.REST.Namespaces.ShortCodesResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/short_codes.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(short_code_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/short_codes.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/short_codes.rb) + +Line 20. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/get.mdx new file mode 100644 index 0000000000..962cb580a0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/get.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::SipProfileResource#get" + parent: "SignalWire::REST::Namespaces::SipProfileResource" + module: "SignalWire.REST.Namespaces.SipProfileResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/sip_profile.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get +``` + +## Source + +[`lib/signalwire/rest/namespaces/sip_profile.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/sip_profile.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/index.mdx new file mode 100644 index 0000000000..7ba1051c08 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/sip-profile-resource" +title: "SipProfileResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::SipProfileResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/sip_profile.rb" + visibility: "public" +--- +# `SipProfileResource` + +Project SIP profile (singleton resource). + +## Signature + +```ruby +class SipProfileResource < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/sip_profile.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/sip_profile.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/initialize.mdx new file mode 100644 index 0000000000..4da994aafb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::SipProfileResource#initialize" + parent: "SignalWire::REST::Namespaces::SipProfileResource" + module: "SignalWire.REST.Namespaces.SipProfileResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/sip_profile.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`SipProfileResource` — a new instance of SipProfileResource + +## Source + +[`lib/signalwire/rest/namespaces/sip_profile.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/sip_profile.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/update.mdx new file mode 100644 index 0000000000..4ffd2c0e07 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/update.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/sip-profile-resource/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::SipProfileResource#update" + parent: "SignalWire::REST::Namespaces::SipProfileResource" + module: "SignalWire.REST.Namespaces.SipProfileResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/sip_profile.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/sip_profile.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/sip_profile.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/create-sip-endpoint.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/create-sip-endpoint.mdx new file mode 100644 index 0000000000..c07aec22c1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/create-sip-endpoint.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/subscribers-resource/create-sip-endpoint" +title: "create_sip_endpoint" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::SubscribersResource#create_sip_endpoint" + parent: "SignalWire::REST::Namespaces::SubscribersResource" + module: "SignalWire.REST.Namespaces.SubscribersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `create_sip_endpoint` + +## Signature + +```ruby +def create_sip_endpoint(subscriber_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 90. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/delete-sip-endpoint.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/delete-sip-endpoint.mdx new file mode 100644 index 0000000000..15dfe5a638 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/delete-sip-endpoint.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/subscribers-resource/delete-sip-endpoint" +title: "delete_sip_endpoint" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::SubscribersResource#delete_sip_endpoint" + parent: "SignalWire::REST::Namespaces::SubscribersResource" + module: "SignalWire.REST.Namespaces.SubscribersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `delete_sip_endpoint` + +## Signature + +```ruby +def delete_sip_endpoint(subscriber_id, endpoint_id) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 102. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/get-sip-endpoint.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/get-sip-endpoint.mdx new file mode 100644 index 0000000000..80cf8b0569 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/get-sip-endpoint.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/subscribers-resource/get-sip-endpoint" +title: "get_sip_endpoint" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::SubscribersResource#get_sip_endpoint" + parent: "SignalWire::REST::Namespaces::SubscribersResource" + module: "SignalWire.REST.Namespaces.SubscribersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `get_sip_endpoint` + +## Signature + +```ruby +def get_sip_endpoint(subscriber_id, endpoint_id) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 94. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/index.mdx new file mode 100644 index 0000000000..c523ce4b23 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/subscribers-resource" +title: "SubscribersResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::SubscribersResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `SubscribersResource` + +Subscribers with SIP endpoint management. + +## Signature + +```ruby +class SubscribersResource < SignalWire::REST::Namespaces::FabricResourcePUT +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::FabricResourcePUT](/reference/ruby/signal-wire/rest/namespaces/fabric-resource-put) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 85. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/list-sip-endpoints.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/list-sip-endpoints.mdx new file mode 100644 index 0000000000..db41298a79 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/list-sip-endpoints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/subscribers-resource/list-sip-endpoints" +title: "list_sip_endpoints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::SubscribersResource#list_sip_endpoints" + parent: "SignalWire::REST::Namespaces::SubscribersResource" + module: "SignalWire.REST.Namespaces.SubscribersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `list_sip_endpoints` + +## Signature + +```ruby +def list_sip_endpoints(subscriber_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 86. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/update-sip-endpoint.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/update-sip-endpoint.mdx new file mode 100644 index 0000000000..30d7df1b57 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/subscribers-resource/update-sip-endpoint.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/subscribers-resource/update-sip-endpoint" +title: "update_sip_endpoint" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::SubscribersResource#update_sip_endpoint" + parent: "SignalWire::REST::Namespaces::SubscribersResource" + module: "SignalWire.REST.Namespaces.SubscribersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `update_sip_endpoint` + +## Signature + +```ruby +def update_sip_endpoint(subscriber_id, endpoint_id, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 98. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/swml-webhooks-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/swml-webhooks-resource/index.mdx new file mode 100644 index 0000000000..2ebd6be169 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/swml-webhooks-resource/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/swml-webhooks-resource" +title: "SwmlWebhooksResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::SwmlWebhooksResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb" + visibility: "public" +--- +# `SwmlWebhooksResource` + +SWML webhooks -- auto-materialized by +phone\_numbers.set\_swml\_webhook+. + +## Signature + +```ruby +class SwmlWebhooksResource < SignalWire::REST::Namespaces::AutoMaterializedWebhook +``` + +## Inheritance + +**Extends:** [SignalWire::REST::Namespaces::AutoMaterializedWebhook](/reference/ruby/signal-wire/rest/namespaces/auto-materialized-webhook) + +## Constants + + + +## Source + +[`lib/signalwire/rest/namespaces/fabric.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/fabric.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/index.mdx new file mode 100644 index 0000000000..ee1e76f767 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/verified-callers-resource" +title: "VerifiedCallersResource" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VerifiedCallersResource" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/verified_callers.rb" + visibility: "public" +--- +# `VerifiedCallersResource` + +Verified caller ID management with verification flow. + +## Signature + +```ruby +class VerifiedCallersResource < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/verified_callers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/verified_callers.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/initialize.mdx new file mode 100644 index 0000000000..2ae77fdf6f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VerifiedCallersResource#initialize" + parent: "SignalWire::REST::Namespaces::VerifiedCallersResource" + module: "SignalWire.REST.Namespaces.VerifiedCallersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/verified_callers.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`VerifiedCallersResource` — a new instance of VerifiedCallersResource + +## Source + +[`lib/signalwire/rest/namespaces/verified_callers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/verified_callers.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/redial-verification.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/redial-verification.mdx new file mode 100644 index 0000000000..be73f37ac0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/redial-verification.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/redial-verification" +title: "redial_verification" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VerifiedCallersResource#redial_verification" + parent: "SignalWire::REST::Namespaces::VerifiedCallersResource" + module: "SignalWire.REST.Namespaces.VerifiedCallersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/verified_callers.rb" + visibility: "public" +--- +# `redial_verification` + +## Signature + +```ruby +def redial_verification(caller_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/verified_callers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/verified_callers.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/submit-verification.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/submit-verification.mdx new file mode 100644 index 0000000000..4c11357da4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/submit-verification.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/verified-callers-resource/submit-verification" +title: "submit_verification" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VerifiedCallersResource#submit_verification" + parent: "SignalWire::REST::Namespaces::VerifiedCallersResource" + module: "SignalWire.REST.Namespaces.VerifiedCallersResource" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/verified_callers.rb" + visibility: "public" +--- +# `submit_verification` + +## Signature + +```ruby +def submit_verification(caller_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/verified_callers.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/verified_callers.rb) + +Line 18. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conference-tokens/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conference-tokens/get.mdx new file mode 100644 index 0000000000..7d76ba5872 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conference-tokens/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-conference-tokens/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoConferenceTokens#get" + parent: "SignalWire::REST::Namespaces::VideoConferenceTokens" + module: "SignalWire.REST.Namespaces.VideoConferenceTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(token_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 87. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conference-tokens/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conference-tokens/index.mdx new file mode 100644 index 0000000000..d7e427d5d8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conference-tokens/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-conference-tokens" +title: "VideoConferenceTokens" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoConferenceTokens" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `VideoConferenceTokens` + +Video conference token management. + +## Signature + +```ruby +class VideoConferenceTokens < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 86. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conference-tokens/reset.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conference-tokens/reset.mdx new file mode 100644 index 0000000000..61154d7428 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conference-tokens/reset.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-conference-tokens/reset" +title: "reset" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoConferenceTokens#reset" + parent: "SignalWire::REST::Namespaces::VideoConferenceTokens" + module: "SignalWire.REST.Namespaces.VideoConferenceTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `reset` + +## Signature + +```ruby +def reset(token_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 91. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/create-stream.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/create-stream.mdx new file mode 100644 index 0000000000..24003d81e2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/create-stream.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-conferences/create-stream" +title: "create_stream" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoConferences#create_stream" + parent: "SignalWire::REST::Namespaces::VideoConferences" + module: "SignalWire.REST.Namespaces.VideoConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `create_stream` + +## Signature + +```ruby +def create_stream(conference_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 80. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/index.mdx new file mode 100644 index 0000000000..41b5facd08 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-conferences" +title: "VideoConferences" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoConferences" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `VideoConferences` + +Video conference management with tokens and streams. + +## Signature + +```ruby +class VideoConferences < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 69. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/list-conference-tokens.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/list-conference-tokens.mdx new file mode 100644 index 0000000000..2d65f91ea9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/list-conference-tokens.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-conferences/list-conference-tokens" +title: "list_conference_tokens" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoConferences#list_conference_tokens" + parent: "SignalWire::REST::Namespaces::VideoConferences" + module: "SignalWire.REST.Namespaces.VideoConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `list_conference_tokens` + +## Signature + +```ruby +def list_conference_tokens(conference_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 72. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/list-streams.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/list-streams.mdx new file mode 100644 index 0000000000..83dde0d9cc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-conferences/list-streams.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-conferences/list-streams" +title: "list_streams" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoConferences#list_streams" + parent: "SignalWire::REST::Namespaces::VideoConferences" + module: "SignalWire.REST.Namespaces.VideoConferences" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `list_streams` + +## Signature + +```ruby +def list_streams(conference_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 76. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/conference-tokens.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/conference-tokens.mdx new file mode 100644 index 0000000000..4468d224a7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/conference-tokens.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-namespace/conference-tokens" +title: "conference_tokens" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoNamespace#conference_tokens" + parent: "SignalWire::REST::Namespaces::VideoNamespace" + module: "SignalWire.REST.Namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `conference_tokens` + +Returns the value of attribute conference\_tokens. + +## Signature + +```ruby +attr_reader conference_tokens -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 113. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/conferences.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/conferences.mdx new file mode 100644 index 0000000000..23b349443a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/conferences.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-namespace/conferences" +title: "conferences" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoNamespace#conferences" + parent: "SignalWire::REST::Namespaces::VideoNamespace" + module: "SignalWire.REST.Namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `conferences` + +Returns the value of attribute conferences. + +## Signature + +```ruby +attr_reader conferences -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 113. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/index.mdx new file mode 100644 index 0000000000..455dfee61b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/index.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-namespace" +title: "VideoNamespace" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoNamespace" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `VideoNamespace` + +Video API namespace. + +## Signature + +```ruby +class VideoNamespace < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute conference\_tokens. + + + + Returns the value of attribute conferences. + + + + + + Returns the value of attribute room\_recordings. + + + + Returns the value of attribute room\_sessions. + + + + Returns the value of attribute room\_tokens. + + + + Returns the value of attribute rooms. + + + + Returns the value of attribute streams. + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 112. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/initialize.mdx new file mode 100644 index 0000000000..7de9682fee --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-namespace/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoNamespace#initialize" + parent: "SignalWire::REST::Namespaces::VideoNamespace" + module: "SignalWire.REST.Namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http) +``` + +## Parameters + + + +## Returns + +`VideoNamespace` — a new instance of VideoNamespace + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 116. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/room-recordings.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/room-recordings.mdx new file mode 100644 index 0000000000..7f7f88c7d0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/room-recordings.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-namespace/room-recordings" +title: "room_recordings" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoNamespace#room_recordings" + parent: "SignalWire::REST::Namespaces::VideoNamespace" + module: "SignalWire.REST.Namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `room_recordings` + +Returns the value of attribute room\_recordings. + +## Signature + +```ruby +attr_reader room_recordings -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 113. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/room-sessions.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/room-sessions.mdx new file mode 100644 index 0000000000..b1c5f9ad1c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/room-sessions.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-namespace/room-sessions" +title: "room_sessions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoNamespace#room_sessions" + parent: "SignalWire::REST::Namespaces::VideoNamespace" + module: "SignalWire.REST.Namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `room_sessions` + +Returns the value of attribute room\_sessions. + +## Signature + +```ruby +attr_reader room_sessions -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 113. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/room-tokens.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/room-tokens.mdx new file mode 100644 index 0000000000..8653358645 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/room-tokens.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-namespace/room-tokens" +title: "room_tokens" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoNamespace#room_tokens" + parent: "SignalWire::REST::Namespaces::VideoNamespace" + module: "SignalWire.REST.Namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `room_tokens` + +Returns the value of attribute room\_tokens. + +## Signature + +```ruby +attr_reader room_tokens -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 113. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/rooms.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/rooms.mdx new file mode 100644 index 0000000000..85ab068e0c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/rooms.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-namespace/rooms" +title: "rooms" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoNamespace#rooms" + parent: "SignalWire::REST::Namespaces::VideoNamespace" + module: "SignalWire.REST.Namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `rooms` + +Returns the value of attribute rooms. + +## Signature + +```ruby +attr_reader rooms -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 113. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/streams.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/streams.mdx new file mode 100644 index 0000000000..f0bca18029 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-namespace/streams.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-namespace/streams" +title: "streams" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoNamespace#streams" + parent: "SignalWire::REST::Namespaces::VideoNamespace" + module: "SignalWire.REST.Namespaces.VideoNamespace" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `streams` + +Returns the value of attribute streams. + +## Signature + +```ruby +attr_reader streams -> Object +``` + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 113. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/delete.mdx new file mode 100644 index 0000000000..551b033a47 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-recordings/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomRecordings#delete" + parent: "SignalWire::REST::Namespaces::VideoRoomRecordings" + module: "SignalWire.REST.Namespaces.VideoRoomRecordings" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(recording_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 59. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/get.mdx new file mode 100644 index 0000000000..c4056d255f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-recordings/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomRecordings#get" + parent: "SignalWire::REST::Namespaces::VideoRoomRecordings" + module: "SignalWire.REST.Namespaces.VideoRoomRecordings" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(recording_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 55. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/index.mdx new file mode 100644 index 0000000000..bf239ad30c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-recordings" +title: "VideoRoomRecordings" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomRecordings" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `VideoRoomRecordings` + +Video room recording management. + +## Signature + +```ruby +class VideoRoomRecordings < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/list-events.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/list-events.mdx new file mode 100644 index 0000000000..fc71b82b44 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/list-events.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-recordings/list-events" +title: "list_events" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomRecordings#list_events" + parent: "SignalWire::REST::Namespaces::VideoRoomRecordings" + module: "SignalWire.REST.Namespaces.VideoRoomRecordings" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `list_events` + +## Signature + +```ruby +def list_events(recording_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 63. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/list.mdx new file mode 100644 index 0000000000..dcbd1321db --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-recordings/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-recordings/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomRecordings#list" + parent: "SignalWire::REST::Namespaces::VideoRoomRecordings" + module: "SignalWire.REST.Namespaces.VideoRoomRecordings" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 51. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/get.mdx new file mode 100644 index 0000000000..7b256c34ad --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-sessions/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomSessions#get" + parent: "SignalWire::REST::Namespaces::VideoRoomSessions" + module: "SignalWire.REST.Namespaces.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(session_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 32. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/index.mdx new file mode 100644 index 0000000000..da7b0bc1e5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-sessions" +title: "VideoRoomSessions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomSessions" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `VideoRoomSessions` + +Video room session management. + +## Signature + +```ruby +class VideoRoomSessions < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 27. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-events.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-events.mdx new file mode 100644 index 0000000000..22b0f1ec2e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-events.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-events" +title: "list_events" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomSessions#list_events" + parent: "SignalWire::REST::Namespaces::VideoRoomSessions" + module: "SignalWire.REST.Namespaces.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `list_events` + +## Signature + +```ruby +def list_events(session_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 36. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-members.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-members.mdx new file mode 100644 index 0000000000..bf6c3a11d4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-members.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-members" +title: "list_members" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomSessions#list_members" + parent: "SignalWire::REST::Namespaces::VideoRoomSessions" + module: "SignalWire.REST.Namespaces.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `list_members` + +## Signature + +```ruby +def list_members(session_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 40. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-recordings.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-recordings.mdx new file mode 100644 index 0000000000..8c718ed41f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-recordings.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list-recordings" +title: "list_recordings" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomSessions#list_recordings" + parent: "SignalWire::REST::Namespaces::VideoRoomSessions" + module: "SignalWire.REST.Namespaces.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `list_recordings` + +## Signature + +```ruby +def list_recordings(session_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 44. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list.mdx new file mode 100644 index 0000000000..88bc066413 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-sessions/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomSessions#list" + parent: "SignalWire::REST::Namespaces::VideoRoomSessions" + module: "SignalWire.REST.Namespaces.VideoRoomSessions" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 28. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-tokens/create.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-tokens/create.mdx new file mode 100644 index 0000000000..fd9bd822e3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-tokens/create.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-tokens/create" +title: "create" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomTokens#create" + parent: "SignalWire::REST::Namespaces::VideoRoomTokens" + module: "SignalWire.REST.Namespaces.VideoRoomTokens" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `create` + +## Signature + +```ruby +def create(**kwargs) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-tokens/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-tokens/index.mdx new file mode 100644 index 0000000000..a5e491b6a5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-room-tokens/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-room-tokens" +title: "VideoRoomTokens" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRoomTokens" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `VideoRoomTokens` + +Video room token generation. + +## Signature + +```ruby +class VideoRoomTokens < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 20. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-rooms/create-stream.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-rooms/create-stream.mdx new file mode 100644 index 0000000000..7cfdf31ea2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-rooms/create-stream.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-rooms/create-stream" +title: "create_stream" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRooms#create_stream" + parent: "SignalWire::REST::Namespaces::VideoRooms" + module: "SignalWire.REST.Namespaces.VideoRooms" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `create_stream` + +## Signature + +```ruby +def create_stream(room_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-rooms/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-rooms/index.mdx new file mode 100644 index 0000000000..2f2f6ac4ab --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-rooms/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-rooms" +title: "VideoRooms" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRooms" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `VideoRooms` + +Video room management with streams. + +## Signature + +```ruby +class VideoRooms < SignalWire::REST::CrudResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::CrudResource](/reference/ruby/signal-wire/rest/crud-resource) + +## Methods + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-rooms/list-streams.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-rooms/list-streams.mdx new file mode 100644 index 0000000000..e08d18a4eb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-rooms/list-streams.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-rooms/list-streams" +title: "list_streams" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoRooms#list_streams" + parent: "SignalWire::REST::Namespaces::VideoRooms" + module: "SignalWire.REST.Namespaces.VideoRooms" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `list_streams` + +## Signature + +```ruby +def list_streams(room_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/delete.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/delete.mdx new file mode 100644 index 0000000000..7493f36184 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/delete.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-streams/delete" +title: "delete" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoStreams#delete" + parent: "SignalWire::REST::Namespaces::VideoStreams" + module: "SignalWire.REST.Namespaces.VideoStreams" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `delete` + +## Signature + +```ruby +def delete(stream_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 106. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/get.mdx new file mode 100644 index 0000000000..5647bd09cb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-streams/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoStreams#get" + parent: "SignalWire::REST::Namespaces::VideoStreams" + module: "SignalWire.REST.Namespaces.VideoStreams" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(stream_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 98. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/index.mdx new file mode 100644 index 0000000000..25727a5ea9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-streams" +title: "VideoStreams" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoStreams" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `VideoStreams` + +Video stream management. + +## Signature + +```ruby +class VideoStreams < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 97. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/update.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/update.mdx new file mode 100644 index 0000000000..0f118282c7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/video-streams/update.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/video-streams/update" +title: "update" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VideoStreams#update" + parent: "SignalWire::REST::Namespaces::VideoStreams" + module: "SignalWire.REST.Namespaces.VideoStreams" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb" + visibility: "public" +--- +# `update` + +## Signature + +```ruby +def update(stream_id, **kwargs) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/video.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/video.rb) + +Line 102. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/get.mdx new file mode 100644 index 0000000000..65896e4b8f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/get.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/voice-logs/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VoiceLogs#get" + parent: "SignalWire::REST::Namespaces::VoiceLogs" + module: "SignalWire.REST.Namespaces.VoiceLogs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `get` + +## Signature + +```ruby +def get(log_id) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/index.mdx new file mode 100644 index 0000000000..6e553b7be0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/voice-logs" +title: "VoiceLogs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VoiceLogs" + parent: "SignalWire::REST::Namespaces" + module: "SignalWire.REST.Namespaces" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `VoiceLogs` + +Voice log queries. + +## Signature + +```ruby +class VoiceLogs < SignalWire::REST::BaseResource +``` + +## Inheritance + +**Extends:** [SignalWire::REST::BaseResource](/reference/ruby/signal-wire/rest/base-resource) + +## Methods + + + + + + + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/list-events.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/list-events.mdx new file mode 100644 index 0000000000..1e613e5729 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/list-events.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/voice-logs/list-events" +title: "list_events" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VoiceLogs#list_events" + parent: "SignalWire::REST::Namespaces::VoiceLogs" + module: "SignalWire.REST.Namespaces.VoiceLogs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `list_events` + +## Signature + +```ruby +def list_events(log_id, **params) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/list.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/list.mdx new file mode 100644 index 0000000000..01e6d16005 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/namespaces/voice-logs/list.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/namespaces/voice-logs/list" +title: "list" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::Namespaces::VoiceLogs#list" + parent: "SignalWire::REST::Namespaces::VoiceLogs" + module: "SignalWire.REST.Namespaces.VoiceLogs" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb" + visibility: "public" +--- +# `list` + +## Signature + +```ruby +def list(**params) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/rest/namespaces/logs.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/namespaces/logs.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/data-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/data-key.mdx new file mode 100644 index 0000000000..5fa581d953 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/data-key.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/paginated-iterator/data-key" +title: "data_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::PaginatedIterator#data_key" + parent: "SignalWire::REST::PaginatedIterator" + module: "SignalWire.REST.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `data_key` + +Returns the value of attribute data\_key. + +## Signature + +```ruby +attr_reader data_key -> Object +``` + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/done.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/done.mdx new file mode 100644 index 0000000000..e04614703f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/done.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/paginated-iterator/done" +title: "done" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::PaginatedIterator#done" + parent: "SignalWire::REST::PaginatedIterator" + module: "SignalWire.REST.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `done` + +Returns the value of attribute done. + +## Signature + +```ruby +attr_reader done -> Object +``` + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/each.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/each.mdx new file mode 100644 index 0000000000..00e05c4fcf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/each.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/rest/paginated-iterator/each" +title: "each" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::PaginatedIterator#each" + parent: "SignalWire::REST::PaginatedIterator" + module: "SignalWire.REST.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `each` + +## Signature + +```ruby +def each +``` + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 34. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/http.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/http.mdx new file mode 100644 index 0000000000..9310dcb32f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/http.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/paginated-iterator/http" +title: "http" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::PaginatedIterator#http" + parent: "SignalWire::REST::PaginatedIterator" + module: "SignalWire.REST.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `http` + +Returns the value of attribute http. + +## Signature + +```ruby +attr_reader http -> Object +``` + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/index.mdx new file mode 100644 index 0000000000..fc405927fc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/index.mdx @@ -0,0 +1,88 @@ +--- +slug: "/reference/ruby/signal-wire/rest/paginated-iterator" +title: "PaginatedIterator" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::PaginatedIterator" + parent: "SignalWire::REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `PaginatedIterator` + +Iterates items across paginated API responses. + +Mirrors the Python PaginatedIterator (signalwire.rest.\_pagination): +the constructor records http/path/params/data\_key without fetching; +iteration walks pages by following the +links.next+ cursor. + +Usage: +iter = SignalWire::REST::PaginatedIterator.new(http, '/api/path', +params: \{\}, data\_key: 'data') +iter.each \{ |item| ... \} + +The iterator is single-pass (matching Python's **next** semantics); +use #to\_a to collect every item across all pages. + +## Signature + +```ruby +class PaginatedIterator < Object +``` + +## Inheritance + +**Extends:** `Object` + +**Mixins:** `Enumerable` + +## Methods + + + + Returns the value of attribute data\_key. + + + + Returns the value of attribute done. + + + + + + Returns the value of attribute http. + + + + Returns the value of attribute index. + + + + + + Returns the value of attribute items. + + + + Equivalent of Python's **next**. Returns the sentinel +:**stop**+ when exhausted (Ruby has no StopIteration error idiom for plain Enumerable), but the public surface is +#each+. + + + + Returns the value of attribute params. + + + + Returns the value of attribute path. + + + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 18. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/index__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/index__2.mdx new file mode 100644 index 0000000000..550d3f07ef --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/index__2.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/paginated-iterator/index__2" +title: "index" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::PaginatedIterator#index" + parent: "SignalWire::REST::PaginatedIterator" + module: "SignalWire.REST.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `index` + +Returns the value of attribute index. + +## Signature + +```ruby +attr_reader index -> Object +``` + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/initialize.mdx new file mode 100644 index 0000000000..0c1d88d073 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/initialize.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/rest/paginated-iterator/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::PaginatedIterator#initialize" + parent: "SignalWire::REST::PaginatedIterator" + module: "SignalWire.REST.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(http, path, params = nil, data_key = 'data') +``` + +## Parameters + + + + + + + + + +## Returns + +`PaginatedIterator` — a new instance of PaginatedIterator + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/items.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/items.mdx new file mode 100644 index 0000000000..2216cf14f1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/items.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/paginated-iterator/items" +title: "items" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::PaginatedIterator#items" + parent: "SignalWire::REST::PaginatedIterator" + module: "SignalWire.REST.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `items` + +Returns the value of attribute items. + +## Signature + +```ruby +attr_reader items -> Object +``` + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/next-item.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/next-item.mdx new file mode 100644 index 0000000000..be4815fe56 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/next-item.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/rest/paginated-iterator/next-item" +title: "next_item" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::PaginatedIterator#next_item" + parent: "SignalWire::REST::PaginatedIterator" + module: "SignalWire.REST.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `next_item` + +Equivalent of Python's **next**. Returns the sentinel +:**stop**+ +when exhausted (Ruby has no StopIteration error idiom for plain +Enumerable), but the public surface is +#each+. + +## Signature + +```ruby +def next_item +``` + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 48. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/params.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/params.mdx new file mode 100644 index 0000000000..f0efd61747 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/params.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/paginated-iterator/params" +title: "params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::PaginatedIterator#params" + parent: "SignalWire::REST::PaginatedIterator" + module: "SignalWire.REST.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `params` + +Returns the value of attribute params. + +## Signature + +```ruby +attr_reader params -> Object +``` + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/path.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/path.mdx new file mode 100644 index 0000000000..7d4c358aee --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/paginated-iterator/path.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/paginated-iterator/path" +title: "path" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::PaginatedIterator#path" + parent: "SignalWire::REST::PaginatedIterator" + module: "SignalWire.REST.PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb" + visibility: "public" +--- +# `path` + +Returns the value of attribute path. + +## Signature + +```ruby +attr_reader path -> Object +``` + +## Source + +[`lib/signalwire/rest/pagination.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/pagination.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/phone-call-handler/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/phone-call-handler/index.mdx new file mode 100644 index 0000000000..79c6a6f10f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/phone-call-handler/index.mdx @@ -0,0 +1,93 @@ +--- +slug: "/reference/ruby/signal-wire/rest/phone-call-handler" +title: "PhoneCallHandler" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::REST::PhoneCallHandler" + parent: "SignalWire::REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/phone_call_handler.rb" + visibility: "public" +--- +# `PhoneCallHandler` + +PhoneCallHandler -- enum-like constants of the +call\_handler+ values +accepted by +phone\_numbers.update+. + +Named +PhoneCallHandler+ (not +CallHandler+) to avoid colliding with +the RELAY client's inbound-call-handler callback (+Relay::Client#on\_call+). + +Setting a phone number's +call\_handler+ together with the handler-specific +companion field routes inbound calls and auto-materializes the matching +Fabric resource on the server. See the high-level helpers on ++SignalWire::REST::Namespaces::PhoneNumbersResource+. + +\=== Mapping + +Constant | Companion field (required) | Auto-creates resource +\------------------+--------------------------------+---------------------- +RELAY\_SCRIPT | call\_relay\_script\_url | swml\_webhook +LAML\_WEBHOOKS | call\_request\_url | cxml\_webhook +LAML\_APPLICATION | call\_laml\_application\_id | cxml\_application +AI\_AGENT | call\_ai\_agent\_id | ai\_agent +CALL\_FLOW | call\_flow\_id | call\_flow +RELAY\_APPLICATION | call\_relay\_application | relay\_application +RELAY\_TOPIC | call\_relay\_topic | (routes via RELAY) +RELAY\_CONTEXT | call\_relay\_context | (legacy, prefer topic) +RELAY\_CONNECTOR | (connector config) | (internal) +VIDEO\_ROOM | call\_video\_room\_id | (routes to Video API) +DIALOGFLOW | call\_dialogflow\_agent\_id | (none) + +Note: +LAML\_WEBHOOKS+ (wire value +laml\_webhooks+) produces a _cXML_ +handler despite the plural name, not a generic webhook. For SWML, use ++RELAY\_SCRIPT+. + +## Signature + +```ruby +module PhoneCallHandler +``` + +## Constants + + + + + All supported wire values, in the same order as the constants. + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/rest/phone_call_handler.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/phone_call_handler.rb) + +Line 35. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/addresses.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/addresses.mdx new file mode 100644 index 0000000000..91f4d0444a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/addresses.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/addresses" +title: "addresses" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#addresses" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `addresses` + +Returns the value of attribute addresses. + +## Signature + +```ruby +attr_reader addresses -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/calling.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/calling.mdx new file mode 100644 index 0000000000..a4f4b66f25 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/calling.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/calling" +title: "calling" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#calling" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `calling` + +Returns the value of attribute calling. + +## Signature + +```ruby +attr_reader calling -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/chat.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/chat.mdx new file mode 100644 index 0000000000..9e6cbed45b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/chat.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/chat" +title: "chat" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#chat" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `chat` + +Returns the value of attribute chat. + +## Signature + +```ruby +attr_reader chat -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/compat.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/compat.mdx new file mode 100644 index 0000000000..c4d60f594a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/compat.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/compat" +title: "compat" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#compat" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `compat` + +Returns the value of attribute compat. + +## Signature + +```ruby +attr_reader compat -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/datasphere.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/datasphere.mdx new file mode 100644 index 0000000000..335be8cdba --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/datasphere.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/datasphere" +title: "datasphere" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#datasphere" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `datasphere` + +Returns the value of attribute datasphere. + +## Signature + +```ruby +attr_reader datasphere -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/fabric.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/fabric.mdx new file mode 100644 index 0000000000..8fb78cc8cb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/fabric.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/fabric" +title: "fabric" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#fabric" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `fabric` + +Returns the value of attribute fabric. + +## Signature + +```ruby +attr_reader fabric -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/http.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/http.mdx new file mode 100644 index 0000000000..b7a1c75ca6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/http.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/http" +title: "http" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#http" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `http` + +Returns the value of attribute http. + +## Signature + +```ruby +attr_reader http -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/imported-numbers.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/imported-numbers.mdx new file mode 100644 index 0000000000..c9de56882c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/imported-numbers.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/imported-numbers" +title: "imported_numbers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#imported_numbers" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `imported_numbers` + +Returns the value of attribute imported\_numbers. + +## Signature + +```ruby +attr_reader imported_numbers -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/index.mdx new file mode 100644 index 0000000000..7dc75741eb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/index.mdx @@ -0,0 +1,155 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client" +title: "RestClient" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient" + parent: "SignalWire::REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `RestClient` + +REST client for the SignalWire platform APIs. + +Usage: +client = SignalWire::REST::RestClient.new( +project: 'your-project-id', +token: 'your-api-token', +host: 'your-space.signalwire.com' +) + +# Or use environment variables: + +# SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, SIGNALWIRE\_SPACE + +client = SignalWire::REST::RestClient.new + +# Use namespaced resources + +client.fabric.ai\_agents.list +client.calling.play(call\_id, play: \[...]) +client.phone\_numbers.search(area\_code: '512') +client.video.rooms.create(name: 'standup') +client.compat.calls.list + +## Signature + +```ruby +class RestClient < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute addresses. + + + + Returns the value of attribute calling. + + + + Returns the value of attribute chat. + + + + Returns the value of attribute compat. + + + + Returns the value of attribute datasphere. + + + + Returns the value of attribute fabric. + + + + Returns the value of attribute http. + + + + Returns the value of attribute imported\_numbers. + + + + +base\_url+ overrides the derived +https://\{space\}+ default. The audit harness uses this to point at the local fixture server. + + + + Returns the value of attribute logs. + + + + Returns the value of attribute lookup. + + + + Returns the value of attribute mfa. + + + + Returns the value of attribute number\_groups. + + + + Returns the value of attribute phone\_numbers. + + + + Returns the value of attribute project. + + + + Returns the value of attribute project\_id. + + + + Returns the value of attribute pubsub. + + + + Returns the value of attribute queues. + + + + Returns the value of attribute recordings. + + + + Returns the value of attribute registry. + + + + Returns the value of attribute short\_codes. + + + + Returns the value of attribute sip\_profile. + + + + Returns the value of attribute verified\_callers. + + + + Returns the value of attribute video. + + + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/initialize.mdx new file mode 100644 index 0000000000..aa90a3fb15 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/initialize.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#initialize" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `initialize` + ++base\_url+ overrides the derived +https://\{space\}+ default. The +audit harness uses this to point at the local fixture server. + +## Signature + +```ruby +def initialize(project: nil, token: nil, host: nil, base_url: nil) +``` + +## Parameters + + + + + + + + + +## Returns + +`RestClient` — a new instance of RestClient + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 58. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/logs.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/logs.mdx new file mode 100644 index 0000000000..ca0a9e197b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/logs.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/logs" +title: "logs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#logs" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `logs` + +Returns the value of attribute logs. + +## Signature + +```ruby +attr_reader logs -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/lookup.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/lookup.mdx new file mode 100644 index 0000000000..5dc449b9d8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/lookup.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/lookup" +title: "lookup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#lookup" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `lookup` + +Returns the value of attribute lookup. + +## Signature + +```ruby +attr_reader lookup -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/mfa.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/mfa.mdx new file mode 100644 index 0000000000..4ba15ab22a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/mfa.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/mfa" +title: "mfa" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#mfa" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `mfa` + +Returns the value of attribute mfa. + +## Signature + +```ruby +attr_reader mfa -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/number-groups.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/number-groups.mdx new file mode 100644 index 0000000000..1c83b7a92a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/number-groups.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/number-groups" +title: "number_groups" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#number_groups" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `number_groups` + +Returns the value of attribute number\_groups. + +## Signature + +```ruby +attr_reader number_groups -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/phone-numbers.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/phone-numbers.mdx new file mode 100644 index 0000000000..4926f8b14b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/phone-numbers.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/phone-numbers" +title: "phone_numbers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#phone_numbers" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `phone_numbers` + +Returns the value of attribute phone\_numbers. + +## Signature + +```ruby +attr_reader phone_numbers -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/project-id.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/project-id.mdx new file mode 100644 index 0000000000..092e910d46 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/project-id.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/project-id" +title: "project_id" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#project_id" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `project_id` + +Returns the value of attribute project\_id. + +## Signature + +```ruby +attr_reader project_id -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/project.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/project.mdx new file mode 100644 index 0000000000..f7f68bcb7a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/project.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/project" +title: "project" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#project" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `project` + +Returns the value of attribute project. + +## Signature + +```ruby +attr_reader project -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/pubsub.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/pubsub.mdx new file mode 100644 index 0000000000..4b7131e96c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/pubsub.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/pubsub" +title: "pubsub" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#pubsub" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `pubsub` + +Returns the value of attribute pubsub. + +## Signature + +```ruby +attr_reader pubsub -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/queues.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/queues.mdx new file mode 100644 index 0000000000..fe2915288e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/queues.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/queues" +title: "queues" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#queues" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `queues` + +Returns the value of attribute queues. + +## Signature + +```ruby +attr_reader queues -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/recordings.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/recordings.mdx new file mode 100644 index 0000000000..66841d4042 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/recordings.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/recordings" +title: "recordings" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#recordings" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `recordings` + +Returns the value of attribute recordings. + +## Signature + +```ruby +attr_reader recordings -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/registry.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/registry.mdx new file mode 100644 index 0000000000..9703397c22 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/registry.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/registry" +title: "registry" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#registry" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `registry` + +Returns the value of attribute registry. + +## Signature + +```ruby +attr_reader registry -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/short-codes.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/short-codes.mdx new file mode 100644 index 0000000000..c3c602f769 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/short-codes.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/short-codes" +title: "short_codes" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#short_codes" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `short_codes` + +Returns the value of attribute short\_codes. + +## Signature + +```ruby +attr_reader short_codes -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/sip-profile.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/sip-profile.mdx new file mode 100644 index 0000000000..8621efdefc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/sip-profile.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/sip-profile" +title: "sip_profile" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#sip_profile" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `sip_profile` + +Returns the value of attribute sip\_profile. + +## Signature + +```ruby +attr_reader sip_profile -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/verified-callers.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/verified-callers.mdx new file mode 100644 index 0000000000..7ebd56fc4e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/verified-callers.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/verified-callers" +title: "verified_callers" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#verified_callers" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `verified_callers` + +Returns the value of attribute verified\_callers. + +## Signature + +```ruby +attr_reader verified_callers -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/video.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/video.mdx new file mode 100644 index 0000000000..e31a764100 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/rest-client/video.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/rest-client/video" +title: "video" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::RestClient#video" + parent: "SignalWire::REST::RestClient" + module: "SignalWire.REST.RestClient" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb" + visibility: "public" +--- +# `video` + +Returns the value of attribute video. + +## Signature + +```ruby +attr_reader video -> Object +``` + +## Source + +[`lib/signalwire/rest/rest_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/rest_client.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/body.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/body.mdx new file mode 100644 index 0000000000..da210ee1f0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/body.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/signal-wire-rest-error/body" +title: "body" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::SignalWireRestError#body" + parent: "SignalWire::REST::SignalWireRestError" + module: "SignalWire.REST.SignalWireRestError" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `body` + +Returns the value of attribute body. + +## Signature + +```ruby +attr_reader body -> Object +``` + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/index.mdx new file mode 100644 index 0000000000..1367cc9471 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/ruby/signal-wire/rest/signal-wire-rest-error" +title: "SignalWireRestError" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::REST::SignalWireRestError" + parent: "SignalWire::REST" + module: "SignalWire.REST" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `SignalWireRestError` + +Raised when the SignalWire REST API returns a non-2xx response. + +## Signature + +```ruby +class SignalWireRestError < StandardError +``` + +## Inheritance + +**Extends:** `StandardError` + +## Methods + + + + Returns the value of attribute body. + + + + + + Returns the value of attribute method\_name. + + + + Returns the value of attribute status\_code. + + + + Returns the value of attribute url. + + + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/initialize.mdx new file mode 100644 index 0000000000..288ed3e8a1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/initialize.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/rest/signal-wire-rest-error/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::SignalWireRestError#initialize" + parent: "SignalWire::REST::SignalWireRestError" + module: "SignalWire.REST.SignalWireRestError" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(status_code, body, url, method_name = 'GET') +``` + +## Parameters + + + + + + + + + +## Returns + +`SignalWireRestError` — a new instance of SignalWireRestError + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/method-name.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/method-name.mdx new file mode 100644 index 0000000000..653f352399 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/method-name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/signal-wire-rest-error/method-name" +title: "method_name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::SignalWireRestError#method_name" + parent: "SignalWire::REST::SignalWireRestError" + module: "SignalWire.REST.SignalWireRestError" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `method_name` + +Returns the value of attribute method\_name. + +## Signature + +```ruby +attr_reader method_name -> Object +``` + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/status-code.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/status-code.mdx new file mode 100644 index 0000000000..0853945633 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/status-code.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/signal-wire-rest-error/status-code" +title: "status_code" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::SignalWireRestError#status_code" + parent: "SignalWire::REST::SignalWireRestError" + module: "SignalWire.REST.SignalWireRestError" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `status_code` + +Returns the value of attribute status\_code. + +## Signature + +```ruby +attr_reader status_code -> Object +``` + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/url.mdx b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/url.mdx new file mode 100644 index 0000000000..ded7a02873 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/rest/signal-wire-rest-error/url.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/rest/signal-wire-rest-error/url" +title: "url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::REST::SignalWireRestError#url" + parent: "SignalWire::REST::SignalWireRestError" + module: "SignalWire.REST.SignalWireRestError" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb" + visibility: "public" +--- +# `url` + +Returns the value of attribute url. + +## Signature + +```ruby +attr_reader url -> Object +``` + +## Source + +[`lib/signalwire/rest/http_client.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/rest/http_client.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/runtime/execution-mode.mdx b/fern/products/sdk-reference/ruby/signal-wire/runtime/execution-mode.mdx new file mode 100644 index 0000000000..0fafcfd0f2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/runtime/execution-mode.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/runtime/execution-mode" +title: "execution_mode" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Runtime.execution_mode" + parent: "SignalWire::Runtime" + module: "SignalWire.Runtime" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb" + visibility: "public" +--- +# `execution_mode` + +Determine the current execution mode. + +Returns one of: + +- +:cgi+ - running under a CGI gateway (GATEWAY\_INTERFACE is set) +- +:lambda+ - running under AWS Lambda +- +:google\_cloud\_function+ - Google Cloud Functions / Cloud Run +- +:azure\_function+ - Azure Functions +- +:server+ - long-running HTTP server (the default) + +Detection order matters: CGI is checked before Lambda because a +Lambda function invoked through an emulator that also sets +GATEWAY\_INTERFACE should still be treated as CGI. + +## Signature + +```ruby +def execution_mode +``` + +## Returns + +`Symbol` — one of the values in \{MODES\} + +## Source + +[`lib/signalwire/runtime.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb) + +Line 34. diff --git a/fern/products/sdk-reference/ruby/signal-wire/runtime/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/runtime/index.mdx new file mode 100644 index 0000000000..a67d861bf3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/runtime/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/ruby/signal-wire/runtime" +title: "Runtime" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Runtime" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb" + visibility: "public" +--- +# `Runtime` + +Runtime environment detection. + +Detects the execution environment (plain server, AWS Lambda, CGI, +Google Cloud Functions, Azure Functions) by inspecting well-known +environment variables set by each platform. + +This is the Ruby counterpart to the Python SDK's ++signalwire.core.logging\_config.get\_execution\_mode+. + +## Signature + +```ruby +module Runtime +``` + +## Constants + + + +## Methods + + + + Determine the current execution mode. + + + + Construct the base URL for the current Lambda function. + + + + True when the SDK is running inside AWS Lambda. + + + + True when the SDK is running inside any serverless platform. + + + +## Source + +[`lib/signalwire/runtime.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/runtime/lambda-base-url.mdx b/fern/products/sdk-reference/ruby/signal-wire/runtime/lambda-base-url.mdx new file mode 100644 index 0000000000..8cfa292675 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/runtime/lambda-base-url.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/ruby/signal-wire/runtime/lambda-base-url" +title: "lambda_base_url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Runtime.lambda_base_url" + parent: "SignalWire::Runtime" + module: "SignalWire.Runtime" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb" + visibility: "public" +--- +# `lambda_base_url` + +Construct the base URL for the current Lambda function. + +Prefers +AWS\_LAMBDA\_FUNCTION\_URL+ when set; otherwise falls back to +the standard Function URL shape built from +AWS\_LAMBDA\_FUNCTION\_NAME+ +and +AWS\_REGION+. Returns +nil+ when neither signal is present. + +The returned URL never has a trailing slash and never contains a +path component, so callers must append the agent's route themselves. + +## Signature + +```ruby +def lambda_base_url +``` + +## Returns + +`String | nil` + +## Source + +[`lib/signalwire/runtime.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb) + +Line 85. diff --git a/fern/products/sdk-reference/ruby/signal-wire/runtime/lambda.mdx b/fern/products/sdk-reference/ruby/signal-wire/runtime/lambda.mdx new file mode 100644 index 0000000000..88add932ea --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/runtime/lambda.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/runtime/lambda" +title: "lambda?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Runtime.lambda?" + parent: "SignalWire::Runtime" + module: "SignalWire.Runtime" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb" + visibility: "public" +--- +# `lambda?` + +True when the SDK is running inside AWS Lambda. + +## Signature + +```ruby +def lambda? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/runtime.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb) + +Line 63. diff --git a/fern/products/sdk-reference/ruby/signal-wire/runtime/serverless.mdx b/fern/products/sdk-reference/ruby/signal-wire/runtime/serverless.mdx new file mode 100644 index 0000000000..282d867da7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/runtime/serverless.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/runtime/serverless" +title: "serverless?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Runtime.serverless?" + parent: "SignalWire::Runtime" + module: "SignalWire.Runtime" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb" + visibility: "public" +--- +# `serverless?` + +True when the SDK is running inside any serverless platform. + +## Signature + +```ruby +def serverless? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/runtime.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/runtime.rb) + +Line 69. diff --git a/fern/products/sdk-reference/ruby/signal-wire/security/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/security/index.mdx new file mode 100644 index 0000000000..5e582edea9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/security/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/security" +title: "Security" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Security" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/session_manager.rb" + visibility: "public" +--- +# `Security` + +## Signature + +```ruby +module Security +``` + +## Classes + + + + Stateless HMAC-SHA256 session manager for secure SWAIG tool tokens. + + + + Rack middleware that rejects webhook requests with bad signatures. + + + +## Modules + + + + Stateless validator for SignalWire-signed webhook requests. + + + +## Source + +[`lib/signalwire/security/session_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/session_manager.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/create-token.mdx b/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/create-token.mdx new file mode 100644 index 0000000000..b446de20d8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/create-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/ruby/signal-wire/security/session-manager/create-token" +title: "create_token" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Security::SessionManager#create_token" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/session_manager.rb" + visibility: "public" +--- +# `create_token` + +Create a secure, self-contained token for a function call. + +Token format (before Base64): +call\_id.function\_name.expiry\_timestamp.nonce.hmac\_hex + +## Signature + +```ruby +def create_token(function_name, call_id) +``` + +## Parameters + + + + + +## Returns + +`String` — URL-safe Base64-encoded token + +## Source + +[`lib/signalwire/security/session_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/session_manager.rb) + +Line 39. diff --git a/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/index.mdx new file mode 100644 index 0000000000..c090c9468b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/ruby/signal-wire/security/session-manager" +title: "SessionManager" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Security::SessionManager" + parent: "SignalWire::Security" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/session_manager.rb" + visibility: "public" +--- +# `SessionManager` + +Stateless HMAC-SHA256 session manager for secure SWAIG tool tokens. + +Tokens are self-contained: all information needed for validation is +encoded inside the token itself. No server-side session state is stored. + +mgr = SessionManager.new(token\_expiry\_secs: 900) +token = mgr.create\_token("lookup\_order", "call-abc-123") +mgr.validate\_token("lookup\_order", token, "call-abc-123") # => true + +## Signature + +```ruby +class SessionManager < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Create a secure, self-contained token for a function call. + + + + + + Validate a function-call token. + + + +## Source + +[`lib/signalwire/security/session_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/session_manager.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/initialize.mdx new file mode 100644 index 0000000000..f333e23525 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/security/session-manager/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Security::SessionManager#initialize" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/session_manager.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(token_expiry_secs: 3600, secret_key: nil) +``` + +## Parameters + + + + + +## Returns + +`SessionManager` — a new instance of SessionManager + +## Source + +[`lib/signalwire/security/session_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/session_manager.rb) + +Line 26. diff --git a/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/validate-token.mdx b/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/validate-token.mdx new file mode 100644 index 0000000000..ffd75c792e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/security/session-manager/validate-token.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/security/session-manager/validate-token" +title: "validate_token" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Security::SessionManager#validate_token" + parent: "SignalWire::Security::SessionManager" + module: "SignalWire.Security.SessionManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/session_manager.rb" + visibility: "public" +--- +# `validate_token` + +Validate a function-call token. + +Checks: + +1. Correct Base64 / structure (5 dot-separated parts) +2. HMAC signature (timing-safe comparison) +3. Function name matches +4. Call ID matches +5. Token not expired + +## Signature + +```ruby +def validate_token(function_name, token, call_id) +``` + +## Parameters + + + + + the token to validate + + + + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/security/session_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/session_manager.rb) + +Line 63. diff --git a/fern/products/sdk-reference/ruby/signal-wire/security/webhook-middleware/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/security/webhook-middleware/index.mdx new file mode 100644 index 0000000000..8a43f46e5f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/security/webhook-middleware/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/security/webhook-middleware" +title: "WebhookMiddleware" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Security::WebhookMiddleware" + parent: "SignalWire::Security" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/webhook_middleware.rb" + visibility: "public" +--- +# `WebhookMiddleware` + +Rack middleware that rejects webhook requests with bad signatures. + +Configure with the customer's Signing Key (and optional `trust_proxy` +to honor X-Forwarded headers). Mount upstream of any body-parsing +middleware so the raw bytes survive intact. + +## Signature + +```ruby +class WebhookMiddleware < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Constants + + + Key under which the captured raw body is stashed on the request env. + + + + + + +## Methods + + + + + +## Source + +[`lib/signalwire/security/webhook_middleware.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/webhook_middleware.rb) + +Line 47. diff --git a/fern/products/sdk-reference/ruby/signal-wire/security/webhook-middleware/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/security/webhook-middleware/initialize.mdx new file mode 100644 index 0000000000..391a44b0ec --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/security/webhook-middleware/initialize.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/security/webhook-middleware/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Security::WebhookMiddleware#initialize" + parent: "SignalWire::Security::WebhookMiddleware" + module: "SignalWire.Security.WebhookMiddleware" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/webhook_middleware.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(app, signing_key:, trust_proxy: false, paths: nil, methods: ['POST']) +``` + +## Parameters + + + the wrapped Rack app. + + + + + + + + + + +## Returns + +`WebhookMiddleware` — a new instance of WebhookMiddleware + +## Throws + +- `ArgumentError` — when `signing_key` is missing. + +## Source + +[`lib/signalwire/security/webhook_middleware.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/webhook_middleware.rb) + +Line 66. diff --git a/fern/products/sdk-reference/ruby/signal-wire/security/webhook-validator/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/security/webhook-validator/index.mdx new file mode 100644 index 0000000000..8e8a0d08e1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/security/webhook-validator/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/security/webhook-validator" +title: "WebhookValidator" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Security::WebhookValidator" + parent: "SignalWire::Security" + module: "SignalWire.Security" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/webhook_validator.rb" + visibility: "public" +--- +# `WebhookValidator` + +Stateless validator for SignalWire-signed webhook requests. + +Both Scheme A (JSON, hex digest) and Scheme B (form-encoded, base64 +digest with bodySHA256 fallback) per porting-sdk/webhooks.md are +tried by the combined entry point. + +The two public entry points are exposed via `module_function` so +they can be invoked as `WebhookValidator.validate_webhook_signature(...)`. +All internal helpers are deliberately `_`-prefixed and private so +they don't pollute the public surface (`audit_no_cheat_tests` and +`signature_dump.rb` skip `_`-prefixed methods). + +## Signature + +```ruby +module WebhookValidator +``` + +## Methods + + + + Legacy `@signalwire/compatibility-api` drop-in entry point. + + + + Validate a SignalWire webhook signature against both schemes. + + + +## Source + +[`lib/signalwire/security/webhook_validator.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/webhook_validator.rb) + +Line 45. diff --git a/fern/products/sdk-reference/ruby/signal-wire/security/webhook-validator/validate-request.mdx b/fern/products/sdk-reference/ruby/signal-wire/security/webhook-validator/validate-request.mdx new file mode 100644 index 0000000000..d5d1dc6fdd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/security/webhook-validator/validate-request.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/ruby/signal-wire/security/webhook-validator/validate-request" +title: "validate_request" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Security::WebhookValidator.validate_request" + parent: "SignalWire::Security::WebhookValidator" + module: "SignalWire.Security.WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/webhook_validator.rb" + visibility: "public" +--- +# `validate_request` + +Legacy `@signalwire/compatibility-api` drop-in entry point. + +If `params_or_raw_body` is a `String`, delegates to +\{validate\_webhook\_signature\} (Scheme A then Scheme B with parsed form). + +If it's a `Hash` or an array of (key, value) pairs, treats it as +pre-parsed form params and runs Scheme B directly (with URL port +normalization and optional bodySHA256 fallback). + +## Signature + +```ruby +def validate_request(signing_key, signature, url, params_or_raw_body) +``` + +## Parameters + + + + + + + + + +## Returns + +`Boolean` + +## Throws + +- `ArgumentError` — when `signing_key` is missing. +- `TypeError` — when `params_or_raw_body` is neither a String, Hash, nor an array of pairs. + +## Source + +[`lib/signalwire/security/webhook_validator.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/webhook_validator.rb) + +Line 121. diff --git a/fern/products/sdk-reference/ruby/signal-wire/security/webhook-validator/validate-webhook-signature.mdx b/fern/products/sdk-reference/ruby/signal-wire/security/webhook-validator/validate-webhook-signature.mdx new file mode 100644 index 0000000000..9a696b4caa --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/security/webhook-validator/validate-webhook-signature.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/ruby/signal-wire/security/webhook-validator/validate-webhook-signature" +title: "validate_webhook_signature" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Security::WebhookValidator.validate_webhook_signature" + parent: "SignalWire::Security::WebhookValidator" + module: "SignalWire.Security.WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/webhook_validator.rb" + visibility: "public" +--- +# `validate_webhook_signature` + +Validate a SignalWire webhook signature against both schemes. + +## Signature + +```ruby +def validate_webhook_signature(signing_key, signature, url, raw_body) +``` + +## Parameters + + + Customer's Signing Key from the Dashboard. UTF-8 string, secret. `nil` / empty raises `ArgumentError` — that's a programming error, not a validation failure. + + + + The `X-SignalWire-Signature` header value (or `X-Twilio-Signature` for cXML compat). Missing / empty returns false without raising. + + + + The full URL SignalWire POSTed to (scheme, host, optional port, path, query). Must match what the platform saw — see the URL reconstruction section of porting-sdk/webhooks.md. + + + + The raw request body bytes as a UTF-8 string, BEFORE any JSON / form parsing. Must be a `String` — passing a parsed Hash raises `TypeError`. + + +## Returns + +`Boolean` — true if the signature matches either Scheme A or Scheme B (with port-normalization variants and optional bodySHA256 fallback). false otherwise. + +## Throws + +- `ArgumentError` — when `signing_key` is missing. +- `TypeError` — when `raw_body` is not a String. + +## Source + +[`lib/signalwire/security/webhook_validator.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/security/webhook_validator.rb) + +Line 67. diff --git a/fern/products/sdk-reference/ruby/signal-wire/serverless/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/serverless/index.mdx new file mode 100644 index 0000000000..c326749326 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/serverless/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/serverless" +title: "Serverless" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Serverless" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/serverless/lambda_handler.rb" + visibility: "public" +--- +# `Serverless` + +## Signature + +```ruby +module Serverless +``` + +## Classes + + + + Adapter that lets an AWS Lambda function invoke a Rack application. + + + +## Source + +[`lib/signalwire/serverless/lambda_handler.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/serverless/lambda_handler.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/call.mdx b/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/call.mdx new file mode 100644 index 0000000000..912bd1767b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/call.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/serverless/lambda-handler/call" +title: "call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Serverless::LambdaHandler#call" + parent: "SignalWire::Serverless::LambdaHandler" + module: "SignalWire.Serverless.LambdaHandler" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/serverless/lambda_handler.rb" + visibility: "public" +--- +# `call` + +Invoke the wrapped Rack application with a Lambda event. + +## Signature + +```ruby +def call(event, _context = nil) +``` + +## Parameters + + + the Lambda invocation event + + + + the Lambda context (ignored) + + +## Returns + +`Hash` — a Lambda-shaped response hash + +## Source + +[`lib/signalwire/serverless/lambda_handler.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/serverless/lambda_handler.rb) + +Line 53. diff --git a/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/for.mdx b/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/for.mdx new file mode 100644 index 0000000000..7e558cc6e7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/for.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/serverless/lambda-handler/for" +title: "for" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Serverless::LambdaHandler.for" + parent: "SignalWire::Serverless::LambdaHandler" + module: "SignalWire.Serverless.LambdaHandler" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/serverless/lambda_handler.rb" + visibility: "public" +--- +# `for` + +Class-level convenience so consumers can use ++SignalWire::Serverless::LambdaHandler.for(agent)+ without +duplicating +.rack\_app+ at the call site. + +## Signature + +```ruby +def for(agent_or_app) +``` + +## Parameters + + + either an AgentBase (responds to +rack\_app+) or any Rack-compatible application + + +## Returns + +`LambdaHandler` + +## Source + +[`lib/signalwire/serverless/lambda_handler.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/serverless/lambda_handler.rb) + +Line 71. diff --git a/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/index.mdx new file mode 100644 index 0000000000..69271cabaf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/ruby/signal-wire/serverless/lambda-handler" +title: "LambdaHandler" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Serverless::LambdaHandler" + parent: "SignalWire::Serverless" + module: "SignalWire.Serverless" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/serverless/lambda_handler.rb" + visibility: "public" +--- +# `LambdaHandler` + +Adapter that lets an AWS Lambda function invoke a Rack application. + +Typical usage from a Lambda entrypoint file: + +require 'signalwire' + +AGENT = SignalWire::AgentBase.new(name: 'my-agent', route: '/') + +# ...configure AGENT... + +HANDLER = SignalWire::Serverless::LambdaHandler.new(AGENT.rack\_app) + +def handler(event:, context:) +HANDLER.call(event, context) +end + +The adapter accepts events from either Lambda Function URLs / API +Gateway HTTP API (payload format v2) or the classic API Gateway REST +API (payload format v1) and returns a response in the matching +shape. Any triple returned by the Rack app (status, headers, body) +is translated into the +\{statusCode:, headers:, body:\}+ shape +expected by Lambda. + +The adapter never reaches out to the network and has no gem +dependencies beyond what the SignalWire SDK already requires, so it +can be bundled directly into a Lambda zip. + +## Signature + +```ruby +class LambdaHandler < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Invoke the wrapped Rack application with a Lambda event. + + + + Class-level convenience so consumers can use +SignalWire::Serverless::LambdaHandler.for(agent)+ without duplicating +.rack\_app+ at the call site. + + + + + +## Source + +[`lib/signalwire/serverless/lambda_handler.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/serverless/lambda_handler.rb) + +Line 40. diff --git a/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/initialize.mdx new file mode 100644 index 0000000000..8eb25ac240 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/serverless/lambda-handler/initialize.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/serverless/lambda-handler/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Serverless::LambdaHandler#initialize" + parent: "SignalWire::Serverless::LambdaHandler" + module: "SignalWire.Serverless.LambdaHandler" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/serverless/lambda_handler.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(app) +``` + +## Parameters + + + a Rack-compatible application + + +## Returns + +`LambdaHandler` — a new instance of LambdaHandler + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/serverless/lambda_handler.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/serverless/lambda_handler.rb) + +Line 42. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/description.mdx new file mode 100644 index 0000000000..88ba3e14ac --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill#description" + parent: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill" + module: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/api_ninjas_trivia.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb) + +Line 28. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..cae784d8c1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill" + module: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/api_ninjas_trivia.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb) + +Line 86. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/index.mdx new file mode 100644 index 0000000000..6619d2a38e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill" +title: "ApiNinjasTriviaSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb" + visibility: "public" +--- +# `ApiNinjasTriviaSkill` + +## Signature + +```ruby +class ApiNinjasTriviaSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Constants + + + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/api_ninjas_trivia.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb) + +Line 9. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/instance-key.mdx new file mode 100644 index 0000000000..0de71565df --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill#instance_key" + parent: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill" + module: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb" + visibility: "public" +--- +# `instance_key` + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/builtin/api_ninjas_trivia.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb) + +Line 41. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/name.mdx new file mode 100644 index 0000000000..d9171a5d3d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill#name" + parent: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill" + module: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/api_ninjas_trivia.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb) + +Line 27. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/register-tools.mdx new file mode 100644 index 0000000000..23239cb601 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill#register_tools" + parent: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill" + module: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/api_ninjas_trivia.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb) + +Line 43. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/setup.mdx new file mode 100644 index 0000000000..3559692137 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill#setup" + parent: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill" + module: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/api_ninjas_trivia.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..4e67d2b9ed --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/api-ninjas-trivia-skill/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill#supports_multiple_instances?" + parent: "SignalWire::Skills::Builtin::ApiNinjasTriviaSkill" + module: "SignalWire.Skills.Builtin.ApiNinjasTriviaSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/builtin/api_ninjas_trivia.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/api_ninjas_trivia.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/description.mdx new file mode 100644 index 0000000000..d5f8f9e53c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/claude-skills-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkillsSkill#description" + parent: "SignalWire::Skills::Builtin::ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/claude_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-hints.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-hints.mdx new file mode 100644 index 0000000000..09ea1013f9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-hints" +title: "get_hints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkillsSkill#get_hints" + parent: "SignalWire::Skills::Builtin::ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb" + visibility: "public" +--- +# `get_hints` + +## Signature + +```ruby +def get_hints +``` + +## Source + +[`lib/signalwire/skills/builtin/claude_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb) + +Line 46. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..e0108a8099 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkillsSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/claude_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb) + +Line 56. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..787d4416e4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/claude-skills-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkillsSkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/claude_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/index.mdx new file mode 100644 index 0000000000..4e61460ee3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/claude-skills-skill" +title: "ClaudeSkillsSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkillsSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb" + visibility: "public" +--- +# `ClaudeSkillsSkill` + +Loads Claude SKILL.md files as agent tools. + +## Signature + +```ruby +class ClaudeSkillsSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/claude_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/instance-key.mdx new file mode 100644 index 0000000000..218aefebdf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/claude-skills-skill/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkillsSkill#instance_key" + parent: "SignalWire::Skills::Builtin::ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb" + visibility: "public" +--- +# `instance_key` + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/builtin/claude_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/name.mdx new file mode 100644 index 0000000000..5acd42f9ce --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/claude-skills-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkillsSkill#name" + parent: "SignalWire::Skills::Builtin::ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/claude_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/register-tools.mdx new file mode 100644 index 0000000000..9c407d8d9b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/claude-skills-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkillsSkill#register_tools" + parent: "SignalWire::Skills::Builtin::ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/claude_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/setup.mdx new file mode 100644 index 0000000000..17e5c679ec --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/claude-skills-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkillsSkill#setup" + parent: "SignalWire::Skills::Builtin::ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/claude_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..0a16754042 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/claude-skills-skill/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/claude-skills-skill/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::ClaudeSkillsSkill#supports_multiple_instances?" + parent: "SignalWire::Skills::Builtin::ClaudeSkillsSkill" + module: "SignalWire.Skills.Builtin.ClaudeSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/builtin/claude_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/claude_skills.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/description.mdx new file mode 100644 index 0000000000..e63304a820 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/custom-skills-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::CustomSkillsSkill#description" + parent: "SignalWire::Skills::Builtin::CustomSkillsSkill" + module: "SignalWire.Skills.Builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/custom_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..81d5e4d145 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/custom-skills-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::CustomSkillsSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::CustomSkillsSkill" + module: "SignalWire.Skills.Builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/custom_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb) + +Line 42. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/index.mdx new file mode 100644 index 0000000000..5b1246e789 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/custom-skills-skill" +title: "CustomSkillsSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::CustomSkillsSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb" + visibility: "public" +--- +# `CustomSkillsSkill` + +User-defined custom tools. + +## Signature + +```ruby +class CustomSkillsSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/custom_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/instance-key.mdx new file mode 100644 index 0000000000..9bec331b1f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/custom-skills-skill/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::CustomSkillsSkill#instance_key" + parent: "SignalWire::Skills::Builtin::CustomSkillsSkill" + module: "SignalWire.Skills.Builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb" + visibility: "public" +--- +# `instance_key` + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/builtin/custom_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/name.mdx new file mode 100644 index 0000000000..20a78cb73c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/custom-skills-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::CustomSkillsSkill#name" + parent: "SignalWire::Skills::Builtin::CustomSkillsSkill" + module: "SignalWire.Skills.Builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/custom_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/register-tools.mdx new file mode 100644 index 0000000000..fbf7bfbfa8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/custom-skills-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::CustomSkillsSkill#register_tools" + parent: "SignalWire::Skills::Builtin::CustomSkillsSkill" + module: "SignalWire.Skills.Builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/custom_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb) + +Line 26. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/setup.mdx new file mode 100644 index 0000000000..786313c186 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/custom-skills-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::CustomSkillsSkill#setup" + parent: "SignalWire::Skills::Builtin::CustomSkillsSkill" + module: "SignalWire.Skills.Builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/custom_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..d35dcdf65b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/custom-skills-skill/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/custom-skills-skill/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::CustomSkillsSkill#supports_multiple_instances?" + parent: "SignalWire::Skills::Builtin::CustomSkillsSkill" + module: "SignalWire.Skills.Builtin.CustomSkillsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/builtin/custom_skills.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/custom_skills.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/description.mdx new file mode 100644 index 0000000000..58fba88ea9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerlessSkill#description" + parent: "SignalWire::Skills::Builtin::DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere_serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-global-data.mdx new file mode 100644 index 0000000000..20c99c8f50 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-global-data" +title: "get_global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerlessSkill#get_global_data" + parent: "SignalWire::Skills::Builtin::DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```ruby +def get_global_data +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere_serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb) + +Line 67. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..cdcea136bd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerlessSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere_serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb) + +Line 90. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..d23b4e0d8f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerlessSkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere_serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb) + +Line 75. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/index.mdx new file mode 100644 index 0000000000..339de7e590 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill" +title: "DatasphereServerlessSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerlessSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb" + visibility: "public" +--- +# `DatasphereServerlessSkill` + +## Signature + +```ruby +class DatasphereServerlessSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/datasphere_serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/instance-key.mdx new file mode 100644 index 0000000000..c253496e83 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerlessSkill#instance_key" + parent: "SignalWire::Skills::Builtin::DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb" + visibility: "public" +--- +# `instance_key` + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere_serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb) + +Line 37. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/name.mdx new file mode 100644 index 0000000000..ebb6ebb886 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerlessSkill#name" + parent: "SignalWire::Skills::Builtin::DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere_serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/register-tools.mdx new file mode 100644 index 0000000000..9686a87aef --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerlessSkill#register_tools" + parent: "SignalWire::Skills::Builtin::DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere_serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb) + +Line 39. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/setup.mdx new file mode 100644 index 0000000000..731f6a30c4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerlessSkill#setup" + parent: "SignalWire::Skills::Builtin::DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere_serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..a8786a979e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-serverless-skill/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereServerlessSkill#supports_multiple_instances?" + parent: "SignalWire::Skills::Builtin::DatasphereServerlessSkill" + module: "SignalWire.Skills.Builtin.DatasphereServerlessSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/builtin/datasphere_serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere_serverless.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/description.mdx new file mode 100644 index 0000000000..af6519653f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereSkill#description" + parent: "SignalWire::Skills::Builtin::DatasphereSkill" + module: "SignalWire.Skills.Builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-global-data.mdx new file mode 100644 index 0000000000..5dfd0e4906 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-global-data" +title: "get_global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereSkill#get_global_data" + parent: "SignalWire::Skills::Builtin::DatasphereSkill" + module: "SignalWire.Skills.Builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```ruby +def get_global_data +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb) + +Line 63. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..6cef54895f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::DatasphereSkill" + module: "SignalWire.Skills.Builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb) + +Line 86. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..44cc94b5e9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereSkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::DatasphereSkill" + module: "SignalWire.Skills.Builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb) + +Line 71. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/index.mdx new file mode 100644 index 0000000000..d8f3d3b71e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-skill" +title: "DatasphereSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb" + visibility: "public" +--- +# `DatasphereSkill` + +## Signature + +```ruby +class DatasphereSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/instance-key.mdx new file mode 100644 index 0000000000..3599f900d4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-skill/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereSkill#instance_key" + parent: "SignalWire::Skills::Builtin::DatasphereSkill" + module: "SignalWire.Skills.Builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb" + visibility: "public" +--- +# `instance_key` + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb) + +Line 48. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/name.mdx new file mode 100644 index 0000000000..e4c488e97a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereSkill#name" + parent: "SignalWire::Skills::Builtin::DatasphereSkill" + module: "SignalWire.Skills.Builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/register-tools.mdx new file mode 100644 index 0000000000..00eabb15c7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereSkill#register_tools" + parent: "SignalWire::Skills::Builtin::DatasphereSkill" + module: "SignalWire.Skills.Builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb) + +Line 50. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/setup.mdx new file mode 100644 index 0000000000..b3c74063c0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereSkill#setup" + parent: "SignalWire::Skills::Builtin::DatasphereSkill" + module: "SignalWire.Skills.Builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb) + +Line 19. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..06bf244c3c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/datasphere-skill/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/datasphere-skill/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DatasphereSkill#supports_multiple_instances?" + parent: "SignalWire::Skills::Builtin::DatasphereSkill" + module: "SignalWire.Skills.Builtin.DatasphereSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/builtin/datasphere.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datasphere.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/description.mdx new file mode 100644 index 0000000000..4882540ffc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/date-time-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DateTimeSkill#description" + parent: "SignalWire::Skills::Builtin::DateTimeSkill" + module: "SignalWire.Skills.Builtin.DateTimeSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datetime.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/datetime.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datetime.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..6950fb8f8e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/date-time-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DateTimeSkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::DateTimeSkill" + module: "SignalWire.Skills.Builtin.DateTimeSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datetime.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/datetime.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datetime.rb) + +Line 34. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/index.mdx new file mode 100644 index 0000000000..ff0b03ae08 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/date-time-skill" +title: "DateTimeSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DateTimeSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datetime.rb" + visibility: "public" +--- +# `DateTimeSkill` + +## Signature + +```ruby +class DateTimeSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/datetime.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datetime.rb) + +Line 9. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/name.mdx new file mode 100644 index 0000000000..44517eadc0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/date-time-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DateTimeSkill#name" + parent: "SignalWire::Skills::Builtin::DateTimeSkill" + module: "SignalWire.Skills.Builtin.DateTimeSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datetime.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/datetime.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datetime.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/register-tools.mdx new file mode 100644 index 0000000000..e4f1f764e2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/date-time-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/date-time-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::DateTimeSkill#register_tools" + parent: "SignalWire::Skills::Builtin::DateTimeSkill" + module: "SignalWire.Skills.Builtin.DateTimeSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datetime.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/datetime.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/datetime.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/description.mdx new file mode 100644 index 0000000000..7525ca902b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/google-maps-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::GoogleMapsSkill#description" + parent: "SignalWire::Skills::Builtin::GoogleMapsSkill" + module: "SignalWire.Skills.Builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/google_maps.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-hints.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-hints.mdx new file mode 100644 index 0000000000..ed2473d72d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-hints" +title: "get_hints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::GoogleMapsSkill#get_hints" + parent: "SignalWire::Skills::Builtin::GoogleMapsSkill" + module: "SignalWire.Skills.Builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb" + visibility: "public" +--- +# `get_hints` + +## Signature + +```ruby +def get_hints +``` + +## Source + +[`lib/signalwire/skills/builtin/google_maps.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb) + +Line 51. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..bcc44da47b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::GoogleMapsSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::GoogleMapsSkill" + module: "SignalWire.Skills.Builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/google_maps.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb) + +Line 70. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..030d7d5613 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/google-maps-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::GoogleMapsSkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::GoogleMapsSkill" + module: "SignalWire.Skills.Builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/google_maps.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb) + +Line 55. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/index.mdx new file mode 100644 index 0000000000..05b58f6071 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/google-maps-skill" +title: "GoogleMapsSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::GoogleMapsSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb" + visibility: "public" +--- +# `GoogleMapsSkill` + +## Signature + +```ruby +class GoogleMapsSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/google_maps.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/name.mdx new file mode 100644 index 0000000000..2f9bad1e01 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/google-maps-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::GoogleMapsSkill#name" + parent: "SignalWire::Skills::Builtin::GoogleMapsSkill" + module: "SignalWire.Skills.Builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/google_maps.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/register-tools.mdx new file mode 100644 index 0000000000..7c2938ca32 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/google-maps-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::GoogleMapsSkill#register_tools" + parent: "SignalWire::Skills::Builtin::GoogleMapsSkill" + module: "SignalWire.Skills.Builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/google_maps.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/setup.mdx new file mode 100644 index 0000000000..a82957cc5f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/google-maps-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/google-maps-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::GoogleMapsSkill#setup" + parent: "SignalWire::Skills::Builtin::GoogleMapsSkill" + module: "SignalWire.Skills.Builtin.GoogleMapsSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/google_maps.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/google_maps.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/index.mdx new file mode 100644 index 0000000000..e2be88aa18 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/index.mdx @@ -0,0 +1,76 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin" +title: "Builtin" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin" + parent: "SignalWire::Skills" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb" + visibility: "public" +--- +# `Builtin` + +## Signature + +```ruby +module Builtin +``` + +## Classes + + + + + + Loads Claude SKILL.md files as agent tools. + + + + User-defined custom tools. + + + + + + + + + + + + + + + + + + Bridge MCP servers with SWAIG functions. + + + + Network/remote mode only (as per porting manifest). + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/joke.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb) + +Line 9. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/description.mdx new file mode 100644 index 0000000000..75db5d6716 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::InfoGathererSkill#description" + parent: "SignalWire::Skills::Builtin::InfoGathererSkill" + module: "SignalWire.Skills.Builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-global-data.mdx new file mode 100644 index 0000000000..721990abaa --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-global-data" +title: "get_global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::InfoGathererSkill#get_global_data" + parent: "SignalWire::Skills::Builtin::InfoGathererSkill" + module: "SignalWire.Skills.Builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```ruby +def get_global_data +``` + +## Source + +[`lib/signalwire/skills/builtin/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb) + +Line 63. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..bf6ea5a4c5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::InfoGathererSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::InfoGathererSkill" + module: "SignalWire.Skills.Builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb) + +Line 84. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..226c1b78e2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::InfoGathererSkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::InfoGathererSkill" + module: "SignalWire.Skills.Builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb) + +Line 73. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/index.mdx new file mode 100644 index 0000000000..e3d38aed20 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/info-gatherer-skill" +title: "InfoGathererSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::InfoGathererSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb" + visibility: "public" +--- +# `InfoGathererSkill` + +## Signature + +```ruby +class InfoGathererSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb) + +Line 9. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/instance-key.mdx new file mode 100644 index 0000000000..8d7583ef8a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::InfoGathererSkill#instance_key" + parent: "SignalWire::Skills::Builtin::InfoGathererSkill" + module: "SignalWire.Skills.Builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb" + visibility: "public" +--- +# `instance_key` + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/builtin/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb) + +Line 38. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/name.mdx new file mode 100644 index 0000000000..23f5a7ba8a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::InfoGathererSkill#name" + parent: "SignalWire::Skills::Builtin::InfoGathererSkill" + module: "SignalWire.Skills.Builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/register-tools.mdx new file mode 100644 index 0000000000..83b014802e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::InfoGathererSkill#register_tools" + parent: "SignalWire::Skills::Builtin::InfoGathererSkill" + module: "SignalWire.Skills.Builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb) + +Line 43. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/setup.mdx new file mode 100644 index 0000000000..714f3d98f6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::InfoGathererSkill#setup" + parent: "SignalWire::Skills::Builtin::InfoGathererSkill" + module: "SignalWire.Skills.Builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..bd41a1c84a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/info-gatherer-skill/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::InfoGathererSkill#supports_multiple_instances?" + parent: "SignalWire::Skills::Builtin::InfoGathererSkill" + module: "SignalWire.Skills.Builtin.InfoGathererSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/builtin/info_gatherer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/info_gatherer.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/description.mdx new file mode 100644 index 0000000000..026926075c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/joke-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::JokeSkill#description" + parent: "SignalWire::Skills::Builtin::JokeSkill" + module: "SignalWire.Skills.Builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/joke.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/get-global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/get-global-data.mdx new file mode 100644 index 0000000000..1005c6d6fa --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/joke-skill/get-global-data" +title: "get_global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::JokeSkill#get_global_data" + parent: "SignalWire::Skills::Builtin::JokeSkill" + module: "SignalWire.Skills.Builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```ruby +def get_global_data +``` + +## Source + +[`lib/signalwire/skills/builtin/joke.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb) + +Line 34. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..c37ae46595 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/joke-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::JokeSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::JokeSkill" + module: "SignalWire.Skills.Builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/joke.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb) + +Line 52. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..97f661fa80 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/joke-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::JokeSkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::JokeSkill" + module: "SignalWire.Skills.Builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/joke.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb) + +Line 38. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/index.mdx new file mode 100644 index 0000000000..3d7218dd6f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/joke-skill" +title: "JokeSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::JokeSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb" + visibility: "public" +--- +# `JokeSkill` + +## Signature + +```ruby +class JokeSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/joke.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/name.mdx new file mode 100644 index 0000000000..55a2a1e8f9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/joke-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::JokeSkill#name" + parent: "SignalWire::Skills::Builtin::JokeSkill" + module: "SignalWire.Skills.Builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/joke.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/register-tools.mdx new file mode 100644 index 0000000000..7927af63db --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/joke-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::JokeSkill#register_tools" + parent: "SignalWire::Skills::Builtin::JokeSkill" + module: "SignalWire.Skills.Builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/joke.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/setup.mdx new file mode 100644 index 0000000000..0e1b64215f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/joke-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/joke-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::JokeSkill#setup" + parent: "SignalWire::Skills::Builtin::JokeSkill" + module: "SignalWire.Skills.Builtin.JokeSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/joke.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/joke.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/description.mdx new file mode 100644 index 0000000000..27e00fe1ce --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/math-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::MathSkill#description" + parent: "SignalWire::Skills::Builtin::MathSkill" + module: "SignalWire.Skills.Builtin.MathSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/math.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/math.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/math.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..0df951923d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/math-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::MathSkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::MathSkill" + module: "SignalWire.Skills.Builtin.MathSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/math.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/math.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/math.rb) + +Line 26. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/index.mdx new file mode 100644 index 0000000000..9d6d5dcd6c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/math-skill" +title: "MathSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::MathSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/math.rb" + visibility: "public" +--- +# `MathSkill` + +## Signature + +```ruby +class MathSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/math.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/math.rb) + +Line 9. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/name.mdx new file mode 100644 index 0000000000..362a28987d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/math-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::MathSkill#name" + parent: "SignalWire::Skills::Builtin::MathSkill" + module: "SignalWire.Skills.Builtin.MathSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/math.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/math.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/math.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/register-tools.mdx new file mode 100644 index 0000000000..6d2e19ae60 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/math-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/math-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::MathSkill#register_tools" + parent: "SignalWire::Skills::Builtin::MathSkill" + module: "SignalWire.Skills.Builtin.MathSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/math.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/math.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/math.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/description.mdx new file mode 100644 index 0000000000..f946088763 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::McpGatewaySkill#description" + parent: "SignalWire::Skills::Builtin::McpGatewaySkill" + module: "SignalWire.Skills.Builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/mcp_gateway.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-global-data.mdx new file mode 100644 index 0000000000..6129434e59 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-global-data" +title: "get_global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::McpGatewaySkill#get_global_data" + parent: "SignalWire::Skills::Builtin::McpGatewaySkill" + module: "SignalWire.Skills.Builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```ruby +def get_global_data +``` + +## Source + +[`lib/signalwire/skills/builtin/mcp_gateway.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb) + +Line 53. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-hints.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-hints.mdx new file mode 100644 index 0000000000..df6139c074 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-hints" +title: "get_hints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::McpGatewaySkill#get_hints" + parent: "SignalWire::Skills::Builtin::McpGatewaySkill" + module: "SignalWire.Skills.Builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb" + visibility: "public" +--- +# `get_hints` + +## Signature + +```ruby +def get_hints +``` + +## Source + +[`lib/signalwire/skills/builtin/mcp_gateway.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb) + +Line 47. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..767d195025 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::McpGatewaySkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::McpGatewaySkill" + module: "SignalWire.Skills.Builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/mcp_gateway.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb) + +Line 72. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..726add91c2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::McpGatewaySkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::McpGatewaySkill" + module: "SignalWire.Skills.Builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/mcp_gateway.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb) + +Line 61. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/index.mdx new file mode 100644 index 0000000000..4242772983 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill" +title: "McpGatewaySkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::McpGatewaySkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb" + visibility: "public" +--- +# `McpGatewaySkill` + +Bridge MCP servers with SWAIG functions. + +## Signature + +```ruby +class McpGatewaySkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/mcp_gateway.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/name.mdx new file mode 100644 index 0000000000..0e99e47cf5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::McpGatewaySkill#name" + parent: "SignalWire::Skills::Builtin::McpGatewaySkill" + module: "SignalWire.Skills.Builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/mcp_gateway.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/register-tools.mdx new file mode 100644 index 0000000000..33159efda2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::McpGatewaySkill#register_tools" + parent: "SignalWire::Skills::Builtin::McpGatewaySkill" + module: "SignalWire.Skills.Builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/mcp_gateway.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb) + +Line 34. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/setup.mdx new file mode 100644 index 0000000000..78f8e37b83 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/mcp-gateway-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::McpGatewaySkill#setup" + parent: "SignalWire::Skills::Builtin::McpGatewaySkill" + module: "SignalWire.Skills.Builtin.McpGatewaySkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/mcp_gateway.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/mcp_gateway.rb) + +Line 18. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/description.mdx new file mode 100644 index 0000000000..eee492c5bd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearchSkill#description" + parent: "SignalWire::Skills::Builtin::NativeVectorSearchSkill" + module: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/native_vector_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/get-hints.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/get-hints.mdx new file mode 100644 index 0000000000..cd07088efc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/get-hints" +title: "get_hints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearchSkill#get_hints" + parent: "SignalWire::Skills::Builtin::NativeVectorSearchSkill" + module: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb" + visibility: "public" +--- +# `get_hints` + +## Signature + +```ruby +def get_hints +``` + +## Source + +[`lib/signalwire/skills/builtin/native_vector_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb) + +Line 49. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..5992165d60 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearchSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::NativeVectorSearchSkill" + module: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/native_vector_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb) + +Line 55. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/index.mdx new file mode 100644 index 0000000000..e74b1c1156 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/native-vector-search-skill" +title: "NativeVectorSearchSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearchSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb" + visibility: "public" +--- +# `NativeVectorSearchSkill` + +Network/remote mode only (as per porting manifest). + +## Signature + +```ruby +class NativeVectorSearchSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/native_vector_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/instance-key.mdx new file mode 100644 index 0000000000..79f5f86f72 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearchSkill#instance_key" + parent: "SignalWire::Skills::Builtin::NativeVectorSearchSkill" + module: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb" + visibility: "public" +--- +# `instance_key` + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/builtin/native_vector_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb) + +Line 33. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/name.mdx new file mode 100644 index 0000000000..645463c81e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearchSkill#name" + parent: "SignalWire::Skills::Builtin::NativeVectorSearchSkill" + module: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/native_vector_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/register-tools.mdx new file mode 100644 index 0000000000..e5dc4d601d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearchSkill#register_tools" + parent: "SignalWire::Skills::Builtin::NativeVectorSearchSkill" + module: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/native_vector_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb) + +Line 35. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/setup.mdx new file mode 100644 index 0000000000..88bd748b11 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearchSkill#setup" + parent: "SignalWire::Skills::Builtin::NativeVectorSearchSkill" + module: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/native_vector_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb) + +Line 19. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..d419601484 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/native-vector-search-skill/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::NativeVectorSearchSkill#supports_multiple_instances?" + parent: "SignalWire::Skills::Builtin::NativeVectorSearchSkill" + module: "SignalWire.Skills.Builtin.NativeVectorSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/builtin/native_vector_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/native_vector_search.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/description.mdx new file mode 100644 index 0000000000..d4055fc3c3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/play-background-file-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill#description" + parent: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill" + module: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/play_background_file.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..885dd384bd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/play-background-file-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill" + module: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/play_background_file.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb) + +Line 73. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/index.mdx new file mode 100644 index 0000000000..4ef68a83e8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/play-background-file-skill" +title: "PlayBackgroundFileSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb" + visibility: "public" +--- +# `PlayBackgroundFileSkill` + +## Signature + +```ruby +class PlayBackgroundFileSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/play_background_file.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb) + +Line 9. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/instance-key.mdx new file mode 100644 index 0000000000..93f29f5a15 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/play-background-file-skill/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill#instance_key" + parent: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill" + module: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb" + visibility: "public" +--- +# `instance_key` + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/builtin/play_background_file.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/name.mdx new file mode 100644 index 0000000000..4abaeb53c3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/play-background-file-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill#name" + parent: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill" + module: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/play_background_file.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/register-tools.mdx new file mode 100644 index 0000000000..4538653a29 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/play-background-file-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill#register_tools" + parent: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill" + module: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/play_background_file.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb) + +Line 27. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/setup.mdx new file mode 100644 index 0000000000..c299d115ad --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/play-background-file-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill#setup" + parent: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill" + module: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/play_background_file.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..803bc5ca87 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/play-background-file-skill/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/play-background-file-skill/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill#supports_multiple_instances?" + parent: "SignalWire::Skills::Builtin::PlayBackgroundFileSkill" + module: "SignalWire.Skills.Builtin.PlayBackgroundFileSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/builtin/play_background_file.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/play_background_file.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/description.mdx new file mode 100644 index 0000000000..75f30ee3ec --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/spider-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SpiderSkill#description" + parent: "SignalWire::Skills::Builtin::SpiderSkill" + module: "SignalWire.Skills.Builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/spider.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/get-hints.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/get-hints.mdx new file mode 100644 index 0000000000..958589f816 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/spider-skill/get-hints" +title: "get_hints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SpiderSkill#get_hints" + parent: "SignalWire::Skills::Builtin::SpiderSkill" + module: "SignalWire.Skills.Builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb" + visibility: "public" +--- +# `get_hints` + +## Signature + +```ruby +def get_hints +``` + +## Source + +[`lib/signalwire/skills/builtin/spider.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb) + +Line 53. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..c370ffe503 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/spider-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SpiderSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::SpiderSkill" + module: "SignalWire.Skills.Builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/spider.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/index.mdx new file mode 100644 index 0000000000..752cbfbd58 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/spider-skill" +title: "SpiderSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SpiderSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb" + visibility: "public" +--- +# `SpiderSkill` + +## Signature + +```ruby +class SpiderSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/spider.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/instance-key.mdx new file mode 100644 index 0000000000..2279e77b03 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/spider-skill/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SpiderSkill#instance_key" + parent: "SignalWire::Skills::Builtin::SpiderSkill" + module: "SignalWire.Skills.Builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb" + visibility: "public" +--- +# `instance_key` + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/builtin/spider.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb) + +Line 26. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/name.mdx new file mode 100644 index 0000000000..f1f7033b68 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/spider-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SpiderSkill#name" + parent: "SignalWire::Skills::Builtin::SpiderSkill" + module: "SignalWire.Skills.Builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/spider.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/register-tools.mdx new file mode 100644 index 0000000000..8f386a0b0f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/spider-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SpiderSkill#register_tools" + parent: "SignalWire::Skills::Builtin::SpiderSkill" + module: "SignalWire.Skills.Builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/spider.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb) + +Line 30. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/setup.mdx new file mode 100644 index 0000000000..52a559cd54 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/spider-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SpiderSkill#setup" + parent: "SignalWire::Skills::Builtin::SpiderSkill" + module: "SignalWire.Skills.Builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/spider.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..d0143e0989 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/spider-skill/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/spider-skill/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SpiderSkill#supports_multiple_instances?" + parent: "SignalWire::Skills::Builtin::SpiderSkill" + module: "SignalWire.Skills.Builtin.SpiderSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/builtin/spider.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/spider.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/description.mdx new file mode 100644 index 0000000000..a455dae202 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransferSkill#description" + parent: "SignalWire::Skills::Builtin::SwmlTransferSkill" + module: "SignalWire.Skills.Builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/swml_transfer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-hints.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-hints.mdx new file mode 100644 index 0000000000..9397ac7647 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-hints.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-hints" +title: "get_hints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransferSkill#get_hints" + parent: "SignalWire::Skills::Builtin::SwmlTransferSkill" + module: "SignalWire.Skills.Builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb" + visibility: "public" +--- +# `get_hints` + +## Signature + +```ruby +def get_hints +``` + +## Source + +[`lib/signalwire/skills/builtin/swml_transfer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb) + +Line 69. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..e11abc73c2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransferSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::SwmlTransferSkill" + module: "SignalWire.Skills.Builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/swml_transfer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb) + +Line 102. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..1978f91693 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransferSkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::SwmlTransferSkill" + module: "SignalWire.Skills.Builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/swml_transfer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb) + +Line 83. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/index.mdx new file mode 100644 index 0000000000..a7804f7c0b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/swml-transfer-skill" +title: "SwmlTransferSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransferSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb" + visibility: "public" +--- +# `SwmlTransferSkill` + +## Signature + +```ruby +class SwmlTransferSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/swml_transfer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/instance-key.mdx new file mode 100644 index 0000000000..3e77a55be8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransferSkill#instance_key" + parent: "SignalWire::Skills::Builtin::SwmlTransferSkill" + module: "SignalWire.Skills.Builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb" + visibility: "public" +--- +# `instance_key` + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/builtin/swml_transfer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb) + +Line 38. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/name.mdx new file mode 100644 index 0000000000..f4d403fe07 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransferSkill#name" + parent: "SignalWire::Skills::Builtin::SwmlTransferSkill" + module: "SignalWire.Skills.Builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/swml_transfer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/register-tools.mdx new file mode 100644 index 0000000000..f194220ddb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransferSkill#register_tools" + parent: "SignalWire::Skills::Builtin::SwmlTransferSkill" + module: "SignalWire.Skills.Builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/swml_transfer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb) + +Line 40. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/setup.mdx new file mode 100644 index 0000000000..ff2889f59c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransferSkill#setup" + parent: "SignalWire::Skills::Builtin::SwmlTransferSkill" + module: "SignalWire.Skills.Builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/swml_transfer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..6a16d11daf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/swml-transfer-skill/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::SwmlTransferSkill#supports_multiple_instances?" + parent: "SignalWire::Skills::Builtin::SwmlTransferSkill" + module: "SignalWire.Skills.Builtin.SwmlTransferSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/builtin/swml_transfer.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/swml_transfer.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/description.mdx new file mode 100644 index 0000000000..657bf977be --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/weather-api-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WeatherApiSkill#description" + parent: "SignalWire::Skills::Builtin::WeatherApiSkill" + module: "SignalWire.Skills.Builtin.WeatherApiSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/weather_api.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..6e3d18161c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/weather-api-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WeatherApiSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::WeatherApiSkill" + module: "SignalWire.Skills.Builtin.WeatherApiSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/weather_api.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb) + +Line 78. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/index.mdx new file mode 100644 index 0000000000..cfe5e75bc3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/weather-api-skill" +title: "WeatherApiSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WeatherApiSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb" + visibility: "public" +--- +# `WeatherApiSkill` + +## Signature + +```ruby +class WeatherApiSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/weather_api.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/name.mdx new file mode 100644 index 0000000000..3ce91dc6f0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/weather-api-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WeatherApiSkill#name" + parent: "SignalWire::Skills::Builtin::WeatherApiSkill" + module: "SignalWire.Skills.Builtin.WeatherApiSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/weather_api.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/register-tools.mdx new file mode 100644 index 0000000000..90876219e9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/weather-api-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WeatherApiSkill#register_tools" + parent: "SignalWire::Skills::Builtin::WeatherApiSkill" + module: "SignalWire.Skills.Builtin.WeatherApiSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/weather_api.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/setup.mdx new file mode 100644 index 0000000000..c8ba3508fd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/weather-api-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/weather-api-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WeatherApiSkill#setup" + parent: "SignalWire::Skills::Builtin::WeatherApiSkill" + module: "SignalWire.Skills.Builtin.WeatherApiSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/weather_api.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/weather_api.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/description.mdx new file mode 100644 index 0000000000..fc7aaefa47 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/web-search-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WebSearchSkill#description" + parent: "SignalWire::Skills::Builtin::WebSearchSkill" + module: "SignalWire.Skills.Builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/web_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/get-global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..46d5b3d73c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/get-global-data.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/web-search-skill/get-global-data" +title: "get_global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WebSearchSkill#get_global_data" + parent: "SignalWire::Skills::Builtin::WebSearchSkill" + module: "SignalWire.Skills.Builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```ruby +def get_global_data +``` + +## Source + +[`lib/signalwire/skills/builtin/web_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb) + +Line 54. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..9046e2fc65 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/web-search-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WebSearchSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::WebSearchSkill" + module: "SignalWire.Skills.Builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/web_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb) + +Line 73. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..f00aa2384e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/web-search-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WebSearchSkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::WebSearchSkill" + module: "SignalWire.Skills.Builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/web_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb) + +Line 58. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/index.mdx new file mode 100644 index 0000000000..d6385e1ad4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/web-search-skill" +title: "WebSearchSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WebSearchSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb" + visibility: "public" +--- +# `WebSearchSkill` + +## Signature + +```ruby +class WebSearchSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/web_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/instance-key.mdx new file mode 100644 index 0000000000..b0906ae62d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/instance-key.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/web-search-skill/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WebSearchSkill#instance_key" + parent: "SignalWire::Skills::Builtin::WebSearchSkill" + module: "SignalWire.Skills.Builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb" + visibility: "public" +--- +# `instance_key` + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/builtin/web_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb) + +Line 39. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/name.mdx new file mode 100644 index 0000000000..80c8c913b7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/web-search-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WebSearchSkill#name" + parent: "SignalWire::Skills::Builtin::WebSearchSkill" + module: "SignalWire.Skills.Builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/web_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/register-tools.mdx new file mode 100644 index 0000000000..80495ef9c3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/web-search-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WebSearchSkill#register_tools" + parent: "SignalWire::Skills::Builtin::WebSearchSkill" + module: "SignalWire.Skills.Builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/web_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb) + +Line 41. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/setup.mdx new file mode 100644 index 0000000000..66080e52c6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/web-search-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WebSearchSkill#setup" + parent: "SignalWire::Skills::Builtin::WebSearchSkill" + module: "SignalWire.Skills.Builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/web_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb) + +Line 19. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/supports-multiple-instances.mdx new file mode 100644 index 0000000000..c797470de4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/web-search-skill/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WebSearchSkill#supports_multiple_instances?" + parent: "SignalWire::Skills::Builtin::WebSearchSkill" + module: "SignalWire.Skills.Builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/builtin/web_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/version.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/version.mdx new file mode 100644 index 0000000000..7b07a3a45b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/web-search-skill/version.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/web-search-skill/version" +title: "version" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WebSearchSkill#version" + parent: "SignalWire::Skills::Builtin::WebSearchSkill" + module: "SignalWire.Skills.Builtin.WebSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb" + visibility: "public" +--- +# `version` + +## Signature + +```ruby +def version +``` + +## Source + +[`lib/signalwire/skills/builtin/web_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/web_search.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/description.mdx new file mode 100644 index 0000000000..9827545dba --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/description.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearchSkill#description" + parent: "SignalWire::Skills::Builtin::WikipediaSearchSkill" + module: "SignalWire.Skills.Builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Source + +[`lib/signalwire/skills/builtin/wikipedia_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..f41810e393 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/get-parameter-schema.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearchSkill#get_parameter_schema" + parent: "SignalWire::Skills::Builtin::WikipediaSearchSkill" + module: "SignalWire.Skills.Builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb" + visibility: "public" +--- +# `get_parameter_schema` + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/builtin/wikipedia_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb) + +Line 51. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..cdd63e1f5f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/get-prompt-sections.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearchSkill#get_prompt_sections" + parent: "SignalWire::Skills::Builtin::WikipediaSearchSkill" + module: "SignalWire.Skills.Builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/builtin/wikipedia_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb) + +Line 37. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/index.mdx new file mode 100644 index 0000000000..842982e775 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill" +title: "WikipediaSearchSkill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearchSkill" + parent: "SignalWire::Skills::Builtin" + module: "SignalWire.Skills.Builtin" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb" + visibility: "public" +--- +# `WikipediaSearchSkill` + +## Signature + +```ruby +class WikipediaSearchSkill < SignalWire::Skills::SkillBase +``` + +## Inheritance + +**Extends:** [SignalWire::Skills::SkillBase](/reference/ruby/signal-wire/skills/skill-base) + +## Methods + + + + + + + + + + + + + + + +## Source + +[`lib/signalwire/skills/builtin/wikipedia_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/name.mdx new file mode 100644 index 0000000000..f00f135559 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/name.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearchSkill#name" + parent: "SignalWire::Skills::Builtin::WikipediaSearchSkill" + module: "SignalWire.Skills.Builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Source + +[`lib/signalwire/skills/builtin/wikipedia_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb) + +Line 14. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/register-tools.mdx new file mode 100644 index 0000000000..6acaa2f6e0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/register-tools.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearchSkill#register_tools" + parent: "SignalWire::Skills::Builtin::WikipediaSearchSkill" + module: "SignalWire.Skills.Builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb" + visibility: "public" +--- +# `register_tools` + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/builtin/wikipedia_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/setup.mdx new file mode 100644 index 0000000000..a240f60f06 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/setup.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/builtin/wikipedia-search-skill/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::Builtin::WikipediaSearchSkill#setup" + parent: "SignalWire::Skills::Builtin::WikipediaSearchSkill" + module: "SignalWire.Skills.Builtin.WikipediaSearchSkill" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb" + visibility: "public" +--- +# `setup` + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/builtin/wikipedia_search.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/builtin/wikipedia_search.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/index.mdx new file mode 100644 index 0000000000..d0d087411c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/skills" +title: "Skills" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Skills" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `Skills` + +## Signature + +```ruby +module Skills +``` + +## Classes + + + + Base class for all skills. Subclasses override the metadata methods and +register\_tools+ to supply tool hashes. + + + + Thread-safe lifecycle manager for loaded skill instances. + + + + Global registry mapping skill names to factory lambdas. + + + +## Modules + + + + + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 12. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/agent.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/agent.mdx new file mode 100644 index 0000000000..4484b0ee1e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/agent.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/agent" +title: "agent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#agent" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `agent` + +Python parity: + +- `params` — params hash passed at construction +- `agent` — owning AgentBase instance (or nil for standalone) +- `logger` — namespaced logger `signalwire.skills.` +- `swaig_fields` — extra SWAIG fields merged into tool defs; + pulled out of `params` if provided + +## Signature + +```ruby +attr_reader agent -> Object +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/cleanup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/cleanup.mdx new file mode 100644 index 0000000000..26db3d767b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/cleanup.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/cleanup" +title: "cleanup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#cleanup" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `cleanup` + +Called when the skill is unloaded. + +## Signature + +```ruby +def cleanup +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 68. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/description.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/description.mdx new file mode 100644 index 0000000000..a30e937c34 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/description" +title: "description" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#description" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `description` + +## Signature + +```ruby +def description +``` + +## Throws + +- `NotImplementedError` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-global-data.mdx new file mode 100644 index 0000000000..e4adbaddb1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-global-data.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/get-global-data" +title: "get_global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#get_global_data" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `get_global_data` + +Global data to merge into the agent. + +## Signature + +```ruby +def get_global_data +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 62. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-hints.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-hints.mdx new file mode 100644 index 0000000000..cc4329f5f7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-hints.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/get-hints" +title: "get_hints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#get_hints" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `get_hints` + +Speech recognition hints. + +## Signature + +```ruby +def get_hints +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 59. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-param.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-param.mdx new file mode 100644 index 0000000000..b5b6ffdc33 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-param.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/get-param" +title: "get_param" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#get_param" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `get_param` + +Helper to get a param with env-var fallback. + +## Signature + +```ruby +def get_param(key, env_var: nil, default: nil) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 77. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-parameter-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-parameter-schema.mdx new file mode 100644 index 0000000000..c005d2290d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-parameter-schema.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#get_parameter_schema" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `get_parameter_schema` + +Parameter schema for GUI / validation. + +## Signature + +```ruby +def get_parameter_schema +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 74. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-prompt-sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-prompt-sections.mdx new file mode 100644 index 0000000000..547abef545 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/get-prompt-sections.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#get_prompt_sections" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `get_prompt_sections` + +Prompt sections to add to the agent. + +## Signature + +```ruby +def get_prompt_sections +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 65. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/index.mdx new file mode 100644 index 0000000000..27787967ad --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/index.mdx @@ -0,0 +1,105 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base" +title: "SkillBase" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase" + parent: "SignalWire::Skills" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `SkillBase` + +Base class for all skills. Subclasses override the metadata methods +and +register\_tools+ to supply tool hashes. + +## Signature + +```ruby +class SkillBase < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Python parity: - `params` — params hash passed at construction - `agent` — owning AgentBase instance (or nil for standalone) - `logger` — namespaced logger `signalwire.skills.` - `swaig_fields` — extra SWAIG fields merged into tool defs; pulled out of `params` if provided + + + + Called when the skill is unloaded. + + + + + + Global data to merge into the agent. + + + + Speech recognition hints. + + + + Helper to get a param with env-var fallback. + + + + Parameter schema for GUI / validation. + + + + Prompt sections to add to the agent. + + + + Python parity: `SkillBase.__init__(self, agent, params=None)`. First positional arg is the owning AgentBase (or nil for standalone). The second is the params hash. We accept the legacy 1-arg form for backwards compatibility (`DateTimeSkill.new({...})`). + + + + Unique key for tracking this skill instance. + + + + Python parity: - `params` — params hash passed at construction - `agent` — owning AgentBase instance (or nil for standalone) - `logger` — namespaced logger `signalwire.skills.` - `swaig_fields` — extra SWAIG fields merged into tool defs; pulled out of `params` if provided + + + + + + Python parity: - `params` — params hash passed at construction - `agent` — owning AgentBase instance (or nil for standalone) - `logger` — namespaced logger `signalwire.skills.` - `swaig_fields` — extra SWAIG fields merged into tool defs; pulled out of `params` if provided + + + + Return an Array of tool definition hashes. Each hash should have: :name, :description, :parameters, :handler (lambda/proc) + + + + + + Called once after construction. Return +true+ if the skill is ready. + + + + + + Python parity: - `params` — params hash passed at construction - `agent` — owning AgentBase instance (or nil for standalone) - `logger` — namespaced logger `signalwire.skills.` - `swaig_fields` — extra SWAIG fields merged into tool defs; pulled out of `params` if provided + + + + + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/initialize.mdx new file mode 100644 index 0000000000..b74e89bd9e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/initialize.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#initialize" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `initialize` + +Python parity: `SkillBase.__init__(self, agent, params=None)`. +First positional arg is the owning AgentBase (or nil for +standalone). The second is the params hash. We accept the legacy +1-arg form for backwards compatibility (`DateTimeSkill.new({...})`). + +## Signature + +```ruby +def initialize(agent = nil, params = nil) +``` + +## Parameters + + + + + +## Returns + +`SkillBase` — a new instance of SkillBase + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 34. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/instance-key.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/instance-key.mdx new file mode 100644 index 0000000000..d1d56e6e43 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/instance-key.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/instance-key" +title: "instance_key" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#instance_key" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `instance_key` + +Unique key for tracking this skill instance. + +## Signature + +```ruby +def instance_key +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 71. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/logger.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/logger.mdx new file mode 100644 index 0000000000..18adf14bdc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/logger.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/logger" +title: "logger" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#logger" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `logger` + +Python parity: + +- `params` — params hash passed at construction +- `agent` — owning AgentBase instance (or nil for standalone) +- `logger` — namespaced logger `signalwire.skills.` +- `swaig_fields` — extra SWAIG fields merged into tool defs; + pulled out of `params` if provided + +## Signature + +```ruby +attr_reader logger -> Object +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/name.mdx new file mode 100644 index 0000000000..4cfc738c30 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#name" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `name` + +## Signature + +```ruby +def name +``` + +## Throws + +- `NotImplementedError` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/params.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/params.mdx new file mode 100644 index 0000000000..f7e25897e4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/params" +title: "params" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#params" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `params` + +Python parity: + +- `params` — params hash passed at construction +- `agent` — owning AgentBase instance (or nil for standalone) +- `logger` — namespaced logger `signalwire.skills.` +- `swaig_fields` — extra SWAIG fields merged into tool defs; + pulled out of `params` if provided + +## Signature + +```ruby +attr_reader params -> Object +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/register-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/register-tools.mdx new file mode 100644 index 0000000000..7e3e95e8ed --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/register-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/register-tools" +title: "register_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#register_tools" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `register_tools` + +Return an Array of tool definition hashes. Each hash should have: +:name, :description, :parameters, :handler (lambda/proc) + +## Signature + +```ruby +def register_tools +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 56. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/required-env-vars.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/required-env-vars.mdx new file mode 100644 index 0000000000..e08d4fa56f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/required-env-vars.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/required-env-vars" +title: "required_env_vars" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#required_env_vars" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `required_env_vars` + +## Signature + +```ruby +def required_env_vars +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 27. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/setup.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/setup.mdx new file mode 100644 index 0000000000..297c028dc8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/setup.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/setup" +title: "setup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#setup" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `setup` + +Called once after construction. Return +true+ if the skill is ready. + +## Signature + +```ruby +def setup +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 52. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/supports-multiple-instances.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/supports-multiple-instances.mdx new file mode 100644 index 0000000000..ede02af293 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/supports-multiple-instances" +title: "supports_multiple_instances?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#supports_multiple_instances?" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `supports_multiple_instances?` + +## Signature + +```ruby +def supports_multiple_instances? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 28. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/swaig-fields.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/swaig-fields.mdx new file mode 100644 index 0000000000..c4df0a8057 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/swaig-fields.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/swaig-fields" +title: "swaig_fields" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#swaig_fields" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `swaig_fields` + +Python parity: + +- `params` — params hash passed at construction +- `agent` — owning AgentBase instance (or nil for standalone) +- `logger` — namespaced logger `signalwire.skills.` +- `swaig_fields` — extra SWAIG fields merged into tool defs; + pulled out of `params` if provided + +## Signature + +```ruby +attr_reader swaig_fields -> Object +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 22. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/version.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/version.mdx new file mode 100644 index 0000000000..e1ca6a2cc6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-base/version.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-base/version" +title: "version" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillBase#version" + parent: "SignalWire::Skills::SkillBase" + module: "SignalWire.Skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb" + visibility: "public" +--- +# `version` + +## Signature + +```ruby +def version +``` + +## Source + +[`lib/signalwire/skills/skill_base.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_base.rb) + +Line 26. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/agent.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/agent.mdx new file mode 100644 index 0000000000..024bc40a11 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/agent.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-manager/agent" +title: "agent" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillManager#agent" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb" + visibility: "public" +--- +# `agent` + +Python parity: + +- `agent` — owning AgentBase instance (or nil) +- `logger` — namespaced logger + +## Signature + +```ruby +attr_reader agent -> Object +``` + +## Source + +[`lib/signalwire/skills/skill_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/clear.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/clear.mdx new file mode 100644 index 0000000000..384448c24b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/clear.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-manager/clear" +title: "clear" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillManager#clear" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb" + visibility: "public" +--- +# `clear` + +Unload all skills. + +## Signature + +```ruby +def clear +``` + +## Source + +[`lib/signalwire/skills/skill_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb) + +Line 89. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/get.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/get.mdx new file mode 100644 index 0000000000..df2587d14b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-manager/get" +title: "get" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillManager#get" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb" + visibility: "public" +--- +# `get` + +Retrieve a loaded skill. + +## Signature + +```ruby +def get(key) +``` + +## Parameters + + + +## Returns + +`SkillBase | nil` + +## Source + +[`lib/signalwire/skills/skill_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb) + +Line 69. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/index.mdx new file mode 100644 index 0000000000..361c9687a6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-manager" +title: "SkillManager" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillManager" + parent: "SignalWire::Skills" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb" + visibility: "public" +--- +# `SkillManager` + +Thread-safe lifecycle manager for loaded skill instances. + +manager = SkillManager.new +manager.load('datetime', DateTimeSkill.new) +manager.get('datetime') #=> <DateTimeSkill> +manager.unload('datetime') + +## Signature + +```ruby +class SkillManager < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Python parity: - `agent` — owning AgentBase instance (or nil) - `logger` — namespaced logger + + + + Unload all skills. + + + + Retrieve a loaded skill. + + + + Python parity: `SkillManager.__init__(self, agent)` — SkillManager keeps a back-pointer to its agent so loaded skills can attach prompt sections / SWAIG tools directly. Ruby allows nil for standalone use (tests, registry tools). + + + + Load a skill instance. Calls +setup+ on the skill; raises if it fails. + + + + + + + + Python parity: - `agent` — owning AgentBase instance (or nil) - `logger` — namespaced logger + + + + + + Unload a skill by instance key. Calls +cleanup+ on it. + + + +## Source + +[`lib/signalwire/skills/skill_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/initialize.mdx new file mode 100644 index 0000000000..446d248e7f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/initialize.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-manager/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillManager#initialize" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb" + visibility: "public" +--- +# `initialize` + +Python parity: `SkillManager.__init__(self, agent)` — +SkillManager keeps a back-pointer to its agent so loaded +skills can attach prompt sections / SWAIG tools directly. +Ruby allows nil for standalone use (tests, registry tools). + +## Signature + +```ruby +def initialize(agent = nil) +``` + +## Parameters + + + +## Returns + +`SkillManager` — a new instance of SkillManager + +## Source + +[`lib/signalwire/skills/skill_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/load.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/load.mdx new file mode 100644 index 0000000000..61487c838d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/load.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-manager/load" +title: "load" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillManager#load" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb" + visibility: "public" +--- +# `load` + +Load a skill instance. Calls +setup+ on the skill; raises if it fails. + +## Signature + +```ruby +def load(key, skill) +``` + +## Parameters + + + the instance key + + + + the skill instance + + +## Returns + +`SkillBase` — the loaded skill + +## Source + +[`lib/signalwire/skills/skill_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb) + +Line 42. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/loaded-keys.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/loaded-keys.mdx new file mode 100644 index 0000000000..abfe0be5fe --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/loaded-keys.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-manager/loaded-keys" +title: "loaded_keys" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillManager#loaded_keys" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb" + visibility: "public" +--- +# `loaded_keys` + +## Signature + +```ruby +def loaded_keys +``` + +## Returns + +`Array` + +## Source + +[`lib/signalwire/skills/skill_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb) + +Line 79. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/loaded.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/loaded.mdx new file mode 100644 index 0000000000..e2187f6179 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/loaded.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-manager/loaded" +title: "loaded?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillManager#loaded?" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb" + visibility: "public" +--- +# `loaded?` + +## Signature + +```ruby +def loaded?(key) +``` + +## Parameters + + + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/skill_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb) + +Line 74. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/logger.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/logger.mdx new file mode 100644 index 0000000000..5958e2f42e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/logger.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-manager/logger" +title: "logger" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillManager#logger" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb" + visibility: "public" +--- +# `logger` + +Python parity: + +- `agent` — owning AgentBase instance (or nil) +- `logger` — namespaced logger + +## Signature + +```ruby +attr_reader logger -> Object +``` + +## Source + +[`lib/signalwire/skills/skill_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/size.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/size.mdx new file mode 100644 index 0000000000..e1ac9f5976 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/size.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-manager/size" +title: "size" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillManager#size" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb" + visibility: "public" +--- +# `size` + +## Signature + +```ruby +def size +``` + +## Returns + +`Integer` + +## Source + +[`lib/signalwire/skills/skill_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb) + +Line 84. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/unload.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/unload.mdx new file mode 100644 index 0000000000..1c6c675d83 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-manager/unload.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-manager/unload" +title: "unload" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillManager#unload" + parent: "SignalWire::Skills::SkillManager" + module: "SignalWire.Skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb" + visibility: "public" +--- +# `unload` + +Unload a skill by instance key. Calls +cleanup+ on it. + +## Signature + +```ruby +def unload(key) +``` + +## Parameters + + + +## Returns + +`SkillBase | nil` — the removed skill, or nil + +## Source + +[`lib/signalwire/skills/skill_manager.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_manager.rb) + +Line 58. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/add-skill-directory.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/add-skill-directory.mdx new file mode 100644 index 0000000000..6eac3b85e6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/add-skill-directory.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/add-skill-directory" +title: "add_skill_directory" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry#add_skill_directory" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `add_skill_directory` + +Add a directory to search for skills. + +Mirrors Python's `SkillRegistry.add_skill_directory`: validate +that the path exists and is a directory, then append it +(de-duplicated) to `@external_paths`. Raises `ArgumentError` +(the Ruby analog of Python's `ValueError`) for invalid input. + +## Signature + +```ruby +def add_skill_directory(path) +``` + +## Parameters + + + absolute or relative path to a directory + + +## Returns + +`void` + +## Throws + +- `ArgumentError` — when the path doesn't exist or isn't a directory. + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 52. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/external-paths.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/external-paths.mdx new file mode 100644 index 0000000000..d91f44c2dc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/external-paths.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/external-paths" +title: "external_paths" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry#external_paths" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `external_paths` + +External skill directories registered via #add\_skill\_directory. +Mirrors Python's `_external_paths` accessor surface. + +## Signature + +```ruby +attr_reader external_paths -> Object +``` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 39. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/get-all-skills-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/get-all-skills-schema.mdx new file mode 100644 index 0000000000..27b27acdf5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/get-all-skills-schema.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/get-all-skills-schema" +title: "get_all_skills_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry#get_all_skills_schema" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `get_all_skills_schema` + +Get complete schema for all registered skills (instance form). + +Mirrors Python's instance-method +`SkillRegistry.get_all_skills_schema()` — returns a hash keyed +by skill name, each value containing parameter metadata. Ruby +skills don't carry rich Python-style parameter introspection in +v1, so the value defaults to a minimal shape with the skill +name; built-ins that expose `parameter_schema` get richer +detail. + +## Signature + +```ruby +def get_all_skills_schema +``` + +## Returns + +`Hash{String => Hash}` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 75. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/get-all-skills-schema__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/get-all-skills-schema__2.mdx new file mode 100644 index 0000000000..70c9e9cc5a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/get-all-skills-schema__2.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/get-all-skills-schema__2" +title: "get_all_skills_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry.get_all_skills_schema" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `get_all_skills_schema` + +Get complete schema for all registered skills. + +Mirrors Python's +`SkillRegistry.get_all_skills_schema()` — returns a hash +keyed by skill name, with each value containing parameter +metadata. Ruby skills don't carry rich Python-style parameter +introspection in v1, so the value defaults to a minimal shape +with the skill name; built-in skills that expose +`parameter_schema` get richer detail. + +## Signature + +```ruby +def get_all_skills_schema +``` + +## Returns + +`Hash{String => Hash}` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 229. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/get-factory.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/get-factory.mdx new file mode 100644 index 0000000000..937138b310 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/get-factory.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/get-factory" +title: "get_factory" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry.get_factory" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `get_factory` + +Get the factory for a skill. + +## Signature + +```ruby +def get_factory(skill_name) +``` + +## Parameters + + + +## Returns + +`Proc | nil` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 165. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/index.mdx new file mode 100644 index 0000000000..e4718220fa --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/index.mdx @@ -0,0 +1,106 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry" +title: "SkillRegistry" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry" + parent: "SignalWire::Skills" + module: "SignalWire.Skills" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `SkillRegistry` + +Global registry mapping skill names to factory lambdas. + +SkillRegistry.register('datetime') \{ |params| DateTimeSkill.new(params) \} +factory = SkillRegistry.get\_factory('datetime') +skill = factory.call(\{ 'timezone' => 'UTC' \}) + +## Signature + +```ruby +class SkillRegistry < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Add a directory to search for skills. + + + + External skill directories registered via #add\_skill\_directory. Mirrors Python's `_external_paths` accessor surface. + + + + Get complete schema for all registered skills (instance form). + + + + Get complete schema for all registered skills. + + + + Get the factory for a skill. + + + + Per-instance state for the skill-directory parity surface; the class-method API above is preserved for backwards compatibility, but `add_skill_directory` mirrors Python's instance-method shape exactly (Python's `signalwire.skills.registry.SkillRegistry`). + + + + The most recently registered skill name (instance form). + + + + List all registered skill names (instance form). + + + + List all registered skill names. + + + + Python parity: `self.logger = get_logger("skill_registry")`. Per-instance logger; the class-level API uses the same name. + + + + Register a skill factory. + + + + Register all built-in skills. Called at load time. + + + + Register a skill class or factory (instance form). + + + + Register with an explicit lambda / proc instead of a block. + + + + Check if a skill is registered. + + + + Clear all registrations (primarily for testing). + + + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 19. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/initialize.mdx new file mode 100644 index 0000000000..1cb8f3e639 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/initialize.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry#initialize" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `initialize` + +Per-instance state for the skill-directory parity surface; the +class-method API above is preserved for backwards compatibility, +but `add_skill_directory` mirrors Python's instance-method shape +exactly (Python's `signalwire.skills.registry.SkillRegistry`). + +## Signature + +```ruby +def initialize +``` + +## Returns + +`SkillRegistry` — a new instance of SkillRegistry + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 27. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/last-registered.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/last-registered.mdx new file mode 100644 index 0000000000..022867c8b4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/last-registered.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/last-registered" +title: "last_registered" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry#last_registered" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `last_registered` + +The most recently registered skill name (instance form). + +## Signature + +```ruby +attr_reader last_registered -> Object +``` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 141. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/list-skills.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/list-skills.mdx new file mode 100644 index 0000000000..70f8d9e1d4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/list-skills.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/list-skills" +title: "list_skills" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry#list_skills" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `list_skills` + +List all registered skill names (instance form). + +Python parity: `SkillRegistry.list_skills(self)` returns a list of +dictionaries describing each skill. Ruby v1 returns the +registered names plus available metadata (description / version) +when the factory can be instantiated without arguments. + +## Signature + +```ruby +def list_skills +``` + +## Returns + +`Array` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 87. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/list-skills__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/list-skills__2.mdx new file mode 100644 index 0000000000..769808c765 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/list-skills__2.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/list-skills__2" +title: "list_skills" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry.list_skills" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `list_skills` + +List all registered skill names. + +## Signature + +```ruby +def list_skills +``` + +## Returns + +`Array` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 171. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/logger.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/logger.mdx new file mode 100644 index 0000000000..3c31ac81fb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/logger.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/logger" +title: "logger" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry#logger" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `logger` + +Python parity: `self.logger = get_logger("skill_registry")`. +Per-instance logger; the class-level API uses the same name. + +## Signature + +```ruby +attr_reader logger -> Object +``` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 35. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register-builtins.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register-builtins.mdx new file mode 100644 index 0000000000..324305a2ab --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register-builtins.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/register-builtins" +title: "register_builtins!" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry.register_builtins!" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `register_builtins!` + +Register all built-in skills. Called at load time. + +## Signature + +```ruby +def register_builtins! +``` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 211. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register-skill.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register-skill.mdx new file mode 100644 index 0000000000..396a355194 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register-skill.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/register-skill" +title: "register_skill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry#register_skill" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `register_skill` + +Register a skill class or factory (instance form). + +Python parity: `SkillRegistry.register_skill(self, skill_class)` +accepts a SkillBase subclass and stores its factory. Ruby +accepts either a class with a `new(params)` constructor, a +`Proc` /`Lambda`, or a 2-arg `(name, factory)` form for +explicit naming. Returns `self` for chaining. + +## Signature + +```ruby +def register_skill(skill_class_or_name, factory = nil) +``` + +## Parameters + + + either a SkillBase subclass (Python style) or a string skill name (legacy 2-arg form). + + + + explicit factory when first arg is a string (legacy form). + + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 104. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register-skill__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register-skill__2.mdx new file mode 100644 index 0000000000..480a403eda --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register-skill__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/register-skill__2" +title: "register_skill" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry.register_skill" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `register_skill` + +Register with an explicit lambda / proc instead of a block. + +## Signature + +```ruby +def register_skill(skill_name, factory) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 156. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register.mdx new file mode 100644 index 0000000000..ad592dd475 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/register.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/register" +title: "register" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry.register" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `register` + +Register a skill factory. + +## Signature + +```ruby +def register(skill_name, &block) +``` + +## Parameters + + + + + +## Yields + +- `params` — block that receives params hash and returns a SkillBase + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 147. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/registered.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/registered.mdx new file mode 100644 index 0000000000..435fa0371b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/registered.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/registered" +title: "registered?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry.registered?" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `registered?` + +Check if a skill is registered. + +## Signature + +```ruby +def registered?(skill_name) +``` + +## Parameters + + + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 201. diff --git a/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/reset.mdx b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/reset.mdx new file mode 100644 index 0000000000..75273b5eee --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/skills/skill-registry/reset.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/skills/skill-registry/reset" +title: "reset!" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Skills::SkillRegistry.reset!" + parent: "SignalWire::Skills::SkillRegistry" + module: "SignalWire.Skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb" + visibility: "public" +--- +# `reset!` + +Clear all registrations (primarily for testing). + +## Signature + +```ruby +def reset! +``` + +## Source + +[`lib/signalwire/skills/skill_registry.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/skills/skill_registry.rb) + +Line 206. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/action.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/action.mdx new file mode 100644 index 0000000000..2ddbd40912 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/action.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/action" +title: "action" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#action" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `action` + +Returns the value of attribute action. + +## Signature + +```ruby +attr_accessor action <-> Object +``` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/action__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/action__2.mdx new file mode 100644 index 0000000000..9c1e34d602 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/action__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/action__2" +title: "action=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#action=" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `action=` + +Sets the attribute action + +## Signature + +```ruby +attr_accessor action= <-> Object +``` + +## Parameters + + + the value to set the attribute action to. + + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/add-action.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/add-action.mdx new file mode 100644 index 0000000000..87c721abfa --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/add-action.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/add-action" +title: "add_action" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#add_action" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `add_action` + +Add a single structured action. + +## Signature + +```ruby +def add_action(name, data) +``` + +## Parameters + + + action key + + + + action value + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 57. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/add-actions.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/add-actions.mdx new file mode 100644 index 0000000000..8bde06883a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/add-actions.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/add-actions" +title: "add_actions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#add_actions" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `add_actions` + +Add multiple structured actions at once. + +## Signature + +```ruby +def add_actions(actions) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 65. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/add-dynamic-hints.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/add-dynamic-hints.mdx new file mode 100644 index 0000000000..36a9820ede --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/add-dynamic-hints.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/add-dynamic-hints" +title: "add_dynamic_hints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#add_dynamic_hints" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `add_dynamic_hints` + +Add dynamic speech recognition hints. + +## Signature + +```ruby +def add_dynamic_hints(hints) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 342. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/clear-dynamic-hints.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/clear-dynamic-hints.mdx new file mode 100644 index 0000000000..6fca76b271 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/clear-dynamic-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/clear-dynamic-hints" +title: "clear_dynamic_hints" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#clear_dynamic_hints" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `clear_dynamic_hints` + +Clear all dynamic speech recognition hints. + +## Signature + +```ruby +def clear_dynamic_hints +``` + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 348. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/connect.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/connect.mdx new file mode 100644 index 0000000000..6270ff43a7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/connect.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/connect" +title: "connect" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#connect" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `connect` + +Connect / transfer the call to another destination. + +## Signature + +```ruby +def connect(destination, final: true, from_addr: nil) +``` + +## Parameters + + + phone number, SIP address, etc. + + + + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 80. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/create-payment-action.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/create-payment-action.mdx new file mode 100644 index 0000000000..3d8c055bee --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/create-payment-action.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/create-payment-action" +title: "create_payment_action" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult.create_payment_action" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `create_payment_action` + +Create a payment action for use inside payment prompts. + +## Signature + +```ruby +def create_payment_action(action_type, phrase) +``` + +## Parameters + + + "Say" or "Play" + + + + +## Returns + +`Hash` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 733. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/create-payment-parameter.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/create-payment-parameter.mdx new file mode 100644 index 0000000000..aaac84e089 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/create-payment-parameter.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/create-payment-parameter" +title: "create_payment_parameter" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult.create_payment_parameter" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `create_payment_parameter` + +Create a payment parameter for use with +pay+. + +## Signature + +```ruby +def create_payment_parameter(name, value) +``` + +## Parameters + + + + + +## Returns + +`Hash` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 742. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/create-payment-prompt.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/create-payment-prompt.mdx new file mode 100644 index 0000000000..2442081af7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/create-payment-prompt.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/create-payment-prompt" +title: "create_payment_prompt" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult.create_payment_prompt" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `create_payment_prompt` + +Create a payment prompt structure for use with +pay+. + +## Signature + +```ruby +def create_payment_prompt(for_situation, actions, card_type: nil, error_type: nil) +``` + +## Parameters + + + e.g. "payment-card-number" + + + + actions with "type" and "phrase" keys + + + + + + +## Returns + +`Hash` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 718. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/enable-extensive-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/enable-extensive-data.mdx new file mode 100644 index 0000000000..e35177ca6d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/enable-extensive-data.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/enable-extensive-data" +title: "enable_extensive_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#enable_extensive_data" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `enable_extensive_data` + +Send full data to LLM for this turn only. + +## Signature + +```ruby +def enable_extensive_data(enabled = true) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 384. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/enable-functions-on-timeout.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/enable-functions-on-timeout.mdx new file mode 100644 index 0000000000..4ec84bff2c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/enable-functions-on-timeout.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/enable-functions-on-timeout" +title: "enable_functions_on_timeout" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#enable_functions_on_timeout" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `enable_functions_on_timeout` + +Enable function calls on speaker timeout. + +## Signature + +```ruby +def enable_functions_on_timeout(enabled = true) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 377. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/execute-rpc.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/execute-rpc.mdx new file mode 100644 index 0000000000..47819fd024 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/execute-rpc.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/execute-rpc" +title: "execute_rpc" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#execute_rpc" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `execute_rpc` + +Execute a generic RPC method via SWML. + +## Signature + +```ruby +def execute_rpc(method, params: nil, call_id: nil, node_id: nil) +``` + +## Parameters + + + RPC method name + + + + + + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 640. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/execute-swml.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/execute-swml.mdx new file mode 100644 index 0000000000..9444baeab5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/execute-swml.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/execute-swml" +title: "execute_swml" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#execute_swml" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `execute_swml` + +Execute SWML content with optional transfer. + +## Signature + +```ruby +def execute_swml(swml_content, transfer: false) +``` + +## Parameters + + + SWML data structure or JSON string + + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 404. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/hangup.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/hangup.mdx new file mode 100644 index 0000000000..800e5ba689 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/hangup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/hangup" +title: "hangup" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#hangup" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `hangup` + +Terminate the call. + +## Signature + +```ruby +def hangup +``` + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 124. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/hold.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/hold.mdx new file mode 100644 index 0000000000..282d3cb776 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/hold.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/hold" +title: "hold" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#hold" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `hold` + +Put the call on hold. + +## Signature + +```ruby +def hold(timeout = 300) +``` + +## Parameters + + + seconds, clamped to 0..900 + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 131. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/index.mdx new file mode 100644 index 0000000000..8408145ee5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/index.mdx @@ -0,0 +1,273 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result" +title: "FunctionResult" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult" + parent: "SignalWire::Swaig" + module: "SignalWire.Swaig" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `FunctionResult` + +Response builder that tool handlers return. +All mutating methods return +self+ for fluent chaining. + +result = FunctionResult.new("Found your order") +.update\_global\_data("order\_id" => "12345") +.say("Let me look that up") + +The result object has three main components: + +1. response - Text the AI should say back to the user +2. action - List of structured actions to execute +3. post\_process - Whether to let AI take another turn before executing actions + +## Signature + +```ruby +class FunctionResult < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Returns the value of attribute action. + + + + Sets the attribute action + + + + Add a single structured action. + + + + Add multiple structured actions at once. + + + + Add dynamic speech recognition hints. + + + + Clear all dynamic speech recognition hints. + + + + Connect / transfer the call to another destination. + + + + Create a payment action for use inside payment prompts. + + + + Create a payment parameter for use with +pay+. + + + + Create a payment prompt structure for use with +pay+. + + + + Send full data to LLM for this turn only. + + + + Enable function calls on speaker timeout. + + + + Execute a generic RPC method via SWML. + + + + Execute SWML content with optional transfer. + + + + Terminate the call. + + + + Put the call on hold. + + + + + + Join an ad-hoc audio conference via SWML. + + + + Join a RELAY room via SWML. + + + + Process payment using SWML pay action. + + + + Play audio/video file in the background. + + + + Returns the value of attribute post\_process. + + + + Sets the attribute post\_process + + + + Start background call recording via SWML. + + + + Remove global agent data variables. + + + + Remove metadata from current function's scope. + + + + Replace the tool\_call + result pair in conversation history. + + + + Returns the value of attribute response. + + + + Sets the attribute response + + + + Inject a message into an AI agent on another call. + + + + Unhold another call via RPC. + + + + Dial out to a number via RPC. + + + + Make the agent speak specific text. + + + + Send an SMS message via SWML. + + + + Adjust end-of-speech timeout. + + + + Set metadata scoped to current function's meta\_data\_token. + + + + Enable / disable post-processing. + + + + Set the natural-language response text. + + + + Adjust speech event timeout. + + + + Queue simulated user input. + + + + Send SIP REFER via SWML. + + + + Stop agent execution. + + + + Stop currently playing background file. + + + + Stop an active background call recording. + + + + Stop an active tap stream via SWML. + + + + Switch agent context/prompt during conversation. + + + + Change the conversation context. + + + + Change the conversation step. + + + + Transfer via SWML with an AI response when transfer completes. + + + + Send a user event through SWML. + + + + Start a background call tap via SWML. + + + + Convert to the Hash structure expected by SWAIG. + + + + + + Enable / disable specific SWAIG functions. + + + + Update global agent data variables. + + + + Update agent runtime settings (temperature, top\_p, etc.). + + + + Control how the agent waits for user input. + + + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/initialize.mdx new file mode 100644 index 0000000000..55b5b5ec88 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/initialize.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#initialize" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(response = nil, post_process: false) +``` + +## Parameters + + + text the AI speaks back to the user + + + + +## Returns + +`FunctionResult` — a new instance of FunctionResult + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 29. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/join-conference.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/join-conference.mdx new file mode 100644 index 0000000000..f839d18c9d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/join-conference.mdx @@ -0,0 +1,78 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/join-conference" +title: "join_conference" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#join_conference" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `join_conference` + +Join an ad-hoc audio conference via SWML. + +## Signature + +```ruby +def join_conference(name, muted: false, beep: "true", start_on_enter: true, end_on_exit: false, wait_url: nil, max_participants: 250, record: "do-not-record", region: nil, trim: "trim-silence", coach: nil, status_callback_event: nil, status_callback: nil, status_callback_method: "POST", recording_status_callback: nil, recording_status_callback_method: "POST", recording_status_callback_event: "completed", result: nil) +``` + +## Parameters + + + conference name (required) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`self` + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 430. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/join-room.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/join-room.mdx new file mode 100644 index 0000000000..aec11e7069 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/join-room.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/join-room" +title: "join_room" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#join_room" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `join_room` + +Join a RELAY room via SWML. + +## Signature + +```ruby +def join_room(name) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 488. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/pay.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/pay.mdx new file mode 100644 index 0000000000..e8d1ebd822 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/pay.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/pay" +title: "pay" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#pay" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `pay` + +Process payment using SWML pay action. + +## Signature + +```ruby +def pay(payment_connector_url:, input_method: "dtmf", status_url: nil, payment_method: "credit-card", timeout: 5, max_attempts: 1, security_code: true, postal_code: true, min_postal_code_length: 0, token_type: "reusable", charge_amount: nil, currency: "usd", language: "en-US", voice: "woman", description: nil, valid_card_types: "visa mastercard amex", parameters: nil, prompts: nil, ai_response: 'The payment status is ${pay_result}, do not mention anything else about collecting payment if successful.') +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 586. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/play-background-file.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/play-background-file.mdx new file mode 100644 index 0000000000..c68c9ed1dd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/play-background-file.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/play-background-file" +title: "play_background_file" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#play_background_file" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `play_background_file` + +Play audio/video file in the background. + +## Signature + +```ruby +def play_background_file(filename, wait: false) +``` + +## Parameters + + + audio/video filename or URL + + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 272. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/post-process.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/post-process.mdx new file mode 100644 index 0000000000..51a1ed83af --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/post-process.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/post-process" +title: "post_process" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#post_process" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `post_process` + +Returns the value of attribute post\_process. + +## Signature + +```ruby +attr_accessor post_process <-> Object +``` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/post-process__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/post-process__2.mdx new file mode 100644 index 0000000000..739d274095 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/post-process__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/post-process__2" +title: "post_process=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#post_process=" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `post_process=` + +Sets the attribute post\_process + +## Signature + +```ruby +attr_accessor post_process= <-> Object +``` + +## Parameters + + + the value to set the attribute post\_process to. + + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/record-call.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/record-call.mdx new file mode 100644 index 0000000000..5c2f193f1f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/record-call.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/record-call" +title: "record_call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#record_call" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `record_call` + +Start background call recording via SWML. + +## Signature + +```ruby +def record_call(control_id: nil, stereo: false, format: "wav", direction: "both", terminators: nil, beep: false, input_sensitivity: 44.0, initial_timeout: nil, end_silence_timeout: nil, max_length: nil, status_url: nil) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`self` + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 293. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/remove-global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/remove-global-data.mdx new file mode 100644 index 0000000000..81e24f800c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/remove-global-data.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/remove-global-data" +title: "remove_global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#remove_global_data" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `remove_global_data` + +Remove global agent data variables. + +## Signature + +```ruby +def remove_global_data(keys) +``` + +## Parameters + + + key(s) to remove + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 175. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/remove-metadata.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/remove-metadata.mdx new file mode 100644 index 0000000000..cd7dda92f2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/remove-metadata.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/remove-metadata" +title: "remove_metadata" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#remove_metadata" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `remove_metadata` + +Remove metadata from current function's scope. + +## Signature + +```ruby +def remove_metadata(keys) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 189. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/replace-in-history.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/replace-in-history.mdx new file mode 100644 index 0000000000..ff76e1601b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/replace-in-history.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/replace-in-history" +title: "replace_in_history" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#replace_in_history" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `replace_in_history` + +Replace the tool\_call + result pair in conversation history. + +## Signature + +```ruby +def replace_in_history(text = true) +``` + +## Parameters + + + replacement text, or +true+ to remove entirely + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 252. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/response.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/response.mdx new file mode 100644 index 0000000000..bc711a47f0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/response.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/response" +title: "response" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#response" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `response` + +Returns the value of attribute response. + +## Signature + +```ruby +attr_accessor response <-> Object +``` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/response__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/response__2.mdx new file mode 100644 index 0000000000..b3c62ccbd7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/response__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/response__2" +title: "response=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#response=" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `response=` + +Sets the attribute response + +## Signature + +```ruby +attr_accessor response= <-> Object +``` + +## Parameters + + + the value to set the attribute response to. + + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 25. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/rpc-ai-message.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/rpc-ai-message.mdx new file mode 100644 index 0000000000..cb3ade68b1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/rpc-ai-message.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/rpc-ai-message" +title: "rpc_ai_message" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#rpc_ai_message" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `rpc_ai_message` + +Inject a message into an AI agent on another call. + +## Signature + +```ruby +def rpc_ai_message(call_id, message_text, role: "system") +``` + +## Parameters + + + + + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 682. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/rpc-ai-unhold.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/rpc-ai-unhold.mdx new file mode 100644 index 0000000000..185d55e630 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/rpc-ai-unhold.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/rpc-ai-unhold" +title: "rpc_ai_unhold" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#rpc_ai_unhold" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `rpc_ai_unhold` + +Unhold another call via RPC. + +## Signature + +```ruby +def rpc_ai_unhold(call_id) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 696. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/rpc-dial.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/rpc-dial.mdx new file mode 100644 index 0000000000..72191dacbc --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/rpc-dial.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/rpc-dial" +title: "rpc_dial" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#rpc_dial" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `rpc_dial` + +Dial out to a number via RPC. + +## Signature + +```ruby +def rpc_dial(to_number:, from_number:, dest_swml:, device_type: "phone") +``` + +## Parameters + + + + + + + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 660. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/say.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/say.mdx new file mode 100644 index 0000000000..2bde4279d4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/say.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/say" +title: "say" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#say" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `say` + +Make the agent speak specific text. + +## Signature + +```ruby +def say(text) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 263. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/send-sms.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/send-sms.mdx new file mode 100644 index 0000000000..29200239a2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/send-sms.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/send-sms" +title: "send_sms" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#send_sms" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `send_sms` + +Send an SMS message via SWML. + +## Signature + +```ruby +def send_sms(to_number:, from_number:, body: nil, media: nil, tags: nil, region: nil) +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`self` + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 559. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-end-of-speech-timeout.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-end-of-speech-timeout.mdx new file mode 100644 index 0000000000..3c4d410298 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-end-of-speech-timeout.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/set-end-of-speech-timeout" +title: "set_end_of_speech_timeout" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#set_end_of_speech_timeout" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `set_end_of_speech_timeout` + +Adjust end-of-speech timeout. + +## Signature + +```ruby +def set_end_of_speech_timeout(milliseconds) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 356. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-metadata.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-metadata.mdx new file mode 100644 index 0000000000..57bb4249fe --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-metadata.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/set-metadata" +title: "set_metadata" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#set_metadata" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `set_metadata` + +Set metadata scoped to current function's meta\_data\_token. + +## Signature + +```ruby +def set_metadata(data) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 182. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-post-process.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-post-process.mdx new file mode 100644 index 0000000000..5659222171 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-post-process.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/set-post-process" +title: "set_post_process" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#set_post_process" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `set_post_process` + +Enable / disable post-processing. + +## Signature + +```ruby +def set_post_process(val) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 48. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-response.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-response.mdx new file mode 100644 index 0000000000..91d60779cb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-response.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/set-response" +title: "set_response" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#set_response" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `set_response` + +Set the natural-language response text. + +## Signature + +```ruby +def set_response(text) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 41. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-speech-event-timeout.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-speech-event-timeout.mdx new file mode 100644 index 0000000000..5d9af275d3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/set-speech-event-timeout.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/set-speech-event-timeout" +title: "set_speech_event_timeout" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#set_speech_event_timeout" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `set_speech_event_timeout` + +Adjust speech event timeout. + +## Signature + +```ruby +def set_speech_event_timeout(milliseconds) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 363. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/simulate-user-input.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/simulate-user-input.mdx new file mode 100644 index 0000000000..2f18f1b4e2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/simulate-user-input.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/simulate-user-input" +title: "simulate_user_input" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#simulate_user_input" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `simulate_user_input` + +Queue simulated user input. + +## Signature + +```ruby +def simulate_user_input(text) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 703. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/sip-refer.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/sip-refer.mdx new file mode 100644 index 0000000000..6f9411b456 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/sip-refer.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/sip-refer" +title: "sip_refer" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#sip_refer" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `sip_refer` + +Send SIP REFER via SWML. + +## Signature + +```ruby +def sip_refer(to_uri) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 499. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop-background-file.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop-background-file.mdx new file mode 100644 index 0000000000..2eb9983e6a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop-background-file.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/stop-background-file" +title: "stop_background_file" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#stop_background_file" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `stop_background_file` + +Stop currently playing background file. + +## Signature + +```ruby +def stop_background_file +``` + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 282. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop-record-call.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop-record-call.mdx new file mode 100644 index 0000000000..607a25516c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop-record-call.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/stop-record-call" +title: "stop_record_call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#stop_record_call" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `stop_record_call` + +Stop an active background call recording. + +## Signature + +```ruby +def stop_record_call(control_id: nil) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 324. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop-tap.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop-tap.mdx new file mode 100644 index 0000000000..9271541725 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop-tap.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/stop-tap" +title: "stop_tap" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#stop_tap" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `stop_tap` + +Stop an active tap stream via SWML. + +## Signature + +```ruby +def stop_tap(control_id: nil) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 539. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop.mdx new file mode 100644 index 0000000000..842c23d2bf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#stop" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `stop` + +Stop agent execution. + +## Signature + +```ruby +def stop +``` + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 157. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/switch-context.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/switch-context.mdx new file mode 100644 index 0000000000..1ae73a728b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/switch-context.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/switch-context" +title: "switch_context" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#switch_context" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `switch_context` + +Switch agent context/prompt during conversation. + +When only +system\_prompt+ is provided and all flags are false, emits +a simple string context switch. Otherwise emits the full object form. + +## Signature + +```ruby +def switch_context(system_prompt: nil, user_prompt: nil, consolidate: false, full_reset: false, isolated: false) +``` + +## Parameters + + + + + + + + + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 233. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-change-context.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-change-context.mdx new file mode 100644 index 0000000000..50974af382 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-change-context.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/swml-change-context" +title: "swml_change_context" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#swml_change_context" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `swml_change_context` + +Change the conversation context. + +## Signature + +```ruby +def swml_change_context(context_name) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 218. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-change-step.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-change-step.mdx new file mode 100644 index 0000000000..d6bfe12efe --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-change-step.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/swml-change-step" +title: "swml_change_step" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#swml_change_step" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `swml_change_step` + +Change the conversation step. + +## Signature + +```ruby +def swml_change_step(step_name) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 211. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-transfer.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-transfer.mdx new file mode 100644 index 0000000000..a2f1e7a707 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-transfer.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/swml-transfer" +title: "swml_transfer" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#swml_transfer" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `swml_transfer` + +Transfer via SWML with an AI response when transfer completes. + +## Signature + +```ruby +def swml_transfer(dest, ai_response, final: true) +``` + +## Parameters + + + destination URL for the transfer + + + + message AI says when transfer completes + + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 104. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-user-event.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-user-event.mdx new file mode 100644 index 0000000000..5c956f9815 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/swml-user-event.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/swml-user-event" +title: "swml_user_event" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#swml_user_event" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `swml_user_event` + +Send a user event through SWML. + +## Signature + +```ruby +def swml_user_event(event_data) +``` + +## Parameters + + + event payload + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 196. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/tap.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/tap.mdx new file mode 100644 index 0000000000..b8ee677976 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/tap.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/tap" +title: "tap" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#tap" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `tap` + +Start a background call tap via SWML. + +## Signature + +```ruby +def tap(uri, control_id: nil, direction: "both", codec: "PCMU", rtp_ptime: 20, status_url: nil) +``` + +## Parameters + + + destination URI (rtp://, ws://, wss://) + + + + + + + + + + + + +## Returns + +`self` + +## Throws + +- `ArgumentError` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 516. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/to-h.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/to-h.mdx new file mode 100644 index 0000000000..02022fb6e8 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/to-h.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/to-h" +title: "to_h" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#to_h" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `to_h` + +Convert to the Hash structure expected by SWAIG. + +Rules: + +- +response+ always included (string) +- +action+ only included if at least one action exists +- +post\_process+ only included if +true+ and actions exist + +## Signature + +```ruby +def to_h +``` + +## Returns + +`Hash` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 758. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/to-json.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/to-json.mdx new file mode 100644 index 0000000000..4d91db8f6f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/to-json.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/to-json" +title: "to_json" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#to_json" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `to_json` + +## Signature + +```ruby +def to_json(*args) +``` + +## Parameters + + + +## Returns + +`String` — JSON representation + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 772. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/toggle-functions.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/toggle-functions.mdx new file mode 100644 index 0000000000..dd3fc0940b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/toggle-functions.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/toggle-functions" +title: "toggle_functions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#toggle_functions" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `toggle_functions` + +Enable / disable specific SWAIG functions. + +## Signature + +```ruby +def toggle_functions(toggles) +``` + +## Parameters + + + each with "function" and "active" keys + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 370. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/update-global-data.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/update-global-data.mdx new file mode 100644 index 0000000000..90ccc63fa4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/update-global-data.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/update-global-data" +title: "update_global_data" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#update_global_data" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `update_global_data` + +Update global agent data variables. + +## Signature + +```ruby +def update_global_data(data) +``` + +## Parameters + + + key-value pairs to set/update + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 168. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/update-settings.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/update-settings.mdx new file mode 100644 index 0000000000..469f893eed --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/update-settings.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/update-settings" +title: "update_settings" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#update_settings" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `update_settings` + +Update agent runtime settings (temperature, top\_p, etc.). + +## Signature + +```ruby +def update_settings(settings) +``` + +## Parameters + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 391. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/wait-for-user.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/wait-for-user.mdx new file mode 100644 index 0000000000..d6ab9cdfa4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/function-result/wait-for-user.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/swaig/function-result/wait-for-user" +title: "wait_for_user" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Swaig::FunctionResult#wait_for_user" + parent: "SignalWire::Swaig::FunctionResult" + module: "SignalWire.Swaig.FunctionResult" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `wait_for_user` + +Control how the agent waits for user input. + +## Signature + +```ruby +def wait_for_user(enabled: nil, timeout: nil, answer_first: false) +``` + +## Parameters + + + + + + + +## Returns + +`self` + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 142. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swaig/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/swaig/index.mdx new file mode 100644 index 0000000000..28d620cec2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swaig/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/swaig" +title: "Swaig" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Swaig" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb" + visibility: "public" +--- +# `Swaig` + +## Signature + +```ruby +module Swaig +``` + +## Classes + + + + Response builder that tool handlers return. All mutating methods return +self+ for fluent chaining. + + + +## Source + +[`lib/signalwire/swaig/function_result.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swaig/function_result.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/add-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/add-section.mdx new file mode 100644 index 0000000000..43d0e58a8f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/add-section.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/add-section" +title: "add_section" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#add_section" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `add_section` + +Add a new named section. Returns true if created, false if it already exists. + +## Signature + +```ruby +def add_section(name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 24. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/add-verb-to-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/add-verb-to-section.mdx new file mode 100644 index 0000000000..8ad4fd6171 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/add-verb-to-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/add-verb-to-section" +title: "add_verb_to_section" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#add_verb_to_section" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `add_verb_to_section` + +Append a verb to an arbitrary section. + +## Signature + +```ruby +def add_verb_to_section(section, verb_name, config) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 48. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/add-verb.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/add-verb.mdx new file mode 100644 index 0000000000..71f12e9524 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/add-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/add-verb" +title: "add_verb" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#add_verb" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `add_verb` + +Append a verb to the _main_ section. + +add\_verb('answer', \{\}) +add\_verb('sleep', 2000) + +## Signature + +```ruby +def add_verb(verb_name, config) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 43. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/get-verbs.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/get-verbs.mdx new file mode 100644 index 0000000000..0546118f3f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/get-verbs.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/get-verbs" +title: "get_verbs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#get_verbs" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `get_verbs` + +Return the list of verb hashes for a section. + +## Signature + +```ruby +def get_verbs(section = 'main') +``` + +## Parameters + + + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 61. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/has-section.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/has-section.mdx new file mode 100644 index 0000000000..164614726a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/has-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/has-section" +title: "has_section?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#has_section?" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `has_section?` + +Check whether a section exists. + +## Signature + +```ruby +def has_section?(name) +``` + +## Parameters + + + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 35. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/index.mdx new file mode 100644 index 0000000000..91e56247e5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/index.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document" +title: "Document" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::SWML::Document" + parent: "SignalWire::SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `Document` + +## Signature + +```ruby +class Document < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Add a new named section. Returns true if created, false if it already exists. + + + + Append a verb to the _main_ section. + + + + Append a verb to an arbitrary section. + + + + Return the list of verb hashes for a section. + + + + Check whether a section exists. + + + + + + Compact JSON string. + + + + Pretty-printed JSON string. + + + + Reset the document to its initial empty state. + + + + Returns the value of attribute sections. + + + + Produce a plain Ruby hash suitable for JSON serialization. + + + + Returns the value of attribute version. + + + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/initialize.mdx new file mode 100644 index 0000000000..5546722091 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/initialize.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#initialize" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize +``` + +## Returns + +`Document` — a new instance of Document + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/render-pretty.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/render-pretty.mdx new file mode 100644 index 0000000000..f86c94c4ed --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/render-pretty.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/render-pretty" +title: "render_pretty" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#render_pretty" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `render_pretty` + +Pretty-printed JSON string. + +## Signature + +```ruby +def render_pretty +``` + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 79. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/render.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/render.mdx new file mode 100644 index 0000000000..23020d9b82 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/render.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/render" +title: "render" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#render" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `render` + +Compact JSON string. + +## Signature + +```ruby +def render +``` + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 74. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/reset.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/reset.mdx new file mode 100644 index 0000000000..66130316b5 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/reset.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/reset" +title: "reset" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#reset" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `reset` + +Reset the document to its initial empty state. + +## Signature + +```ruby +def reset +``` + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/sections.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/sections.mdx new file mode 100644 index 0000000000..0d0d985d2a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/sections.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/sections" +title: "sections" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#sections" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `sections` + +Returns the value of attribute sections. + +## Signature + +```ruby +attr_reader sections -> Object +``` + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/to-h.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/to-h.mdx new file mode 100644 index 0000000000..2b101c52ee --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/to-h.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/to-h" +title: "to_h" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#to_h" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `to_h` + +Produce a plain Ruby hash suitable for JSON serialization. + +## Signature + +```ruby +def to_h +``` + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 66. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/document/version.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/document/version.mdx new file mode 100644 index 0000000000..74dec21334 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/document/version.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/document/version" +title: "version" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Document#version" + parent: "SignalWire::SWML::Document" + module: "SignalWire.SWML.Document" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb" + visibility: "public" +--- +# `version` + +Returns the value of attribute version. + +## Signature + +```ruby +attr_reader version -> Object +``` + +## Source + +[`lib/signalwire/swml/document.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/document.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/index.mdx new file mode 100644 index 0000000000..fd055b8266 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/swml" +title: "SWML" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::SWML" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb" + visibility: "public" +--- +# `SWML` + +## Signature + +```ruby +module SWML +``` + +## Methods + + + + Allow resetting for tests + + + + Module-level singleton so the schema is loaded at most once. + + + +## Classes + + + + + + + + + +## Source + +[`lib/signalwire/swml/schema.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb) + +Line 6. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/reset-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/reset-schema.mdx new file mode 100644 index 0000000000..d490e42722 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/reset-schema.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/reset-schema" +title: "reset_schema!" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML.reset_schema!" + parent: "SignalWire::SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb" + visibility: "public" +--- +# `reset_schema!` + +Allow resetting for tests + +## Signature + +```ruby +def reset_schema! +``` + +## Source + +[`lib/signalwire/swml/schema.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb) + +Line 77. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/schema.mdx new file mode 100644 index 0000000000..3f4b129c15 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/schema.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/schema" +title: "schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML.schema" + parent: "SignalWire::SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb" + visibility: "public" +--- +# `schema` + +Module-level singleton so the schema is loaded at most once. + +## Signature + +```ruby +def schema +``` + +## Source + +[`lib/signalwire/swml/schema.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb) + +Line 72. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/schema/get-verb.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/get-verb.mdx new file mode 100644 index 0000000000..fae868e745 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/get-verb.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/swml/schema/get-verb" +title: "get_verb" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Schema#get_verb" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb" + visibility: "public" +--- +# `get_verb` + +Return the full definition hash for a verb, or nil. + +## Signature + +```ruby +def get_verb(name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/swml/schema.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb) + +Line 31. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/schema/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/index.mdx new file mode 100644 index 0000000000..18eae29c96 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/ruby/signal-wire/swml/schema" +title: "Schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::SWML::Schema" + parent: "SignalWire::SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb" + visibility: "public" +--- +# `Schema` + +## Signature + +```ruby +class Schema < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Return the full definition hash for a verb, or nil. + + + + + + Is +name+ a recognised SWML verb? + + + + How many verbs are defined in the schema. + + + + Sorted list of all known verb names. + + + + Returns the value of attribute verbs. + + + +## Source + +[`lib/signalwire/swml/schema.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb) + +Line 7. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/schema/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/initialize.mdx new file mode 100644 index 0000000000..dae458b878 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/initialize.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/swml/schema/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Schema#initialize" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize +``` + +## Returns + +`Schema` — a new instance of Schema + +## Source + +[`lib/signalwire/swml/schema.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb) + +Line 10. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/schema/valid-verb.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/valid-verb.mdx new file mode 100644 index 0000000000..b35a279278 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/valid-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swml/schema/valid-verb" +title: "valid_verb?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Schema#valid_verb?" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb" + visibility: "public" +--- +# `valid_verb?` + +Is +name+ a recognised SWML verb? + +## Signature + +```ruby +def valid_verb?(name) +``` + +## Parameters + + + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/swml/schema.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/schema/verb-count.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/verb-count.mdx new file mode 100644 index 0000000000..8a870160c4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/verb-count.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/schema/verb-count" +title: "verb_count" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Schema#verb_count" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb" + visibility: "public" +--- +# `verb_count` + +How many verbs are defined in the schema. + +## Signature + +```ruby +def verb_count +``` + +## Source + +[`lib/signalwire/swml/schema.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb) + +Line 26. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/schema/verb-names.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/verb-names.mdx new file mode 100644 index 0000000000..d41f5ca566 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/verb-names.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/schema/verb-names" +title: "verb_names" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Schema#verb_names" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb" + visibility: "public" +--- +# `verb_names` + +Sorted list of all known verb names. + +## Signature + +```ruby +def verb_names +``` + +## Source + +[`lib/signalwire/swml/schema.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/schema/verbs.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/verbs.mdx new file mode 100644 index 0000000000..4c11ebbcf9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/schema/verbs.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/schema/verbs" +title: "verbs" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Schema#verbs" + parent: "SignalWire::SWML::Schema" + module: "SignalWire.SWML.Schema" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb" + visibility: "public" +--- +# `verbs` + +Returns the value of attribute verbs. + +## Signature + +```ruby +attr_reader verbs -> Object +``` + +## Source + +[`lib/signalwire/swml/schema.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/schema.rb) + +Line 8. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/config-file.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/config-file.mdx new file mode 100644 index 0000000000..f8377e4ac6 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/config-file.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/config-file" +title: "config_file" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#config_file" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `config_file` + +Python parity: + +- `name`, `route`, `host`, `port` — surface from + SWMLService. +- `schema_path` — path to the SWML schema file (or nil to use + the gem-bundled default). +- `config_file` — optional TOML/YAML config file path. +- `schema_validation` — boolean flag mirroring Python's + `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` + env var forces this to false. + +## Signature + +```ruby +attr_reader config_file -> Object +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/define-tool.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/define-tool.mdx new file mode 100644 index 0000000000..039ff73ca7 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/define-tool.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/define-tool" +title: "define_tool" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#define_tool" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `define_tool` + +Define a SWAIG function the AI can call. Tool descriptions and +parameter descriptions are LLM-facing prompt engineering — see +PORTING\_GUIDE for guidance. + +## Signature + +```ruby +def define_tool(name:, description:, parameters: {}, secure: false, &handler) +``` + +## Parameters + + + + + + + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 84. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/define-tools.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/define-tools.mdx new file mode 100644 index 0000000000..b65995d935 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/define-tools.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/define-tools" +title: "define_tools" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#define_tools" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `define_tools` + +Return an array of all tool definitions (for SWML rendering). + +## Signature + +```ruby +def define_tools +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 106. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/document.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/document.mdx new file mode 100644 index 0000000000..9b8e46bd5a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/document.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/document" +title: "document" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#document" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `document` + +Expose the underlying document (useful for tests and subclasses). + +## Signature + +```ruby +def document +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 352. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/execute-verb.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/execute-verb.mdx new file mode 100644 index 0000000000..3d478cb5fb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/execute-verb.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/execute-verb" +title: "execute_verb" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#execute_verb" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `execute_verb` + +Execute a SWML verb, adding it to the current document. + +For most verbs the config is a keyword-args Hash. +The +sleep+ verb is special: it also accepts a bare Integer. + +## Signature + +```ruby +def execute_verb(verb_name, args = [], kwargs = {}) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 216. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-all-functions.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-all-functions.mdx new file mode 100644 index 0000000000..e188f81f9f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-all-functions.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/get-all-functions" +title: "get_all_functions" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#get_all_functions" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `get_all_functions` + +Snapshot of all registered SWAIG functions keyed by name. +(Python parity: ToolRegistry#get\_all\_functions.) + +## Signature + +```ruby +def get_all_functions +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 145. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-basic-auth-credentials-with-source.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-basic-auth-credentials-with-source.mdx new file mode 100644 index 0000000000..904ce0723b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-basic-auth-credentials-with-source.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/get-basic-auth-credentials-with-source" +title: "get_basic_auth_credentials_with_source" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#get_basic_auth_credentials_with_source" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `get_basic_auth_credentials_with_source` + +Backwards-compat alias for the legacy 3-tuple-only form. + +## Signature + +```ruby +def get_basic_auth_credentials_with_source +``` + +## Returns + +`Array(String, String, String)` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 284. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..937aecd739 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-basic-auth-credentials.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/get-basic-auth-credentials" +title: "get_basic_auth_credentials" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#get_basic_auth_credentials" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `get_basic_auth_credentials` + +Get the configured basic-auth credentials. + +Python parity: `get_basic_auth_credentials(include_source=False)`. +When `include_source` is true, returns a 3-tuple `[user, +pass, source]` where `source` is one of `"environment"`, +`"auto-generated"`, or `"provided"`. Otherwise returns the +2-tuple `[user, pass]`. + +## Signature + +```ruby +def get_basic_auth_credentials(include_source: false) +``` + +## Parameters + + + +## Returns + +`Array(String, String)` — or \[Array(String, String, String)] + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 251. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-full-url.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-full-url.mdx new file mode 100644 index 0000000000..95cdaf6c33 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-full-url.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/get-full-url" +title: "get_full_url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#get_full_url" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `get_full_url` + +Build the full URL for this service. + +get\_full\_url # => "http://0.0.0.0:3000/" +get\_full\_url(include\_auth: true) # => "http://user:pass@0.0.0.0:3000/" + +## Signature + +```ruby +def get_full_url(include_auth: false) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 292. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-function.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-function.mdx new file mode 100644 index 0000000000..53d56c22f0 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/get-function.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/get-function" +title: "get_function" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#get_function" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `get_function` + +Get a registered SWAIG function by name, or nil when absent. +(Python parity: ToolRegistry#get\_function.) + +## Signature + +```ruby +def get_function(name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 139. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/handle-additional-route.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/handle-additional-route.mdx new file mode 100644 index 0000000000..b0b2916d10 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/handle-additional-route.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/handle-additional-route" +title: "handle_additional_route" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#handle_additional_route" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `handle_additional_route` + +Extension point: register additional Rack routes after Service +mounts /health, /ready, /swaig, and the main route. AgentBase uses +this to add /post\_prompt, /debug\_events, /mcp. + +## Signature + +```ruby +def handle_additional_route(_sub_path, _request_data, _env) +``` + +## Parameters + + + + + + + +## Returns + +`Array | nil` — A Rack response triple, or nil if not handled + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 190. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/has-function.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/has-function.mdx new file mode 100644 index 0000000000..a8c9d4e376 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/has-function.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/has-function" +title: "has_function" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#has_function" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `has_function` + +Whether a SWAIG function with the given name is registered. +(Python parity: ToolRegistry#has\_function.) + +## Signature + +```ruby +def has_function(name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 133. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/host.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/host.mdx new file mode 100644 index 0000000000..52c78bd7e9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/host.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/host" +title: "host" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#host" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `host` + +Python parity: + +- `name`, `route`, `host`, `port` — surface from + SWMLService. +- `schema_path` — path to the SWML schema file (or nil to use + the gem-bundled default). +- `config_file` — optional TOML/YAML config file path. +- `schema_validation` — boolean flag mirroring Python's + `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` + env var forces this to false. + +## Signature + +```ruby +attr_reader host -> Object +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/index.mdx new file mode 100644 index 0000000000..df1f779dda --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/index.mdx @@ -0,0 +1,196 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service" +title: "Service" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::SWML::Service" + parent: "SignalWire::SWML" + module: "SignalWire.SWML" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `Service` + +## Signature + +```ruby +class Service < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Constants + + + Maximum request body size enforced on /swaig and the main route (1 MB). + + +## Methods + + + + Python parity: - `name`, `route`, `host`, `port` — surface from SWMLService. - `schema_path` — path to the SWML schema file (or nil to use the gem-bundled default). - `config_file` — optional TOML/YAML config file path. - `schema_validation` — boolean flag mirroring Python's `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` env var forces this to false. + + + + Define a SWAIG function the AI can call. Tool descriptions and parameter descriptions are LLM-facing prompt engineering — see PORTING\_GUIDE for guidance. + + + + Return an array of all tool definitions (for SWML rendering). + + + + Expose the underlying document (useful for tests and subclasses). + + + + Execute a SWML verb, adding it to the current document. + + + + Snapshot of all registered SWAIG functions keyed by name. (Python parity: ToolRegistry#get\_all\_functions.) + + + + Get the configured basic-auth credentials. + + + + Backwards-compat alias for the legacy 3-tuple-only form. + + + + Build the full URL for this service. + + + + Get a registered SWAIG function by name, or nil when absent. (Python parity: ToolRegistry#get\_function.) + + + + Extension point: register additional Rack routes after Service mounts /health, /ready, /swaig, and the main route. AgentBase uses this to add /post\_prompt, /debug\_events, /mcp. + + + + Whether a SWAIG function with the given name is registered. (Python parity: ToolRegistry#has\_function.) + + + + Python parity: - `name`, `route`, `host`, `port` — surface from SWMLService. - `schema_path` — path to the SWML schema file (or nil to use the gem-bundled default). - `config_file` — optional TOML/YAML config file path. - `schema_validation` — boolean flag mirroring Python's `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` env var forces this to false. + + + + + + List registered SWAIG tool names in registration order. + + + + \------------------------------------------------------------------ Verb auto-vivification via method\_missing ------------------------------------------------------------------ + + + + Python parity: - `name`, `route`, `host`, `port` — surface from SWMLService. - `schema_path` — path to the SWML schema file (or nil to use the gem-bundled default). - `config_file` — optional TOML/YAML config file path. - `schema_validation` — boolean flag mirroring Python's `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` env var forces this to false. + + + + Dispatch a function call to the registered handler. Default plain implementation — AgentBase overrides with token validation. + + + + Customization hook called when SWML is requested. Default delegates to \{#on\_swml\_request\} and returns its result. Subclasses typically override +on\_swml\_request+ rather than this method. + + + + Customization point for subclasses to modify SWML based on request data. The default returns nil (no modification). + + + + Python parity: - `name`, `route`, `host`, `port` — surface from SWMLService. - `schema_path` — path to the SWML schema file (or nil to use the gem-bundled default). - `config_file` — optional TOML/YAML config file path. - `schema_validation` — boolean flag mirroring Python's `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` env var forces this to false. + + + + Returns a Rack-compatible application. + + + + \------------------------------------------------------------------ Routing callbacks & request handling ------------------------------------------------------------------ + + + + Register a raw SWAIG function definition (e.g. from DataMap#to\_swaig\_function). + + + + Remove a registered SWAIG function. Returns true on success, false when the function was not registered. (Python parity: ToolRegistry#remove\_function.) + + + + \------------------------------------------------------------------ Render the current SWML document ------------------------------------------------------------------ + + + + Extension point: handle GET /swaig (returns the SWML document by default). AgentBase overrides to render with prompts + dynamic config. + + + + + + + + Python parity: - `name`, `route`, `host`, `port` — surface from SWMLService. - `schema_path` — path to the SWML schema file (or nil to use the gem-bundled default). - `config_file` — optional TOML/YAML config file path. - `schema_validation` — boolean flag mirroring Python's `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` env var forces this to false. + + + + Python parity: - `name`, `route`, `host`, `port` — surface from SWMLService. - `schema_path` — path to the SWML schema file (or nil to use the gem-bundled default). - `config_file` — optional TOML/YAML config file path. - `schema_validation` — boolean flag mirroring Python's `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` env var forces this to false. + + + + SchemaUtils helper bound to this Service. Mirrors Python's self.schema\_utils public instance attribute on SWMLService. Built lazily on first access. + + + + Python parity: - `name`, `route`, `host`, `port` — surface from SWMLService. - `schema_path` — path to the SWML schema file (or nil to use the gem-bundled default). - `config_file` — optional TOML/YAML config file path. - `schema_validation` — boolean flag mirroring Python's `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` env var forces this to false. + + + + Start serving (blocking). + + + + Gracefully stop the server. + + + + Extension point: invoked between argument parsing and function dispatch on POST /swaig. Returns \[target, short\_circuit]. If short\_circuit is non-nil, it's returned as the SWAIG response without calling on\_function\_call. AgentBase overrides to add session-token validation and ephemeral dynamic-config copies. + + + + Validate provided basic-auth credentials against the configured ones using a constant-time comparison. Python parity: AuthMixin#validate\_basic\_auth(username, password). + + + +## Classes + + + + \------------------------------------------------------------------ Middleware: security headers ------------------------------------------------------------------ + + + + \------------------------------------------------------------------ Middleware: timing-safe Basic-Auth ------------------------------------------------------------------ + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 13. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/initialize.mdx new file mode 100644 index 0000000000..dc35546e9a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/initialize.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#initialize" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(name:, route: '/', host: '0.0.0.0', port: nil, basic_auth: nil, schema_path: nil, config_file: nil, schema_validation: true) +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`Service` — a new instance of Service + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 34. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/list-tool-names.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/list-tool-names.mdx new file mode 100644 index 0000000000..de48a7ae98 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/list-tool-names.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/list-tool-names" +title: "list_tool_names" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#list_tool_names" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `list_tool_names` + +List registered SWAIG tool names in registration order. + +## Signature + +```ruby +def list_tool_names +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 127. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/method-missing.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/method-missing.mdx new file mode 100644 index 0000000000..b9fd9d3fa3 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/method-missing.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/method-missing" +title: "method_missing" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#method_missing" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `method_missing` + +*** + +## Verb auto-vivification via method\_missing + +## Signature + +```ruby +def method_missing(method_name, *args, **kwargs) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 198. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/name.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/name.mdx new file mode 100644 index 0000000000..8d8e118957 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/name.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/name" +title: "name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#name" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `name` + +Python parity: + +- `name`, `route`, `host`, `port` — surface from + SWMLService. +- `schema_path` — path to the SWML schema file (or nil to use + the gem-bundled default). +- `config_file` — optional TOML/YAML config file path. +- `schema_validation` — boolean flag mirroring Python's + `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` + env var forces this to false. + +## Signature + +```ruby +attr_reader name -> Object +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/on-function-call.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/on-function-call.mdx new file mode 100644 index 0000000000..e7642183f4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/on-function-call.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/on-function-call" +title: "on_function_call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#on_function_call" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `on_function_call` + +Dispatch a function call to the registered handler. Default plain +implementation — AgentBase overrides with token validation. + +## Signature + +```ruby +def on_function_call(name, args, raw_data) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 113. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/on-request.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/on-request.mdx new file mode 100644 index 0000000000..2212c4f5aa --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/on-request.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/on-request" +title: "on_request" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#on_request" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `on_request` + +Customization hook called when SWML is requested. Default +delegates to \{#on\_swml\_request\} and returns its result. +Subclasses typically override +on\_swml\_request+ rather than +this method. + +Return +nil+ to use the default SWML rendering, or a Hash of +modifications to merge into the document. + +Python parity: WebMixin#on\_request(request\_data, callback\_path). +The Python third +request+ argument is FastAPI-specific and +intentionally not mirrored. +Python parity: `on_request(request_data, callback_path)`. The +third Python parameter (`request`) — a FastAPI `Request` — +is propagated through Ruby as the optional `request:` keyword +so subclasses can read query/header info when a Rack-style +request is available. Default: delegate to `on_swml_request`. + +## Signature + +```ruby +def on_request(request_data = nil, callback_path = nil, request: nil) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 323. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/on-swml-request.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/on-swml-request.mdx new file mode 100644 index 0000000000..4a89f48d04 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/on-swml-request.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/on-swml-request" +title: "on_swml_request" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#on_swml_request" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `on_swml_request` + +Customization point for subclasses to modify SWML based on +request data. The default returns nil (no modification). + +Python parity: +`on_swml_request(request_data, callback_path, request)`. The +`request:` keyword carries the Rack request (or FastAPI +`Request` analogue) for subclasses that need query params +or headers. + +## Signature + +```ruby +def on_swml_request(request_data = nil, callback_path = nil, request: nil) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 335. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/port.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/port.mdx new file mode 100644 index 0000000000..7481f97f50 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/port.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/port" +title: "port" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#port" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `port` + +Python parity: + +- `name`, `route`, `host`, `port` — surface from + SWMLService. +- `schema_path` — path to the SWML schema file (or nil to use + the gem-bundled default). +- `config_file` — optional TOML/YAML config file path. +- `schema_validation` — boolean flag mirroring Python's + `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` + env var forces this to false. + +## Signature + +```ruby +attr_reader port -> Object +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/rack-app.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/rack-app.mdx new file mode 100644 index 0000000000..4c0e1c153e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/rack-app.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/rack-app" +title: "rack_app" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#rack_app" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `rack_app` + +Returns a Rack-compatible application. + +## Signature + +```ruby +def rack_app +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 371. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/register-routing-callback.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/register-routing-callback.mdx new file mode 100644 index 0000000000..b98469ba82 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/register-routing-callback.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/register-routing-callback" +title: "register_routing_callback" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#register_routing_callback" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `register_routing_callback` + +*** + +## Routing callbacks & request handling + +## Signature + +```ruby +def register_routing_callback(path, &block) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 303. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/register-swaig-function.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/register-swaig-function.mdx new file mode 100644 index 0000000000..35ddf3d097 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/register-swaig-function.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/register-swaig-function" +title: "register_swaig_function" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#register_swaig_function" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `register_swaig_function` + +Register a raw SWAIG function definition (e.g. from DataMap#to\_swaig\_function). + +## Signature + +```ruby +def register_swaig_function(func_def) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 98. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/remove-function.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/remove-function.mdx new file mode 100644 index 0000000000..ef42a99153 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/remove-function.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/remove-function" +title: "remove_function" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#remove_function" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `remove_function` + +Remove a registered SWAIG function. Returns true on success, +false when the function was not registered. +(Python parity: ToolRegistry#remove\_function.) + +## Signature + +```ruby +def remove_function(name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 155. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/render-main-swml.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/render-main-swml.mdx new file mode 100644 index 0000000000..39e9034b18 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/render-main-swml.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/render-main-swml" +title: "render_main_swml" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#render_main_swml" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `render_main_swml` + +Extension point: handle GET /swaig (returns the SWML document by +default). AgentBase overrides to render with prompts + dynamic config. + +## Signature + +```ruby +def render_main_swml(_request_data = nil, request: nil) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 178. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/render-pretty.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/render-pretty.mdx new file mode 100644 index 0000000000..03a1ed8396 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/render-pretty.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/render-pretty" +title: "render_pretty" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#render_pretty" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `render_pretty` + +## Signature + +```ruby +def render_pretty +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 347. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/render.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/render.mdx new file mode 100644 index 0000000000..669eab044b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/render.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/render" +title: "render" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#render" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `render` + +*** + +## Render the current SWML document + +## Signature + +```ruby +def render +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 343. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/respond-to-missing.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/respond-to-missing.mdx new file mode 100644 index 0000000000..73b62708ec --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/respond-to-missing.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/respond-to-missing" +title: "respond_to_missing?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#respond_to_missing?" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `respond_to_missing?` + +## Signature + +```ruby +def respond_to_missing?(method_name, include_private = false) +``` + +## Parameters + + + + + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 208. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/route.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/route.mdx new file mode 100644 index 0000000000..1a2afd7e13 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/route.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/route" +title: "route" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#route" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `route` + +Python parity: + +- `name`, `route`, `host`, `port` — surface from + SWMLService. +- `schema_path` — path to the SWML schema file (or nil to use + the gem-bundled default). +- `config_file` — optional TOML/YAML config file path. +- `schema_validation` — boolean flag mirroring Python's + `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` + env var forces this to false. + +## Signature + +```ruby +attr_reader route -> Object +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/schema-path.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/schema-path.mdx new file mode 100644 index 0000000000..a4c55d0358 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/schema-path.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/schema-path" +title: "schema_path" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#schema_path" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `schema_path` + +Python parity: + +- `name`, `route`, `host`, `port` — surface from + SWMLService. +- `schema_path` — path to the SWML schema file (or nil to use + the gem-bundled default). +- `config_file` — optional TOML/YAML config file path. +- `schema_validation` — boolean flag mirroring Python's + `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` + env var forces this to false. + +## Signature + +```ruby +attr_reader schema_path -> Object +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/schema-utils.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/schema-utils.mdx new file mode 100644 index 0000000000..4cd333c094 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/schema-utils.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/schema-utils" +title: "schema_utils" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#schema_utils" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `schema_utils` + +SchemaUtils helper bound to this Service. Mirrors Python's +self.schema\_utils public instance attribute on SWMLService. +Built lazily on first access. + +## Signature + +```ruby +def schema_utils +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 359. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/schema-validation.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/schema-validation.mdx new file mode 100644 index 0000000000..3d1f7e530c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/schema-validation.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/schema-validation" +title: "schema_validation" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#schema_validation" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `schema_validation` + +Python parity: + +- `name`, `route`, `host`, `port` — surface from + SWMLService. +- `schema_path` — path to the SWML schema file (or nil to use + the gem-bundled default). +- `config_file` — optional TOML/YAML config file path. +- `schema_validation` — boolean flag mirroring Python's + `self._schema_validation`. `SWML_SKIP_SCHEMA_VALIDATION=1` + env var forces this to false. + +## Signature + +```ruby +attr_reader schema_validation -> Object +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 23. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/security-headers-middleware/call.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/security-headers-middleware/call.mdx new file mode 100644 index 0000000000..f9b0d2dbb4 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/security-headers-middleware/call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/security-headers-middleware/call" +title: "call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service::SecurityHeadersMiddleware#call" + parent: "SignalWire::SWML::Service::SecurityHeadersMiddleware" + module: "SignalWire.SWML.Service.SecurityHeadersMiddleware" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `call` + +## Signature + +```ruby +def call(env) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 592. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/security-headers-middleware/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/security-headers-middleware/index.mdx new file mode 100644 index 0000000000..bd5c467262 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/security-headers-middleware/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/security-headers-middleware" +title: "SecurityHeadersMiddleware" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::SWML::Service::SecurityHeadersMiddleware" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `SecurityHeadersMiddleware` + +*** + +## Middleware: security headers + +## Signature + +```ruby +class SecurityHeadersMiddleware < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Constants + + + +## Methods + + + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 581. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/security-headers-middleware/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/security-headers-middleware/initialize.mdx new file mode 100644 index 0000000000..f935ed944f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/security-headers-middleware/initialize.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/security-headers-middleware/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service::SecurityHeadersMiddleware#initialize" + parent: "SignalWire::SWML::Service::SecurityHeadersMiddleware" + module: "SignalWire.SWML.Service.SecurityHeadersMiddleware" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(app) +``` + +## Parameters + + + +## Returns + +`SecurityHeadersMiddleware` — a new instance of SecurityHeadersMiddleware + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 588. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/serve.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/serve.mdx new file mode 100644 index 0000000000..5e0cdb9a7b --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/serve.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/serve" +title: "serve" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#serve" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `serve` + +Start serving (blocking). + +Python parity: +`serve(host=None, port=None, ssl_cert=None, ssl_key=None, +ssl_enabled=None, domain=None)`. When SSL parameters are +supplied the server is started with HTTPS bindings; otherwise +plain HTTP. `host`/`port` overrides default to the +constructor-provided values. + +## Signature + +```ruby +def serve(host: nil, port: nil, ssl_cert: nil, ssl_key: nil, ssl_enabled: nil, domain: nil) +``` + +## Parameters + + + + + + + + + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 390. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/stop.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/stop.mdx new file mode 100644 index 0000000000..fc2c509b96 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/stop" +title: "stop" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#stop" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `stop` + +Gracefully stop the server. + +## Signature + +```ruby +def stop +``` + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 443. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..1faa532379 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/swaig-pre-dispatch.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/swaig-pre-dispatch" +title: "swaig_pre_dispatch" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#swaig_pre_dispatch" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `swaig_pre_dispatch` + +Extension point: invoked between argument parsing and function +dispatch on POST /swaig. Returns \[target, short\_circuit]. If +short\_circuit is non-nil, it's returned as the SWAIG response +without calling on\_function\_call. AgentBase overrides to add +session-token validation and ephemeral dynamic-config copies. + +## Signature + +```ruby +def swaig_pre_dispatch(_request_data, _func_name, _env) +``` + +## Parameters + + + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 172. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/timing-safe-basic-auth/call.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/timing-safe-basic-auth/call.mdx new file mode 100644 index 0000000000..dc6e15b933 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/timing-safe-basic-auth/call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/timing-safe-basic-auth/call" +title: "call" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service::TimingSafeBasicAuth#call" + parent: "SignalWire::SWML::Service::TimingSafeBasicAuth" + module: "SignalWire.SWML.Service.TimingSafeBasicAuth" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `call` + +## Signature + +```ruby +def call(env) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 608. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/timing-safe-basic-auth/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/timing-safe-basic-auth/index.mdx new file mode 100644 index 0000000000..605ebee5ac --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/timing-safe-basic-auth/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/timing-safe-basic-auth" +title: "TimingSafeBasicAuth" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::SWML::Service::TimingSafeBasicAuth" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `TimingSafeBasicAuth` + +*** + +## Middleware: timing-safe Basic-Auth + +## Signature + +```ruby +class TimingSafeBasicAuth < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 602. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/timing-safe-basic-auth/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/timing-safe-basic-auth/initialize.mdx new file mode 100644 index 0000000000..a8f6c2e9dd --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/timing-safe-basic-auth/initialize.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/timing-safe-basic-auth/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service::TimingSafeBasicAuth#initialize" + parent: "SignalWire::SWML::Service::TimingSafeBasicAuth" + module: "SignalWire.SWML.Service.TimingSafeBasicAuth" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `initialize` + +## Signature + +```ruby +def initialize(app, service) +``` + +## Parameters + + + + + +## Returns + +`TimingSafeBasicAuth` — a new instance of TimingSafeBasicAuth + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 603. diff --git a/fern/products/sdk-reference/ruby/signal-wire/swml/service/validate-basic-auth.mdx b/fern/products/sdk-reference/ruby/signal-wire/swml/service/validate-basic-auth.mdx new file mode 100644 index 0000000000..22bd29a34c --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/swml/service/validate-basic-auth.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/ruby/signal-wire/swml/service/validate-basic-auth" +title: "validate_basic_auth" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::SWML::Service#validate_basic_auth" + parent: "SignalWire::SWML::Service" + module: "SignalWire.SWML.Service" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb" + visibility: "public" +--- +# `validate_basic_auth` + +Validate provided basic-auth credentials against the configured ones +using a constant-time comparison. +Python parity: AuthMixin#validate\_basic\_auth(username, password). + +## Signature + +```ruby +def validate_basic_auth(username, password) +``` + +## Parameters + + + + + +## Source + +[`lib/signalwire/swml/service.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/swml/service.rb) + +Line 271. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/index.mdx new file mode 100644 index 0000000000..a03e43115a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/ruby/signal-wire/utils" +title: "Utils" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Utils" + parent: "SignalWire" + module: "SignalWire" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/serverless.rb" + visibility: "public" +--- +# `Utils` + +## Signature + +```ruby +module Utils +``` + +## Methods + + + + + +## Classes + + + + SchemaUtils — Ruby port of signalwire.utils.schema\_utils.SchemaUtils. + + + + SchemaValidationError — Ruby port of signalwire.utils.schema\_utils.SchemaValidationError. + + + +## Modules + + + + SSRF-prevention guard for user-supplied URLs. + + + +## Source + +[`lib/signalwire/utils/serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/serverless.rb) + +Line 11. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/is-serverless-mode.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/is-serverless-mode.mdx new file mode 100644 index 0000000000..ab39194bd1 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/is-serverless-mode.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/utils/is-serverless-mode" +title: "is_serverless_mode" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils.is_serverless_mode" + parent: "SignalWire::Utils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/serverless.rb" + visibility: "public" +--- +# `is_serverless_mode` + +## Signature + +```ruby +def is_serverless_mode +``` + +## Returns + +`Boolean` — true unless the detected mode is 'server'. + +## Source + +[`lib/signalwire/utils/serverless.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/serverless.rb) + +Line 15. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/full-validation-available.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/full-validation-available.mdx new file mode 100644 index 0000000000..0e46e3395f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/full-validation-available.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/full-validation-available" +title: "full_validation_available?" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#full_validation_available?" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `full_validation_available?` + +Whether full JSON Schema validation is wired up. +Mirrors Python's full\_validation\_available property. + +## Signature + +```ruby +def full_validation_available? +``` + +## Returns + +`Boolean` + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 70. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/generate-method-body.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/generate-method-body.mdx new file mode 100644 index 0000000000..4e293752e9 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/generate-method-body.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/generate-method-body" +title: "generate_method_body" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#generate_method_body" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `generate_method_body` + +Generate a Python-style method body string for a verb. +Mirrors Python's generate\_method\_body(verb\_name). + +## Signature + +```ruby +def generate_method_body(verb_name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 188. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/generate-method-signature.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/generate-method-signature.mdx new file mode 100644 index 0000000000..8b7b401f90 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/generate-method-signature.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/generate-method-signature" +title: "generate_method_signature" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#generate_method_signature" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `generate_method_signature` + +Generate a Python-style method signature string for a verb. +Mirrors Python's generate\_method\_signature(verb\_name). + +## Signature + +```ruby +def generate_method_signature(verb_name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 159. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-all-verb-names.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-all-verb-names.mdx new file mode 100644 index 0000000000..daa768143d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-all-verb-names.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/get-all-verb-names" +title: "get_all_verb_names" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#get_all_verb_names" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `get_all_verb_names` + +Sorted list of all known verb names. +Mirrors Python's get\_all\_verb\_names(). + +## Signature + +```ruby +def get_all_verb_names +``` + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 87. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-verb-parameters.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-verb-parameters.mdx new file mode 100644 index 0000000000..d5f94ea37d --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-verb-parameters.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/get-verb-parameters" +title: "get_verb_parameters" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#get_verb_parameters" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `get_verb_parameters` + +Parameter-definition block used by code-gen tooling. +Mirrors Python's get\_verb\_parameters(verb\_name). + +## Signature + +```ruby +def get_verb_parameters(verb_name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 118. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-verb-properties.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-verb-properties.mdx new file mode 100644 index 0000000000..3b464fd4cb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-verb-properties.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/get-verb-properties" +title: "get_verb_properties" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#get_verb_properties" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `get_verb_properties` + +The properties\[verb\_name] block for a verb, or \{\} when unknown. +Mirrors Python's get\_verb\_properties(verb\_name). + +## Signature + +```ruby +def get_verb_properties(verb_name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 93. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-verb-required-properties.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-verb-required-properties.mdx new file mode 100644 index 0000000000..58e02607af --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/get-verb-required-properties.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/get-verb-required-properties" +title: "get_verb_required_properties" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#get_verb_required_properties" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `get_verb_required_properties` + +The required list for a verb, or \[] when unknown / no required. +Mirrors Python's get\_verb\_required\_properties(verb\_name). + +## Signature + +```ruby +def get_verb_required_properties(verb_name) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 108. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/index.mdx new file mode 100644 index 0000000000..fd36ce4dec --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/index.mdx @@ -0,0 +1,103 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils" +title: "SchemaUtils" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils" + parent: "SignalWire::Utils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `SchemaUtils` + +SchemaUtils — Ruby port of signalwire.utils.schema\_utils.SchemaUtils. + +Loads the SWML JSON Schema, extracts verb metadata, and validates +either a single verb config or a complete SWML document. + +Construction rules mirror Python: + +- Pass schema\_path: nil to use the bundled schema.json. +- schema\_validation: false disables validation (validate\_verb returns + true for every call). +- The env var SWML\_SKIP\_SCHEMA\_VALIDATION=1/true/yes also disables + validation regardless of the constructor argument. + +The Ruby port currently ships only the lightweight validator (verb +existence + required-property check). Full JSON Schema validation +can be wired in via the `json_schemer` gem by extending +init\_full\_validator. The lightweight contract matches Python's +\_validate\_verb\_lightweight() exactly. + +## Signature + +```ruby +class SchemaUtils < Object +``` + +## Inheritance + +**Extends:** `Object` + +## Methods + + + + Whether full JSON Schema validation is wired up. Mirrors Python's full\_validation\_available property. + + + + Generate a Python-style method body string for a verb. Mirrors Python's generate\_method\_body(verb\_name). + + + + Generate a Python-style method signature string for a verb. Mirrors Python's generate\_method\_signature(verb\_name). + + + + Sorted list of all known verb names. Mirrors Python's get\_all\_verb\_names(). + + + + Parameter-definition block used by code-gen tooling. Mirrors Python's get\_verb\_parameters(verb\_name). + + + + The properties\[verb\_name] block for a verb, or \{\} when unknown. Mirrors Python's get\_verb\_properties(verb\_name). + + + + The required list for a verb, or \[] when unknown / no required. Mirrors Python's get\_verb\_required\_properties(verb\_name). + + + + Construct a SchemaUtils. + + + + Read and parse the JSON Schema. Mirrors Python's load\_schema(). + + + + + + + + Validate a complete SWML document. Mirrors Python's validate\_document(document). Returns (false, \['Schema validator not initialized']) when no full validator is wired in. + + + + Validate a verb config against the schema. Mirrors Python's validate\_verb(verb\_name, verb\_config). + + + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 46. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/initialize.mdx new file mode 100644 index 0000000000..6393dfbd9e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/initialize.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#initialize" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `initialize` + +Construct a SchemaUtils. + +## Signature + +```ruby +def initialize(schema_path = nil, schema_validation = true) +``` + +## Parameters + + + path to a schema.json file; nil for the bundled copy at lib/signalwire/swml/schema.json. + + + + enable/disable schema validation. + + +## Returns + +`SchemaUtils` — a new instance of SchemaUtils + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 58. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/load-schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/load-schema.mdx new file mode 100644 index 0000000000..1d422d570f --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/load-schema.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/load-schema" +title: "load_schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#load_schema" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `load_schema` + +Read and parse the JSON Schema. Mirrors Python's load\_schema(). + +## Signature + +```ruby +def load_schema +``` + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 75. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/schema-path.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/schema-path.mdx new file mode 100644 index 0000000000..c1fc72b78e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/schema-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/schema-path" +title: "schema_path" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#schema_path" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `schema_path` + +## Signature + +```ruby +attr_reader schema_path -> String | nil +``` + +## Returns + +`String | nil` — resolved schema path (nil = embedded default) + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 51. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/schema.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/schema.mdx new file mode 100644 index 0000000000..e82d0fc781 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/schema.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/schema" +title: "schema" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#schema" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `schema` + +## Signature + +```ruby +attr_reader schema -> Hash{String=>Object} +``` + +## Returns + +`Hash{String=>Object}` — parsed JSON Schema document + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 48. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/validate-document.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/validate-document.mdx new file mode 100644 index 0000000000..53d985f649 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/validate-document.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/validate-document" +title: "validate_document" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#validate_document" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `validate_document` + +Validate a complete SWML document. +Mirrors Python's validate\_document(document). Returns +(false, \['Schema validator not initialized']) when no full +validator is wired in. + +## Signature + +```ruby +def validate_document(document) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 148. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/validate-verb.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/validate-verb.mdx new file mode 100644 index 0000000000..918ffd4006 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-utils/validate-verb.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-utils/validate-verb" +title: "validate_verb" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaUtils#validate_verb" + parent: "SignalWire::Utils::SchemaUtils" + module: "SignalWire.Utils.SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `validate_verb` + +Validate a verb config against the schema. +Mirrors Python's validate\_verb(verb\_name, verb\_config). + +## Signature + +```ruby +def validate_verb(verb_name, verb_config) +``` + +## Parameters + + + + + +## Returns + +`Array(Boolean, Array)` — (valid, errors) tuple. + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 130. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/errors.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/errors.mdx new file mode 100644 index 0000000000..8c210c441e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/errors.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-validation-error/errors" +title: "errors" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaValidationError#errors" + parent: "SignalWire::Utils::SchemaValidationError" + module: "SignalWire.Utils.SchemaValidationError" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `errors` + +Returns the value of attribute errors. + +## Signature + +```ruby +attr_reader errors -> Object +``` + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/index.mdx new file mode 100644 index 0000000000..f0dfc84adf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-validation-error" +title: "SchemaValidationError" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "class" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaValidationError" + parent: "SignalWire::Utils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `SchemaValidationError` + +SchemaValidationError — Ruby port of +signalwire.utils.schema\_utils.SchemaValidationError. + +Raised when SWML schema validation of a verb config fails. + +## Signature + +```ruby +class SchemaValidationError < StandardError +``` + +## Inheritance + +**Extends:** `StandardError` + +## Methods + + + + Returns the value of attribute errors. + + + + Construct a SchemaValidationError. Mirrors Python's SchemaValidationError(verb\_name, errors). + + + + Returns the value of attribute verb\_name. + + + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 16. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/initialize.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/initialize.mdx new file mode 100644 index 0000000000..340cc6fdcf --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/initialize.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-validation-error/initialize" +title: "initialize" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaValidationError#initialize" + parent: "SignalWire::Utils::SchemaValidationError" + module: "SignalWire.Utils.SchemaValidationError" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `initialize` + +Construct a SchemaValidationError. Mirrors Python's +SchemaValidationError(verb\_name, errors). + +## Signature + +```ruby +def initialize(verb_name, errors) +``` + +## Parameters + + + + + +## Returns + +`SchemaValidationError` — a new instance of SchemaValidationError + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 21. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/verb-name.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/verb-name.mdx new file mode 100644 index 0000000000..404a67b395 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/schema-validation-error/verb-name.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/ruby/signal-wire/utils/schema-validation-error/verb-name" +title: "verb_name" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::SchemaValidationError#verb_name" + parent: "SignalWire::Utils::SchemaValidationError" + module: "SignalWire.Utils.SchemaValidationError" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb" + visibility: "public" +--- +# `verb_name` + +Returns the value of attribute verb\_name. + +## Signature + +```ruby +attr_reader verb_name -> Object +``` + +## Source + +[`lib/signalwire/utils/schema_utils.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/schema_utils.rb) + +Line 17. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/index.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/index.mdx new file mode 100644 index 0000000000..b45290e40e --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/ruby/signal-wire/utils/url-validator" +title: "UrlValidator" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "module" + language: "ruby" + qualified_name: "SignalWire::Utils::UrlValidator" + parent: "SignalWire::Utils" + module: "SignalWire.Utils" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/url_validator.rb" + visibility: "public" +--- +# `UrlValidator` + +SSRF-prevention guard for user-supplied URLs. + +Mirrors Python's signalwire.utils.url\_validator.validate\_url: +rejects non-http(s) schemes, missing hostnames, and any URL whose +hostname resolves to a private / loopback / link-local / cloud- +metadata IP. When +allow\_private+ is true, OR the ++SWML\_ALLOW\_PRIVATE\_URLS+ env var is set to "1", "true" or "yes" +(case-insensitive), the IP-blocklist check is skipped. + +The method UrlValidator.validate\_url projects onto the Python free +function signalwire.utils.url\_validator.validate\_url via +scripts/enumerate\_signatures.py. + +## Signature + +```ruby +module UrlValidator +``` + +## Constants + + + Cross-port SSRF block list. Order matches the Python reference. + + + + +## Methods + + + + Pluggable resolver hook. Tests inject a lambda to keep the suite hermetic; production calls Resolv.getaddresses. Underscore prefix keeps it out of the public surface inventory — the Python reference only exposes `validate_url` at this module level. + + + + + + Validate that a URL is safe to fetch. + + + +## Source + +[`lib/signalwire/utils/url_validator.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/url_validator.rb) + +Line 28. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/resolver.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/resolver.mdx new file mode 100644 index 0000000000..0e2ed8e1eb --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/resolver.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/ruby/signal-wire/utils/url-validator/resolver" +title: "_resolver" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::UrlValidator._resolver" + parent: "SignalWire::Utils::UrlValidator" + module: "SignalWire.Utils.UrlValidator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/url_validator.rb" + visibility: "public" +--- +# `_resolver` + +Pluggable resolver hook. Tests inject a lambda to keep the suite +hermetic; production calls Resolv.getaddresses. Underscore prefix +keeps it out of the public surface inventory — the Python +reference only exposes `validate_url` at this module level. + +## Signature + +```ruby +def _resolver +``` + +## Source + +[`lib/signalwire/utils/url_validator.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/url_validator.rb) + +Line 48. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/resolver__2.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/resolver__2.mdx new file mode 100644 index 0000000000..cb7ede40b2 --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/resolver__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/ruby/signal-wire/utils/url-validator/resolver__2" +title: "_resolver=" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::UrlValidator._resolver=" + parent: "SignalWire::Utils::UrlValidator" + module: "SignalWire.Utils.UrlValidator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/url_validator.rb" + visibility: "public" +--- +# `_resolver=` + +## Signature + +```ruby +def _resolver=(value) +``` + +## Parameters + + + +## Source + +[`lib/signalwire/utils/url_validator.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/url_validator.rb) + +Line 52. diff --git a/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/validate-url.mdx b/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/validate-url.mdx new file mode 100644 index 0000000000..4a8c40b00a --- /dev/null +++ b/fern/products/sdk-reference/ruby/signal-wire/utils/url-validator/validate-url.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/ruby/signal-wire/utils/url-validator/validate-url" +title: "validate_url" +sdk_label: "Ruby SDK" +icon: "ruby" +lustri: + auto_generated: true + kind: "method" + language: "ruby" + qualified_name: "SignalWire::Utils::UrlValidator.validate_url" + parent: "SignalWire::Utils::UrlValidator" + module: "SignalWire.Utils.UrlValidator" + source_url: "https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/url_validator.rb" + visibility: "public" +--- +# `validate_url` + +Validate that a URL is safe to fetch. + +## Signature + +```ruby +def validate_url(url, allow_private = false) +``` + +## Parameters + + + URL to validate + + + + when true, bypass the IP-blocklist check + + +## Returns + +`Boolean` — true if the URL is safe to fetch + +## Source + +[`lib/signalwire/utils/url_validator.rb`](https://github.com/signalwire/signalwire-ruby/blob/main/lib/signalwire/utils/url_validator.rb) + +Line 61. diff --git a/fern/products/sdk-reference/rust/_meta.json b/fern/products/sdk-reference/rust/_meta.json new file mode 100644 index 0000000000..81eff9a217 --- /dev/null +++ b/fern/products/sdk-reference/rust/_meta.json @@ -0,0 +1,10 @@ +{ + "language": "rust", + "sdk_name": "signalwire (Rust)", + "version": "1.1.2", + "source_repo": "https://github.com/signalwire/signalwire-rust", + "format": "mdx", + "platform": "fern", + "base_slug": "/reference/rust", + "item_count": 1605 +} \ No newline at end of file diff --git a/fern/products/sdk-reference/rust/index.mdx b/fern/products/sdk-reference/rust/index.mdx new file mode 100644 index 0000000000..f1d3bdabf5 --- /dev/null +++ b/fern/products/sdk-reference/rust/index.mdx @@ -0,0 +1,15 @@ +--- +title: "Rust SDK" +slug: "/reference/rust" +lustri: + auto_generated: true + language: "rust" + kind: "sdk" +--- +# Rust SDK Reference +Version: **1.1.2** + +## Modules + +- [`signalwire`](/reference/rust/signalwire) + diff --git a/fern/products/sdk-reference/rust/signalwire/add-skill-directory.mdx b/fern/products/sdk-reference/rust/signalwire/add-skill-directory.mdx new file mode 100644 index 0000000000..25cb4806e0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/add-skill-directory.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/add-skill-directory" +title: "add_skill_directory" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::add_skill_directory" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs" + visibility: "public" +--- +# `add_skill_directory` + +Add a directory to the global skill search path. + +Mirrors `signalwire.add_skill_directory(path)`. In Rust the +directory contents cannot be loaded at runtime — third-party +skills must call \[`skills::SkillRegistry::register_skill`] at +startup — but the registered path is recorded for introspection. + +**Errors:** + +Returns an error string if the directory does not exist or is not +a directory. + +## Signature + +```rust +fn add_skill_directory(path: &str) -> ?<(), ?> +``` + +## Parameters + + + +## Returns + +`?<(), ?>` + +## Source + +[`src/lib.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs) + +Line 52. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-function-include.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-function-include.mdx new file mode 100644 index 0000000000..368b99f9cf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-function-include.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-function-include" +title: "add_function_include" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_function_include" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_function_include` + +## Signature + +```rust +fn add_function_include(&mut self, include: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 860. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-hint.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-hint.mdx new file mode 100644 index 0000000000..095acc9dc0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-hint.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-hint" +title: "add_hint" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_hint" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_hint` + +## Signature + +```rust +fn add_hint(&mut self, hint: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 621. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-hints.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-hints.mdx new file mode 100644 index 0000000000..e659d80fc0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-hints" +title: "add_hints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_hints" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_hints` + +## Signature + +```rust +fn add_hints(&mut self, hints: ?<&str>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 626. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-internal-filler-for.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-internal-filler-for.mdx new file mode 100644 index 0000000000..c8fe833564 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-internal-filler-for.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-internal-filler-for" +title: "add_internal_filler_for" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_internal_filler_for" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_internal_filler_for` + +Add internal fillers for a single internal function and language. + +See \[`Self::set_internal_fillers_map`] for the complete list of +supported `function_name` values +(\[`Self::SUPPORTED_INTERNAL_FILLER_NAMES`]) and what fillers do. +Names outside the supported set log a warning. + +## Signature + +```rust +fn add_internal_filler_for( + &mut self, + function_name: &str, + language_code: &str, + fillers: ? +) -> &mut Self +``` + +## Parameters + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 833. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-internal-filler.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-internal-filler.mdx new file mode 100644 index 0000000000..8410017a29 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-internal-filler.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-internal-filler" +title: "add_internal_filler" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_internal_filler" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_internal_filler` + +## Signature + +```rust +fn add_internal_filler(&mut self, filler: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 822. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-language.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-language.mdx new file mode 100644 index 0000000000..b9501ba628 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-language.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-language" +title: "add_language" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_language" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_language` + +## Signature + +```rust +fn add_language(&mut self, name: &str, code: &str, voice: &str) -> &mut Self +``` + +## Parameters + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 638. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-pattern-hint.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-pattern-hint.mdx new file mode 100644 index 0000000000..313baedea9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-pattern-hint.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-pattern-hint" +title: "add_pattern_hint" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_pattern_hint" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_pattern_hint` + +## Signature + +```rust +fn add_pattern_hint(&mut self, pattern: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 633. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-post-ai-verb.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-post-ai-verb.mdx new file mode 100644 index 0000000000..ab8f07aec2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-post-ai-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-post-ai-verb" +title: "add_post_ai_verb" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_post_ai_verb" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_post_ai_verb` + +## Signature + +```rust +fn add_post_ai_verb(&mut self, verb: &str, config: ?) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 898. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-post-answer-verb.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-post-answer-verb.mdx new file mode 100644 index 0000000000..6f1eb9e4bb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-post-answer-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-post-answer-verb" +title: "add_post_answer_verb" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_post_answer_verb" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_post_answer_verb` + +## Signature + +```rust +fn add_post_answer_verb(&mut self, verb: &str, config: ?) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 893. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-pre-answer-verb.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..947f727595 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-pre-answer-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-pre-answer-verb" +title: "add_pre_answer_verb" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_pre_answer_verb" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_pre_answer_verb` + +## Signature + +```rust +fn add_pre_answer_verb(&mut self, verb: &str, config: ?) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 888. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-pronunciation.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-pronunciation.mdx new file mode 100644 index 0000000000..f23a214649 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-pronunciation.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-pronunciation" +title: "add_pronunciation" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_pronunciation" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_pronunciation` + +## Signature + +```rust +fn add_pronunciation( + &mut self, + replace: &str, + with: &str, + ignore: &str +) -> &mut Self +``` + +## Parameters + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 700. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-skill.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-skill.mdx new file mode 100644 index 0000000000..1491596f8f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-skill.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-skill" +title: "add_skill" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_skill" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_skill` + +## Signature + +```rust +fn add_skill(&mut self, name: &str, params: ?) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 974. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-swaig-query-params.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-swaig-query-params.mdx new file mode 100644 index 0000000000..aec3470517 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/add-swaig-query-params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/add-swaig-query-params" +title: "add_swaig_query_params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::add_swaig_query_params" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `add_swaig_query_params` + +## Signature + +```rust +fn add_swaig_query_params(&mut self, params: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1081. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/build-ai-verb.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/build-ai-verb.mdx new file mode 100644 index 0000000000..a23b77d2db --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/build-ai-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/build-ai-verb" +title: "build_ai_verb" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::build_ai_verb" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `build_ai_verb` + +Build the AI verb configuration block. + +## Signature + +```rust +fn build_ai_verb(&self, headers: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1193. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..ad5d6cf48f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-post-ai-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/clear-post-ai-verbs" +title: "clear_post_ai_verbs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::clear_post_ai_verbs" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `clear_post_ai_verbs` + +## Signature + +```rust +fn clear_post_ai_verbs(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 913. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..84b09316c6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-post-answer-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/clear-post-answer-verbs" +title: "clear_post_answer_verbs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::clear_post_answer_verbs" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `clear_post_answer_verbs` + +## Signature + +```rust +fn clear_post_answer_verbs(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 908. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..7a770573b8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-pre-answer-verbs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/clear-pre-answer-verbs" +title: "clear_pre_answer_verbs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::clear_pre_answer_verbs" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `clear_pre_answer_verbs` + +## Signature + +```rust +fn clear_pre_answer_verbs(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 903. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-swaig-query-params.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..bd5355f971 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clear-swaig-query-params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/clear-swaig-query-params" +title: "clear_swaig_query_params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::clear_swaig_query_params" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `clear_swaig_query_params` + +## Signature + +```rust +fn clear_swaig_query_params(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1088. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clone-for-request.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clone-for-request.mdx new file mode 100644 index 0000000000..f62b8b3cb5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clone-for-request.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/clone-for-request" +title: "clone_for_request" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::clone_for_request" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `clone_for_request` + +Create a deep copy of this agent for per-request customisation. + +## Signature + +```rust +fn clone_for_request(&self) -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1415. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clone.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clone.mdx new file mode 100644 index 0000000000..4d0797e911 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::clone" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 165. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/create-tool-token.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/create-tool-token.mdx new file mode 100644 index 0000000000..a86ba51e83 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/create-tool-token.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/create-tool-token" +title: "create_tool_token" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::create_tool_token" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `create_tool_token` + +Mint a per-call SWAIG-function token via the agent's SessionManager. + +Python parity: `state_mixin.StateMixin._create_tool_token` — +delegates to `SessionManager::create_token` and returns `String::new()` +on failure (Python catches all exceptions and returns ""). + +## Signature + +```rust +fn create_tool_token(&self, tool_name: &str, call_id: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 337. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/define-contexts.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/define-contexts.mdx new file mode 100644 index 0000000000..919b761210 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/define-contexts.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/define-contexts" +title: "define_contexts" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::define_contexts" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `define_contexts` + +Return the ContextBuilder, creating it lazily on first access. + +The builder's tool-name supplier is set to a snapshot of the +currently registered tool names so \[`ContextBuilder::validate`] +can check for collisions with reserved native tool names +(`next_step`, `change_context`, `gather_submit`). Tools added to +the agent after the first `define_contexts()` call will not be +included in that snapshot — call \[`AgentBase::refresh_context_tools`] +to update it, or call `define_contexts` only after defining all +tools. + +## Signature + +```rust +fn define_contexts(&mut self) -> &mut ? +``` + +## Returns + +`&mut ?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 932. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/define-tools.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/define-tools.mdx new file mode 100644 index 0000000000..0c95b2add8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/define-tools.mdx @@ -0,0 +1,126 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/define-tools" +title: "define_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::define_tools" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `define_tools` + +Register a SWAIG tool (function) that the AI can invoke during a +call. + +# How this becomes a tool the model sees + +A SWAIG function is **exactly the same concept** as a "tool" in +native OpenAI / Anthropic tool calling. On every LLM turn, the +SDK renders each registered SWAIG function into the OpenAI tool +schema: + +```text +{ + "type": "function", + "function": { + "name": "your_name_here", + "description": "your description text", + "parameters": { ... your JSON schema ... } + } +} +``` + +That schema is sent to the model as part of the same API call +that produces the next assistant message. The model reads: + +- the function `description` to decide WHEN to call this tool +- each parameter `description` (inside `parameters`) to decide + HOW to fill in that argument from the user's utterance + +This means **descriptions are prompt engineering**, not developer +comments. A vague description is the #1 cause of "the model has +the right tool but doesn't call it" failures. + +# Bad vs good descriptions + +```text +BAD : description: "Lookup function" +GOOD: description: "Look up a customer's account details by " + + "account number. Use this BEFORE quoting any " + + "account-specific info (balance, plan, status). " + + "Do not use for general product questions." + +BAD : parameters: json!({"id": {"type": "string", "description": "the id"}}) +GOOD: parameters: json!({"account_number": {"type": "string", + "description": "The customer's 8-digit account number, " + "no dashes or spaces. Ask the user if they " + "don't provide it."}}) +``` + +# Tool count matters + +LLM tool selection accuracy degrades past ~7-8 +simultaneously-active tools per call. Use +\[`crate::contexts::Step::set_functions`] to partition tools +across steps so only the relevant subset is active at any moment. +Convenience: register multiple raw SWAIG function descriptors. +Wraps the inherited `register_swaig_function` for each. + +## Signature + +```rust +fn define_tools(&mut self, tool_defs: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Examples + + + + ```rust + { + "type": "function", + "function": { + "name": "your_name_here", + "description": "your description text", + "parameters": { ... your JSON schema ... } + } + } + ``` + + + + ```rust + BAD : description: "Lookup function" + GOOD: description: "Look up a customer's account details by " + + "account number. Use this BEFORE quoting any " + + "account-specific info (balance, plan, status). " + + "Do not use for general product questions." + + BAD : parameters: json!({"id": {"type": "string", "description": "the id"}}) + GOOD: parameters: json!({"account_number": {"type": "string", + "description": "The customer's 8-digit account number, " + "no dashes or spaces. Ask the user if they " + "don't provide it."}}) + ``` + + + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 610. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/deref-mut.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/deref-mut.mdx new file mode 100644 index 0000000000..b29305b7d0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/deref-mut.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/deref-mut" +title: "deref_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::deref_mut" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `deref_mut` + +## Signature + +```rust +fn deref_mut(&mut self) -> &mut ? +``` + +## Returns + +`&mut ?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 233. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/deref.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/deref.mdx new file mode 100644 index 0000000000..80b5637433 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::deref" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 227. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/enable-debug-events.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/enable-debug-events.mdx new file mode 100644 index 0000000000..b8ba17f460 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/enable-debug-events.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/enable-debug-events" +title: "enable_debug_events" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::enable_debug_events" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `enable_debug_events` + +## Signature + +```rust +fn enable_debug_events(&mut self, level: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 855. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/enable-sip-routing.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/enable-sip-routing.mdx new file mode 100644 index 0000000000..7b49d8d465 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/enable-sip-routing.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/enable-sip-routing" +title: "enable_sip_routing" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::enable_sip_routing" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `enable_sip_routing` + +## Signature + +```rust +fn enable_sip_routing(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1117. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..22bdcae7fc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-basic-auth-credentials.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/get-basic-auth-credentials" +title: "get_basic_auth_credentials" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::get_basic_auth_credentials" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `get_basic_auth_credentials` + +Return `(user, password)` for the agent's basic auth. + +## Signature + +```rust +fn get_basic_auth_credentials(&self) -> (?, ?) +``` + +## Returns + +`(?, ?)` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1623. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-contexts.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-contexts.mdx new file mode 100644 index 0000000000..3b2d4431e3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-contexts.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/get-contexts" +title: "get_contexts" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::get_contexts" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `get_contexts` + +Returns the contexts dictionary as a serialised `Value::Object`, +or `None` when no contexts have been defined yet. + +Mirrors Python's `PromptManager.get_contexts` which returns the +contexts dict or `None`. + +## Signature + +```rust +fn get_contexts(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 540. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-language-params.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-language-params.mdx new file mode 100644 index 0000000000..93c50c0366 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-language-params.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/get-language-params" +title: "get_language_params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::get_language_params" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `get_language_params` + +Read the per-language `params` dict for a previously-added +language. Mirrors Python's `AIConfigMixin.get_language_params`. + +Returns `Some(&Value)` (always a JSON object) when params were set, +`None` otherwise — including when the language code is unknown. +No error path. + +## Signature + +```rust +fn get_language_params(&self, code: &str) -> ?<&?> +``` + +## Parameters + + + +## Returns + +`?<&?>` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 686. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-post-prompt.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-post-prompt.mdx new file mode 100644 index 0000000000..a51ce6474e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/get-post-prompt" +title: "get_post_prompt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::get_post_prompt" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `get_post_prompt` + +Returns the post-prompt text whatever `set_post_prompt` stored, or +`None` when no post-prompt has been set. + +Mirrors Python's `PromptManager.get_post_prompt` / +`PromptMixin.get_post_prompt` — used by SWML rendering when a +post-prompt is configured. + +## Signature + +```rust +fn get_post_prompt(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 501. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-prompt.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-prompt.mdx new file mode 100644 index 0000000000..3bed30a175 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-prompt.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/get-prompt" +title: "get_prompt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::get_prompt" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `get_prompt` + +Return the prompt payload: POM array if enabled and populated, otherwise raw text. + +## Signature + +```rust +fn get_prompt(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 459. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-raw-prompt.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-raw-prompt.mdx new file mode 100644 index 0000000000..a992370dac --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/get-raw-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/get-raw-prompt" +title: "get_raw_prompt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::get_raw_prompt" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `get_raw_prompt` + +Returns the raw prompt text whatever `set_prompt_text` stored, or +`None` when no raw prompt has been set. Distinct from `get_prompt` +which may return the POM array when `use_pom` is `true`. + +Mirrors Python's `PromptManager.get_raw_prompt`. + +## Signature + +```rust +fn get_raw_prompt(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 514. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/handle-request.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/handle-request.mdx new file mode 100644 index 0000000000..58bacf43d8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/handle-request.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/handle-request" +title: "handle_request" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::handle_request" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `handle_request` + +Handle an HTTP request. Overrides the service handler with agent-specific +logic for SWML, SWAIG dispatch, and post-prompt callbacks. + +## Signature + +```rust +fn handle_request( + &self, + method: &str, + path: &str, + headers: &?, + body: &str +) -> (u16, ?, ?) +``` + +## Parameters + + + + + + + + + +## Returns + +`(u16, ?, ?)` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1302. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/has-skill.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/has-skill.mdx new file mode 100644 index 0000000000..540a832194 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/has-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/has-skill" +title: "has_skill" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::has_skill" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `has_skill` + +## Signature + +```rust +fn has_skill(&self, name: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1046. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/index.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/index.mdx new file mode 100644 index 0000000000..bdc75f685c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/index.mdx @@ -0,0 +1,272 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base" +title: "AgentBase" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase" + parent: "signalwire::agent::agent_base" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `AgentBase` + +Core agent that extends `Service` with AI-specific capabilities. + +Manages prompt configuration, tool registration, SWML rendering, +and HTTP request handling for AI agent endpoints. + +AgentBase implements `Deref` (Rust's idiomatic +equivalent of inheritance) so `Service` methods like `set_route`, +`define_tool`, `on_function_call`, etc. are usable on `AgentBase` +instances directly without needing forwarding wrappers. + +## Signature + +```rust +struct AgentBase { /* fields */ } +``` + +## Inheritance + +**Implements:** `Clone`, `Deref`, `DerefMut` + +## Constants + + + The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — \[`Self::set_internal_fillers_map`] and \[`Self::add_internal_filler_for`] warn if you pass an unknown name. Notable absences: `change_step`, `gather_submit`, and arbitrary user-defined SWAIG function names are NOT supported. + + +## Methods + + + + + + + + + + + + Add internal fillers for a single internal function and language. + + + + + + + + + + + + + + + + + + + + Build the AI verb configuration block. + + + + + + + + + + + + + + Create a deep copy of this agent for per-request customisation. + + + + Mint a per-call SWAIG-function token via the agent's SessionManager. + + + + Return the ContextBuilder, creating it lazily on first access. + + + + Register a SWAIG tool (function) that the AI can invoke during a call. + + + + + + + + + + + + Return `(user, password)` for the agent's basic auth. + + + + Returns the contexts dictionary as a serialised `Value::Object`, or `None` when no contexts have been defined yet. + + + + Read the per-language `params` dict for a previously-added language. Mirrors Python's `AIConfigMixin.get_language_params`. + + + + Returns the post-prompt text whatever `set_post_prompt` stored, or `None` when no post-prompt has been set. + + + + Return the prompt payload: POM array if enabled and populated, otherwise raw text. + + + + Returns the raw prompt text whatever `set_prompt_text` stored, or `None` when no raw prompt has been set. Distinct from `get_prompt` which may return the POM array when `use_pom` is `true`. + + + + Handle an HTTP request. Overrides the service handler with agent-specific logic for SWML, SWAIG dispatch, and post-prompt callbacks. + + + + + + + + Return the names of every registered SWAIG tool in insertion order. + + + + + + + + + + + + Read-only snapshot of the agent's POM as a typed \[`PromptObjectModel`]. + + + + Add a top-level POM section with an optional body and bullets. + + + + Add a subsection nested under an existing parent section. + + + + Append body text and/or bullets to an existing section. + + + + Check whether a POM section with the given title exists. + + + + Refresh the ContextBuilder's tool-name supplier with the current list of registered SWAIG tools. Call this if you define new tools after the first `define_contexts()` call and want the next `validate()` to see them. + + + + + + + + Build the complete SWML document for a request. + + + + Remove all contexts, returning the agent to a no-contexts state. This is a convenience wrapper around `define_contexts().reset()`. Use it in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + + + + Start a blocking HTTP server on the configured host:port. + + + + Access the underlying service. + + + + Access the underlying service mutably. + + + + + + + + + + + + Set internal fillers for native SWAIG functions (structured form). + + + + Set (or replace) the per-language `params` dict on an already-added language. Mirrors Python's `AIConfigMixin.set_language_params` — engine-specific tuning (voice stability/similarity, model knobs, etc.) can be attached after the language entry was created. + + + + + + + + + + + + + + + + + + + + Sets the prompt as a list of POM section objects. Each section supports keys "title", "body", "bullets", "numbered", "numbered\_bullets", and "subsections". Switches the agent to POM mode. + + + + + + + + Set or clear the signing key after construction. Useful for tests and dynamic-config flows. Pass an empty string or `None`-equivalent to disable. + + + + + + Return the signing key resolved from `AgentOptions::signing_key` or the `SIGNALWIRE_SIGNING_KEY` environment variable. `None` means signature validation is disabled. + + + + + + Validate a per-call SWAIG-function token. Returns `false` when the function is not registered or when the SessionManager rejects the token. + + + +## Type Aliases + + + + + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 82. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/list-skills.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/list-skills.mdx new file mode 100644 index 0000000000..88f6e23160 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/list-skills.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/list-skills" +title: "list_skills" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::list_skills" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `list_skills` + +## Signature + +```rust +fn list_skills(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1042. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/list-tool-names.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/list-tool-names.mdx new file mode 100644 index 0000000000..4ccbe4523c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/list-tool-names.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/list-tool-names" +title: "list_tool_names" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::list_tool_names" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `list_tool_names` + +Return the names of every registered SWAIG tool in insertion order. + +## Signature + +```rust +fn list_tool_names(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 955. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/manual-set-proxy-url.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..8d121ac4bf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/manual-set-proxy-url.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/manual-set-proxy-url" +title: "manual_set_proxy_url" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::manual_set_proxy_url" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `manual_set_proxy_url` + +## Signature + +```rust +fn manual_set_proxy_url(&mut self, url: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1076. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/new.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/new.mdx new file mode 100644 index 0000000000..b8bf348271 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::new" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(options: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 239. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/on-debug-event.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/on-debug-event.mdx new file mode 100644 index 0000000000..9b2d2d1c98 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/on-debug-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/on-debug-event" +title: "on_debug_event" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::on_debug_event" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `on_debug_event` + +## Signature + +```rust +fn on_debug_event(&mut self, callback: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1103. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/on-summary.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/on-summary.mdx new file mode 100644 index 0000000000..254b087c99 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/on-summary.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/on-summary" +title: "on_summary" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::on_summary" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `on_summary` + +## Signature + +```rust +fn on_summary(&mut self, callback: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1093. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/pom.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/pom.mdx new file mode 100644 index 0000000000..368e18b8c6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/pom.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/pom" +title: "pom" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::pom" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `pom` + +Read-only snapshot of the agent's POM as a typed +\[`PromptObjectModel`]. + +Python parity: `agent.pom` instance attribute (agent\_base.py +line 209). Returns `None` when `use_pom` is `false` (mirroring +Python's `self.pom = None`); otherwise returns a freshly built +\[`PromptObjectModel`] populated from the agent's stored +section list. + +Returning a typed POM (rather than the raw `Vec`) lets +callers reach for `render_markdown` / `render_xml` / `to_json` +directly without re-implementing the renderers — matching +Python's `agent.pom.render_markdown()` ergonomics. + +## Signature + +```rust +fn pom(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 480. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-section.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-section.mdx new file mode 100644 index 0000000000..0c8749c3ee --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-section.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-section" +title: "prompt_add_section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::prompt_add_section" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `prompt_add_section` + +Add a top-level POM section with an optional body and bullets. + +## Signature + +```rust +fn prompt_add_section( + &mut self, + title: &str, + body: &str, + bullets: ?<&str> +) -> &mut Self +``` + +## Parameters + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 373. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-subsection.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-subsection.mdx new file mode 100644 index 0000000000..92dd1aa419 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-subsection.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-subsection" +title: "prompt_add_subsection" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::prompt_add_subsection" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `prompt_add_subsection` + +Add a subsection nested under an existing parent section. + +## Signature + +```rust +fn prompt_add_subsection( + &mut self, + parent_title: &str, + title: &str, + body: &str +) -> &mut Self +``` + +## Parameters + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 391. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-to-section.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-to-section.mdx new file mode 100644 index 0000000000..93cff2f2fb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-to-section.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/prompt-add-to-section" +title: "prompt_add_to_section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::prompt_add_to_section" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `prompt_add_to_section` + +Append body text and/or bullets to an existing section. + +## Signature + +```rust +fn prompt_add_to_section( + &mut self, + title: &str, + body: ?<&str>, + bullets: ?<&str> +) -> &mut Self +``` + +## Parameters + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 414. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-has-section.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-has-section.mdx new file mode 100644 index 0000000000..fca210f497 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/prompt-has-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/prompt-has-section" +title: "prompt_has_section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::prompt_has_section" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `prompt_has_section` + +Check whether a POM section with the given title exists. + +## Signature + +```rust +fn prompt_has_section(&self, title: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 449. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/refresh-context-tools.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/refresh-context-tools.mdx new file mode 100644 index 0000000000..c1332cead9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/refresh-context-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/refresh-context-tools" +title: "refresh_context_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::refresh_context_tools" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `refresh_context_tools` + +Refresh the ContextBuilder's tool-name supplier with the current +list of registered SWAIG tools. Call this if you define new tools +after the first `define_contexts()` call and want the next +`validate()` to see them. + +## Signature + +```rust +fn refresh_context_tools(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 946. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/register-sip-username.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/register-sip-username.mdx new file mode 100644 index 0000000000..19544d9ca4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/register-sip-username.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/register-sip-username" +title: "register_sip_username" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::register_sip_username" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `register_sip_username` + +## Signature + +```rust +fn register_sip_username(&mut self, username: &str, route: &str) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1122. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/remove-skill.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/remove-skill.mdx new file mode 100644 index 0000000000..c38c9eb605 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/remove-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/remove-skill" +title: "remove_skill" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::remove_skill" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `remove_skill` + +## Signature + +```rust +fn remove_skill(&mut self, name: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1037. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/render-swml.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/render-swml.mdx new file mode 100644 index 0000000000..6033358b1d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/render-swml.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/render-swml" +title: "render_swml" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::render_swml" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `render_swml` + +Build the complete SWML document for a request. + +Phases: + +1. Pre-answer verbs +2. Answer verb (if auto\_answer) +3. Record call verb (if record\_call) +4. Post-answer verbs +5. AI verb (via build\_ai\_verb) +6. Post-AI verbs + +## Signature + +```rust +fn render_swml(&self, headers: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1143. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/reset-contexts.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/reset-contexts.mdx new file mode 100644 index 0000000000..716deb681b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/reset-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/reset-contexts" +title: "reset_contexts" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::reset_contexts" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `reset_contexts` + +Remove all contexts, returning the agent to a no-contexts state. +This is a convenience wrapper around `define_contexts().reset()`. +Use it in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```rust +fn reset_contexts(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 963. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/run.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/run.mdx new file mode 100644 index 0000000000..632d1c2363 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/run.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/run" +title: "run" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::run" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `run` + +Start a blocking HTTP server on the configured host:port. + +## Signature + +```rust +fn run(&self) +``` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1629. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/service-mut.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/service-mut.mdx new file mode 100644 index 0000000000..1cb074feff --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/service-mut.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/service-mut" +title: "service_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::service_mut" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `service_mut` + +Access the underlying service mutably. + +## Signature + +```rust +fn service_mut(&mut self) -> &mut ? +``` + +## Returns + +`&mut ?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 313. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/service.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/service.mdx new file mode 100644 index 0000000000..d56f3f27fc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/service.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/service" +title: "service" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::service" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `service` + +Access the underlying service. + +## Signature + +```rust +fn service(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 308. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..6dde12ef8e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-dynamic-config-callback.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-dynamic-config-callback" +title: "set_dynamic_config_callback" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_dynamic_config_callback" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_dynamic_config_callback` + +## Signature + +```rust +fn set_dynamic_config_callback( + &mut self, + callback: ? +) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1054. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-function-includes.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-function-includes.mdx new file mode 100644 index 0000000000..3d20862e1c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-function-includes.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-function-includes" +title: "set_function_includes" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_function_includes" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_function_includes` + +## Signature + +```rust +fn set_function_includes(&mut self, includes: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 865. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-global-data.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-global-data.mdx new file mode 100644 index 0000000000..d81f9c3380 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-global-data" +title: "set_global_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_global_data" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_global_data` + +## Signature + +```rust +fn set_global_data(&mut self, data: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 733. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-internal-fillers-map.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-internal-fillers-map.mdx new file mode 100644 index 0000000000..9802200186 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-internal-fillers-map.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-internal-fillers-map" +title: "set_internal_fillers_map" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_internal_fillers_map" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_internal_fillers_map` + +Set internal fillers for native SWAIG functions (structured form). + +Internal fillers are short phrases the AI agent speaks (via TTS) +while an internal/native function is running, so the caller +doesn't hear dead air during transitions or background work. + +Supported function names (match the SWAIGInternalFiller schema): +`hangup`, `check_time`, `wait_for_user`, `wait_seconds`, +`adjust_response_latency`, `next_step`, `change_context`, +`get_visual_input`, `get_ideal_strategy`. See +\[`Self::SUPPORTED_INTERNAL_FILLER_NAMES`]. + +Notably NOT supported: `change_step`, `gather_submit`, or +arbitrary user-defined SWAIG function names. The runtime only +honors fillers for the names listed above; everything else is +silently ignored at the SWML level. This method warns at +registration time if you pass an unknown name so you catch the +typo early. + +## Signature + +```rust +fn set_internal_fillers_map(&mut self, fillers: ?>>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 799. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-internal-fillers.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-internal-fillers.mdx new file mode 100644 index 0000000000..98059f4312 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-internal-fillers.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-internal-fillers" +title: "set_internal_fillers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_internal_fillers" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_internal_fillers` + +## Signature + +```rust +fn set_internal_fillers(&mut self, fillers: ?<&str>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 776. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-language-params.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-language-params.mdx new file mode 100644 index 0000000000..00ab818671 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-language-params.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-language-params" +title: "set_language_params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_language_params" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_language_params` + +Set (or replace) the per-language `params` dict on an already-added +language. Mirrors Python's `AIConfigMixin.set_language_params` — +engine-specific tuning (voice stability/similarity, model knobs, +etc.) can be attached after the language entry was created. + +Behavior, matching Python: + +- If `params` is a non-empty JSON object, store it under the + `params` key on the matching language entry (replacing any + prior value). +- If `params` is an empty object (or any non-object value), + remove the `params` key (treated as unset). +- If no language with the given code exists, this is a no-op. +- Returns `&mut Self` for chaining. + +Python parity: the per-language params are emitted as the language +object's `params` key in SWML and use snake\_case wire shape. + +## Signature + +```rust +fn set_language_params(&mut self, code: &str, params: ?) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 660. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-languages.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-languages.mdx new file mode 100644 index 0000000000..432abb79d7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-languages.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-languages" +title: "set_languages" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_languages" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_languages` + +## Signature + +```rust +fn set_languages(&mut self, languages: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 695. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-native-functions.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-native-functions.mdx new file mode 100644 index 0000000000..270142518a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-native-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-native-functions" +title: "set_native_functions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_native_functions" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_native_functions` + +## Signature + +```rust +fn set_native_functions(&mut self, functions: ?<&str>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 749. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-param.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-param.mdx new file mode 100644 index 0000000000..9b8f5e5c50 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-param.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-param" +title: "set_param" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_param" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_param` + +## Signature + +```rust +fn set_param(&mut self, key: &str, value: ?) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 721. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-params.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-params.mdx new file mode 100644 index 0000000000..f153766fb7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-params" +title: "set_params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_params" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_params` + +## Signature + +```rust +fn set_params(&mut self, params: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 726. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..95e06e6e05 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt-llm-params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt-llm-params" +title: "set_post_prompt_llm_params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_post_prompt_llm_params" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_post_prompt_llm_params` + +## Signature + +```rust +fn set_post_prompt_llm_params(&mut self, params: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 877. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt-url.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt-url.mdx new file mode 100644 index 0000000000..c6e970ef6a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt-url.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt-url" +title: "set_post_prompt_url" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_post_prompt_url" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_post_prompt_url` + +## Signature + +```rust +fn set_post_prompt_url(&mut self, url: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1071. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt.mdx new file mode 100644 index 0000000000..6e0824f292 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-post-prompt" +title: "set_post_prompt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_post_prompt" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_post_prompt` + +## Signature + +```rust +fn set_post_prompt(&mut self, text: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 367. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-llm-params.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..44d187a416 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-llm-params.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-llm-params" +title: "set_prompt_llm_params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_prompt_llm_params" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_prompt_llm_params` + +## Signature + +```rust +fn set_prompt_llm_params(&mut self, params: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 870. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-pom.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-pom.mdx new file mode 100644 index 0000000000..d012dfd32b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-pom.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-pom" +title: "set_prompt_pom" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_prompt_pom" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_prompt_pom` + +Sets the prompt as a list of POM section objects. Each section +supports keys "title", "body", "bullets", "numbered", +"numbered\_bullets", and "subsections". Switches the agent to POM +mode. + +Mirrors Python's `PromptManager.set_prompt_pom` — accepts a list +of section dicts and stores them in `pom_sections`. + +## Signature + +```rust +fn set_prompt_pom(&mut self, pom: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 529. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-text.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-text.mdx new file mode 100644 index 0000000000..ee1a33513f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-text.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-prompt-text" +title: "set_prompt_text" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_prompt_text" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_prompt_text` + +## Signature + +```rust +fn set_prompt_text(&mut self, text: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 362. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-pronunciations.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-pronunciations.mdx new file mode 100644 index 0000000000..5209f1a542 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-pronunciations.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-pronunciations" +title: "set_pronunciations" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_pronunciations" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_pronunciations` + +## Signature + +```rust +fn set_pronunciations(&mut self, pronunciations: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 716. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-signing-key.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-signing-key.mdx new file mode 100644 index 0000000000..30037b9ef6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-signing-key.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-signing-key" +title: "set_signing_key" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_signing_key" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_signing_key` + +Set or clear the signing key after construction. Useful for +tests and dynamic-config flows. Pass an empty string or +`None`-equivalent to disable. + +## Signature + +```rust +fn set_signing_key(&mut self, key: ?<&str>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 327. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-webhook-url.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-webhook-url.mdx new file mode 100644 index 0000000000..4742ebcf6c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/set-webhook-url.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/set-webhook-url" +title: "set_webhook_url" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::set_webhook_url" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `set_webhook_url` + +## Signature + +```rust +fn set_webhook_url(&mut self, url: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1066. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/signing-key.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/signing-key.mdx new file mode 100644 index 0000000000..83c05fa0f7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/signing-key.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/signing-key" +title: "signing_key" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::signing_key" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `signing_key` + +Return the signing key resolved from `AgentOptions::signing_key` +or the `SIGNALWIRE_SIGNING_KEY` environment variable. `None` +means signature validation is disabled. + +## Signature + +```rust +fn signing_key(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 320. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/target.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/target.mdx new file mode 100644 index 0000000000..b4fb27f88b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::agent::agent_base::AgentBase" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 226. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/update-global-data.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/update-global-data.mdx new file mode 100644 index 0000000000..a43f51dc98 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/update-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/update-global-data" +title: "update_global_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::update_global_data" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `update_global_data` + +## Signature + +```rust +fn update_global_data(&mut self, data: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 740. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/validate-tool-token.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/validate-tool-token.mdx new file mode 100644 index 0000000000..7a961b53cd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-base/validate-tool-token.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-base/validate-tool-token" +title: "validate_tool_token" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentBase::validate_tool_token" + parent: "signalwire::agent::agent_base::AgentBase" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `validate_tool_token` + +Validate a per-call SWAIG-function token. Returns `false` when the +function is not registered or when the SessionManager rejects the +token. + +Python parity: `state_mixin.StateMixin.validate_tool_token` — +rejects unknown function names up-front. Rust's +`SessionManager::validate_token` returns `bool` (no panics on bad +input — see security/session\_manager.rs), so no try/catch is +required for parity. + +## Signature + +```rust +fn validate_tool_token( + &self, + function_name: &str, + token: &str, + call_id: &str +) -> bool +``` + +## Parameters + + + + + + + +## Returns + +`bool` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 350. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-options/index.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-options/index.mdx new file mode 100644 index 0000000000..cbc31f588a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-options/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-options" +title: "AgentOptions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentOptions" + parent: "signalwire::agent::agent_base" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `AgentOptions` + +Options for constructing an `AgentBase`. + +## Signature + +```rust +struct AgentOptions { /* fields */ } +``` + +## Properties + + + + + + + + + + + + + + + + + + + SignalWire Signing Key used to validate the `X-SignalWire-Signature` header on incoming POST webhooks (`POST /`, `POST /swaig`, `POST /post_prompt`). When `None`, the agent falls back to the `SIGNALWIRE_SIGNING_KEY` environment variable. When neither is set, the agent logs a prominent warning at startup and accepts unsigned requests — see Python parity (`webhook_validator.py`, reference at `signalwire-python/signalwire/signalwire/core/security/`). + + + + +## Methods + + + + + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 19. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-options/new.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-options/new.mdx new file mode 100644 index 0000000000..68f06c0e23 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/agent-options/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base/agent-options/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::agent::agent_base::AgentOptions::new" + parent: "signalwire::agent::agent_base::AgentOptions" + module: "agent.agent_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(name: &str) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 42. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/agent-base/index.mdx b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/index.mdx new file mode 100644 index 0000000000..41f0b62f20 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/agent-base/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/agent/agent-base" +title: "agent_base" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::agent::agent_base" + parent: "signalwire::agent" + module: "agent" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs" + visibility: "public" +--- +# `agent_base` + +## Classes + + + + Core agent that extends `Service` with AI-specific capabilities. + + + + Options for constructing an `AgentBase`. + + + +## Source + +[`src/agent/agent_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/agent_base.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/agent/index.mdx b/fern/products/sdk-reference/rust/signalwire/agent/index.mdx new file mode 100644 index 0000000000..71102819be --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/agent/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/rust/signalwire/agent" +title: "agent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::agent" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/agent/mod.rs" + visibility: "public" +--- +# `agent` + +## Modules + + + + + +## Source + +[`src/agent/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/agent/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/add-context.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/add-context.mdx new file mode 100644 index 0000000000..78fa22559a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/add-context.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/add-context" +title: "add_context" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::add_context" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `add_context` + +## Signature + +```rust +fn add_context(&mut self, name: &str) -> &mut ? +``` + +## Parameters + + + +## Returns + +`&mut ?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 650. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/attach-tool-name-supplier.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/attach-tool-name-supplier.mdx new file mode 100644 index 0000000000..ec9012b0f3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/attach-tool-name-supplier.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/attach-tool-name-supplier" +title: "attach_tool_name_supplier" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::attach_tool_name_supplier" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `attach_tool_name_supplier` + +Attach a closure that returns registered SWAIG tool names so +\[`Self::validate`] can check for collisions with +\[`RESERVED_NATIVE_TOOL_NAMES`]. + +## Signature + +```rust +fn attach_tool_name_supplier( + &mut self, + supplier: F +) -> &mut Self where F: ?() -> ? + ? + ? + 'static +``` + +## Type Parameters + + + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 633. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/clone.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/clone.mdx new file mode 100644 index 0000000000..4e5030c8fd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::clone" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 596. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/default.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/default.mdx new file mode 100644 index 0000000000..176faac5ea --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/default.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/default" +title: "default" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::default" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `default` + +## Signature + +```rust +fn default() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 863. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/fmt.mdx new file mode 100644 index 0000000000..4e99e985e4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::fmt" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 609. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/get-context-mut.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/get-context-mut.mdx new file mode 100644 index 0000000000..49ba8b2c29 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/get-context-mut.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/get-context-mut" +title: "get_context_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::get_context_mut" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `get_context_mut` + +## Signature + +```rust +fn get_context_mut(&mut self, name: &str) -> ?<&mut ?> +``` + +## Parameters + + + +## Returns + +`?<&mut ?>` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 673. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/get-context.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/get-context.mdx new file mode 100644 index 0000000000..36499996f5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/get-context.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/get-context" +title: "get_context" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::get_context" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `get_context` + +## Signature + +```rust +fn get_context(&self, name: &str) -> ?<&?> +``` + +## Parameters + + + +## Returns + +`?<&?>` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 669. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/has-contexts.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/has-contexts.mdx new file mode 100644 index 0000000000..d107463706 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/has-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/has-contexts" +title: "has_contexts" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::has_contexts" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `has_contexts` + +## Signature + +```rust +fn has_contexts(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 677. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/index.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/index.mdx new file mode 100644 index 0000000000..d9ca47adb4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/index.mdx @@ -0,0 +1,96 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder" +title: "ContextBuilder" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder" + parent: "signalwire::contexts::context_builder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `ContextBuilder` + +Builder for multi-step, multi-context AI agent workflows. + +A ContextBuilder owns one or more \[`Context`]s; each Context owns an +ordered list of \[`Step`]s. Only one context and one step is active at +a time. Per chat turn, the runtime injects the current step's +instructions as a system message, then asks the LLM for a response. + +# Native tools auto-injected by the runtime + +When a step (or its enclosing context) declares valid\_steps or +valid\_contexts, the runtime auto-injects two native tools so the +model can navigate the flow: + +- `next_step(step: enum)` — present when valid\_steps is set +- `change_context(context: enum)` — present when valid\_contexts is set + +A third native tool — `gather_submit` — is injected during +gather\_info questioning. These three names are reserved: see +\[`RESERVED_NATIVE_TOOL_NAMES`]. \[`ContextBuilder::validate`] rejects +any agent that defines a SWAIG tool with one of these names. + +# Function whitelisting (\[`Step::set_functions`]) + +Each step may declare a functions whitelist. The whitelist is applied +in-memory at the start of each LLM turn. CRITICALLY: if a step does +NOT declare a functions field, it INHERITS the previous step's +active set. See \[`Step::set_functions`] for details and examples. + +## Signature + +```rust +struct ContextBuilder { /* fields */ } +``` + +## Inheritance + +**Implements:** `Clone`, `Debug`, `Default` + +## Methods + + + + + + Attach a closure that returns registered SWAIG tool names so \[`Self::validate`] can check for collisions with \[`RESERVED_NATIVE_TOOL_NAMES`]. + + + + + + + + + + + + + + + + + + Remove all contexts, returning the builder to its initial state. Use this in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + + + + Serialise all contexts in order. Validates before converting. + + + + Validate the contexts configuration. Returns `Ok(())` if valid, `Err(errors)` with a list of error messages. + + + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 597. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/new.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/new.mdx new file mode 100644 index 0000000000..4e873ba04a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/new.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::new" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 622. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/reset.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/reset.mdx new file mode 100644 index 0000000000..348cc7bc64 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/reset.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/reset" +title: "reset" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::reset" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `reset` + +Remove all contexts, returning the builder to its initial state. +Use this in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```rust +fn reset(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 644. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/to-value.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/to-value.mdx new file mode 100644 index 0000000000..e73482429f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/to-value.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/to-value" +title: "to_value" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::to_value" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `to_value` + +Serialise all contexts in order. Validates before converting. + +## Signature + +```rust +fn to_value(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 847. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/validate.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/validate.mdx new file mode 100644 index 0000000000..941073b4f0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context-builder/validate.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context-builder/validate" +title: "validate" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::ContextBuilder::validate" + parent: "signalwire::contexts::context_builder::ContextBuilder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `validate` + +Validate the contexts configuration. +Returns `Ok(())` if valid, `Err(errors)` with a list of error messages. + +## Signature + +```rust +fn validate(&self) -> ?<(), ?> +``` + +## Returns + +`?<(), ?>` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 683. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/add-step.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/add-step.mdx new file mode 100644 index 0000000000..4fc1a32ba5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/add-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/add-step" +title: "add_step" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::add_step" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `add_step` + +## Signature + +```rust +fn add_step(&mut self, name: &str) -> &mut ? +``` + +## Parameters + + + +## Returns + +`&mut ?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 441. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/clone.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/clone.mdx new file mode 100644 index 0000000000..0e86eff96d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::clone" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 407. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/fmt.mdx new file mode 100644 index 0000000000..d04b66d0b6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::fmt" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 407. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/get-step-mut.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/get-step-mut.mdx new file mode 100644 index 0000000000..f791c66f3f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/get-step-mut.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/get-step-mut" +title: "get_step_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::get_step_mut" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `get_step_mut` + +## Signature + +```rust +fn get_step_mut(&mut self, name: &str) -> ?<&mut ?> +``` + +## Parameters + + + +## Returns + +`?<&mut ?>` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 465. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/get-step.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/get-step.mdx new file mode 100644 index 0000000000..a771e6cd4d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/get-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/get-step" +title: "get_step" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::get_step" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `get_step` + +## Signature + +```rust +fn get_step(&self, name: &str) -> ?<&?> +``` + +## Parameters + + + +## Returns + +`?<&?>` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 461. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/index.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/index.mdx new file mode 100644 index 0000000000..6ea1b261f3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context" +title: "Context" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context" + parent: "signalwire::contexts::context_builder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `Context` + +A named context containing an ordered set of steps. + +## Signature + +```rust +struct Context { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + Set which step the context starts on when entered. + + + + + + + + + + + + + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 408. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/move-step.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/move-step.mdx new file mode 100644 index 0000000000..3fd19686ea --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/move-step.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/move-step" +title: "move_step" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::move_step" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `move_step` + +## Signature + +```rust +fn move_step(&mut self, name: &str, position: usize) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 476. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/name.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/name.mdx new file mode 100644 index 0000000000..e5bb317571 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::name" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 435. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/new.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/new.mdx new file mode 100644 index 0000000000..87bd487af3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::new" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(name: &str) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 422. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/remove-step.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/remove-step.mdx new file mode 100644 index 0000000000..7cbf1d2511 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/remove-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/remove-step" +title: "remove_step" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::remove_step" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `remove_step` + +## Signature + +```rust +fn remove_step(&mut self, name: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 469. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-enter-fillers.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-enter-fillers.mdx new file mode 100644 index 0000000000..c7342c1390 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-enter-fillers.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/set-enter-fillers" +title: "set_enter_fillers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::set_enter_fillers" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_enter_fillers` + +## Signature + +```rust +fn set_enter_fillers(&mut self, fillers: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 512. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-exit-fillers.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-exit-fillers.mdx new file mode 100644 index 0000000000..0b50214b23 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-exit-fillers.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/set-exit-fillers" +title: "set_exit_fillers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::set_exit_fillers" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_exit_fillers` + +## Signature + +```rust +fn set_exit_fillers(&mut self, fillers: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 517. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-initial-step.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-initial-step.mdx new file mode 100644 index 0000000000..adb95d3b75 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-initial-step.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/set-initial-step" +title: "set_initial_step" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::set_initial_step" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_initial_step` + +Set which step the context starts on when entered. + +By default, a context starts on its first step (index 0). Use +this to skip a preamble step on re-entry via `change_context`. + +## Signature + +```rust +fn set_initial_step(&mut self, step_name: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 493. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-prompt-text.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-prompt-text.mdx new file mode 100644 index 0000000000..3f91ad334e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-prompt-text.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/set-prompt-text" +title: "set_prompt_text" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::set_prompt_text" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_prompt_text` + +## Signature + +```rust +fn set_prompt_text(&mut self, prompt: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 500. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-system-prompt.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-system-prompt.mdx new file mode 100644 index 0000000000..620c3264e2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/set-system-prompt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/set-system-prompt" +title: "set_system_prompt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::set_system_prompt" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_system_prompt` + +## Signature + +```rust +fn set_system_prompt(&mut self, system_prompt: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 505. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/step-order.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/step-order.mdx new file mode 100644 index 0000000000..85b91327f2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/step-order.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/step-order" +title: "step_order" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::step_order" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `step_order` + +## Signature + +```rust +fn step_order(&self) -> &[?] +``` + +## Returns + +`&[?]` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 528. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/steps.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/steps.mdx new file mode 100644 index 0000000000..44e225cbd9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/steps.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/steps" +title: "steps" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::steps" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `steps` + +## Signature + +```rust +fn steps(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 524. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/to-value.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/to-value.mdx new file mode 100644 index 0000000000..526edb318d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/context/to-value.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/context/to-value" +title: "to_value" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Context::to_value" + parent: "signalwire::contexts::context_builder::Context" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `to_value` + +## Signature + +```rust +fn to_value(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 534. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/create-simple-context.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/create-simple-context.mdx new file mode 100644 index 0000000000..185ca42464 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/create-simple-context.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/create-simple-context" +title: "create_simple_context" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::create_simple_context" + parent: "signalwire::contexts::context_builder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `create_simple_context` + +Create a builder pre-populated with a single named context. + +## Signature + +```rust +fn create_simple_context(name: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 871. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/add-question.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/add-question.mdx new file mode 100644 index 0000000000..d7e3c0e1a4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/add-question.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-info/add-question" +title: "add_question" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherInfo::add_question" + parent: "signalwire::contexts::context_builder::GatherInfo" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `add_question` + +## Signature + +```rust +fn add_question( + &mut self, + key: &str, + question: &str, + question_type: &str, + confirm: bool, + prompt: ?<&str>, + functions: ?> +) -> &mut Self +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 107. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/clone.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/clone.mdx new file mode 100644 index 0000000000..5aea47aa1b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-info/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherInfo::clone" + parent: "signalwire::contexts::context_builder::GatherInfo" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 85. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/completion-action.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/completion-action.mdx new file mode 100644 index 0000000000..48a640bca1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/completion-action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-info/completion-action" +title: "completion_action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherInfo::completion_action" + parent: "signalwire::contexts::context_builder::GatherInfo" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `completion_action` + +## Signature + +```rust +fn completion_action(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 131. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/fmt.mdx new file mode 100644 index 0000000000..715549565a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-info/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherInfo::fmt" + parent: "signalwire::contexts::context_builder::GatherInfo" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 85. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/index.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/index.mdx new file mode 100644 index 0000000000..703ef641eb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-info" +title: "GatherInfo" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherInfo" + parent: "signalwire::contexts::context_builder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `GatherInfo` + +Configuration for structured data gathering within a step. + +## Signature + +```rust +struct GatherInfo { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 86. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/new.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/new.mdx new file mode 100644 index 0000000000..52568859fa --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-info/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherInfo::new" + parent: "signalwire::contexts::context_builder::GatherInfo" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(output_key: ?<&str>, completion_action: ?<&str>, prompt: ?<&str>) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 94. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/questions.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/questions.mdx new file mode 100644 index 0000000000..9dbcb7a819 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/questions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-info/questions" +title: "questions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherInfo::questions" + parent: "signalwire::contexts::context_builder::GatherInfo" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `questions` + +## Signature + +```rust +fn questions(&self) -> &[?] +``` + +## Returns + +`&[?]` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 127. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/to-value.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/to-value.mdx new file mode 100644 index 0000000000..83034d53a9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-info/to-value.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-info/to-value" +title: "to_value" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherInfo::to_value" + parent: "signalwire::contexts::context_builder::GatherInfo" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `to_value` + +## Signature + +```rust +fn to_value(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 135. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/clone.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/clone.mdx new file mode 100644 index 0000000000..ed3fb1828c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-question/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherQuestion::clone" + parent: "signalwire::contexts::context_builder::GatherQuestion" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/fmt.mdx new file mode 100644 index 0000000000..8d33c728a6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-question/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherQuestion::fmt" + parent: "signalwire::contexts::context_builder::GatherQuestion" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/index.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/index.mdx new file mode 100644 index 0000000000..9b66761673 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-question" +title: "GatherQuestion" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherQuestion" + parent: "signalwire::contexts::context_builder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `GatherQuestion` + +A single question within a gather\_info block. + +## Signature + +```rust +struct GatherQuestion { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 26. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/key.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/key.mdx new file mode 100644 index 0000000000..0e8c5f57d7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-question/key" +title: "key" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherQuestion::key" + parent: "signalwire::contexts::context_builder::GatherQuestion" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `key` + +## Signature + +```rust +fn key(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 54. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/new.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/new.mdx new file mode 100644 index 0000000000..d8a668b00c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/new.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-question/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherQuestion::new" + parent: "signalwire::contexts::context_builder::GatherQuestion" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new( + key: &str, + question: &str, + question_type: &str, + confirm: bool, + prompt: ?<&str>, + functions: ?> +) -> Self +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 36. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/to-value.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/to-value.mdx new file mode 100644 index 0000000000..4e4668400e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/gather-question/to-value.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/gather-question/to-value" +title: "to_value" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::GatherQuestion::to_value" + parent: "signalwire::contexts::context_builder::GatherQuestion" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `to_value` + +## Signature + +```rust +fn to_value(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 58. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/index.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/index.mdx new file mode 100644 index 0000000000..2997a932ac --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder" +title: "context_builder" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::contexts::context_builder" + parent: "signalwire::contexts" + module: "contexts" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `context_builder` + +## Constants + + + Reserved tool names auto-injected by the runtime when contexts/steps are present. User-defined SWAIG tools must not collide with these names: \[`ContextBuilder::validate`] rejects any agent that registers a user tool sharing one of these names — the runtime would never call the user tool because the native one wins. + + +## Functions + + + + Create a builder pre-populated with a single named context. + + + +## Classes + + + + A named context containing an ordered set of steps. + + + + Builder for multi-step, multi-context AI agent workflows. + + + + Configuration for structured data gathering within a step. + + + + A single question within a gather\_info block. + + + + A single step within a context. + + + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/add-gather-question.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/add-gather-question.mdx new file mode 100644 index 0000000000..be9517ce94 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/add-gather-question.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/add-gather-question" +title: "add_gather_question" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::add_gather_question" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `add_gather_question` + +Add a question to this step's gather\_info. Initialises +gather\_info if needed. + +# Gather mode locks function access (IMPORTANT) + +While the model is asking gather questions, the runtime +forcibly deactivates ALL of the step's other functions. The +only callable tools during a gather question are: + +- `gather_submit` (the native answer-submission tool) +- Whatever names you pass in this question's `functions` + argument + +`next_step` and `change_context` are also filtered out — the +model cannot navigate away until the gather completes. This +is by design: it forces a tight ask → submit → next-question +loop. + +If a question needs to call out to a tool (e.g. validate an +email, geocode a ZIP), list that tool name in this question's +`functions` argument. Functions listed here are active ONLY +for this question. + +## Signature + +```rust +fn add_gather_question( + &mut self, + key: &str, + question: &str, + question_type: &str, + confirm: bool, + prompt: ?<&str>, + functions: ?> +) -> &mut Self +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 319. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/add-section.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/add-section.mdx new file mode 100644 index 0000000000..844c8f7343 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/add-section" +title: "add_section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::add_section" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `add_section` + +Add a POM section with title and body. + +## Signature + +```rust +fn add_section(&mut self, title: &str, body: &str) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 203. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/clone.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/clone.mdx new file mode 100644 index 0000000000..2e8d0d4038 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::clone" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 158. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/fmt.mdx new file mode 100644 index 0000000000..6044012197 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::fmt" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 158. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/gather-info.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/gather-info.mdx new file mode 100644 index 0000000000..0a1f6ccd2f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/gather-info.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/gather-info" +title: "gather_info" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::gather_info" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `gather_info` + +## Signature + +```rust +fn gather_info(&self) -> ?<&?> +``` + +## Returns + +`?<&?>` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 347. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/index.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/index.mdx new file mode 100644 index 0000000000..4f5713ae72 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/index.mdx @@ -0,0 +1,86 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step" +title: "Step" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step" + parent: "signalwire::contexts::context_builder" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `Step` + +A single step within a context. + +## Signature + +```rust +struct Step { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone` + +## Methods + + + + Add a question to this step's gather\_info. Initialises gather\_info if needed. + + + + Add a POM section with title and body. + + + + + + + + + + + + + + Mark this step as terminal for the step flow. + + + + Set which non-internal functions are callable while this step is active. + + + + Initialise gather\_info for this step. + + + + + + + + Set the step's prompt text directly. Mutually exclusive with POM sections. + + + + + + + + + + + + + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 159. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/name.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/name.mdx new file mode 100644 index 0000000000..05a5447991 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::name" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 188. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/new.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/new.mdx new file mode 100644 index 0000000000..92cd0dfede --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::new" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(name: &str) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 173. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-end.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-end.mdx new file mode 100644 index 0000000000..06f279158c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-end.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/set-end" +title: "set_end" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::set_end" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_end` + +Mark this step as terminal for the step flow. + +**IMPORTANT**: `end = true` does NOT end the conversation or +hang up the call. It exits step mode entirely after this step +executes — clearing the steps list, current step index, +valid\_steps, and valid\_contexts. The agent keeps running, but +operates only under the base system prompt and the context-level +prompt; no more step instructions are injected and no more +`next_step` tool is offered. + +To actually end the call, call a hangup tool or define a +hangup hook. + +## Signature + +```rust +fn set_end(&mut self, end: bool) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 276. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-functions.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-functions.mdx new file mode 100644 index 0000000000..2d1d656ea5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-functions.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/set-functions" +title: "set_functions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::set_functions" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_functions` + +Set which non-internal functions are callable while this step is +active. + +# Inheritance behavior (IMPORTANT) + +If you do NOT call this method, the step inherits whichever +function set was active on the previous step (or the previous +context's last step). The server-side runtime only resets the +active set when a step explicitly declares its `functions` field. +This is the most common source of bugs in multi-step agents: +forgetting `set_functions` on a later step lets the previous +step's tools leak through. Best practice is to call +`set_functions` explicitly on every step that should differ from +the previous one. + +Keep the per-step active set small: LLM tool selection accuracy +degrades noticeably past ~7-8 simultaneously-active tools per +call. Use per-step whitelisting to partition large tool +collections. + +Internal functions (e.g. `gather_submit`, hangup hook) are +ALWAYS protected and cannot be deactivated by this whitelist. The +native navigation tools `next_step` and `change_context` are +injected automatically when `set_valid_steps` / +`set_valid_contexts` is used; they are not affected by this list. + +## Signature + +```rust +fn set_functions(&mut self, functions: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 249. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-gather-info.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-gather-info.mdx new file mode 100644 index 0000000000..eb8588e3e6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-gather-info.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/set-gather-info" +title: "set_gather_info" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::set_gather_info" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_gather_info` + +Initialise gather\_info for this step. + +## Signature + +```rust +fn set_gather_info( + &mut self, + output_key: ?<&str>, + completion_action: ?<&str>, + prompt: ?<&str> +) -> &mut Self +``` + +## Parameters + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 287. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-skip-user-turn.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-skip-user-turn.mdx new file mode 100644 index 0000000000..ee1448d55b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-skip-user-turn.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/set-skip-user-turn" +title: "set_skip_user_turn" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::set_skip_user_turn" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_skip_user_turn` + +## Signature + +```rust +fn set_skip_user_turn(&mut self, skip: bool) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 281. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-step-criteria.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-step-criteria.mdx new file mode 100644 index 0000000000..4e56e583e7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-step-criteria.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/set-step-criteria" +title: "set_step_criteria" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::set_step_criteria" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_step_criteria` + +## Signature + +```rust +fn set_step_criteria(&mut self, criteria: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 212. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-text.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-text.mdx new file mode 100644 index 0000000000..4f028a6ec7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-text.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/set-text" +title: "set_text" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::set_text" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_text` + +Set the step's prompt text directly. Mutually exclusive with POM sections. + +## Signature + +```rust +fn set_text(&mut self, text: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 193. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-valid-contexts.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-valid-contexts.mdx new file mode 100644 index 0000000000..f436b4525b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-valid-contexts.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/set-valid-contexts" +title: "set_valid_contexts" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::set_valid_contexts" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_valid_contexts` + +## Signature + +```rust +fn set_valid_contexts(&mut self, contexts: ?<&str>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 259. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-valid-steps.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-valid-steps.mdx new file mode 100644 index 0000000000..6a07633e9a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/set-valid-steps.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/set-valid-steps" +title: "set_valid_steps" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::set_valid_steps" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `set_valid_steps` + +## Signature + +```rust +fn set_valid_steps(&mut self, steps: ?<&str>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 254. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/to-value.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/to-value.mdx new file mode 100644 index 0000000000..85403f835b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/to-value.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/to-value" +title: "to_value" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::to_value" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `to_value` + +## Signature + +```rust +fn to_value(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 371. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/valid-contexts.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/valid-contexts.mdx new file mode 100644 index 0000000000..f77f2c4943 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/valid-contexts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/valid-contexts" +title: "valid_contexts" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::valid_contexts" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `valid_contexts` + +## Signature + +```rust +fn valid_contexts(&self) -> ?<&[?]> +``` + +## Returns + +`?<&[?]>` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 343. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/valid-steps.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/valid-steps.mdx new file mode 100644 index 0000000000..77c73ccf19 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/context-builder/step/valid-steps.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/contexts/context-builder/step/valid-steps" +title: "valid_steps" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::contexts::context_builder::Step::valid_steps" + parent: "signalwire::contexts::context_builder::Step" + module: "contexts.context_builder" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs" + visibility: "public" +--- +# `valid_steps` + +## Signature + +```rust +fn valid_steps(&self) -> ?<&[?]> +``` + +## Returns + +`?<&[?]>` + +## Source + +[`src/contexts/context_builder.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/context_builder.rs) + +Line 339. diff --git a/fern/products/sdk-reference/rust/signalwire/contexts/index.mdx b/fern/products/sdk-reference/rust/signalwire/contexts/index.mdx new file mode 100644 index 0000000000..761653602e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/contexts/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/rust/signalwire/contexts" +title: "contexts" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::contexts" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/mod.rs" + visibility: "public" +--- +# `contexts` + +## Modules + + + + + +## Source + +[`src/contexts/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/contexts/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/core/index.mdx b/fern/products/sdk-reference/rust/signalwire/core/index.mdx new file mode 100644 index 0000000000..4774ec6757 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/core/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/rust/signalwire/core" +title: "core" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::core" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/core/mod.rs" + visibility: "public" +--- +# `core` + +## Modules + + + + + +## Source + +[`src/core/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/core/mod.rs) + +Line 5. diff --git a/fern/products/sdk-reference/rust/signalwire/core/logging-config/get-execution-mode.mdx b/fern/products/sdk-reference/rust/signalwire/core/logging-config/get-execution-mode.mdx new file mode 100644 index 0000000000..43431ec3f2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/core/logging-config/get-execution-mode.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/core/logging-config/get-execution-mode" +title: "get_execution_mode" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::core::logging_config::get_execution_mode" + parent: "signalwire::core::logging_config" + module: "core.logging_config" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/core/logging_config.rs" + visibility: "public" +--- +# `get_execution_mode` + +Detect the SDK's deployment environment based on well-known +environment variables. + +Returns one of `"cgi"`, `"lambda"`, `"google_cloud_function"`, +`"azure_function"`, or `"server"`. + +## Signature + +```rust +fn get_execution_mode() -> ? +``` + +## Returns + +`?` + +## Source + +[`src/core/logging_config.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/core/logging_config.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/core/logging-config/index.mdx b/fern/products/sdk-reference/rust/signalwire/core/logging-config/index.mdx new file mode 100644 index 0000000000..53d90a2568 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/core/logging-config/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/core/logging-config" +title: "logging_config" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::core::logging_config" + parent: "signalwire::core" + module: "core" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/core/logging_config.rs" + visibility: "public" +--- +# `logging_config` + +## Functions + + + + Detect the SDK's deployment environment based on well-known environment variables. + + + +## Source + +[`src/core/logging_config.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/core/logging_config.rs) + +Line 13. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/body.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/body.mdx new file mode 100644 index 0000000000..82a7fc2ef1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/body.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/body" +title: "body" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::body" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `body` + +Set body on the last webhook. + +## Signature + +```rust +fn body(&mut self, data: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 172. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/clone.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/clone.mdx new file mode 100644 index 0000000000..160a798f6b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::clone" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 8. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/create-expression-tool.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/create-expression-tool.mdx new file mode 100644 index 0000000000..e7101555b1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/create-expression-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/create-expression-tool" +title: "create_expression_tool" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::create_expression_tool" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `create_expression_tool` + +Build a complete SWAIG function definition with expressions only. + +## Signature + +```rust +fn create_expression_tool( + name: &str, + purpose: &str, + parameters: ?, + expressions: ? +) -> ? +``` + +## Parameters + + + + + + + + + +## Returns + +`?` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 307. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/create-simple-api-tool.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/create-simple-api-tool.mdx new file mode 100644 index 0000000000..a684294745 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/create-simple-api-tool.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/create-simple-api-tool" +title: "create_simple_api_tool" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::create_simple_api_tool" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `create_simple_api_tool` + +Build a complete SWAIG function definition with a single webhook. + +## Signature + +```rust +fn create_simple_api_tool( + name: &str, + purpose: &str, + parameters: ?, + method: &str, + url: &str, + output: ?, + headers: ? +) -> ? +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`?` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 276. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/description.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/description.mdx new file mode 100644 index 0000000000..5a7bc7b8d2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/description.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::description" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `description` + +Alias for \[`Self::purpose`]. Sets the LLM-facing tool +description. This string is read by the model to decide WHEN +to call this tool. See \[`Self::purpose`] for bad-vs-good +examples. + +## Signature + +```rust +fn description(&mut self, desc: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 67. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/error-keys.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/error-keys.mdx new file mode 100644 index 0000000000..601cd4780e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/error-keys.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/error-keys" +title: "error_keys" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::error_keys" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `error_keys` + +Set error\_keys on the last webhook. + +## Signature + +```rust +fn error_keys(&mut self, keys: ?<&str>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 211. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/expression.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/expression.mdx new file mode 100644 index 0000000000..5482519ec1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/expression.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/expression" +title: "expression" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::expression" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `expression` + +Add an expression rule. + +## Signature + +```rust +fn expression( + &mut self, + test_value: &str, + pattern: &str, + output: ?, + nomatch_output: ? +) -> &mut Self +``` + +## Parameters + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 113. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/fallback-output.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/fallback-output.mdx new file mode 100644 index 0000000000..a3107a373a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/fallback-output.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/fallback-output" +title: "fallback_output" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::fallback_output" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `fallback_output` + +Set global fallback output. + +## Signature + +```rust +fn fallback_output(&mut self, result: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 205. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/fmt.mdx new file mode 100644 index 0000000000..d82601f2ba --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::fmt" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 8. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/for-each.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/for-each.mdx new file mode 100644 index 0000000000..bcff1e3c4c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/for-each.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/for-each" +title: "for_each" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::for_each" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `for_each` + +Set foreach on the last webhook. + +## Signature + +```rust +fn for_each(&mut self, config: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 188. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/global-error-keys.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/global-error-keys.mdx new file mode 100644 index 0000000000..7753cb9cd4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/global-error-keys.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/global-error-keys" +title: "global_error_keys" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::global_error_keys" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `global_error_keys` + +Set global error\_keys. + +## Signature + +```rust +fn global_error_keys(&mut self, keys: ?<&str>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 219. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/index.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/index.mdx new file mode 100644 index 0000000000..9a816e95c4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/index.mdx @@ -0,0 +1,111 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map" +title: "DataMap" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap" + parent: "signalwire::datamap::datamap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `DataMap` + +Fluent builder for DataMap-based SWAIG function definitions. + +A DataMap tool defines its behaviour declaratively (expressions, webhooks) +instead of with a code handler. + +## Signature + +```rust +struct DataMap { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone` + +## Methods + + + + Set body on the last webhook. + + + + + + Build a complete SWAIG function definition with expressions only. + + + + Build a complete SWAIG function definition with a single webhook. + + + + Alias for \[`Self::purpose`]. Sets the LLM-facing tool description. This string is read by the model to decide WHEN to call this tool. See \[`Self::purpose`] for bad-vs-good examples. + + + + Set error\_keys on the last webhook. + + + + Add an expression rule. + + + + Set global fallback output. + + + + + + Set foreach on the last webhook. + + + + Set global error\_keys. + + + + + + Set output on the last webhook. + + + + Add a parameter definition — the `description` is **LLM-FACING**. + + + + Set params on the last webhook. + + + + Set the LLM-facing tool description (the "purpose"). **Prompt engineering, not developer documentation.** + + + + Serialise to a SWAIG function definition. + + + + Add a webhook definition. + + + + Set expressions on the last webhook. + + + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 9. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/new.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/new.mdx new file mode 100644 index 0000000000..994cf8e298 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::new" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(function_name: &str) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/output.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/output.mdx new file mode 100644 index 0000000000..ca9f940720 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/output.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/output" +title: "output" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::output" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `output` + +Set output on the last webhook. + +## Signature + +```rust +fn output(&mut self, result: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 196. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/parameter.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/parameter.mdx new file mode 100644 index 0000000000..0fc623b2b1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/parameter.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/parameter" +title: "parameter" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::parameter" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `parameter` + +Add a parameter definition — the `description` is **LLM-FACING**. + +Each parameter description is rendered into the OpenAI tool +schema under `parameters.properties..description` and +sent to the model. The model uses it to decide HOW to fill in +the argument from user speech. It is prompt engineering, not +developer FYI. + +# Bad vs good + +```text +BAD : .parameter("city", "string", "the city", ...) +GOOD: .parameter("city", "string", + "The name of the city to get weather for, e.g. " + "'San Francisco'. Ask the user if they did not " + "provide one. Include the state or country if the " + "city name is ambiguous.", ...) +``` + +## Signature + +```rust +fn parameter( + &mut self, + name: &str, + param_type: &str, + description: &str, + required: bool, + enum_values: ?<&str> +) -> &mut Self +``` + +## Parameters + + + + + + + + + + + +## Returns + +`&mut Self` + +## Examples + +```rust +BAD : .parameter("city", "string", "the city", ...) +GOOD: .parameter("city", "string", + "The name of the city to get weather for, e.g. " + "'San Francisco'. Ask the user if they did not " + "provide one. Include the state or country if the " + "city name is ambiguous.", ...) +``` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 89. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/params.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/params.mdx new file mode 100644 index 0000000000..b5f58792c1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/params.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::params" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `params` + +Set params on the last webhook. + +## Signature + +```rust +fn params(&mut self, data: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 180. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/purpose.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/purpose.mdx new file mode 100644 index 0000000000..b496fed75a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/purpose.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/purpose" +title: "purpose" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::purpose" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `purpose` + +Set the LLM-facing tool description (the "purpose"). **Prompt +engineering, not developer documentation.** + +The description string is rendered into the OpenAI tool schema +`description` field on every LLM turn. The model reads it to +decide WHEN to call this tool. A vague `purpose()` is the #1 +cause of "the model has the right tool but doesn't call it" +failures with data-map tools. + +# Bad vs good + +```text +BAD : .purpose("weather api") +GOOD: .purpose("Get the current weather conditions and forecast " + + "for a specific city. Use this whenever the user " + + "asks about weather, temperature, rain, or similar " + + "conditions in a named location.") +``` + +## Signature + +```rust +fn purpose(&mut self, desc: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Examples + +```rust +BAD : .purpose("weather api") +GOOD: .purpose("Get the current weather conditions and forecast " + + "for a specific city. Use this whenever the user " + + "asks about weather, temperature, rain, or similar " + + "conditions in a named location.") +``` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 58. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/to-swaig-function.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/to-swaig-function.mdx new file mode 100644 index 0000000000..ac51d4e1a5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/to-swaig-function.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/to-swaig-function" +title: "to_swaig_function" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::to_swaig_function" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `to_swaig_function` + +Serialise to a SWAIG function definition. + +## Signature + +```rust +fn to_swaig_function(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 227. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/webhook-expressions.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/webhook-expressions.mdx new file mode 100644 index 0000000000..30556bf22a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/webhook-expressions.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/webhook-expressions" +title: "webhook_expressions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::webhook_expressions" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `webhook_expressions` + +Set expressions on the last webhook. + +## Signature + +```rust +fn webhook_expressions(&mut self, expressions: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 164. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/webhook.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/webhook.mdx new file mode 100644 index 0000000000..7439c4c919 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/data-map/webhook.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap/data-map/webhook" +title: "webhook" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::datamap::datamap::DataMap::webhook" + parent: "signalwire::datamap::datamap::DataMap" + module: "datamap.datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `webhook` + +Add a webhook definition. + +## Signature + +```rust +fn webhook( + &mut self, + method: &str, + url: &str, + headers: ?, + form_param: &str, + input_args_as_params: bool, + require_args: ?<&str> +) -> &mut Self +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 132. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/datamap/index.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/index.mdx new file mode 100644 index 0000000000..8e5f4c16a8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/datamap/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/datamap/datamap" +title: "datamap" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::datamap::datamap" + parent: "signalwire::datamap" + module: "datamap" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs" + visibility: "public" +--- +# `datamap` + +## Classes + + + + Fluent builder for DataMap-based SWAIG function definitions. + + + +## Source + +[`src/datamap/datamap.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/datamap.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/datamap/index.mdx b/fern/products/sdk-reference/rust/signalwire/datamap/index.mdx new file mode 100644 index 0000000000..ebf26cf299 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/datamap/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/rust/signalwire/datamap" +title: "datamap" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::datamap" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/mod.rs" + visibility: "public" +--- +# `datamap` + +## Modules + + + + + +## Source + +[`src/datamap/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/datamap/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/index.mdx b/fern/products/sdk-reference/rust/signalwire/index.mdx new file mode 100644 index 0000000000..0f41386797 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/index.mdx @@ -0,0 +1,98 @@ +--- +slug: "/reference/rust/signalwire" +title: "signalwire" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs" + visibility: "public" +--- +# `signalwire` + +## Functions + + + + Add a directory to the global skill search path. + + + + Sorted list of every registered skill name. + + + + Per-skill schema map (parameter metadata) for every registered skill. Currently returns only the skill name as the key with an empty parameter map — Rust skills don't carry rich Python-style parameter introspection. The shape matches Python's contract so downstream tooling can iterate. + + + + Register a custom skill class. + + + + Construct a \[`RestClient`] from positional or keyword credentials. + + + + Run the supplied \[`AgentBase`] directly (without an \[`AgentServer`]) on its configured host/port. Blocking call. + + + + Construct an \[`AgentServer`] containing a single \[`AgentBase`] and run it on the configured `host:port`. Blocking call. + + + +## Classes + + + + Skill registration descriptor — Rust's analogue of a Python skill class. Bundles a skill's registration name with its factory closure into a single value so \[`register_skill`] can mirror Python's one-argument signature. + + + +## Modules + + + + + + + + + + + + + + Prompt Object Model (POM) + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/lib.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/list-skills-with-params.mdx b/fern/products/sdk-reference/rust/signalwire/list-skills-with-params.mdx new file mode 100644 index 0000000000..a3d89161ef --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/list-skills-with-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/list-skills-with-params" +title: "list_skills_with_params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::list_skills_with_params" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs" + visibility: "public" +--- +# `list_skills_with_params` + +Per-skill schema map (parameter metadata) for every registered +skill. Currently returns only the skill name as the key with an +empty parameter map — Rust skills don't carry rich Python-style +parameter introspection. The shape matches Python's contract so +downstream tooling can iterate. + +Mirrors Python's `signalwire.list_skills_with_params()`. + +## Signature + +```rust +fn list_skills_with_params() -> ? +``` + +## Returns + +`?` + +## Source + +[`src/lib.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs) + +Line 101. diff --git a/fern/products/sdk-reference/rust/signalwire/list-skills.mdx b/fern/products/sdk-reference/rust/signalwire/list-skills.mdx new file mode 100644 index 0000000000..8f96226995 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/list-skills.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/list-skills" +title: "list_skills" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::list_skills" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs" + visibility: "public" +--- +# `list_skills` + +Sorted list of every registered skill name. + +Mirrors Python's `signalwire.list_skills()`. + +## Signature + +```rust +fn list_skills() -> ? +``` + +## Returns + +`?` + +## Source + +[`src/lib.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs) + +Line 90. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/index.mdx b/fern/products/sdk-reference/rust/signalwire/logging/index.mdx new file mode 100644 index 0000000000..04bd60b3e4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/rust/signalwire/logging" +title: "logging" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::logging" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `logging` + +## Functions + + + + Initialize the global logger (call once at startup). + + + +## Classes + + + + Logger with level filtering and suppression via environment variables. + + + +## Enums + + + + Log levels matching the SDK convention. + + + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/init.mdx b/fern/products/sdk-reference/rust/signalwire/logging/init.mdx new file mode 100644 index 0000000000..dac6d79808 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/init.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/logging/init" +title: "init" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::logging::init" + parent: "signalwire::logging" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `init` + +Initialize the global logger (call once at startup). + +## Signature + +```rust +fn init() +``` + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 95. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/level/as-str.mdx b/fern/products/sdk-reference/rust/signalwire/logging/level/as-str.mdx new file mode 100644 index 0000000000..ff3684f1e3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/level/as-str.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/logging/level/as-str" +title: "as_str" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Level::as_str" + parent: "signalwire::logging::Level" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `as_str` + +## Signature + +```rust +fn as_str(&self) -> &'static str +``` + +## Returns + +`&'static str` + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 26. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/level/clone.mdx b/fern/products/sdk-reference/rust/signalwire/logging/level/clone.mdx new file mode 100644 index 0000000000..c86ff2b5b2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/level/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/logging/level/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Level::clone" + parent: "signalwire::logging::Level" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/level/cmp.mdx b/fern/products/sdk-reference/rust/signalwire/logging/level/cmp.mdx new file mode 100644 index 0000000000..1afd0ef9c6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/level/cmp.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/logging/level/cmp" +title: "cmp" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Level::cmp" + parent: "signalwire::logging::Level" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `cmp` + +## Signature + +```rust +fn cmp(&self, other: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/level/eq.mdx b/fern/products/sdk-reference/rust/signalwire/logging/level/eq.mdx new file mode 100644 index 0000000000..4886a19720 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/level/eq.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/logging/level/eq" +title: "eq" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Level::eq" + parent: "signalwire::logging::Level" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `eq` + +## Signature + +```rust +fn eq(&self, other: &?) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/level/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/logging/level/fmt.mdx new file mode 100644 index 0000000000..f88751c5b3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/level/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/logging/level/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Level::fmt" + parent: "signalwire::logging::Level" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/level/from-str.mdx b/fern/products/sdk-reference/rust/signalwire/logging/level/from-str.mdx new file mode 100644 index 0000000000..246252edff --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/level/from-str.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/logging/level/from-str" +title: "from_str" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Level::from_str" + parent: "signalwire::logging::Level" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `from_str` + +## Signature + +```rust +fn from_str(s: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 16. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/level/index.mdx b/fern/products/sdk-reference/rust/signalwire/logging/level/index.mdx new file mode 100644 index 0000000000..b4c65b2035 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/level/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/rust/signalwire/logging/level" +title: "Level" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "enum" + language: "rust" + qualified_name: "signalwire::logging::Level" + parent: "signalwire::logging" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `Level` + +Log levels matching the SDK convention. + +## Signature + +```rust +enum Level +``` + +## Inheritance + +**Implements:** `Debug`, `Clone`, `Copy`, `PartialEq`, `Eq`, `PartialOrd`, `Ord` + +## Variants + + + + + + + + + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 8. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/level/partial-cmp.mdx b/fern/products/sdk-reference/rust/signalwire/logging/level/partial-cmp.mdx new file mode 100644 index 0000000000..2eacf15a0a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/level/partial-cmp.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/logging/level/partial-cmp" +title: "partial_cmp" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Level::partial_cmp" + parent: "signalwire::logging::Level" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `partial_cmp` + +## Signature + +```rust +fn partial_cmp(&self, other: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/logger/debug.mdx b/fern/products/sdk-reference/rust/signalwire/logging/logger/debug.mdx new file mode 100644 index 0000000000..c5e51a9070 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/logger/debug.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/logging/logger/debug" +title: "debug" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Logger::debug" + parent: "signalwire::logging::Logger" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `debug` + +## Signature + +```rust +fn debug(&self, message: &str) +``` + +## Parameters + + + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 77. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/logger/error.mdx b/fern/products/sdk-reference/rust/signalwire/logging/logger/error.mdx new file mode 100644 index 0000000000..8c8fd2c508 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/logger/error.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/logging/logger/error" +title: "error" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Logger::error" + parent: "signalwire::logging::Logger" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `error` + +## Signature + +```rust +fn error(&self, message: &str) +``` + +## Parameters + + + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 89. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/logger/index.mdx b/fern/products/sdk-reference/rust/signalwire/logging/logger/index.mdx new file mode 100644 index 0000000000..d56c78db65 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/logger/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/rust/signalwire/logging/logger" +title: "Logger" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::logging::Logger" + parent: "signalwire::logging" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `Logger` + +Logger with level filtering and suppression via environment variables. + +- `SIGNALWIRE_LOG_LEVEL` — sets the minimum level (debug/info/warn/error) +- `SIGNALWIRE_LOG_MODE=off` — suppresses all output + +## Signature + +```rust +struct Logger { /* fields */ } +``` + +## Properties + + + + + + + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 40. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/logger/info.mdx b/fern/products/sdk-reference/rust/signalwire/logging/logger/info.mdx new file mode 100644 index 0000000000..9749f16cc9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/logger/info.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/logging/logger/info" +title: "info" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Logger::info" + parent: "signalwire::logging::Logger" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `info` + +## Signature + +```rust +fn info(&self, message: &str) +``` + +## Parameters + + + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 81. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/logger/log.mdx b/fern/products/sdk-reference/rust/signalwire/logging/logger/log.mdx new file mode 100644 index 0000000000..5db5c26125 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/logger/log.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/logging/logger/log" +title: "log" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Logger::log" + parent: "signalwire::logging::Logger" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `log` + +## Signature + +```rust +fn log(&self, level: ?, message: &str) +``` + +## Parameters + + + + + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 69. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/logger/new.mdx b/fern/products/sdk-reference/rust/signalwire/logging/logger/new.mdx new file mode 100644 index 0000000000..8c961a0375 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/logger/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/logging/logger/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Logger::new" + parent: "signalwire::logging::Logger" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(name: &str) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 47. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/logger/should-log.mdx b/fern/products/sdk-reference/rust/signalwire/logging/logger/should-log.mdx new file mode 100644 index 0000000000..053959f7a7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/logger/should-log.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/logging/logger/should-log" +title: "should_log" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Logger::should_log" + parent: "signalwire::logging::Logger" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `should_log` + +## Signature + +```rust +fn should_log(&self, level: ?) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 65. diff --git a/fern/products/sdk-reference/rust/signalwire/logging/logger/warn.mdx b/fern/products/sdk-reference/rust/signalwire/logging/logger/warn.mdx new file mode 100644 index 0000000000..4af40da60a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/logging/logger/warn.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/logging/logger/warn" +title: "warn" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::logging::Logger::warn" + parent: "signalwire::logging::Logger" + module: "logging" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs" + visibility: "public" +--- +# `warn` + +## Signature + +```rust +fn warn(&self, message: &str) +``` + +## Parameters + + + +## Source + +[`src/logging.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/logging.rs) + +Line 85. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/index.mdx b/fern/products/sdk-reference/rust/signalwire/pom/index.mdx new file mode 100644 index 0000000000..2ae1414662 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/pom" +title: "pom" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::pom" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/mod.rs" + visibility: "public" +--- +# `pom` + +Prompt Object Model (POM) + +A typed tree of prompt sections that supports markdown / XML / JSON / +YAML rendering. Direct port of `signalwire.pom.pom` from +signalwire-python. + +The two public types are \[`PromptObjectModel`] (the root container) +and \[`Section`] (one node in the tree). Build a model with +`add_section` / `add_subsection`, then render via `render_markdown`, +`render_xml`, `to_json`, or `to_yaml`. All renderers match Python +byte-for-byte — the cross-port parity contract lives in +`signalwire-python/tests/unit/pom/test_pom_render_parity.py`. + +## Modules + + + + `PromptObjectModel` — root container for a POM document. + + + + Section type for the Prompt Object Model. + + + +## Source + +[`src/pom/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/index.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/index.mdx new file mode 100644 index 0000000000..2df02f9b27 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/pom/pom" +title: "pom" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::pom::pom" + parent: "signalwire::pom" + module: "pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `pom` + +`PromptObjectModel` — root container for a POM document. + +Direct port of `signalwire.pom.pom.PromptObjectModel` +(signalwire-python/signalwire/signalwire/pom/pom.py:234-540). + +Owns a `Vec
` (the top-level sections) and exposes +markdown / XML / JSON / YAML rendering plus structural helpers +(`add_section`, `find_section`, `add_pom_as_subsection`). + +All renderers match Python byte-for-byte — the cross-port +parity contract is asserted in +`signalwire-python/tests/unit/pom/test_pom_render_parity.py` and +mirrored in this crate's inline tests. + +## Classes + + + + Root container for a Prompt Object Model document. + + + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/add-pom-as-subsection.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/add-pom-as-subsection.mdx new file mode 100644 index 0000000000..298b840cbf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/add-pom-as-subsection.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/add-pom-as-subsection" +title: "add_pom_as_subsection" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::add_pom_as_subsection" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `add_pom_as_subsection` + +Append every top-level section of `pom_to_add` as a +subsection of the section identified by `target_title`. + +Mirrors Python's `add_pom_as_subsection(target, pom_to_add)` +where `target` is a section title. Returns `Err` when no +section with the given title exists. + +## Signature + +```rust +fn add_pom_as_subsection( + &mut self, + target_title: &str, + pom_to_add: &? +) -> ?<(), ?> +``` + +## Parameters + + + + + +## Returns + +`?<(), ?>` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 251. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/add-section-with.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/add-section-with.mdx new file mode 100644 index 0000000000..c94e79fc0d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/add-section-with.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/add-section-with" +title: "add_section_with" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::add_section_with" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `add_section_with` + +Append a top-level section with title + body in one call. +Convenience wrapper that mirrors Python's keyword-style +`add_section(title=..., body=...)`. + +## Signature + +```rust +fn add_section_with: ?>( + &mut self, + title: ?, + body: impl ? +) -> ?<&mut ?, ?> +``` + +## Type Parameters + + + +## Parameters + + + + + +## Returns + +`?<&mut ?, ?>` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 107. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/add-section.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/add-section.mdx new file mode 100644 index 0000000000..82968bae40 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/add-section.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/add-section" +title: "add_section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::add_section" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `add_section` + +Append a top-level section with the given title and body. + +Mirrors Python's `PromptObjectModel.add_section(title, body=...)`. +Only the _first_ section may pass `title = None`; subsequent +`None` titles return `Err`. + +Returns a mutable reference to the new section so callers +can keep configuring it (Python returns the `Section` object +— Rust's borrow checker makes a `&mut` reference the +equivalent shape). + +## Signature + +```rust +fn add_section(&mut self, title: ?) -> ?<&mut ?, ?> +``` + +## Parameters + + + +## Returns + +`?<&mut ?, ?>` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 96. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/clone.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/clone.mdx new file mode 100644 index 0000000000..62b1f36038 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::clone" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 31. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/default.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/default.mdx new file mode 100644 index 0000000000..e54b4075b6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/default.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/default" +title: "default" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::default" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `default` + +## Signature + +```rust +fn default() -> ? +``` + +## Returns + +`?` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 31. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/eq.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/eq.mdx new file mode 100644 index 0000000000..056b8a5c4c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/eq.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/eq" +title: "eq" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::eq" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `eq` + +## Signature + +```rust +fn eq(&self, other: &?) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 31. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/find-section-mut.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/find-section-mut.mdx new file mode 100644 index 0000000000..099c5de5c2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/find-section-mut.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/find-section-mut" +title: "find_section_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::find_section_mut" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `find_section_mut` + +Mutable variant of \[`find_section`]. + +[`find_section`]: PromptObjectModel::find_section + +## Signature + +```rust +fn find_section_mut(&mut self, title: &str) -> ?<&mut ?> +``` + +## Parameters + + + +## Returns + +`?<&mut ?>` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 138. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/find-section.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/find-section.mdx new file mode 100644 index 0000000000..1478843465 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/find-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/find-section" +title: "find_section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::find_section" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `find_section` + +Find the first section (recursively, depth-first) with the +given title. Returns `None` when no match. Mirrors Python's +`find_section`. + +## Signature + +```rust +fn find_section(&self, title: &str) -> ?<&?> +``` + +## Parameters + + + +## Returns + +`?<&?>` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 120. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/fmt.mdx new file mode 100644 index 0000000000..5cb3de97cf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::fmt" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 31. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/from-json.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/from-json.mdx new file mode 100644 index 0000000000..a232cf6f34 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/from-json.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/from-json" +title: "from_json" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::from_json" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `from_json` + +Parse a JSON string into a \[`PromptObjectModel`]. Mirrors +Python's `PromptObjectModel.from_json(json_data)`. + +Returns `Err(String)` with a descriptive message on parse +errors, matching Python's `ValueError`. + +## Signature + +```rust +fn from_json(json_str: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 54. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/from-value.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/from-value.mdx new file mode 100644 index 0000000000..79e10cb64d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/from-value.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/from-value" +title: "from_value" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::from_value" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `from_value` + +Build a model from a parsed `serde_json::Value`. Used by +both \[`from_json`] and \[`from_yaml`]. + +[`from_json`]: PromptObjectModel::from_json + +[`from_yaml`]: PromptObjectModel::from_yaml + +## Signature + +```rust +fn from_value(value: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 73. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/from-yaml.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/from-yaml.mdx new file mode 100644 index 0000000000..a9fe255f3b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/from-yaml.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/from-yaml" +title: "from_yaml" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::from_yaml" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `from_yaml` + +Parse a YAML string into a \[`PromptObjectModel`]. Mirrors +Python's `PromptObjectModel.from_yaml(yaml_data)`. + +## Signature + +```rust +fn from_yaml(yaml_str: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 62. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/index.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/index.mdx new file mode 100644 index 0000000000..3e08afab2e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/index.mdx @@ -0,0 +1,123 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model" +title: "PromptObjectModel" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel" + parent: "signalwire::pom::pom" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `PromptObjectModel` + +Root container for a Prompt Object Model document. + +Mirrors Python's `signalwire.pom.pom.PromptObjectModel`. Construct +with \[`PromptObjectModel::new`], populate with [`add_section`], +then render via [`render_markdown`], [`render_xml`], [`to_json`], +or [`to_yaml`]. + +[`add_section`]: PromptObjectModel::add_section + +[`render_markdown`]: PromptObjectModel::render_markdown + +[`render_xml`]: PromptObjectModel::render_xml + +[`to_json`]: PromptObjectModel::to_json + +[`to_yaml`]: PromptObjectModel::to_yaml + +## Signature + +```rust +struct PromptObjectModel { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone`, `Default`, `PartialEq`, `Eq` + +## Properties + + + Top-level sections, in insertion order. Only the _first_ entry may have `title = None`; all others must carry a title (Python raises `ValueError` otherwise — see `add_section`). + + +## Methods + + + + Append every top-level section of `pom_to_add` as a subsection of the section identified by `target_title`. + + + + Append a top-level section with the given title and body. + + + + Append a top-level section with title + body in one call. Convenience wrapper that mirrors Python's keyword-style `add_section(title=..., body=...)`. + + + + + + + + + + Find the first section (recursively, depth-first) with the given title. Returns `None` when no match. Mirrors Python's `find_section`. + + + + Mutable variant of \[`find_section`]. + + + + + + Parse a JSON string into a \[`PromptObjectModel`]. Mirrors Python's `PromptObjectModel.from_json(json_data)`. + + + + Build a model from a parsed `serde_json::Value`. Used by both \[`from_json`] and \[`from_yaml`]. + + + + Parse a YAML string into a \[`PromptObjectModel`]. Mirrors Python's `PromptObjectModel.from_yaml(yaml_data)`. + + + + Construct an empty model. Mirrors Python's `PromptObjectModel()` constructor. + + + + Render the entire model as markdown. Matches Python's `render_markdown` byte-for-byte. + + + + Render the entire model as XML. Matches Python's `render_xml` byte-for-byte. + + + + Render the model as a JSON string (indent=2). Matches Python's `to_json` byte-for-byte: `json.dumps([...], indent=2)`. + + + + Convert the model to a `serde_json::Value` (a JSON array of section dicts). Mirrors Python's `to_dict`. The Rust name follows serde idiom (`to_value`) but the cross-port surface audit treats `to_value` ≡ `to_dict`. + + + + Render the model as a YAML string. Matches PyYAML's output shape (`default_flow_style=False, sort_keys=False`). + + + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 32. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/new.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/new.mdx new file mode 100644 index 0000000000..edf297987c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/new.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::new" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `new` + +Construct an empty model. Mirrors Python's +`PromptObjectModel()` constructor. + +## Signature + +```rust +fn new() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 43. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/render-markdown.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/render-markdown.mdx new file mode 100644 index 0000000000..0d5b43a652 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/render-markdown.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/render-markdown" +title: "render_markdown" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::render_markdown" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `render_markdown` + +Render the entire model as markdown. Matches Python's +`render_markdown` byte-for-byte. + +## Signature + +```rust +fn render_markdown(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 194. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/render-xml.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/render-xml.mdx new file mode 100644 index 0000000000..aa3d196d43 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/render-xml.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/render-xml" +title: "render_xml" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::render_xml" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `render_xml` + +Render the entire model as XML. Matches Python's +`render_xml` byte-for-byte. + +## Signature + +```rust +fn render_xml(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 218. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/to-json.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/to-json.mdx new file mode 100644 index 0000000000..29a9042194 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/to-json.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/to-json" +title: "to_json" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::to_json" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `to_json` + +Render the model as a JSON string (indent=2). Matches +Python's `to_json` byte-for-byte: `json.dumps([...], indent=2)`. + +## Signature + +```rust +fn to_json(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 163. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/to-value.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/to-value.mdx new file mode 100644 index 0000000000..90d9e3456e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/to-value.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/to-value" +title: "to_value" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::to_value" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `to_value` + +Convert the model to a `serde_json::Value` (a JSON array of +section dicts). Mirrors Python's `to_dict`. The Rust name +follows serde idiom (`to_value`) but the cross-port surface +audit treats `to_value` ≡ `to_dict`. + +## Signature + +```rust +fn to_value(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 157. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/to-yaml.mdx b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/to-yaml.mdx new file mode 100644 index 0000000000..1f150ee95a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/pom/prompt-object-model/to-yaml.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/rust/signalwire/pom/pom/prompt-object-model/to-yaml" +title: "to_yaml" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::pom::PromptObjectModel::to_yaml" + parent: "signalwire::pom::pom::PromptObjectModel" + module: "pom.pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs" + visibility: "public" +--- +# `to_yaml` + +Render the model as a YAML string. Matches PyYAML's output +shape (`default_flow_style=False, sort_keys=False`). + +We hand-emit YAML rather than rely on `serde_yaml::to_string` +because the latter (a) sorts keys alphabetically when fed a +`serde_json::Value` (which uses BTreeMap internally) and +(b) doesn't expose a switch to disable that. The POM +document shape is fully constrained — list of dicts with +known string/list-of-string/list-of-dict values — so a +targeted emitter is straightforward and guarantees parity. + +## Signature + +```rust +fn to_yaml(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/pom/pom.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/pom.rs) + +Line 180. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/index.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/index.mdx new file mode 100644 index 0000000000..5f71c4c6d8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/pom/section" +title: "section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::pom::section" + parent: "signalwire::pom" + module: "pom" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `section` + +Section type for the Prompt Object Model. + +Direct port of `signalwire.pom.pom.Section` +(signalwire-python/signalwire/signalwire/pom/pom.py:5-231). + +Each \[`Section`] holds an optional title, optional body text, +optional bullets, optional numbering flags, and a tree of nested +subsections. Renderers (`render_markdown`, `render_xml`, +`to_value`) walk the tree and emit byte-for-byte the same output +as Python's reference implementation. + +## Classes + + + + One node in a Prompt Object Model tree. + + + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-body.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-body.mdx new file mode 100644 index 0000000000..8211f86ada --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-body.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/add-body" +title: "add_body" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::add_body" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `add_body` + +Replace the body text. Mirrors Python's `Section.add_body` — +the docstring explicitly says "Add OR REPLACE the body". + +## Signature + +```rust +fn add_body: ?>(&mut self, body: impl ?) -> &mut Self +``` + +## Type Parameters + + + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 73. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-bullets.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-bullets.mdx new file mode 100644 index 0000000000..3837ffacdc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-bullets.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/add-bullets" +title: "add_bullets" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::add_bullets" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `add_bullets` + +Append additional bullets. Mirrors Python's +`Section.add_bullets` (`self.bullets.extend(bullets)`). + +## Signature + +```rust +fn add_bullets(&mut self, bullets: I) -> &mut Self where I: ?, S: ? +``` + +## Type Parameters + + + + + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 80. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-subsection-full.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-subsection-full.mdx new file mode 100644 index 0000000000..63baed643a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-subsection-full.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/add-subsection-full" +title: "add_subsection_full" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::add_subsection_full" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `add_subsection_full` + +Add a fully-specified subsection. Convenience that mirrors +Python's keyword-argument form +`add_subsection(title=..., body=..., bullets=..., numbered=..., numberedBullets=...)`. + +## Signature + +```rust +fn add_subsection_full: ?, impl Into: ?>( + &mut self, + title: impl ?, + body: impl ?, + bullets: ?, + numbered: ?, + numbered_bullets: bool +) -> &mut ? +``` + +## Type Parameters + + + + + +## Parameters + + + + + + + + + + + +## Returns + +`&mut ?` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 106. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-subsection.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-subsection.mdx new file mode 100644 index 0000000000..f652d538ea --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/add-subsection.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/add-subsection" +title: "add_subsection" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::add_subsection" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `add_subsection` + +Add a subsection. Mirrors Python's `Section.add_subsection` +— the title is required (Python raises `ValueError` when +`title is None`); we encode the same constraint by accepting +`String` (not `Option`). + +Returns a mutable reference to the freshly-appended +subsection so the caller can keep configuring it. (Python +returns the `Section` object directly; Rust's borrow checker +makes a `&mut` reference the equivalent shape.) + +## Signature + +```rust +fn add_subsection: ?>( + &mut self, + title: impl ? +) -> &mut ? +``` + +## Type Parameters + + + +## Parameters + + + +## Returns + +`&mut ?` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 98. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/clone.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/clone.mdx new file mode 100644 index 0000000000..7d9b08b615 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::clone" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 18. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/default.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/default.mdx new file mode 100644 index 0000000000..ccb26d9875 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/default.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/default" +title: "default" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::default" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `default` + +## Signature + +```rust +fn default() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 44. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/eq.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/eq.mdx new file mode 100644 index 0000000000..3a769ea82c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/eq.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/eq" +title: "eq" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::eq" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `eq` + +## Signature + +```rust +fn eq(&self, other: &?) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 18. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/fmt.mdx new file mode 100644 index 0000000000..f559b891c0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::fmt" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 18. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/index.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/index.mdx new file mode 100644 index 0000000000..ee24e415c0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/index.mdx @@ -0,0 +1,107 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section" +title: "Section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::pom::section::Section" + parent: "signalwire::pom::section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `Section` + +One node in a Prompt Object Model tree. + +Mirrors Python's `signalwire.pom.pom.Section`. Fields are owned +strings/vecs (Rust idiom — the model is a value-type document). + +## Signature + +```rust +struct Section { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone`, `PartialEq`, `Eq`, `Default` + +## Properties + + + Paragraph of body text. Empty string when not set (matches Python's `body=''` default). + + + + Bullet items. Rendered as `- text` (or `1. text` when `numbered_bullets` is `true`). + + + + Whether this section participates in numbered numbering. `None` means "unspecified" (Python's `None` default). `Some(true)` enables numbering on this and all sibling sections at the same level (unless explicitly set to `Some(false)`). + + + + Whether bullets in _this_ section render as `1. x` (true) or `- x` (false). Default `false` matches Python. + + + + Nested subsections. Renderer walks this tree depth-first. + + + + The section title. `None` is valid only for the _first_ top-level section in a \[`crate::pom::PromptObjectModel`]; every other section must carry a title. + + +## Methods + + + + Replace the body text. Mirrors Python's `Section.add_body` — the docstring explicitly says "Add OR REPLACE the body". + + + + Append additional bullets. Mirrors Python's `Section.add_bullets` (`self.bullets.extend(bullets)`). + + + + Add a subsection. Mirrors Python's `Section.add_subsection` — the title is required (Python raises `ValueError` when `title is None`); we encode the same constraint by accepting `String` (not `Option`). + + + + Add a fully-specified subsection. Convenience that mirrors Python's keyword-argument form `add_subsection(title=..., body=..., bullets=..., numbered=..., numberedBullets=...)`. + + + + + + + + + + + + Construct a section with the given title. + + + + Render this section (and all nested subsections) as markdown. Output matches Python's `Section.render_markdown` byte-for-byte — see `signalwire-python/tests/unit/pom/test_pom_render_parity.py` for the cross-port contract. + + + + Render this section as XML. Matches Python's `Section.render_xml` byte-for-byte. + + + + Convert this section to a `serde_json::Value` matching Python's `Section.to_dict` exactly. Key order is fixed (`title`, `body`, `bullets`, `subsections`, `numbered`, `numberedBullets`) so JSON/YAML serialisation is byte-for-byte deterministic across ports. + + + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 19. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/new.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/new.mdx new file mode 100644 index 0000000000..9e22b63e68 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/new.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::new" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `new` + +Construct a section with the given title. + +Use the field-setter methods (`add_body`, `add_bullets`, +`add_subsection`) or struct-literal construction for further +configuration. Mirrors Python's `Section(title=..., ...)` +keyword constructor — Rust's idiom uses a builder-style call +chain via `add_*`. + +## Signature + +```rust +fn new(title: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 64. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/render-markdown.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/render-markdown.mdx new file mode 100644 index 0000000000..0797c7fd59 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/render-markdown.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/render-markdown" +title: "render_markdown" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::render_markdown" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `render_markdown` + +Render this section (and all nested subsections) as +markdown. Output matches Python's +`Section.render_markdown` byte-for-byte — see +`signalwire-python/tests/unit/pom/test_pom_render_parity.py` +for the cross-port contract. + +## Signature + +```rust +fn render_markdown(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 177. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/render-xml.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/render-xml.mdx new file mode 100644 index 0000000000..c3b67a359b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/render-xml.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/render-xml" +title: "render_xml" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::render_xml" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `render_xml` + +Render this section as XML. Matches Python's +`Section.render_xml` byte-for-byte. + +## Signature + +```rust +fn render_xml(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 239. diff --git a/fern/products/sdk-reference/rust/signalwire/pom/section/section/to-value.mdx b/fern/products/sdk-reference/rust/signalwire/pom/section/section/to-value.mdx new file mode 100644 index 0000000000..9be4e23fcd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/pom/section/section/to-value.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/rust/signalwire/pom/section/section/to-value" +title: "to_value" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::pom::section::Section::to_value" + parent: "signalwire::pom::section::Section" + module: "pom.section" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs" + visibility: "public" +--- +# `to_value` + +Convert this section to a `serde_json::Value` matching +Python's `Section.to_dict` exactly. Key order is fixed +(`title`, `body`, `bullets`, `subsections`, `numbered`, +`numberedBullets`) so JSON/YAML serialisation is +byte-for-byte deterministic across ports. + +The Python name is `to_dict`; in Rust the natural name for +a `serde_json::Value` is `to_value`. The cross-port surface +audit treats the two as equivalent (see +`enumerate_surface.py` METHOD\_RENAMES). + +## Signature + +```rust +fn to_value(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/pom/section.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/pom/section.rs) + +Line 136. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/agent-mut.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/agent-mut.mdx new file mode 100644 index 0000000000..d8a8a9bd61 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/agent-mut.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/agent-mut" +title: "agent_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::agent_mut" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `agent_mut` + +Borrow the underlying `AgentBase` (mutable). Most consumers use +`Deref`/`DerefMut` for chaining; this is occasionally useful +when an explicit handle is needed. + +## Signature + +```rust +fn agent_mut(&mut self) -> &mut ? +``` + +## Returns + +`&mut ?` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 315. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/agent.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/agent.mdx new file mode 100644 index 0000000000..5727ddb718 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/agent.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/agent" +title: "agent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::agent" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `agent` + +Borrow the underlying `AgentBase` (read-only). + +## Signature + +```rust +fn agent(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 308. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/deref-mut.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/deref-mut.mdx new file mode 100644 index 0000000000..548a462cf3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/deref-mut.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/deref-mut" +title: "deref_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::deref_mut" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `deref_mut` + +## Signature + +```rust +fn deref_mut(&mut self) -> &mut ? +``` + +## Returns + +`&mut ?` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 348. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/deref.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/deref.mdx new file mode 100644 index 0000000000..a0ba5f9cc5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::deref" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 342. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/fmt.mdx new file mode 100644 index 0000000000..97ff232ce5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::fmt" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 354. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/index.mdx new file mode 100644 index 0000000000..17ceb93e4a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/index.mdx @@ -0,0 +1,119 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent" +title: "BedrockAgent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent" + parent: "signalwire::prefabs::bedrock" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `BedrockAgent` + +Voice-to-voice agent backed by Amazon Bedrock. + +Wraps an \[`AgentBase`]: every standard agent operation +(`set_prompt_text`, `prompt_add_section`, `define_tool`, …) is +available through `Deref`/`DerefMut`. The single divergence is at +SWML rendering time: \[`BedrockAgent::render_swml`] takes the SWML +produced by `AgentBase::render_swml` and rewrites the `ai` verb +into an `amazon_bedrock` verb that carries Bedrock-specific +inference parameters (voice id, temperature, top-p) inside the +prompt object. + +## Signature + +```rust +struct BedrockAgent { /* fields */ } +``` + +## Inheritance + +**Implements:** `Deref`, `DerefMut`, `Debug` + +## Methods + + + + Borrow the underlying `AgentBase` (read-only). + + + + Borrow the underlying `AgentBase` (mutable). Most consumers use `Deref`/`DerefMut` for chaining; this is occasionally useful when an explicit handle is needed. + + + + + + + + + + Current max-tokens cap. + + + + Construct a new BedrockAgent. + + + + Render SWML, transforming the `ai` verb into an `amazon_bedrock` verb that carries the Bedrock voice and inference parameters. Mirrors Python's `_render_swml`. + + + + String representation matching Python's `__repr__`. + + + + Update Bedrock inference parameters. Pass `None` to keep an existing value untouched. Mirrors the Python signature. + + + + Set LLM model — not applicable for Bedrock. Logs a warning and is a no-op (Bedrock uses a fixed voice-to-voice model). Matches Python's documented behavior. + + + + Set LLM temperature — redirects to `set_inference_params` for Bedrock. Matches Python's documented behavior. + + + + Set post-prompt LLM params — not applicable for Bedrock. Logs a warning and is a no-op (post-prompt summarisation runs on a platform-side model). Matches Python's documented behavior. + + + + Set prompt LLM params — Bedrock callers should use `set_inference_params` instead. Logs a warning and is a no-op. Matches Python's documented behavior. + + + + Set the Bedrock voice id (e.g. `"matthew"`, `"joanna"`). + + + + Current generation temperature. + + + + Current nucleus sampling parameter. + + + + Current voice id. + + + +## Type Aliases + + + + + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 28. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/max-tokens.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/max-tokens.mdx new file mode 100644 index 0000000000..cddbbdcb96 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/max-tokens.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/max-tokens" +title: "max_tokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::max_tokens" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `max_tokens` + +Current max-tokens cap. + +## Signature + +```rust +fn max_tokens(&self) -> u32 +``` + +## Returns + +`u32` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 335. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/new.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/new.mdx new file mode 100644 index 0000000000..148a17889e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/new.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::new" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `new` + +Construct a new BedrockAgent. + +Mirrors Python's +`BedrockAgent(name=..., route=..., system_prompt=..., voice_id=..., +temperature=..., top_p=..., max_tokens=..., **kwargs)`. + +## Signature + +```rust +fn new(options: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 98. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/render-swml.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/render-swml.mdx new file mode 100644 index 0000000000..181b7a7e90 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/render-swml.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/render-swml" +title: "render_swml" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::render_swml" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `render_swml` + +Render SWML, transforming the `ai` verb into an +`amazon_bedrock` verb that carries the Bedrock voice and +inference parameters. Mirrors Python's `_render_swml`. + +## Signature + +```rust +fn render_swml(&self, headers: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 201. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/repr.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/repr.mdx new file mode 100644 index 0000000000..953921dd81 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/repr.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/repr" +title: "repr" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::repr" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `repr` + +String representation matching Python's `__repr__`. + +## Signature + +```rust +fn repr(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 298. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-inference-params.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-inference-params.mdx new file mode 100644 index 0000000000..7ea8344b6d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-inference-params.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-inference-params" +title: "set_inference_params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::set_inference_params" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `set_inference_params` + +Update Bedrock inference parameters. Pass `None` to keep an +existing value untouched. Mirrors the Python signature. + +## Signature + +```rust +fn set_inference_params( + &mut self, + temperature: ?, + top_p: ?, + max_tokens: ? +) -> &mut Self +``` + +## Parameters + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 140. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-llm-model.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-llm-model.mdx new file mode 100644 index 0000000000..1a733701da --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-llm-model.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-llm-model" +title: "set_llm_model" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::set_llm_model" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `set_llm_model` + +Set LLM model — not applicable for Bedrock. Logs a warning and +is a no-op (Bedrock uses a fixed voice-to-voice model). Matches +Python's documented behavior. + +## Signature + +```rust +fn set_llm_model(&mut self, model: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 165. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-llm-temperature.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-llm-temperature.mdx new file mode 100644 index 0000000000..d54c3bef46 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-llm-temperature.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-llm-temperature" +title: "set_llm_temperature" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::set_llm_temperature" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `set_llm_temperature` + +Set LLM temperature — redirects to `set_inference_params` for +Bedrock. Matches Python's documented behavior. + +## Signature + +```rust +fn set_llm_temperature(&mut self, temperature: f64) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 175. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..e6f8673aca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-post-prompt-llm-params.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-post-prompt-llm-params" +title: "set_post_prompt_llm_params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::set_post_prompt_llm_params" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `set_post_prompt_llm_params` + +Set post-prompt LLM params — not applicable for Bedrock. Logs a +warning and is a no-op (post-prompt summarisation runs on a +platform-side model). Matches Python's documented behavior. + +## Signature + +```rust +fn set_post_prompt_llm_params(&mut self, _params: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 182. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-prompt-llm-params.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..aa00230104 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-prompt-llm-params.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-prompt-llm-params" +title: "set_prompt_llm_params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::set_prompt_llm_params" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `set_prompt_llm_params` + +Set prompt LLM params — Bedrock callers should use +`set_inference_params` instead. Logs a warning and is a no-op. +Matches Python's documented behavior. + +## Signature + +```rust +fn set_prompt_llm_params(&mut self, _params: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 192. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-voice.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-voice.mdx new file mode 100644 index 0000000000..f84fc7bce4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-voice.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/set-voice" +title: "set_voice" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::set_voice" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `set_voice` + +Set the Bedrock voice id (e.g. `"matthew"`, `"joanna"`). + +## Signature + +```rust +fn set_voice(&mut self, voice_id: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 132. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/target.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/target.mdx new file mode 100644 index 0000000000..beb58bf4ea --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 341. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/temperature.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/temperature.mdx new file mode 100644 index 0000000000..421ba4e991 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/temperature.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/temperature" +title: "temperature" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::temperature" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `temperature` + +Current generation temperature. + +## Signature + +```rust +fn temperature(&self) -> f64 +``` + +## Returns + +`f64` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 325. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/top-p.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/top-p.mdx new file mode 100644 index 0000000000..9973676059 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/top-p.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/top-p" +title: "top_p" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::top_p" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `top_p` + +Current nucleus sampling parameter. + +## Signature + +```rust +fn top_p(&self) -> f64 +``` + +## Returns + +`f64` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 330. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/voice-id.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/voice-id.mdx new file mode 100644 index 0000000000..3622a2a16d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-agent/voice-id.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-agent/voice-id" +title: "voice_id" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockAgent::voice_id" + parent: "signalwire::prefabs::bedrock::BedrockAgent" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `voice_id` + +Current voice id. + +## Signature + +```rust +fn voice_id(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 320. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-options/default.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-options/default.mdx new file mode 100644 index 0000000000..61c4a7c126 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-options/default.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-options/default" +title: "default" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockOptions::default" + parent: "signalwire::prefabs::bedrock::BedrockOptions" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `default` + +## Signature + +```rust +fn default() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 65. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-options/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-options/index.mdx new file mode 100644 index 0000000000..08c2c4d8f2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-options/index.mdx @@ -0,0 +1,91 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-options" +title: "BedrockOptions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockOptions" + parent: "signalwire::prefabs::bedrock" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `BedrockOptions` + +Construction options for \[`BedrockAgent`]. Mirrors the keyword +arguments of Python's `BedrockAgent.__init__`. + +## Signature + +```rust +struct BedrockOptions { /* fields */ } +``` + +## Inheritance + +**Implements:** `Default` + +## Properties + + + Optional basic-auth password override. + + + + Optional basic-auth user override. + + + + Optional bind host override. + + + + Max generation tokens (default `1024`). + + + + Agent name (default `"bedrock_agent"`). + + + + Optional bind port override. + + + + HTTP route (default `"/bedrock"`). + + + + Optional system prompt to register with `set_prompt_text`. + + + + Generation temperature 0..1 (default `0.7`). + + + + Nucleus sampling top-p 0..1 (default `0.9`). + + + + Bedrock voice id (default `"matthew"`). + + +## Methods + + + + + + Convenience: create with a name (other fields keep defaults). + + + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 39. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-options/with-name.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-options/with-name.mdx new file mode 100644 index 0000000000..5304c2f245 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/bedrock-options/with-name.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock/bedrock-options/with-name" +title: "with_name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock::BedrockOptions::with_name" + parent: "signalwire::prefabs::bedrock::BedrockOptions" + module: "prefabs.bedrock" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `with_name` + +Convenience: create with a name (other fields keep defaults). + +## Signature + +```rust +fn with_name(name: &str) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 84. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/index.mdx new file mode 100644 index 0000000000..37fec4ddd6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/bedrock/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/prefabs/bedrock" +title: "bedrock" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::prefabs::bedrock" + parent: "signalwire::prefabs" + module: "prefabs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs" + visibility: "public" +--- +# `bedrock` + +Amazon Bedrock voice-to-voice agent. + +`BedrockAgent` extends \[`AgentBase`] (via composition + `Deref`) so it +shares all of AgentBase's features (prompt building, skills, tools, +post-prompt, dynamic configuration) but emits an `amazon_bedrock` +verb in the rendered SWML document instead of the standard `ai` +verb. + +Mirrors the Python `signalwire.agents.bedrock.BedrockAgent`. + +## Classes + + + + Voice-to-voice agent backed by Amazon Bedrock. + + + + Construction options for \[`BedrockAgent`]. Mirrors the keyword arguments of Python's `BedrockAgent.__init__`. + + + +## Source + +[`src/prefabs/bedrock.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/bedrock.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/agent-mut.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/agent-mut.mdx new file mode 100644 index 0000000000..248db927a0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/agent-mut.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/concierge/concierge-agent/agent-mut" +title: "agent_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::concierge::ConciergeAgent::agent_mut" + parent: "signalwire::prefabs::concierge::ConciergeAgent" + module: "prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs" + visibility: "public" +--- +# `agent_mut` + +## Signature + +```rust +fn agent_mut(&mut self) -> &mut ? +``` + +## Returns + +`&mut ?` + +## Source + +[`src/prefabs/concierge.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs) + +Line 231. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/agent.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/agent.mdx new file mode 100644 index 0000000000..11662437a0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/agent.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/concierge/concierge-agent/agent" +title: "agent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::concierge::ConciergeAgent::agent" + parent: "signalwire::prefabs::concierge::ConciergeAgent" + module: "prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs" + visibility: "public" +--- +# `agent` + +## Signature + +```rust +fn agent(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/prefabs/concierge.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs) + +Line 227. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/amenities.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/amenities.mdx new file mode 100644 index 0000000000..33d9264885 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/amenities.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/concierge/concierge-agent/amenities" +title: "amenities" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::concierge::ConciergeAgent::amenities" + parent: "signalwire::prefabs::concierge::ConciergeAgent" + module: "prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs" + visibility: "public" +--- +# `amenities` + +## Signature + +```rust +fn amenities(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/prefabs/concierge.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs) + +Line 243. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/index.mdx new file mode 100644 index 0000000000..606c373705 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/prefabs/concierge/concierge-agent" +title: "ConciergeAgent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::prefabs::concierge::ConciergeAgent" + parent: "signalwire::prefabs::concierge" + module: "prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs" + visibility: "public" +--- +# `ConciergeAgent` + +A pre-built concierge agent for venues — answers questions about services, +amenities, hours, and provides directions. + +## Signature + +```rust +struct ConciergeAgent { /* fields */ } +``` + +## Methods + + + + + + + + + + Create a new ConciergeAgent. + + + + + + + +## Source + +[`src/prefabs/concierge.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs) + +Line 10. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/new.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/new.mdx new file mode 100644 index 0000000000..99aee54ad8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/new.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/prefabs/concierge/concierge-agent/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::concierge::ConciergeAgent::new" + parent: "signalwire::prefabs::concierge::ConciergeAgent" + module: "prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs" + visibility: "public" +--- +# `new` + +Create a new ConciergeAgent. + +## Signature + +```rust +fn new(name: &str, venue_info: &?, route: ?<&str>) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/prefabs/concierge.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/services.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/services.mdx new file mode 100644 index 0000000000..ab3b1c0c0e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/services.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/concierge/concierge-agent/services" +title: "services" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::concierge::ConciergeAgent::services" + parent: "signalwire::prefabs::concierge::ConciergeAgent" + module: "prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs" + visibility: "public" +--- +# `services` + +## Signature + +```rust +fn services(&self) -> &[?] +``` + +## Returns + +`&[?]` + +## Source + +[`src/prefabs/concierge.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs) + +Line 239. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/venue-name.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/venue-name.mdx new file mode 100644 index 0000000000..4bf692cfa2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/concierge-agent/venue-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/concierge/concierge-agent/venue-name" +title: "venue_name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::concierge::ConciergeAgent::venue_name" + parent: "signalwire::prefabs::concierge::ConciergeAgent" + module: "prefabs.concierge" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs" + visibility: "public" +--- +# `venue_name` + +## Signature + +```rust +fn venue_name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/prefabs/concierge.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs) + +Line 235. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/index.mdx new file mode 100644 index 0000000000..19a588a753 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/concierge/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/prefabs/concierge" +title: "concierge" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::prefabs::concierge" + parent: "signalwire::prefabs" + module: "prefabs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs" + visibility: "public" +--- +# `concierge` + +## Classes + + + + A pre-built concierge agent for venues — answers questions about services, amenities, hours, and provides directions. + + + +## Source + +[`src/prefabs/concierge.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/concierge.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/agent-mut.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/agent-mut.mdx new file mode 100644 index 0000000000..9d1260b20d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/agent-mut.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/agent-mut" +title: "agent_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::faq_bot::FAQBotAgent::agent_mut" + parent: "signalwire::prefabs::faq_bot::FAQBotAgent" + module: "prefabs.faq_bot" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs" + visibility: "public" +--- +# `agent_mut` + +## Signature + +```rust +fn agent_mut(&mut self) -> &mut ? +``` + +## Returns + +`&mut ?` + +## Source + +[`src/prefabs/faq_bot.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs) + +Line 176. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/agent.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/agent.mdx new file mode 100644 index 0000000000..e21b75dd78 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/agent.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/agent" +title: "agent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::faq_bot::FAQBotAgent::agent" + parent: "signalwire::prefabs::faq_bot::FAQBotAgent" + module: "prefabs.faq_bot" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs" + visibility: "public" +--- +# `agent` + +## Signature + +```rust +fn agent(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/prefabs/faq_bot.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs) + +Line 172. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/faqs.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/faqs.mdx new file mode 100644 index 0000000000..b7d1781d4b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/faqs.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/faqs" +title: "faqs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::faq_bot::FAQBotAgent::faqs" + parent: "signalwire::prefabs::faq_bot::FAQBotAgent" + module: "prefabs.faq_bot" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs" + visibility: "public" +--- +# `faqs` + +## Signature + +```rust +fn faqs(&self) -> &[?] +``` + +## Returns + +`&[?]` + +## Source + +[`src/prefabs/faq_bot.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs) + +Line 180. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/index.mdx new file mode 100644 index 0000000000..060e6a946b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent" +title: "FAQBotAgent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::prefabs::faq_bot::FAQBotAgent" + parent: "signalwire::prefabs::faq_bot" + module: "prefabs.faq_bot" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs" + visibility: "public" +--- +# `FAQBotAgent` + +A pre-built FAQ bot agent that provides answers from a knowledge base. + +## Signature + +```rust +struct FAQBotAgent { /* fields */ } +``` + +## Methods + + + + + + + + + + Create a new FAQBotAgent. + + + + + +## Source + +[`src/prefabs/faq_bot.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/new.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/new.mdx new file mode 100644 index 0000000000..7c885b22fb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/new.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::faq_bot::FAQBotAgent::new" + parent: "signalwire::prefabs::faq_bot::FAQBotAgent" + module: "prefabs.faq_bot" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs" + visibility: "public" +--- +# `new` + +Create a new FAQBotAgent. + +## Signature + +```rust +fn new( + name: &str, + faqs: ?, + suggest_related: bool, + persona: ?<&str>, + route: ?<&str> +) -> Self +``` + +## Parameters + + + + + + + + + + + +## Returns + +`Self` + +## Source + +[`src/prefabs/faq_bot.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs) + +Line 22. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/suggest-related.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/suggest-related.mdx new file mode 100644 index 0000000000..e670e4341b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/suggest-related.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/faq-bot/faq-bot-agent/suggest-related" +title: "suggest_related" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::faq_bot::FAQBotAgent::suggest_related" + parent: "signalwire::prefabs::faq_bot::FAQBotAgent" + module: "prefabs.faq_bot" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs" + visibility: "public" +--- +# `suggest_related` + +## Signature + +```rust +fn suggest_related(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/prefabs/faq_bot.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs) + +Line 184. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/index.mdx new file mode 100644 index 0000000000..98b8999a9a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/faq-bot/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/prefabs/faq-bot" +title: "faq_bot" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::prefabs::faq_bot" + parent: "signalwire::prefabs" + module: "prefabs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs" + visibility: "public" +--- +# `faq_bot` + +## Classes + + + + A pre-built FAQ bot agent that provides answers from a knowledge base. + + + +## Source + +[`src/prefabs/faq_bot.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/faq_bot.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/index.mdx new file mode 100644 index 0000000000..3d276161ec --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/prefabs" +title: "prefabs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::prefabs" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/mod.rs" + visibility: "public" +--- +# `prefabs` + +## Modules + + + + Amazon Bedrock voice-to-voice agent. + + + + + + + + + + + + + +## Source + +[`src/prefabs/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/index.mdx new file mode 100644 index 0000000000..afa0669a4b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/prefabs/info-gatherer" +title: "info_gatherer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::prefabs::info_gatherer" + parent: "signalwire::prefabs" + module: "prefabs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs" + visibility: "public" +--- +# `info_gatherer` + +## Classes + + + + A pre-built agent that asks a series of questions and collects answers. + + + +## Source + +[`src/prefabs/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/agent-mut.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/agent-mut.mdx new file mode 100644 index 0000000000..d3d5374542 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/agent-mut.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/agent-mut" +title: "agent_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::info_gatherer::InfoGathererAgent::agent_mut" + parent: "signalwire::prefabs::info_gatherer::InfoGathererAgent" + module: "prefabs.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs" + visibility: "public" +--- +# `agent_mut` + +Access the underlying `AgentBase` mutably. + +## Signature + +```rust +fn agent_mut(&mut self) -> &mut ? +``` + +## Returns + +`&mut ?` + +## Source + +[`src/prefabs/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs) + +Line 101. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/agent.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/agent.mdx new file mode 100644 index 0000000000..8f68db318b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/agent.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/agent" +title: "agent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::info_gatherer::InfoGathererAgent::agent" + parent: "signalwire::prefabs::info_gatherer::InfoGathererAgent" + module: "prefabs.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs" + visibility: "public" +--- +# `agent` + +Access the underlying `AgentBase`. + +## Signature + +```rust +fn agent(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/prefabs/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs) + +Line 96. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/index.mdx new file mode 100644 index 0000000000..61b74dd1a1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent" +title: "InfoGathererAgent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::prefabs::info_gatherer::InfoGathererAgent" + parent: "signalwire::prefabs::info_gatherer" + module: "prefabs.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs" + visibility: "public" +--- +# `InfoGathererAgent` + +A pre-built agent that asks a series of questions and collects answers. + +## Signature + +```rust +struct InfoGathererAgent { /* fields */ } +``` + +## Methods + + + + Access the underlying `AgentBase`. + + + + Access the underlying `AgentBase` mutably. + + + + Create a new InfoGathererAgent. + + + + Get the configured questions. + + + +## Source + +[`src/prefabs/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/new.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/new.mdx new file mode 100644 index 0000000000..d103bd5f12 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/new.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::info_gatherer::InfoGathererAgent::new" + parent: "signalwire::prefabs::info_gatherer::InfoGathererAgent" + module: "prefabs.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs" + visibility: "public" +--- +# `new` + +Create a new InfoGathererAgent. + +## Signature + +```rust +fn new(name: &str, questions: ?, route: ?<&str>) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/prefabs/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs) + +Line 19. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/questions.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/questions.mdx new file mode 100644 index 0000000000..7922094ae4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/questions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/prefabs/info-gatherer/info-gatherer-agent/questions" +title: "questions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::info_gatherer::InfoGathererAgent::questions" + parent: "signalwire::prefabs::info_gatherer::InfoGathererAgent" + module: "prefabs.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs" + visibility: "public" +--- +# `questions` + +Get the configured questions. + +## Signature + +```rust +fn questions(&self) -> &[?] +``` + +## Returns + +`&[?]` + +## Source + +[`src/prefabs/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/info_gatherer.rs) + +Line 106. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/index.mdx new file mode 100644 index 0000000000..217597211f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/prefabs/receptionist" +title: "receptionist" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::prefabs::receptionist" + parent: "signalwire::prefabs" + module: "prefabs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs" + visibility: "public" +--- +# `receptionist` + +## Classes + + + + A pre-built receptionist agent that routes callers to departments. + + + +## Source + +[`src/prefabs/receptionist.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/agent-mut.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/agent-mut.mdx new file mode 100644 index 0000000000..8146bda2e3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/agent-mut.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/receptionist/receptionist-agent/agent-mut" +title: "agent_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::receptionist::ReceptionistAgent::agent_mut" + parent: "signalwire::prefabs::receptionist::ReceptionistAgent" + module: "prefabs.receptionist" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs" + visibility: "public" +--- +# `agent_mut` + +## Signature + +```rust +fn agent_mut(&mut self) -> &mut ? +``` + +## Returns + +`&mut ?` + +## Source + +[`src/prefabs/receptionist.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs) + +Line 154. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/agent.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/agent.mdx new file mode 100644 index 0000000000..bb8e5f73e2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/agent.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/receptionist/receptionist-agent/agent" +title: "agent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::receptionist::ReceptionistAgent::agent" + parent: "signalwire::prefabs::receptionist::ReceptionistAgent" + module: "prefabs.receptionist" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs" + visibility: "public" +--- +# `agent` + +## Signature + +```rust +fn agent(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/prefabs/receptionist.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs) + +Line 150. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/departments.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/departments.mdx new file mode 100644 index 0000000000..022b38b41c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/departments.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/receptionist/receptionist-agent/departments" +title: "departments" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::receptionist::ReceptionistAgent::departments" + parent: "signalwire::prefabs::receptionist::ReceptionistAgent" + module: "prefabs.receptionist" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs" + visibility: "public" +--- +# `departments` + +## Signature + +```rust +fn departments(&self) -> &[?] +``` + +## Returns + +`&[?]` + +## Source + +[`src/prefabs/receptionist.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs) + +Line 158. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/greeting.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/greeting.mdx new file mode 100644 index 0000000000..e57d8a4884 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/greeting.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/receptionist/receptionist-agent/greeting" +title: "greeting" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::receptionist::ReceptionistAgent::greeting" + parent: "signalwire::prefabs::receptionist::ReceptionistAgent" + module: "prefabs.receptionist" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs" + visibility: "public" +--- +# `greeting` + +## Signature + +```rust +fn greeting(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/prefabs/receptionist.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs) + +Line 162. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/index.mdx new file mode 100644 index 0000000000..f7a1521d99 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/prefabs/receptionist/receptionist-agent" +title: "ReceptionistAgent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::prefabs::receptionist::ReceptionistAgent" + parent: "signalwire::prefabs::receptionist" + module: "prefabs.receptionist" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs" + visibility: "public" +--- +# `ReceptionistAgent` + +A pre-built receptionist agent that routes callers to departments. + +## Signature + +```rust +struct ReceptionistAgent { /* fields */ } +``` + +## Methods + + + + + + + + + + + + Create a new ReceptionistAgent. + + + +## Source + +[`src/prefabs/receptionist.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/new.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/new.mdx new file mode 100644 index 0000000000..e921fe16f8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/receptionist/receptionist-agent/new.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/prefabs/receptionist/receptionist-agent/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::receptionist::ReceptionistAgent::new" + parent: "signalwire::prefabs::receptionist::ReceptionistAgent" + module: "prefabs.receptionist" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs" + visibility: "public" +--- +# `new` + +Create a new ReceptionistAgent. + +## Signature + +```rust +fn new(name: &str, departments: ?, greeting: ?<&str>, route: ?<&str>) -> Self +``` + +## Parameters + + + + + + + + + +## Returns + +`Self` + +## Source + +[`src/prefabs/receptionist.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/receptionist.rs) + +Line 21. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/survey/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/index.mdx new file mode 100644 index 0000000000..344d49fae8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/prefabs/survey" +title: "survey" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::prefabs::survey" + parent: "signalwire::prefabs" + module: "prefabs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs" + visibility: "public" +--- +# `survey` + +## Classes + + + + A pre-built agent for conducting surveys with typed question validation. + + + +## Source + +[`src/prefabs/survey.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/agent-mut.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/agent-mut.mdx new file mode 100644 index 0000000000..cfa701bf08 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/agent-mut.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/survey/survey-agent/agent-mut" +title: "agent_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::survey::SurveyAgent::agent_mut" + parent: "signalwire::prefabs::survey::SurveyAgent" + module: "prefabs.survey" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs" + visibility: "public" +--- +# `agent_mut` + +## Signature + +```rust +fn agent_mut(&mut self) -> &mut ? +``` + +## Returns + +`&mut ?` + +## Source + +[`src/prefabs/survey.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs) + +Line 244. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/agent.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/agent.mdx new file mode 100644 index 0000000000..aef23e6e74 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/agent.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/survey/survey-agent/agent" +title: "agent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::survey::SurveyAgent::agent" + parent: "signalwire::prefabs::survey::SurveyAgent" + module: "prefabs.survey" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs" + visibility: "public" +--- +# `agent` + +## Signature + +```rust +fn agent(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/prefabs/survey.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs) + +Line 240. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/index.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/index.mdx new file mode 100644 index 0000000000..084dfad3eb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/prefabs/survey/survey-agent" +title: "SurveyAgent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::prefabs::survey::SurveyAgent" + parent: "signalwire::prefabs::survey" + module: "prefabs.survey" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs" + visibility: "public" +--- +# `SurveyAgent` + +A pre-built agent for conducting surveys with typed question validation. + +## Signature + +```rust +struct SurveyAgent { /* fields */ } +``` + +## Methods + + + + + + + + Create a new SurveyAgent. + + + + + + + +## Source + +[`src/prefabs/survey.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/new.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/new.mdx new file mode 100644 index 0000000000..187dc9c96e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/new.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/prefabs/survey/survey-agent/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::survey::SurveyAgent::new" + parent: "signalwire::prefabs::survey::SurveyAgent" + module: "prefabs.survey" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs" + visibility: "public" +--- +# `new` + +Create a new SurveyAgent. + +## Signature + +```rust +fn new(name: &str, questions: ?, options: ?<&?>) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/prefabs/survey.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs) + +Line 21. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/survey-name.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/survey-name.mdx new file mode 100644 index 0000000000..47a674c075 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/survey-name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/survey/survey-agent/survey-name" +title: "survey_name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::survey::SurveyAgent::survey_name" + parent: "signalwire::prefabs::survey::SurveyAgent" + module: "prefabs.survey" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs" + visibility: "public" +--- +# `survey_name` + +## Signature + +```rust +fn survey_name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/prefabs/survey.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs) + +Line 248. diff --git a/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/survey-questions.mdx b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/survey-questions.mdx new file mode 100644 index 0000000000..9682c7d892 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/prefabs/survey/survey-agent/survey-questions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/prefabs/survey/survey-agent/survey-questions" +title: "survey_questions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::prefabs::survey::SurveyAgent::survey_questions" + parent: "signalwire::prefabs::survey::SurveyAgent" + module: "prefabs.survey" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs" + visibility: "public" +--- +# `survey_questions` + +## Signature + +```rust +fn survey_questions(&self) -> &[?] +``` + +## Returns + +`&[?]` + +## Source + +[`src/prefabs/survey.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/prefabs/survey.rs) + +Line 252. diff --git a/fern/products/sdk-reference/rust/signalwire/register-skill.mdx b/fern/products/sdk-reference/rust/signalwire/register-skill.mdx new file mode 100644 index 0000000000..1528bf1660 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/register-skill.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/register-skill" +title: "register_skill" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::register_skill" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs" + visibility: "public" +--- +# `register_skill` + +Register a custom skill class. + +Mirrors Python's `signalwire.register_skill(skill_class)`. Python's +`skill_class` carries both the name (via `SKILL_NAME` attribute) and +the factory (via the class itself); Rust packages the same pair as +a \[`SkillSpec`] tuple — the canonical "skill class" descriptor in +Rust. + +## Signature + +```rust +fn register_skill(skill_class: ?) +``` + +## Parameters + + + A \[`SkillSpec`] describing the skill's name and factory function. To preserve the older two-argument call style, \[`SkillRegistry::register_skill`] remains available as `signalwire::skills::SkillRegistry::register_skill(name, factory)`. + + +## Source + +[`src/lib.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs) + +Line 123. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/call-id.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/call-id.mdx new file mode 100644 index 0000000000..a357e59469 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/call-id" +title: "call_id" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::call_id" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `call_id` + +## Signature + +```rust +fn call_id(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 75. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/control-id.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/control-id.mdx new file mode 100644 index 0000000000..1bda1ee929 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/control-id" +title: "control_id" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::control_id" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `control_id` + +## Signature + +```rust +fn control_id(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 71. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/events.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/events.mdx new file mode 100644 index 0000000000..629c40cb57 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/events.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/events" +title: "events" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::events" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `events` + +## Signature + +```rust +fn events(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 99. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/execute-subcommand.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/execute-subcommand.mdx new file mode 100644 index 0000000000..f2de49b127 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/execute-subcommand.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/execute-subcommand" +title: "execute_subcommand" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::execute_subcommand" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `execute_subcommand` + +Send a sub-command RPC through the client. + +## Signature + +```rust +fn execute_subcommand(&self, method: &str, extra: ?) +``` + +## Parameters + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 199. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/handle-event.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/handle-event.mdx new file mode 100644 index 0000000000..ba05f0b89b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/handle-event.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/handle-event" +title: "handle_event" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::handle_event" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `handle_event` + +Append an incoming event and update local state / payload. +Subclasses override `should_handle_event` to filter. + +## Signature + +```rust +fn handle_event(&self, event: &?) +``` + +## Parameters + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 139. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/index.mdx new file mode 100644 index 0000000000..2c1e992641 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/index.mdx @@ -0,0 +1,84 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action" +title: "Action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::action::Action" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `Action` + +Base class for all RELAY call actions (play, record, collect, etc.). + +An Action is the client-side handle returned when you start an +asynchronous operation on a call. It accumulates events, tracks +state, and resolves once the operation reaches a terminal state. + +## Signature + +```rust +struct Action { /* fields */ } +``` + +## Methods + + + + + + + + + + Send a sub-command RPC through the client. + + + + Append an incoming event and update local state / payload. Subclasses override `should_handle_event` to filter. + + + + + + + + + + Register a callback to fire when the action completes. If the action is already done, the callback fires immediately. + + + + + + Mark this action as completed. + + + + + + Install a channel sender so that `wait_sync()` can block until the action resolves. + + + + + + Stop the running action by sending its stop sub-command. + + + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/is-done.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/is-done.mdx new file mode 100644 index 0000000000..a246d6655f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/is-done" +title: "is_done" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::is_done" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `is_done` + +## Signature + +```rust +fn is_done(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 83. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/new.mdx new file mode 100644 index 0000000000..185a73be4b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::new" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(control_id: &str, call_id: &str, node_id: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 40. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/node-id.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/node-id.mdx new file mode 100644 index 0000000000..653c2978a2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/node-id" +title: "node_id" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::node_id" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `node_id` + +## Signature + +```rust +fn node_id(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 79. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/on-completed.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/on-completed.mdx new file mode 100644 index 0000000000..df55001d49 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/on-completed.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/on-completed" +title: "on_completed" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::on_completed" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `on_completed` + +Register a callback to fire when the action completes. +If the action is already done, the callback fires immediately. + +## Signature + +```rust +fn on_completed(&self, cb: F) +``` + +## Type Parameters + + + +## Parameters + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 123. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/payload.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/payload.mdx new file mode 100644 index 0000000000..07503ec1e3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/payload.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/payload" +title: "payload" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::payload" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `payload` + +## Signature + +```rust +fn payload(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 95. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/resolve.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/resolve.mdx new file mode 100644 index 0000000000..141f53da8e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/resolve.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/resolve" +title: "resolve" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::resolve" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `resolve` + +Mark this action as completed. + +## Signature + +```rust +fn resolve(&self, result: ?) +``` + +## Parameters + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 168. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/result.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/result.mdx new file mode 100644 index 0000000000..56c116b0e0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/result" +title: "result" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::result" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `result` + +## Signature + +```rust +fn result(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 91. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/set-notify-sender.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/set-notify-sender.mdx new file mode 100644 index 0000000000..fde3c9510d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/set-notify-sender.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/set-notify-sender" +title: "set_notify_sender" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::set_notify_sender" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `set_notify_sender` + +Install a channel sender so that `wait_sync()` can block until +the action resolves. + +## Signature + +```rust +fn set_notify_sender(&self, tx: ?<()>) +``` + +## Parameters + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 113. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/state.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/state.mdx new file mode 100644 index 0000000000..9640137096 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/state" +title: "state" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::state" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `state` + +## Signature + +```rust +fn state(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 87. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/stop-method.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/stop-method.mdx new file mode 100644 index 0000000000..4dff1c8a85 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/stop-method.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/stop-method" +title: "stop_method" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::stop_method" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `stop_method` + +## Signature + +```rust +fn stop_method(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 103. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/stop.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/stop.mdx new file mode 100644 index 0000000000..daf25c3447 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/stop.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/stop" +title: "stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::stop" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `stop` + +Stop the running action by sending its stop sub-command. + +## Signature + +```rust +fn stop(&self) +``` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 192. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/action/with-stop-method.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/action/with-stop-method.mdx new file mode 100644 index 0000000000..33140443ee --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/action/with-stop-method.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/relay/action/action/with-stop-method" +title: "with_stop_method" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::Action::with_stop_method" + parent: "signalwire::relay::action::Action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `with_stop_method` + +## Signature + +```rust +fn with_stop_method( + control_id: &str, + call_id: &str, + node_id: &str, + stop_method: &str +) -> Self +``` + +## Parameters + + + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 44. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/action.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/action.mdx new file mode 100644 index 0000000000..b7450ea2ad --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/ai-action/action" +title: "action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::AIAction::action" + parent: "signalwire::relay::action::AIAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `action` + +## Signature + +```rust +fn action(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 425. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/deref.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/deref.mdx new file mode 100644 index 0000000000..98d19cf09e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/ai-action/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::AIAction::deref" + parent: "signalwire::relay::action::AIAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 425. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/index.mdx new file mode 100644 index 0000000000..6795c1b9fc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/relay/action/ai-action" +title: "AIAction" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::action::AIAction" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `AIAction` + +## Signature + +```rust +struct AIAction { /* fields */ } +``` + +## Inheritance + +**Implements:** `Deref` + +## Properties + + + +## Methods + + + + + + + + + +## Type Aliases + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 425. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/new.mdx new file mode 100644 index 0000000000..5ec8e49056 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/action/ai-action/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::AIAction::new" + parent: "signalwire::relay::action::AIAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(control_id: &str, call_id: &str, node_id: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 425. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/target.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/target.mdx new file mode 100644 index 0000000000..6710a57922 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/ai-action/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/relay/action/ai-action/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::relay::action::AIAction" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 425. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/action.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/action.mdx new file mode 100644 index 0000000000..aebc6da14b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/collect-action/action" +title: "action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::CollectAction::action" + parent: "signalwire::relay::action::CollectAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `action` + +## Signature + +```rust +fn action(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 344. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/collect-result.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/collect-result.mdx new file mode 100644 index 0000000000..e53976ec69 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/collect-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/collect-action/collect-result" +title: "collect_result" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::CollectAction::collect_result" + parent: "signalwire::relay::action::CollectAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `collect_result` + +## Signature + +```rust +fn collect_result(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 352. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/deref.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/deref.mdx new file mode 100644 index 0000000000..5eb9129e11 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/collect-action/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::CollectAction::deref" + parent: "signalwire::relay::action::CollectAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 367. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/handle-event-filtered.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/handle-event-filtered.mdx new file mode 100644 index 0000000000..6897e3b803 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/handle-event-filtered.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/action/collect-action/handle-event-filtered" +title: "handle_event_filtered" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::CollectAction::handle_event_filtered" + parent: "signalwire::relay::action::CollectAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `handle_event_filtered` + +Handle an event, silently ignoring intermediate play events. + +## Signature + +```rust +fn handle_event_filtered(&self, event: &?) +``` + +## Parameters + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 357. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/index.mdx new file mode 100644 index 0000000000..70f41942c8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/index.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/rust/signalwire/relay/action/collect-action" +title: "CollectAction" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::action::CollectAction" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `CollectAction` + +## Signature + +```rust +struct CollectAction { /* fields */ } +``` + +## Inheritance + +**Implements:** `Deref` + +## Properties + + + +## Methods + + + + + + + + + + Handle an event, silently ignoring intermediate play events. + + + + + + + +## Type Aliases + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 328. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/new.mdx new file mode 100644 index 0000000000..3b3702a8af --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/action/collect-action/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::CollectAction::new" + parent: "signalwire::relay::action::CollectAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(control_id: &str, call_id: &str, node_id: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 333. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/start-input-timers.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..83fb12661b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/start-input-timers.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/rust/signalwire/relay/action/collect-action/start-input-timers" +title: "start_input_timers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::CollectAction::start_input_timers" + parent: "signalwire::relay::action::CollectAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `start_input_timers` + +## Signature + +```rust +fn start_input_timers(&self) +``` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 348. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/target.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/target.mdx new file mode 100644 index 0000000000..51feddc8e8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/collect-action/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/relay/action/collect-action/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::relay::action::CollectAction" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 366. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/completed-callback.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/completed-callback.mdx new file mode 100644 index 0000000000..d23c9fafd1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/completed-callback.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/relay/action/completed-callback" +title: "CompletedCallback" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "signalwire::relay::action::CompletedCallback" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `CompletedCallback` + +Callback type for completion notifications. + +## Signature + +```rust +type CompletedCallback = ? +``` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 9. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/action.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/action.mdx new file mode 100644 index 0000000000..af1900a31d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/detect-action/action" +title: "action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::DetectAction::action" + parent: "signalwire::relay::action::DetectAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `action` + +## Signature + +```rust +fn action(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 374. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/deref.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/deref.mdx new file mode 100644 index 0000000000..f3b932b1cc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/detect-action/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::DetectAction::deref" + parent: "signalwire::relay::action::DetectAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 374. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/detect-result.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/detect-result.mdx new file mode 100644 index 0000000000..cc8860ed7e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/detect-result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/detect-action/detect-result" +title: "detect_result" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::DetectAction::detect_result" + parent: "signalwire::relay::action::DetectAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `detect_result` + +## Signature + +```rust +fn detect_result(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 377. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/index.mdx new file mode 100644 index 0000000000..b0b98dcf4f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/rust/signalwire/relay/action/detect-action" +title: "DetectAction" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::action::DetectAction" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `DetectAction` + +## Signature + +```rust +struct DetectAction { /* fields */ } +``` + +## Inheritance + +**Implements:** `Deref` + +## Properties + + + +## Methods + + + + + + + + + + + +## Type Aliases + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 374. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/new.mdx new file mode 100644 index 0000000000..cd6f18572e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/action/detect-action/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::DetectAction::new" + parent: "signalwire::relay::action::DetectAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(control_id: &str, call_id: &str, node_id: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 374. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/target.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/target.mdx new file mode 100644 index 0000000000..c646890ff0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/detect-action/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/relay/action/detect-action/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::relay::action::DetectAction" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 374. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/action.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/action.mdx new file mode 100644 index 0000000000..735450491e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/fax-action/action" +title: "action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::FaxAction::action" + parent: "signalwire::relay::action::FaxAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `action` + +## Signature + +```rust +fn action(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 403. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/deref.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/deref.mdx new file mode 100644 index 0000000000..762493ec54 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/fax-action/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::FaxAction::deref" + parent: "signalwire::relay::action::FaxAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 414. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/fax-type.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/fax-type.mdx new file mode 100644 index 0000000000..3bca596f93 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/fax-type.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/fax-action/fax-type" +title: "fax_type" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::FaxAction::fax_type" + parent: "signalwire::relay::action::FaxAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `fax_type` + +## Signature + +```rust +fn fax_type(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 407. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/index.mdx new file mode 100644 index 0000000000..b9249f7e0f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/rust/signalwire/relay/action/fax-action" +title: "FaxAction" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::action::FaxAction" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `FaxAction` + +## Signature + +```rust +struct FaxAction { /* fields */ } +``` + +## Inheritance + +**Implements:** `Deref` + +## Properties + + + + + +## Methods + + + + + + + + + + + +## Type Aliases + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 385. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/new.mdx new file mode 100644 index 0000000000..4a10b65960 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/new.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/relay/action/fax-action/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::FaxAction::new" + parent: "signalwire::relay::action::FaxAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(control_id: &str, call_id: &str, node_id: &str, fax_type: &str) -> Self +``` + +## Parameters + + + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 391. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/target.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/target.mdx new file mode 100644 index 0000000000..fd34b91667 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/fax-action/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/relay/action/fax-action/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::relay::action::FaxAction" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 413. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/index.mdx new file mode 100644 index 0000000000..a28154c11f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/rust/signalwire/relay/action" +title: "action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::relay::action" + parent: "signalwire::relay" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `action` + +## Type Aliases + + + + Callback type for completion notifications. + + + +## Classes + + + + Base class for all RELAY call actions (play, record, collect, etc.). + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/action.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/action.mdx new file mode 100644 index 0000000000..5dbb247186 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/pay-action/action" +title: "action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::PayAction::action" + parent: "signalwire::relay::action::PayAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `action` + +## Signature + +```rust +fn action(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 423. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/deref.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/deref.mdx new file mode 100644 index 0000000000..ec65954cfb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/pay-action/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::PayAction::deref" + parent: "signalwire::relay::action::PayAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 423. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/index.mdx new file mode 100644 index 0000000000..85f9561b5d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/relay/action/pay-action" +title: "PayAction" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::action::PayAction" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `PayAction` + +## Signature + +```rust +struct PayAction { /* fields */ } +``` + +## Inheritance + +**Implements:** `Deref` + +## Properties + + + +## Methods + + + + + + + + + +## Type Aliases + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 423. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/new.mdx new file mode 100644 index 0000000000..9c1be73062 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/action/pay-action/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::PayAction::new" + parent: "signalwire::relay::action::PayAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(control_id: &str, call_id: &str, node_id: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 423. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/target.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/target.mdx new file mode 100644 index 0000000000..23323d0570 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/pay-action/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/relay/action/pay-action/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::relay::action::PayAction" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 423. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/action.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/action.mdx new file mode 100644 index 0000000000..e03b199c22 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/play-action/action" +title: "action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::PlayAction::action" + parent: "signalwire::relay::action::PlayAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `action` + +## Signature + +```rust +fn action(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 279. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/deref.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/deref.mdx new file mode 100644 index 0000000000..f983a31d5e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/play-action/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::PlayAction::deref" + parent: "signalwire::relay::action::PlayAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 279. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/index.mdx new file mode 100644 index 0000000000..3bb24755f1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/rust/signalwire/relay/action/play-action" +title: "PlayAction" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::action::PlayAction" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `PlayAction` + +## Signature + +```rust +struct PlayAction { /* fields */ } +``` + +## Inheritance + +**Implements:** `Deref` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + +## Type Aliases + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 279. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/new.mdx new file mode 100644 index 0000000000..bc4e57d479 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/action/play-action/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::PlayAction::new" + parent: "signalwire::relay::action::PlayAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(control_id: &str, call_id: &str, node_id: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 279. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/pause.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/pause.mdx new file mode 100644 index 0000000000..ab2c91d098 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/pause.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/rust/signalwire/relay/action/play-action/pause" +title: "pause" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::PlayAction::pause" + parent: "signalwire::relay::action::PlayAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `pause` + +## Signature + +```rust +fn pause(&self) +``` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 282. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/resume.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/resume.mdx new file mode 100644 index 0000000000..dca38466c4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/resume.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/rust/signalwire/relay/action/play-action/resume" +title: "resume" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::PlayAction::resume" + parent: "signalwire::relay::action::PlayAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `resume` + +## Signature + +```rust +fn resume(&self) +``` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 286. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/target.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/target.mdx new file mode 100644 index 0000000000..e33839ea81 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/relay/action/play-action/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::relay::action::PlayAction" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 279. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/volume.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/volume.mdx new file mode 100644 index 0000000000..51bb829586 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/play-action/volume.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/play-action/volume" +title: "volume" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::PlayAction::volume" + parent: "signalwire::relay::action::PlayAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `volume` + +## Signature + +```rust +fn volume(&self, db: f64) +``` + +## Parameters + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 290. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/action.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/action.mdx new file mode 100644 index 0000000000..750c365649 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/record-action/action" +title: "action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::RecordAction::action" + parent: "signalwire::relay::action::RecordAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `action` + +## Signature + +```rust +fn action(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 299. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/deref.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/deref.mdx new file mode 100644 index 0000000000..bd90c72cd8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/record-action/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::RecordAction::deref" + parent: "signalwire::relay::action::RecordAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 299. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/duration.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/duration.mdx new file mode 100644 index 0000000000..5b3d1674d9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/duration.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/record-action/duration" +title: "duration" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::RecordAction::duration" + parent: "signalwire::relay::action::RecordAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `duration` + +## Signature + +```rust +fn duration(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 317. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/index.mdx new file mode 100644 index 0000000000..a7862a0588 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/rust/signalwire/relay/action/record-action" +title: "RecordAction" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::action::RecordAction" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `RecordAction` + +## Signature + +```rust +struct RecordAction { /* fields */ } +``` + +## Inheritance + +**Implements:** `Deref` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + + + + + +## Type Aliases + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 299. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/new.mdx new file mode 100644 index 0000000000..f1b0576ee1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/action/record-action/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::RecordAction::new" + parent: "signalwire::relay::action::RecordAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(control_id: &str, call_id: &str, node_id: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 299. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/pause.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/pause.mdx new file mode 100644 index 0000000000..13acec50f6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/pause.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/rust/signalwire/relay/action/record-action/pause" +title: "pause" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::RecordAction::pause" + parent: "signalwire::relay::action::RecordAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `pause` + +## Signature + +```rust +fn pause(&self) +``` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 302. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/resume.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/resume.mdx new file mode 100644 index 0000000000..ede4761e62 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/resume.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/rust/signalwire/relay/action/record-action/resume" +title: "resume" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::RecordAction::resume" + parent: "signalwire::relay::action::RecordAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `resume` + +## Signature + +```rust +fn resume(&self) +``` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 306. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/size.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/size.mdx new file mode 100644 index 0000000000..d35cbf7220 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/size.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/record-action/size" +title: "size" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::RecordAction::size" + parent: "signalwire::relay::action::RecordAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `size` + +## Signature + +```rust +fn size(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 321. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/target.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/target.mdx new file mode 100644 index 0000000000..91ca2fdf50 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/relay/action/record-action/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::relay::action::RecordAction" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 299. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/url.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/url.mdx new file mode 100644 index 0000000000..7770acb4bb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/record-action/url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/record-action/url" +title: "url" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::RecordAction::url" + parent: "signalwire::relay::action::RecordAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `url` + +## Signature + +```rust +fn url(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 310. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/action.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/action.mdx new file mode 100644 index 0000000000..700c8543f4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/stream-action/action" +title: "action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::StreamAction::action" + parent: "signalwire::relay::action::StreamAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `action` + +## Signature + +```rust +fn action(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 422. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/deref.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/deref.mdx new file mode 100644 index 0000000000..0537ec6805 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/stream-action/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::StreamAction::deref" + parent: "signalwire::relay::action::StreamAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 422. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/index.mdx new file mode 100644 index 0000000000..352db95c5e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/relay/action/stream-action" +title: "StreamAction" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::action::StreamAction" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `StreamAction` + +## Signature + +```rust +struct StreamAction { /* fields */ } +``` + +## Inheritance + +**Implements:** `Deref` + +## Properties + + + +## Methods + + + + + + + + + +## Type Aliases + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 422. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/new.mdx new file mode 100644 index 0000000000..76779b917d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/action/stream-action/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::StreamAction::new" + parent: "signalwire::relay::action::StreamAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(control_id: &str, call_id: &str, node_id: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 422. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/target.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/target.mdx new file mode 100644 index 0000000000..e0eb5d3e15 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/stream-action/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/relay/action/stream-action/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::relay::action::StreamAction" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 422. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/action.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/action.mdx new file mode 100644 index 0000000000..089e2e4e0a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/tap-action/action" +title: "action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::TapAction::action" + parent: "signalwire::relay::action::TapAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `action` + +## Signature + +```rust +fn action(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 421. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/deref.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/deref.mdx new file mode 100644 index 0000000000..dc7ac77436 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/tap-action/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::TapAction::deref" + parent: "signalwire::relay::action::TapAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 421. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/index.mdx new file mode 100644 index 0000000000..9b5498da5d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/relay/action/tap-action" +title: "TapAction" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::action::TapAction" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `TapAction` + +## Signature + +```rust +struct TapAction { /* fields */ } +``` + +## Inheritance + +**Implements:** `Deref` + +## Properties + + + +## Methods + + + + + + + + + +## Type Aliases + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 421. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/new.mdx new file mode 100644 index 0000000000..12d58fb33c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/action/tap-action/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::TapAction::new" + parent: "signalwire::relay::action::TapAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(control_id: &str, call_id: &str, node_id: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 421. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/target.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/target.mdx new file mode 100644 index 0000000000..cf3d1b8f0b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/tap-action/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/relay/action/tap-action/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::relay::action::TapAction" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 421. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/action.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/action.mdx new file mode 100644 index 0000000000..1f4464236a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/action.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/transcribe-action/action" +title: "action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::TranscribeAction::action" + parent: "signalwire::relay::action::TranscribeAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `action` + +## Signature + +```rust +fn action(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 424. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/deref.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/deref.mdx new file mode 100644 index 0000000000..9dd1ecea9c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/deref.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/action/transcribe-action/deref" +title: "deref" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::TranscribeAction::deref" + parent: "signalwire::relay::action::TranscribeAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `deref` + +## Signature + +```rust +fn deref(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 424. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/index.mdx new file mode 100644 index 0000000000..7006f4c95e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/relay/action/transcribe-action" +title: "TranscribeAction" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::action::TranscribeAction" + parent: "signalwire::relay::action" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `TranscribeAction` + +## Signature + +```rust +struct TranscribeAction { /* fields */ } +``` + +## Inheritance + +**Implements:** `Deref` + +## Properties + + + +## Methods + + + + + + + + + +## Type Aliases + + + + + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 424. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/new.mdx new file mode 100644 index 0000000000..9ca0f95023 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/action/transcribe-action/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::action::TranscribeAction::new" + parent: "signalwire::relay::action::TranscribeAction" + module: "relay.action" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(control_id: &str, call_id: &str, node_id: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 424. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/target.mdx b/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/target.mdx new file mode 100644 index 0000000000..ed356c45df --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/action/transcribe-action/target.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/relay/action/transcribe-action/target" +title: "Target" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Target" + parent: "signalwire::relay::action::TranscribeAction" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs" + visibility: "public" +--- +# `Target` + +## Source + +[`src/relay/action.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/action.rs) + +Line 424. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call-event-callback.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call-event-callback.mdx new file mode 100644 index 0000000000..8b581d791d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call-event-callback.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call-event-callback" +title: "CallEventCallback" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "signalwire::relay::call::CallEventCallback" + parent: "signalwire::relay::call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `CallEventCallback` + +Callback type for call-level event listeners. + +## Signature + +```rust +type CallEventCallback = ? +``` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai-hold.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai-hold.mdx new file mode 100644 index 0000000000..21816307d4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai-hold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/ai-hold" +title: "ai_hold" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::ai_hold" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `ai_hold` + +## Signature + +```rust +fn ai_hold(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 272. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai-message.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai-message.mdx new file mode 100644 index 0000000000..d91548bd82 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/ai-message" +title: "ai_message" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::ai_message" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `ai_message` + +## Signature + +```rust +fn ai_message(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 268. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai-unhold.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai-unhold.mdx new file mode 100644 index 0000000000..a9b2293511 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai-unhold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/ai-unhold" +title: "ai_unhold" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::ai_unhold" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `ai_unhold` + +## Signature + +```rust +fn ai_unhold(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 276. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai.mdx new file mode 100644 index 0000000000..ce6c0690c4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/ai.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/ai" +title: "ai" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::ai" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `ai` + +## Signature + +```rust +fn ai(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 348. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/amazon-bedrock.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/amazon-bedrock.mdx new file mode 100644 index 0000000000..74af4a4ff2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/amazon-bedrock.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/amazon-bedrock" +title: "amazon_bedrock" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::amazon_bedrock" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `amazon_bedrock` + +## Signature + +```rust +fn amazon_bedrock(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 264. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/answer.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/answer.mdx new file mode 100644 index 0000000000..a9f5109d0c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/answer.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/answer" +title: "answer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::answer" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `answer` + +## Signature + +```rust +fn answer(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 188. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/bind-digit.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/bind-digit.mdx new file mode 100644 index 0000000000..15302828ca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/bind-digit.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/bind-digit" +title: "bind_digit" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::bind_digit" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `bind_digit` + +## Signature + +```rust +fn bind_digit(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 240. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/clear-digit-bindings.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/clear-digit-bindings.mdx new file mode 100644 index 0000000000..ff5c324dcc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/clear-digit-bindings.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/clear-digit-bindings" +title: "clear_digit_bindings" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::clear_digit_bindings" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `clear_digit_bindings` + +## Signature + +```rust +fn clear_digit_bindings(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 244. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/collect.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/collect.mdx new file mode 100644 index 0000000000..1abe98136a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/collect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/collect" +title: "collect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::collect" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `collect` + +## Signature + +```rust +fn collect(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 312. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/connect.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/connect.mdx new file mode 100644 index 0000000000..7573d7a351 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/connect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/connect" +title: "connect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::connect" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `connect` + +## Signature + +```rust +fn connect(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 200. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/current-state.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/current-state.mdx new file mode 100644 index 0000000000..4cf23fa8d6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/current-state.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/current-state" +title: "current_state" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::current_state" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `current_state` + +Current call state. + +## Signature + +```rust +fn current_state(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 88. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/denoise-stop.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/denoise-stop.mdx new file mode 100644 index 0000000000..8fe4e7e846 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/denoise-stop.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/denoise-stop" +title: "denoise_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::denoise_stop" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `denoise_stop` + +## Signature + +```rust +fn denoise_stop(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 220. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/denoise.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/denoise.mdx new file mode 100644 index 0000000000..ad516feee9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/denoise.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/denoise" +title: "denoise" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::denoise" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `denoise` + +## Signature + +```rust +fn denoise(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 216. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/detect.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/detect.mdx new file mode 100644 index 0000000000..af3a72aab3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/detect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/detect" +title: "detect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::detect" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `detect` + +## Signature + +```rust +fn detect(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 320. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/disconnect.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/disconnect.mdx new file mode 100644 index 0000000000..c25eb1edf2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/disconnect.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/disconnect" +title: "disconnect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::disconnect" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `disconnect` + +## Signature + +```rust +fn disconnect(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 204. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/dispatch-event.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/dispatch-event.mdx new file mode 100644 index 0000000000..07448535fb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/dispatch-event.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/dispatch-event" +title: "dispatch_event" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::dispatch_event" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `dispatch_event` + +Central event router invoked by the Client whenever a server event +targets this call. + +## Signature + +```rust +fn dispatch_event(&self, event: &?) +``` + +## Parameters + + + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 108. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/echo-call.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/echo-call.mdx new file mode 100644 index 0000000000..48b4739b5a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/echo-call.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/echo-call" +title: "echo_call" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::echo_call" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `echo_call` + +## Signature + +```rust +fn echo_call(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 236. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/hangup.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/hangup.mdx new file mode 100644 index 0000000000..92aa1188eb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/hangup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/hangup" +title: "hangup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::hangup" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `hangup` + +## Signature + +```rust +fn hangup(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 192. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/hold.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/hold.mdx new file mode 100644 index 0000000000..5bdb422b2f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/hold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/hold" +title: "hold" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::hold" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `hold` + +## Signature + +```rust +fn hold(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 208. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/index.mdx new file mode 100644 index 0000000000..436b084a96 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/index.mdx @@ -0,0 +1,166 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call" +title: "Call" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::call::Call" + parent: "signalwire::relay::call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `Call` + +Represents a RELAY voice call. + +Holds call-level state, dispatches server events to registered listeners +and to in-flight Action objects, and exposes every calling.\* RPC method +as a first-class Rust method. + +## Signature + +```rust +struct Call { /* fields */ } +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + Current call state. + + + + + + + + + + + + Central event router invoked by the Client whenever a server event targets this call. + + + + + + + + + + + + + + + + + + + + + + Construct a Call from a server params object. + + + + Register a generic event listener on this call. + + + + + + + + + + + + + + + + + + + + + + Python-style `__repr__` (mirrors `Call.__repr__` in the signalwire-python reference). Returns a string of the form `Call(call_id=..., state=...)`. + + + + Mark every outstanding action as completed. + + + + + + + + + + + + + + + + + + + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 19. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/join-conference.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/join-conference.mdx new file mode 100644 index 0000000000..9c5527d038 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/join-conference.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/join-conference" +title: "join_conference" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::join_conference" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `join_conference` + +## Signature + +```rust +fn join_conference(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 228. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/join-room.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/join-room.mdx new file mode 100644 index 0000000000..f121ba13f6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/join-room.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/join-room" +title: "join_room" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::join_room" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `join_room` + +## Signature + +```rust +fn join_room(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 256. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/leave-conference.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/leave-conference.mdx new file mode 100644 index 0000000000..3e50e8c160 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/leave-conference.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/leave-conference" +title: "leave_conference" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::leave_conference" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `leave_conference` + +## Signature + +```rust +fn leave_conference(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 232. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/leave-room.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/leave-room.mdx new file mode 100644 index 0000000000..1b698d694e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/leave-room.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/leave-room" +title: "leave_room" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::leave_room" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `leave_room` + +## Signature + +```rust +fn leave_room(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 260. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/live-transcribe.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/live-transcribe.mdx new file mode 100644 index 0000000000..f9e69fe0a3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/live-transcribe.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/live-transcribe" +title: "live_transcribe" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::live_transcribe" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `live_transcribe` + +## Signature + +```rust +fn live_transcribe(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 248. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/live-translate.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/live-translate.mdx new file mode 100644 index 0000000000..f1d0bb8f50 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/live-translate.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/live-translate" +title: "live_translate" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::live_translate" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `live_translate` + +## Signature + +```rust +fn live_translate(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 252. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/new.mdx new file mode 100644 index 0000000000..cc8c8356e9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::new" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `new` + +Construct a Call from a server params object. + +## Signature + +```rust +fn new(params: &?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 47. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/on.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/on.mdx new file mode 100644 index 0000000000..a7bb7c0376 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/on.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/on" +title: "on" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::on" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `on` + +Register a generic event listener on this call. + +## Signature + +```rust +fn on(&self, cb: F) +``` + +## Type Parameters + + + +## Parameters + + + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 169. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/pass.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/pass.mdx new file mode 100644 index 0000000000..f6a96ba3f2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/pass.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/pass" +title: "pass" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::pass" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `pass` + +## Signature + +```rust +fn pass(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 196. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/pay.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/pay.mdx new file mode 100644 index 0000000000..d6245d0925 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/pay.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/pay" +title: "pay" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::pay" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `pay` + +## Signature + +```rust +fn pay(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 340. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/play-and-collect.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/play-and-collect.mdx new file mode 100644 index 0000000000..1a80ec1b75 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/play-and-collect.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/play-and-collect" +title: "play_and_collect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::play_and_collect" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `play_and_collect` + +## Signature + +```rust +fn play_and_collect(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 316. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/play.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/play.mdx new file mode 100644 index 0000000000..b8dd9a5736 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/play.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/play" +title: "play" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::play" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `play` + +## Signature + +```rust +fn play(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 304. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/queue-enter.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/queue-enter.mdx new file mode 100644 index 0000000000..cbf7c90b59 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/queue-enter.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/queue-enter" +title: "queue_enter" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::queue_enter" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `queue_enter` + +## Signature + +```rust +fn queue_enter(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 284. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/queue-leave.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/queue-leave.mdx new file mode 100644 index 0000000000..4e4f7c031f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/queue-leave.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/queue-leave" +title: "queue_leave" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::queue_leave" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `queue_leave` + +## Signature + +```rust +fn queue_leave(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 288. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/receive-fax.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/receive-fax.mdx new file mode 100644 index 0000000000..6467bdb137 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/receive-fax.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/receive-fax" +title: "receive_fax" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::receive_fax" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `receive_fax` + +## Signature + +```rust +fn receive_fax(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 328. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/record.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/record.mdx new file mode 100644 index 0000000000..9a77310803 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/record.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/record" +title: "record" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::record" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `record` + +## Signature + +```rust +fn record(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 308. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/refer-call.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/refer-call.mdx new file mode 100644 index 0000000000..c6df69ba5e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/refer-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/refer-call" +title: "refer_call" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::refer_call" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `refer_call` + +## Signature + +```rust +fn refer_call(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 292. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/repr.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/repr.mdx new file mode 100644 index 0000000000..5395d82ad7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/repr.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/repr" +title: "repr" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::repr" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `repr` + +Python-style `__repr__` (mirrors `Call.__repr__` in the +signalwire-python reference). Returns a string of the form +`Call(call_id=..., state=...)`. + +## Signature + +```rust +fn repr(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 95. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/resolve-all-actions.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/resolve-all-actions.mdx new file mode 100644 index 0000000000..4ac2c027ea --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/resolve-all-actions.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/resolve-all-actions" +title: "resolve_all_actions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::resolve_all_actions" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `resolve_all_actions` + +Mark every outstanding action as completed. + +## Signature + +```rust +fn resolve_all_actions(&self) +``` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 177. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/send-digits.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/send-digits.mdx new file mode 100644 index 0000000000..ce86fc6263 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/send-digits.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/send-digits" +title: "send_digits" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::send_digits" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `send_digits` + +## Signature + +```rust +fn send_digits(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 296. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/send-fax.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/send-fax.mdx new file mode 100644 index 0000000000..21f6d3d11b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/send-fax.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/send-fax" +title: "send_fax" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::send_fax" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `send_fax` + +## Signature + +```rust +fn send_fax(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 324. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/stream.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/stream.mdx new file mode 100644 index 0000000000..c7888fc591 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/stream.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/stream" +title: "stream" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::stream" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `stream` + +## Signature + +```rust +fn stream(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 336. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/tap.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/tap.mdx new file mode 100644 index 0000000000..7f084f3380 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/tap.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/tap" +title: "tap" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::tap" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `tap` + +## Signature + +```rust +fn tap(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 332. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/transcribe.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/transcribe.mdx new file mode 100644 index 0000000000..8a15a2c759 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/transcribe.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/transcribe" +title: "transcribe" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::transcribe" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `transcribe` + +## Signature + +```rust +fn transcribe(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 344. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/transfer.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/transfer.mdx new file mode 100644 index 0000000000..673517fbff --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/transfer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/transfer" +title: "transfer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::transfer" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `transfer` + +## Signature + +```rust +fn transfer(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 224. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/unhold.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/unhold.mdx new file mode 100644 index 0000000000..8397c3bab0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/unhold.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/unhold" +title: "unhold" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::unhold" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `unhold` + +## Signature + +```rust +fn unhold(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 212. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/call/user-event.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/call/user-event.mdx new file mode 100644 index 0000000000..331d32abff --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/call/user-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/call/call/user-event" +title: "user_event" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::call::Call::user_event" + parent: "signalwire::relay::call::Call" + module: "relay.call" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `user_event` + +## Signature + +```rust +fn user_event(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 280. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/call/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/call/index.mdx new file mode 100644 index 0000000000..9ac83d7eee --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/call/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/call" +title: "call" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::relay::call" + parent: "signalwire::relay" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs" + visibility: "public" +--- +# `call` + +## Type Aliases + + + + Callback type for call-level event listeners. + + + +## Classes + + + + Represents a RELAY voice call. + + + +## Source + +[`src/relay/call.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/call.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/authenticate-blocking.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/authenticate-blocking.mdx new file mode 100644 index 0000000000..df01478a00 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/authenticate-blocking.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/authenticate-blocking" +title: "authenticate_blocking" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::authenticate_blocking" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `authenticate_blocking` + +Send the `signalwire.connect` RPC and block until the response +arrives or the handshake times out. The response carries the +server-assigned protocol string and authorization state. + +## Signature + +```rust +fn authenticate_blocking(&self) -> ?<(), ?> +``` + +## Returns + +`?<(), ?>` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 244. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/authenticate.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/authenticate.mdx new file mode 100644 index 0000000000..cc8da6a6bc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/authenticate.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/authenticate" +title: "authenticate" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::authenticate" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `authenticate` + +Backwards-compat: enqueue the `signalwire.connect` frame without +waiting. Used by older tests that drive `handle_message` directly. +Production code should call \[`connect`] which runs the full +handshake. + +## Signature + +```rust +fn authenticate(&self) +``` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 357. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/bump-reconnect-delay.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/bump-reconnect-delay.mdx new file mode 100644 index 0000000000..e61464bf2d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/bump-reconnect-delay.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/bump-reconnect-delay" +title: "bump_reconnect_delay" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::bump_reconnect_delay" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `bump_reconnect_delay` + +Compute the next reconnect delay (1s → 2s → 4s → … → 30s) and +return the value to wait _this_ time. Mirrors Python's +`RECONNECT_MIN_DELAY` / `RECONNECT_MAX_DELAY` / backoff factor. +Exposed (and tested) separately from \[`reconnect`] so the math +is verifiable without opening a real socket. + +## Signature + +```rust +fn bump_reconnect_delay(&self) -> u64 +``` + +## Returns + +`u64` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 418. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/connect-fresh.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/connect-fresh.mdx new file mode 100644 index 0000000000..74ef7f7538 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/connect-fresh.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/connect-fresh" +title: "connect_fresh" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::connect_fresh" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `connect_fresh` + +Initial connect -- resets reconnect delay and connects. + +## Signature + +```rust +fn connect_fresh(&self) -> ?<(), ?> +``` + +## Returns + +`?<(), ?>` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 236. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/connect.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/connect.mdx new file mode 100644 index 0000000000..a080e26b62 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/connect.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/connect" +title: "connect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::connect" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `connect` + +Open the WebSocket connection, run the `signalwire.connect` +handshake, subscribe to the configured contexts, and spawn the +reader thread that dispatches every inbound frame through +`handle_message`. + +Reads the WebSocket scheme from `SIGNALWIRE_RELAY_SCHEME` (defaults +to `wss`; the audit fixture sets `ws`) and the host override from +`SIGNALWIRE_RELAY_HOST` (used by the audit fixture to point at a +`127.0.0.1:N` ephemeral port). In production neither env var is +usually set and the URL resolves to `wss://{self.host}/api/relay/ws`, +matching Python's `RelayClient.connect()`. + +Returns `Err` if the TCP/WS upgrade fails, the server rejects the +connect handshake, or the response doesn't arrive within +`HANDSHAKE_TIMEOUT`. + +## Signature + +```rust +fn connect(&self) -> ?<(), ?> +``` + +## Returns + +`?<(), ?>` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 179. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/dial-blocking.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/dial-blocking.mdx new file mode 100644 index 0000000000..5f19869714 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/dial-blocking.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/dial-blocking" +title: "dial_blocking" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::dial_blocking" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `dial_blocking` + +Initiate an outbound call using `calling.dial`. + +Mirrors Python's `RelayClient.dial`. The dial response carries no +`call_id` — the actual call info arrives via subsequent +`calling.call.dial` events keyed by `tag`. This method waits for +that event up to `dial_timeout` and returns the resolved Call. + +`devices` is the standard serial/parallel device matrix +(`[[device]]` for one parallel leg / serial = one inner list with +multiple devices). + +## Signature + +```rust +fn dial_blocking( + &self, + devices: ?, + tag: ?<&str>, + max_duration: ?, + dial_timeout: ? +) -> ?, ?> +``` + +## Parameters + + + + + + + + + +## Returns + +`?, ?>` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 887. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/disconnect.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/disconnect.mdx new file mode 100644 index 0000000000..8667d13c70 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/disconnect.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/disconnect" +title: "disconnect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::disconnect" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `disconnect` + +Gracefully close the connection. Signals the reader thread to +exit, sends a WS close frame, and joins the thread. + +## Signature + +```rust +fn disconnect(&self) +``` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 381. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/execute-blocking.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/execute-blocking.mdx new file mode 100644 index 0000000000..0420ce0a80 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/execute-blocking.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/execute-blocking" +title: "execute_blocking" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::execute_blocking" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `execute_blocking` + +Send a JSON-RPC request for a calling/messaging method. + +Mirrors Python's `RelayClient._send_request`: emits a flat-Blade +frame `{"method": , "params": }` directly — no +`signalwire.execute` wrapper. Both forms are accepted by the +production RELAY server and the mock; the flat form is what +every existing SDK port emits because it keeps the journal +filterable by inner method name without unwrapping. + +Returns the response's `result` value on success, or an `Err` +with the server's error message on failure or timeout. + +## Signature + +```rust +fn execute_blocking(&self, method: &str, inner_params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 749. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/from-env.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/from-env.mdx new file mode 100644 index 0000000000..36aa970067 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/from-env.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/from-env" +title: "from_env" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::from_env" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `from_env` + +Create from env vars SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, SIGNALWIRE\_SPACE. + +## Signature + +```rust +fn from_env() -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 151. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/get-call.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/get-call.mdx new file mode 100644 index 0000000000..05071e5647 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/get-call.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/get-call" +title: "get_call" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::get_call" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `get_call` + +Get a call by ID. + +## Signature + +```rust +fn get_call(&self, call_id: &str) -> ?> +``` + +## Parameters + + + +## Returns + +`?>` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 697. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/get-message.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/get-message.mdx new file mode 100644 index 0000000000..dc030a2744 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/get-message.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/get-message" +title: "get_message" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::get_message" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `get_message` + +Get a message by ID. + +## Signature + +```rust +fn get_message(&self, message_id: &str) -> ?> +``` + +## Parameters + + + +## Returns + +`?>` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 702. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/handle-event.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/handle-event.mdx new file mode 100644 index 0000000000..e2eb364a8f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/handle-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/handle-event" +title: "handle_event" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::handle_event" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `handle_event` + +Route a signalwire.event payload to the appropriate handler. + +## Signature + +```rust +fn handle_event(&self, outer_params: &?) +``` + +## Parameters + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 553. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/handle-message.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/handle-message.mdx new file mode 100644 index 0000000000..44f080fc13 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/handle-message.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/handle-message" +title: "handle_message" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::handle_message" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `handle_message` + +Parse a raw JSON string from the server and route it. + +## Signature + +```rust +fn handle_message(&self, raw: &str) +``` + +## Parameters + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 498. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/index.mdx new file mode 100644 index 0000000000..48c13dc93e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/index.mdx @@ -0,0 +1,191 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client" +title: "Client" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::client::Client" + parent: "signalwire::relay::client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `Client` + +RELAY Client -- manages the WebSocket connection to SignalWire, sends +JSON-RPC requests, and dispatches inbound events to the correct Call +or Message objects. + +The transport is a real WebSocket connection over TCP (plus TLS for +`wss://`). One reader thread (spawned on `connect()`) owns the read +half and dispatches every inbound JSON-RPC frame through +`handle_message`. Writes go through `send()` which serializes the +frame and pushes it onto an mpsc channel that the reader thread +drains alongside its read loop, so all socket I/O is single- +threaded but both directions make forward progress. + +Tests still use `sent_messages` to inspect what the client _would_ +have written; `send()` mirrors every frame into that Vec whether or +not a live socket is attached. That keeps the unit tests covering +dispatch logic working without a real RELAY server. + +## Signature + +```rust +struct Client { /* fields */ } +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + Messages sent through the transport (for testing). + + + + + + +## Methods + + + + Backwards-compat: enqueue the `signalwire.connect` frame without waiting. Used by older tests that drive `handle_message` directly. Production code should call \[`connect`] which runs the full handshake. + + + + Send the `signalwire.connect` RPC and block until the response arrives or the handshake times out. The response carries the server-assigned protocol string and authorization state. + + + + Compute the next reconnect delay (1s → 2s → 4s → … → 30s) and return the value to wait _this_ time. Mirrors Python's `RECONNECT_MIN_DELAY` / `RECONNECT_MAX_DELAY` / backoff factor. Exposed (and tested) separately from \[`reconnect`] so the math is verifiable without opening a real socket. + + + + Open the WebSocket connection, run the `signalwire.connect` handshake, subscribe to the configured contexts, and spawn the reader thread that dispatches every inbound frame through `handle_message`. + + + + Initial connect -- resets reconnect delay and connects. + + + + Initiate an outbound call using `calling.dial`. + + + + Gracefully close the connection. Signals the reader thread to exit, sends a WS close frame, and joins the thread. + + + + Send a JSON-RPC request for a calling/messaging method. + + + + Create from env vars SIGNALWIRE\_PROJECT\_ID, SIGNALWIRE\_API\_TOKEN, SIGNALWIRE\_SPACE. + + + + Get a call by ID. + + + + Get a message by ID. + + + + Route a signalwire.event payload to the appropriate handler. + + + + Parse a raw JSON string from the server and route it. + + + + + + + + + + Register a handler for inbound calls. + + + + Register a generic event handler. + + + + Register a handler for inbound messages. + + + + Subscribe to one or more inbound contexts. + + + + Reconnect with exponential back-off (1s → 30s cap). Sleeps for the current delay, doubles the delay (capped at 30s), and runs the full connect handshake again. Authorization state survives across reconnects because \[`authenticate_blocking`] re-sends the stored token on the new socket. + + + + Register a pending dial. + + + + Register a pending-response slot for a request ID. + + + + Remove a pending dial. + + + + Send a raw JSON message through the transport. + + + + Send an acknowledgement for a server-initiated request. + + + + Send an outbound SMS/MMS message. + + + + Build and send a JSON-RPC request. Returns the message ID. + + + + Track a new message. + + + + Unsubscribe from one or more contexts. + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 76. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/is-connected.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/is-connected.mdx new file mode 100644 index 0000000000..482aa83041 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/is-connected.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/is-connected" +title: "is_connected" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::is_connected" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `is_connected` + +## Signature + +```rust +fn is_connected(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 425. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/is-running.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/is-running.mdx new file mode 100644 index 0000000000..10a58f0898 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/is-running.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/is-running" +title: "is_running" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::is_running" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `is_running` + +## Signature + +```rust +fn is_running(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 429. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/new.mdx new file mode 100644 index 0000000000..61fb253b17 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::new" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(project: &str, token: &str, host: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 122. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/on-call.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/on-call.mdx new file mode 100644 index 0000000000..b26374ce9d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/on-call.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/on-call" +title: "on_call" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::on_call" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `on_call` + +Register a handler for inbound calls. + +## Signature + +```rust +fn on_call, &?) + ? + ? + 'static>(&self, cb: F) +``` + +## Type Parameters + + + +## Parameters + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 682. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/on-event.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/on-event.mdx new file mode 100644 index 0000000000..5753934043 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/on-event.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/on-event" +title: "on_event" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::on_event" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `on_event` + +Register a generic event handler. + +## Signature + +```rust +fn on_event(&self, cb: F) +``` + +## Type Parameters + + + +## Parameters + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 692. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/on-message.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/on-message.mdx new file mode 100644 index 0000000000..3c5f58e063 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/on-message.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/on-message" +title: "on_message" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::on_message" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `on_message` + +Register a handler for inbound messages. + +## Signature + +```rust +fn on_message(&self, cb: F) +``` + +## Type Parameters + + + +## Parameters + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 687. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/receive.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/receive.mdx new file mode 100644 index 0000000000..7410df8249 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/receive.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/receive" +title: "receive" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::receive" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `receive` + +Subscribe to one or more inbound contexts. + +## Signature + +```rust +fn receive(&self, contexts: &[?]) +``` + +## Parameters + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 658. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/reconnect.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/reconnect.mdx new file mode 100644 index 0000000000..a942578bfa --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/reconnect.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/reconnect" +title: "reconnect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::reconnect" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `reconnect` + +Reconnect with exponential back-off (1s → 30s cap). Sleeps for +the current delay, doubles the delay (capped at 30s), and runs +the full connect handshake again. Authorization state survives +across reconnects because \[`authenticate_blocking`] re-sends the +stored token on the new socket. + +## Signature + +```rust +fn reconnect(&self) -> ?<(), ?> +``` + +## Returns + +`?<(), ?>` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 402. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/register-dial.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/register-dial.mdx new file mode 100644 index 0000000000..0af8dd595e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/register-dial.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/register-dial" +title: "register_dial" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::register_dial" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `register_dial` + +Register a pending dial. + +## Signature + +```rust +fn register_dial) + ? + 'static>(&self, tag: &str, resolve: F) +``` + +## Type Parameters + + + +## Parameters + + + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 715. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/register-pending.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/register-pending.mdx new file mode 100644 index 0000000000..27138725bd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/register-pending.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/register-pending" +title: "register_pending" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::register_pending" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `register_pending` + +Register a pending-response slot for a request ID. + +## Signature + +```rust +fn register_pending( + &self, + id: &str, + resolve: R, + reject: E +) where R: ?(?) + ? + 'static, E: ?(?) + ? + 'static +``` + +## Type Parameters + + + + + +## Parameters + + + + + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 451. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/remove-pending-dial.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/remove-pending-dial.mdx new file mode 100644 index 0000000000..4e494cbb4b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/remove-pending-dial.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/remove-pending-dial" +title: "remove_pending_dial" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::remove_pending_dial" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `remove_pending_dial` + +Remove a pending dial. + +## Signature + +```rust +fn remove_pending_dial(&self, tag: &str) +``` + +## Parameters + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 730. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/send-ack.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/send-ack.mdx new file mode 100644 index 0000000000..5f5c0c6a9c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/send-ack.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/send-ack" +title: "send_ack" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::send_ack" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `send_ack` + +Send an acknowledgement for a server-initiated request. + +## Signature + +```rust +fn send_ack(&self, id: &str) +``` + +## Parameters + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 485. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/send-message-blocking.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/send-message-blocking.mdx new file mode 100644 index 0000000000..6281f11cc9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/send-message-blocking.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/send-message-blocking" +title: "send_message_blocking" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::send_message_blocking" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `send_message_blocking` + +Send an outbound SMS/MMS message. + +Mirrors Python's `RelayClient.send_message`. At least one of +`body` or `media` must be supplied. Returns a tracked `Message` +whose state will progress as `messaging.state` events arrive +from the server. + +## Signature + +```rust +fn send_message_blocking( + &self, + to_number: &str, + from_number: &str, + body: ?<&str>, + media: ?<&[?]>, + tags: ?<&[?]>, + context: ?<&str> +) -> ?, ?> +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`?, ?>` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 802. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/send-request.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/send-request.mdx new file mode 100644 index 0000000000..d8029c5dcf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/send-request.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/send-request" +title: "send_request" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::send_request" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `send_request` + +Build and send a JSON-RPC request. Returns the message ID. + +## Signature + +```rust +fn send_request(&self, method: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 438. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/send.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/send.mdx new file mode 100644 index 0000000000..8b638d81e9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/send.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/send" +title: "send" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::send" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `send` + +Send a raw JSON message through the transport. + +Records the frame in `sent_messages` (used by tests and for debug +inspection) and, when a live socket is attached, enqueues the +frame on the writer channel so the reader thread flushes it to +the WebSocket. With no live socket attached the call is purely +in-memory — that's the path the dispatch unit tests below take. + +## Signature + +```rust +fn send(&self, msg: &?) +``` + +## Parameters + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 472. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/track-message.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/track-message.mdx new file mode 100644 index 0000000000..bed2382295 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/track-message.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/track-message" +title: "track_message" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::track_message" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `track_message` + +Track a new message. + +## Signature + +```rust +fn track_message(&self, message_id: &str, msg: ?) +``` + +## Parameters + + + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 707. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/client/unreceive.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/client/unreceive.mdx new file mode 100644 index 0000000000..42305915fe --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/client/unreceive.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/client/client/unreceive" +title: "unreceive" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::client::Client::unreceive" + parent: "signalwire::relay::client::Client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `unreceive` + +Unsubscribe from one or more contexts. + +## Signature + +```rust +fn unreceive(&self, contexts: &[?]) +``` + +## Parameters + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 672. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/index.mdx new file mode 100644 index 0000000000..fc760248e0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/relay/client" +title: "client" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::relay::client" + parent: "signalwire::relay" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `client` + +## Type Aliases + + + + Callback type for inbound call handler. + + + + Callback type for generic events. + + + + Callback type for inbound message handler. + + + +## Classes + + + + RELAY Client -- manages the WebSocket connection to SignalWire, sends JSON-RPC requests, and dispatches inbound events to the correct Call or Message objects. + + + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/on-call-handler.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/on-call-handler.mdx new file mode 100644 index 0000000000..6a3c2e33ee --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/on-call-handler.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/relay/client/on-call-handler" +title: "OnCallHandler" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "signalwire::relay::client::OnCallHandler" + parent: "signalwire::relay::client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `OnCallHandler` + +Callback type for inbound call handler. + +## Signature + +```rust +type OnCallHandler = ? +``` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 33. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/on-event-handler.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/on-event-handler.mdx new file mode 100644 index 0000000000..6b9503e766 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/on-event-handler.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/relay/client/on-event-handler" +title: "OnEventHandler" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "signalwire::relay::client::OnEventHandler" + parent: "signalwire::relay::client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `OnEventHandler` + +Callback type for generic events. + +## Signature + +```rust +type OnEventHandler = ? +``` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 39. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/client/on-message-handler.mdx b/fern/products/sdk-reference/rust/signalwire/relay/client/on-message-handler.mdx new file mode 100644 index 0000000000..50b61bf8db --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/client/on-message-handler.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/relay/client/on-message-handler" +title: "OnMessageHandler" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "signalwire::relay::client::OnMessageHandler" + parent: "signalwire::relay::client" + module: "relay.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs" + visibility: "public" +--- +# `OnMessageHandler` + +Callback type for inbound message handler. + +## Signature + +```rust +type OnMessageHandler = ? +``` + +## Source + +[`src/relay/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/client.rs) + +Line 36. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/constants/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/constants/index.mdx new file mode 100644 index 0000000000..5f2ef5755c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/constants/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/rust/signalwire/relay/constants" +title: "constants" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::relay::constants" + parent: "signalwire::relay" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/constants.rs" + visibility: "public" +--- +# `constants` + +RELAY module -- real-time event signalling over WebSocket (JSON-RPC 2.0). + +Provides constants, event/action primitives, call control, message +tracking, and the async-ready `Client` that ties everything together. + +## Constants + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + RELAY protocol constants. Mirrors the PHP `Constants` class: protocol version, call/dial/message states, terminal-state maps, and per-event-type action terminal states. Protocol version exchanged during `signalwire.connect`. + + + + + + +## Functions + + + + Returns `true` when the given `(event_type, action_state)` pair represents a terminal state for an in-flight action. + + + + Returns `true` when the call state is terminal (i.e. `"ended"`). + + + + Returns `true` when the message state is terminal. + + + +## Source + +[`src/relay/constants.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/constants.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/constants/is-action-terminal.mdx b/fern/products/sdk-reference/rust/signalwire/relay/constants/is-action-terminal.mdx new file mode 100644 index 0000000000..0e83980468 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/constants/is-action-terminal.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/relay/constants/is-action-terminal" +title: "is_action_terminal" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::relay::constants::is_action_terminal" + parent: "signalwire::relay::constants" + module: "relay.constants" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/constants.rs" + visibility: "public" +--- +# `is_action_terminal` + +Returns `true` when the given `(event_type, action_state)` pair represents +a terminal state for an in-flight action. + +## Signature + +```rust +fn is_action_terminal(event_type: &str, state: &str) -> bool +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/relay/constants.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/constants.rs) + +Line 60. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/constants/is-call-terminal.mdx b/fern/products/sdk-reference/rust/signalwire/relay/constants/is-call-terminal.mdx new file mode 100644 index 0000000000..c532d0ff21 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/constants/is-call-terminal.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/constants/is-call-terminal" +title: "is_call_terminal" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::relay::constants::is_call_terminal" + parent: "signalwire::relay::constants" + module: "relay.constants" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/constants.rs" + visibility: "public" +--- +# `is_call_terminal` + +Returns `true` when the call state is terminal (i.e. `"ended"`). + +## Signature + +```rust +fn is_call_terminal(state: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/relay/constants.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/constants.rs) + +Line 22. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/constants/is-message-terminal.mdx b/fern/products/sdk-reference/rust/signalwire/relay/constants/is-message-terminal.mdx new file mode 100644 index 0000000000..9bf3adb481 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/constants/is-message-terminal.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/constants/is-message-terminal" +title: "is_message_terminal" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::relay::constants::is_message_terminal" + parent: "signalwire::relay::constants" + module: "relay.constants" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/constants.rs" + visibility: "public" +--- +# `is_message_terminal` + +Returns `true` when the message state is terminal. + +## Signature + +```rust +fn is_message_terminal(state: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/relay/constants.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/constants.rs) + +Line 47. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/call-id.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/call-id.mdx new file mode 100644 index 0000000000..e9204ff06f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/call-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/call-id" +title: "call_id" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::call_id" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `call_id` + +## Signature + +```rust +fn call_id(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 61. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/clone.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/clone.mdx new file mode 100644 index 0000000000..8728bc121e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::clone" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/control-id.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/control-id.mdx new file mode 100644 index 0000000000..3550a7fffc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/control-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/control-id" +title: "control_id" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::control_id" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `control_id` + +## Signature + +```rust +fn control_id(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 73. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/event-type.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/event-type.mdx new file mode 100644 index 0000000000..cc28e19b9e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/event-type.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/event-type" +title: "event_type" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::event_type" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `event_type` + +## Signature + +```rust +fn event_type(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 49. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/fmt.mdx new file mode 100644 index 0000000000..67cdaebfdb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::fmt" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/index.mdx new file mode 100644 index 0000000000..b528100ed4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event" +title: "Event" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::event::Event" + parent: "signalwire::relay::event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `Event` + +A RELAY event received from the SignalWire server. + +Events carry an `event_type` (e.g. `"calling.call.state"`), a +timestamp, and a bag of string-keyed parameters. + +## Signature + +```rust +struct Event { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone` + +## Methods + + + + + + + + + + + + + + Create a new event. If `timestamp` is `0.0`, the current time is used. + + + + + + + + Convenience constructor from a `serde_json::Value` params object. + + + + + + + + + + Serialize back to a JSON-compatible map. + + + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 8. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/new.mdx new file mode 100644 index 0000000000..bb0fc92732 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/new.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::new" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `new` + +Create a new event. If `timestamp` is `0.0`, the current time is used. + +## Signature + +```rust +fn new(event_type: &str, params: ?, timestamp: f64) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 16. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/node-id.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/node-id.mdx new file mode 100644 index 0000000000..dea78eb790 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/node-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/node-id" +title: "node_id" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::node_id" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `node_id` + +## Signature + +```rust +fn node_id(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 67. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/params.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/params.mdx new file mode 100644 index 0000000000..9f40d2ce30 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::params" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 57. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/parse.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/parse.mdx new file mode 100644 index 0000000000..65e25f4719 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/parse.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/parse" +title: "parse" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::parse" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `parse` + +Convenience constructor from a `serde_json::Value` params object. + +## Signature + +```rust +fn parse(event_type: &str, params_value: &?) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 34. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/state.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/state.mdx new file mode 100644 index 0000000000..dbde3d0032 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/state" +title: "state" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::state" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `state` + +## Signature + +```rust +fn state(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 83. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/tag.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/tag.mdx new file mode 100644 index 0000000000..a33c45fd0c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/tag.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/tag" +title: "tag" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::tag" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `tag` + +## Signature + +```rust +fn tag(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 79. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/timestamp.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/timestamp.mdx new file mode 100644 index 0000000000..d66446f703 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/timestamp.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/timestamp" +title: "timestamp" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::timestamp" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `timestamp` + +## Signature + +```rust +fn timestamp(&self) -> f64 +``` + +## Returns + +`f64` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 53. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/event/to-value.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/event/to-value.mdx new file mode 100644 index 0000000000..54ae5cff85 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/event/to-value.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/event/event/to-value" +title: "to_value" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::event::Event::to_value" + parent: "signalwire::relay::event::Event" + module: "relay.event" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `to_value` + +Serialize back to a JSON-compatible map. + +## Signature + +```rust +fn to_value(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 88. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/event/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/event/index.mdx new file mode 100644 index 0000000000..0825e5e938 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/event/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/relay/event" +title: "event" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::relay::event" + parent: "signalwire::relay" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs" + visibility: "public" +--- +# `event` + +## Classes + + + + A RELAY event received from the SignalWire server. + + + +## Source + +[`src/relay/event.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/event.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/index.mdx new file mode 100644 index 0000000000..b2fd0ce350 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/relay" +title: "relay" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::relay" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/mod.rs" + visibility: "public" +--- +# `relay` + +## Modules + + + + + + + + + + RELAY module -- real-time event signalling over WebSocket (JSON-RPC 2.0). + + + + + + + +## Source + +[`src/relay/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/index.mdx new file mode 100644 index 0000000000..f09757b84d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/message" +title: "message" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::relay::message" + parent: "signalwire::relay" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `message` + +## Type Aliases + + + + Callback type for completion notifications. + + + +## Classes + + + + Represents a RELAY messaging message (SMS / MMS). + + + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message-completed-callback.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message-completed-callback.mdx new file mode 100644 index 0000000000..eb20798863 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message-completed-callback.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message-completed-callback" +title: "MessageCompletedCallback" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "signalwire::relay::message::MessageCompletedCallback" + parent: "signalwire::relay::message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `MessageCompletedCallback` + +Callback type for completion notifications. + +## Signature + +```rust +type MessageCompletedCallback = ? +``` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 9. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/body.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/body.mdx new file mode 100644 index 0000000000..f72564bdc0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/body" +title: "body" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::body" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `body` + +## Signature + +```rust +fn body(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 144. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/context.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/context.mdx new file mode 100644 index 0000000000..bd18576759 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/context.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/context" +title: "context" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::context" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `context` + +## Signature + +```rust +fn context(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 128. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/direction.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/direction.mdx new file mode 100644 index 0000000000..77e3e03f41 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/direction.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/direction" +title: "direction" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::direction" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `direction` + +## Signature + +```rust +fn direction(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 132. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/dispatch-event.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/dispatch-event.mdx new file mode 100644 index 0000000000..8ebe91158d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/dispatch-event.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/dispatch-event" +title: "dispatch_event" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::dispatch_event" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `dispatch_event` + +Process an inbound event for this message. + +## Signature + +```rust +fn dispatch_event(&self, event: &?) +``` + +## Parameters + + + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 177. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/from-number.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/from-number.mdx new file mode 100644 index 0000000000..a2e5dd17a6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/from-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/from-number" +title: "from_number" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::from_number" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `from_number` + +## Signature + +```rust +fn from_number(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 136. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/index.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/index.mdx new file mode 100644 index 0000000000..32c452c4bb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/index.mdx @@ -0,0 +1,87 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message" +title: "Message" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::relay::message::Message" + parent: "signalwire::relay::message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `Message` + +Represents a RELAY messaging message (SMS / MMS). + +A Message is created when you send or receive a message through the +RELAY messaging namespace. It accumulates state-change events and +resolves once the message reaches a terminal state (delivered, +undelivered, or failed). + +## Signature + +```rust +struct Message { /* fields */ } +``` + +## Methods + + + + + + + + + + Process an inbound event for this message. + + + + + + + + + + + + Build a Message from a params map. + + + + Register a listener that fires on every state-change event. + + + + Register a callback to fire when the message reaches a terminal state. + + + + + + Python-style `__repr__` (mirrors `Message.__repr__` in the signalwire-python reference). Returns a string of the form `Message(message_id=..., from=..., to=..., state=...)`. + + + + Mark this message as completed. + + + + + + + + + + + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 17. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/is-done.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/is-done.mdx new file mode 100644 index 0000000000..46575655eb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/is-done" +title: "is_done" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::is_done" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `is_done` + +## Signature + +```rust +fn is_done(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 164. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/media.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/media.mdx new file mode 100644 index 0000000000..9067f68d46 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/media.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/media" +title: "media" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::media" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `media` + +## Signature + +```rust +fn media(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 148. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/message-id.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/message-id.mdx new file mode 100644 index 0000000000..ed26369fea --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/message-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/message-id" +title: "message_id" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::message_id" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `message_id` + +## Signature + +```rust +fn message_id(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 114. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/new.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/new.mdx new file mode 100644 index 0000000000..14a46792d0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::new" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `new` + +Build a Message from a params map. + +## Signature + +```rust +fn new(params: &?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 37. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/on-completed.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/on-completed.mdx new file mode 100644 index 0000000000..06abc02fd2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/on-completed.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/on-completed" +title: "on_completed" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::on_completed" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `on_completed` + +Register a callback to fire when the message reaches a terminal state. + +## Signature + +```rust +fn on_completed(&self, cb: F) +``` + +## Type Parameters + + + +## Parameters + + + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 230. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/on.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/on.mdx new file mode 100644 index 0000000000..a0c1e1a288 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/on.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/on" +title: "on" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::on" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `on` + +Register a listener that fires on every state-change event. + +## Signature + +```rust +fn on(&self, cb: F) +``` + +## Type Parameters + + + +## Parameters + + + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 222. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/reason.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/reason.mdx new file mode 100644 index 0000000000..aac7aa9793 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/reason.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/reason" +title: "reason" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::reason" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `reason` + +## Signature + +```rust +fn reason(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 160. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/repr.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/repr.mdx new file mode 100644 index 0000000000..5546cfe54a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/repr.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/repr" +title: "repr" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::repr" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `repr` + +Python-style `__repr__` (mirrors `Message.__repr__` in the +signalwire-python reference). Returns a string of the form +`Message(message_id=..., from=..., to=..., state=...)`. + +## Signature + +```rust +fn repr(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 121. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/resolve.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/resolve.mdx new file mode 100644 index 0000000000..eb5366d367 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/resolve.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/resolve" +title: "resolve" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::resolve" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `resolve` + +Mark this message as completed. + +## Signature + +```rust +fn resolve(&self, result: ?) +``` + +## Parameters + + + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 243. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/result.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/result.mdx new file mode 100644 index 0000000000..166689fd13 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/result.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/result" +title: "result" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::result" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `result` + +## Signature + +```rust +fn result(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 168. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/state.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/state.mdx new file mode 100644 index 0000000000..a016660aff --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/state.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/state" +title: "state" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::state" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `state` + +## Signature + +```rust +fn state(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 156. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/tags.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/tags.mdx new file mode 100644 index 0000000000..2c8f318a1b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/tags.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/tags" +title: "tags" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::tags" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `tags` + +## Signature + +```rust +fn tags(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 152. diff --git a/fern/products/sdk-reference/rust/signalwire/relay/message/message/to-number.mdx b/fern/products/sdk-reference/rust/signalwire/relay/message/message/to-number.mdx new file mode 100644 index 0000000000..967eff13c0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/relay/message/message/to-number.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/relay/message/message/to-number" +title: "to_number" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::relay::message::Message::to_number" + parent: "signalwire::relay::message::Message" + module: "relay.message" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs" + visibility: "public" +--- +# `to_number` + +## Signature + +```rust +fn to_number(&self) -> ?<&str> +``` + +## Returns + +`?<&str>` + +## Source + +[`src/relay/message.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/relay/message.rs) + +Line 140. diff --git a/fern/products/sdk-reference/rust/signalwire/rest-client.mdx b/fern/products/sdk-reference/rust/signalwire/rest-client.mdx new file mode 100644 index 0000000000..bd830c3f3d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest-client.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/rust/signalwire/rest-client" +title: "RestClient" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::RestClient" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs" + visibility: "public" +--- +# `RestClient` + +Construct a \[`RestClient`] from positional or keyword credentials. + +Mirrors Python's top-level `signalwire.RestClient(*args, **kwargs)` +factory — in Python that's a thin wrapper that lazy-imports +`signalwire.rest.RestClient` and instantiates it. The Rust struct +is exposed at `signalwire::rest::RestClient`; this free function +provides the same one-line entry point under `signalwire::`. + +The struct re-export at `signalwire::RestClient` (a type) and this +function at `signalwire::RestClient` (a value) coexist because +they live in distinct namespaces — types and values, respectively. + +The signature mirrors Python's `(*args, **kwargs)` shape so the +cross-language signature audit recognises them as compatible. In +practice callers pass either: + +- `args = ["proj", "tok", "space"]` (three positional strings), or +- `args = []` and `kwargs = {"project": ..., "token": ..., "host": ...}` + +Either form maps onto \[`rest::RestClient::new`]. + +**Errors:** + +Returns an error string if credentials cannot be derived from either +`args` or `kwargs` (or fall back to the standard environment +variables `SIGNALWIRE_PROJECT_ID` / `SIGNALWIRE_API_TOKEN` / +`SIGNALWIRE_SPACE`). + +## Signature + +```rust +fn RestClient(args: ?, kwargs: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/lib.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs) + +Line 172. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/index.mdx new file mode 100644 index 0000000000..07d4cc241c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/rest/client" +title: "client" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::client" + parent: "signalwire::rest" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `client` + +## Classes + + + + Top-level SignalWire REST client. + + + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/addresses.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/addresses.mdx new file mode 100644 index 0000000000..d47a70d809 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/addresses.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/addresses" +title: "addresses" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::addresses" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `addresses` + +Addresses. + +## Signature + +```rust +fn addresses(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 187. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/base-url.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/base-url.mdx new file mode 100644 index 0000000000..cc1feb1a67 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/base-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/base-url" +title: "base_url" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::base_url" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `base_url` + +## Signature + +```rust +fn base_url(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 131. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/calling.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/calling.mdx new file mode 100644 index 0000000000..abfec4cfca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/calling.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/calling" +title: "calling" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::calling" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `calling` + +Calling API (37 call-control commands). + +## Signature + +```rust +fn calling(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 153. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/chat.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/chat.mdx new file mode 100644 index 0000000000..8fbfc58046 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/chat.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/chat" +title: "chat" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::chat" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `chat` + +Chat tokens. + +## Signature + +```rust +fn chat(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 258. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/compat.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/compat.mdx new file mode 100644 index 0000000000..96fc3258e2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/compat.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/compat" +title: "compat" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::compat" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `compat` + +Compatibility (Twilio-compatible LAML) API namespace. + +Returns a [`Compat`](super::namespaces::compat::Compat) handle whose +sub-resources (`calls`, `messages`, `faxes`, `phone_numbers`, +`conferences`, `recordings`, `transcriptions`, `applications`, +`laml_bins`, `queues`, `tokens`, `accounts`) cover the full Python +`client.compat.*` surface. + +## Signature + +```rust +fn compat(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 182. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/datasphere.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/datasphere.mdx new file mode 100644 index 0000000000..7c42fe06f1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/datasphere.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/datasphere" +title: "datasphere" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::datasphere" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `datasphere` + +Datasphere namespace (documents + chunks + search). + +## Signature + +```rust +fn datasphere(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 163. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/fabric.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/fabric.mdx new file mode 100644 index 0000000000..e5e19f96eb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/fabric.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/fabric" +title: "fabric" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::fabric" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `fabric` + +Fabric API (sub-resources: subscribers, sip\_endpoints, call\_flows, ...). + +## Signature + +```rust +fn fabric(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 148. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/from-env.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/from-env.mdx new file mode 100644 index 0000000000..6e0f1346ec --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/from-env.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/from-env" +title: "from_env" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::from_env" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `from_env` + +Create from environment variables. + +## Signature + +```rust +fn from_env() -> ? +``` + +## Returns + +`?` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 109. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/http.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/http.mdx new file mode 100644 index 0000000000..309e8ea26f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/http" +title: "http" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::http" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `http` + +## Signature + +```rust +fn http(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 135. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/imported-numbers.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/imported-numbers.mdx new file mode 100644 index 0000000000..9b4e114291 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/imported-numbers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/imported-numbers" +title: "imported_numbers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::imported_numbers" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `imported_numbers` + +Imported phone numbers. + +## Signature + +```rust +fn imported_numbers(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 228. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/index.mdx new file mode 100644 index 0000000000..675719bf30 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/index.mdx @@ -0,0 +1,151 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client" +title: "RestClient" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient" + parent: "signalwire::rest::client" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `RestClient` + +Top-level SignalWire REST client. + +Provides lazy access to every API namespace (fabric, calling, +phone\_numbers, datasphere, video, compat, etc.). Credentials can +be supplied explicitly or pulled from environment variables. + +Production HTTP transport is `ureq` (sync, blocking, real network +I/O). Tests can substitute a stub via \[`with_http`]. + +## Signature + +```rust +struct RestClient { /* fields */ } +``` + +## Methods + + + + Addresses. + + + + + + Calling API (37 call-control commands). + + + + Chat tokens. + + + + Compatibility (Twilio-compatible LAML) API namespace. + + + + Datasphere namespace (documents + chunks + search). + + + + Fabric API (sub-resources: subscribers, sip\_endpoints, call\_flows, ...). + + + + Create from environment variables. + + + + + + Imported phone numbers. + + + + Logs (messages, voice, fax, conferences). + + + + Phone number lookup. + + + + Multi-factor authentication (sms/call/verify). + + + + Create a new REST client with explicit credentials. The base URL resolves to `https://{space}`. Use \[`with_base_url`] to override (e.g. for fixture-driven tests pointed at `http://127.0.0.1:N`). + + + + Number groups (CRUD + membership operations). + + + + Phone numbers. + + + + Project namespace (exposes `tokens` sub-resource). + + + + + + PubSub tokens. + + + + Queues namespace (CRUD + member operations). + + + + Recordings. + + + + Registry (10DLC brands, campaigns, orders, numbers). + + + + Short codes. + + + + Project SIP profile (singular: singleton resource at `/api/relay/rest/sip_profile`). + + + + + + + + Verified callers. + + + + Video API namespace (rooms, sessions, recordings, conferences, tokens, streams). + + + + Create a REST client with an explicit base URL. Used by audit harnesses and integration tests to point at a local fixture without going through the `https://{space}` resolution. Production callers should use \[`new`] instead. + + + + Create a REST client with a specific HTTP client (for testing). + + + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 14. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/logs.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/logs.mdx new file mode 100644 index 0000000000..31df0a7da0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/logs.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/logs" +title: "logs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::logs" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `logs` + +Logs (messages, voice, fax, conferences). + +## Signature + +```rust +fn logs(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 243. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/lookup.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/lookup.mdx new file mode 100644 index 0000000000..8c4c93d152 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/lookup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/lookup" +title: "lookup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::lookup" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `lookup` + +Phone number lookup. + +## Signature + +```rust +fn lookup(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 218. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/mfa.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/mfa.mdx new file mode 100644 index 0000000000..c68c2fd9d7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/mfa.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/mfa" +title: "mfa" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::mfa" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `mfa` + +Multi-factor authentication (sms/call/verify). + +## Signature + +```rust +fn mfa(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 233. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/new.mdx new file mode 100644 index 0000000000..64fa18db27 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/new.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::new" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `new` + +Create a new REST client with explicit credentials. The base URL +resolves to `https://{space}`. Use \[`with_base_url`] to override +(e.g. for fixture-driven tests pointed at `http://127.0.0.1:N`). + +## Signature + +```rust +fn new(project_id: &str, token: &str, space: &str) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 26. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/number-groups.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/number-groups.mdx new file mode 100644 index 0000000000..41875cad9b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/number-groups.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/number-groups" +title: "number_groups" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::number_groups" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `number_groups` + +Number groups (CRUD + membership operations). + +## Signature + +```rust +fn number_groups(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 202. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/phone-numbers.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/phone-numbers.mdx new file mode 100644 index 0000000000..66d129542e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/phone-numbers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/phone-numbers" +title: "phone_numbers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::phone_numbers" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `phone_numbers` + +Phone numbers. + +## Signature + +```rust +fn phone_numbers(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 158. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/project-id.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/project-id.mdx new file mode 100644 index 0000000000..88493ea994 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/project-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/project-id" +title: "project_id" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::project_id" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `project_id` + +## Signature + +```rust +fn project_id(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 119. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/project.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/project.mdx new file mode 100644 index 0000000000..329d514fa5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/project.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/project" +title: "project" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::project" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `project` + +Project namespace (exposes `tokens` sub-resource). + +## Signature + +```rust +fn project(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 248. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/pubsub.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/pubsub.mdx new file mode 100644 index 0000000000..3a24fce507 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/pubsub.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/pubsub" +title: "pubsub" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::pubsub" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `pubsub` + +PubSub tokens. + +## Signature + +```rust +fn pubsub(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 253. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/queues.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/queues.mdx new file mode 100644 index 0000000000..9191509570 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/queues.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/queues" +title: "queues" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::queues" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `queues` + +Queues namespace (CRUD + member operations). + +## Signature + +```rust +fn queues(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 192. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/recordings.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/recordings.mdx new file mode 100644 index 0000000000..ad9b03187f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/recordings.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/recordings" +title: "recordings" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::recordings" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `recordings` + +Recordings. + +## Signature + +```rust +fn recordings(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 197. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/registry.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/registry.mdx new file mode 100644 index 0000000000..e5941ae5e8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/registry.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/registry" +title: "registry" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::registry" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `registry` + +Registry (10DLC brands, campaigns, orders, numbers). + +## Signature + +```rust +fn registry(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 238. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/short-codes.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/short-codes.mdx new file mode 100644 index 0000000000..e99d4654f1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/short-codes.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/short-codes" +title: "short_codes" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::short_codes" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `short_codes` + +Short codes. + +## Signature + +```rust +fn short_codes(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 223. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/sip-profile.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/sip-profile.mdx new file mode 100644 index 0000000000..e334e7cd1e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/sip-profile.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/sip-profile" +title: "sip_profile" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::sip_profile" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `sip_profile` + +Project SIP profile (singular: singleton resource at +`/api/relay/rest/sip_profile`). + +## Signature + +```rust +fn sip_profile(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 213. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/space.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/space.mdx new file mode 100644 index 0000000000..3d83dc3b5b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/space.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/space" +title: "space" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::space" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `space` + +## Signature + +```rust +fn space(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 127. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/token.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/token.mdx new file mode 100644 index 0000000000..15e6532b84 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/token" +title: "token" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::token" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `token` + +## Signature + +```rust +fn token(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 123. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/verified-callers.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/verified-callers.mdx new file mode 100644 index 0000000000..468435c01f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/verified-callers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/verified-callers" +title: "verified_callers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::verified_callers" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `verified_callers` + +Verified callers. + +## Signature + +```rust +fn verified_callers(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 207. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/video.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/video.mdx new file mode 100644 index 0000000000..1bbb0d3d9a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/video.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/video" +title: "video" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::video" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `video` + +Video API namespace (rooms, sessions, recordings, conferences, +tokens, streams). + +## Signature + +```rust +fn video(&self) -> ?<'_> +``` + +## Returns + +`?<'_>` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 171. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/with-base-url.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/with-base-url.mdx new file mode 100644 index 0000000000..86cf7ab365 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/with-base-url.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/with-base-url" +title: "with_base_url" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::with_base_url" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `with_base_url` + +Create a REST client with an explicit base URL. Used by audit +harnesses and integration tests to point at a local fixture +without going through the `https://{space}` resolution. Production +callers should use \[`new`] instead. + +## Signature + +```rust +fn with_base_url(project_id: &str, token: &str, base_url: &str) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 64. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/with-http.mdx b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/with-http.mdx new file mode 100644 index 0000000000..a04a34097d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/client/rest-client/with-http.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/rest/client/rest-client/with-http" +title: "with_http" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::client::RestClient::with_http" + parent: "signalwire::rest::client::RestClient" + module: "rest.client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs" + visibility: "public" +--- +# `with_http` + +Create a REST client with a specific HTTP client (for testing). + +## Signature + +```rust +fn with_http(project_id: &str, token: &str, space: &str, http: ?) -> ? +``` + +## Parameters + + + + + + + + + +## Returns + +`?` + +## Source + +[`src/rest/client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/client.rs) + +Line 90. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/base-path.mdx new file mode 100644 index 0000000000..8eb3822288 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/crud-resource/crud-resource/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::crud_resource::CrudResource::base_path" + parent: "signalwire::rest::crud_resource::CrudResource" + module: "rest.crud_resource" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/crud_resource.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/client.mdx b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/client.mdx new file mode 100644 index 0000000000..b83e9de250 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/crud-resource/crud-resource/client" +title: "client" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::crud_resource::CrudResource::client" + parent: "signalwire::rest::crud_resource::CrudResource" + module: "rest.crud_resource" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs" + visibility: "public" +--- +# `client` + +## Signature + +```rust +fn client(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/rest/crud_resource.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/create.mdx new file mode 100644 index 0000000000..bda1643afa --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/create.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/crud-resource/crud-resource/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::crud_resource::CrudResource::create" + parent: "signalwire::rest::crud_resource::CrudResource" + module: "rest.crud_resource" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs" + visibility: "public" +--- +# `create` + +Create a new resource (POST basePath). + +## Signature + +```rust +fn create(&self, data: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/crud_resource.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs) + +Line 47. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/delete.mdx new file mode 100644 index 0000000000..14bb4cd986 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/delete.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/crud-resource/crud-resource/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::crud_resource::CrudResource::delete" + parent: "signalwire::rest::crud_resource::CrudResource" + module: "rest.crud_resource" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs" + visibility: "public" +--- +# `delete` + +Delete a resource by ID (DELETE basePath/\{id\}). + +## Signature + +```rust +fn delete(&self, id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/crud_resource.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs) + +Line 62. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/get.mdx new file mode 100644 index 0000000000..44d1ba7233 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/crud-resource/crud-resource/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::crud_resource::CrudResource::get" + parent: "signalwire::rest::crud_resource::CrudResource" + module: "rest.crud_resource" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs" + visibility: "public" +--- +# `get` + +Retrieve a single resource by ID (GET basePath/\{id\}). + +## Signature + +```rust +fn get(&self, id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/crud_resource.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs) + +Line 52. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/index.mdx new file mode 100644 index 0000000000..eec4a8a64f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/rust/signalwire/rest/crud-resource/crud-resource" +title: "CrudResource" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::crud_resource::CrudResource" + parent: "signalwire::rest::crud_resource" + module: "rest.crud_resource" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs" + visibility: "public" +--- +# `CrudResource` + +Generic CRUD wrapper around an HttpClient and a base API path. + +Provides list / create / get / update / delete for any REST resource +that follows the standard SignalWire collection+item URL pattern. + +## Signature + +```rust +struct CrudResource { /* fields */ } +``` + +## Methods + + + + + + + + Create a new resource (POST basePath). + + + + Delete a resource by ID (DELETE basePath/\{id\}). + + + + Retrieve a single resource by ID (GET basePath/\{id\}). + + + + List resources (GET basePath). + + + + + + Update a resource by ID (PUT basePath/\{id\}). + + + +## Source + +[`src/rest/crud_resource.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/list.mdx new file mode 100644 index 0000000000..e0cad65950 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/list.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/crud-resource/crud-resource/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::crud_resource::CrudResource::list" + parent: "signalwire::rest::crud_resource::CrudResource" + module: "rest.crud_resource" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs" + visibility: "public" +--- +# `list` + +List resources (GET basePath). + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/crud_resource.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs) + +Line 42. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/new.mdx new file mode 100644 index 0000000000..86f2a82863 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/crud-resource/crud-resource/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::crud_resource::CrudResource::new" + parent: "signalwire::rest::crud_resource::CrudResource" + module: "rest.crud_resource" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/crud_resource.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs) + +Line 18. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/update.mdx new file mode 100644 index 0000000000..433023541d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/crud-resource/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/crud-resource/crud-resource/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::crud_resource::CrudResource::update" + parent: "signalwire::rest::crud_resource::CrudResource" + module: "rest.crud_resource" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs" + visibility: "public" +--- +# `update` + +Update a resource by ID (PUT basePath/\{id\}). + +## Signature + +```rust +fn update(&self, id: &str, data: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/crud_resource.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs) + +Line 57. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/index.mdx new file mode 100644 index 0000000000..b91f15ef44 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/crud-resource/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/rest/crud-resource" +title: "crud_resource" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::crud_resource" + parent: "signalwire::rest" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs" + visibility: "public" +--- +# `crud_resource` + +## Classes + + + + Generic CRUD wrapper around an HttpClient and a base API path. + + + +## Source + +[`src/rest/crud_resource.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/crud_resource.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/error/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/error/index.mdx new file mode 100644 index 0000000000..523630b9a6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/error/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/rust/signalwire/rest/error" +title: "error" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::error" + parent: "signalwire::rest" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs" + visibility: "public" +--- +# `error` + +REST module -- SignalWire REST API client, HTTP transport, and CRUD +resource helpers. + +## Classes + + + + Exception thrown when a SignalWire REST API request fails with a non-2xx status. + + + +## Source + +[`src/rest/error.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/clone.mdx b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/clone.mdx new file mode 100644 index 0000000000..4b91149b1c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/error/signal-wire-rest-error/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::error::SignalWireRestError::clone" + parent: "signalwire::rest::error::SignalWireRestError" + module: "rest.error" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/rest/error.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs) + +Line 4. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/fmt.mdx new file mode 100644 index 0000000000..4c8783b33b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/error/signal-wire-rest-error/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::error::SignalWireRestError::fmt" + parent: "signalwire::rest::error::SignalWireRestError" + module: "rest.error" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/error.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs) + +Line 4. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/fmt__2.mdx b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/fmt__2.mdx new file mode 100644 index 0000000000..d67825570e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/fmt__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/error/signal-wire-rest-error/fmt__2" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::error::SignalWireRestError::fmt" + parent: "signalwire::rest::error::SignalWireRestError" + module: "rest.error" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/error.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs) + +Line 34. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/index.mdx new file mode 100644 index 0000000000..998494685d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/rest/error/signal-wire-rest-error" +title: "SignalWireRestError" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::error::SignalWireRestError" + parent: "signalwire::rest::error" + module: "rest.error" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs" + visibility: "public" +--- +# `SignalWireRestError` + +Exception thrown when a SignalWire REST API request fails with a non-2xx status. + +## Signature + +```rust +struct SignalWireRestError { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone`, `Display`, [Error](/reference/rust/signalwire/security/webhook-layer/webhook-validate/error) + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/error.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs) + +Line 5. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/message.mdx b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/message.mdx new file mode 100644 index 0000000000..617f6e4a0e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/message.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/error/signal-wire-rest-error/message" +title: "message" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::error::SignalWireRestError::message" + parent: "signalwire::rest::error::SignalWireRestError" + module: "rest.error" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs" + visibility: "public" +--- +# `message` + +## Signature + +```rust +fn message(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/error.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/new.mdx new file mode 100644 index 0000000000..be09ff78b1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/new.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/error/signal-wire-rest-error/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::error::SignalWireRestError::new" + parent: "signalwire::rest::error::SignalWireRestError" + module: "rest.error" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(message: &str, status_code: u16, response_body: &str) -> Self +``` + +## Parameters + + + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/error.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/response-body.mdx b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/response-body.mdx new file mode 100644 index 0000000000..3dacbbb045 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/response-body.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/error/signal-wire-rest-error/response-body" +title: "response_body" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::error::SignalWireRestError::response_body" + parent: "signalwire::rest::error::SignalWireRestError" + module: "rest.error" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs" + visibility: "public" +--- +# `response_body` + +## Signature + +```rust +fn response_body(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/error.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs) + +Line 28. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/status-code.mdx b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/status-code.mdx new file mode 100644 index 0000000000..ed2d0d3de9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/error/signal-wire-rest-error/status-code.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/error/signal-wire-rest-error/status-code" +title: "status_code" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::error::SignalWireRestError::status_code" + parent: "signalwire::rest::error::SignalWireRestError" + module: "rest.error" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs" + visibility: "public" +--- +# `status_code` + +## Signature + +```rust +fn status_code(&self) -> u16 +``` + +## Returns + +`u16` + +## Source + +[`src/rest/error.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/error.rs) + +Line 24. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/auth-header.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/auth-header.mdx new file mode 100644 index 0000000000..848fb45019 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/auth-header.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/auth-header" +title: "auth_header" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::auth_header" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `auth_header` + +## Signature + +```rust +fn auth_header(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 220. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/base-url.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/base-url.mdx new file mode 100644 index 0000000000..221ad78bc6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/base-url.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/base-url" +title: "base_url" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::base_url" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `base_url` + +## Signature + +```rust +fn base_url(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 216. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/delete.mdx new file mode 100644 index 0000000000..1f447a58d7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::delete" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, path: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 245. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/get.mdx new file mode 100644 index 0000000000..0595bc71a5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/get.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::get" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, path: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 226. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/index.mdx new file mode 100644 index 0000000000..5750be810d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client" +title: "HttpClient" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient" + parent: "signalwire::rest::http_client" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `HttpClient` + +Low-level HTTP client for SignalWire REST APIs. + +Uses Basic Auth with project\_id:token and returns parsed JSON +responses as `serde_json::Value`. + +## Signature + +```rust +struct HttpClient { /* fields */ } +``` + +## Methods + + + + + + + + + + + + Return all pages of results, following `links.next`. + + + + + + + + + + + + + + + + Create with a stub transport for testing. + + + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 164. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/list-all.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/list-all.mdx new file mode 100644 index 0000000000..03d1fed2d2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/list-all.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/list-all" +title: "list_all" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::list_all" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `list_all` + +Return all pages of results, following `links.next`. + +## Signature + +```rust +fn list_all(&self, path: &str, params: &?) -> ?, ?> +``` + +## Parameters + + + + + +## Returns + +`?, ?>` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 252. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/new.mdx new file mode 100644 index 0000000000..879f96f353 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/new.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::new" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new( + project_id: &str, + token: &str, + base_url: &str, + transport: ? +) -> Self +``` + +## Parameters + + + + + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 174. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/patch.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/patch.mdx new file mode 100644 index 0000000000..b9743b23f0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/patch.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/patch" +title: "patch" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::patch" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `patch` + +## Signature + +```rust +fn patch(&self, path: &str, data: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 240. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/post.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/post.mdx new file mode 100644 index 0000000000..8c150f0de9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/post.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/post" +title: "post" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::post" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `post` + +## Signature + +```rust +fn post(&self, path: &str, data: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 230. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/project-id.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/project-id.mdx new file mode 100644 index 0000000000..dc9d5dc2c8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/project-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/project-id" +title: "project_id" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::project_id" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `project_id` + +## Signature + +```rust +fn project_id(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 208. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/put.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/put.mdx new file mode 100644 index 0000000000..05f1f81443 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/put.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/put" +title: "put" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::put" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `put` + +## Signature + +```rust +fn put(&self, path: &str, data: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 235. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/token.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/token.mdx new file mode 100644 index 0000000000..f153776ca6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/token.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/token" +title: "token" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::token" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `token` + +## Signature + +```rust +fn token(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 212. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/with-stub.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/with-stub.mdx new file mode 100644 index 0000000000..7cf0598ecb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-client/with-stub.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-client/with-stub" +title: "with_stub" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpClient::with_stub" + parent: "signalwire::rest::http_client::HttpClient" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `with_stub` + +Create with a stub transport for testing. + +## Signature + +```rust +fn with_stub(project_id: &str, token: &str, base_url: &str) -> (Self, ?) +``` + +## Parameters + + + + + + + +## Returns + +`(Self, ?)` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 195. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-transport/execute.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-transport/execute.mdx new file mode 100644 index 0000000000..9488e1f4d0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-transport/execute.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-transport/execute" +title: "execute" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpTransport::execute" + parent: "signalwire::rest::http_client::HttpTransport" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `execute` + +## Signature + +```rust +fn execute( + &self, + method: &str, + url: &str, + headers: &?, + body: ?<&str> +) -> ?<(u16, ?), ?> +``` + +## Parameters + + + + + + + + + +## Returns + +`?<(u16, ?), ?>` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 14. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-transport/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-transport/index.mdx new file mode 100644 index 0000000000..a3d612b1d7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/http-transport/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/http-transport" +title: "HttpTransport" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "interface" + language: "rust" + qualified_name: "signalwire::rest::http_client::HttpTransport" + parent: "signalwire::rest::http_client" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `HttpTransport` + +Trait for the HTTP transport layer. + +Production code uses a real implementation (e.g. ureq), while +tests inject a mock. + +## Signature + +```rust +trait HttpTransport +``` + +## Inheritance + +**Extends:** `?`, `?` + +## Methods + + + + + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 13. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/index.mdx new file mode 100644 index 0000000000..89832fe9eb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client" +title: "http_client" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::http_client" + parent: "signalwire::rest" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `http_client` + +## Classes + + + + Low-level HTTP client for SignalWire REST APIs. + + + + A stub transport that records requests and returns canned responses. Useful for unit testing without network access. + + + + Real HTTP transport backed by ureq. + + + +## Interfaces + + + + Trait for the HTTP transport layer. + + + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/execute.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/execute.mdx new file mode 100644 index 0000000000..28c26c16bf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/execute.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/stub-transport/execute" +title: "execute" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::StubTransport::execute" + parent: "signalwire::rest::http_client::StubTransport" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `execute` + +## Signature + +```rust +fn execute( + &self, + method: &str, + url: &str, + _headers: &?, + body: ?<&str> +) -> ?<(u16, ?), ?> +``` + +## Parameters + + + + + + + + + +## Returns + +`?<(u16, ?), ?>` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 143. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/index.mdx new file mode 100644 index 0000000000..22505cc05d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/stub-transport" +title: "StubTransport" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::http_client::StubTransport" + parent: "signalwire::rest::http_client" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `StubTransport` + +A stub transport that records requests and returns canned responses. +Useful for unit testing without network access. + +## Signature + +```rust +struct StubTransport { /* fields */ } +``` + +## Inheritance + +**Implements:** `HttpTransport` + +## Properties + + + Recorded requests: (method, url, body). + + + + Canned response: (status\_code, body). + + +## Methods + + + + + + + + + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 122. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/new.mdx new file mode 100644 index 0000000000..cadd6381df --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/stub-transport/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::StubTransport::new" + parent: "signalwire::rest::http_client::StubTransport" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(status: u16, body: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 130. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/set-response.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/set-response.mdx new file mode 100644 index 0000000000..22ba99656e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/stub-transport/set-response.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/stub-transport/set-response" +title: "set_response" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::StubTransport::set_response" + parent: "signalwire::rest::http_client::StubTransport" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `set_response` + +## Signature + +```rust +fn set_response(&self, status: u16, body: &str) +``` + +## Parameters + + + + + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 137. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/default.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/default.mdx new file mode 100644 index 0000000000..26526f9352 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/default.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/ureq-transport/default" +title: "default" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::UreqTransport::default" + parent: "signalwire::rest::http_client::UreqTransport" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `default` + +## Signature + +```rust +fn default() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 35. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/execute.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/execute.mdx new file mode 100644 index 0000000000..13815db146 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/execute.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/ureq-transport/execute" +title: "execute" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::UreqTransport::execute" + parent: "signalwire::rest::http_client::UreqTransport" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `execute` + +## Signature + +```rust +fn execute( + &self, + method: &str, + url: &str, + headers: &?, + body: ?<&str> +) -> ?<(u16, ?), ?> +``` + +## Parameters + + + + + + + + + +## Returns + +`?<(u16, ?), ?>` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 52. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/index.mdx new file mode 100644 index 0000000000..11fc07fc14 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/ureq-transport" +title: "UreqTransport" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::http_client::UreqTransport" + parent: "signalwire::rest::http_client" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `UreqTransport` + +Real HTTP transport backed by ureq. + +This is the production transport — every REST namespace operation +goes through `ureq::Agent::request()` to a real HTTP endpoint. The +REST audit fixture (`audit_rest_transport.py`) drives the wire +shape (method, path, headers, body) end-to-end against this code, +so any regression in serialization is caught. + +## Signature + +```rust +struct UreqTransport { /* fields */ } +``` + +## Inheritance + +**Implements:** `Default`, `HttpTransport` + +## Methods + + + + + + + + + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 30. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/new.mdx new file mode 100644 index 0000000000..797464a7ba --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/http-client/ureq-transport/new.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/http-client/ureq-transport/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::http_client::UreqTransport::new" + parent: "signalwire::rest::http_client::UreqTransport" + module: "rest.http_client" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/rest/http_client.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/http_client.rs) + +Line 41. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/index.mdx new file mode 100644 index 0000000000..947d043775 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/rest" +title: "rest" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/mod.rs" + visibility: "public" +--- +# `rest` + +## Modules + + + + + + + + REST module -- SignalWire REST API client, HTTP transport, and CRUD resource helpers. + + + + + + + + Paginated iterator over `links.next`-cursor responses. + + + +## Source + +[`src/rest/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-hold.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-hold.mdx new file mode 100644 index 0000000000..079b7e727f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-hold.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/ai-hold" +title: "ai_hold" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::ai_hold" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `ai_hold` + +## Signature + +```rust +fn ai_hold(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 246. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-message.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-message.mdx new file mode 100644 index 0000000000..43752e5a85 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-message.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/ai-message" +title: "ai_message" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::ai_message" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `ai_message` + +## Signature + +```rust +fn ai_message(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 238. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-stop.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-stop.mdx new file mode 100644 index 0000000000..ab9acd9204 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/ai-stop" +title: "ai_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::ai_stop" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `ai_stop` + +## Signature + +```rust +fn ai_stop(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 254. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-unhold.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-unhold.mdx new file mode 100644 index 0000000000..1740bf1b33 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/ai-unhold.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/ai-unhold" +title: "ai_unhold" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::ai_unhold" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `ai_unhold` + +## Signature + +```rust +fn ai_unhold(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 250. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/base-path.mdx new file mode 100644 index 0000000000..b19c95a854 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::base_path" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 35. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/client.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/client.mdx new file mode 100644 index 0000000000..59e393abfe --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/client" +title: "client" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::client" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `client` + +## Signature + +```rust +fn client(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 27. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/collect-start-input-timers.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/collect-start-input-timers.mdx new file mode 100644 index 0000000000..6acf9292b5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/collect-start-input-timers.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/collect-start-input-timers" +title: "collect_start_input_timers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::collect_start_input_timers" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `collect_start_input_timers` + +## Signature + +```rust +fn collect_start_input_timers(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 150. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/collect-stop.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/collect-stop.mdx new file mode 100644 index 0000000000..ab76d7bd5a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/collect-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/collect-stop" +title: "collect_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::collect_stop" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `collect_stop` + +## Signature + +```rust +fn collect_stop(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 142. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/collect.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/collect.mdx new file mode 100644 index 0000000000..28e3f8e21e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/collect.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/collect" +title: "collect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::collect" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `collect` + +## Signature + +```rust +fn collect(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 138. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/denoise-stop.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/denoise-stop.mdx new file mode 100644 index 0000000000..cca140683f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/denoise-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/denoise-stop" +title: "denoise_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::denoise_stop" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `denoise_stop` + +## Signature + +```rust +fn denoise_stop(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 206. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/denoise.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/denoise.mdx new file mode 100644 index 0000000000..b73e8ff02a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/denoise.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/denoise" +title: "denoise" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::denoise" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `denoise` + +## Signature + +```rust +fn denoise(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 202. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/detect-stop.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/detect-stop.mdx new file mode 100644 index 0000000000..27b2b53b92 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/detect-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/detect-stop" +title: "detect_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::detect_stop" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `detect_stop` + +## Signature + +```rust +fn detect_stop(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 166. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/detect.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/detect.mdx new file mode 100644 index 0000000000..48a805858d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/detect.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/detect" +title: "detect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::detect" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `detect` + +## Signature + +```rust +fn detect(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 162. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/dial.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/dial.mdx new file mode 100644 index 0000000000..debf52a2b4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/dial.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/dial" +title: "dial" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::dial" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `dial` + +## Signature + +```rust +fn dial(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 63. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/disconnect.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/disconnect.mdx new file mode 100644 index 0000000000..455e65b0f1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/disconnect.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/disconnect" +title: "disconnect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::disconnect" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `disconnect` + +## Signature + +```rust +fn disconnect(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 82. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/end.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/end.mdx new file mode 100644 index 0000000000..bc0d15281b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/end.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/end" +title: "end" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::end" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `end` + +## Signature + +```rust +fn end(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 74. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/index.mdx new file mode 100644 index 0000000000..f0768402da --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/index.mdx @@ -0,0 +1,122 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling" +title: "Calling" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling" + parent: "signalwire::rest::namespaces::calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `Calling` + +Calling API namespace. + +Provides 37 call-control command methods that each POST to +`/api/calling/calls` with a JSON body containing the command name, +an optional call ID, and parameters. + +## Signature + +```rust +struct Calling { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + POST /api/calling/calls with `command="update"` — mirrors the Python `client.calling.update(id=..., state=...)` shape: caller-supplied `id` lives **inside** params, not as the top-level body field. + + + + + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 14. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/live-transcribe.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/live-transcribe.mdx new file mode 100644 index 0000000000..3aea5d35cf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/live-transcribe.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/live-transcribe" +title: "live_transcribe" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::live_transcribe" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `live_transcribe` + +## Signature + +```rust +fn live_transcribe(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 262. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/live-translate.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/live-translate.mdx new file mode 100644 index 0000000000..499dca9028 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/live-translate.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/live-translate" +title: "live_translate" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::live_translate" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `live_translate` + +## Signature + +```rust +fn live_translate(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 270. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/new.mdx new file mode 100644 index 0000000000..ac53519ef9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::new" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, project_id: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-pause.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-pause.mdx new file mode 100644 index 0000000000..b4118fab2f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-pause.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/play-pause" +title: "play_pause" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::play_pause" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `play_pause` + +## Signature + +```rust +fn play_pause(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 94. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-resume.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-resume.mdx new file mode 100644 index 0000000000..19a65cbdfb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-resume.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/play-resume" +title: "play_resume" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::play_resume" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `play_resume` + +## Signature + +```rust +fn play_resume(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 98. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-stop.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-stop.mdx new file mode 100644 index 0000000000..afb2457b65 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/play-stop" +title: "play_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::play_stop" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `play_stop` + +## Signature + +```rust +fn play_stop(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 102. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-volume.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-volume.mdx new file mode 100644 index 0000000000..4dc5a2db5a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play-volume.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/play-volume" +title: "play_volume" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::play_volume" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `play_volume` + +## Signature + +```rust +fn play_volume(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 106. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play.mdx new file mode 100644 index 0000000000..b36e9c08b6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/play.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/play" +title: "play" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::play" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `play` + +## Signature + +```rust +fn play(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 90. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/project-id.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/project-id.mdx new file mode 100644 index 0000000000..3ef9c518c0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/project-id.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/project-id" +title: "project_id" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::project_id" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `project_id` + +## Signature + +```rust +fn project_id(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 31. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/receive-fax-stop.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/receive-fax-stop.mdx new file mode 100644 index 0000000000..a2e09ca381 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/receive-fax-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/receive-fax-stop" +title: "receive_fax_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::receive_fax_stop" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `receive_fax_stop` + +## Signature + +```rust +fn receive_fax_stop(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 290. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record-pause.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record-pause.mdx new file mode 100644 index 0000000000..22ccef5d38 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record-pause.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/record-pause" +title: "record_pause" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::record_pause" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `record_pause` + +## Signature + +```rust +fn record_pause(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 118. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record-resume.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record-resume.mdx new file mode 100644 index 0000000000..6d4b898c87 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record-resume.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/record-resume" +title: "record_resume" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::record_resume" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `record_resume` + +## Signature + +```rust +fn record_resume(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 122. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record-stop.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record-stop.mdx new file mode 100644 index 0000000000..83437f269f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/record-stop" +title: "record_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::record_stop" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `record_stop` + +## Signature + +```rust +fn record_stop(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 130. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record.mdx new file mode 100644 index 0000000000..7b5686a1d8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/record.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/record" +title: "record" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::record" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `record` + +## Signature + +```rust +fn record(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 114. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/refer.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/refer.mdx new file mode 100644 index 0000000000..a03082045c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/refer.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/refer" +title: "refer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::refer" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `refer` + +## Signature + +```rust +fn refer(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 302. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/send-fax-stop.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/send-fax-stop.mdx new file mode 100644 index 0000000000..287b9e4872 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/send-fax-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/send-fax-stop" +title: "send_fax_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::send_fax_stop" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `send_fax_stop` + +## Signature + +```rust +fn send_fax_stop(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 282. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/stream-stop.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/stream-stop.mdx new file mode 100644 index 0000000000..b469435467 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/stream-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/stream-stop" +title: "stream_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::stream_stop" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `stream_stop` + +## Signature + +```rust +fn stream_stop(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 190. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/stream.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/stream.mdx new file mode 100644 index 0000000000..aa94acb340 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/stream.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/stream" +title: "stream" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::stream" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `stream` + +## Signature + +```rust +fn stream(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 186. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/tap-stop.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/tap-stop.mdx new file mode 100644 index 0000000000..f83646a914 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/tap-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/tap-stop" +title: "tap_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::tap_stop" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `tap_stop` + +## Signature + +```rust +fn tap_stop(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 178. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/tap.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/tap.mdx new file mode 100644 index 0000000000..30ed29f537 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/tap.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/tap" +title: "tap" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::tap" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `tap` + +## Signature + +```rust +fn tap(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 174. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/transcribe-stop.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/transcribe-stop.mdx new file mode 100644 index 0000000000..e79c69421a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/transcribe-stop.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/transcribe-stop" +title: "transcribe_stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::transcribe_stop" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `transcribe_stop` + +## Signature + +```rust +fn transcribe_stop(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 226. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/transcribe.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/transcribe.mdx new file mode 100644 index 0000000000..0ea9d52328 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/transcribe.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/transcribe" +title: "transcribe" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::transcribe" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `transcribe` + +## Signature + +```rust +fn transcribe(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 218. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/transfer.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/transfer.mdx new file mode 100644 index 0000000000..525c90037d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/transfer.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/transfer" +title: "transfer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::transfer" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `transfer` + +## Signature + +```rust +fn transfer(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 78. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/update.mdx new file mode 100644 index 0000000000..7266326f07 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::update" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `update` + +POST /api/calling/calls with `command="update"` — mirrors the Python +`client.calling.update(id=..., state=...)` shape: caller-supplied +`id` lives **inside** params, not as the top-level body field. + +## Signature + +```rust +fn update(&self, params: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 70. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/user-event.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/user-event.mdx new file mode 100644 index 0000000000..3b28be40f5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/calling/user-event.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling/calling/user-event" +title: "user_event" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling::Calling::user_event" + parent: "signalwire::rest::namespaces::calling::Calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `user_event` + +## Signature + +```rust +fn user_event(&self, call_id: &str, params: ?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 310. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/index.mdx new file mode 100644 index 0000000000..7fe473438c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/calling/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/calling" +title: "calling" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::calling" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs" + visibility: "public" +--- +# `calling` + +## Classes + + + + Calling API namespace. + + + +## Source + +[`src/rest/namespaces/calling.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/calling.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/base-path.mdx new file mode 100644 index 0000000000..c8e9a21de0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-accounts/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatAccounts::base_path" + parent: "signalwire::rest::namespaces::compat::CompatAccounts" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 135. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/create.mdx new file mode 100644 index 0000000000..1bc2533335 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-accounts/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatAccounts::create" + parent: "signalwire::rest::namespaces::compat::CompatAccounts" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 144. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/get.mdx new file mode 100644 index 0000000000..eb3784cc4e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-accounts/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatAccounts::get" + parent: "signalwire::rest::namespaces::compat::CompatAccounts" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 148. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/index.mdx new file mode 100644 index 0000000000..f083c60c57 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-accounts" +title: "CompatAccounts" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatAccounts" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatAccounts` + +## Signature + +```rust +struct CompatAccounts { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 122. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/list.mdx new file mode 100644 index 0000000000..4fbf994ce3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-accounts/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatAccounts::list" + parent: "signalwire::rest::namespaces::compat::CompatAccounts" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 139. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/new.mdx new file mode 100644 index 0000000000..71006234e1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-accounts/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatAccounts::new" + parent: "signalwire::rest::namespaces::compat::CompatAccounts" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 128. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/update.mdx new file mode 100644 index 0000000000..85cad587cc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-accounts/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-accounts/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatAccounts::update" + parent: "signalwire::rest::namespaces::compat::CompatAccounts" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 152. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/base-path.mdx new file mode 100644 index 0000000000..103ced7eb6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-applications/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatApplications::base_path" + parent: "signalwire::rest::namespaces::compat::CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 597. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/create.mdx new file mode 100644 index 0000000000..189ba191dc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-applications/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatApplications::create" + parent: "signalwire::rest::namespaces::compat::CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 606. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/delete.mdx new file mode 100644 index 0000000000..23fd9d9a23 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-applications/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatApplications::delete" + parent: "signalwire::rest::namespaces::compat::CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 618. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/get.mdx new file mode 100644 index 0000000000..e199111442 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-applications/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatApplications::get" + parent: "signalwire::rest::namespaces::compat::CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 610. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/index.mdx new file mode 100644 index 0000000000..f994847e96 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-applications" +title: "CompatApplications" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatApplications" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatApplications` + +## Signature + +```rust +struct CompatApplications { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 584. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/list.mdx new file mode 100644 index 0000000000..e85b332bdd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-applications/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatApplications::list" + parent: "signalwire::rest::namespaces::compat::CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 601. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/new.mdx new file mode 100644 index 0000000000..d0f3141bc8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-applications/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatApplications::new" + parent: "signalwire::rest::namespaces::compat::CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 590. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/update.mdx new file mode 100644 index 0000000000..a1dd2f951e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-applications/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-applications/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatApplications::update" + parent: "signalwire::rest::namespaces::compat::CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 614. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/base-path.mdx new file mode 100644 index 0000000000..c7b1acf491 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-calls/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatCalls::base_path" + parent: "signalwire::rest::namespaces::compat::CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 174. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/index.mdx new file mode 100644 index 0000000000..b7d4707f70 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-calls" +title: "CompatCalls" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatCalls" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatCalls` + +## Signature + +```rust +struct CompatCalls { /* fields */ } +``` + +## Methods + + + + + + + + POST /Calls/\{sid\}/Recordings — start a new recording on the call. + + + + POST /Calls/\{sid\}/Streams — start a new stream on the call. + + + + POST /Calls/\{sid\}/Streams/\{stream\_sid\} — stop / update a stream. + + + + + + POST /Calls/\{sid\}/Recordings/\{rec\_sid\} — update a specific recording. + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 161. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/new.mdx new file mode 100644 index 0000000000..b61ac2553b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-calls/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatCalls::new" + parent: "signalwire::rest::namespaces::compat::CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 167. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/start-recording.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/start-recording.mdx new file mode 100644 index 0000000000..8b3ee21765 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/start-recording.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-calls/start-recording" +title: "start_recording" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatCalls::start_recording" + parent: "signalwire::rest::namespaces::compat::CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `start_recording` + +POST /Calls/\{sid\}/Recordings — start a new recording on the call. + +## Signature + +```rust +fn start_recording(&self, call_sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 183. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/start-stream.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/start-stream.mdx new file mode 100644 index 0000000000..4ee73e53f2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/start-stream.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-calls/start-stream" +title: "start_stream" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatCalls::start_stream" + parent: "signalwire::rest::namespaces::compat::CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `start_stream` + +POST /Calls/\{sid\}/Streams — start a new stream on the call. + +## Signature + +```rust +fn start_stream(&self, call_sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 204. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/stop-stream.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/stop-stream.mdx new file mode 100644 index 0000000000..150cef65d2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/stop-stream.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-calls/stop-stream" +title: "stop_stream" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatCalls::stop_stream" + parent: "signalwire::rest::namespaces::compat::CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `stop_stream` + +POST /Calls/\{sid\}/Streams/\{stream\_sid\} — stop / update a stream. + +## Signature + +```rust +fn stop_stream(&self, call_sid: &str, stream_sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 214. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/update-recording.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/update-recording.mdx new file mode 100644 index 0000000000..9f0f34e9bf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/update-recording.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-calls/update-recording" +title: "update_recording" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatCalls::update_recording" + parent: "signalwire::rest::namespaces::compat::CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update_recording` + +POST /Calls/\{sid\}/Recordings/\{rec\_sid\} — update a specific recording. + +## Signature + +```rust +fn update_recording( + &self, + call_sid: &str, + recording_sid: &str, + params: &? +) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 193. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/update.mdx new file mode 100644 index 0000000000..50c0b85d48 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-calls/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-calls/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatCalls::update" + parent: "signalwire::rest::namespaces::compat::CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 178. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/base-path.mdx new file mode 100644 index 0000000000..7c2a2f5736 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::base_path" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 380. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/delete-recording.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/delete-recording.mdx new file mode 100644 index 0000000000..51ba0f69fe --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/delete-recording.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/delete-recording" +title: "delete_recording" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::delete_recording" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete_recording` + +## Signature + +```rust +fn delete_recording(&self, conference_sid: &str, recording_sid: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 464. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get-participant.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get-participant.mdx new file mode 100644 index 0000000000..322f42cf1b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get-participant.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get-participant" +title: "get_participant" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::get_participant" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get_participant` + +## Signature + +```rust +fn get_participant(&self, conference_sid: &str, call_sid: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 407. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get-recording.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get-recording.mdx new file mode 100644 index 0000000000..35609d2fca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get-recording.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get-recording" +title: "get_recording" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::get_recording" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get_recording` + +## Signature + +```rust +fn get_recording(&self, conference_sid: &str, recording_sid: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 445. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get.mdx new file mode 100644 index 0000000000..1b87b93c1d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::get" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 389. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/index.mdx new file mode 100644 index 0000000000..70231ace6d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences" +title: "CompatConferences" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatConferences` + +## Signature + +```rust +struct CompatConferences { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 367. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list-participants.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list-participants.mdx new file mode 100644 index 0000000000..74cd0f3d53 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list-participants.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list-participants" +title: "list_participants" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::list_participants" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list_participants` + +## Signature + +```rust +fn list_participants(&self, conference_sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 397. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list-recordings.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list-recordings.mdx new file mode 100644 index 0000000000..597f2d2a7e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list-recordings.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list-recordings" +title: "list_recordings" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::list_recordings" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list_recordings` + +## Signature + +```rust +fn list_recordings(&self, conference_sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 435. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list.mdx new file mode 100644 index 0000000000..f0d418af95 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::list" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 384. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/new.mdx new file mode 100644 index 0000000000..c628db55b3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::new" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 373. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/remove-participant.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/remove-participant.mdx new file mode 100644 index 0000000000..e73fc591bb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/remove-participant.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/remove-participant" +title: "remove_participant" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::remove_participant" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `remove_participant` + +## Signature + +```rust +fn remove_participant(&self, conference_sid: &str, call_sid: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 426. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/start-stream.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/start-stream.mdx new file mode 100644 index 0000000000..3358345423 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/start-stream.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/start-stream" +title: "start_stream" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::start_stream" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `start_stream` + +## Signature + +```rust +fn start_stream(&self, conference_sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 473. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/stop-stream.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/stop-stream.mdx new file mode 100644 index 0000000000..d759049f2d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/stop-stream.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/stop-stream" +title: "stop_stream" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::stop_stream" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `stop_stream` + +## Signature + +```rust +fn stop_stream( + &self, + conference_sid: &str, + stream_sid: &str, + params: &? +) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 482. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update-participant.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update-participant.mdx new file mode 100644 index 0000000000..aaef45dad4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update-participant.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update-participant" +title: "update_participant" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::update_participant" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update_participant` + +## Signature + +```rust +fn update_participant( + &self, + conference_sid: &str, + call_sid: &str, + params: &? +) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 416. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update-recording.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update-recording.mdx new file mode 100644 index 0000000000..51b8cbb54b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update-recording.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update-recording" +title: "update_recording" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::update_recording" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update_recording` + +## Signature + +```rust +fn update_recording( + &self, + conference_sid: &str, + recording_sid: &str, + params: &? +) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 454. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update.mdx new file mode 100644 index 0000000000..3586daab1b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-conferences/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatConferences::update" + parent: "signalwire::rest::namespaces::compat::CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 393. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/base-path.mdx new file mode 100644 index 0000000000..b884d777f1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-faxes/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatFaxes::base_path" + parent: "signalwire::rest::namespaces::compat::CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 313. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/create.mdx new file mode 100644 index 0000000000..c8a32da273 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-faxes/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatFaxes::create" + parent: "signalwire::rest::namespaces::compat::CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 322. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/delete-media.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/delete-media.mdx new file mode 100644 index 0000000000..9e61d57d35 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/delete-media.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-faxes/delete-media" +title: "delete_media" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatFaxes::delete_media" + parent: "signalwire::rest::namespaces::compat::CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete_media` + +## Signature + +```rust +fn delete_media(&self, fax_sid: &str, media_sid: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 353. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/delete.mdx new file mode 100644 index 0000000000..7ae96e5be4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-faxes/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatFaxes::delete" + parent: "signalwire::rest::namespaces::compat::CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 334. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/get-media.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/get-media.mdx new file mode 100644 index 0000000000..c4fafaea65 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/get-media.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-faxes/get-media" +title: "get_media" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatFaxes::get_media" + parent: "signalwire::rest::namespaces::compat::CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get_media` + +## Signature + +```rust +fn get_media(&self, fax_sid: &str, media_sid: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 344. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/get.mdx new file mode 100644 index 0000000000..211df45640 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-faxes/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatFaxes::get" + parent: "signalwire::rest::namespaces::compat::CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 326. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/index.mdx new file mode 100644 index 0000000000..883cc7fcda --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-faxes" +title: "CompatFaxes" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatFaxes" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatFaxes` + +## Signature + +```rust +struct CompatFaxes { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 300. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/list-media.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/list-media.mdx new file mode 100644 index 0000000000..4443558772 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/list-media.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-faxes/list-media" +title: "list_media" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatFaxes::list_media" + parent: "signalwire::rest::namespaces::compat::CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list_media` + +## Signature + +```rust +fn list_media(&self, fax_sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 338. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/list.mdx new file mode 100644 index 0000000000..d9baab2348 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-faxes/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatFaxes::list" + parent: "signalwire::rest::namespaces::compat::CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 317. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/new.mdx new file mode 100644 index 0000000000..b2a615ca18 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-faxes/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatFaxes::new" + parent: "signalwire::rest::namespaces::compat::CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 306. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/update.mdx new file mode 100644 index 0000000000..ea4c51ce54 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-faxes/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-faxes/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatFaxes::update" + parent: "signalwire::rest::namespaces::compat::CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 330. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/base-path.mdx new file mode 100644 index 0000000000..5a3177808d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatLamlBins::base_path" + parent: "signalwire::rest::namespaces::compat::CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 640. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/create.mdx new file mode 100644 index 0000000000..78db7f0696 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatLamlBins::create" + parent: "signalwire::rest::namespaces::compat::CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 649. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/delete.mdx new file mode 100644 index 0000000000..e219c207b9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatLamlBins::delete" + parent: "signalwire::rest::namespaces::compat::CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 661. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/get.mdx new file mode 100644 index 0000000000..54e12af461 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatLamlBins::get" + parent: "signalwire::rest::namespaces::compat::CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 653. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/index.mdx new file mode 100644 index 0000000000..4396e28873 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins" +title: "CompatLamlBins" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatLamlBins" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatLamlBins` + +## Signature + +```rust +struct CompatLamlBins { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 627. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/list.mdx new file mode 100644 index 0000000000..75565c6390 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatLamlBins::list" + parent: "signalwire::rest::namespaces::compat::CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 644. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/new.mdx new file mode 100644 index 0000000000..4012bc5fd7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatLamlBins::new" + parent: "signalwire::rest::namespaces::compat::CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 633. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/update.mdx new file mode 100644 index 0000000000..45ddd0188f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-laml-bins/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatLamlBins::update" + parent: "signalwire::rest::namespaces::compat::CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 657. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/base-path.mdx new file mode 100644 index 0000000000..038d0c23e5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-messages/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatMessages::base_path" + parent: "signalwire::rest::namespaces::compat::CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 242. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/create.mdx new file mode 100644 index 0000000000..b86126846a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-messages/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatMessages::create" + parent: "signalwire::rest::namespaces::compat::CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 251. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/delete-media.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/delete-media.mdx new file mode 100644 index 0000000000..9b744d7cf3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/delete-media.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-messages/delete-media" +title: "delete_media" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatMessages::delete_media" + parent: "signalwire::rest::namespaces::compat::CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete_media` + +## Signature + +```rust +fn delete_media(&self, message_sid: &str, media_sid: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 286. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/delete.mdx new file mode 100644 index 0000000000..b20ae04c53 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-messages/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatMessages::delete" + parent: "signalwire::rest::namespaces::compat::CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 263. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/get-media.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/get-media.mdx new file mode 100644 index 0000000000..848116082b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/get-media.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-messages/get-media" +title: "get_media" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatMessages::get_media" + parent: "signalwire::rest::namespaces::compat::CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get_media` + +## Signature + +```rust +fn get_media(&self, message_sid: &str, media_sid: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 277. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/get.mdx new file mode 100644 index 0000000000..bc6974529e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-messages/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatMessages::get" + parent: "signalwire::rest::namespaces::compat::CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 255. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/index.mdx new file mode 100644 index 0000000000..177dfefc24 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-messages" +title: "CompatMessages" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatMessages" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatMessages` + +## Signature + +```rust +struct CompatMessages { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 229. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/list-media.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/list-media.mdx new file mode 100644 index 0000000000..f3083f9b2b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/list-media.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-messages/list-media" +title: "list_media" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatMessages::list_media" + parent: "signalwire::rest::namespaces::compat::CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list_media` + +## Signature + +```rust +fn list_media(&self, message_sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 267. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/list.mdx new file mode 100644 index 0000000000..4a644c0912 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-messages/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatMessages::list" + parent: "signalwire::rest::namespaces::compat::CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 246. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/new.mdx new file mode 100644 index 0000000000..dac00cb8c9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-messages/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatMessages::new" + parent: "signalwire::rest::namespaces::compat::CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 235. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/update.mdx new file mode 100644 index 0000000000..cd0f4d47e0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-messages/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-messages/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatMessages::update" + parent: "signalwire::rest::namespaces::compat::CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 259. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/available-base.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/available-base.mdx new file mode 100644 index 0000000000..2848e06d22 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/available-base.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/available-base" +title: "available_base" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::available_base" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `available_base` + +## Signature + +```rust +fn available_base(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 518. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/base-path.mdx new file mode 100644 index 0000000000..13ba232198 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::base_path" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 514. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/delete.mdx new file mode 100644 index 0000000000..abfea5512e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::delete" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 539. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/get.mdx new file mode 100644 index 0000000000..a63b881051 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::get" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 531. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/import-number.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/import-number.mdx new file mode 100644 index 0000000000..b88b91805c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/import-number.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/import-number" +title: "import_number" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::import_number" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `import_number` + +POST /ImportedPhoneNumbers — note the path is _Imported_, not _Incoming_. + +## Signature + +```rust +fn import_number(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 544. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/index.mdx new file mode 100644 index 0000000000..6c650ed760 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers" +title: "CompatPhoneNumbers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatPhoneNumbers` + +## Signature + +```rust +struct CompatPhoneNumbers { /* fields */ } +``` + +## Methods + + + + + + + + + + + + POST /ImportedPhoneNumbers — note the path is _Imported_, not _Incoming_. + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 497. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/list-available-countries.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/list-available-countries.mdx new file mode 100644 index 0000000000..0b17c6fe8c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/list-available-countries.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/list-available-countries" +title: "list_available_countries" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::list_available_countries" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list_available_countries` + +## Signature + +```rust +fn list_available_countries(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 551. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/list.mdx new file mode 100644 index 0000000000..0bf2578ffd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::list" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 522. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/new.mdx new file mode 100644 index 0000000000..7291b811e1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::new" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 504. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/purchase.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/purchase.mdx new file mode 100644 index 0000000000..da66997b93 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/purchase.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/purchase" +title: "purchase" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::purchase" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `purchase` + +## Signature + +```rust +fn purchase(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 527. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/search-local.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/search-local.mdx new file mode 100644 index 0000000000..17894b147d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/search-local.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/search-local" +title: "search_local" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::search_local" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `search_local` + +## Signature + +```rust +fn search_local(&self, country: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 559. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/search-toll-free.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/search-toll-free.mdx new file mode 100644 index 0000000000..e2f83efbe6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/search-toll-free.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/search-toll-free" +title: "search_toll_free" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::search_toll_free" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `search_toll_free` + +## Signature + +```rust +fn search_toll_free(&self, country: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 569. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/update.mdx new file mode 100644 index 0000000000..1101eca6b9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-phone-numbers/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatPhoneNumbers::update" + parent: "signalwire::rest::namespaces::compat::CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 535. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/base-path.mdx new file mode 100644 index 0000000000..0263b5e916 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-queues/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatQueues::base_path" + parent: "signalwire::rest::namespaces::compat::CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 683. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/create.mdx new file mode 100644 index 0000000000..04e7d64555 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-queues/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatQueues::create" + parent: "signalwire::rest::namespaces::compat::CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 692. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/delete.mdx new file mode 100644 index 0000000000..b54aa7aa00 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-queues/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatQueues::delete" + parent: "signalwire::rest::namespaces::compat::CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 704. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/dequeue-member.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/dequeue-member.mdx new file mode 100644 index 0000000000..8fc7fbbb4e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/dequeue-member.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-queues/dequeue-member" +title: "dequeue_member" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatQueues::dequeue_member" + parent: "signalwire::rest::namespaces::compat::CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `dequeue_member` + +## Signature + +```rust +fn dequeue_member(&self, queue_sid: &str, call_sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 727. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/get-member.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/get-member.mdx new file mode 100644 index 0000000000..803515c4b4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/get-member.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-queues/get-member" +title: "get_member" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatQueues::get_member" + parent: "signalwire::rest::namespaces::compat::CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get_member` + +## Signature + +```rust +fn get_member(&self, queue_sid: &str, call_sid: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 718. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/get.mdx new file mode 100644 index 0000000000..6337c6e848 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-queues/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatQueues::get" + parent: "signalwire::rest::namespaces::compat::CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 696. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/index.mdx new file mode 100644 index 0000000000..fa49efee59 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-queues" +title: "CompatQueues" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatQueues" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatQueues` + +## Signature + +```rust +struct CompatQueues { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 670. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/list-members.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/list-members.mdx new file mode 100644 index 0000000000..42c627d04c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/list-members.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-queues/list-members" +title: "list_members" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatQueues::list_members" + parent: "signalwire::rest::namespaces::compat::CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list_members` + +## Signature + +```rust +fn list_members(&self, queue_sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 708. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/list.mdx new file mode 100644 index 0000000000..304a59f8cd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-queues/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatQueues::list" + parent: "signalwire::rest::namespaces::compat::CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 687. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/new.mdx new file mode 100644 index 0000000000..be4609242d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-queues/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatQueues::new" + parent: "signalwire::rest::namespaces::compat::CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 676. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/update.mdx new file mode 100644 index 0000000000..0761a36435 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-queues/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-queues/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatQueues::update" + parent: "signalwire::rest::namespaces::compat::CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, sid: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 700. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/base-path.mdx new file mode 100644 index 0000000000..b952f1a39d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-recordings/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatRecordings::base_path" + parent: "signalwire::rest::namespaces::compat::CompatRecordings" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 755. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/delete.mdx new file mode 100644 index 0000000000..4f0e0d085d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-recordings/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatRecordings::delete" + parent: "signalwire::rest::namespaces::compat::CompatRecordings" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 768. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/get.mdx new file mode 100644 index 0000000000..13bbfdc3e3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-recordings/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatRecordings::get" + parent: "signalwire::rest::namespaces::compat::CompatRecordings" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 764. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/index.mdx new file mode 100644 index 0000000000..8de055f30e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-recordings" +title: "CompatRecordings" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatRecordings" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatRecordings` + +## Signature + +```rust +struct CompatRecordings { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 742. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/list.mdx new file mode 100644 index 0000000000..d8f063e9f2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-recordings/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatRecordings::list" + parent: "signalwire::rest::namespaces::compat::CompatRecordings" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 759. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/new.mdx new file mode 100644 index 0000000000..42099b548c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-recordings/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-recordings/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatRecordings::new" + parent: "signalwire::rest::namespaces::compat::CompatRecordings" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 748. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/base-path.mdx new file mode 100644 index 0000000000..9834248c5d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-tokens/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTokens::base_path" + parent: "signalwire::rest::namespaces::compat::CompatTokens" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 825. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/create.mdx new file mode 100644 index 0000000000..abcc4f04a0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-tokens/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTokens::create" + parent: "signalwire::rest::namespaces::compat::CompatTokens" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 829. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/delete.mdx new file mode 100644 index 0000000000..64e22c1b47 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-tokens/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTokens::delete" + parent: "signalwire::rest::namespaces::compat::CompatTokens" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, token_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 841. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/index.mdx new file mode 100644 index 0000000000..ec4dffb519 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-tokens" +title: "CompatTokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTokens" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatTokens` + +## Signature + +```rust +struct CompatTokens { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 812. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/new.mdx new file mode 100644 index 0000000000..fe9b7e2591 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-tokens/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTokens::new" + parent: "signalwire::rest::namespaces::compat::CompatTokens" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 818. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/update.mdx new file mode 100644 index 0000000000..9ac625cc5b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-tokens/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-tokens/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTokens::update" + parent: "signalwire::rest::namespaces::compat::CompatTokens" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, token_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 833. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/base-path.mdx new file mode 100644 index 0000000000..2ed5791479 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTranscriptions::base_path" + parent: "signalwire::rest::namespaces::compat::CompatTranscriptions" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 790. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/delete.mdx new file mode 100644 index 0000000000..5664bf1575 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTranscriptions::delete" + parent: "signalwire::rest::namespaces::compat::CompatTranscriptions" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 803. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/get.mdx new file mode 100644 index 0000000000..7174845a1e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTranscriptions::get" + parent: "signalwire::rest::namespaces::compat::CompatTranscriptions" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, sid: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 799. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/index.mdx new file mode 100644 index 0000000000..aaea278c11 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions" +title: "CompatTranscriptions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTranscriptions" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `CompatTranscriptions` + +## Signature + +```rust +struct CompatTranscriptions { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 777. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/list.mdx new file mode 100644 index 0000000000..e29667cd6b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTranscriptions::list" + parent: "signalwire::rest::namespaces::compat::CompatTranscriptions" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 794. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/new.mdx new file mode 100644 index 0000000000..69e3249636 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat-transcriptions/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::CompatTranscriptions::new" + parent: "signalwire::rest::namespaces::compat::CompatTranscriptions" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 783. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/account-sid.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/account-sid.mdx new file mode 100644 index 0000000000..714c57eaf4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/account-sid.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/account-sid" +title: "account_sid" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::account_sid" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `account_sid` + +## Signature + +```rust +fn account_sid(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 33. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/accounts.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/accounts.mdx new file mode 100644 index 0000000000..43bb5e0417 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/accounts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/accounts" +title: "accounts" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::accounts" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `accounts` + +## Signature + +```rust +fn accounts(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 43. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/applications.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/applications.mdx new file mode 100644 index 0000000000..66ee36da1d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/applications.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/applications" +title: "applications" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::applications" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `applications` + +## Signature + +```rust +fn applications(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 67. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/calls.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/calls.mdx new file mode 100644 index 0000000000..3be158d714 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/calls.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/calls" +title: "calls" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::calls" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `calls` + +## Signature + +```rust +fn calls(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 47. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/client.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/client.mdx new file mode 100644 index 0000000000..ac9d63021d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/client" +title: "client" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::client" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `client` + +## Signature + +```rust +fn client(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/conferences.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/conferences.mdx new file mode 100644 index 0000000000..537ea00ac5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/conferences.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/conferences" +title: "conferences" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::conferences" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `conferences` + +## Signature + +```rust +fn conferences(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 59. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/faxes.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/faxes.mdx new file mode 100644 index 0000000000..022ef63eaf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/faxes.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/faxes" +title: "faxes" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::faxes" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `faxes` + +## Signature + +```rust +fn faxes(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 55. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/index.mdx new file mode 100644 index 0000000000..6daa0a051e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat" +title: "Compat" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat" + parent: "signalwire::rest::namespaces::compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `Compat` + +Compat (Twilio-compatible LAML) API namespace. + +Mirrors `signalwire.rest.namespaces.compat.CompatNamespace` from the +Python SDK. The base path is +`/api/laml/2010-04-01/Accounts/{account_sid}` and every sub-resource +is rooted under that. + +## Signature + +```rust +struct Compat { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 16. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/laml-bins.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/laml-bins.mdx new file mode 100644 index 0000000000..79913ea1b7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/laml-bins.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/laml-bins" +title: "laml_bins" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::laml_bins" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `laml_bins` + +## Signature + +```rust +fn laml_bins(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 71. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/messages.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/messages.mdx new file mode 100644 index 0000000000..6efb664d81 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/messages.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/messages" +title: "messages" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::messages" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `messages` + +## Signature + +```rust +fn messages(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 51. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/new.mdx new file mode 100644 index 0000000000..6d0f721b42 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::new" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, account_sid: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 22. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/phone-numbers.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/phone-numbers.mdx new file mode 100644 index 0000000000..47d6ef0314 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/phone-numbers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/phone-numbers" +title: "phone_numbers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::phone_numbers" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `phone_numbers` + +## Signature + +```rust +fn phone_numbers(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 63. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/queues.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/queues.mdx new file mode 100644 index 0000000000..3ae6b38a2c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/queues.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/queues" +title: "queues" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::queues" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `queues` + +## Signature + +```rust +fn queues(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 75. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/recordings.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/recordings.mdx new file mode 100644 index 0000000000..c1f36f7fbc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/recordings.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/recordings" +title: "recordings" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::recordings" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `recordings` + +## Signature + +```rust +fn recordings(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 79. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/tokens.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/tokens.mdx new file mode 100644 index 0000000000..c9c23342ff --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/tokens" +title: "tokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::tokens" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `tokens` + +## Signature + +```rust +fn tokens(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 87. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/transcriptions.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/transcriptions.mdx new file mode 100644 index 0000000000..493e2e2ada --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/compat/transcriptions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat/compat/transcriptions" +title: "transcriptions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat::Compat::transcriptions" + parent: "signalwire::rest::namespaces::compat::Compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `transcriptions` + +## Signature + +```rust +fn transcriptions(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 83. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/index.mdx new file mode 100644 index 0000000000..a1227dd1e2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/compat/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/compat" +title: "compat" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::compat" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs" + visibility: "public" +--- +# `compat` + +## Classes + + + + Compat (Twilio-compatible LAML) API namespace. + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/compat.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/compat.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/base-path.mdx new file mode 100644 index 0000000000..84d16b8684 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments::base_path" + parent: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 42. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/create.mdx new file mode 100644 index 0000000000..39e3312af1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments::create" + parent: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 66. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/delete-chunk.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/delete-chunk.mdx new file mode 100644 index 0000000000..54291296ad --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/delete-chunk.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/delete-chunk" +title: "delete_chunk" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments::delete_chunk" + parent: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `delete_chunk` + +## Signature + +```rust +fn delete_chunk(&self, document_id: &str, chunk_id: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 112. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/delete.mdx new file mode 100644 index 0000000000..8e1754184d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments::delete" + parent: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, document_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 84. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/get-chunk.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/get-chunk.mdx new file mode 100644 index 0000000000..b2d7e3e91f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/get-chunk.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/get-chunk" +title: "get_chunk" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments::get_chunk" + parent: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `get_chunk` + +## Signature + +```rust +fn get_chunk(&self, document_id: &str, chunk_id: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 103. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/get.mdx new file mode 100644 index 0000000000..374bc99b8c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments::get" + parent: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, document_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 70. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/index.mdx new file mode 100644 index 0000000000..5eb2824538 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents" +title: "DatasphereDocuments" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + parent: "signalwire::rest::namespaces::datasphere" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `DatasphereDocuments` + +Datasphere documents resource. + +Rooted at `/api/datasphere/documents` with CRUD plus search and chunk +sub-paths. + +## Signature + +```rust +struct DatasphereDocuments { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/list-chunks.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/list-chunks.mdx new file mode 100644 index 0000000000..33307a035f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/list-chunks.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/list-chunks" +title: "list_chunks" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments::list_chunks" + parent: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `list_chunks` + +## Signature + +```rust +fn list_chunks(&self, document_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 93. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/list.mdx new file mode 100644 index 0000000000..b00912639d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments::list" + parent: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 61. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/new.mdx new file mode 100644 index 0000000000..e0a9019892 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments::new" + parent: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 35. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/search.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/search.mdx new file mode 100644 index 0000000000..5a9c7bfad5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/search.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/search" +title: "search" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments::search" + parent: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `search` + +## Signature + +```rust +fn search(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 89. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/update.mdx new file mode 100644 index 0000000000..a73111d1c1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-documents/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereDocuments::update" + parent: "signalwire::rest::namespaces::datasphere::DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, document_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 75. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace/documents.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace/documents.mdx new file mode 100644 index 0000000000..3c55e0620c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace/documents.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace/documents" +title: "documents" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereNamespace::documents" + parent: "signalwire::rest::namespaces::datasphere::DatasphereNamespace" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `documents` + +## Signature + +```rust +fn documents(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace/index.mdx new file mode 100644 index 0000000000..0814699829 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace" +title: "DatasphereNamespace" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereNamespace" + parent: "signalwire::rest::namespaces::datasphere" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `DatasphereNamespace` + +Datasphere API namespace — exposes documents. + +Mirrors `signalwire.rest.namespaces.datasphere.DatasphereNamespace`. + +## Signature + +```rust +struct DatasphereNamespace { /* fields */ } +``` + +## Methods + + + + + + + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 11. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace/new.mdx new file mode 100644 index 0000000000..8ef80c59e7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere/datasphere-namespace/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere::DatasphereNamespace::new" + parent: "signalwire::rest::namespaces::datasphere::DatasphereNamespace" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 16. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/index.mdx new file mode 100644 index 0000000000..f330b66412 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/datasphere/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/datasphere" +title: "datasphere" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::datasphere" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs" + visibility: "public" +--- +# `datasphere` + +## Classes + + + + Datasphere documents resource. + + + + Datasphere API namespace — exposes documents. + + + +## Source + +[`src/rest/namespaces/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/datasphere.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/base-path.mdx new file mode 100644 index 0000000000..f09d6c233d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CallFlowsResource::base_path" + parent: "signalwire::rest::namespaces::fabric::CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 293. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/create.mdx new file mode 100644 index 0000000000..1e299a6453 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CallFlowsResource::create" + parent: "signalwire::rest::namespaces::fabric::CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 306. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/delete.mdx new file mode 100644 index 0000000000..849b7d294c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CallFlowsResource::delete" + parent: "signalwire::rest::namespaces::fabric::CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, resource_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 324. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/deploy-version.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/deploy-version.mdx new file mode 100644 index 0000000000..e2c9f06587 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/deploy-version.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/deploy-version" +title: "deploy_version" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CallFlowsResource::deploy_version" + parent: "signalwire::rest::namespaces::fabric::CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `deploy_version` + +## Signature + +```rust +fn deploy_version(&self, resource_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 352. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/get.mdx new file mode 100644 index 0000000000..1ffc2ee413 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CallFlowsResource::get" + parent: "signalwire::rest::namespaces::fabric::CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, resource_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 310. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/index.mdx new file mode 100644 index 0000000000..c58d0758a5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource" +title: "CallFlowsResource" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CallFlowsResource" + parent: "signalwire::rest::namespaces::fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `CallFlowsResource` + +## Signature + +```rust +struct CallFlowsResource { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + Sub-resource list — uses singular `call_flow` per the API spec. + + + + + + + + + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 280. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list-addresses.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list-addresses.mdx new file mode 100644 index 0000000000..a268ba9926 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list-addresses.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list-addresses" +title: "list_addresses" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CallFlowsResource::list_addresses" + parent: "signalwire::rest::namespaces::fabric::CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list_addresses` + +Sub-resource list — uses singular `call_flow` per the API spec. + +## Signature + +```rust +fn list_addresses(&self, resource_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 330. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list-versions.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list-versions.mdx new file mode 100644 index 0000000000..98197f4266 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list-versions.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list-versions" +title: "list_versions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CallFlowsResource::list_versions" + parent: "signalwire::rest::namespaces::fabric::CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list_versions` + +## Signature + +```rust +fn list_versions(&self, resource_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 341. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list.mdx new file mode 100644 index 0000000000..19995c5bff --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CallFlowsResource::list" + parent: "signalwire::rest::namespaces::fabric::CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 301. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/new.mdx new file mode 100644 index 0000000000..4d201f1d49 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CallFlowsResource::new" + parent: "signalwire::rest::namespaces::fabric::CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 286. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/update.mdx new file mode 100644 index 0000000000..d4ef435c0c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/call-flows-resource/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CallFlowsResource::update" + parent: "signalwire::rest::namespaces::fabric::CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, resource_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 315. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/base-path.mdx new file mode 100644 index 0000000000..a47be23026 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource::base_path" + parent: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 380. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/create.mdx new file mode 100644 index 0000000000..a8df9d53c2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource::create" + parent: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 393. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/delete.mdx new file mode 100644 index 0000000000..2e92ad18be --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource::delete" + parent: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, resource_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 411. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/get.mdx new file mode 100644 index 0000000000..831fe7fc59 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource::get" + parent: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, resource_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 397. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/index.mdx new file mode 100644 index 0000000000..141f1dda02 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource" +title: "ConferenceRoomsResource" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource" + parent: "signalwire::rest::namespaces::fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `ConferenceRoomsResource` + +## Signature + +```rust +struct ConferenceRoomsResource { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 367. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/list-addresses.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/list-addresses.mdx new file mode 100644 index 0000000000..4d79c30345 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/list-addresses.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/list-addresses" +title: "list_addresses" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource::list_addresses" + parent: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list_addresses` + +## Signature + +```rust +fn list_addresses(&self, resource_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 416. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/list.mdx new file mode 100644 index 0000000000..31d0bf6519 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource::list" + parent: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 388. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/new.mdx new file mode 100644 index 0000000000..463a7c31e0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource::new" + parent: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 373. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/update.mdx new file mode 100644 index 0000000000..ccff45c8ce --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/conference-rooms-resource/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource::update" + parent: "signalwire::rest::namespaces::fabric::ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, resource_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 402. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/base-path.mdx new file mode 100644 index 0000000000..5785f3fb8a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource::base_path" + parent: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 445. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/create.mdx new file mode 100644 index 0000000000..6a8dd1c497 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/create.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource::create" + parent: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `create` + +cXML applications cannot be created via this API. + +Returns an `Err` with a clear "not implemented" message that +mirrors the Python SDK's `NotImplementedError`. No HTTP request +is sent to the server. + +## Signature + +```rust +fn create(&self, _params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 478. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/delete.mdx new file mode 100644 index 0000000000..f76b0a80bc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource::delete" + parent: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, resource_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 468. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/get.mdx new file mode 100644 index 0000000000..a669145e4f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource::get" + parent: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, resource_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 454. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/index.mdx new file mode 100644 index 0000000000..41fbbd68d5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource" +title: "CxmlApplicationsResource" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource" + parent: "signalwire::rest::namespaces::fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `CxmlApplicationsResource` + +## Signature + +```rust +struct CxmlApplicationsResource { /* fields */ } +``` + +## Methods + + + + + + cXML applications cannot be created via this API. + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 432. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/list.mdx new file mode 100644 index 0000000000..d1ceeec6be --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource::list" + parent: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 449. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/new.mdx new file mode 100644 index 0000000000..e9130604ca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource::new" + parent: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 438. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/update.mdx new file mode 100644 index 0000000000..b49eb2aa7f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/cxml-applications-resource/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource::update" + parent: "signalwire::rest::namespaces::fabric::CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, resource_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 459. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/base-path.mdx new file mode 100644 index 0000000000..fb70a99b15 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricAddresses::base_path" + parent: "signalwire::rest::namespaces::fabric::FabricAddresses" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 154. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/get.mdx new file mode 100644 index 0000000000..57acac07a5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricAddresses::get" + parent: "signalwire::rest::namespaces::fabric::FabricAddresses" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, address_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 163. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/index.mdx new file mode 100644 index 0000000000..d2875bb7ca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses" +title: "FabricAddresses" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricAddresses" + parent: "signalwire::rest::namespaces::fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `FabricAddresses` + +## Signature + +```rust +struct FabricAddresses { /* fields */ } +``` + +## Methods + + + + + + + + + + + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 141. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/list.mdx new file mode 100644 index 0000000000..deec80ae04 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricAddresses::list" + parent: "signalwire::rest::namespaces::fabric::FabricAddresses" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 158. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/new.mdx new file mode 100644 index 0000000000..0c060e7526 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-addresses/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricAddresses::new" + parent: "signalwire::rest::namespaces::fabric::FabricAddresses" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 147. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-embed-token.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-embed-token.mdx new file mode 100644 index 0000000000..2bf64d792c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-embed-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-embed-token" +title: "create_embed_token" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricTokens::create_embed_token" + parent: "signalwire::rest::namespaces::fabric::FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `create_embed_token` + +## Signature + +```rust +fn create_embed_token(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 587. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-guest-token.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-guest-token.mdx new file mode 100644 index 0000000000..11da494b6b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-guest-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-guest-token" +title: "create_guest_token" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricTokens::create_guest_token" + parent: "signalwire::rest::namespaces::fabric::FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `create_guest_token` + +## Signature + +```rust +fn create_guest_token(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 580. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-invite-token.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-invite-token.mdx new file mode 100644 index 0000000000..57f5e64d04 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-invite-token.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-invite-token" +title: "create_invite_token" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricTokens::create_invite_token" + parent: "signalwire::rest::namespaces::fabric::FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `create_invite_token` + +Note the singular `subscriber` segment per the spec. + +## Signature + +```rust +fn create_invite_token(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 573. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-subscriber-token.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-subscriber-token.mdx new file mode 100644 index 0000000000..6988de62ac --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-subscriber-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/create-subscriber-token" +title: "create_subscriber_token" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricTokens::create_subscriber_token" + parent: "signalwire::rest::namespaces::fabric::FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `create_subscriber_token` + +## Signature + +```rust +fn create_subscriber_token(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 556. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/index.mdx new file mode 100644 index 0000000000..43b8e859ed --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens" +title: "FabricTokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricTokens" + parent: "signalwire::rest::namespaces::fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `FabricTokens` + +## Signature + +```rust +struct FabricTokens { /* fields */ } +``` + +## Methods + + + + + + + + Note the singular `subscriber` segment per the spec. + + + + + + + + + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 547. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/new.mdx new file mode 100644 index 0000000000..0a7d913e6a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricTokens::new" + parent: "signalwire::rest::namespaces::fabric::FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 552. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token.mdx new file mode 100644 index 0000000000..38ce05b882 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token" +title: "refresh_subscriber_token" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::FabricTokens::refresh_subscriber_token" + parent: "signalwire::rest::namespaces::fabric::FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `refresh_subscriber_token` + +## Signature + +```rust +fn refresh_subscriber_token(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 564. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/addresses.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/addresses.mdx new file mode 100644 index 0000000000..094386184c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/addresses.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/addresses" +title: "addresses" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::addresses" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `addresses` + +Read-only top-level fabric addresses (NOT under `/resources`). + +## Signature + +```rust +fn addresses(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 71. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/ai-agents.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/ai-agents.mdx new file mode 100644 index 0000000000..03e0b3d8d0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/ai-agents.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/ai-agents" +title: "ai_agents" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::ai_agents" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `ai_agents` + +## Signature + +```rust +fn ai_agents(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 106. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/call-flows.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/call-flows.mdx new file mode 100644 index 0000000000..c93743da91 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/call-flows.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/call-flows" +title: "call_flows" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::call_flows" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `call_flows` + +Call flows — exposes a singular `call_flow` sub-path for addresses +/ versions per the API spec. + +## Signature + +```rust +fn call_flows(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 77. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/call-queues.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/call-queues.mdx new file mode 100644 index 0000000000..d1dad40777 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/call-queues.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/call-queues" +title: "call_queues" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::call_queues" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `call_queues` + +## Signature + +```rust +fn call_queues(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 102. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/client.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/client.mdx new file mode 100644 index 0000000000..a16536c65a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/client" +title: "client" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::client" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `client` + +## Signature + +```rust +fn client(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 55. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/conference-rooms.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/conference-rooms.mdx new file mode 100644 index 0000000000..47204bda6a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/conference-rooms.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/conference-rooms" +title: "conference_rooms" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::conference_rooms" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `conference_rooms` + +Conference rooms — singular `conference_room` for sub-paths. + +## Signature + +```rust +fn conference_rooms(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 90. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/conversations.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/conversations.mdx new file mode 100644 index 0000000000..69d09a09bb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/conversations.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/conversations" +title: "conversations" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::conversations" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `conversations` + +## Signature + +```rust +fn conversations(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 85. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/cxml-applications.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/cxml-applications.mdx new file mode 100644 index 0000000000..e72bc8ae6c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/cxml-applications.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/cxml-applications" +title: "cxml_applications" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::cxml_applications" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `cxml_applications` + +cXML applications — read/update/delete only (no create). + +## Signature + +```rust +fn cxml_applications(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 119. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/dial-plans.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/dial-plans.mdx new file mode 100644 index 0000000000..5617a12faf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/dial-plans.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/dial-plans" +title: "dial_plans" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::dial_plans" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `dial_plans` + +## Signature + +```rust +fn dial_plans(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 94. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/freeclimb-apps.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/freeclimb-apps.mdx new file mode 100644 index 0000000000..a9a694262b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/freeclimb-apps.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/freeclimb-apps" +title: "freeclimb_apps" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::freeclimb_apps" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `freeclimb_apps` + +## Signature + +```rust +fn freeclimb_apps(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 98. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/index.mdx new file mode 100644 index 0000000000..09be951416 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/index.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric" +title: "Fabric" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric" + parent: "signalwire::rest::namespaces::fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `Fabric` + +## Signature + +```rust +struct Fabric { /* fields */ } +``` + +## Methods + + + + Read-only top-level fabric addresses (NOT under `/resources`). + + + + + + Call flows — exposes a singular `call_flow` sub-path for addresses / versions per the API spec. + + + + + + + + Conference rooms — singular `conference_room` for sub-paths. + + + + + + cXML applications — read/update/delete only (no create). + + + + + + + + + + + + Generic resource operations across every fabric resource type. + + + + + + + + Subscribers resource — full CRUD plus SIP-endpoint sub-resources. + + + + + + Fabric token factories (subscriber / guest / invite / embed). + + + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 46. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/new.mdx new file mode 100644 index 0000000000..941cd5b3fd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::new" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 51. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/phone-numbers.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/phone-numbers.mdx new file mode 100644 index 0000000000..bee76d8ade --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/phone-numbers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/phone-numbers" +title: "phone_numbers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::phone_numbers" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `phone_numbers` + +## Signature + +```rust +fn phone_numbers(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 114. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/resources.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/resources.mdx new file mode 100644 index 0000000000..42c7e2e342 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/resources.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/resources" +title: "resources" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::resources" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `resources` + +Generic resource operations across every fabric resource type. + +## Signature + +```rust +fn resources(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 127. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/sip-endpoints.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/sip-endpoints.mdx new file mode 100644 index 0000000000..bff433b1cf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/sip-endpoints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/sip-endpoints" +title: "sip_endpoints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::sip_endpoints" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `sip_endpoints` + +## Signature + +```rust +fn sip_endpoints(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 66. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/sip-profiles.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/sip-profiles.mdx new file mode 100644 index 0000000000..aae2777788 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/sip-profiles.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/sip-profiles" +title: "sip_profiles" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::sip_profiles" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `sip_profiles` + +## Signature + +```rust +fn sip_profiles(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 110. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/subscribers.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/subscribers.mdx new file mode 100644 index 0000000000..d2cdba486b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/subscribers.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/subscribers" +title: "subscribers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::subscribers" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `subscribers` + +Subscribers resource — full CRUD plus SIP-endpoint sub-resources. + +## Signature + +```rust +fn subscribers(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 62. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/swml-scripts.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/swml-scripts.mdx new file mode 100644 index 0000000000..4305056d4e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/swml-scripts.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/swml-scripts" +title: "swml_scripts" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::swml_scripts" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `swml_scripts` + +## Signature + +```rust +fn swml_scripts(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 81. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/tokens.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/tokens.mdx new file mode 100644 index 0000000000..b4aa04bb35 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/fabric/tokens.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/fabric/tokens" +title: "tokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::Fabric::tokens" + parent: "signalwire::rest::namespaces::fabric::Fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `tokens` + +Fabric token factories (subscriber / guest / invite / embed). + +## Signature + +```rust +fn tokens(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 132. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/assign-domain-application.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/assign-domain-application.mdx new file mode 100644 index 0000000000..25fc32b038 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/assign-domain-application.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/generic-resources/assign-domain-application" +title: "assign_domain_application" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::GenericResources::assign_domain_application" + parent: "signalwire::rest::namespaces::fabric::GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `assign_domain_application` + +## Signature + +```rust +fn assign_domain_application(&self, resource_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 533. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/base-path.mdx new file mode 100644 index 0000000000..87d19f78b2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/generic-resources/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::GenericResources::base_path" + parent: "signalwire::rest::namespaces::fabric::GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 504. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/delete.mdx new file mode 100644 index 0000000000..4dfc9062e0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/generic-resources/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::GenericResources::delete" + parent: "signalwire::rest::namespaces::fabric::GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, resource_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 518. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/get.mdx new file mode 100644 index 0000000000..395634b89b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/generic-resources/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::GenericResources::get" + parent: "signalwire::rest::namespaces::fabric::GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, resource_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 513. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/index.mdx new file mode 100644 index 0000000000..f52aaf3db3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/generic-resources" +title: "GenericResources" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::GenericResources" + parent: "signalwire::rest::namespaces::fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `GenericResources` + +## Signature + +```rust +struct GenericResources { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 491. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/list-addresses.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/list-addresses.mdx new file mode 100644 index 0000000000..15ee999990 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/list-addresses.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/generic-resources/list-addresses" +title: "list_addresses" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::GenericResources::list_addresses" + parent: "signalwire::rest::namespaces::fabric::GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list_addresses` + +## Signature + +```rust +fn list_addresses(&self, resource_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 523. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/list.mdx new file mode 100644 index 0000000000..bae604f778 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/generic-resources/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::GenericResources::list" + parent: "signalwire::rest::namespaces::fabric::GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 508. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/new.mdx new file mode 100644 index 0000000000..44d0593f3d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/generic-resources/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/generic-resources/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::GenericResources::new" + parent: "signalwire::rest::namespaces::fabric::GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 497. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/index.mdx new file mode 100644 index 0000000000..7ac42cc193 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric" +title: "fabric" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `fabric` + +REST API namespace modules. +Fabric API namespace — resource composition, addresses, and tokens. + +Mirrors `signalwire.rest.namespaces.fabric.FabricNamespace` from the +Python SDK. + +## Classes + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/base-path.mdx new file mode 100644 index 0000000000..992ae0e371 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::base_path" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 186. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint.mdx new file mode 100644 index 0000000000..c660191717 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint" +title: "create_sip_endpoint" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::create_sip_endpoint" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `create_sip_endpoint` + +## Signature + +```rust +fn create_sip_endpoint(&self, subscriber_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 238. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/create.mdx new file mode 100644 index 0000000000..ca6d8e3c5a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::create" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 195. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint.mdx new file mode 100644 index 0000000000..b84e8e9854 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint" +title: "delete_sip_endpoint" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::delete_sip_endpoint" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `delete_sip_endpoint` + +## Signature + +```rust +fn delete_sip_endpoint(&self, subscriber_id: &str, endpoint_id: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 266. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/delete.mdx new file mode 100644 index 0000000000..beda18f7f9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::delete" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, subscriber_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 213. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint.mdx new file mode 100644 index 0000000000..4b6d841c85 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint" +title: "get_sip_endpoint" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::get_sip_endpoint" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `get_sip_endpoint` + +## Signature + +```rust +fn get_sip_endpoint(&self, subscriber_id: &str, endpoint_id: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 247. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/get.mdx new file mode 100644 index 0000000000..b6fbbca604 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::get" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, subscriber_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 199. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/index.mdx new file mode 100644 index 0000000000..6249ece323 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource" +title: "SubscribersResource" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource" + parent: "signalwire::rest::namespaces::fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `SubscribersResource` + +## Signature + +```rust +struct SubscribersResource { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 173. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list-addresses.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list-addresses.mdx new file mode 100644 index 0000000000..978097eab4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list-addresses.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list-addresses" +title: "list_addresses" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::list_addresses" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list_addresses` + +## Signature + +```rust +fn list_addresses(&self, subscriber_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 218. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints.mdx new file mode 100644 index 0000000000..305931afb8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints" +title: "list_sip_endpoints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::list_sip_endpoints" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list_sip_endpoints` + +## Signature + +```rust +fn list_sip_endpoints(&self, subscriber_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 228. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list.mdx new file mode 100644 index 0000000000..5095826dcb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::list" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 190. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/new.mdx new file mode 100644 index 0000000000..0787c5d276 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::new" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 179. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint.mdx new file mode 100644 index 0000000000..e5eb139981 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint" +title: "update_sip_endpoint" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::update_sip_endpoint" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `update_sip_endpoint` + +## Signature + +```rust +fn update_sip_endpoint( + &self, + subscriber_id: &str, + endpoint_id: &str, + params: &? +) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 256. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/update.mdx new file mode 100644 index 0000000000..29b9af3cb4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/fabric/subscribers-resource/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::fabric::SubscribersResource::update" + parent: "signalwire::rest::namespaces::fabric::SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, subscriber_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/fabric.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/fabric.rs) + +Line 204. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/index.mdx new file mode 100644 index 0000000000..11d7fb36c4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces" +title: "namespaces" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces" + parent: "signalwire::rest" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mod.rs" + visibility: "public" +--- +# `namespaces` + +## Modules + + + + + + + + + + REST API namespace modules. Fabric API namespace — resource composition, addresses, and tokens. + + + + Logs namespace — message, voice, fax, conference logs (read-only). + + + + + + + + + + + + 10DLC Campaign Registry namespace — brands, campaigns, orders, numbers. + + + + + + Video API namespace — rooms, sessions, recordings, conferences, tokens, streams. + + + +## Source + +[`src/rest/namespaces/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/base-path.mdx new file mode 100644 index 0000000000..70c01a7ef9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/conference-logs/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::ConferenceLogs::base_path" + parent: "signalwire::rest::namespaces::logs::ConferenceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 196. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/index.mdx new file mode 100644 index 0000000000..d0557c126e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/conference-logs" +title: "ConferenceLogs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::ConferenceLogs" + parent: "signalwire::rest::namespaces::logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `ConferenceLogs` + +## Signature + +```rust +struct ConferenceLogs { /* fields */ } +``` + +## Methods + + + + + + + + + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 183. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/list.mdx new file mode 100644 index 0000000000..83c8618d49 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/conference-logs/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::ConferenceLogs::list" + parent: "signalwire::rest::namespaces::logs::ConferenceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 200. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/new.mdx new file mode 100644 index 0000000000..58d19ea258 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/conference-logs/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/conference-logs/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::ConferenceLogs::new" + parent: "signalwire::rest::namespaces::logs::ConferenceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 189. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/base-path.mdx new file mode 100644 index 0000000000..792beb3791 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/fax-logs/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::FaxLogs::base_path" + parent: "signalwire::rest::namespaces::logs::FaxLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 164. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/get.mdx new file mode 100644 index 0000000000..e109ba7ac4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/fax-logs/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::FaxLogs::get" + parent: "signalwire::rest::namespaces::logs::FaxLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, log_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 173. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/index.mdx new file mode 100644 index 0000000000..e01b0be10e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/fax-logs" +title: "FaxLogs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::FaxLogs" + parent: "signalwire::rest::namespaces::logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `FaxLogs` + +## Signature + +```rust +struct FaxLogs { /* fields */ } +``` + +## Methods + + + + + + + + + + + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 151. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/list.mdx new file mode 100644 index 0000000000..6e2af2214d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/fax-logs/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::FaxLogs::list" + parent: "signalwire::rest::namespaces::logs::FaxLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 168. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/new.mdx new file mode 100644 index 0000000000..c5d07cbd49 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/fax-logs/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/fax-logs/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::FaxLogs::new" + parent: "signalwire::rest::namespaces::logs::FaxLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 157. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/index.mdx new file mode 100644 index 0000000000..a70f41589c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs" +title: "logs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `logs` + +Logs namespace — message, voice, fax, conference logs (read-only). + +Mirrors `signalwire.rest.namespaces.logs.LogsNamespace`. Each +sub-resource binds to a different sub-API path because the upstream +specs live in different documents. + +## Classes + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/client.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/client.mdx new file mode 100644 index 0000000000..031b4a1d7d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/logs/client" +title: "client" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::Logs::client" + parent: "signalwire::rest::namespaces::logs::Logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `client` + +## Signature + +```rust +fn client(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 52. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/conferences.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/conferences.mdx new file mode 100644 index 0000000000..9171d2a06e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/conferences.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/logs/conferences" +title: "conferences" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::Logs::conferences" + parent: "signalwire::rest::namespaces::logs::Logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `conferences` + +## Signature + +```rust +fn conferences(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 68. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/fax.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/fax.mdx new file mode 100644 index 0000000000..c7c06a679c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/fax.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/logs/fax" +title: "fax" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::Logs::fax" + parent: "signalwire::rest::namespaces::logs::Logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `fax` + +## Signature + +```rust +fn fax(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 64. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/index.mdx new file mode 100644 index 0000000000..1ce4d5c690 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/logs" +title: "Logs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::Logs" + parent: "signalwire::rest::namespaces::logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `Logs` + +## Signature + +```rust +struct Logs { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 43. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/messages.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/messages.mdx new file mode 100644 index 0000000000..932ddd17c9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/messages.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/logs/messages" +title: "messages" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::Logs::messages" + parent: "signalwire::rest::namespaces::logs::Logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `messages` + +## Signature + +```rust +fn messages(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 56. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/new.mdx new file mode 100644 index 0000000000..ee77319772 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/logs/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::Logs::new" + parent: "signalwire::rest::namespaces::logs::Logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 48. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/voice.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/voice.mdx new file mode 100644 index 0000000000..57014d4100 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/logs/voice.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/logs/voice" +title: "voice" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::Logs::voice" + parent: "signalwire::rest::namespaces::logs::Logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `voice` + +## Signature + +```rust +fn voice(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 60. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/base-path.mdx new file mode 100644 index 0000000000..98a0529c5c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/message-logs/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::MessageLogs::base_path" + parent: "signalwire::rest::namespaces::logs::MessageLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 90. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/get.mdx new file mode 100644 index 0000000000..557c0d4f9c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/message-logs/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::MessageLogs::get" + parent: "signalwire::rest::namespaces::logs::MessageLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, log_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 99. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/index.mdx new file mode 100644 index 0000000000..31089eba86 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/message-logs" +title: "MessageLogs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::MessageLogs" + parent: "signalwire::rest::namespaces::logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `MessageLogs` + +## Signature + +```rust +struct MessageLogs { /* fields */ } +``` + +## Methods + + + + + + + + + + + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 77. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/list.mdx new file mode 100644 index 0000000000..4a3c8c977b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/message-logs/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::MessageLogs::list" + parent: "signalwire::rest::namespaces::logs::MessageLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 94. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/new.mdx new file mode 100644 index 0000000000..a0510c5dbb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/message-logs/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/message-logs/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::MessageLogs::new" + parent: "signalwire::rest::namespaces::logs::MessageLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 83. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/base-path.mdx new file mode 100644 index 0000000000..f12ed7c285 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/voice-logs/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::VoiceLogs::base_path" + parent: "signalwire::rest::namespaces::logs::VoiceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 122. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/get.mdx new file mode 100644 index 0000000000..ae2c6ac5c5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/voice-logs/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::VoiceLogs::get" + parent: "signalwire::rest::namespaces::logs::VoiceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, log_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 131. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/index.mdx new file mode 100644 index 0000000000..f2b27f46ff --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/voice-logs" +title: "VoiceLogs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::VoiceLogs" + parent: "signalwire::rest::namespaces::logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `VoiceLogs` + +## Signature + +```rust +struct VoiceLogs { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 109. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/list-events.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/list-events.mdx new file mode 100644 index 0000000000..24234fb35b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/list-events.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/voice-logs/list-events" +title: "list_events" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::VoiceLogs::list_events" + parent: "signalwire::rest::namespaces::logs::VoiceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `list_events` + +## Signature + +```rust +fn list_events(&self, log_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 136. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/list.mdx new file mode 100644 index 0000000000..85f6e4a4be --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/voice-logs/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::VoiceLogs::list" + parent: "signalwire::rest::namespaces::logs::VoiceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 126. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/new.mdx new file mode 100644 index 0000000000..d5d0c6092d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/logs/voice-logs/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/logs/voice-logs/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::logs::VoiceLogs::new" + parent: "signalwire::rest::namespaces::logs::VoiceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/logs.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/logs.rs) + +Line 115. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/index.mdx new file mode 100644 index 0000000000..c4e51f53cc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/mfa" +title: "mfa" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::mfa" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs" + visibility: "public" +--- +# `mfa` + +## Classes + + + + MFA (Multi-Factor Authentication) namespace. + + + +## Source + +[`src/rest/namespaces/mfa.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/base-path.mdx new file mode 100644 index 0000000000..e3b2da9de3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/mfa/mfa/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::mfa::Mfa::base_path" + parent: "signalwire::rest::namespaces::mfa::Mfa" + module: "rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/mfa.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs) + +Line 24. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/call.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/call.mdx new file mode 100644 index 0000000000..a9ebc97ff0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/call.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/mfa/mfa/call" +title: "call" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::mfa::Mfa::call" + parent: "signalwire::rest::namespaces::mfa::Mfa" + module: "rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs" + visibility: "public" +--- +# `call` + +POST /api/relay/rest/mfa/call — deliver a one-time code via voice. + +## Signature + +```rust +fn call(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/mfa.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs) + +Line 34. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/index.mdx new file mode 100644 index 0000000000..b9ed3d9f5d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/mfa/mfa" +title: "Mfa" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::mfa::Mfa" + parent: "signalwire::rest::namespaces::mfa" + module: "rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs" + visibility: "public" +--- +# `Mfa` + +MFA (Multi-Factor Authentication) namespace. + +Mirrors `signalwire.rest.namespaces.mfa.MfaResource` from the Python SDK. +Rooted at `/api/relay/rest/mfa` with `sms`, `call`, and `verify` +sub-paths. + +## Signature + +```rust +struct Mfa { /* fields */ } +``` + +## Methods + + + + + + POST /api/relay/rest/mfa/call — deliver a one-time code via voice. + + + + + + POST /api/relay/rest/mfa/sms — send a one-time code over SMS. + + + + POST /api/relay/rest/mfa/\{request\_id\}/verify — verify a code. + + + +## Source + +[`src/rest/namespaces/mfa.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs) + +Line 11. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/new.mdx new file mode 100644 index 0000000000..0d72530260 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/mfa/mfa/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::mfa::Mfa::new" + parent: "signalwire::rest::namespaces::mfa::Mfa" + module: "rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/mfa.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs) + +Line 17. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/sms.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/sms.mdx new file mode 100644 index 0000000000..676b2d46f0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/sms.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/mfa/mfa/sms" +title: "sms" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::mfa::Mfa::sms" + parent: "signalwire::rest::namespaces::mfa::Mfa" + module: "rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs" + visibility: "public" +--- +# `sms` + +POST /api/relay/rest/mfa/sms — send a one-time code over SMS. + +## Signature + +```rust +fn sms(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/mfa.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/verify.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/verify.mdx new file mode 100644 index 0000000000..02dea20cfa --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/mfa/mfa/verify.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/mfa/mfa/verify" +title: "verify" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::mfa::Mfa::verify" + parent: "signalwire::rest::namespaces::mfa::Mfa" + module: "rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs" + visibility: "public" +--- +# `verify` + +POST /api/relay/rest/mfa/\{request\_id\}/verify — verify a code. + +## Signature + +```rust +fn verify(&self, request_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/mfa.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/mfa.rs) + +Line 39. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/index.mdx new file mode 100644 index 0000000000..c4a36a367a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups" +title: "number_groups" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `number_groups` + +## Classes + + + + Number Groups namespace. + + + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/add-membership.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/add-membership.mdx new file mode 100644 index 0000000000..91eed311e2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/add-membership.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups/add-membership" +title: "add_membership" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups::add_membership" + parent: "signalwire::rest::namespaces::number_groups::NumberGroups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `add_membership` + +## Signature + +```rust +fn add_membership(&self, group_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 88. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/base-path.mdx new file mode 100644 index 0000000000..7fcab0a88d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups::base_path" + parent: "signalwire::rest::namespaces::number_groups::NumberGroups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 27. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/create.mdx new file mode 100644 index 0000000000..71c99ec9a6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups::create" + parent: "signalwire::rest::namespaces::number_groups::NumberGroups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 51. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/delete-membership.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/delete-membership.mdx new file mode 100644 index 0000000000..4280792923 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/delete-membership.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups/delete-membership" +title: "delete_membership" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups::delete_membership" + parent: "signalwire::rest::namespaces::number_groups::NumberGroups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `delete_membership` + +## Signature + +```rust +fn delete_membership(&self, membership_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 111. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/delete.mdx new file mode 100644 index 0000000000..0cad5074d8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups::delete" + parent: "signalwire::rest::namespaces::number_groups::NumberGroups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, group_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 69. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/get-membership.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/get-membership.mdx new file mode 100644 index 0000000000..6cb85f6032 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/get-membership.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups/get-membership" +title: "get_membership" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups::get_membership" + parent: "signalwire::rest::namespaces::number_groups::NumberGroups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `get_membership` + +## Signature + +```rust +fn get_membership(&self, membership_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 100. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/get.mdx new file mode 100644 index 0000000000..c8b1cb6a37 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups::get" + parent: "signalwire::rest::namespaces::number_groups::NumberGroups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, group_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 55. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/index.mdx new file mode 100644 index 0000000000..279abbce00 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups" +title: "NumberGroups" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups" + parent: "signalwire::rest::namespaces::number_groups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `NumberGroups` + +Number Groups namespace. + +Mirrors `signalwire.rest.namespaces.number_groups.NumberGroupsResource`. +Provides standard CRUD over `/api/relay/rest/number_groups` plus the +membership endpoints rooted at the same collection and at the +project-scoped `/api/relay/rest/number_group_memberships` collection. + +## Signature + +```rust +struct NumberGroups { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + GET /api/relay/rest/number\_groups/\{id\}/number\_group\_memberships + + + + + + + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 14. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/list-memberships.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/list-memberships.mdx new file mode 100644 index 0000000000..568510d8dc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/list-memberships.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups/list-memberships" +title: "list_memberships" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups::list_memberships" + parent: "signalwire::rest::namespaces::number_groups::NumberGroups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `list_memberships` + +GET /api/relay/rest/number\_groups/\{id\}/number\_group\_memberships + +## Signature + +```rust +fn list_memberships(&self, group_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 75. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/list.mdx new file mode 100644 index 0000000000..8e1d5c3104 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups::list" + parent: "signalwire::rest::namespaces::number_groups::NumberGroups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 46. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/new.mdx new file mode 100644 index 0000000000..fe82d0c242 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups::new" + parent: "signalwire::rest::namespaces::number_groups::NumberGroups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/update.mdx new file mode 100644 index 0000000000..757d1e52af --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/number-groups/number-groups/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/number-groups/number-groups/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::number_groups::NumberGroups::update" + parent: "signalwire::rest::namespaces::number_groups::NumberGroups" + module: "rest.namespaces.number_groups" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, group_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/number_groups.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/number_groups.rs) + +Line 60. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/index.mdx new file mode 100644 index 0000000000..762237c313 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/project" +title: "project" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::project" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs" + visibility: "public" +--- +# `project` + +## Classes + + + + Project API namespace — exposes the API token sub-resource. + + + + Project API token management. + + + +## Source + +[`src/rest/namespaces/project.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/base-path.mdx new file mode 100644 index 0000000000..c6d367fd76 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/project/project-tokens/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::project::ProjectTokens::base_path" + parent: "signalwire::rest::namespaces::project::ProjectTokens" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/project.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs) + +Line 40. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/create.mdx new file mode 100644 index 0000000000..f2a36ae529 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/project/project-tokens/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::project::ProjectTokens::create" + parent: "signalwire::rest::namespaces::project::ProjectTokens" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/project.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs) + +Line 44. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/delete.mdx new file mode 100644 index 0000000000..77d6ff075e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/project/project-tokens/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::project::ProjectTokens::delete" + parent: "signalwire::rest::namespaces::project::ProjectTokens" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, token_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/project.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs) + +Line 57. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/index.mdx new file mode 100644 index 0000000000..84029538eb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/project/project-tokens" +title: "ProjectTokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::project::ProjectTokens" + parent: "signalwire::rest::namespaces::project" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs" + visibility: "public" +--- +# `ProjectTokens` + +Project API token management. + +Mirrors `ProjectTokens` from the Python SDK. Rooted at +`/api/project/tokens`. + +## Signature + +```rust +struct ProjectTokens { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/project.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs) + +Line 27. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/new.mdx new file mode 100644 index 0000000000..6be280d281 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/project/project-tokens/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::project::ProjectTokens::new" + parent: "signalwire::rest::namespaces::project::ProjectTokens" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/project.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs) + +Line 33. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/update.mdx new file mode 100644 index 0000000000..405c0f36bb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project-tokens/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/project/project-tokens/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::project::ProjectTokens::update" + parent: "signalwire::rest::namespaces::project::ProjectTokens" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, token_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/project.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs) + +Line 48. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project/index.mdx new file mode 100644 index 0000000000..d65da929ea --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/project/project" +title: "Project" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::project::Project" + parent: "signalwire::rest::namespaces::project" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs" + visibility: "public" +--- +# `Project` + +Project API namespace — exposes the API token sub-resource. + +Mirrors `signalwire.rest.namespaces.project.ProjectNamespace`. + +## Signature + +```rust +struct Project { /* fields */ } +``` + +## Methods + + + + + + + +## Source + +[`src/rest/namespaces/project.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs) + +Line 9. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project/new.mdx new file mode 100644 index 0000000000..559d7092ed --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/project/project/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::project::Project::new" + parent: "signalwire::rest::namespaces::project::Project" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/project.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs) + +Line 14. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project/tokens.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project/tokens.mdx new file mode 100644 index 0000000000..16a406029a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/project/project/tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/project/project/tokens" +title: "tokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::project::Project::tokens" + parent: "signalwire::rest::namespaces::project::Project" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs" + visibility: "public" +--- +# `tokens` + +## Signature + +```rust +fn tokens(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/project.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/project.rs) + +Line 18. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/index.mdx new file mode 100644 index 0000000000..8d88a34379 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues" +title: "queues" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `queues` + +## Classes + + + + Queues namespace. + + + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/base-path.mdx new file mode 100644 index 0000000000..57302d5be9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues/queues/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues::Queues::base_path" + parent: "signalwire::rest::namespaces::queues::Queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/create.mdx new file mode 100644 index 0000000000..949f3bf6c4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues/queues/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues::Queues::create" + parent: "signalwire::rest::namespaces::queues::Queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 49. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/delete.mdx new file mode 100644 index 0000000000..5821e44c2e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues/queues/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues::Queues::delete" + parent: "signalwire::rest::namespaces::queues::Queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, queue_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 67. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/get-member.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/get-member.mdx new file mode 100644 index 0000000000..50bfeedd42 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/get-member.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues/queues/get-member" +title: "get_member" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues::Queues::get_member" + parent: "signalwire::rest::namespaces::queues::Queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `get_member` + +## Signature + +```rust +fn get_member(&self, queue_id: &str, member_id: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 90. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/get-next-member.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/get-next-member.mdx new file mode 100644 index 0000000000..a6b595e998 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/get-next-member.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues/queues/get-next-member" +title: "get_next_member" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues::Queues::get_next_member" + parent: "signalwire::rest::namespaces::queues::Queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `get_next_member` + +## Signature + +```rust +fn get_next_member(&self, queue_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 82. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/get.mdx new file mode 100644 index 0000000000..cbc8a84dd3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues/queues/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues::Queues::get" + parent: "signalwire::rest::namespaces::queues::Queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, queue_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 53. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/index.mdx new file mode 100644 index 0000000000..1c3810508d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues/queues" +title: "Queues" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues::Queues" + parent: "signalwire::rest::namespaces::queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `Queues` + +Queues namespace. + +Mirrors `signalwire.rest.namespaces.queues.QueuesResource`. CRUD over +`/api/relay/rest/queues` plus the queue-member operations. + +## Signature + +```rust +struct Queues { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/list-members.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/list-members.mdx new file mode 100644 index 0000000000..f11b0a9606 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/list-members.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues/queues/list-members" +title: "list_members" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues::Queues::list_members" + parent: "signalwire::rest::namespaces::queues::Queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `list_members` + +## Signature + +```rust +fn list_members(&self, queue_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 72. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/list.mdx new file mode 100644 index 0000000000..694ac67818 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues/queues/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues::Queues::list" + parent: "signalwire::rest::namespaces::queues::Queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 44. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/new.mdx new file mode 100644 index 0000000000..270829c4c2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues/queues/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues::Queues::new" + parent: "signalwire::rest::namespaces::queues::Queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 18. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/update.mdx new file mode 100644 index 0000000000..81fd10e1e6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/queues/queues/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/queues/queues/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::queues::Queues::update" + parent: "signalwire::rest::namespaces::queues::Queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, queue_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/queues.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/queues.rs) + +Line 58. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/index.mdx new file mode 100644 index 0000000000..ad33254cee --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry" +title: "registry" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `registry` + +10DLC Campaign Registry namespace — brands, campaigns, orders, numbers. + +Mirrors `signalwire.rest.namespaces.registry.RegistryNamespace`. Every +sub-resource lives under `/api/relay/rest/registry/beta`. + +## Classes + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/base-path.mdx new file mode 100644 index 0000000000..ee5d60eac9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-brands/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryBrands::base_path" + parent: "signalwire::rest::namespaces::registry::RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 91. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/create-campaign.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/create-campaign.mdx new file mode 100644 index 0000000000..f19341dd79 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/create-campaign.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-brands/create-campaign" +title: "create_campaign" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryBrands::create_campaign" + parent: "signalwire::rest::namespaces::registry::RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `create_campaign` + +## Signature + +```rust +fn create_campaign(&self, brand_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 119. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/create.mdx new file mode 100644 index 0000000000..39609cb171 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-brands/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryBrands::create" + parent: "signalwire::rest::namespaces::registry::RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 100. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/get.mdx new file mode 100644 index 0000000000..651f9e1661 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-brands/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryBrands::get" + parent: "signalwire::rest::namespaces::registry::RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, brand_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 104. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/index.mdx new file mode 100644 index 0000000000..de721d83de --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-brands" +title: "RegistryBrands" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryBrands" + parent: "signalwire::rest::namespaces::registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `RegistryBrands` + +## Signature + +```rust +struct RegistryBrands { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 78. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/list-campaigns.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/list-campaigns.mdx new file mode 100644 index 0000000000..664470aaef --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/list-campaigns.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-brands/list-campaigns" +title: "list_campaigns" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryBrands::list_campaigns" + parent: "signalwire::rest::namespaces::registry::RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `list_campaigns` + +## Signature + +```rust +fn list_campaigns(&self, brand_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 109. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/list.mdx new file mode 100644 index 0000000000..302c25b607 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-brands/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryBrands::list" + parent: "signalwire::rest::namespaces::registry::RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 95. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/new.mdx new file mode 100644 index 0000000000..ac77791a5c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-brands/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-brands/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryBrands::new" + parent: "signalwire::rest::namespaces::registry::RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 84. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/base-path.mdx new file mode 100644 index 0000000000..862cf9703c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryCampaigns::base_path" + parent: "signalwire::rest::namespaces::registry::RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 146. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/create-order.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/create-order.mdx new file mode 100644 index 0000000000..6c72fc42fc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/create-order.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/create-order" +title: "create_order" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryCampaigns::create_order" + parent: "signalwire::rest::namespaces::registry::RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `create_order` + +## Signature + +```rust +fn create_order(&self, campaign_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 184. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/get.mdx new file mode 100644 index 0000000000..23d47200e9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryCampaigns::get" + parent: "signalwire::rest::namespaces::registry::RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, campaign_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 150. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/index.mdx new file mode 100644 index 0000000000..016091e8be --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-campaigns" +title: "RegistryCampaigns" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryCampaigns" + parent: "signalwire::rest::namespaces::registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `RegistryCampaigns` + +## Signature + +```rust +struct RegistryCampaigns { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 133. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/list-numbers.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/list-numbers.mdx new file mode 100644 index 0000000000..45db5067eb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/list-numbers.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/list-numbers" +title: "list_numbers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryCampaigns::list_numbers" + parent: "signalwire::rest::namespaces::registry::RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `list_numbers` + +## Signature + +```rust +fn list_numbers(&self, campaign_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 164. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/list-orders.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/list-orders.mdx new file mode 100644 index 0000000000..8334152ea4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/list-orders.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/list-orders" +title: "list_orders" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryCampaigns::list_orders" + parent: "signalwire::rest::namespaces::registry::RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `list_orders` + +## Signature + +```rust +fn list_orders(&self, campaign_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 174. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/new.mdx new file mode 100644 index 0000000000..9a9daa8111 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryCampaigns::new" + parent: "signalwire::rest::namespaces::registry::RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 139. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/update.mdx new file mode 100644 index 0000000000..bc7ba2a8f1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-campaigns/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryCampaigns::update" + parent: "signalwire::rest::namespaces::registry::RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, campaign_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 155. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/base-path.mdx new file mode 100644 index 0000000000..795daa69ca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-numbers/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryNumbers::base_path" + parent: "signalwire::rest::namespaces::registry::RegistryNumbers" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 238. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/delete.mdx new file mode 100644 index 0000000000..ba1a37555c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-numbers/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryNumbers::delete" + parent: "signalwire::rest::namespaces::registry::RegistryNumbers" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, number_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 242. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/index.mdx new file mode 100644 index 0000000000..e5a68f3819 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-numbers" +title: "RegistryNumbers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryNumbers" + parent: "signalwire::rest::namespaces::registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `RegistryNumbers` + +## Signature + +```rust +struct RegistryNumbers { /* fields */ } +``` + +## Methods + + + + + + + + + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 225. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/new.mdx new file mode 100644 index 0000000000..813df6410b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-numbers/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-numbers/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryNumbers::new" + parent: "signalwire::rest::namespaces::registry::RegistryNumbers" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 231. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/base-path.mdx new file mode 100644 index 0000000000..52d6f72864 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-orders/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryOrders::base_path" + parent: "signalwire::rest::namespaces::registry::RegistryOrders" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 211. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/get.mdx new file mode 100644 index 0000000000..375205f28b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-orders/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryOrders::get" + parent: "signalwire::rest::namespaces::registry::RegistryOrders" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, order_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 215. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/index.mdx new file mode 100644 index 0000000000..76abce2dff --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-orders" +title: "RegistryOrders" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryOrders" + parent: "signalwire::rest::namespaces::registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `RegistryOrders` + +## Signature + +```rust +struct RegistryOrders { /* fields */ } +``` + +## Methods + + + + + + + + + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 198. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/new.mdx new file mode 100644 index 0000000000..0c1a0cd1b5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry-orders/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry-orders/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::RegistryOrders::new" + parent: "signalwire::rest::namespaces::registry::RegistryOrders" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 204. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/brands.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/brands.mdx new file mode 100644 index 0000000000..2661fd6aad --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/brands.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry/brands" +title: "brands" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::Registry::brands" + parent: "signalwire::rest::namespaces::registry::Registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `brands` + +## Signature + +```rust +fn brands(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 57. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/campaigns.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/campaigns.mdx new file mode 100644 index 0000000000..17b092290f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/campaigns.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry/campaigns" +title: "campaigns" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::Registry::campaigns" + parent: "signalwire::rest::namespaces::registry::Registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `campaigns` + +## Signature + +```rust +fn campaigns(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 61. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/client.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/client.mdx new file mode 100644 index 0000000000..28c440f0cd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry/client" +title: "client" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::Registry::client" + parent: "signalwire::rest::namespaces::registry::Registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `client` + +## Signature + +```rust +fn client(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 53. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/index.mdx new file mode 100644 index 0000000000..51e7946f9d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry" +title: "Registry" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::Registry" + parent: "signalwire::rest::namespaces::registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `Registry` + +## Signature + +```rust +struct Registry { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 44. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/new.mdx new file mode 100644 index 0000000000..c03f51b0aa --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::Registry::new" + parent: "signalwire::rest::namespaces::registry::Registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 49. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/numbers.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/numbers.mdx new file mode 100644 index 0000000000..7f56433b83 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/numbers.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry/numbers" +title: "numbers" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::Registry::numbers" + parent: "signalwire::rest::namespaces::registry::Registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `numbers` + +## Signature + +```rust +fn numbers(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 69. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/orders.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/orders.mdx new file mode 100644 index 0000000000..44b8363d9d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/registry/registry/orders.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/registry/registry/orders" +title: "orders" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::registry::Registry::orders" + parent: "signalwire::rest::namespaces::registry::Registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs" + visibility: "public" +--- +# `orders` + +## Signature + +```rust +fn orders(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/registry.rs) + +Line 65. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/index.mdx new file mode 100644 index 0000000000..ec24f338ea --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/sip-profile" +title: "sip_profile" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::sip_profile" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs" + visibility: "public" +--- +# `sip_profile` + +## Classes + + + + SIP Profile (singleton resource) namespace. + + + +## Source + +[`src/rest/namespaces/sip_profile.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/base-path.mdx new file mode 100644 index 0000000000..e0e7bd865e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::sip_profile::SipProfile::base_path" + parent: "signalwire::rest::namespaces::sip_profile::SipProfile" + module: "rest.namespaces.sip_profile" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/sip_profile.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs) + +Line 24. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/get.mdx new file mode 100644 index 0000000000..6f6657827c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/get.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::sip_profile::SipProfile::get" + parent: "signalwire::rest::namespaces::sip_profile::SipProfile" + module: "rest.namespaces.sip_profile" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs" + visibility: "public" +--- +# `get` + +GET /api/relay/rest/sip\_profile — fetch the current profile. + +## Signature + +```rust +fn get(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/sip_profile.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/index.mdx new file mode 100644 index 0000000000..98086e4a39 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile" +title: "SipProfile" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::sip_profile::SipProfile" + parent: "signalwire::rest::namespaces::sip_profile" + module: "rest.namespaces.sip_profile" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs" + visibility: "public" +--- +# `SipProfile` + +SIP Profile (singleton resource) namespace. + +Mirrors `signalwire.rest.namespaces.sip_profile.SipProfileResource`. +Rooted at `/api/relay/rest/sip_profile` (singular) — the project has +exactly one SIP profile, so there is no list/create/delete. + +## Signature + +```rust +struct SipProfile { /* fields */ } +``` + +## Methods + + + + + + GET /api/relay/rest/sip\_profile — fetch the current profile. + + + + + + PUT /api/relay/rest/sip\_profile — update the SIP profile. + + + +## Source + +[`src/rest/namespaces/sip_profile.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs) + +Line 11. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/new.mdx new file mode 100644 index 0000000000..2b44bfa35a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::sip_profile::SipProfile::new" + parent: "signalwire::rest::namespaces::sip_profile::SipProfile" + module: "rest.namespaces.sip_profile" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/sip_profile.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs) + +Line 17. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/update.mdx new file mode 100644 index 0000000000..c318e71c8c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/sip-profile/sip-profile/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::sip_profile::SipProfile::update" + parent: "signalwire::rest::namespaces::sip_profile::SipProfile" + module: "rest.namespaces.sip_profile" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs" + visibility: "public" +--- +# `update` + +PUT /api/relay/rest/sip\_profile — update the SIP profile. + +## Signature + +```rust +fn update(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/sip_profile.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/sip_profile.rs) + +Line 34. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/index.mdx new file mode 100644 index 0000000000..0141d3212a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video" +title: "video" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video" + parent: "signalwire::rest::namespaces" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `video` + +Video API namespace — rooms, sessions, recordings, conferences, tokens, +streams. + +Mirrors `signalwire.rest.namespaces.video.VideoNamespace` from the Python +SDK. Each sub-resource exposes the methods present on the upstream +Python class. + +## Classes + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/base-path.mdx new file mode 100644 index 0000000000..f809797b0d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferenceTokens::base_path" + parent: "signalwire::rest::namespaces::video::VideoConferenceTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 389. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/get.mdx new file mode 100644 index 0000000000..51c5ef2b42 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferenceTokens::get" + parent: "signalwire::rest::namespaces::video::VideoConferenceTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, token_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 393. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/index.mdx new file mode 100644 index 0000000000..8e91460dbb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conference-tokens" +title: "VideoConferenceTokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferenceTokens" + parent: "signalwire::rest::namespaces::video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `VideoConferenceTokens` + +## Signature + +```rust +struct VideoConferenceTokens { /* fields */ } +``` + +## Methods + + + + + + + + + + POST \{base\}/\{id\}/reset — no-body POST per Python. + + + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 376. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/new.mdx new file mode 100644 index 0000000000..630aa95749 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferenceTokens::new" + parent: "signalwire::rest::namespaces::video::VideoConferenceTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 382. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/reset.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/reset.mdx new file mode 100644 index 0000000000..32ede8cbbc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/reset.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conference-tokens/reset" +title: "reset" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferenceTokens::reset" + parent: "signalwire::rest::namespaces::video::VideoConferenceTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `reset` + +POST \{base\}/\{id\}/reset — no-body POST per Python. + +## Signature + +```rust +fn reset(&self, token_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 399. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/base-path.mdx new file mode 100644 index 0000000000..3b9d1695e6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conferences/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferences::base_path" + parent: "signalwire::rest::namespaces::video::VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 310. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/create-stream.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/create-stream.mdx new file mode 100644 index 0000000000..e875cfdbc5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/create-stream.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conferences/create-stream" +title: "create_stream" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferences::create_stream" + parent: "signalwire::rest::namespaces::video::VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `create_stream` + +## Signature + +```rust +fn create_stream(&self, conference_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 362. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/create.mdx new file mode 100644 index 0000000000..c91aafb511 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conferences/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferences::create" + parent: "signalwire::rest::namespaces::video::VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 319. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/delete.mdx new file mode 100644 index 0000000000..9dfecae11f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conferences/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferences::delete" + parent: "signalwire::rest::namespaces::video::VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, conference_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 337. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/get.mdx new file mode 100644 index 0000000000..b8d7a699bd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conferences/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferences::get" + parent: "signalwire::rest::namespaces::video::VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, conference_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 323. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/index.mdx new file mode 100644 index 0000000000..f123e54965 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conferences" +title: "VideoConferences" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferences" + parent: "signalwire::rest::namespaces::video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `VideoConferences` + +## Signature + +```rust +struct VideoConferences { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 297. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/list-conference-tokens.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/list-conference-tokens.mdx new file mode 100644 index 0000000000..d20b13afcb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/list-conference-tokens.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conferences/list-conference-tokens" +title: "list_conference_tokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferences::list_conference_tokens" + parent: "signalwire::rest::namespaces::video::VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `list_conference_tokens` + +## Signature + +```rust +fn list_conference_tokens(&self, conference_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 342. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/list-streams.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/list-streams.mdx new file mode 100644 index 0000000000..094cbd1885 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/list-streams.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conferences/list-streams" +title: "list_streams" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferences::list_streams" + parent: "signalwire::rest::namespaces::video::VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `list_streams` + +## Signature + +```rust +fn list_streams(&self, conference_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 352. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/list.mdx new file mode 100644 index 0000000000..65b3f9831c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conferences/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferences::list" + parent: "signalwire::rest::namespaces::video::VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 314. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/new.mdx new file mode 100644 index 0000000000..858fb6c949 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conferences/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferences::new" + parent: "signalwire::rest::namespaces::video::VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 303. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/update.mdx new file mode 100644 index 0000000000..7d2126960f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-conferences/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-conferences/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoConferences::update" + parent: "signalwire::rest::namespaces::video::VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, conference_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 328. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/base-path.mdx new file mode 100644 index 0000000000..b05f04bd03 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-recordings/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomRecordings::base_path" + parent: "signalwire::rest::namespaces::video::VideoRoomRecordings" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 263. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/delete.mdx new file mode 100644 index 0000000000..d6248a1051 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-recordings/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomRecordings::delete" + parent: "signalwire::rest::namespaces::video::VideoRoomRecordings" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, recording_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 277. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/get.mdx new file mode 100644 index 0000000000..02af0845ea --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-recordings/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomRecordings::get" + parent: "signalwire::rest::namespaces::video::VideoRoomRecordings" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, recording_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 272. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/index.mdx new file mode 100644 index 0000000000..dd0e6de08d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-recordings" +title: "VideoRoomRecordings" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomRecordings" + parent: "signalwire::rest::namespaces::video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `VideoRoomRecordings` + +## Signature + +```rust +struct VideoRoomRecordings { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 250. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/list-events.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/list-events.mdx new file mode 100644 index 0000000000..105dd8e517 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/list-events.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-recordings/list-events" +title: "list_events" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomRecordings::list_events" + parent: "signalwire::rest::namespaces::video::VideoRoomRecordings" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `list_events` + +## Signature + +```rust +fn list_events(&self, recording_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 282. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/list.mdx new file mode 100644 index 0000000000..41cd68ffc5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-recordings/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomRecordings::list" + parent: "signalwire::rest::namespaces::video::VideoRoomRecordings" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 267. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/new.mdx new file mode 100644 index 0000000000..93eed9e5d6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-recordings/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-recordings/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomRecordings::new" + parent: "signalwire::rest::namespaces::video::VideoRoomRecordings" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 256. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/base-path.mdx new file mode 100644 index 0000000000..82e467eca9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-sessions/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomSessions::base_path" + parent: "signalwire::rest::namespaces::video::VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 201. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/get.mdx new file mode 100644 index 0000000000..e40d733fbd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-sessions/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomSessions::get" + parent: "signalwire::rest::namespaces::video::VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, session_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 210. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/index.mdx new file mode 100644 index 0000000000..0b3b56486d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-sessions" +title: "VideoRoomSessions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomSessions" + parent: "signalwire::rest::namespaces::video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `VideoRoomSessions` + +## Signature + +```rust +struct VideoRoomSessions { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 188. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-events.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-events.mdx new file mode 100644 index 0000000000..e47674fcae --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-events.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-events" +title: "list_events" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomSessions::list_events" + parent: "signalwire::rest::namespaces::video::VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `list_events` + +## Signature + +```rust +fn list_events(&self, session_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 215. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-members.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-members.mdx new file mode 100644 index 0000000000..6c741d4d9a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-members.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-members" +title: "list_members" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomSessions::list_members" + parent: "signalwire::rest::namespaces::video::VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `list_members` + +## Signature + +```rust +fn list_members(&self, session_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 225. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-recordings.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-recordings.mdx new file mode 100644 index 0000000000..d70a804616 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-recordings.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list-recordings" +title: "list_recordings" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomSessions::list_recordings" + parent: "signalwire::rest::namespaces::video::VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `list_recordings` + +## Signature + +```rust +fn list_recordings(&self, session_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 235. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list.mdx new file mode 100644 index 0000000000..274bd5688e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-sessions/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomSessions::list" + parent: "signalwire::rest::namespaces::video::VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 205. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/new.mdx new file mode 100644 index 0000000000..39f72bd833 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-sessions/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-sessions/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomSessions::new" + parent: "signalwire::rest::namespaces::video::VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 194. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/base-path.mdx new file mode 100644 index 0000000000..a30fc6c039 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-tokens/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomTokens::base_path" + parent: "signalwire::rest::namespaces::video::VideoRoomTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 175. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/create.mdx new file mode 100644 index 0000000000..c6a4b63b96 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-tokens/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomTokens::create" + parent: "signalwire::rest::namespaces::video::VideoRoomTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 179. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/index.mdx new file mode 100644 index 0000000000..c98fcffc61 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-tokens" +title: "VideoRoomTokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomTokens" + parent: "signalwire::rest::namespaces::video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `VideoRoomTokens` + +## Signature + +```rust +struct VideoRoomTokens { /* fields */ } +``` + +## Methods + + + + + + + + + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 162. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/new.mdx new file mode 100644 index 0000000000..bdc886a4ae --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-room-tokens/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-room-tokens/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRoomTokens::new" + parent: "signalwire::rest::namespaces::video::VideoRoomTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 168. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/base-path.mdx new file mode 100644 index 0000000000..ba4542cd70 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-rooms/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRooms::base_path" + parent: "signalwire::rest::namespaces::video::VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 105. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/create-stream.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/create-stream.mdx new file mode 100644 index 0000000000..ed0c290fa3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/create-stream.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-rooms/create-stream" +title: "create_stream" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRooms::create_stream" + parent: "signalwire::rest::namespaces::video::VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `create_stream` + +## Signature + +```rust +fn create_stream(&self, room_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 148. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/create.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/create.mdx new file mode 100644 index 0000000000..cc4df50a69 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/create.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-rooms/create" +title: "create" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRooms::create" + parent: "signalwire::rest::namespaces::video::VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `create` + +## Signature + +```rust +fn create(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 114. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/delete.mdx new file mode 100644 index 0000000000..5c40c52aad --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-rooms/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRooms::delete" + parent: "signalwire::rest::namespaces::video::VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, room_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 133. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/get.mdx new file mode 100644 index 0000000000..56af04f4f6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-rooms/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRooms::get" + parent: "signalwire::rest::namespaces::video::VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, room_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 118. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/index.mdx new file mode 100644 index 0000000000..b475303ebf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-rooms" +title: "VideoRooms" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRooms" + parent: "signalwire::rest::namespaces::video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `VideoRooms` + +## Signature + +```rust +struct VideoRooms { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + VideoRooms uses PUT for update. + + + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 92. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/list-streams.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/list-streams.mdx new file mode 100644 index 0000000000..56a2a5f4ff --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/list-streams.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-rooms/list-streams" +title: "list_streams" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRooms::list_streams" + parent: "signalwire::rest::namespaces::video::VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `list_streams` + +## Signature + +```rust +fn list_streams(&self, room_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 138. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/list.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/list.mdx new file mode 100644 index 0000000000..66857936c9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/list.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-rooms/list" +title: "list" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRooms::list" + parent: "signalwire::rest::namespaces::video::VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `list` + +## Signature + +```rust +fn list(&self, params: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 109. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/new.mdx new file mode 100644 index 0000000000..5304ecad55 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-rooms/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRooms::new" + parent: "signalwire::rest::namespaces::video::VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 98. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/update.mdx new file mode 100644 index 0000000000..5b611c9412 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-rooms/update.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-rooms/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoRooms::update" + parent: "signalwire::rest::namespaces::video::VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `update` + +VideoRooms uses PUT for update. + +## Signature + +```rust +fn update(&self, room_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 124. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/base-path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/base-path.mdx new file mode 100644 index 0000000000..27b4d92f75 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/base-path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-streams/base-path" +title: "base_path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoStreams::base_path" + parent: "signalwire::rest::namespaces::video::VideoStreams" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `base_path` + +## Signature + +```rust +fn base_path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 422. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/delete.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/delete.mdx new file mode 100644 index 0000000000..f6e03e45b1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/delete.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-streams/delete" +title: "delete" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoStreams::delete" + parent: "signalwire::rest::namespaces::video::VideoStreams" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `delete` + +## Signature + +```rust +fn delete(&self, stream_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 440. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/get.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/get.mdx new file mode 100644 index 0000000000..c9d84fc4e5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/get.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-streams/get" +title: "get" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoStreams::get" + parent: "signalwire::rest::namespaces::video::VideoStreams" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `get` + +## Signature + +```rust +fn get(&self, stream_id: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 426. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/index.mdx new file mode 100644 index 0000000000..d97eda9372 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-streams" +title: "VideoStreams" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoStreams" + parent: "signalwire::rest::namespaces::video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `VideoStreams` + +## Signature + +```rust +struct VideoStreams { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 409. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/new.mdx new file mode 100644 index 0000000000..c9b2dec6b9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-streams/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoStreams::new" + parent: "signalwire::rest::namespaces::video::VideoStreams" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?, base_path: &str) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 415. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/update.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/update.mdx new file mode 100644 index 0000000000..608ece0f30 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video-streams/update.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video-streams/update" +title: "update" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::VideoStreams::update" + parent: "signalwire::rest::namespaces::video::VideoStreams" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `update` + +## Signature + +```rust +fn update(&self, stream_id: &str, params: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 431. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/client.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/client.mdx new file mode 100644 index 0000000000..c846f3cec2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/client.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video/client" +title: "client" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::Video::client" + parent: "signalwire::rest::namespaces::video::Video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `client` + +## Signature + +```rust +fn client(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 55. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/conference-tokens.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/conference-tokens.mdx new file mode 100644 index 0000000000..9e598059e5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/conference-tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video/conference-tokens" +title: "conference_tokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::Video::conference_tokens" + parent: "signalwire::rest::namespaces::video::Video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `conference_tokens` + +## Signature + +```rust +fn conference_tokens(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 79. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/conferences.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/conferences.mdx new file mode 100644 index 0000000000..67cf93fdb4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/conferences.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video/conferences" +title: "conferences" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::Video::conferences" + parent: "signalwire::rest::namespaces::video::Video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `conferences` + +## Signature + +```rust +fn conferences(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 75. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/index.mdx new file mode 100644 index 0000000000..1f6b2a7de3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video" +title: "Video" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::Video" + parent: "signalwire::rest::namespaces::video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `Video` + +## Signature + +```rust +struct Video { /* fields */ } +``` + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 46. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/new.mdx new file mode 100644 index 0000000000..b118445012 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::Video::new" + parent: "signalwire::rest::namespaces::video::Video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(client: &'a ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 51. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/room-recordings.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/room-recordings.mdx new file mode 100644 index 0000000000..314476a4f0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/room-recordings.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video/room-recordings" +title: "room_recordings" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::Video::room_recordings" + parent: "signalwire::rest::namespaces::video::Video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `room_recordings` + +## Signature + +```rust +fn room_recordings(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 71. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/room-sessions.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/room-sessions.mdx new file mode 100644 index 0000000000..7357609a30 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/room-sessions.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video/room-sessions" +title: "room_sessions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::Video::room_sessions" + parent: "signalwire::rest::namespaces::video::Video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `room_sessions` + +## Signature + +```rust +fn room_sessions(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 67. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/room-tokens.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/room-tokens.mdx new file mode 100644 index 0000000000..7d95877b96 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/room-tokens.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video/room-tokens" +title: "room_tokens" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::Video::room_tokens" + parent: "signalwire::rest::namespaces::video::Video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `room_tokens` + +## Signature + +```rust +fn room_tokens(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 63. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/rooms.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/rooms.mdx new file mode 100644 index 0000000000..3c4078460a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/rooms.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video/rooms" +title: "rooms" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::Video::rooms" + parent: "signalwire::rest::namespaces::video::Video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `rooms` + +## Signature + +```rust +fn rooms(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 59. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/streams.mdx b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/streams.mdx new file mode 100644 index 0000000000..f5538a3aa3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/namespaces/video/video/streams.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/namespaces/video/video/streams" +title: "streams" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::namespaces::video::Video::streams" + parent: "signalwire::rest::namespaces::video::Video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs" + visibility: "public" +--- +# `streams` + +## Signature + +```rust +fn streams(&self) -> ?<'a> +``` + +## Returns + +`?<'a>` + +## Source + +[`src/rest/namespaces/video.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/namespaces/video.rs) + +Line 83. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/index.mdx new file mode 100644 index 0000000000..947be45040 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination" +title: "pagination" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::rest::pagination" + parent: "signalwire::rest" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `pagination` + +Paginated iterator over `links.next`-cursor responses. + +Mirrors `signalwire.rest._pagination.PaginatedIterator` from the Python +SDK. Construction is lazy — no HTTP is dispatched until the iterator is +first stepped. Each fetch follows the response's `links.next` cursor; +when the cursor is empty/missing, the iterator is exhausted. + +## Classes + + + + Streaming iterator that walks a `links.next`-paginated REST endpoint. + + + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/data-key.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/data-key.mdx new file mode 100644 index 0000000000..b004cd8c02 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/data-key.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator/data-key" +title: "data_key" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::pagination::PaginatedIterator::data_key" + parent: "signalwire::rest::pagination::PaginatedIterator" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `data_key` + +## Signature + +```rust +fn data_key(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 79. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/http.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/http.mdx new file mode 100644 index 0000000000..b4e3ce075d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/http.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator/http" +title: "http" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::pagination::PaginatedIterator::http" + parent: "signalwire::rest::pagination::PaginatedIterator" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `http` + +## Signature + +```rust +fn http(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 67. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/index.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/index.mdx new file mode 100644 index 0000000000..abeccbae94 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/index.mdx @@ -0,0 +1,72 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator" +title: "PaginatedIterator" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::rest::pagination::PaginatedIterator" + parent: "signalwire::rest::pagination" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `PaginatedIterator` + +Streaming iterator that walks a `links.next`-paginated REST endpoint. + +Holds a borrowed reference to the \[`HttpClient`] for the duration of +iteration. Use the \[`Iterator`] impl (`for item in it { ... }`) or +step manually via \[`PaginatedIterator::next_item`]. + +## Signature + +```rust +struct PaginatedIterator { /* fields */ } +``` + +## Inheritance + +**Implements:** `Iterator` + +## Methods + + + + + + + + + + + + + + Construct a new iterator. + + + + + + Fetch the next item, dispatching a new page request if needed. Returns `Ok(None)` when the cursor is exhausted. + + + + + + + +## Type Aliases + + + + + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 26. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/index__2.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/index__2.mdx new file mode 100644 index 0000000000..53a35812f9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/index__2.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator/index__2" +title: "index" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::pagination::PaginatedIterator::index" + parent: "signalwire::rest::pagination::PaginatedIterator" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `index` + +## Signature + +```rust +fn index(&self) -> usize +``` + +## Returns + +`usize` + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 83. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/is-done.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/is-done.mdx new file mode 100644 index 0000000000..193068a7a8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/is-done.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator/is-done" +title: "is_done" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::pagination::PaginatedIterator::is_done" + parent: "signalwire::rest::pagination::PaginatedIterator" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `is_done` + +## Signature + +```rust +fn is_done(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 91. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/item.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/item.mdx new file mode 100644 index 0000000000..4eaed1dc65 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/item.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator/item" +title: "Item" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Item" + parent: "signalwire::rest::pagination::PaginatedIterator" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `Item` + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 159. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/items.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/items.mdx new file mode 100644 index 0000000000..c284aabd3a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/items.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator/items" +title: "items" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::pagination::PaginatedIterator::items" + parent: "signalwire::rest::pagination::PaginatedIterator" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `items` + +## Signature + +```rust +fn items(&self) -> &[?] +``` + +## Returns + +`&[?]` + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 87. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/new.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/new.mdx new file mode 100644 index 0000000000..9ca4dac465 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/new.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::pagination::PaginatedIterator::new" + parent: "signalwire::rest::pagination::PaginatedIterator" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `new` + +Construct a new iterator. + +`params` and `data_key` mirror the Python signature: the body field +containing the items array is named `data_key` (typically `"data"`), +and `params` is forwarded on the first GET. + +## Signature + +```rust +fn new(http: &'a ?, path: &str, params: ?, data_key: &str) -> Self +``` + +## Parameters + + + + + + + + + +## Returns + +`Self` + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 48. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/next-item.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/next-item.mdx new file mode 100644 index 0000000000..2c54e9de03 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/next-item.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator/next-item" +title: "next_item" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::pagination::PaginatedIterator::next_item" + parent: "signalwire::rest::pagination::PaginatedIterator" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `next_item` + +Fetch the next item, dispatching a new page request if needed. +Returns `Ok(None)` when the cursor is exhausted. + +## Signature + +```rust +fn next_item(&mut self) -> ?, ?> +``` + +## Returns + +`?, ?>` + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 97. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/next.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/next.mdx new file mode 100644 index 0000000000..e77bd9d0e0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/next.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator/next" +title: "next" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::pagination::PaginatedIterator::next" + parent: "signalwire::rest::pagination::PaginatedIterator" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `next` + +## Signature + +```rust +fn next(&mut self) -> ?<::Item> +``` + +## Returns + +`?<::Item>` + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 161. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/params.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/params.mdx new file mode 100644 index 0000000000..1ad199474c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::pagination::PaginatedIterator::params" + parent: "signalwire::rest::pagination::PaginatedIterator" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 75. diff --git a/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/path.mdx b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/path.mdx new file mode 100644 index 0000000000..342373ee10 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/rest/pagination/paginated-iterator/path.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/rest/pagination/paginated-iterator/path" +title: "path" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::rest::pagination::PaginatedIterator::path" + parent: "signalwire::rest::pagination::PaginatedIterator" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs" + visibility: "public" +--- +# `path` + +## Signature + +```rust +fn path(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/rest/pagination.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/rest/pagination.rs) + +Line 71. diff --git a/fern/products/sdk-reference/rust/signalwire/run-agent.mdx b/fern/products/sdk-reference/rust/signalwire/run-agent.mdx new file mode 100644 index 0000000000..9a7b6095bb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/run-agent.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/run-agent" +title: "run_agent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::run_agent" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs" + visibility: "public" +--- +# `run_agent` + +Run the supplied \[`AgentBase`] directly (without an +\[`AgentServer`]) on its configured host/port. Blocking call. + +Mirrors Python's `signalwire.run_agent(agent, host=..., port=...)`. +Useful when a caller wants the agent's own routes (`/`, `/swaig`, +`/post_prompt`, `/health`) without the multi-agent wrapper. + +## Signature + +```rust +fn run_agent(agent: &?, _host: ?<&str>, _port: ?) +``` + +## Parameters + + + + + + + +## Source + +[`src/lib.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs) + +Line 78. diff --git a/fern/products/sdk-reference/rust/signalwire/security/index.mdx b/fern/products/sdk-reference/rust/signalwire/security/index.mdx new file mode 100644 index 0000000000..4ce4ce4fae --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/security" +title: "security" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::security" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/mod.rs" + visibility: "public" +--- +# `security` + +## Modules + + + + + + Webhook signature validation for SignalWire-signed HTTP requests. + + + + Tower / axum middleware for SignalWire webhook signature validation. + + + +## Source + +[`src/security/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/security/session-manager/index.mdx b/fern/products/sdk-reference/rust/signalwire/security/session-manager/index.mdx new file mode 100644 index 0000000000..8d2da72abe --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/session-manager/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/security/session-manager" +title: "session_manager" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::security::session_manager" + parent: "signalwire::security" + module: "security" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs" + visibility: "public" +--- +# `session_manager` + +## Classes + + + + Session manager that generates and validates HMAC-signed tokens. + + + +## Source + +[`src/security/session_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/clone.mdx b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/clone.mdx new file mode 100644 index 0000000000..73724271bd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/security/session-manager/session-manager/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::session_manager::SessionManager::clone" + parent: "signalwire::security::session_manager::SessionManager" + module: "security.session_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/security/session_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs) + +Line 13. diff --git a/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/create-session.mdx b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/create-session.mdx new file mode 100644 index 0000000000..83c62d503a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/create-session.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/security/session-manager/session-manager/create-session" +title: "create_session" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::session_manager::SessionManager::create_session" + parent: "signalwire::security::session_manager::SessionManager" + module: "security.session_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs" + visibility: "public" +--- +# `create_session` + +Create or confirm a session, returning the call ID. + +## Signature + +```rust +fn create_session(&self, call_id: ?<&str>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/security/session_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs) + +Line 41. diff --git a/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/create-token.mdx b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/create-token.mdx new file mode 100644 index 0000000000..5c112ffc1d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/create-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/rust/signalwire/security/session-manager/session-manager/create-token" +title: "create_token" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::session_manager::SessionManager::create_token" + parent: "signalwire::security::session_manager::SessionManager" + module: "security.session_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs" + visibility: "public" +--- +# `create_token` + +Generate an HMAC-SHA256 signed token for a given function and call. + +Token format (before base64url encoding): +`{call_id}.{function_name}.{expiry}.{nonce}.{hmac_hex}` + +## Signature + +```rust +fn create_token(&self, function_name: &str, call_id: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/security/session_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs) + +Line 52. diff --git a/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/index.mdx b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/index.mdx new file mode 100644 index 0000000000..79c04b6346 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/rust/signalwire/security/session-manager/session-manager" +title: "SessionManager" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::security::session_manager::SessionManager" + parent: "signalwire::security::session_manager" + module: "security.session_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs" + visibility: "public" +--- +# `SessionManager` + +Session manager that generates and validates HMAC-signed tokens. + +Tokens bind a function name and call ID together with an expiry time, +preventing replay attacks and cross-function/cross-call misuse. + +## Signature + +```rust +struct SessionManager { /* fields */ } +``` + +## Inheritance + +**Implements:** `Clone` + +## Methods + + + + + + Create or confirm a session, returning the call ID. + + + + Generate an HMAC-SHA256 signed token for a given function and call. + + + + Create a new session manager with a random 32-byte secret. + + + + Get the configured token expiry in seconds. + + + + Validate a token against the expected function name and call ID. + + + + Create a new session manager with the default expiry (3600 seconds). + + + +## Source + +[`src/security/session_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs) + +Line 14. diff --git a/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/new.mdx b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/new.mdx new file mode 100644 index 0000000000..6bdf7a497f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/security/session-manager/session-manager/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::session_manager::SessionManager::new" + parent: "signalwire::security::session_manager::SessionManager" + module: "security.session_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs" + visibility: "public" +--- +# `new` + +Create a new session manager with a random 32-byte secret. + +## Signature + +```rust +fn new(token_expiry_secs: u64) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/security/session_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs) + +Line 21. diff --git a/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/token-expiry-secs.mdx b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/token-expiry-secs.mdx new file mode 100644 index 0000000000..c40d0e388e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/token-expiry-secs.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/security/session-manager/session-manager/token-expiry-secs" +title: "token_expiry_secs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::session_manager::SessionManager::token_expiry_secs" + parent: "signalwire::security::session_manager::SessionManager" + module: "security.session_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs" + visibility: "public" +--- +# `token_expiry_secs` + +Get the configured token expiry in seconds. + +## Signature + +```rust +fn token_expiry_secs(&self) -> u64 +``` + +## Returns + +`u64` + +## Source + +[`src/security/session_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs) + +Line 36. diff --git a/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/validate-token.mdx b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/validate-token.mdx new file mode 100644 index 0000000000..c86f43b7b4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/validate-token.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/security/session-manager/session-manager/validate-token" +title: "validate_token" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::session_manager::SessionManager::validate_token" + parent: "signalwire::security::session_manager::SessionManager" + module: "security.session_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs" + visibility: "public" +--- +# `validate_token` + +Validate a token against the expected function name and call ID. + +Uses timing-safe comparison for all security-critical fields. + +## Signature + +```rust +fn validate_token( + &self, + function_name: &str, + call_id: &str, + token: &str +) -> bool +``` + +## Parameters + + + + + + + +## Returns + +`bool` + +## Source + +[`src/security/session_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs) + +Line 70. diff --git a/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/with-defaults.mdx b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/with-defaults.mdx new file mode 100644 index 0000000000..0c83bdb5af --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/session-manager/session-manager/with-defaults.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/security/session-manager/session-manager/with-defaults" +title: "with_defaults" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::session_manager::SessionManager::with_defaults" + parent: "signalwire::security::session_manager::SessionManager" + module: "security.session_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs" + visibility: "public" +--- +# `with_defaults` + +Create a new session manager with the default expiry (3600 seconds). + +## Signature + +```rust +fn with_defaults() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/security/session_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/session_manager.rs) + +Line 31. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/index.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/index.mdx new file mode 100644 index 0000000000..34bfffa333 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer" +title: "webhook_layer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::security::webhook_layer" + parent: "signalwire::security" + module: "security" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `webhook_layer` + +Tower / axum middleware for SignalWire webhook signature validation. + +This module provides a \[`tower::Layer`] that buffers the request body, +verifies the `X-SignalWire-Signature` (or `X-Twilio-Signature`) +header against a configured signing key, and either: + +- rejects the request with `403 Forbidden` (no body) when the + signature is missing or invalid, or +- rebuilds the request with the buffered body so downstream + handlers can re-read it as a normal `axum::body::Body`. + +The URL passed to the validator honors `X-Forwarded-Proto` / +`X-Forwarded-Host` (for reverse-proxy / tunnel deploys) and falls +back to scheme-derived-from-`x-forwarded-proto-or-https` plus the +`Host` header. + +The Layer is gated behind the `tower-middleware` Cargo feature +(enabled by default). Users who only need the raw validator can +depend on `signalwire` with `default-features = false`. + +Copyright (c) 2025 SignalWire. Licensed under the MIT License. + +## Classes + + + + Tower \[`Layer`] that wraps any `Service>` with SignalWire webhook signature validation. + + + + Tower \[`Service`] produced by \[`WebhookLayer::layer`]. Buffers the request body, validates the signature, and either forwards a reconstructed request to the inner service or short-circuits with a `403 Forbidden`. + + + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/clone.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/clone.mdx new file mode 100644 index 0000000000..b00e709163 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-layer/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook_layer::WebhookLayer::clone" + parent: "signalwire::security::webhook_layer::WebhookLayer" + module: "security.webhook_layer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 48. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/index.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/index.mdx new file mode 100644 index 0000000000..8c08e42c67 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-layer" +title: "WebhookLayer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::security::webhook_layer::WebhookLayer" + parent: "signalwire::security::webhook_layer" + module: "security.webhook_layer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `WebhookLayer` + +Tower \[`Layer`] that wraps any `Service>` with +SignalWire webhook signature validation. + +Construct with \[`WebhookLayer::new`] and pass the customer's +Signing Key. Optionally provide an explicit URL via +\[`WebhookLayer::with_url_override`] when running behind a tunnel +or reverse proxy that doesn't set `X-Forwarded-*` headers. + +## Signature + +```rust +struct WebhookLayer { /* fields */ } +``` + +## Inheritance + +**Implements:** `Clone`, `Layer` + +## Methods + + + + + + + + Construct a new layer bound to the given Signing Key. + + + + Override the URL **base** the validator signs against. When set, reverse-proxy header reconstruction is skipped and the full URL is built as ``. + + + +## Type Aliases + + + + + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 49. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/layer.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/layer.mdx new file mode 100644 index 0000000000..e88d98cd38 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/layer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-layer/layer" +title: "layer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook_layer::WebhookLayer::layer" + parent: "signalwire::security::webhook_layer::WebhookLayer" + module: "security.webhook_layer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `layer` + +## Signature + +```rust +fn layer(&self, inner: S) -> ::Service +``` + +## Parameters + + + +## Returns + +`::Service` + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 90. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/new.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/new.mdx new file mode 100644 index 0000000000..98108012af --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/new.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-layer/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook_layer::WebhookLayer::new" + parent: "signalwire::security::webhook_layer::WebhookLayer" + module: "security.webhook_layer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `new` + +Construct a new layer bound to the given Signing Key. + +## Signature + +```rust +fn new: ?>(signing_key: impl ?) -> Self +``` + +## Type Parameters + + + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 60. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/service.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/service.mdx new file mode 100644 index 0000000000..a83947ac5a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/service.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-layer/service" +title: "Service" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Service" + parent: "signalwire::security::webhook_layer::WebhookLayer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `Service` + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 88. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/with-url-base.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/with-url-base.mdx new file mode 100644 index 0000000000..61665e26e1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-layer/with-url-base.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-layer/with-url-base" +title: "with_url_base" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook_layer::WebhookLayer::with_url_base" + parent: "signalwire::security::webhook_layer::WebhookLayer" + module: "security.webhook_layer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `with_url_base` + +Override the URL **base** the validator signs against. When set, +reverse-proxy header reconstruction is skipped and the full URL +is built as ``. + +`base` is typically `scheme://host[:port]` with no trailing slash +— e.g. `"https://example.ngrok.io"`. Any trailing `/` is +stripped before concatenation. + +## Signature + +```rust +fn with_url_base: ?>(self, base: impl ?) -> Self +``` + +## Type Parameters + + + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 76. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/call.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/call.mdx new file mode 100644 index 0000000000..cc2290d1f8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-validate/call" +title: "call" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook_layer::WebhookValidate::call" + parent: "signalwire::security::webhook_layer::WebhookValidate" + module: "security.webhook_layer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `call` + +## Signature + +```rust +fn call(&mut self, req: ?) -> ::Future +``` + +## Parameters + + + +## Returns + +`::Future` + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 124. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/clone.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/clone.mdx new file mode 100644 index 0000000000..c57ab1b13f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-validate/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook_layer::WebhookValidate::clone" + parent: "signalwire::security::webhook_layer::WebhookValidate" + module: "security.webhook_layer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 102. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/error.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/error.mdx new file mode 100644 index 0000000000..ce1a3e385b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/error.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-validate/error" +title: "Error" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Error" + parent: "signalwire::security::webhook_layer::WebhookValidate" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `Error` + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 117. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/future.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/future.mdx new file mode 100644 index 0000000000..29afac1bde --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/future.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-validate/future" +title: "Future" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Future" + parent: "signalwire::security::webhook_layer::WebhookValidate" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `Future` + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 118. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/index.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/index.mdx new file mode 100644 index 0000000000..c76dc1aea1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-validate" +title: "WebhookValidate" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::security::webhook_layer::WebhookValidate" + parent: "signalwire::security::webhook_layer" + module: "security.webhook_layer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `WebhookValidate` + +Tower \[`Service`] produced by \[`WebhookLayer::layer`]. Buffers the +request body, validates the signature, and either forwards a +reconstructed request to the inner service or short-circuits with +a `403 Forbidden`. + +## Signature + +```rust +struct WebhookValidate { /* fields */ } +``` + +## Inheritance + +**Implements:** `Clone`, [Service](/reference/rust/signalwire/security/webhook-layer/webhook-layer/service) + +## Methods + + + + + + + + + +## Type Aliases + + + + + + + + + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 103. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/poll-ready.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/poll-ready.mdx new file mode 100644 index 0000000000..643ea93360 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/poll-ready.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-validate/poll-ready" +title: "poll_ready" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook_layer::WebhookValidate::poll_ready" + parent: "signalwire::security::webhook_layer::WebhookValidate" + module: "security.webhook_layer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `poll_ready` + +## Signature + +```rust +fn poll_ready(&mut self, cx: &mut ?<'_>) -> ?::Error>> +``` + +## Parameters + + + +## Returns + +`?::Error>>` + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 120. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/response.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/response.mdx new file mode 100644 index 0000000000..1b966e9ec9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook-layer/webhook-validate/response.mdx @@ -0,0 +1,21 @@ +--- +slug: "/reference/rust/signalwire/security/webhook-layer/webhook-validate/response" +title: "Response" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "Response" + parent: "signalwire::security::webhook_layer::WebhookValidate" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs" + visibility: "public" +--- +# `Response` + +## Source + +[`src/security/webhook_layer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook_layer.rs) + +Line 116. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook/index.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook/index.mdx new file mode 100644 index 0000000000..79f0ee55dc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook/index.mdx @@ -0,0 +1,88 @@ +--- +slug: "/reference/rust/signalwire/security/webhook" +title: "webhook" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::security::webhook" + parent: "signalwire::security" + module: "security" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs" + visibility: "public" +--- +# `webhook` + +Webhook signature validation for SignalWire-signed HTTP requests. + +Implements both schemes from `porting-sdk/webhooks.md`: + +- **Scheme A** — RELAY/SWML/JSON: `lowercase_hex(HMAC-SHA1(key, url + raw_body))` +- **Scheme B** — Compat/cXML form: `base64(HMAC-SHA1(key, url + sortedFormParams))` + with optional `bodySHA256` query-param fallback for JSON-on-compat-surface. + +Public API mirrors Python's `signalwire.core.security.webhook_validator`: + +- \[`validate_webhook_signature`] — combined validator (tries A, then B). +- \[`validate_request`] — legacy `@signalwire/compatibility-api` drop-in + that accepts either a raw body string or pre-parsed form params. + +All comparisons go through \[`subtle::ConstantTimeEq`] so the secret +is not leaked through repeated requests. Inputs are taken as +`&str` / borrowed strings — no allocation hidden behind the API. + +``` +use signalwire::security::webhook::validate_webhook_signature; + +let key = "PSKtest1234567890abcdef"; +let url = "https://example.ngrok.io/webhook"; +let raw_body = r#"{"event":"call.state","params":{"call_id":"abc-123","state":"answered"}}"#; +let sig = "c3c08c1fefaf9ee198a100d5906765a6f394bf0f"; +assert!(validate_webhook_signature(key, sig, url, raw_body).unwrap()); +``` + +Copyright (c) 2025 SignalWire. Licensed under the MIT License. + +## Examples + +```rust +use signalwire::security::webhook::validate_webhook_signature; + +let key = "PSKtest1234567890abcdef"; +let url = "https://example.ngrok.io/webhook"; +let raw_body = r#"{"event":"call.state","params":{"call_id":"abc-123","state":"answered"}}"#; +let sig = "c3c08c1fefaf9ee198a100d5906765a6f394bf0f"; +assert!(validate_webhook_signature(key, sig, url, raw_body).unwrap()); +``` + +## Functions + + + + Legacy `@signalwire/compatibility-api` drop-in entry point. + + + + Validate a SignalWire webhook signature against both schemes. + + + +## Enums + + + + Argument shape for \[`validate_request`]. Either a raw body string (which will run Scheme A first, then Scheme B with the form-parsed body) or a pre-parsed form-param list (which goes straight to Scheme B). + + + + Errors returned by the webhook validator. + + + +## Source + +[`src/security/webhook.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook/params-or-body/clone.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook/params-or-body/clone.mdx new file mode 100644 index 0000000000..ccde817d7e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook/params-or-body/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/security/webhook/params-or-body/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook::ParamsOrBody::clone" + parent: "signalwire::security::webhook::ParamsOrBody" + module: "security.webhook" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/security/webhook.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs) + +Line 74. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook/params-or-body/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook/params-or-body/fmt.mdx new file mode 100644 index 0000000000..70f7a86d87 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook/params-or-body/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/security/webhook/params-or-body/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook::ParamsOrBody::fmt" + parent: "signalwire::security::webhook::ParamsOrBody" + module: "security.webhook" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/security/webhook.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs) + +Line 74. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook/params-or-body/index.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook/params-or-body/index.mdx new file mode 100644 index 0000000000..77368e5d99 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook/params-or-body/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/rust/signalwire/security/webhook/params-or-body" +title: "ParamsOrBody" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "enum" + language: "rust" + qualified_name: "signalwire::security::webhook::ParamsOrBody" + parent: "signalwire::security::webhook" + module: "security.webhook" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs" + visibility: "public" +--- +# `ParamsOrBody` + +Argument shape for \[`validate_request`]. Either a raw body string +(which will run Scheme A first, then Scheme B with the form-parsed +body) or a pre-parsed form-param list (which goes straight to +Scheme B). + +Repeated keys in the `Params` variant are supported by emitting a +`Vec` per key in submission order. + +## Signature + +```rust +enum ParamsOrBody +``` + +## Inheritance + +**Implements:** `Debug`, `Clone` + +## Variants + + + Raw HTTP request body (UTF-8). The validator will sort form params if it parses cleanly; for JSON bodies this branch degrades to the empty-params Scheme B fallback. + + + + Pre-parsed form params, list-of-(key, list-of-values) so repeated keys keep their submission order. + + +## Methods + + + + + + + +## Source + +[`src/security/webhook.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs) + +Line 75. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook/validate-request.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook/validate-request.mdx new file mode 100644 index 0000000000..f0612e4826 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook/validate-request.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/rust/signalwire/security/webhook/validate-request" +title: "validate_request" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::security::webhook::validate_request" + parent: "signalwire::security::webhook" + module: "security.webhook" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs" + visibility: "public" +--- +# `validate_request` + +Legacy `@signalwire/compatibility-api` drop-in entry point. + +If `params_or_raw_body` is \[`ParamsOrBody::Body`], delegates to +\[`validate_webhook_signature`] (Scheme A then Scheme B with parsed form). + +If it's \[`ParamsOrBody::Params`], runs Scheme B directly with those +pre-parsed form params (plus URL port normalization). + +`bodySHA256` verification is skipped in the `Params` variant — there +is no raw body to hash. + +## Signature + +```rust +fn validate_request( + signing_key: &str, + signature: &str, + url: &str, + params_or_raw_body: &? +) -> ? +``` + +## Parameters + + + + + + + + + +## Returns + +`?` + +## Source + +[`src/security/webhook.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs) + +Line 389. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook/validate-webhook-signature.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook/validate-webhook-signature.mdx new file mode 100644 index 0000000000..be29fa3a38 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook/validate-webhook-signature.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/security/webhook/validate-webhook-signature" +title: "validate_webhook_signature" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::security::webhook::validate_webhook_signature" + parent: "signalwire::security::webhook" + module: "security.webhook" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs" + visibility: "public" +--- +# `validate_webhook_signature` + +Validate a SignalWire webhook signature against both schemes. + +## Signature + +```rust +fn validate_webhook_signature( + signing_key: &str, + signature: &str, + url: &str, + raw_body: &str +) -> ? +``` + +## Parameters + + + + + + + + + +## Returns + +`?` — All comparisons are constant-time via \[`subtle::ConstantTimeEq`]. + +## Source + +[`src/security/webhook.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs) + +Line 325. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/clone.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/clone.mdx new file mode 100644 index 0000000000..26d9b2885e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/security/webhook/webhook-error/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook::WebhookError::clone" + parent: "signalwire::security::webhook::WebhookError" + module: "security.webhook" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/security/webhook.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs) + +Line 49. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/eq.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/eq.mdx new file mode 100644 index 0000000000..eb53f1c246 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/eq.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/security/webhook/webhook-error/eq" +title: "eq" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook::WebhookError::eq" + parent: "signalwire::security::webhook::WebhookError" + module: "security.webhook" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs" + visibility: "public" +--- +# `eq` + +## Signature + +```rust +fn eq(&self, other: &?) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/security/webhook.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs) + +Line 49. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/fmt.mdx new file mode 100644 index 0000000000..7f776832b1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/security/webhook/webhook-error/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook::WebhookError::fmt" + parent: "signalwire::security::webhook::WebhookError" + module: "security.webhook" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/security/webhook.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs) + +Line 49. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/fmt__2.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/fmt__2.mdx new file mode 100644 index 0000000000..6bd1d2502a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/fmt__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/security/webhook/webhook-error/fmt__2" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::security::webhook::WebhookError::fmt" + parent: "signalwire::security::webhook::WebhookError" + module: "security.webhook" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/security/webhook.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs) + +Line 58. diff --git a/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/index.mdx b/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/index.mdx new file mode 100644 index 0000000000..10080624e4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/security/webhook/webhook-error/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/rust/signalwire/security/webhook/webhook-error" +title: "WebhookError" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "enum" + language: "rust" + qualified_name: "signalwire::security::webhook::WebhookError" + parent: "signalwire::security::webhook" + module: "security.webhook" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs" + visibility: "public" +--- +# `WebhookError` + +Errors returned by the webhook validator. + +`validate_webhook_signature` and `validate_request` return +`Result` so callers can distinguish a legitimate +"signature did not match" (`Ok(false)`) from a programming-error +"you forgot the signing key" (`Err(WebhookError::MissingSigningKey)`). +Per the spec, missing/empty _signature header_ and malformed +signatures return `Ok(false)` — those are not errors. + +## Signature + +```rust +enum WebhookError +``` + +## Inheritance + +**Implements:** `Debug`, `Clone`, `PartialEq`, `Eq`, `Display`, [Error](/reference/rust/signalwire/security/webhook-layer/webhook-validate/error) + +## Variants + + + Caller passed an empty `signing_key`. This is a programming error (the key is mandatory configuration), not a validation failure — Python raises `ValueError` here, Node throws. + + +## Methods + + + + + + + + + + + +## Source + +[`src/security/webhook.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/security/webhook.rs) + +Line 50. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/get-agent-mut.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/get-agent-mut.mdx new file mode 100644 index 0000000000..01bdf30aad --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/get-agent-mut.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/get-agent-mut" +title: "get_agent_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::get_agent_mut" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `get_agent_mut` + +Get a mutable reference to an agent by route. + +## Signature + +```rust +fn get_agent_mut(&mut self, route: &str) -> ?<&mut ?> +``` + +## Parameters + + + +## Returns + +`?<&mut ?>` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 134. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/get-agent.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/get-agent.mdx new file mode 100644 index 0000000000..9faa0f7c36 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/get-agent.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/get-agent" +title: "get_agent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::get_agent" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `get_agent` + +Get an agent by route. + +## Signature + +```rust +fn get_agent(&self, route: &str) -> ?<&?> +``` + +## Parameters + + + +## Returns + +`?<&?>` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 128. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/get-agents.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/get-agents.mdx new file mode 100644 index 0000000000..a77e588adb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/get-agents.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/get-agents" +title: "get_agents" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::get_agents" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `get_agents` + +Get all registered routes (sorted). + +## Signature + +```rust +fn get_agents(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 121. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/handle-request.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/handle-request.mdx new file mode 100644 index 0000000000..d5e6470a50 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/handle-request.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/handle-request" +title: "handle_request" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::handle_request" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `handle_request` + +Handle an HTTP request and return `(status, headers, body)`. + +## Signature + +```rust +fn handle_request( + &self, + method: &str, + path: &str, + headers: &?, + body: &str +) -> (u16, ?, ?) +``` + +## Parameters + + + + + + + + + +## Returns + +`(u16, ?, ?)` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 291. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/host.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/host.mdx new file mode 100644 index 0000000000..a659424f86 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/host.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/host" +title: "host" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::host" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `host` + +## Signature + +```rust +fn host(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 396. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/index.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/index.mdx new file mode 100644 index 0000000000..4a06594e11 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/index.mdx @@ -0,0 +1,97 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server" +title: "AgentServer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer" + parent: "signalwire::server::agent_server" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `AgentServer` + +Multi-agent HTTP server that dispatches requests to registered agents +by longest-prefix route matching. + +## Signature + +```rust +struct AgentServer { /* fields */ } +``` + +## Methods + + + + Get an agent by route. + + + + Get a mutable reference to an agent by route. + + + + Get all registered routes (sorted). + + + + Handle an HTTP request and return `(status, headers, body)`. + + + + + + Check if SIP routing is enabled. + + + + + + + + Register an agent at its default route (from the agent's service), or at an explicit route override. + + + + Register a routing callback that runs on every request whose path matches the configured `path`. Returning `Some(route)` from the callback redirects handling to that registered agent; returning `None` falls through to normal longest-prefix dispatch. + + + + Map a SIP username to a route. + + + + Run the HTTP server on the configured host:port, blocking the current thread until the listener exits. + + + + Serve static files from a directory under a URL prefix. + + + + Serve static files from a directory under a URL prefix. + + + + Enable SIP-based routing. + + + + Get the SIP username mapping. + + + + Unregister an agent from a route. + + + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 49. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/is-sip-routing-enabled.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/is-sip-routing-enabled.mdx new file mode 100644 index 0000000000..f88b581b17 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/is-sip-routing-enabled.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/is-sip-routing-enabled" +title: "is_sip_routing_enabled" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::is_sip_routing_enabled" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `is_sip_routing_enabled` + +Check if SIP routing is enabled. + +## Signature + +```rust +fn is_sip_routing_enabled(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 158. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/new.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/new.mdx new file mode 100644 index 0000000000..b12424a671 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/new.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::new" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(host: ?<&str>, port: ?) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 64. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/port.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/port.mdx new file mode 100644 index 0000000000..7f92479114 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/port.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/port" +title: "port" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::port" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `port` + +## Signature + +```rust +fn port(&self) -> u16 +``` + +## Returns + +`u16` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 400. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/register-global-routing-callback.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/register-global-routing-callback.mdx new file mode 100644 index 0000000000..4b6369714b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/register-global-routing-callback.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/register-global-routing-callback" +title: "register_global_routing_callback" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::register_global_routing_callback" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `register_global_routing_callback` + +Register a routing callback that runs on every request whose +path matches the configured `path`. Returning `Some(route)` from +the callback redirects handling to that registered agent; +returning `None` falls through to normal longest-prefix +dispatch. + +Mirrors Python's +`AgentServer.register_global_routing_callback(callback_fn, path)`. + +In Python the callback signature is +`(request, body) -> Optional[route]`; the Rust signature passes +`(path, headers, parsed_body)` since Rust does not carry a +FastAPI request object. + +## Signature + +```rust +fn register_global_routing_callback( + &mut self, + callback: ?, + path: &str +) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 223. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/register-sip-username.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/register-sip-username.mdx new file mode 100644 index 0000000000..5779ffa1fb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/register-sip-username.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/register-sip-username" +title: "register_sip_username" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::register_sip_username" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `register_sip_username` + +Map a SIP username to a route. + +## Signature + +```rust +fn register_sip_username(&mut self, username: &str, route: &str) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 150. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/register.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/register.mdx new file mode 100644 index 0000000000..f4868c0fa3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/register.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/register" +title: "register" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::register" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `register` + +Register an agent at its default route (from the agent's service), +or at an explicit route override. + +**Errors:** + +Returns an error string if the route is already registered. + +## Signature + +```rust +fn register(&mut self, agent: ?, route: ?<&str>) -> ?<(), ?> +``` + +## Parameters + + + + + +## Returns + +`?<(), ?>` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 94. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/run.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/run.mdx new file mode 100644 index 0000000000..6e1d00f615 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/run.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/run" +title: "run" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::run" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `run` + +Run the HTTP server on the configured host:port, blocking the +current thread until the listener exits. + +Mirrors Python's `AgentServer.run(host, port)`. The optional +`host` and `port` arguments override the values supplied at +construction time (matching the Python contract). + +## Signature + +```rust +fn run(&self, host: ?<&str>, port: ?) +``` + +## Parameters + + + + + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 243. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/serve-static-files.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/serve-static-files.mdx new file mode 100644 index 0000000000..5eb9d4ee84 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/serve-static-files.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/serve-static-files" +title: "serve_static_files" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::serve_static_files" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `serve_static_files` + +Serve static files from a directory under a URL prefix. + +This is the named-mirror of Python's +`AgentServer.serve_static_files(directory, route="/")`. Behaves +identically to \[`AgentServer::serve_static`] (which kept the +shorter Rust-idiomatic name) — both are kept so existing code +keeps working and the Python-name parity is preserved for the +surface diff. + +**Errors:** + +Returns an error string if the directory does not exist. + +## Signature + +```rust +fn serve_static_files(&mut self, directory: &str, route: &str) -> ?<(), ?> +``` + +## Parameters + + + + + +## Returns + +`?<(), ?>` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 202. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/serve-static.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/serve-static.mdx new file mode 100644 index 0000000000..a6091c1c9b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/serve-static.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/serve-static" +title: "serve_static" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::serve_static" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `serve_static` + +Serve static files from a directory under a URL prefix. + +**Errors:** + +Returns an error string if the directory does not exist. + +## Signature + +```rust +fn serve_static(&mut self, directory: &str, url_prefix: &str) -> ?<(), ?> +``` + +## Parameters + + + + + +## Returns + +`?<(), ?>` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 175. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/setup-sip-routing.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/setup-sip-routing.mdx new file mode 100644 index 0000000000..3ec19fb36f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/setup-sip-routing.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/setup-sip-routing" +title: "setup_sip_routing" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::setup_sip_routing" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `setup_sip_routing` + +Enable SIP-based routing. + +## Signature + +```rust +fn setup_sip_routing(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 144. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/sip-username-mapping.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/sip-username-mapping.mdx new file mode 100644 index 0000000000..8ef8e3fecc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/sip-username-mapping.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/sip-username-mapping" +title: "sip_username_mapping" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::sip_username_mapping" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `sip_username_mapping` + +Get the SIP username mapping. + +## Signature + +```rust +fn sip_username_mapping(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 163. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/unregister.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/unregister.mdx new file mode 100644 index 0000000000..5abdcf3883 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/agent-server/unregister.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/agent-server/unregister" +title: "unregister" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::server::agent_server::AgentServer::unregister" + parent: "signalwire::server::agent_server::AgentServer" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `unregister` + +Unregister an agent from a route. + +## Signature + +```rust +fn unregister(&mut self, route: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 114. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/global-routing-callback.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/global-routing-callback.mdx new file mode 100644 index 0000000000..61a4724626 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/global-routing-callback.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server/global-routing-callback" +title: "GlobalRoutingCallback" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "signalwire::server::agent_server::GlobalRoutingCallback" + parent: "signalwire::server::agent_server" + module: "server.agent_server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `GlobalRoutingCallback` + +Callback signature for global request-time routing decisions. + +The callback receives the parsed request body (or `None` if absent +/ unparseable) and returns: + +- `Some(route)` — redirect handling to that route's agent. +- `None` — fall through to normal route dispatch. + +Mirrors Python's `register_routing_callback` / `register_global_routing_callback` +signature (`Callable[[Request, Dict[str, Any]], Optional[str]]`), +modulo Rust's lack of a FastAPI Request object. + +## Signature + +```rust +type GlobalRoutingCallback = ? +``` + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 22. diff --git a/fern/products/sdk-reference/rust/signalwire/server/agent-server/index.mdx b/fern/products/sdk-reference/rust/signalwire/server/agent-server/index.mdx new file mode 100644 index 0000000000..3db03108f3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/agent-server/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/server/agent-server" +title: "agent_server" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::server::agent_server" + parent: "signalwire::server" + module: "server" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs" + visibility: "public" +--- +# `agent_server` + +## Type Aliases + + + + Callback signature for global request-time routing decisions. + + + +## Classes + + + + Multi-agent HTTP server that dispatches requests to registered agents by longest-prefix route matching. + + + +## Source + +[`src/server/agent_server.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/agent_server.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/server/index.mdx b/fern/products/sdk-reference/rust/signalwire/server/index.mdx new file mode 100644 index 0000000000..f3cf956351 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/server/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/rust/signalwire/server" +title: "server" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::server" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/server/mod.rs" + visibility: "public" +--- +# `server` + +## Modules + + + + + +## Source + +[`src/server/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/server/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/detect.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/detect.mdx new file mode 100644 index 0000000000..42759e42ee --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/detect.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/adapter/detect" +title: "detect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::serverless::adapter::Adapter::detect" + parent: "signalwire::serverless::adapter::Adapter" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `detect` + +Detect the current runtime environment. + +## Signature + +```rust +fn detect() -> ? +``` + +## Returns + +`?` + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 45. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/handle-azure.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/handle-azure.mdx new file mode 100644 index 0000000000..1cbbc758fb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/handle-azure.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/adapter/handle-azure" +title: "handle_azure" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::serverless::adapter::Adapter::handle_azure" + parent: "signalwire::serverless::adapter::Adapter" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `handle_azure` + +Handle an Azure Functions invocation. + +## Signature + +```rust +fn handle_azure(agent: &dyn ?, request: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 130. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/handle-lambda.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/handle-lambda.mdx new file mode 100644 index 0000000000..0bce946a66 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/handle-lambda.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/adapter/handle-lambda" +title: "handle_lambda" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::serverless::adapter::Adapter::handle_lambda" + parent: "signalwire::serverless::adapter::Adapter" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `handle_lambda` + +Handle an AWS Lambda (API Gateway) invocation. + +Extracts method, path, headers, and body from the API Gateway event +format, calls agent.handle\_request(), and returns an API Gateway +compatible response. + +## Signature + +```rust +fn handle_lambda(agent: &dyn ?, event: &?) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 67. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/index.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/index.mdx new file mode 100644 index 0000000000..6bb2efc339 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/adapter" +title: "Adapter" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::serverless::adapter::Adapter" + parent: "signalwire::serverless::adapter" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `Adapter` + +Auto-detect and handle serverless environments (Lambda, Azure, GCF, CGI) +or fall back to the built-in server. + +## Signature + +```rust +struct Adapter; +``` + +## Methods + + + + Detect the current runtime environment. + + + + Handle an Azure Functions invocation. + + + + Handle an AWS Lambda (API Gateway) invocation. + + + + Auto-detect the runtime environment and return the environment type. The caller can then dispatch accordingly. + + + + Return the standard HTTP status text for a given status code. + + + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 41. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/serve-detect.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/serve-detect.mdx new file mode 100644 index 0000000000..eb112c8c2b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/serve-detect.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/adapter/serve-detect" +title: "serve_detect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::serverless::adapter::Adapter::serve_detect" + parent: "signalwire::serverless::adapter::Adapter" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `serve_detect` + +Auto-detect the runtime environment and return the environment type. +The caller can then dispatch accordingly. + +## Signature + +```rust +fn serve_detect() -> ? +``` + +## Returns + +`?` + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 195. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/status-text.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/status-text.mdx new file mode 100644 index 0000000000..b6dc711d2d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/adapter/status-text.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/adapter/status-text" +title: "status_text" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::serverless::adapter::Adapter::status_text" + parent: "signalwire::serverless::adapter::Adapter" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `status_text` + +Return the standard HTTP status text for a given status code. + +## Signature + +```rust +fn status_text(code: u16) -> &'static str +``` + +## Parameters + + + +## Returns + +`&'static str` + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 200. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/index.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/index.mdx new file mode 100644 index 0000000000..99d4d8ec64 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter" +title: "adapter" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::serverless::adapter" + parent: "signalwire::serverless" + module: "serverless" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `adapter` + +Serverless adapter -- auto-detect runtime environment (Lambda, Azure, +server) and handle requests accordingly. + +## Classes + + + + Auto-detect and handle serverless environments (Lambda, Azure, GCF, CGI) or fall back to the built-in server. + + + +## Interfaces + + + + Trait that the agent/service must implement so the adapter can forward requests to it. + + + +## Enums + + + + Detected runtime environment. + + + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/request-handler/handle-request.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/request-handler/handle-request.mdx new file mode 100644 index 0000000000..996fc893a7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/request-handler/handle-request.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/request-handler/handle-request" +title: "handle_request" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::serverless::adapter::RequestHandler::handle_request" + parent: "signalwire::serverless::adapter::RequestHandler" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `handle_request` + +Handle an HTTP request, returning (status\_code, headers, body). + +## Signature + +```rust +fn handle_request( + &self, + method: &str, + path: &str, + headers: &?, + body: &str +) -> (u16, ?, ?) +``` + +## Parameters + + + + + + + + + +## Returns + +`(u16, ?, ?)` + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 30. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/request-handler/index.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/request-handler/index.mdx new file mode 100644 index 0000000000..a2a1ab22be --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/request-handler/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/request-handler" +title: "RequestHandler" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "interface" + language: "rust" + qualified_name: "signalwire::serverless::adapter::RequestHandler" + parent: "signalwire::serverless::adapter" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `RequestHandler` + +Trait that the agent/service must implement so the adapter can +forward requests to it. + +## Signature + +```rust +trait RequestHandler +``` + +## Methods + + + + Handle an HTTP request, returning (status\_code, headers, body). + + + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 28. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/as-str.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/as-str.mdx new file mode 100644 index 0000000000..37c05de61b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/as-str.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/runtime-environment/as-str" +title: "as_str" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::serverless::adapter::RuntimeEnvironment::as_str" + parent: "signalwire::serverless::adapter::RuntimeEnvironment" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `as_str` + +## Signature + +```rust +fn as_str(&self) -> &'static str +``` + +## Returns + +`&'static str` + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 15. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/clone.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/clone.mdx new file mode 100644 index 0000000000..ee5056167b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/runtime-environment/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::serverless::adapter::RuntimeEnvironment::clone" + parent: "signalwire::serverless::adapter::RuntimeEnvironment" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 5. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/eq.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/eq.mdx new file mode 100644 index 0000000000..7aa36430df --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/eq.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/runtime-environment/eq" +title: "eq" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::serverless::adapter::RuntimeEnvironment::eq" + parent: "signalwire::serverless::adapter::RuntimeEnvironment" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `eq` + +## Signature + +```rust +fn eq(&self, other: &?) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 5. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/fmt.mdx new file mode 100644 index 0000000000..a7aeb366b6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/runtime-environment/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::serverless::adapter::RuntimeEnvironment::fmt" + parent: "signalwire::serverless::adapter::RuntimeEnvironment" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 5. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/index.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/index.mdx new file mode 100644 index 0000000000..8975b2dd0d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/adapter/runtime-environment/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/rust/signalwire/serverless/adapter/runtime-environment" +title: "RuntimeEnvironment" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "enum" + language: "rust" + qualified_name: "signalwire::serverless::adapter::RuntimeEnvironment" + parent: "signalwire::serverless::adapter" + module: "serverless.adapter" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs" + visibility: "public" +--- +# `RuntimeEnvironment` + +Detected runtime environment. + +## Signature + +```rust +enum RuntimeEnvironment +``` + +## Inheritance + +**Implements:** `Debug`, `Clone`, `PartialEq`, `Eq` + +## Variants + + + + + + + + + + + +## Methods + + + + + + + + + + + +## Source + +[`src/serverless/adapter.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/adapter.rs) + +Line 6. diff --git a/fern/products/sdk-reference/rust/signalwire/serverless/index.mdx b/fern/products/sdk-reference/rust/signalwire/serverless/index.mdx new file mode 100644 index 0000000000..4c3a41acab --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/serverless/index.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/rust/signalwire/serverless" +title: "serverless" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::serverless" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/mod.rs" + visibility: "public" +--- +# `serverless` + +## Modules + + + + Serverless adapter -- auto-detect runtime environment (Lambda, Azure, server) and handle requests accordingly. + + + +## Source + +[`src/serverless/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/serverless/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skill-spec/index.mdx b/fern/products/sdk-reference/rust/signalwire/skill-spec/index.mdx new file mode 100644 index 0000000000..87f3d6186e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skill-spec/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/skill-spec" +title: "SkillSpec" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::SkillSpec" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs" + visibility: "public" +--- +# `SkillSpec` + +Skill registration descriptor — Rust's analogue of a Python skill +class. Bundles a skill's registration name with its factory closure +into a single value so \[`register_skill`] can mirror Python's +one-argument signature. + +## Signature + +```rust +struct SkillSpec { /* fields */ } +``` + +## Properties + + + Factory closure that constructs a \[`skills::SkillBase`] from a JSON parameters map. + + + + Snake-case skill name used as the registry key. + + +## Methods + + + + Convenience constructor. + + + +## Source + +[`src/lib.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs) + +Line 131. diff --git a/fern/products/sdk-reference/rust/signalwire/skill-spec/new.mdx b/fern/products/sdk-reference/rust/signalwire/skill-spec/new.mdx new file mode 100644 index 0000000000..22874a9f77 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skill-spec/new.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/rust/signalwire/skill-spec/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::SkillSpec::new" + parent: "signalwire::SkillSpec" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs" + visibility: "public" +--- +# `new` + +Convenience constructor. + +## Signature + +```rust +fn new: ?>(name: impl ?, factory: ?) -> Self +``` + +## Type Parameters + + + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/lib.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs) + +Line 141. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/description.mdx new file mode 100644 index 0000000000..0790234812 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia::description" + parent: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs) + +Line 41. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/index.mdx new file mode 100644 index 0000000000..8582ee35c4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia" +title: "ApiNinjasTrivia" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia" + parent: "signalwire::skills::builtin::api_ninjas_trivia" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs" + visibility: "public" +--- +# `ApiNinjasTrivia` + +Get trivia questions from API Ninjas (DataMap-based). + +## Signature + +```rust +struct ApiNinjasTrivia { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/api_ninjas_trivia.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs) + +Line 24. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/name.mdx new file mode 100644 index 0000000000..9b2717738f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia::name" + parent: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs) + +Line 37. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/new.mdx new file mode 100644 index 0000000000..0ba36b22eb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia::new" + parent: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/params.mdx new file mode 100644 index 0000000000..0dfd8821d4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia::params" + parent: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs) + +Line 49. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/register-tools.mdx new file mode 100644 index 0000000000..8fab51d16d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia::register_tools" + parent: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/api_ninjas_trivia.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs) + +Line 57. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/setup.mdx new file mode 100644 index 0000000000..dd367313c4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia::setup" + parent: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs) + +Line 53. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/supports-multiple-instances.mdx new file mode 100644 index 0000000000..fb280898a9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/api-ninjas-trivia/api-ninjas-trivia/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia::supports_multiple_instances" + parent: "signalwire::skills::builtin::api_ninjas_trivia::ApiNinjasTrivia" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs) + +Line 45. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/index.mdx new file mode 100644 index 0000000000..6e74611d0d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/api-ninjas-trivia/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/api-ninjas-trivia" +title: "api_ninjas_trivia" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::api_ninjas_trivia" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs" + visibility: "public" +--- +# `api_ninjas_trivia` + +## Classes + + + + Get trivia questions from API Ninjas (DataMap-based). + + + +## Source + +[`src/skills/builtin/api_ninjas_trivia.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/api_ninjas_trivia.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/description.mdx new file mode 100644 index 0000000000..ebdc92a476 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::claude_skills::ClaudeSkills::description" + parent: "signalwire::skills::builtin::claude_skills::ClaudeSkills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/claude_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/get-hints.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/get-hints.mdx new file mode 100644 index 0000000000..fb2279344e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/get-hints" +title: "get_hints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::claude_skills::ClaudeSkills::get_hints" + parent: "signalwire::skills::builtin::claude_skills::ClaudeSkills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs" + visibility: "public" +--- +# `get_hints` + +## Signature + +```rust +fn get_hints(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/claude_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs) + +Line 105. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/get-prompt-sections.mdx new file mode 100644 index 0000000000..86af347c5c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::claude_skills::ClaudeSkills::get_prompt_sections" + parent: "signalwire::skills::builtin::claude_skills::ClaudeSkills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/claude_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs) + +Line 109. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/index.mdx new file mode 100644 index 0000000000..5f61571bb3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/claude-skills/claude-skills" +title: "ClaudeSkills" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::claude_skills::ClaudeSkills" + parent: "signalwire::skills::builtin::claude_skills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs" + visibility: "public" +--- +# `ClaudeSkills` + +Load Claude SKILL.md files as agent tools (handler-based). + +## Signature + +```rust +struct ClaudeSkills { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/claude_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs) + +Line 8. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/name.mdx new file mode 100644 index 0000000000..ad66a45794 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::claude_skills::ClaudeSkills::name" + parent: "signalwire::skills::builtin::claude_skills::ClaudeSkills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/claude_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs) + +Line 21. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/new.mdx new file mode 100644 index 0000000000..dfcde02f6b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::claude_skills::ClaudeSkills::new" + parent: "signalwire::skills::builtin::claude_skills::ClaudeSkills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/claude_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs) + +Line 13. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/params.mdx new file mode 100644 index 0000000000..8f1c007757 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::claude_skills::ClaudeSkills::params" + parent: "signalwire::skills::builtin::claude_skills::ClaudeSkills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/claude_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs) + +Line 33. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/register-tools.mdx new file mode 100644 index 0000000000..0c0455629d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::claude_skills::ClaudeSkills::register_tools" + parent: "signalwire::skills::builtin::claude_skills::ClaudeSkills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/claude_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs) + +Line 41. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/setup.mdx new file mode 100644 index 0000000000..fe441c2f3c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::claude_skills::ClaudeSkills::setup" + parent: "signalwire::skills::builtin::claude_skills::ClaudeSkills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/claude_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs) + +Line 37. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/supports-multiple-instances.mdx new file mode 100644 index 0000000000..9cd601d615 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/claude-skills/claude-skills/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::claude_skills::ClaudeSkills::supports_multiple_instances" + parent: "signalwire::skills::builtin::claude_skills::ClaudeSkills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/claude_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/index.mdx new file mode 100644 index 0000000000..bdbb3db2aa --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/claude-skills/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/claude-skills" +title: "claude_skills" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::claude_skills" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs" + visibility: "public" +--- +# `claude_skills` + +## Classes + + + + Load Claude SKILL.md files as agent tools (handler-based). + + + +## Source + +[`src/skills/builtin/claude_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/claude_skills.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/description.mdx new file mode 100644 index 0000000000..2b88e27c56 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::custom_skills::CustomSkills::description" + parent: "signalwire::skills::builtin::custom_skills::CustomSkills" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/custom_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs) + +Line 24. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/index.mdx new file mode 100644 index 0000000000..24655085d2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/custom-skills/custom-skills" +title: "CustomSkills" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::custom_skills::CustomSkills" + parent: "signalwire::skills::builtin::custom_skills" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs" + visibility: "public" +--- +# `CustomSkills` + +Register user-defined custom tools. + +## Signature + +```rust +struct CustomSkills { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/custom_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/name.mdx new file mode 100644 index 0000000000..573e3fd8ed --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::custom_skills::CustomSkills::name" + parent: "signalwire::skills::builtin::custom_skills::CustomSkills" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/custom_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/new.mdx new file mode 100644 index 0000000000..25d3f0b650 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::custom_skills::CustomSkills::new" + parent: "signalwire::skills::builtin::custom_skills::CustomSkills" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/custom_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/params.mdx new file mode 100644 index 0000000000..4950756a0f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::custom_skills::CustomSkills::params" + parent: "signalwire::skills::builtin::custom_skills::CustomSkills" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/custom_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs) + +Line 32. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/register-tools.mdx new file mode 100644 index 0000000000..92cec5815b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::custom_skills::CustomSkills::register_tools" + parent: "signalwire::skills::builtin::custom_skills::CustomSkills" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/custom_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs) + +Line 40. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/setup.mdx new file mode 100644 index 0000000000..44f8a66ac0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::custom_skills::CustomSkills::setup" + parent: "signalwire::skills::builtin::custom_skills::CustomSkills" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/custom_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs) + +Line 36. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/supports-multiple-instances.mdx new file mode 100644 index 0000000000..43ef8f0bf6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/custom-skills/custom-skills/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::custom_skills::CustomSkills::supports_multiple_instances" + parent: "signalwire::skills::builtin::custom_skills::CustomSkills" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/custom_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs) + +Line 28. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/index.mdx new file mode 100644 index 0000000000..5e7e19ee2d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/custom-skills/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/custom-skills" +title: "custom_skills" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::custom_skills" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs" + visibility: "public" +--- +# `custom_skills` + +## Classes + + + + Register user-defined custom tools. + + + +## Source + +[`src/skills/builtin/custom_skills.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/custom_skills.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/description.mdx new file mode 100644 index 0000000000..62f9856e2d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless::description" + parent: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/datasphere_serverless.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs) + +Line 26. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/get-global-data.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/get-global-data.mdx new file mode 100644 index 0000000000..355cdc5e2d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/get-global-data" +title: "get_global_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless::get_global_data" + parent: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```rust +fn get_global_data(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/datasphere_serverless.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs) + +Line 125. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/get-prompt-sections.mdx new file mode 100644 index 0000000000..217d35bf26 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless::get_prompt_sections" + parent: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/datasphere_serverless.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs) + +Line 142. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/index.mdx new file mode 100644 index 0000000000..a5165c94ca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless" +title: "DatasphereServerless" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless" + parent: "signalwire::skills::builtin::datasphere_serverless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs" + visibility: "public" +--- +# `DatasphereServerless` + +Search knowledge using SignalWire DataSphere with serverless DataMap execution. + +## Signature + +```rust +struct DatasphereServerless { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/datasphere_serverless.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs) + +Line 9. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/name.mdx new file mode 100644 index 0000000000..a6264fb838 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless::name" + parent: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/datasphere_serverless.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs) + +Line 22. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/new.mdx new file mode 100644 index 0000000000..08c41d7d48 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless::new" + parent: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/datasphere_serverless.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs) + +Line 14. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/params.mdx new file mode 100644 index 0000000000..6db6ef931f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless::params" + parent: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/datasphere_serverless.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs) + +Line 34. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/register-tools.mdx new file mode 100644 index 0000000000..e7b26a4d46 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless::register_tools" + parent: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/datasphere_serverless.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs) + +Line 47. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/setup.mdx new file mode 100644 index 0000000000..54ad81c964 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless::setup" + parent: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/datasphere_serverless.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs) + +Line 38. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/supports-multiple-instances.mdx new file mode 100644 index 0000000000..50cc596488 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere-serverless/datasphere-serverless/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless::supports_multiple_instances" + parent: "signalwire::skills::builtin::datasphere_serverless::DatasphereServerless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/datasphere_serverless.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs) + +Line 30. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/index.mdx new file mode 100644 index 0000000000..595347bda7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere-serverless/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere-serverless" +title: "datasphere_serverless" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere_serverless" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs" + visibility: "public" +--- +# `datasphere_serverless` + +## Classes + + + + Search knowledge using SignalWire DataSphere with serverless DataMap execution. + + + +## Source + +[`src/skills/builtin/datasphere_serverless.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere_serverless.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/description.mdx new file mode 100644 index 0000000000..b053b09681 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere/datasphere/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere::Datasphere::description" + parent: "signalwire::skills::builtin::datasphere::Datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs) + +Line 36. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/get-global-data.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/get-global-data.mdx new file mode 100644 index 0000000000..e1a8023eb2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere/datasphere/get-global-data" +title: "get_global_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere::Datasphere::get_global_data" + parent: "signalwire::skills::builtin::datasphere::Datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```rust +fn get_global_data(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs) + +Line 164. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/get-prompt-sections.mdx new file mode 100644 index 0000000000..29c790b579 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere/datasphere/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere::Datasphere::get_prompt_sections" + parent: "signalwire::skills::builtin::datasphere::Datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs) + +Line 178. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/index.mdx new file mode 100644 index 0000000000..ad5cf2c4ef --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere/datasphere" +title: "Datasphere" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere::Datasphere" + parent: "signalwire::skills::builtin::datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs" + visibility: "public" +--- +# `Datasphere` + +Search knowledge using SignalWire DataSphere RAG stack. + +Mirrors Python's `signalwire.skills.datasphere`: real HTTP POST to +`https://{space_name}.signalwire.com/api/datasphere/documents/search` +with project-id/token Basic auth and a JSON body containing the +document ID, query, distance, and count. + +The base URL can be overridden by setting `DATASPHERE_BASE_URL` — +`audit_skills_dispatch.py` uses this to point at its loopback +fixture. Token can also come from `DATASPHERE_TOKEN`. + +## Signature + +```rust +struct Datasphere { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs) + +Line 19. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/name.mdx new file mode 100644 index 0000000000..6d801307df --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere/datasphere/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere::Datasphere::name" + parent: "signalwire::skills::builtin::datasphere::Datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs) + +Line 32. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/new.mdx new file mode 100644 index 0000000000..fb3ced313a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere/datasphere/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere::Datasphere::new" + parent: "signalwire::skills::builtin::datasphere::Datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs) + +Line 24. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/params.mdx new file mode 100644 index 0000000000..d00fe0fa77 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere/datasphere/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere::Datasphere::params" + parent: "signalwire::skills::builtin::datasphere::Datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs) + +Line 44. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/register-tools.mdx new file mode 100644 index 0000000000..3c4a5fb058 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere/datasphere/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere::Datasphere::register_tools" + parent: "signalwire::skills::builtin::datasphere::Datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs) + +Line 63. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/setup.mdx new file mode 100644 index 0000000000..a845a3e81d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere/datasphere/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere::Datasphere::setup" + parent: "signalwire::skills::builtin::datasphere::Datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs) + +Line 48. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/supports-multiple-instances.mdx new file mode 100644 index 0000000000..47f376099a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/datasphere/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere/datasphere/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere::Datasphere::supports_multiple_instances" + parent: "signalwire::skills::builtin::datasphere::Datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs) + +Line 40. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/index.mdx new file mode 100644 index 0000000000..70f1476c61 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datasphere/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datasphere" +title: "datasphere" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::datasphere" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs" + visibility: "public" +--- +# `datasphere` + +## Classes + + + + Search knowledge using SignalWire DataSphere RAG stack. + + + +## Source + +[`src/skills/builtin/datasphere.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datasphere.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/description.mdx new file mode 100644 index 0000000000..c41f04557c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datetime/datetime/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datetime::Datetime::description" + parent: "signalwire::skills::builtin::datetime::Datetime" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/datetime.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/get-prompt-sections.mdx new file mode 100644 index 0000000000..9d8c713e92 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datetime/datetime/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datetime::Datetime::get_prompt_sections" + parent: "signalwire::skills::builtin::datetime::Datetime" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/datetime.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs) + +Line 96. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/index.mdx new file mode 100644 index 0000000000..75ac1df974 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datetime/datetime" +title: "Datetime" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::datetime::Datetime" + parent: "signalwire::skills::builtin::datetime" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs" + visibility: "public" +--- +# `Datetime` + +Get current date, time, and timezone information. + +## Signature + +```rust +struct Datetime { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/datetime.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs) + +Line 8. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/name.mdx new file mode 100644 index 0000000000..6ad18d2f0a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datetime/datetime/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datetime::Datetime::name" + parent: "signalwire::skills::builtin::datetime::Datetime" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/datetime.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs) + +Line 21. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/new.mdx new file mode 100644 index 0000000000..8645c4adf7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datetime/datetime/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datetime::Datetime::new" + parent: "signalwire::skills::builtin::datetime::Datetime" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/datetime.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs) + +Line 13. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/params.mdx new file mode 100644 index 0000000000..70efb32213 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datetime/datetime/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datetime::Datetime::params" + parent: "signalwire::skills::builtin::datetime::Datetime" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/datetime.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/register-tools.mdx new file mode 100644 index 0000000000..2e42880f6d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datetime/datetime/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datetime::Datetime::register_tools" + parent: "signalwire::skills::builtin::datetime::Datetime" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/datetime.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs) + +Line 37. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/setup.mdx new file mode 100644 index 0000000000..00efe9d5df --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/datetime/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datetime/datetime/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::datetime::Datetime::setup" + parent: "signalwire::skills::builtin::datetime::Datetime" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/datetime.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs) + +Line 33. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/index.mdx new file mode 100644 index 0000000000..42aa280257 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/datetime/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/datetime" +title: "datetime" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::datetime" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs" + visibility: "public" +--- +# `datetime` + +## Classes + + + + Get current date, time, and timezone information. + + + +## Source + +[`src/skills/builtin/datetime.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/datetime.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/description.mdx new file mode 100644 index 0000000000..d6a374fa7b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/google-maps/google-maps/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::google_maps::GoogleMaps::description" + parent: "signalwire::skills::builtin::google_maps::GoogleMaps" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/google_maps.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs) + +Line 24. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/get-hints.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/get-hints.mdx new file mode 100644 index 0000000000..d8611f6b42 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/google-maps/google-maps/get-hints" +title: "get_hints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::google_maps::GoogleMaps::get_hints" + parent: "signalwire::skills::builtin::google_maps::GoogleMaps" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs" + visibility: "public" +--- +# `get_hints` + +## Signature + +```rust +fn get_hints(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/google_maps.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs) + +Line 157. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/get-prompt-sections.mdx new file mode 100644 index 0000000000..9b3744e674 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/google-maps/google-maps/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::google_maps::GoogleMaps::get_prompt_sections" + parent: "signalwire::skills::builtin::google_maps::GoogleMaps" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/google_maps.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs) + +Line 168. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/index.mdx new file mode 100644 index 0000000000..70670769ac --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/google-maps/google-maps" +title: "GoogleMaps" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::google_maps::GoogleMaps" + parent: "signalwire::skills::builtin::google_maps" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs" + visibility: "public" +--- +# `GoogleMaps` + +Validate addresses and compute driving routes using Google Maps (DataMap-based). + +## Signature + +```rust +struct GoogleMaps { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/google_maps.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/name.mdx new file mode 100644 index 0000000000..9f883148e4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/google-maps/google-maps/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::google_maps::GoogleMaps::name" + parent: "signalwire::skills::builtin::google_maps::GoogleMaps" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/google_maps.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/new.mdx new file mode 100644 index 0000000000..d227cde491 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/google-maps/google-maps/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::google_maps::GoogleMaps::new" + parent: "signalwire::skills::builtin::google_maps::GoogleMaps" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/google_maps.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/params.mdx new file mode 100644 index 0000000000..2ac804c7ee --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/google-maps/google-maps/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::google_maps::GoogleMaps::params" + parent: "signalwire::skills::builtin::google_maps::GoogleMaps" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/google_maps.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs) + +Line 28. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/register-tools.mdx new file mode 100644 index 0000000000..b07ebac64a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/google-maps/google-maps/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::google_maps::GoogleMaps::register_tools" + parent: "signalwire::skills::builtin::google_maps::GoogleMaps" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/google_maps.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs) + +Line 36. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/setup.mdx new file mode 100644 index 0000000000..32ff25f595 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/google-maps/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/google-maps/google-maps/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::google_maps::GoogleMaps::setup" + parent: "signalwire::skills::builtin::google_maps::GoogleMaps" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/google_maps.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs) + +Line 32. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/index.mdx new file mode 100644 index 0000000000..2680437ba0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/google-maps/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/google-maps" +title: "google_maps" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::google_maps" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs" + visibility: "public" +--- +# `google_maps` + +## Classes + + + + Validate addresses and compute driving routes using Google Maps (DataMap-based). + + + +## Source + +[`src/skills/builtin/google_maps.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/google_maps.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/index.mdx new file mode 100644 index 0000000000..66d92df7b5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin" +title: "builtin" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin" + parent: "signalwire::skills" + module: "skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mod.rs" + visibility: "public" +--- +# `builtin` + +## Modules + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/index.mdx new file mode 100644 index 0000000000..e65b342d29 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/info-gatherer" +title: "info_gatherer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::info_gatherer" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs" + visibility: "public" +--- +# `info_gatherer` + +## Classes + + + + Gather answers to a configurable list of questions (handler-based). + + + +## Source + +[`src/skills/builtin/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/description.mdx new file mode 100644 index 0000000000..eccd21cb7b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::info_gatherer::InfoGatherer::description" + parent: "signalwire::skills::builtin::info_gatherer::InfoGatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/get-global-data.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/get-global-data.mdx new file mode 100644 index 0000000000..6493f5632d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/get-global-data" +title: "get_global_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::info_gatherer::InfoGatherer::get_global_data" + parent: "signalwire::skills::builtin::info_gatherer::InfoGatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```rust +fn get_global_data(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs) + +Line 171. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/get-prompt-sections.mdx new file mode 100644 index 0000000000..60a7b2c375 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::info_gatherer::InfoGatherer::get_prompt_sections" + parent: "signalwire::skills::builtin::info_gatherer::InfoGatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs) + +Line 187. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/index.mdx new file mode 100644 index 0000000000..df9a45075b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer" +title: "InfoGatherer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::info_gatherer::InfoGatherer" + parent: "signalwire::skills::builtin::info_gatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs" + visibility: "public" +--- +# `InfoGatherer` + +Gather answers to a configurable list of questions (handler-based). + +## Signature + +```rust +struct InfoGatherer { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs) + +Line 8. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/name.mdx new file mode 100644 index 0000000000..f8fdbe0364 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::info_gatherer::InfoGatherer::name" + parent: "signalwire::skills::builtin::info_gatherer::InfoGatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs) + +Line 21. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/new.mdx new file mode 100644 index 0000000000..8481b8cad8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::info_gatherer::InfoGatherer::new" + parent: "signalwire::skills::builtin::info_gatherer::InfoGatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs) + +Line 13. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/params.mdx new file mode 100644 index 0000000000..3f1a11ae2e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::info_gatherer::InfoGatherer::params" + parent: "signalwire::skills::builtin::info_gatherer::InfoGatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs) + +Line 33. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/register-tools.mdx new file mode 100644 index 0000000000..55c7c93802 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::info_gatherer::InfoGatherer::register_tools" + parent: "signalwire::skills::builtin::info_gatherer::InfoGatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs) + +Line 42. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/setup.mdx new file mode 100644 index 0000000000..c7e319c941 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::info_gatherer::InfoGatherer::setup" + parent: "signalwire::skills::builtin::info_gatherer::InfoGatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs) + +Line 37. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/supports-multiple-instances.mdx new file mode 100644 index 0000000000..2ecea488a4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/info-gatherer/info-gatherer/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::info_gatherer::InfoGatherer::supports_multiple_instances" + parent: "signalwire::skills::builtin::info_gatherer::InfoGatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/info_gatherer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/info_gatherer.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/index.mdx new file mode 100644 index 0000000000..72f286c45a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/joke" +title: "joke" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::joke" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs" + visibility: "public" +--- +# `joke` + +## Classes + + + + Tell jokes using the API Ninjas joke API (DataMap-based). + + + +## Source + +[`src/skills/builtin/joke.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/description.mdx new file mode 100644 index 0000000000..3f1713d051 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/joke/joke/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::joke::Joke::description" + parent: "signalwire::skills::builtin::joke::Joke" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/joke.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs) + +Line 24. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/get-global-data.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/get-global-data.mdx new file mode 100644 index 0000000000..0a7299fd80 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/joke/joke/get-global-data" +title: "get_global_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::joke::Joke::get_global_data" + parent: "signalwire::skills::builtin::joke::Joke" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```rust +fn get_global_data(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/joke.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs) + +Line 84. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/get-prompt-sections.mdx new file mode 100644 index 0000000000..ebe4d2181c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/joke/joke/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::joke::Joke::get_prompt_sections" + parent: "signalwire::skills::builtin::joke::Joke" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/joke.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs) + +Line 90. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/index.mdx new file mode 100644 index 0000000000..744abc094b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/joke/joke" +title: "Joke" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::joke::Joke" + parent: "signalwire::skills::builtin::joke" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs" + visibility: "public" +--- +# `Joke` + +Tell jokes using the API Ninjas joke API (DataMap-based). + +## Signature + +```rust +struct Joke { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/joke.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/name.mdx new file mode 100644 index 0000000000..b74ae9f924 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/joke/joke/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::joke::Joke::name" + parent: "signalwire::skills::builtin::joke::Joke" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/joke.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/new.mdx new file mode 100644 index 0000000000..0bf5960532 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/joke/joke/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::joke::Joke::new" + parent: "signalwire::skills::builtin::joke::Joke" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/joke.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/params.mdx new file mode 100644 index 0000000000..5a7576de04 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/joke/joke/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::joke::Joke::params" + parent: "signalwire::skills::builtin::joke::Joke" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/joke.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs) + +Line 28. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/register-tools.mdx new file mode 100644 index 0000000000..2b68336fdf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/joke/joke/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::joke::Joke::register_tools" + parent: "signalwire::skills::builtin::joke::Joke" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/joke.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs) + +Line 36. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/setup.mdx new file mode 100644 index 0000000000..2aaf562010 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/joke/joke/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/joke/joke/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::joke::Joke::setup" + parent: "signalwire::skills::builtin::joke::Joke" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/joke.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/joke.rs) + +Line 32. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/index.mdx new file mode 100644 index 0000000000..fab330cbfb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/math" +title: "math" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::math" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs" + visibility: "public" +--- +# `math` + +## Classes + + + + Perform basic mathematical calculations. + + + +## Source + +[`src/skills/builtin/math.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/description.mdx new file mode 100644 index 0000000000..e0575d078b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/math/math/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::math::Math::description" + parent: "signalwire::skills::builtin::math::Math" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/math.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/get-prompt-sections.mdx new file mode 100644 index 0000000000..c1b6bb2c14 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/math/math/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::math::Math::get_prompt_sections" + parent: "signalwire::skills::builtin::math::Math" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/math.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs) + +Line 99. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/index.mdx new file mode 100644 index 0000000000..90c44fe528 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/math/math" +title: "Math" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::math::Math" + parent: "signalwire::skills::builtin::math" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs" + visibility: "public" +--- +# `Math` + +Perform basic mathematical calculations. + +## Signature + +```rust +struct Math { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/math.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs) + +Line 8. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/name.mdx new file mode 100644 index 0000000000..d2b67c59a5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/math/math/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::math::Math::name" + parent: "signalwire::skills::builtin::math::Math" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/math.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs) + +Line 21. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/new.mdx new file mode 100644 index 0000000000..2a20598163 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/math/math/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::math::Math::new" + parent: "signalwire::skills::builtin::math::Math" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/math.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs) + +Line 13. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/params.mdx new file mode 100644 index 0000000000..96578f0362 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/math/math/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::math::Math::params" + parent: "signalwire::skills::builtin::math::Math" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/math.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/register-tools.mdx new file mode 100644 index 0000000000..ed365f12a5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/math/math/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::math::Math::register_tools" + parent: "signalwire::skills::builtin::math::Math" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/math.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs) + +Line 37. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/setup.mdx new file mode 100644 index 0000000000..c44a4e8802 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/math/math/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/math/math/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::math::Math::setup" + parent: "signalwire::skills::builtin::math::Math" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/math.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/math.rs) + +Line 33. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/index.mdx new file mode 100644 index 0000000000..f10bbafbc2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/mcp-gateway" +title: "mcp_gateway" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::mcp_gateway" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs" + visibility: "public" +--- +# `mcp_gateway` + +## Classes + + + + Bridge MCP servers with SWAIG functions (handler-based). + + + +## Source + +[`src/skills/builtin/mcp_gateway.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/description.mdx new file mode 100644 index 0000000000..459f30c003 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::mcp_gateway::McpGateway::description" + parent: "signalwire::skills::builtin::mcp_gateway::McpGateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/mcp_gateway.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-global-data.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-global-data.mdx new file mode 100644 index 0000000000..de55bc7a4e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-global-data" +title: "get_global_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::mcp_gateway::McpGateway::get_global_data" + parent: "signalwire::skills::builtin::mcp_gateway::McpGateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```rust +fn get_global_data(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/mcp_gateway.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs) + +Line 201. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-hints.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-hints.mdx new file mode 100644 index 0000000000..c918b35574 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-hints" +title: "get_hints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::mcp_gateway::McpGateway::get_hints" + parent: "signalwire::skills::builtin::mcp_gateway::McpGateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs" + visibility: "public" +--- +# `get_hints` + +## Signature + +```rust +fn get_hints(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/mcp_gateway.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs) + +Line 185. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-prompt-sections.mdx new file mode 100644 index 0000000000..af50c389ce --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::mcp_gateway::McpGateway::get_prompt_sections" + parent: "signalwire::skills::builtin::mcp_gateway::McpGateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/mcp_gateway.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs) + +Line 218. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/index.mdx new file mode 100644 index 0000000000..b464e4e74c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway" +title: "McpGateway" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::mcp_gateway::McpGateway" + parent: "signalwire::skills::builtin::mcp_gateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs" + visibility: "public" +--- +# `McpGateway` + +Bridge MCP servers with SWAIG functions (handler-based). + +## Signature + +```rust +struct McpGateway { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/mcp_gateway.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs) + +Line 8. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/name.mdx new file mode 100644 index 0000000000..a6cad3b62a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::mcp_gateway::McpGateway::name" + parent: "signalwire::skills::builtin::mcp_gateway::McpGateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/mcp_gateway.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs) + +Line 21. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/new.mdx new file mode 100644 index 0000000000..32425b0a2d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::mcp_gateway::McpGateway::new" + parent: "signalwire::skills::builtin::mcp_gateway::McpGateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/mcp_gateway.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs) + +Line 13. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/params.mdx new file mode 100644 index 0000000000..29d648fb40 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::mcp_gateway::McpGateway::params" + parent: "signalwire::skills::builtin::mcp_gateway::McpGateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/mcp_gateway.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/register-tools.mdx new file mode 100644 index 0000000000..8565d0d589 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::mcp_gateway::McpGateway::register_tools" + parent: "signalwire::skills::builtin::mcp_gateway::McpGateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/mcp_gateway.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs) + +Line 37. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/setup.mdx new file mode 100644 index 0000000000..dc06358329 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/mcp-gateway/mcp-gateway/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::mcp_gateway::McpGateway::setup" + parent: "signalwire::skills::builtin::mcp_gateway::McpGateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/mcp_gateway.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/mcp_gateway.rs) + +Line 33. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/index.mdx new file mode 100644 index 0000000000..299686fc7d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/native-vector-search" +title: "native_vector_search" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::native_vector_search" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs" + visibility: "public" +--- +# `native_vector_search` + +## Classes + + + + Search document indexes using vector similarity and keyword search (handler-based). + + + +## Source + +[`src/skills/builtin/native_vector_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/description.mdx new file mode 100644 index 0000000000..5df3fcd2e0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch::description" + parent: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/native_vector_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/get-hints.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/get-hints.mdx new file mode 100644 index 0000000000..b99d3b0297 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/get-hints" +title: "get_hints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch::get_hints" + parent: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs" + visibility: "public" +--- +# `get_hints` + +## Signature + +```rust +fn get_hints(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/native_vector_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs) + +Line 98. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/index.mdx new file mode 100644 index 0000000000..afad045693 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search" +title: "NativeVectorSearch" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch" + parent: "signalwire::skills::builtin::native_vector_search" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs" + visibility: "public" +--- +# `NativeVectorSearch` + +Search document indexes using vector similarity and keyword search (handler-based). + +## Signature + +```rust +struct NativeVectorSearch { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/native_vector_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs) + +Line 8. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/name.mdx new file mode 100644 index 0000000000..591a45e45d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch::name" + parent: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/native_vector_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs) + +Line 21. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/new.mdx new file mode 100644 index 0000000000..ba0f27e4b5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch::new" + parent: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/native_vector_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs) + +Line 13. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/params.mdx new file mode 100644 index 0000000000..3243d67e34 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch::params" + parent: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/native_vector_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs) + +Line 33. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/register-tools.mdx new file mode 100644 index 0000000000..8c64680990 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch::register_tools" + parent: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/native_vector_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs) + +Line 41. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/setup.mdx new file mode 100644 index 0000000000..5dc7437a29 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch::setup" + parent: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/native_vector_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs) + +Line 37. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/supports-multiple-instances.mdx new file mode 100644 index 0000000000..f42e1206ed --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/native-vector-search/native-vector-search/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch::supports_multiple_instances" + parent: "signalwire::skills::builtin::native_vector_search::NativeVectorSearch" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/native_vector_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/native_vector_search.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/index.mdx new file mode 100644 index 0000000000..a6915675da --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/play-background-file" +title: "play_background_file" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::play_background_file" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs" + visibility: "public" +--- +# `play_background_file` + +## Classes + + + + Control background file playback (DataMap-based). + + + +## Source + +[`src/skills/builtin/play_background_file.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/description.mdx new file mode 100644 index 0000000000..1950f6ad62 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile::description" + parent: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/play_background_file.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs) + +Line 24. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/index.mdx new file mode 100644 index 0000000000..fb8d05e0f6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/index.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/play-background-file/play-background-file" +title: "PlayBackgroundFile" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile" + parent: "signalwire::skills::builtin::play_background_file" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs" + visibility: "public" +--- +# `PlayBackgroundFile` + +Control background file playback (DataMap-based). + +## Signature + +```rust +struct PlayBackgroundFile { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/play_background_file.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/name.mdx new file mode 100644 index 0000000000..1232bbba5f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile::name" + parent: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/play_background_file.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/new.mdx new file mode 100644 index 0000000000..b6a3e0623a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile::new" + parent: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/play_background_file.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/params.mdx new file mode 100644 index 0000000000..a83e229080 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile::params" + parent: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/play_background_file.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs) + +Line 32. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/register-tools.mdx new file mode 100644 index 0000000000..4ed390181a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile::register_tools" + parent: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/play_background_file.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs) + +Line 41. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/setup.mdx new file mode 100644 index 0000000000..154a55dd96 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile::setup" + parent: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/play_background_file.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs) + +Line 36. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/supports-multiple-instances.mdx new file mode 100644 index 0000000000..9590bf8708 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/play-background-file/play-background-file/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile::supports_multiple_instances" + parent: "signalwire::skills::builtin::play_background_file::PlayBackgroundFile" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/play_background_file.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/play_background_file.rs) + +Line 28. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/index.mdx new file mode 100644 index 0000000000..8a0b08da34 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/spider" +title: "spider" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::spider" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs" + visibility: "public" +--- +# `spider` + +## Classes + + + + Fast web scraping and crawling capabilities (handler-based). + + + +## Source + +[`src/skills/builtin/spider.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/description.mdx new file mode 100644 index 0000000000..a0ae84d3c1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/spider/spider/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::spider::Spider::description" + parent: "signalwire::skills::builtin::spider::Spider" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/spider.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/get-hints.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/get-hints.mdx new file mode 100644 index 0000000000..0ba1ef8afb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/spider/spider/get-hints" +title: "get_hints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::spider::Spider::get_hints" + parent: "signalwire::skills::builtin::spider::Spider" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs" + visibility: "public" +--- +# `get_hints` + +## Signature + +```rust +fn get_hints(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/spider.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs) + +Line 161. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/index.mdx new file mode 100644 index 0000000000..375c5b239c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/spider/spider" +title: "Spider" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::spider::Spider" + parent: "signalwire::skills::builtin::spider" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs" + visibility: "public" +--- +# `Spider` + +Fast web scraping and crawling capabilities (handler-based). + +## Signature + +```rust +struct Spider { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/spider.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs) + +Line 8. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/name.mdx new file mode 100644 index 0000000000..3cd83086c3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/spider/spider/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::spider::Spider::name" + parent: "signalwire::skills::builtin::spider::Spider" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/spider.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs) + +Line 21. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/new.mdx new file mode 100644 index 0000000000..fdeb32a775 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/spider/spider/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::spider::Spider::new" + parent: "signalwire::skills::builtin::spider::Spider" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/spider.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs) + +Line 13. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/params.mdx new file mode 100644 index 0000000000..5a3fb41fa0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/spider/spider/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::spider::Spider::params" + parent: "signalwire::skills::builtin::spider::Spider" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/spider.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs) + +Line 33. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/register-tools.mdx new file mode 100644 index 0000000000..c74167ebb7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/spider/spider/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::spider::Spider::register_tools" + parent: "signalwire::skills::builtin::spider::Spider" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/spider.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs) + +Line 41. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/setup.mdx new file mode 100644 index 0000000000..e2259f3091 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/spider/spider/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::spider::Spider::setup" + parent: "signalwire::skills::builtin::spider::Spider" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/spider.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs) + +Line 37. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/supports-multiple-instances.mdx new file mode 100644 index 0000000000..d1f8060584 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/spider/spider/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/spider/spider/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::spider::Spider::supports_multiple_instances" + parent: "signalwire::skills::builtin::spider::Spider" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/spider.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/spider.rs) + +Line 29. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/index.mdx new file mode 100644 index 0000000000..1f69b878f2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/swml-transfer" +title: "swml_transfer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::swml_transfer" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs" + visibility: "public" +--- +# `swml_transfer` + +## Classes + + + + Transfer calls between agents based on pattern matching (DataMap-based). + + + +## Source + +[`src/skills/builtin/swml_transfer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/description.mdx new file mode 100644 index 0000000000..4a189de011 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::swml_transfer::SwmlTransfer::description" + parent: "signalwire::skills::builtin::swml_transfer::SwmlTransfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/swml_transfer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs) + +Line 24. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/get-hints.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/get-hints.mdx new file mode 100644 index 0000000000..cd4dc050d2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/get-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/get-hints" +title: "get_hints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::swml_transfer::SwmlTransfer::get_hints" + parent: "signalwire::skills::builtin::swml_transfer::SwmlTransfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs" + visibility: "public" +--- +# `get_hints` + +## Signature + +```rust +fn get_hints(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/swml_transfer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs) + +Line 169. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/get-prompt-sections.mdx new file mode 100644 index 0000000000..8d1c64d03a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::swml_transfer::SwmlTransfer::get_prompt_sections" + parent: "signalwire::skills::builtin::swml_transfer::SwmlTransfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/swml_transfer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs) + +Line 190. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/index.mdx new file mode 100644 index 0000000000..099fc54446 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer" +title: "SwmlTransfer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::swml_transfer::SwmlTransfer" + parent: "signalwire::skills::builtin::swml_transfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs" + visibility: "public" +--- +# `SwmlTransfer` + +Transfer calls between agents based on pattern matching (DataMap-based). + +## Signature + +```rust +struct SwmlTransfer { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/swml_transfer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/name.mdx new file mode 100644 index 0000000000..df39c4b030 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::swml_transfer::SwmlTransfer::name" + parent: "signalwire::skills::builtin::swml_transfer::SwmlTransfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/swml_transfer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/new.mdx new file mode 100644 index 0000000000..4e5a500642 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::swml_transfer::SwmlTransfer::new" + parent: "signalwire::skills::builtin::swml_transfer::SwmlTransfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/swml_transfer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/params.mdx new file mode 100644 index 0000000000..dd0d1fd7d1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::swml_transfer::SwmlTransfer::params" + parent: "signalwire::skills::builtin::swml_transfer::SwmlTransfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/swml_transfer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs) + +Line 32. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/register-tools.mdx new file mode 100644 index 0000000000..55a4166122 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::swml_transfer::SwmlTransfer::register_tools" + parent: "signalwire::skills::builtin::swml_transfer::SwmlTransfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/swml_transfer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs) + +Line 45. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/setup.mdx new file mode 100644 index 0000000000..11547ebc4c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::swml_transfer::SwmlTransfer::setup" + parent: "signalwire::skills::builtin::swml_transfer::SwmlTransfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/swml_transfer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs) + +Line 36. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/supports-multiple-instances.mdx new file mode 100644 index 0000000000..9c1325eb6a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/swml-transfer/swml-transfer/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::swml_transfer::SwmlTransfer::supports_multiple_instances" + parent: "signalwire::skills::builtin::swml_transfer::SwmlTransfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/swml_transfer.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/swml_transfer.rs) + +Line 28. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/index.mdx new file mode 100644 index 0000000000..fcc11aff81 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/weather-api" +title: "weather_api" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::weather_api" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs" + visibility: "public" +--- +# `weather_api` + +## Classes + + + + Get current weather information from WeatherAPI.com (DataMap-based). + + + +## Source + +[`src/skills/builtin/weather_api.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/description.mdx new file mode 100644 index 0000000000..ad4c973fcf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/weather-api/weather-api/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::weather_api::WeatherApi::description" + parent: "signalwire::skills::builtin::weather_api::WeatherApi" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/weather_api.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs) + +Line 24. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/index.mdx new file mode 100644 index 0000000000..c33b169f7d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/weather-api/weather-api" +title: "WeatherApi" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::weather_api::WeatherApi" + parent: "signalwire::skills::builtin::weather_api" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs" + visibility: "public" +--- +# `WeatherApi` + +Get current weather information from WeatherAPI.com (DataMap-based). + +## Signature + +```rust +struct WeatherApi { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/weather_api.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/name.mdx new file mode 100644 index 0000000000..dee1ec2151 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/weather-api/weather-api/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::weather_api::WeatherApi::name" + parent: "signalwire::skills::builtin::weather_api::WeatherApi" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/weather_api.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/new.mdx new file mode 100644 index 0000000000..bbe6f3cf47 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/weather-api/weather-api/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::weather_api::WeatherApi::new" + parent: "signalwire::skills::builtin::weather_api::WeatherApi" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/weather_api.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/params.mdx new file mode 100644 index 0000000000..c75cb6540d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/weather-api/weather-api/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::weather_api::WeatherApi::params" + parent: "signalwire::skills::builtin::weather_api::WeatherApi" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/weather_api.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs) + +Line 28. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/register-tools.mdx new file mode 100644 index 0000000000..0753a0fade --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/weather-api/weather-api/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::weather_api::WeatherApi::register_tools" + parent: "signalwire::skills::builtin::weather_api::WeatherApi" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/weather_api.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs) + +Line 36. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/setup.mdx new file mode 100644 index 0000000000..ebd66d665c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/weather-api/weather-api/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/weather-api/weather-api/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::weather_api::WeatherApi::setup" + parent: "signalwire::skills::builtin::weather_api::WeatherApi" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/weather_api.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/weather_api.rs) + +Line 32. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/index.mdx new file mode 100644 index 0000000000..209a714d5c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search" +title: "web_search" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `web_search` + +## Classes + + + + Search the web using Google Custom Search API. + + + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/description.mdx new file mode 100644 index 0000000000..e94bd4cf8d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search/web-search/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search::WebSearch::description" + parent: "signalwire::skills::builtin::web_search::WebSearch" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 32. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/get-global-data.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/get-global-data.mdx new file mode 100644 index 0000000000..2eb8da1336 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/get-global-data.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search/web-search/get-global-data" +title: "get_global_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search::WebSearch::get_global_data" + parent: "signalwire::skills::builtin::web_search::WebSearch" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `get_global_data` + +## Signature + +```rust +fn get_global_data(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 153. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/get-prompt-sections.mdx new file mode 100644 index 0000000000..801859b1e2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search/web-search/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search::WebSearch::get_prompt_sections" + parent: "signalwire::skills::builtin::web_search::WebSearch" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 163. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/index.mdx new file mode 100644 index 0000000000..eb03bb5ea2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search/web-search" +title: "WebSearch" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search::WebSearch" + parent: "signalwire::skills::builtin::web_search" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `WebSearch` + +Search the web using Google Custom Search API. + +Mirrors Python's `signalwire.skills.web_search`: the SDK issues a +real HTTP GET to Google CSE (`https://www.googleapis.com/customsearch/v1`) +with the query, key, and CSE ID in the query string, and parses the +JSON response. The base URL can be overridden via the +`WEB_SEARCH_BASE_URL` env var (used by `audit_skills_dispatch.py`'s +fixture). Without that override, the URL points at Google. + +## Signature + +```rust +struct WebSearch { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 15. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/name.mdx new file mode 100644 index 0000000000..ae4d89d420 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search/web-search/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search::WebSearch::name" + parent: "signalwire::skills::builtin::web_search::WebSearch" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 28. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/new.mdx new file mode 100644 index 0000000000..a33f0d0418 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search/web-search/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search::WebSearch::new" + parent: "signalwire::skills::builtin::web_search::WebSearch" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/params.mdx new file mode 100644 index 0000000000..d997622233 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search/web-search/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search::WebSearch::params" + parent: "signalwire::skills::builtin::web_search::WebSearch" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 44. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/register-tools.mdx new file mode 100644 index 0000000000..a66a3d4787 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search/web-search/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search::WebSearch::register_tools" + parent: "signalwire::skills::builtin::web_search::WebSearch" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 61. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/setup.mdx new file mode 100644 index 0000000000..e997b4cec9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search/web-search/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search::WebSearch::setup" + parent: "signalwire::skills::builtin::web_search::WebSearch" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 48. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/supports-multiple-instances.mdx new file mode 100644 index 0000000000..ee8bc6c3da --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/supports-multiple-instances.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search/web-search/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search::WebSearch::supports_multiple_instances" + parent: "signalwire::skills::builtin::web_search::WebSearch" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 40. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/version.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/version.mdx new file mode 100644 index 0000000000..74471db25a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/web-search/web-search/version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/web-search/web-search/version" +title: "version" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::web_search::WebSearch::version" + parent: "signalwire::skills::builtin::web_search::WebSearch" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs" + visibility: "public" +--- +# `version` + +## Signature + +```rust +fn version(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/web_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/web_search.rs) + +Line 36. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/index.mdx new file mode 100644 index 0000000000..adee61f985 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/wikipedia-search" +title: "wikipedia_search" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::builtin::wikipedia_search" + parent: "signalwire::skills::builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs" + visibility: "public" +--- +# `wikipedia_search` + +## Classes + + + + Search Wikipedia and get article summaries. + + + +## Source + +[`src/skills/builtin/wikipedia_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/description.mdx new file mode 100644 index 0000000000..0b3f6cef2f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/description.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch::description" + parent: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs" + visibility: "public" +--- +# `description` + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/wikipedia_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs) + +Line 30. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/get-prompt-sections.mdx new file mode 100644 index 0000000000..092b0da315 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/get-prompt-sections.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch::get_prompt_sections" + parent: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs" + visibility: "public" +--- +# `get_prompt_sections` + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/builtin/wikipedia_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs) + +Line 129. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/index.mdx new file mode 100644 index 0000000000..7eabb55fe1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search" +title: "WikipediaSearch" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch" + parent: "signalwire::skills::builtin::wikipedia_search" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs" + visibility: "public" +--- +# `WikipediaSearch` + +Search Wikipedia and get article summaries. + +Mirrors Python's `signalwire.skills.wikipedia_search`: real HTTP GET +against the Wikipedia REST API. The base URL can be overridden by +setting `WIKIPEDIA_BASE_URL` (used by `audit_skills_dispatch.py`'s +fixture). Defaults to `https://en.wikipedia.org`. + +## Signature + +```rust +struct WikipediaSearch { /* fields */ } +``` + +## Inheritance + +**Implements:** `SkillBase` + +## Methods + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/builtin/wikipedia_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs) + +Line 13. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/name.mdx new file mode 100644 index 0000000000..b35d361776 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch::name" + parent: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/builtin/wikipedia_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs) + +Line 26. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/new.mdx new file mode 100644 index 0000000000..c79165f0ac --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch::new" + parent: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/builtin/wikipedia_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs) + +Line 18. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/params.mdx new file mode 100644 index 0000000000..0bf409a039 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/params.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch::params" + parent: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs" + visibility: "public" +--- +# `params` + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/builtin/wikipedia_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs) + +Line 34. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/register-tools.mdx new file mode 100644 index 0000000000..46cc8cbf4f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/register-tools.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch::register_tools" + parent: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs" + visibility: "public" +--- +# `register_tools` + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/builtin/wikipedia_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs) + +Line 42. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/setup.mdx new file mode 100644 index 0000000000..a49e0d4418 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/setup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/builtin/wikipedia-search/wikipedia-search/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch::setup" + parent: "signalwire::skills::builtin::wikipedia_search::WikipediaSearch" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs" + visibility: "public" +--- +# `setup` + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/builtin/wikipedia_search.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/builtin/wikipedia_search.rs) + +Line 38. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/index.mdx new file mode 100644 index 0000000000..143b5036cc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/rust/signalwire/skills" +title: "skills" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/mod.rs" + visibility: "public" +--- +# `skills` + +## Modules + + + + + + + + + + + +## Source + +[`src/skills/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/index.mdx new file mode 100644 index 0000000000..326639d22e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base" +title: "skill_base" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::skill_base" + parent: "signalwire::skills" + module: "skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `skill_base` + +## Functions + + + + Convert a `Value` (expected to be an object) into a `Map`. + + + +## Classes + + + + Parameters holder used by the default `SkillBase` implementations. + + + +## Interfaces + + + + Trait implemented by all skills (both builtin and custom). + + + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/cleanup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/cleanup.mdx new file mode 100644 index 0000000000..8ddabd0cb5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/cleanup.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/cleanup" +title: "cleanup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::cleanup" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `cleanup` + +Called when the skill is unloaded. + +## Signature + +```rust +fn cleanup(&mut self) +``` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 89. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/description.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/description.mdx new file mode 100644 index 0000000000..19c29495a2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/description.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/description" +title: "description" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::description" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `description` + +Human-readable description. + +## Signature + +```rust +fn description(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 14. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-global-data.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-global-data.mdx new file mode 100644 index 0000000000..1b9f01d8c6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/get-global-data" +title: "get_global_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::get_global_data" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_global_data` + +Key/value pairs merged into the agent's global data. + +## Signature + +```rust +fn get_global_data(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 53. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-hints.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-hints.mdx new file mode 100644 index 0000000000..9a9100a052 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-hints.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/get-hints" +title: "get_hints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::get_hints" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_hints` + +Speech recognition hints. + +## Signature + +```rust +fn get_hints(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 48. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-instance-key.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-instance-key.mdx new file mode 100644 index 0000000000..897327e700 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-instance-key.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/get-instance-key" +title: "get_instance_key" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::get_instance_key" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_instance_key` + +Instance key used to track loaded skills (allows tool\_name overrides). + +## Signature + +```rust +fn get_instance_key(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 32. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-parameter-schema.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-parameter-schema.mdx new file mode 100644 index 0000000000..08008d27ea --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-parameter-schema.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/get-parameter-schema" +title: "get_parameter_schema" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::get_parameter_schema" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_parameter_schema` + +JSON-Schema describing accepted parameters. + +## Signature + +```rust +fn get_parameter_schema(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 66. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-prompt-sections.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-prompt-sections.mdx new file mode 100644 index 0000000000..3d008282d9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-prompt-sections.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/get-prompt-sections" +title: "get_prompt_sections" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::get_prompt_sections" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_prompt_sections` + +POM sections merged into the agent's prompt. + +## Signature + +```rust +fn get_prompt_sections(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 58. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-swaig-fields.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-swaig-fields.mdx new file mode 100644 index 0000000000..144da24575 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-swaig-fields.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/get-swaig-fields" +title: "get_swaig_fields" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::get_swaig_fields" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_swaig_fields` + +Get the SWAIG fields to merge into tool definitions. + +## Signature + +```rust +fn get_swaig_fields(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 115. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-tool-name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-tool-name.mdx new file mode 100644 index 0000000000..2c33844ece --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/get-tool-name.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/get-tool-name" +title: "get_tool_name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::get_tool_name" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_tool_name` + +Get the tool name, falling back to `default` if no override is set. + +## Signature + +```rust +fn get_tool_name(&self, default: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 106. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/index.mdx new file mode 100644 index 0000000000..6a2dfd5e66 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/index.mdx @@ -0,0 +1,109 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base" +title: "SkillBase" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "interface" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase" + parent: "signalwire::skills::skill_base" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `SkillBase` + +Trait implemented by all skills (both builtin and custom). + +A skill encapsulates tools, hints, global data, and prompt sections that can +be loaded into an `AgentBase` via the `SkillManager`. + +## Signature + +```rust +trait SkillBase +``` + +## Inheritance + +**Extends:** `?`, `?` + +## Methods + + + + Called when the skill is unloaded. + + + + Human-readable description. + + + + Key/value pairs merged into the agent's global data. + + + + Speech recognition hints. + + + + Instance key used to track loaded skills (allows tool\_name overrides). + + + + JSON-Schema describing accepted parameters. + + + + POM sections merged into the agent's prompt. + + + + Get the SWAIG fields to merge into tool definitions. + + + + Get the tool name, falling back to `default` if no override is set. + + + + Unique snake\_case name of this skill (e.g. `"datetime"`). + + + + Access the skill's configuration parameters. + + + + Register tools on the agent. + + + + Environment variables that must be set before `setup` is called. + + + + One-time setup. Return `true` on success. + + + + Whether multiple instances of this skill can be loaded simultaneously. + + + + Validate that all required env vars are set. Returns missing var names. + + + + Semantic version string. + + + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 9. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/name.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/name.mdx new file mode 100644 index 0000000000..9adec5dced --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/name.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::name" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `name` + +Unique snake\_case name of this skill (e.g. `"datetime"`). + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 11. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/params.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/params.mdx new file mode 100644 index 0000000000..0eb244847b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/params.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/params" +title: "params" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::params" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `params` + +Access the skill's configuration parameters. + +## Signature + +```rust +fn params(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 92. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/register-tools.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/register-tools.mdx new file mode 100644 index 0000000000..adac025233 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/register-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/register-tools" +title: "register_tools" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::register_tools" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `register_tools` + +Register tools on the agent. + +## Signature + +```rust +fn register_tools(&self, agent: &mut ?) +``` + +## Parameters + + + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 45. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/required-env-vars.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/required-env-vars.mdx new file mode 100644 index 0000000000..925af65e33 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/required-env-vars.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/required-env-vars" +title: "required_env_vars" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::required_env_vars" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `required_env_vars` + +Environment variables that must be set before `setup` is called. + +## Signature + +```rust +fn required_env_vars(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 22. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/setup.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/setup.mdx new file mode 100644 index 0000000000..608590a4fe --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/setup" +title: "setup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::setup" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `setup` + +One-time setup. Return `true` on success. + +## Signature + +```rust +fn setup(&mut self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 42. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/supports-multiple-instances.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/supports-multiple-instances.mdx new file mode 100644 index 0000000000..d211305832 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/supports-multiple-instances.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/supports-multiple-instances" +title: "supports_multiple_instances" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::supports_multiple_instances" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `supports_multiple_instances` + +Whether multiple instances of this skill can be loaded simultaneously. + +## Signature + +```rust +fn supports_multiple_instances(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 27. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/validate-env-vars.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/validate-env-vars.mdx new file mode 100644 index 0000000000..001697d61f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/validate-env-vars.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/validate-env-vars" +title: "validate_env_vars" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::validate_env_vars" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `validate_env_vars` + +Validate that all required env vars are set. Returns missing var names. + +## Signature + +```rust +fn validate_env_vars(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 95. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/version.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/version.mdx new file mode 100644 index 0000000000..cbc0664be3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-base/version.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-base/version" +title: "version" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillBase::version" + parent: "signalwire::skills::skill_base::SkillBase" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `version` + +Semantic version string. + +## Signature + +```rust +fn version(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 17. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/clone.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/clone.mdx new file mode 100644 index 0000000000..dee7b7513a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams::clone" + parent: "signalwire::skills::skill_base::SkillParams" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 125. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/empty.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/empty.mdx new file mode 100644 index 0000000000..3882c79c7f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/empty.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params/empty" +title: "empty" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams::empty" + parent: "signalwire::skills::skill_base::SkillParams" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `empty` + +## Signature + +```rust +fn empty() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 135. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/fmt.mdx new file mode 100644 index 0000000000..de0623e21f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams::fmt" + parent: "signalwire::skills::skill_base::SkillParams" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 125. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-array.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-array.mdx new file mode 100644 index 0000000000..3ef310b091 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-array.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params/get-array" +title: "get_array" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams::get_array" + parent: "signalwire::skills::skill_base::SkillParams" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_array` + +## Signature + +```rust +fn get_array(&self, key: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 159. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-bool.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-bool.mdx new file mode 100644 index 0000000000..10cf62178d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-bool.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params/get-bool" +title: "get_bool" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams::get_bool" + parent: "signalwire::skills::skill_base::SkillParams" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_bool` + +## Signature + +```rust +fn get_bool(&self, key: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 147. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-f64.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-f64.mdx new file mode 100644 index 0000000000..c292707d41 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-f64.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params/get-f64" +title: "get_f64" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams::get_f64" + parent: "signalwire::skills::skill_base::SkillParams" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_f64` + +## Signature + +```rust +fn get_f64(&self, key: &str, default: f64) -> f64 +``` + +## Parameters + + + + + +## Returns + +`f64` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 155. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-i64.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-i64.mdx new file mode 100644 index 0000000000..84abc892b0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-i64.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params/get-i64" +title: "get_i64" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams::get_i64" + parent: "signalwire::skills::skill_base::SkillParams" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_i64` + +## Signature + +```rust +fn get_i64(&self, key: &str, default: i64) -> i64 +``` + +## Parameters + + + + + +## Returns + +`i64` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 151. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-object.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-object.mdx new file mode 100644 index 0000000000..da4b06608a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-object.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params/get-object" +title: "get_object" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams::get_object" + parent: "signalwire::skills::skill_base::SkillParams" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_object` + +## Signature + +```rust +fn get_object(&self, key: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 167. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-str-or.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-str-or.mdx new file mode 100644 index 0000000000..9415c9f547 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-str-or.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params/get-str-or" +title: "get_str_or" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams::get_str_or" + parent: "signalwire::skills::skill_base::SkillParams" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_str_or` + +## Signature + +```rust +fn get_str_or(&self, key: &str, default: &str) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 143. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-str.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-str.mdx new file mode 100644 index 0000000000..430fbf9bcc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/get-str.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params/get-str" +title: "get_str" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams::get_str" + parent: "signalwire::skills::skill_base::SkillParams" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `get_str` + +## Signature + +```rust +fn get_str(&self, key: &str) -> ?<&str> +``` + +## Parameters + + + +## Returns + +`?<&str>` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 139. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/index.mdx new file mode 100644 index 0000000000..03f92b7c3e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/index.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params" +title: "SkillParams" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams" + parent: "signalwire::skills::skill_base" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `SkillParams` + +Parameters holder used by the default `SkillBase` implementations. + +## Signature + +```rust +struct SkillParams { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone` + +## Properties + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 126. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/new.mdx new file mode 100644 index 0000000000..871a4bce11 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/skill-params/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/skill-params/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_base::SkillParams::new" + parent: "signalwire::skills::skill_base::SkillParams" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(params: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 131. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-base/value-to-map.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/value-to-map.mdx new file mode 100644 index 0000000000..40e0b876e0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-base/value-to-map.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-base/value-to-map" +title: "value_to_map" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::skills::skill_base::value_to_map" + parent: "signalwire::skills::skill_base" + module: "skills.skill_base" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs" + visibility: "public" +--- +# `value_to_map` + +Convert a `Value` (expected to be an object) into a `Map`. + +## Signature + +```rust +fn value_to_map(val: ?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/skills/skill_base.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_base.rs) + +Line 177. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/index.mdx new file mode 100644 index 0000000000..411c04dd1e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-manager" +title: "skill_manager" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::skill_manager" + parent: "signalwire::skills" + module: "skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs" + visibility: "public" +--- +# `skill_manager` + +## Classes + + + + Manages loaded skills for an agent — validates, sets up, and merges skill contributions (tools, hints, global data, prompt sections) into the agent. + + + +## Source + +[`src/skills/skill_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/default.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/default.mdx new file mode 100644 index 0000000000..b9a0aff179 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/default.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-manager/skill-manager/default" +title: "default" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_manager::SkillManager::default" + parent: "signalwire::skills::skill_manager::SkillManager" + module: "skills.skill_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs" + visibility: "public" +--- +# `default` + +## Signature + +```rust +fn default() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/skills/skill_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs) + +Line 207. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/get-skill.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/get-skill.mdx new file mode 100644 index 0000000000..a2b3e55071 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/get-skill.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-manager/skill-manager/get-skill" +title: "get_skill" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_manager::SkillManager::get_skill" + parent: "signalwire::skills::skill_manager::SkillManager" + module: "skills.skill_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs" + visibility: "public" +--- +# `get_skill` + +Get a reference to a loaded skill. + +## Signature + +```rust +fn get_skill(&self, key: &str) -> ?> +``` + +## Parameters + + + +## Returns + +`?>` + +## Source + +[`src/skills/skill_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs) + +Line 201. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/has-skill.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/has-skill.mdx new file mode 100644 index 0000000000..538e311dfa --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/has-skill.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-manager/skill-manager/has-skill" +title: "has_skill" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_manager::SkillManager::has_skill" + parent: "signalwire::skills::skill_manager::SkillManager" + module: "skills.skill_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs" + visibility: "public" +--- +# `has_skill` + +Check if a skill is loaded. + +## Signature + +```rust +fn has_skill(&self, key: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs) + +Line 196. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/index.mdx new file mode 100644 index 0000000000..8b5e14e09f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-manager/skill-manager" +title: "SkillManager" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::skill_manager::SkillManager" + parent: "signalwire::skills::skill_manager" + module: "skills.skill_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs" + visibility: "public" +--- +# `SkillManager` + +Manages loaded skills for an agent — validates, sets up, and merges skill +contributions (tools, hints, global data, prompt sections) into the agent. + +## Signature + +```rust +struct SkillManager { /* fields */ } +``` + +## Inheritance + +**Implements:** `Default` + +## Methods + + + + + + Get a reference to a loaded skill. + + + + Check if a skill is loaded. + + + + List all loaded skill instance keys. + + + + Load a skill by registry name, creating it via the registry factory. + + + + Load a skill from a pre-constructed instance. + + + + + + Unload a skill by instance key. + + + +## Source + +[`src/skills/skill_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/list-skills.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/list-skills.mdx new file mode 100644 index 0000000000..8fd1211fe1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/list-skills.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-manager/skill-manager/list-skills" +title: "list_skills" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_manager::SkillManager::list_skills" + parent: "signalwire::skills::skill_manager::SkillManager" + module: "skills.skill_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs" + visibility: "public" +--- +# `list_skills` + +List all loaded skill instance keys. + +## Signature + +```rust +fn list_skills(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs) + +Line 189. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/load-skill-instance.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/load-skill-instance.mdx new file mode 100644 index 0000000000..517c2a161c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/load-skill-instance.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-manager/skill-manager/load-skill-instance" +title: "load_skill_instance" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_manager::SkillManager::load_skill_instance" + parent: "signalwire::skills::skill_manager::SkillManager" + module: "skills.skill_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs" + visibility: "public" +--- +# `load_skill_instance` + +Load a skill from a pre-constructed instance. + +## Signature + +```rust +fn load_skill_instance( + &mut self, + instance: ?, + agent: &mut ? +) -> (bool, ?) +``` + +## Parameters + + + + + +## Returns + +`(bool, ?)` + +## Source + +[`src/skills/skill_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs) + +Line 113. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/load-skill.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/load-skill.mdx new file mode 100644 index 0000000000..8a130631e1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/load-skill.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-manager/skill-manager/load-skill" +title: "load_skill" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_manager::SkillManager::load_skill" + parent: "signalwire::skills::skill_manager::SkillManager" + module: "skills.skill_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs" + visibility: "public" +--- +# `load_skill` + +Load a skill by registry name, creating it via the registry factory. + +Returns `(true, "")` on success, or `(false, reason)` on failure. + +## Signature + +```rust +fn load_skill( + &mut self, + skill_name: &str, + params: ?, + agent: &mut ? +) -> (bool, ?) +``` + +## Parameters + + + + + + + +## Returns + +`(bool, ?)` + +## Source + +[`src/skills/skill_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs) + +Line 26. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/new.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/new.mdx new file mode 100644 index 0000000000..7813679766 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/new.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-manager/skill-manager/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_manager::SkillManager::new" + parent: "signalwire::skills::skill_manager::SkillManager" + module: "skills.skill_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/skills/skill_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs) + +Line 17. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/unload-skill.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/unload-skill.mdx new file mode 100644 index 0000000000..3226c894d8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-manager/skill-manager/unload-skill.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-manager/skill-manager/unload-skill" +title: "unload_skill" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_manager::SkillManager::unload_skill" + parent: "signalwire::skills::skill_manager::SkillManager" + module: "skills.skill_manager" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs" + visibility: "public" +--- +# `unload_skill` + +Unload a skill by instance key. + +## Signature + +```rust +fn unload_skill(&mut self, key: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/skills/skill_manager.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_manager.rs) + +Line 184. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/index.mdx new file mode 100644 index 0000000000..99513307ec --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-registry" +title: "skill_registry" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::skills::skill_registry" + parent: "signalwire::skills" + module: "skills" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs" + visibility: "public" +--- +# `skill_registry` + +## Type Aliases + + + + Factory function that creates a new skill instance given parameters. + + + +## Classes + + + + Public interface to the global skill registry. + + + +## Source + +[`src/skills/skill_registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-factory.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-factory.mdx new file mode 100644 index 0000000000..7cf1e88b21 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-factory.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-registry/skill-factory" +title: "SkillFactory" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "signalwire::skills::skill_registry::SkillFactory" + parent: "signalwire::skills::skill_registry" + module: "skills.skill_registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs" + visibility: "public" +--- +# `SkillFactory` + +Factory function that creates a new skill instance given parameters. + +## Signature + +```rust +type SkillFactory = ? +``` + +## Source + +[`src/skills/skill_registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs) + +Line 11. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/add-skill-directory.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/add-skill-directory.mdx new file mode 100644 index 0000000000..1e694c6eca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/add-skill-directory.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-registry/skill-registry/add-skill-directory" +title: "add_skill_directory" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_registry::SkillRegistry::add_skill_directory" + parent: "signalwire::skills::skill_registry::SkillRegistry" + module: "skills.skill_registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs" + visibility: "public" +--- +# `add_skill_directory` + +Register an external directory containing third-party skill +factories. + +Mirrors Python's +`signalwire.skills.registry.SkillRegistry.add_skill_directory`. +Rust cannot dynamically load `.rs` files the way Python loads +`.py` modules from a directory; in Rust, third-party skills +must call \[`SkillRegistry::register_skill`] at startup. The +path is recorded for introspection / logging purposes (matching +the Python `_external_paths` field) so the surface contract +matches. + +**Errors:** + +Returns an error string if the directory does not exist or is +not a directory. + +## Signature + +```rust +fn add_skill_directory(path: &str) -> ?<(), ?> +``` + +## Parameters + + + +## Returns + +`?<(), ?>` + +## Source + +[`src/skills/skill_registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs) + +Line 172. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/external-paths.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/external-paths.mdx new file mode 100644 index 0000000000..1896b4b244 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/external-paths.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-registry/skill-registry/external-paths" +title: "external_paths" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_registry::SkillRegistry::external_paths" + parent: "signalwire::skills::skill_registry::SkillRegistry" + module: "skills.skill_registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs" + visibility: "public" +--- +# `external_paths` + +Read the list of external skill directories registered via +\[`SkillRegistry::add_skill_directory`]. + +## Signature + +```rust +fn external_paths() -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs) + +Line 190. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/get-factory.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/get-factory.mdx new file mode 100644 index 0000000000..32861ebc91 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/get-factory.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-registry/skill-registry/get-factory" +title: "get_factory" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_registry::SkillRegistry::get_factory" + parent: "signalwire::skills::skill_registry::SkillRegistry" + module: "skills.skill_registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs" + visibility: "public" +--- +# `get_factory` + +Get the factory for a skill by name. + +## Signature + +```rust +fn get_factory(name: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/skills/skill_registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs) + +Line 130. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/index.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/index.mdx new file mode 100644 index 0000000000..c3b9f57cb0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-registry/skill-registry" +title: "SkillRegistry" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::skills::skill_registry::SkillRegistry" + parent: "signalwire::skills::skill_registry" + module: "skills.skill_registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs" + visibility: "public" +--- +# `SkillRegistry` + +Public interface to the global skill registry. + +## Signature + +```rust +struct SkillRegistry; +``` + +## Methods + + + + Register an external directory containing third-party skill factories. + + + + Read the list of external skill directories registered via \[`SkillRegistry::add_skill_directory`]. + + + + Get the factory for a skill by name. + + + + List all registered skill names (sorted). + + + + Register a custom skill factory. + + + +## Source + +[`src/skills/skill_registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs) + +Line 120. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/list-skills.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/list-skills.mdx new file mode 100644 index 0000000000..6a5ce0d9b0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/list-skills.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-registry/skill-registry/list-skills" +title: "list_skills" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_registry::SkillRegistry::list_skills" + parent: "signalwire::skills::skill_registry::SkillRegistry" + module: "skills.skill_registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs" + visibility: "public" +--- +# `list_skills` + +List all registered skill names (sorted). + +## Signature + +```rust +fn list_skills() -> ? +``` + +## Returns + +`?` + +## Source + +[`src/skills/skill_registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs) + +Line 150. diff --git a/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/register-skill.mdx b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/register-skill.mdx new file mode 100644 index 0000000000..52df96e502 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/skills/skill-registry/skill-registry/register-skill.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/skills/skill-registry/skill-registry/register-skill" +title: "register_skill" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::skills::skill_registry::SkillRegistry::register_skill" + parent: "signalwire::skills::skill_registry::SkillRegistry" + module: "skills.skill_registry" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs" + visibility: "public" +--- +# `register_skill` + +Register a custom skill factory. + +## Signature + +```rust +fn register_skill(name: &str, factory: ?) +``` + +## Parameters + + + + + +## Source + +[`src/skills/skill_registry.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/skills/skill_registry.rs) + +Line 124. diff --git a/fern/products/sdk-reference/rust/signalwire/start-agent.mdx b/fern/products/sdk-reference/rust/signalwire/start-agent.mdx new file mode 100644 index 0000000000..b8cb322b88 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/start-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/start-agent" +title: "start_agent" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::start_agent" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs" + visibility: "public" +--- +# `start_agent` + +Construct an \[`AgentServer`] containing a single \[`AgentBase`] and +run it on the configured `host:port`. Blocking call. + +Mirrors Python's `signalwire.start_agent(agent, host=..., port=...)` +— the Python helper instantiates an AgentServer behind the scenes, +registers the agent, and runs it. The Rust signature accepts an +owned `AgentBase` (Rust's ownership model makes "move into the +server, then run" the natural shape). + +## Signature + +```rust +fn start_agent(agent: ?, host: ?<&str>, port: ?) +``` + +## Parameters + + + + + + + +## Source + +[`src/lib.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/lib.rs) + +Line 64. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/add-action.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/add-action.mdx new file mode 100644 index 0000000000..c98e075244 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/add-action.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/add-action" +title: "add_action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::add_action" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `add_action` + +## Signature + +```rust +fn add_action(&mut self, action: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 45. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/add-actions.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/add-actions.mdx new file mode 100644 index 0000000000..cdde45c687 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/add-actions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/add-actions" +title: "add_actions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::add_actions" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `add_actions` + +## Signature + +```rust +fn add_actions(&mut self, actions: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 50. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/add-dynamic-hints.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/add-dynamic-hints.mdx new file mode 100644 index 0000000000..a7ed019fb2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/add-dynamic-hints.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/add-dynamic-hints" +title: "add_dynamic_hints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::add_dynamic_hints" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `add_dynamic_hints` + +## Signature + +```rust +fn add_dynamic_hints(&mut self, hints: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 279. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/clear-dynamic-hints.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/clear-dynamic-hints.mdx new file mode 100644 index 0000000000..23f0a36bf9 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/clear-dynamic-hints.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/clear-dynamic-hints" +title: "clear_dynamic_hints" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::clear_dynamic_hints" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `clear_dynamic_hints` + +## Signature + +```rust +fn clear_dynamic_hints(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 284. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/clone.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/clone.mdx new file mode 100644 index 0000000000..db30898016 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::clone" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 9. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/connect.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/connect.mdx new file mode 100644 index 0000000000..ae1ff03277 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/connect.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/connect" +title: "connect" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::connect" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `connect` + +## Signature + +```rust +fn connect(&mut self, destination: &str, _final: bool, from: &str) -> &mut Self +``` + +## Parameters + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 84. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/create-payment-action.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/create-payment-action.mdx new file mode 100644 index 0000000000..76c182aa7e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/create-payment-action.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/create-payment-action" +title: "create_payment_action" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::create_payment_action" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `create_payment_action` + +## Signature + +```rust +fn create_payment_action( + action_type: &str, + text: &str, + language: &str, + voice: &str +) -> ? +``` + +## Parameters + + + + + + + + + +## Returns + +`?` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 497. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/create-payment-parameter.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/create-payment-parameter.mdx new file mode 100644 index 0000000000..a33bf94a9d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/create-payment-parameter.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/create-payment-parameter" +title: "create_payment_parameter" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::create_payment_parameter" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `create_payment_parameter` + +## Signature + +```rust +fn create_payment_parameter(name: &str, param_type: &str, config: ?) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 508. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/create-payment-prompt.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/create-payment-prompt.mdx new file mode 100644 index 0000000000..27b8c2220e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/create-payment-prompt.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/create-payment-prompt" +title: "create_payment_prompt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::create_payment_prompt" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `create_payment_prompt` + +## Signature + +```rust +fn create_payment_prompt(text: &str, language: &str, voice: &str) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 487. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/default.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/default.mdx new file mode 100644 index 0000000000..a90ab823f7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/default.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/default" +title: "default" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::default" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `default` + +## Signature + +```rust +fn default() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 522. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/enable-extensive-data.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/enable-extensive-data.mdx new file mode 100644 index 0000000000..b4c85bd988 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/enable-extensive-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/enable-extensive-data" +title: "enable_extensive_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::enable_extensive_data" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `enable_extensive_data` + +## Signature + +```rust +fn enable_extensive_data(&mut self, enabled: bool) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 313. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/enable-functions-on-timeout.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/enable-functions-on-timeout.mdx new file mode 100644 index 0000000000..83867fc79a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/enable-functions-on-timeout.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/enable-functions-on-timeout" +title: "enable_functions_on_timeout" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::enable_functions_on_timeout" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `enable_functions_on_timeout` + +## Signature + +```rust +fn enable_functions_on_timeout(&mut self, enabled: bool) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 308. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/execute-rpc.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/execute-rpc.mdx new file mode 100644 index 0000000000..85c3dee505 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/execute-rpc.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/execute-rpc" +title: "execute_rpc" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::execute_rpc" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `execute_rpc` + +## Signature + +```rust +fn execute_rpc(&mut self, method: &str, params: ?) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 433. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/execute-swml.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/execute-swml.mdx new file mode 100644 index 0000000000..5146c36c1e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/execute-swml.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/execute-swml" +title: "execute_swml" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::execute_swml" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `execute_swml` + +## Signature + +```rust +fn execute_swml(&mut self, swml_content: ?, transfer: bool) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 325. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/fmt.mdx new file mode 100644 index 0000000000..8b73329fe4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::fmt" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 9. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/hangup.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/hangup.mdx new file mode 100644 index 0000000000..ad6b95acff --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/hangup.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/hangup" +title: "hangup" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::hangup" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `hangup` + +## Signature + +```rust +fn hangup(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 112. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/hold.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/hold.mdx new file mode 100644 index 0000000000..1bb6745063 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/hold.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/hold" +title: "hold" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::hold" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `hold` + +## Signature + +```rust +fn hold(&mut self, timeout: i64) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 117. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/index.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/index.mdx new file mode 100644 index 0000000000..4dac3bdb82 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/index.mdx @@ -0,0 +1,157 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result" +title: "FunctionResult" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult" + parent: "signalwire::swaig::function_result" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `FunctionResult` + +Result returned from a SWAIG function handler. + +Serialises to `{"response": "...", "action": [...], "post_process": true}` where +`action` is omitted when empty and `post_process` is omitted when false. + +## Signature + +```rust +struct FunctionResult { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone`, `Default` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Replace conversation history. Pass `None` for text to use "summary". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Compact JSON string. + + + + Serialise to a JSON value. + + + + + + + + + + + + + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 10. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/join-conference.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/join-conference.mdx new file mode 100644 index 0000000000..5d67f3bdbb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/join-conference.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/join-conference" +title: "join_conference" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::join_conference" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `join_conference` + +## Signature + +```rust +fn join_conference( + &mut self, + name: &str, + muted: bool, + beep: &str, + hold_audio: &str +) -> &mut Self +``` + +## Parameters + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 334. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/join-room.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/join-room.mdx new file mode 100644 index 0000000000..009a60fff7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/join-room.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/join-room" +title: "join_room" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::join_room" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `join_room` + +## Signature + +```rust +fn join_room(&mut self, name: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 352. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/new.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/new.mdx new file mode 100644 index 0000000000..ef8668cc50 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/new.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::new" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 17. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/pay.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/pay.mdx new file mode 100644 index 0000000000..b3da85fcfa --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/pay.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/pay" +title: "pay" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::pay" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `pay` + +## Signature + +```rust +fn pay( + &mut self, + connector_url: &str, + input_method: &str, + action_url: &str, + timeout: i64, + max_attempts: i64 +) -> &mut Self +``` + +## Parameters + + + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 411. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/play-background-file.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/play-background-file.mdx new file mode 100644 index 0000000000..86cfddb8c3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/play-background-file.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/play-background-file" +title: "play_background_file" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::play_background_file" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `play_background_file` + +## Signature + +```rust +fn play_background_file(&mut self, filename: &str, wait: bool) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 235. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/record-call.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/record-call.mdx new file mode 100644 index 0000000000..9ad5c2c76d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/record-call.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/record-call" +title: "record_call" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::record_call" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `record_call` + +## Signature + +```rust +fn record_call( + &mut self, + control_id: &str, + stereo: bool, + format: &str, + direction: &str +) -> &mut Self +``` + +## Parameters + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 249. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/remove-global-data.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/remove-global-data.mdx new file mode 100644 index 0000000000..cde31358fd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/remove-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/remove-global-data" +title: "remove_global_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::remove_global_data" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `remove_global_data` + +## Signature + +```rust +fn remove_global_data(&mut self, keys: ?<&str>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 161. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/remove-metadata.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/remove-metadata.mdx new file mode 100644 index 0000000000..afc1ab20f3 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/remove-metadata.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/remove-metadata" +title: "remove_metadata" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::remove_metadata" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `remove_metadata` + +## Signature + +```rust +fn remove_metadata(&mut self, keys: ?<&str>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 171. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/replace-in-history.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/replace-in-history.mdx new file mode 100644 index 0000000000..4d6545503c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/replace-in-history.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/replace-in-history" +title: "replace_in_history" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::replace_in_history" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `replace_in_history` + +Replace conversation history. Pass `None` for text to use "summary". + +## Signature + +```rust +fn replace_in_history(&mut self, text: ?<&str>) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 220. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/rpc-ai-message.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/rpc-ai-message.mdx new file mode 100644 index 0000000000..0fdc2f1c53 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/rpc-ai-message.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/rpc-ai-message" +title: "rpc_ai_message" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::rpc_ai_message" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `rpc_ai_message` + +## Signature + +```rust +fn rpc_ai_message(&mut self, call_id: &str, message_text: &str) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 469. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/rpc-ai-unhold.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/rpc-ai-unhold.mdx new file mode 100644 index 0000000000..20f69ae3ba --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/rpc-ai-unhold.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/rpc-ai-unhold" +title: "rpc_ai_unhold" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::rpc_ai_unhold" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `rpc_ai_unhold` + +## Signature + +```rust +fn rpc_ai_unhold(&mut self, call_id: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 476. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/rpc-dial.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/rpc-dial.mdx new file mode 100644 index 0000000000..39b8538575 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/rpc-dial.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/rpc-dial" +title: "rpc_dial" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::rpc_dial" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `rpc_dial` + +## Signature + +```rust +fn rpc_dial( + &mut self, + to: &str, + from: &str, + dest_swml: ?<&str>, + call_timeout: ?, + region: &str +) -> &mut Self +``` + +## Parameters + + + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 444. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/say.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/say.mdx new file mode 100644 index 0000000000..2c7c3b575a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/say.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/say" +title: "say" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::say" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `say` + +## Signature + +```rust +fn say(&mut self, text: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 230. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/send-sms.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/send-sms.mdx new file mode 100644 index 0000000000..f15b5b20bd --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/send-sms.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/send-sms" +title: "send_sms" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::send_sms" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `send_sms` + +## Signature + +```rust +fn send_sms( + &mut self, + to: &str, + from: &str, + body: &str, + media: ?<&str>, + tags: ?<&str> +) -> &mut Self +``` + +## Parameters + + + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 389. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-end-of-speech-timeout.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-end-of-speech-timeout.mdx new file mode 100644 index 0000000000..99275bf630 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-end-of-speech-timeout.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/set-end-of-speech-timeout" +title: "set_end_of_speech_timeout" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::set_end_of_speech_timeout" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `set_end_of_speech_timeout` + +## Signature + +```rust +fn set_end_of_speech_timeout(&mut self, ms: i64) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 289. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-metadata.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-metadata.mdx new file mode 100644 index 0000000000..3f26826786 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-metadata.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/set-metadata" +title: "set_metadata" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::set_metadata" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `set_metadata` + +## Signature + +```rust +fn set_metadata(&mut self, data: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 166. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-post-process.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-post-process.mdx new file mode 100644 index 0000000000..f2540ebc6c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-post-process.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/set-post-process" +title: "set_post_process" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::set_post_process" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `set_post_process` + +## Signature + +```rust +fn set_post_process(&mut self, val: bool) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 40. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-response.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-response.mdx new file mode 100644 index 0000000000..8cfa2467b1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-response.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/set-response" +title: "set_response" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::set_response" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `set_response` + +## Signature + +```rust +fn set_response(&mut self, text: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 35. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-speech-event-timeout.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-speech-event-timeout.mdx new file mode 100644 index 0000000000..a39830aeed --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/set-speech-event-timeout.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/set-speech-event-timeout" +title: "set_speech_event_timeout" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::set_speech_event_timeout" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `set_speech_event_timeout` + +## Signature + +```rust +fn set_speech_event_timeout(&mut self, ms: i64) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 294. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/simulate-user-input.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/simulate-user-input.mdx new file mode 100644 index 0000000000..7af44a7eda --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/simulate-user-input.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/simulate-user-input" +title: "simulate_user_input" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::simulate_user_input" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `simulate_user_input` + +## Signature + +```rust +fn simulate_user_input(&mut self, text: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 480. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/sip-refer.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/sip-refer.mdx new file mode 100644 index 0000000000..7dcc26a3ed --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/sip-refer.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/sip-refer" +title: "sip_refer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::sip_refer" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `sip_refer` + +## Signature + +```rust +fn sip_refer(&mut self, to_uri: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 357. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop-background-file.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop-background-file.mdx new file mode 100644 index 0000000000..208fabd699 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop-background-file.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/stop-background-file" +title: "stop_background_file" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::stop_background_file" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `stop_background_file` + +## Signature + +```rust +fn stop_background_file(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 244. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop-record-call.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop-record-call.mdx new file mode 100644 index 0000000000..d88dda5d04 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop-record-call.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/stop-record-call" +title: "stop_record_call" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::stop_record_call" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `stop_record_call` + +## Signature + +```rust +fn stop_record_call(&mut self, control_id: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 268. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop-tap.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop-tap.mdx new file mode 100644 index 0000000000..1654627a95 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop-tap.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/stop-tap" +title: "stop_tap" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::stop_tap" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `stop_tap` + +## Signature + +```rust +fn stop_tap(&mut self, control_id: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 380. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop.mdx new file mode 100644 index 0000000000..5da40f3750 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/stop.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/stop" +title: "stop" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::stop" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `stop` + +## Signature + +```rust +fn stop(&mut self) -> &mut Self +``` + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 149. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/switch-context.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/switch-context.mdx new file mode 100644 index 0000000000..18ae8665f6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/switch-context.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/switch-context" +title: "switch_context" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::switch_context" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `switch_context` + +## Signature + +```rust +fn switch_context( + &mut self, + system_prompt: &str, + user_prompt: &str, + consolidate: bool, + full_reset: bool, + isolated: bool +) -> &mut Self +``` + +## Parameters + + + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 191. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-change-context.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-change-context.mdx new file mode 100644 index 0000000000..b7a646611f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-change-context.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/swml-change-context" +title: "swml_change_context" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::swml_change_context" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `swml_change_context` + +## Signature + +```rust +fn swml_change_context(&mut self, context_name: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 186. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-change-step.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-change-step.mdx new file mode 100644 index 0000000000..468353d109 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-change-step.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/swml-change-step" +title: "swml_change_step" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::swml_change_step" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `swml_change_step` + +## Signature + +```rust +fn swml_change_step(&mut self, step_name: &str) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 181. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-transfer.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-transfer.mdx new file mode 100644 index 0000000000..6cff450d00 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-transfer.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/swml-transfer" +title: "swml_transfer" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::swml_transfer" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `swml_transfer` + +## Signature + +```rust +fn swml_transfer(&mut self, dest: &str, ai_response: &str) -> &mut Self +``` + +## Parameters + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 104. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-user-event.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-user-event.mdx new file mode 100644 index 0000000000..e8c7e689d2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/swml-user-event.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/swml-user-event" +title: "swml_user_event" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::swml_user_event" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `swml_user_event` + +## Signature + +```rust +fn swml_user_event(&mut self, event_data: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 176. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/tap.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/tap.mdx new file mode 100644 index 0000000000..efcdd8503b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/tap.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/tap" +title: "tap" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::tap" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `tap` + +## Signature + +```rust +fn tap( + &mut self, + uri: &str, + control_id: &str, + direction: &str, + codec: &str +) -> &mut Self +``` + +## Parameters + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 362. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/to-json.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/to-json.mdx new file mode 100644 index 0000000000..7a9f862574 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/to-json.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/to-json" +title: "to_json" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::to_json" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `to_json` + +Compact JSON string. + +## Signature + +```rust +fn to_json(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 78. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/to-value.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/to-value.mdx new file mode 100644 index 0000000000..be4763bb58 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/to-value.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/to-value" +title: "to_value" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::to_value" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `to_value` + +Serialise to a JSON value. + +- `response` is always included. +- `action` is only included if at least one action exists. +- `post_process` is only included if `true`. + +## Signature + +```rust +fn to_value(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 62. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/toggle-functions.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/toggle-functions.mdx new file mode 100644 index 0000000000..915c778dd2 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/toggle-functions.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/toggle-functions" +title: "toggle_functions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::toggle_functions" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `toggle_functions` + +## Signature + +```rust +fn toggle_functions(&mut self, toggles: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 299. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/update-global-data.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/update-global-data.mdx new file mode 100644 index 0000000000..b1de542059 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/update-global-data.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/update-global-data" +title: "update_global_data" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::update_global_data" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `update_global_data` + +## Signature + +```rust +fn update_global_data(&mut self, data: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 156. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/update-settings.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/update-settings.mdx new file mode 100644 index 0000000000..684ecbc1c8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/update-settings.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/update-settings" +title: "update_settings" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::update_settings" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `update_settings` + +## Signature + +```rust +fn update_settings(&mut self, settings: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 318. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/wait-for-user.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/wait-for-user.mdx new file mode 100644 index 0000000000..8e9cefd9a6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/wait-for-user.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/wait-for-user" +title: "wait_for_user" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::wait_for_user" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `wait_for_user` + +## Signature + +```rust +fn wait_for_user( + &mut self, + enabled: ?, + timeout: ?, + answer_first: ? +) -> &mut Self +``` + +## Parameters + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 123. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/with-response.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/with-response.mdx new file mode 100644 index 0000000000..39772e6500 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/function-result/with-response.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result/function-result/with-response" +title: "with_response" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swaig::function_result::FunctionResult::with_response" + parent: "signalwire::swaig::function_result::FunctionResult" + module: "swaig.function_result" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `with_response` + +## Signature + +```rust +fn with_response(response: &str) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 25. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/function-result/index.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/index.mdx new file mode 100644 index 0000000000..1b871a167d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/function-result/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/swaig/function-result" +title: "function_result" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::swaig::function_result" + parent: "signalwire::swaig" + module: "swaig" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs" + visibility: "public" +--- +# `function_result` + +## Classes + + + + Result returned from a SWAIG function handler. + + + +## Source + +[`src/swaig/function_result.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/function_result.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/swaig/index.mdx b/fern/products/sdk-reference/rust/signalwire/swaig/index.mdx new file mode 100644 index 0000000000..acf7d9824b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swaig/index.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/rust/signalwire/swaig" +title: "swaig" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::swaig" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/mod.rs" + visibility: "public" +--- +# `swaig` + +## Modules + + + + + +## Source + +[`src/swaig/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swaig/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-raw-verb.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-raw-verb.mdx new file mode 100644 index 0000000000..b158fc01c6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-raw-verb.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/add-raw-verb" +title: "add_raw_verb" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::add_raw_verb" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `add_raw_verb` + +Append a pre-formatted verb value to a section. + +**Panics:** + +Panics if the section does not exist. + +## Signature + +```rust +fn add_raw_verb(&mut self, section: &str, verb_hash: ?) +``` + +## Parameters + + + + + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 68. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-section.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-section.mdx new file mode 100644 index 0000000000..4457482867 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-section.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/add-section" +title: "add_section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::add_section" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `add_section` + +Add a new named section. Returns `true` if created, `false` if it already existed. + +## Signature + +```rust +fn add_section(&mut self, name: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 26. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-verb-to-section.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-verb-to-section.mdx new file mode 100644 index 0000000000..44962a83ea --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-verb-to-section.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/add-verb-to-section" +title: "add_verb_to_section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::add_verb_to_section" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `add_verb_to_section` + +Append a verb to a named section. + +**Panics:** + +Panics if the section does not exist. + +## Signature + +```rust +fn add_verb_to_section(&mut self, section: &str, verb_name: &str, config: ?) +``` + +## Parameters + + + + + + + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 53. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-verb.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-verb.mdx new file mode 100644 index 0000000000..f1e5b71552 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/add-verb.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/add-verb" +title: "add_verb" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::add_verb" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `add_verb` + +Append a verb to the `main` section. + +## Signature + +```rust +fn add_verb(&mut self, verb_name: &str, config: ?) +``` + +## Parameters + + + + + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 44. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/clear-section.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/clear-section.mdx new file mode 100644 index 0000000000..bddca5d13d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/clear-section.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/clear-section" +title: "clear_section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::clear_section" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `clear_section` + +Clear all verbs in a section (keeps the section itself). + +## Signature + +```rust +fn clear_section(&mut self, section: &str) +``` + +## Parameters + + + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 77. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/default.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/default.mdx new file mode 100644 index 0000000000..5b4b6b6970 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/default.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/default" +title: "default" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::default" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `default` + +## Signature + +```rust +fn default() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 118. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/get-verbs.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/get-verbs.mdx new file mode 100644 index 0000000000..02c3f762eb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/get-verbs.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/get-verbs" +title: "get_verbs" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::get_verbs" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `get_verbs` + +Get a clone of the verbs for a section (empty vec if section does not exist). + +## Signature + +```rust +fn get_verbs(&self, section: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 39. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/has-section.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/has-section.mdx new file mode 100644 index 0000000000..c494b4f8c5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/has-section.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/has-section" +title: "has_section" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::has_section" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `has_section` + +## Signature + +```rust +fn has_section(&self, name: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 34. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/index.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/index.mdx new file mode 100644 index 0000000000..2f75095850 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/index.mdx @@ -0,0 +1,86 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document" +title: "Document" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::swml::document::Document" + parent: "signalwire::swml::document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `Document` + +SWML document: version + named sections containing verb arrays. + +## Signature + +```rust +struct Document { /* fields */ } +``` + +## Inheritance + +**Implements:** `Default` + +## Methods + + + + Append a pre-formatted verb value to a section. + + + + Add a new named section. Returns `true` if created, `false` if it already existed. + + + + Append a verb to the `main` section. + + + + Append a verb to a named section. + + + + Clear all verbs in a section (keeps the section itself). + + + + + + Get a clone of the verbs for a section (empty vec if section does not exist). + + + + + + + + Compact JSON string. + + + + Pretty-printed JSON string. + + + + Reset document to initial state (only `main` with no verbs). + + + + Build the document as a `serde_json::Value`. + + + + + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 6. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/new.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/new.mdx new file mode 100644 index 0000000000..6c06f62a75 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/new.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::new" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new() -> Self +``` + +## Returns + +`Self` + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 12. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/render-pretty.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/render-pretty.mdx new file mode 100644 index 0000000000..df4fab9e9b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/render-pretty.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/render-pretty" +title: "render_pretty" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::render_pretty" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `render_pretty` + +Pretty-printed JSON string. + +## Signature + +```rust +fn render_pretty(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 111. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/render.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/render.mdx new file mode 100644 index 0000000000..31863b26cc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/render.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/render" +title: "render" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::render" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `render` + +Compact JSON string. + +## Signature + +```rust +fn render(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 106. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/reset.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/reset.mdx new file mode 100644 index 0000000000..a130efeec6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/reset.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/reset" +title: "reset" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::reset" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `reset` + +Reset document to initial state (only `main` with no verbs). + +## Signature + +```rust +fn reset(&mut self) +``` + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 84. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/to-value.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/to-value.mdx new file mode 100644 index 0000000000..c6f432dabc --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/to-value.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/to-value" +title: "to_value" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::to_value" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `to_value` + +Build the document as a `serde_json::Value`. + +## Signature + +```rust +fn to_value(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 90. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/document/version.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/document/version.mdx new file mode 100644 index 0000000000..2a7d9ac557 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/document/version.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/document/document/version" +title: "version" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::document::Document::version" + parent: "signalwire::swml::document::Document" + module: "swml.document" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `version` + +## Signature + +```rust +fn version(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 21. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/document/index.mdx b/fern/products/sdk-reference/rust/signalwire/swml/document/index.mdx new file mode 100644 index 0000000000..b4293cd144 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/document/index.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/rust/signalwire/swml/document" +title: "document" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::swml::document" + parent: "signalwire::swml" + module: "swml" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs" + visibility: "public" +--- +# `document` + +## Classes + + + + SWML document: version + named sections containing verb arrays. + + + +## Source + +[`src/swml/document.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/document.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/index.mdx b/fern/products/sdk-reference/rust/signalwire/swml/index.mdx new file mode 100644 index 0000000000..377ea13435 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/index.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/rust/signalwire/swml" +title: "swml" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::swml" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/mod.rs" + visibility: "public" +--- +# `swml` + +## Modules + + + + + + + + + +## Source + +[`src/swml/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/mod.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/schema/get-verb-names.mdx b/fern/products/sdk-reference/rust/signalwire/swml/schema/get-verb-names.mdx new file mode 100644 index 0000000000..7c6fa60862 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/schema/get-verb-names.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/swml/schema/get-verb-names" +title: "get_verb_names" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::swml::schema::get_verb_names" + parent: "signalwire::swml::schema" + module: "swml.schema" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs" + visibility: "public" +--- +# `get_verb_names` + +Get sorted list of all verb names. + +## Signature + +```rust +fn get_verb_names() -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swml/schema.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs) + +Line 75. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/schema/get-verb.mdx b/fern/products/sdk-reference/rust/signalwire/swml/schema/get-verb.mdx new file mode 100644 index 0000000000..69dd36c504 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/schema/get-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swml/schema/get-verb" +title: "get_verb" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::swml::schema::get_verb" + parent: "signalwire::swml::schema" + module: "swml.schema" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs" + visibility: "public" +--- +# `get_verb` + +Get verb metadata, or `None` if not found. + +## Signature + +```rust +fn get_verb(name: &str) -> ?<&?> +``` + +## Parameters + + + +## Returns + +`?<&?>` + +## Source + +[`src/swml/schema.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs) + +Line 82. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/schema/index.mdx b/fern/products/sdk-reference/rust/signalwire/swml/schema/index.mdx new file mode 100644 index 0000000000..74fdf37a68 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/schema/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/swml/schema" +title: "schema" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::swml::schema" + parent: "signalwire::swml" + module: "swml" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs" + visibility: "public" +--- +# `schema` + +## Functions + + + + Get verb metadata, or `None` if not found. + + + + Get sorted list of all verb names. + + + + Check whether a verb name is valid. + + + + Number of verbs defined in the schema. + + + +## Classes + + + + Metadata about a single SWML verb extracted from the schema. + + + +## Source + +[`src/swml/schema.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/schema/is-valid-verb.mdx b/fern/products/sdk-reference/rust/signalwire/swml/schema/is-valid-verb.mdx new file mode 100644 index 0000000000..1e29849334 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/schema/is-valid-verb.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swml/schema/is-valid-verb" +title: "is_valid_verb" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::swml::schema::is_valid_verb" + parent: "signalwire::swml::schema" + module: "swml.schema" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs" + visibility: "public" +--- +# `is_valid_verb` + +Check whether a verb name is valid. + +## Signature + +```rust +fn is_valid_verb(name: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/swml/schema.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs) + +Line 70. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-count.mdx b/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-count.mdx new file mode 100644 index 0000000000..1d8271970b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-count.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/swml/schema/verb-count" +title: "verb_count" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::swml::schema::verb_count" + parent: "signalwire::swml::schema" + module: "swml.schema" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs" + visibility: "public" +--- +# `verb_count` + +Number of verbs defined in the schema. + +## Signature + +```rust +fn verb_count() -> usize +``` + +## Returns + +`usize` + +## Source + +[`src/swml/schema.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs) + +Line 87. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-info/clone.mdx b/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-info/clone.mdx new file mode 100644 index 0000000000..1a37a0e042 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-info/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/schema/verb-info/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::schema::VerbInfo::clone" + parent: "signalwire::swml::schema::VerbInfo" + module: "swml.schema" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swml/schema.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs) + +Line 6. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-info/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-info/fmt.mdx new file mode 100644 index 0000000000..d1c3a4bdf0 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-info/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swml/schema/verb-info/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::schema::VerbInfo::fmt" + parent: "signalwire::swml::schema::VerbInfo" + module: "swml.schema" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/swml/schema.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs) + +Line 6. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-info/index.mdx b/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-info/index.mdx new file mode 100644 index 0000000000..344f72a473 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/schema/verb-info/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/rust/signalwire/swml/schema/verb-info" +title: "VerbInfo" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::swml::schema::VerbInfo" + parent: "signalwire::swml::schema" + module: "swml.schema" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs" + visibility: "public" +--- +# `VerbInfo` + +Metadata about a single SWML verb extracted from the schema. + +## Signature + +```rust +struct VerbInfo { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone` + +## Properties + + + + + +## Methods + + + + + + + +## Source + +[`src/swml/schema.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/schema.rs) + +Line 7. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/function-handler.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/function-handler.mdx new file mode 100644 index 0000000000..d634d30d8e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/function-handler.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/rust/signalwire/swml/service/function-handler" +title: "FunctionHandler" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "signalwire::swml::service::FunctionHandler" + parent: "signalwire::swml::service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `FunctionHandler` + +Handler type for SWAIG function callbacks. + +Receives `(args, raw_data)` and returns a `FunctionResult`. Same signature +AgentBase uses, so handlers are interchangeable between the two paths. + +## Signature + +```rust +type FunctionHandler = ? +``` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 74. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/index.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/index.mdx new file mode 100644 index 0000000000..bf6b92ec43 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/swml/service" +title: "service" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::swml::service" + parent: "signalwire::swml" + module: "swml" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `service` + +## Type Aliases + + + + Handler type for SWAIG function callbacks. + + + + Hook function for SWML-request customization. Mirrors Python's `WebMixin.on_swml_request(request_data, callback_path)` — receives the parsed body and optional callback path, and returns a JSON `Value` of modifications to merge (or `None` to use default rendering). + + + +## Classes + + + + SWML service: holds a document, auth credentials, and handles HTTP requests. + + + + Options for constructing a `Service`. + + + + Tool registered on a `Service` for SWAIG dispatch. The `definition` field holds the rendered SWAIG function dict (function/purpose/argument); `handler` is `None` for raw / DataMap-style functions, where dispatch happens server-side rather than in this process. + + + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 1. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/on-swml-request-hook.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/on-swml-request-hook.mdx new file mode 100644 index 0000000000..743acdf5af --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/on-swml-request-hook.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/rust/signalwire/swml/service/on-swml-request-hook" +title: "OnSwmlRequestHook" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "type_alias" + language: "rust" + qualified_name: "signalwire::swml::service::OnSwmlRequestHook" + parent: "signalwire::swml::service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `OnSwmlRequestHook` + +Hook function for SWML-request customization. Mirrors Python's +`WebMixin.on_swml_request(request_data, callback_path)` — receives the +parsed body and optional callback path, and returns a JSON `Value` of +modifications to merge (or `None` to use default rendering). + +Rust has no method overriding via inheritance — the function-field +hook is the idiomatic equivalent of Python's overridable +`on_swml_request`. Set via `Service::set_on_swml_request_hook`. + +## Signature + +```rust +type OnSwmlRequestHook = ? +``` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 43. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service-options/index.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service-options/index.mdx new file mode 100644 index 0000000000..e4b1faefe1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service-options/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service-options" +title: "ServiceOptions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::swml::service::ServiceOptions" + parent: "signalwire::swml::service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `ServiceOptions` + +Options for constructing a `Service`. + +## Signature + +```rust +struct ServiceOptions { /* fields */ } +``` + +## Properties + + + + + + + + + + + + + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 26. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/add-verb.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/add-verb.mdx new file mode 100644 index 0000000000..f2f96744c6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/add-verb.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/add-verb" +title: "add_verb" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::add_verb" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `add_verb` + +Add a verb to a section, validating against the schema. + +**Panics:** + +Panics if the verb name is not in the schema. + +## Signature + +```rust +fn add_verb(&mut self, verb: &str, section: &str, config: ?) +``` + +## Parameters + + + + + + + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 440. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/basic-auth-credentials.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/basic-auth-credentials.mdx new file mode 100644 index 0000000000..47847f30ba --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/basic-auth-credentials.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/basic-auth-credentials" +title: "basic_auth_credentials" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::basic_auth_credentials" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `basic_auth_credentials` + +## Signature + +```rust +fn basic_auth_credentials(&self) -> (&str, &str) +``` + +## Returns + +`(&str, &str)` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 329. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/define-tool.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/define-tool.mdx new file mode 100644 index 0000000000..3bc3e52128 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/define-tool.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/define-tool" +title: "define_tool" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::define_tool" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `define_tool` + +Define a SWAIG function the AI can call. Tool descriptions and +parameter descriptions are LLM-facing prompt engineering — see +PORTING\_GUIDE for guidance. + +Same shape as `AgentBase::define_tool` — a tool registered here is +usable on both sidecar and agent paths because they share storage. + +## Signature + +```rust +fn define_tool( + &mut self, + name: &str, + description: &str, + parameters: ?, + handler: ?, + secure: bool +) -> &mut Self +``` + +## Parameters + + + + + + + + + + + +## Returns + +`&mut Self` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 180. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/document-mut.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/document-mut.mdx new file mode 100644 index 0000000000..1c5f9051af --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/document-mut.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/document-mut" +title: "document_mut" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::document_mut" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `document_mut` + +## Signature + +```rust +fn document_mut(&mut self) -> &mut ? +``` + +## Returns + +`&mut ?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 325. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/document.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/document.mdx new file mode 100644 index 0000000000..b0a7ee06d6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/document.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/document" +title: "document" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::document" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `document` + +## Signature + +```rust +fn document(&self) -> &? +``` + +## Returns + +`&?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 321. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/extract-sip-username.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/extract-sip-username.mdx new file mode 100644 index 0000000000..f8302a19ca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/extract-sip-username.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/extract-sip-username" +title: "extract_sip_username" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::extract_sip_username" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `extract_sip_username` + +Extract SIP username from a request body. +Validates format: only `[a-zA-Z0-9._-]`, max 64 chars. + +## Signature + +```rust +fn extract_sip_username(body: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 558. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-all-functions.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-all-functions.mdx new file mode 100644 index 0000000000..84556968bf --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-all-functions.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/get-all-functions" +title: "get_all_functions" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::get_all_functions" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `get_all_functions` + +Snapshot of all registered SWAIG functions keyed by name. +Python parity: `ToolRegistry.get_all_functions`. + +## Signature + +```rust +fn get_all_functions(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 245. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-basic-auth-credentials-with-source.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-basic-auth-credentials-with-source.mdx new file mode 100644 index 0000000000..49d692f46d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-basic-auth-credentials-with-source.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/get-basic-auth-credentials-with-source" +title: "get_basic_auth_credentials_with_source" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::get_basic_auth_credentials_with_source" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `get_basic_auth_credentials_with_source` + +Get (user, password, source) where source is one of "provided", +"environment", or "generated". Python parity: +`AuthMixin.get_basic_auth_credentials(include_source=True)`. + +## Signature + +```rust +fn get_basic_auth_credentials_with_source(&self) -> (?, ?, ?) +``` + +## Returns + +`(?, ?, ?)` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 342. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..4dab2977ca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-basic-auth-credentials.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/get-basic-auth-credentials" +title: "get_basic_auth_credentials" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::get_basic_auth_credentials" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `get_basic_auth_credentials` + +Get (user, password) — Python-canonical name. +Python parity: `AuthMixin.get_basic_auth_credentials`. + +## Signature + +```rust +fn get_basic_auth_credentials(&self) -> (?, ?) +``` + +## Returns + +`(?, ?)` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 335. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-function.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-function.mdx new file mode 100644 index 0000000000..7a02c92b4e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/get-function" +title: "get_function" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::get_function" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `get_function` + +Get a registered SWAIG function definition by name, or `None` +when absent. Python parity: `ToolRegistry.get_function`. + +## Signature + +```rust +fn get_function(&self, name: &str) -> ?<&?> +``` + +## Parameters + + + +## Returns + +`?<&?>` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 239. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-proxy-url-base.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-proxy-url-base.mdx new file mode 100644 index 0000000000..73973f9402 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/get-proxy-url-base.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/get-proxy-url-base" +title: "get_proxy_url_base" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::get_proxy_url_base" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `get_proxy_url_base` + +Detect or construct the proxy URL base from request headers. + +## Signature + +```rust +fn get_proxy_url_base(&self, headers: &?) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 603. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/handle-request.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/handle-request.mdx new file mode 100644 index 0000000000..925e001a69 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/handle-request.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/handle-request" +title: "handle_request" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::handle_request" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `handle_request` + +Handle an HTTP request. Returns (status\_code, headers, body). + +## Signature + +```rust +fn handle_request( + &self, + method: &str, + path: &str, + headers: &?, + body: &str +) -> (u16, ?, ?) +``` + +## Parameters + + + + + + + + + +## Returns + +`(u16, ?, ?)` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 458. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/has-function.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/has-function.mdx new file mode 100644 index 0000000000..2d19ba8d57 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/has-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/has-function" +title: "has_function" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::has_function" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `has_function` + +Whether a SWAIG function with the given name is registered. +Python parity: `ToolRegistry.has_function`. + +## Signature + +```rust +fn has_function(&self, name: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 233. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/has-tool.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/has-tool.mdx new file mode 100644 index 0000000000..5111f4e495 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/has-tool.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/has-tool" +title: "has_tool" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::has_tool" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `has_tool` + +Whether a tool with the given name is registered. + +## Signature + +```rust +fn has_tool(&self, name: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 276. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/host.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/host.mdx new file mode 100644 index 0000000000..e20f56ce64 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/host.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/host" +title: "host" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::host" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `host` + +## Signature + +```rust +fn host(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 305. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/index.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/index.mdx new file mode 100644 index 0000000000..5dc0e410ba --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/index.mdx @@ -0,0 +1,144 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service" +title: "Service" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::swml::service::Service" + parent: "signalwire::swml::service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `Service` + +SWML service: holds a document, auth credentials, and handles HTTP requests. + +## Signature + +```rust +struct Service { /* fields */ } +``` + +## Methods + + + + Add a verb to a section, validating against the schema. + + + + + + Define a SWAIG function the AI can call. Tool descriptions and parameter descriptions are LLM-facing prompt engineering — see PORTING\_GUIDE for guidance. + + + + + + + + Extract SIP username from a request body. Validates format: only `[a-zA-Z0-9._-]`, max 64 chars. + + + + Snapshot of all registered SWAIG functions keyed by name. Python parity: `ToolRegistry.get_all_functions`. + + + + Get (user, password) — Python-canonical name. Python parity: `AuthMixin.get_basic_auth_credentials`. + + + + Get (user, password, source) where source is one of "provided", "environment", or "generated". Python parity: `AuthMixin.get_basic_auth_credentials(include_source=True)`. + + + + Get a registered SWAIG function definition by name, or `None` when absent. Python parity: `ToolRegistry.get_function`. + + + + Detect or construct the proxy URL base from request headers. + + + + Handle an HTTP request. Returns (status\_code, headers, body). + + + + Whether a SWAIG function with the given name is registered. Python parity: `ToolRegistry.has_function`. + + + + Whether a tool with the given name is registered. + + + + + + Registered tool names in insertion order. + + + + + + + + Dispatch a function call to the registered handler. Returns `None` for unknown functions or registered functions with no local handler (e.g. DataMap tools that execute server-side). + + + + Customization hook called when SWML is requested. Default delegates to \[`Service::on_swml_request`] and returns its result. Subclasses (or external callers) typically configure `on_swml_request` via \[`Service::set_on_swml_request_hook`] rather than overriding this method. + + + + Customization point for modifying SWML based on request data. If a hook has been registered via \[`Service::set_on_swml_request_hook`] the hook is invoked; otherwise this returns `None` (no modification). + + + + + + Register a raw SWAIG function definition (e.g. DataMap tools that have no local handler). + + + + Remove a registered SWAIG function. Returns `true` when the function was found and removed; `false` when it wasn't registered. Python parity: `ToolRegistry.remove_function`. + + + + + + + + + + + + SchemaUtils helper bound to this Service. Mirrors Python's `self.schema_utils` instance attribute on `SWMLService`. Returns a freshly-built helper each call — the underlying schema is `LazyLock`-cached, so this is cheap. + + + + Register a function that customizes the SWML response on a per-request basis. The hook receives the parsed body and the callback path; returning `Some(value)` applies modifications, `None` falls through to the default rendering. + + + + Add a `sleep` verb (integer milliseconds) to a section. + + + + Look up a registered tool's full SWAIG definition (the JSON shape returned to the SignalWire platform). Used by audit harnesses that need to inspect the DataMap webhook URL of a registered tool without invoking it. + + + + Validate provided basic-auth credentials against the configured ones. Python parity: `AuthMixin.validate_basic_auth(username, password)`. + + + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 48. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/list-tool-names.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/list-tool-names.mdx new file mode 100644 index 0000000000..f7847d4f6c --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/list-tool-names.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/list-tool-names" +title: "list_tool_names" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::list_tool_names" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `list_tool_names` + +Registered tool names in insertion order. + +## Signature + +```rust +fn list_tool_names(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 281. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/name.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/name.mdx new file mode 100644 index 0000000000..68e87d1b83 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/name.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/name" +title: "name" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::name" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `name` + +## Signature + +```rust +fn name(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 297. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/new.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/new.mdx new file mode 100644 index 0000000000..957f5bfea8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/new.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::new" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `new` + +## Signature + +```rust +fn new(options: ?) -> Self +``` + +## Parameters + + + +## Returns + +`Self` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 92. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/on-function-call.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/on-function-call.mdx new file mode 100644 index 0000000000..ce10641b80 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/on-function-call.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/on-function-call" +title: "on_function_call" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::on_function_call" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `on_function_call` + +Dispatch a function call to the registered handler. Returns +`None` for unknown functions or registered functions with no +local handler (e.g. DataMap tools that execute server-side). + +## Signature + +```rust +fn on_function_call( + &self, + name: &str, + args: &?, + raw_data: &? +) -> ? +``` + +## Parameters + + + + + + + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 264. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/on-request.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/on-request.mdx new file mode 100644 index 0000000000..532acbd9f5 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/on-request.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/on-request" +title: "on_request" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::on_request" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `on_request` + +Customization hook called when SWML is requested. Default +delegates to \[`Service::on_swml_request`] and returns its result. +Subclasses (or external callers) typically configure +`on_swml_request` via \[`Service::set_on_swml_request_hook`] +rather than overriding this method. + +Returning `None` uses the default rendered SWML; returning a +non-`None` value applies modifications to the rendered document. + +Python parity: `WebMixin.on_request(request_data, callback_path)`. + +## Signature + +```rust +fn on_request(&self, request_data: ?<&?>, callback_path: ?<&str>) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 404. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/on-swml-request.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/on-swml-request.mdx new file mode 100644 index 0000000000..9cde003f13 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/on-swml-request.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/on-swml-request" +title: "on_swml_request" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::on_swml_request" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `on_swml_request` + +Customization point for modifying SWML based on request data. +If a hook has been registered via +\[`Service::set_on_swml_request_hook`] the hook is invoked; +otherwise this returns `None` (no modification). + +Python parity: `WebMixin.on_swml_request(request_data, callback_path)`. +The Python third `request` argument is FastAPI-specific and +intentionally not mirrored. + +## Signature + +```rust +fn on_swml_request(&self, request_data: ?<&?>, callback_path: ?<&str>) -> ? +``` + +## Parameters + + + + + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 420. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/port.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/port.mdx new file mode 100644 index 0000000000..4c5a5d49b7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/port.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/port" +title: "port" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::port" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `port` + +## Signature + +```rust +fn port(&self) -> u16 +``` + +## Returns + +`u16` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 309. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/register-swaig-function.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/register-swaig-function.mdx new file mode 100644 index 0000000000..a43f82e282 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/register-swaig-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/register-swaig-function" +title: "register_swaig_function" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::register_swaig_function" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `register_swaig_function` + +Register a raw SWAIG function definition (e.g. DataMap tools that +have no local handler). + +## Signature + +```rust +fn register_swaig_function(&mut self, func_def: ?) -> &mut Self +``` + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 212. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/remove-function.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/remove-function.mdx new file mode 100644 index 0000000000..9dcd7f0986 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/remove-function.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/remove-function" +title: "remove_function" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::remove_function" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `remove_function` + +Remove a registered SWAIG function. Returns `true` when the +function was found and removed; `false` when it wasn't +registered. Python parity: `ToolRegistry.remove_function`. + +## Signature + +```rust +fn remove_function(&mut self, name: &str) -> bool +``` + +## Parameters + + + +## Returns + +`bool` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 252. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/render-pretty.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/render-pretty.mdx new file mode 100644 index 0000000000..91b056e577 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/render-pretty.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/render-pretty" +title: "render_pretty" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::render_pretty" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `render_pretty` + +## Signature + +```rust +fn render_pretty(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 370. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/render.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/render.mdx new file mode 100644 index 0000000000..924e59db5a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/render.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/render" +title: "render" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::render" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `render` + +## Signature + +```rust +fn render(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 366. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/route.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/route.mdx new file mode 100644 index 0000000000..0744055ca7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/route.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/route" +title: "route" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::route" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `route` + +## Signature + +```rust +fn route(&self) -> &str +``` + +## Returns + +`&str` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 301. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/run.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/run.mdx new file mode 100644 index 0000000000..d2c09908e1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/run.mdx @@ -0,0 +1,28 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/run" +title: "run" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::run" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `run` + +## Signature + +```rust +fn run(&self) +``` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 863. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/schema-utils.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/schema-utils.mdx new file mode 100644 index 0000000000..c692d7cebe --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/schema-utils.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/schema-utils" +title: "schema_utils" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::schema_utils" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `schema_utils` + +SchemaUtils helper bound to this Service. Mirrors Python's +`self.schema_utils` instance attribute on `SWMLService`. +Returns a freshly-built helper each call — the underlying +schema is `LazyLock`-cached, so this is cheap. + +## Signature + +```rust +fn schema_utils(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 317. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/set-on-swml-request-hook.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/set-on-swml-request-hook.mdx new file mode 100644 index 0000000000..07d955721d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/set-on-swml-request-hook.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/set-on-swml-request-hook" +title: "set_on_swml_request_hook" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::set_on_swml_request_hook" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `set_on_swml_request_hook` + +Register a function that customizes the SWML response on a +per-request basis. The hook receives the parsed body and the +callback path; returning `Some(value)` applies modifications, +`None` falls through to the default rendering. + +Rust has no method overriding via inheritance — this hook is +the idiomatic Rust equivalent of Python's overridable +`on_swml_request`. + +## Signature + +```rust +fn set_on_swml_request_hook( + &mut self, + hook: F +) -> &mut Self where F: ?(?<&?>, ?<&str>) -> ? + ? + ? + 'static +``` + +## Type Parameters + + + +## Parameters + + + +## Returns + +`&mut Self` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 386. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/sleep.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/sleep.mdx new file mode 100644 index 0000000000..b964c99b0d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/sleep.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/sleep" +title: "sleep" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::sleep" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `sleep` + +Add a `sleep` verb (integer milliseconds) to a section. + +## Signature + +```rust +fn sleep(&mut self, millis: i64, section: &str) +``` + +## Parameters + + + + + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 448. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/tool-definition.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/tool-definition.mdx new file mode 100644 index 0000000000..7ac9633b8f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/tool-definition.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/tool-definition" +title: "tool_definition" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::tool_definition" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `tool_definition` + +Look up a registered tool's full SWAIG definition (the JSON +shape returned to the SignalWire platform). Used by audit +harnesses that need to inspect the DataMap webhook URL of a +registered tool without invoking it. + +## Signature + +```rust +fn tool_definition(&self, name: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 289. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/service/validate-basic-auth.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/service/validate-basic-auth.mdx new file mode 100644 index 0000000000..e75d5c9081 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/service/validate-basic-auth.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/swml/service/service/validate-basic-auth" +title: "validate_basic_auth" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::Service::validate_basic_auth" + parent: "signalwire::swml::service::Service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `validate_basic_auth` + +Validate provided basic-auth credentials against the configured ones. +Python parity: `AuthMixin.validate_basic_auth(username, password)`. + +## Signature + +```rust +fn validate_basic_auth(&self, username: &str, password: &str) -> bool +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 361. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/tool-def/clone.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/tool-def/clone.mdx new file mode 100644 index 0000000000..550df25982 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/tool-def/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/swml/service/tool-def/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::swml::service::ToolDef::clone" + parent: "signalwire::swml::service::ToolDef" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 84. diff --git a/fern/products/sdk-reference/rust/signalwire/swml/service/tool-def/index.mdx b/fern/products/sdk-reference/rust/signalwire/swml/service/tool-def/index.mdx new file mode 100644 index 0000000000..8f1841dc8b --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/swml/service/tool-def/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/rust/signalwire/swml/service/tool-def" +title: "ToolDef" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::swml::service::ToolDef" + parent: "signalwire::swml::service" + module: "swml.service" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs" + visibility: "public" +--- +# `ToolDef` + +Tool registered on a `Service` for SWAIG dispatch. The `definition` +field holds the rendered SWAIG function dict (function/purpose/argument); +`handler` is `None` for raw / DataMap-style functions, where dispatch +happens server-side rather than in this process. + +## Signature + +```rust +struct ToolDef { /* fields */ } +``` + +## Inheritance + +**Implements:** `Clone` + +## Properties + + + + + + + +## Methods + + + + + +## Source + +[`src/swml/service.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/swml/service.rs) + +Line 85. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/index.mdx b/fern/products/sdk-reference/rust/signalwire/utils/index.mdx new file mode 100644 index 0000000000..f1e1cfd12d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/utils" +title: "utils" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::utils" + parent: "signalwire" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/mod.rs" + visibility: "public" +--- +# `utils` + +## Functions + + + + Cross-language SDK contract: `signalwire.utils.is_serverless_mode` returns `true` whenever the SDK is running inside any short-lived / event-driven invocation environment (anything other than `"server"`). + + + +## Modules + + + + + + SSRF-prevention guard for user-supplied URLs. + + + +## Source + +[`src/utils/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/mod.rs) + +Line 4. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/is-serverless-mode.mdx b/fern/products/sdk-reference/rust/signalwire/utils/is-serverless-mode.mdx new file mode 100644 index 0000000000..ef618fa83e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/is-serverless-mode.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/utils/is-serverless-mode" +title: "is_serverless_mode" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::utils::is_serverless_mode" + parent: "signalwire::utils" + module: "utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/mod.rs" + visibility: "public" +--- +# `is_serverless_mode` + +Cross-language SDK contract: `signalwire.utils.is_serverless_mode` +returns `true` whenever the SDK is running inside any short-lived / +event-driven invocation environment (anything other than `"server"`). + +Mirrors `signalwire.utils.is_serverless_mode` in the Python +reference. The actual detection ladder lives in +`core::logging_config::get_execution_mode`; this helper just maps +"anything except 'server'" -> `true`. + +## Signature + +```rust +fn is_serverless_mode() -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/utils/mod.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/mod.rs) + +Line 20. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/index.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/index.mdx new file mode 100644 index 0000000000..fcc5739dc4 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils" +title: "schema_utils" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::utils::schema_utils" + parent: "signalwire::utils" + module: "utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `schema_utils` + +## Classes + + + + SchemaUtils — Rust port of `signalwire.utils.schema_utils.SchemaUtils`. + + + + SchemaValidationError — Rust port of `signalwire.utils.schema_utils.SchemaValidationError`. + + + + Verb metadata extracted from the schema. + + + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 17. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/full-validation-available.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/full-validation-available.mdx new file mode 100644 index 0000000000..c724f39878 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/full-validation-available.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils/full-validation-available" +title: "full_validation_available" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils::full_validation_available" + parent: "signalwire::utils::schema_utils::SchemaUtils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `full_validation_available` + +Whether full JSON Schema validation is wired up. Mirrors +Python's `full_validation_available` property. + +## Signature + +```rust +fn full_validation_available(&self) -> bool +``` + +## Returns + +`bool` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 93. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/generate-method-body.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/generate-method-body.mdx new file mode 100644 index 0000000000..eec766233f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/generate-method-body.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils/generate-method-body" +title: "generate_method_body" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils::generate_method_body" + parent: "signalwire::utils::schema_utils::SchemaUtils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `generate_method_body` + +Generate a Python-style method body string for a verb. Mirrors +Python's `generate_method_body(verb_name)`. + +## Signature + +```rust +fn generate_method_body(&self, verb_name: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 239. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/generate-method-signature.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/generate-method-signature.mdx new file mode 100644 index 0000000000..64a266daca --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/generate-method-signature.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils/generate-method-signature" +title: "generate_method_signature" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils::generate_method_signature" + parent: "signalwire::utils::schema_utils::SchemaUtils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `generate_method_signature` + +Generate a Python-style method signature string for a verb. +Mirrors Python's `generate_method_signature(verb_name)`. + +## Signature + +```rust +fn generate_method_signature(&self, verb_name: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 202. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-all-verb-names.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-all-verb-names.mdx new file mode 100644 index 0000000000..cdc3104f8f --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-all-verb-names.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils/get-all-verb-names" +title: "get_all_verb_names" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils::get_all_verb_names" + parent: "signalwire::utils::schema_utils::SchemaUtils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `get_all_verb_names` + +Sorted list of all known verb names. Mirrors Python's +`get_all_verb_names()`. + +## Signature + +```rust +fn get_all_verb_names(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 110. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-parameters.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-parameters.mdx new file mode 100644 index 0000000000..5db78cb0d7 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-parameters.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-parameters" +title: "get_verb_parameters" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils::get_verb_parameters" + parent: "signalwire::utils::schema_utils::SchemaUtils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `get_verb_parameters` + +Parameter-definition block used by code-gen tooling. Mirrors +Python's `get_verb_parameters(verb_name)`. + +## Signature + +```rust +fn get_verb_parameters(&self, verb_name: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 145. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-properties.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-properties.mdx new file mode 100644 index 0000000000..24f0b63250 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-properties.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-properties" +title: "get_verb_properties" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils::get_verb_properties" + parent: "signalwire::utils::schema_utils::SchemaUtils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `get_verb_properties` + +The `properties[verb_name]` block for a verb, or empty when +unknown. Mirrors Python's `get_verb_properties(verb_name)`. + +## Signature + +```rust +fn get_verb_properties(&self, verb_name: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 116. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-required-properties.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-required-properties.mdx new file mode 100644 index 0000000000..e006872ef8 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-required-properties.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils/get-verb-required-properties" +title: "get_verb_required_properties" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils::get_verb_required_properties" + parent: "signalwire::utils::schema_utils::SchemaUtils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `get_verb_required_properties` + +The `required` list for a verb, or empty when unknown / not +specified. Mirrors Python's +`get_verb_required_properties(verb_name)`. + +## Signature + +```rust +fn get_verb_required_properties(&self, verb_name: &str) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 132. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/index.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/index.mdx new file mode 100644 index 0000000000..bca3e771af --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils" +title: "SchemaUtils" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils" + parent: "signalwire::utils::schema_utils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `SchemaUtils` + +SchemaUtils — Rust port of +`signalwire.utils.schema_utils.SchemaUtils`. + +## Signature + +```rust +struct SchemaUtils { /* fields */ } +``` + +## Methods + + + + Whether full JSON Schema validation is wired up. Mirrors Python's `full_validation_available` property. + + + + Generate a Python-style method body string for a verb. Mirrors Python's `generate_method_body(verb_name)`. + + + + Generate a Python-style method signature string for a verb. Mirrors Python's `generate_method_signature(verb_name)`. + + + + Sorted list of all known verb names. Mirrors Python's `get_all_verb_names()`. + + + + Parameter-definition block used by code-gen tooling. Mirrors Python's `get_verb_parameters(verb_name)`. + + + + The `properties[verb_name]` block for a verb, or empty when unknown. Mirrors Python's `get_verb_properties(verb_name)`. + + + + The `required` list for a verb, or empty when unknown / not specified. Mirrors Python's `get_verb_required_properties(verb_name)`. + + + + Read and parse the JSON Schema. Mirrors Python's `load_schema()`. + + + + Construct a SchemaUtils. Mirrors Python's `SchemaUtils(schema_path=None, schema_validation=True)`. + + + + Validate a complete SWML document. Mirrors Python's `validate_document(document)`. Returns `(false, ["Schema validator not initialized"])` when no full validator is wired in. + + + + Validate a verb config against the schema. Mirrors Python's `validate_verb(verb_name, verb_config)`. + + + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 63. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/load-schema.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/load-schema.mdx new file mode 100644 index 0000000000..6cd29e502a --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/load-schema.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils/load-schema" +title: "load_schema" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils::load_schema" + parent: "signalwire::utils::schema_utils::SchemaUtils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `load_schema` + +Read and parse the JSON Schema. Mirrors Python's +`load_schema()`. + +## Signature + +```rust +fn load_schema(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 99. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/new.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/new.mdx new file mode 100644 index 0000000000..496f03e762 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/new.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils::new" + parent: "signalwire::utils::schema_utils::SchemaUtils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `new` + +Construct a SchemaUtils. Mirrors Python's +`SchemaUtils(schema_path=None, schema_validation=True)`. + +## Signature + +```rust +fn new(schema_path: ?, schema_validation: bool) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 74. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/validate-document.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/validate-document.mdx new file mode 100644 index 0000000000..3db0d9c619 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/validate-document.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils/validate-document" +title: "validate_document" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils::validate_document" + parent: "signalwire::utils::schema_utils::SchemaUtils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `validate_document` + +Validate a complete SWML document. Mirrors Python's +`validate_document(document)`. Returns +`(false, ["Schema validator not initialized"])` when no full +validator is wired in. + +## Signature + +```rust +fn validate_document(&self, _document: &?) -> (bool, ?) +``` + +## Parameters + + + +## Returns + +`(bool, ?)` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 192. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/validate-verb.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/validate-verb.mdx new file mode 100644 index 0000000000..d40a21c72e --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-utils/validate-verb.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-utils/validate-verb" +title: "validate_verb" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaUtils::validate_verb" + parent: "signalwire::utils::schema_utils::SchemaUtils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `validate_verb` + +Validate a verb config against the schema. Mirrors Python's +`validate_verb(verb_name, verb_config)`. + +## Signature + +```rust +fn validate_verb(&self, verb_name: &str, verb_config: &?) -> (bool, ?) +``` + +## Parameters + + + + + +## Returns + +`(bool, ?)` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 155. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/clone.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/clone.mdx new file mode 100644 index 0000000000..9a88ddcb6d --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-validation-error/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaValidationError::clone" + parent: "signalwire::utils::schema_utils::SchemaValidationError" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 26. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/fmt.mdx new file mode 100644 index 0000000000..bb2fafd887 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-validation-error/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaValidationError::fmt" + parent: "signalwire::utils::schema_utils::SchemaValidationError" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 26. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/fmt__2.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/fmt__2.mdx new file mode 100644 index 0000000000..7d333ce1cb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/fmt__2.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-validation-error/fmt__2" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaValidationError::fmt" + parent: "signalwire::utils::schema_utils::SchemaValidationError" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 41. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/index.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/index.mdx new file mode 100644 index 0000000000..71bcf7c8e1 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-validation-error" +title: "SchemaValidationError" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaValidationError" + parent: "signalwire::utils::schema_utils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `SchemaValidationError` + +SchemaValidationError — Rust port of +`signalwire.utils.schema_utils.SchemaValidationError`. + +## Signature + +```rust +struct SchemaValidationError { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone`, `Display`, [Error](/reference/rust/signalwire/security/webhook-layer/webhook-validate/error) + +## Properties + + + + + +## Methods + + + + + + + + + + Construct a SchemaValidationError. Mirrors Python's `SchemaValidationError(verb_name, errors)`. + + + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 27. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/new.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/new.mdx new file mode 100644 index 0000000000..15424e9257 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/schema-validation-error/new.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/schema-validation-error/new" +title: "new" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::SchemaValidationError::new" + parent: "signalwire::utils::schema_utils::SchemaValidationError" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `new` + +Construct a SchemaValidationError. Mirrors Python's +`SchemaValidationError(verb_name, errors)`. + +## Signature + +```rust +fn new(verb_name: ?, errors: ?) -> Self +``` + +## Parameters + + + + + +## Returns + +`Self` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 35. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/verb-definition/clone.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/verb-definition/clone.mdx new file mode 100644 index 0000000000..e979d779b6 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/verb-definition/clone.mdx @@ -0,0 +1,32 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/verb-definition/clone" +title: "clone" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::VerbDefinition::clone" + parent: "signalwire::utils::schema_utils::VerbDefinition" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `clone` + +## Signature + +```rust +fn clone(&self) -> ? +``` + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 54. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/verb-definition/fmt.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/verb-definition/fmt.mdx new file mode 100644 index 0000000000..738536ab26 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/verb-definition/fmt.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/verb-definition/fmt" +title: "fmt" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "method" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::VerbDefinition::fmt" + parent: "signalwire::utils::schema_utils::VerbDefinition" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `fmt` + +## Signature + +```rust +fn fmt(&self, f: &mut ?<'_>) -> ? +``` + +## Parameters + + + +## Returns + +`?` + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 54. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/verb-definition/index.mdx b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/verb-definition/index.mdx new file mode 100644 index 0000000000..751e0e1faa --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/schema-utils/verb-definition/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/rust/signalwire/utils/schema-utils/verb-definition" +title: "VerbDefinition" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "class" + language: "rust" + qualified_name: "signalwire::utils::schema_utils::VerbDefinition" + parent: "signalwire::utils::schema_utils" + module: "utils.schema_utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs" + visibility: "public" +--- +# `VerbDefinition` + +Verb metadata extracted from the schema. + +## Signature + +```rust +struct VerbDefinition { /* fields */ } +``` + +## Inheritance + +**Implements:** `Debug`, `Clone` + +## Properties + + + + + + + +## Methods + + + + + + + +## Source + +[`src/utils/schema_utils.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/schema_utils.rs) + +Line 55. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/url-validator/index.mdx b/fern/products/sdk-reference/rust/signalwire/utils/url-validator/index.mdx new file mode 100644 index 0000000000..50137be3bb --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/url-validator/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/rust/signalwire/utils/url-validator" +title: "url_validator" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "module" + language: "rust" + qualified_name: "signalwire::utils::url_validator" + parent: "signalwire::utils" + module: "utils" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/url_validator.rs" + visibility: "public" +--- +# `url_validator` + +SSRF-prevention guard for user-supplied URLs. + +Mirrors Python's `signalwire.utils.url_validator.validate_url`: +rejects non-http(s) schemes, missing hostnames, and any URL whose +hostname resolves to a private / loopback / link-local / cloud- +metadata IP. When `allow_private` is true, OR the +`SWML_ALLOW_PRIVATE_URLS` env var is set to `"1"`, `"true"`, or +`"yes"` (case-insensitive), the IP-blocklist check is skipped. + +## Constants + + + Cross-port SSRF block list. Order matches the Python reference for ease of cross-language review. + + +## Functions + + + + Install a custom resolver (for tests). Pass `None` to clear. + + + + Validate that a URL is safe to fetch. + + + +## Source + +[`src/utils/url_validator.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/url_validator.rs) + +Line 6. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/url-validator/set-resolver.mdx b/fern/products/sdk-reference/rust/signalwire/utils/url-validator/set-resolver.mdx new file mode 100644 index 0000000000..e654dedd88 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/url-validator/set-resolver.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/rust/signalwire/utils/url-validator/set-resolver" +title: "_set_resolver" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::utils::url_validator::_set_resolver" + parent: "signalwire::utils::url_validator" + module: "utils.url_validator" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/url_validator.rs" + visibility: "public" +--- +# `_set_resolver` + +Install a custom resolver (for tests). Pass `None` to clear. + +## Signature + +```rust +fn _set_resolver(resolver: ?>) +``` + +## Parameters + + + +## Source + +[`src/utils/url_validator.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/url_validator.rs) + +Line 44. diff --git a/fern/products/sdk-reference/rust/signalwire/utils/url-validator/validate-url.mdx b/fern/products/sdk-reference/rust/signalwire/utils/url-validator/validate-url.mdx new file mode 100644 index 0000000000..fc1fee0442 --- /dev/null +++ b/fern/products/sdk-reference/rust/signalwire/utils/url-validator/validate-url.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/rust/signalwire/utils/url-validator/validate-url" +title: "validate_url" +sdk_label: "Rust SDK" +icon: "rust" +lustri: + auto_generated: true + kind: "function" + language: "rust" + qualified_name: "signalwire::utils::url_validator::validate_url" + parent: "signalwire::utils::url_validator" + module: "utils.url_validator" + source_url: "https://github.com/signalwire/signalwire-rust/blob/main/src/utils/url_validator.rs" + visibility: "public" +--- +# `validate_url` + +Validate that a URL is safe to fetch. + +Mirrors Python's `validate_url(url, allow_private=False) -> bool`. + +## Signature + +```rust +fn validate_url(url: &str, allow_private: bool) -> bool +``` + +## Parameters + + + + + +## Returns + +`bool` + +## Source + +[`src/utils/url_validator.rs`](https://github.com/signalwire/signalwire-rust/blob/main/src/utils/url_validator.rs) + +Line 116. diff --git a/fern/products/sdk-reference/sdk-reference.yml b/fern/products/sdk-reference/sdk-reference.yml new file mode 100644 index 0000000000..51880d83fe --- /dev/null +++ b/fern/products/sdk-reference/sdk-reference.yml @@ -0,0 +1,80 @@ +tabs: + reference: + display-name: Reference + icon: fa-regular fa-code + +navigation: + - tab: reference + variants: + - title: TypeScript + icon: brands fa-js + default: true + layout: + - folder: ./typescript + title: TypeScript SDK + collapsed: false + + - title: Python + icon: brands fa-python + layout: + - folder: ./python + title: Python SDK + collapsed: false + + - title: Ruby + icon: fa-regular fa-gem + layout: + - folder: ./ruby + title: Ruby SDK + collapsed: false + + - title: Go + icon: fa-regular fa-code + layout: + - folder: ./go + title: Go SDK + collapsed: false + + - title: Java + icon: brands fa-java + layout: + - folder: ./java + title: Java SDK + collapsed: false + + - title: .NET + slug: dotnet + icon: brands fa-microsoft + layout: + - folder: ./dotnet + title: .NET SDK + collapsed: false + + - title: PHP + icon: brands fa-php + layout: + - folder: ./php + title: PHP SDK + collapsed: false + + - title: Rust + icon: brands fa-rust + layout: + - folder: ./rust + title: Rust SDK + collapsed: false + + - title: C++ + slug: cpp + icon: fa-regular fa-code + layout: + - folder: ./cpp + title: C++ SDK + collapsed: false + + - title: Perl + icon: fa-regular fa-code + layout: + - folder: ./perl + title: Perl SDK + collapsed: false diff --git a/fern/products/sdk-reference/typescript/_meta.json b/fern/products/sdk-reference/typescript/_meta.json new file mode 100644 index 0000000000..16207ca681 --- /dev/null +++ b/fern/products/sdk-reference/typescript/_meta.json @@ -0,0 +1,10 @@ +{ + "language": "typescript", + "sdk_name": "@signalwire/sdk", + "version": null, + "source_repo": "https://github.com/signalwire/signalwire-typescript", + "format": "mdx", + "platform": "fern", + "base_slug": "/reference/typescript", + "item_count": 3872 +} \ No newline at end of file diff --git a/fern/products/sdk-reference/typescript/add-skill-directory.mdx b/fern/products/sdk-reference/typescript/add-skill-directory.mdx new file mode 100644 index 0000000000..3500a097f0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/add-skill-directory.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/add-skill-directory" +title: "addSkillDirectory" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "addSkillDirectory" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts" +--- +# `addSkillDirectory` + +Register a directory to search for additional skill modules. + +Equivalent to Python's `add_skill_directory(path)`. Proxies to +`SkillRegistry.addSearchPath()`. Callers who want on-disk dynamic +discovery can pair this with `SkillRegistry.discoverFromDirectory()`. + +## Signature + +```typescript +addSkillDirectory(path: string): void +``` + +## Parameters + + + Absolute path to a directory containing skill files. + + +## Returns + +`void` + +## Source + +[`src/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts) + +Line 311. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-answer-verb.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-answer-verb.mdx new file mode 100644 index 0000000000..08fa41d151 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-answer-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-answer-verb" +title: "addAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addAnswerVerb" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addAnswerVerb` + +Configure the answer verb (phase 2) with optional settings. + +## Signature + +```typescript +addAnswerVerb(config?: Record): this +``` + +## Parameters + + + Optional answer verb configuration. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1493. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-function-include.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-function-include.mdx new file mode 100644 index 0000000000..e5712ec436 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-function-include.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-function-include" +title: "addFunctionInclude" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addFunctionInclude" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addFunctionInclude` + +Add a remote SWAIG function include reference. + +## Signature + +```typescript +addFunctionInclude( + url: string, + functions: string[], + metaData?: Record +): this +``` + +## Parameters + + + URL of the remote SWAIG endpoint. + + + + Function names available at that endpoint. + + + + Optional metadata to attach to the include. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 965. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-hint.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-hint.mdx new file mode 100644 index 0000000000..3fbad41a42 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-hint.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-hint" +title: "addHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addHint" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHint` + +Add a single speech-recognition hint. + +## Signature + +```typescript +addHint(hint: string): this +``` + +## Parameters + + + Word or phrase to boost in speech recognition. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 652. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-hints.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-hints.mdx new file mode 100644 index 0000000000..f9424198a9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-hints.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-hints" +title: "addHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addHints" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHints` + +Add multiple speech-recognition hints at once. + +## Signature + +```typescript +addHints(hints: string[]): this +``` + +## Parameters + + + Array of words or phrases to boost. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 662. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-internal-filler.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-internal-filler.mdx new file mode 100644 index 0000000000..e84a545fcf --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-internal-filler.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-internal-filler" +title: "addInternalFiller" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addInternalFiller" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addInternalFiller` + +Add internal filler phrases for a single internal function and language. + +See [setInternalFillers](/reference/typescript/agent-base/agent-base/set-internal-fillers) for the complete list of supported +functionName values and an explanation of what fillers do. + +## Signature + +```typescript +addInternalFiller( + functionName: string, + languageCode: string, + fillers: string[] +): this +``` + +## Parameters + + + One of the supported internal function names (see SUPPORTED\_INTERNAL\_FILLER\_NAMES). Names outside the supported set log a warning and are ignored by the runtime. + + + + BCP-47 language code for the fillers (e.g. 'en-US'). + + + + Array of filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 942. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-language.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-language.mdx new file mode 100644 index 0000000000..f7bbbdc82b --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-language.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-language" +title: "addLanguage" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addLanguage" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addLanguage` + +Add a supported language to the AI configuration. + +## Signature + +```typescript +addLanguage(config: LanguageConfig): this +``` + +## Parameters + + + Language configuration including name, code, voice, and optional fillers. `params` may be set to attach engine-specific tuning (voice stability, similarity boost, model knobs, etc.); only emitted into SWML when non-empty so existing entries stay byte-identical when no params are passed (Python ai\_config\_mixin.py `add_language`). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 693. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-mcp-server.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-mcp-server.mdx new file mode 100644 index 0000000000..832eadc569 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-mcp-server.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-mcp-server" +title: "addMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addMcpServer" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addMcpServer` + +Add an external MCP server for tool discovery and invocation. +Tools are discovered via MCP protocol at session start and added to the AI's tool list. + +## Signature + +```typescript +addMcpServer(url: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + MCP server HTTP endpoint URL + + + + Optional configuration: headers, resources, resourceVars + + + + + + + + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1145. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-pattern-hint.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-pattern-hint.mdx new file mode 100644 index 0000000000..375a5c91cc --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-pattern-hint.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-pattern-hint" +title: "addPatternHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addPatternHint" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPatternHint` + +Add a pattern-based speech-recognition hint with find-and-replace behavior. + +## Signature + +```typescript +addPatternHint(opts: { ...4 fields }): this +``` + +## Parameters + + + Pattern hint configuration with a descriptive hint label, regex pattern, replacement string, and optional case-insensitive flag. + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 673. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-post-ai-verb.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-post-ai-verb.mdx new file mode 100644 index 0000000000..c025fadc60 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-post-ai-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-post-ai-verb" +title: "addPostAiVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addPostAiVerb" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAiVerb` + +Add a SWML verb to execute after the AI verb (phase 5). + +## Signature + +```typescript +addPostAiVerb(verbName: string, config: Record): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1515. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-post-answer-verb.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-post-answer-verb.mdx new file mode 100644 index 0000000000..b13ac7e0a8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-post-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-post-answer-verb" +title: "addPostAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addPostAnswerVerb" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAnswerVerb` + +Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + +## Signature + +```typescript +addPostAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1504. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-pre-answer-verb.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..4bd66ba202 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-pre-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-pre-answer-verb" +title: "addPreAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addPreAnswerVerb" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPreAnswerVerb` + +Add a SWML verb to execute before the answer phase (phase 1). + +## Signature + +```typescript +addPreAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb (e.g. "play", "record"). + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1483. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-pronunciation.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-pronunciation.mdx new file mode 100644 index 0000000000..330d28b1ce --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-pronunciation.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-pronunciation" +title: "addPronunciation" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addPronunciation" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPronunciation` + +Add a pronunciation override rule for the TTS engine. + +## Signature + +```typescript +addPronunciation(rule: PronunciationRule): this +``` + +## Parameters + + + Pronunciation rule specifying the text to replace and its substitute. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 773. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-section.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-section.mdx new file mode 100644 index 0000000000..a56991909c --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addSection" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addSection` + +Add a new named section to the SWML document. +Mirrors Python's `add_section()`. + +## Signature + +```typescript +addSection(sectionName: string): this +``` + +## Parameters + + + Name of the section to create. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 653. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-skill-by-name.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-skill-by-name.mdx new file mode 100644 index 0000000000..0340f4712a --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-skill-by-name.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-skill-by-name" +title: "addSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addSkillByName" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkillByName` + +Add a skill by its registered name, looking it up in the global SkillRegistry. + +Matches Python's `add_skill(skill_name, params)` which loads skills by string +name via the SkillManager registry. Throws a `ValueError`-equivalent if the +skill name is not found in the registry. + +## Signature + +```typescript +addSkillByName(skillName: string, params?: SkillConfig): Promise +``` + +## Parameters + + + The name the skill was registered under in the SkillRegistry. + + + + Optional configuration parameters forwarded to the skill factory. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Throws + +- Error if no skill with the given name is registered. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1627. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-skill.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-skill.mdx new file mode 100644 index 0000000000..15ae4e1f1d --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-skill" +title: "addSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addSkill" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkill` + +Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + +## Signature + +```typescript +addSkill(skill: SkillBase): Promise +``` + +## Parameters + + + The skill instance to add. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1562. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-swaig-query-params.mdx new file mode 100644 index 0000000000..9955d3c0d4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-swaig-query-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-swaig-query-params" +title: "addSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addSwaigQueryParams" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSwaigQueryParams` + +Add extra query parameters appended to all SWAIG webhook URLs. + +## Signature + +```typescript +addSwaigQueryParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to append as query parameters. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1714. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-verb-to-section.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-verb-to-section.mdx new file mode 100644 index 0000000000..6ce858f6cf --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-verb-to-section.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-verb-to-section" +title: "addVerbToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addVerbToSection" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerbToSection` + +Add a verb to a specific named section. +Mirrors Python's `add_verb_to_section()`. + +## Signature + +```typescript +addVerbToSection(sectionName: string, verbName: string, config: unknown): this +``` + +## Parameters + + + Target section name (auto-created if missing). + + + + Verb name. + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 669. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/add-verb.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-verb.mdx new file mode 100644 index 0000000000..4ab23b269a --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/add-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/add-verb" +title: "addVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.addVerb" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerb` + +Add a verb to the SWML document. + +## Signature + +```typescript +addVerb(name: string, config: unknown): this +``` + +## Parameters + + + Verb name (e.g., 'answer', 'play', 'hangup'). + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 642. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/as-router.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/as-router.mdx new file mode 100644 index 0000000000..e029734270 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/as-router.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/as-router" +title: "asRouter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.asRouter" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `asRouter` + +Return this agent's Hono app for mounting as a sub-router in an AgentServer. + +## Signature + +```typescript +asRouter(): Hono +``` + +## Returns + +`Hono` — The Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2637. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/auto-map-sip-usernames.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/auto-map-sip-usernames.mdx new file mode 100644 index 0000000000..18b187d9d7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/auto-map-sip-usernames.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/auto-map-sip-usernames" +title: "autoMapSipUsernames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.autoMapSipUsernames" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `autoMapSipUsernames` + +Automatically register common SIP usernames based on this agent's +name and route. Derives cleaned variants (alphanumeric + underscore) +and registers each via `registerSipUsername()`. + +Port of Python's `auto_map_sip_usernames()`: + +- Registers a cleaned version of the agent name +- Registers a cleaned version of the route (if different from name) +- For names longer than 3 characters, also registers a vowel-stripped variant + +## Signature + +```typescript +autoMapSipUsernames(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1057. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/build-swml-for-request.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/build-swml-for-request.mdx new file mode 100644 index 0000000000..cdd96f6367 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/build-swml-for-request.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/build-swml-for-request" +title: "buildSwmlForRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.buildSwmlForRequest" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `buildSwmlForRequest` + +Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` +to fully replace the document for this request, or `null` to fall +through to `setOnRequestCallback` or the static builder. + +This is distinct from the WebMixin `onRequest(requestData, +callbackPath)` hook on AgentBase (which mirrors Python's +`on_request -> on_swml_request` modification-merge contract). +Use this hook when you want to swap the entire SWML builder; use +`onRequest` / `onSwmlRequest` on AgentBase when you want to merge +targeted modifications into the rendered document. + +Default implementation returns `null` (no-op). + +## Signature + +```typescript +buildSwmlForRequest( + _queryParams: Record, + _bodyParams: Record, + _headers: Record, + _callbackPath?: string +): SwmlBuilder | null +``` + +## Parameters + + + + + + + + + +## Returns + +`SwmlBuilder | null` — A `SwmlBuilder` whose document is sent as the response, or `null` to delegate to the next handler in the chain. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 834. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..a24a73e269 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-post-ai-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/clear-post-ai-verbs" +title: "clearPostAiVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.clearPostAiVerbs" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAiVerbs` + +Remove all post-AI verbs. + +## Signature + +```typescript +clearPostAiVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1542. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..cf9c6ff283 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-post-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/clear-post-answer-verbs" +title: "clearPostAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.clearPostAnswerVerbs" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAnswerVerbs` + +Remove all post-answer verbs. + +## Signature + +```typescript +clearPostAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1533. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..de4115a83a --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-pre-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/clear-pre-answer-verbs" +title: "clearPreAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.clearPreAnswerVerbs" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPreAnswerVerbs` + +Remove all pre-answer verbs. + +## Signature + +```typescript +clearPreAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1524. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..65c3a21757 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/clear-swaig-query-params.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/clear-swaig-query-params" +title: "clearSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.clearSwaigQueryParams" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearSwaigQueryParams` + +Clear all SWAIG query parameters. + +## Signature + +```typescript +clearSwaigQueryParams(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1723. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/constructor.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/constructor.mdx new file mode 100644 index 0000000000..9b98432901 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.constructor" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `constructor` + +Create a new AgentBase instance. + +## Signature + +```typescript +constructor(opts: AgentOptions): AgentBase +``` + +## Parameters + + + Agent configuration options including name, route, auth, and call settings. + + +## Returns + +`AgentBase` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 220. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/create-tool-token.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/create-tool-token.mdx new file mode 100644 index 0000000000..9d34a0bbb2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/create-tool-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/create-tool-token" +title: "createToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.createToolToken" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `createToolToken` + +Mint a per-call SWAIG-function token via the agent's SessionManager. + +Mirrors Python reference `core/mixins/state_mixin.py _create_tool_token`: +delegates to `SessionManager.createToolToken` and returns an empty +string on any failure (Python catches all exceptions and returns ""). + +## Signature + +```typescript +createToolToken(toolName: string, callId: string): string +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1467. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/define-contexts.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/define-contexts.mdx new file mode 100644 index 0000000000..e381a1220e --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/define-contexts.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/define-contexts" +title: "defineContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.defineContexts" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineContexts` + +Define or replace the contexts configuration for the AI verb. + +## Signature + +```typescript +defineContexts( + contexts?: Record | ContextBuilder +): ContextBuilder +``` + +## Parameters + + + An existing ContextBuilder instance or a plain object; a new ContextBuilder is created if omitted. + + +## Returns + +`ContextBuilder` — The active ContextBuilder for further configuration. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 603. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/define-tool.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/define-tool.mdx new file mode 100644 index 0000000000..5ddb005b2c --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/define-tool.mdx @@ -0,0 +1,114 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.defineTool" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTool` + +Register a SWAIG tool (function) that the AI can invoke during a call. + +## How this becomes a tool the model sees + +A SWAIG function is **exactly the same concept** as a "tool" in +native OpenAI / Anthropic tool calling. On every LLM turn, the SDK +renders each registered SWAIG function into the OpenAI tool schema: + +```json +{ +"type": "function", +"function": { +"name": "your_name_here", +"description": "your description text", +"parameters": { /* your JSON schema */ } +} +} +``` + +That schema goes to the model in the same API call that produces +the next assistant message. The model reads: + +- the **function `description`** to decide WHEN to call this tool +- each **parameter `description`** (inside the JSON schema) to + decide HOW to fill in each argument + +This means **descriptions are prompt engineering**, not developer +comments. A vague description is the #1 cause of "the model has the +right tool but doesn't call it" failures. + +### Bad vs good descriptions + +```text +BAD : description: 'Lookup function' +GOOD: description: 'Look up a customer's account details by account +number. Use this BEFORE quoting any account-specific info +(balance, plan, status). Do not use for general product +questions.' + +BAD : parameters: { id: { type: 'string', description: 'the id' } } +GOOD: parameters: { account_number: { type: 'string', description: +'The customer's 8-digit account number, no dashes or spaces. +Ask the user if they don't provide it.' } } +``` + +### Tool count matters + +LLM tool selection accuracy degrades past ~7-8 simultaneously-active +tools per call. Use Step.setFunctions() to partition tools across +steps so only the relevant subset is active at any moment. + +## Signature + +```typescript +defineTool(opts: { ...11 fields }): this +``` + +## Parameters + + + Tool definition including name, description, parameter schema, and handler callback. `description` and per-parameter `description` strings are LLM-facing prompt engineering. + + + + + Additional fields to pass through to the SWAIG function definition (Python `**swaig_fields` equivalent). + + + + + + + + + + + + + + + + + + + + External webhook URL; makes this an externally-hosted tool. + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1329. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/define-tools.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/define-tools.mdx new file mode 100644 index 0000000000..f44123bb22 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/define-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/define-tools" +title: "defineTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.defineTools" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" + visibility: "protected" +--- +# `defineTools` + +Lifecycle method to register tools. Subclasses should call this at the +end of their own constructor (after all fields are initialized). +Not called automatically — call `this.defineTools()` explicitly. + +## Signature + +```typescript +defineTools(): void +``` + +## Returns + +`void` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 358. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/define-typed-tool.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/define-typed-tool.mdx new file mode 100644 index 0000000000..4088fa060f --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/define-typed-tool.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/define-typed-tool" +title: "defineTypedTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.defineTypedTool" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTypedTool` + +Register a SWAIG tool with a typed handler that receives named parameters +instead of the standard `(args, rawData)` convention. + +The SDK wraps the handler to unpack the args dict into positional params. +If no `parameters` schema is provided, one is inferred from the handler's +source code (parameter names and default values). + +## Signature + +```typescript +defineTypedTool(opts: { ...9 fields }): this +``` + +## Parameters + + + Tool definition with a typed handler function. + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1372. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-debug-events.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-debug-events.mdx new file mode 100644 index 0000000000..e354f7fc01 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-debug-events.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/enable-debug-events" +title: "enableDebugEvents" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.enableDebugEvents" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugEvents` + +Enable debug event webhooks for this agent. + +## Signature + +```typescript +enableDebugEvents(level: number = 1): this +``` + +## Parameters + + + Debug verbosity level (defaults to 1). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1010. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-debug-routes.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-debug-routes.mdx new file mode 100644 index 0000000000..798d817fc6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-debug-routes.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/enable-debug-routes" +title: "enableDebugRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.enableDebugRoutes" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugRoutes` + +Register a callback function that determines routing based on POST data. + +When a routing callback is registered, an endpoint at the specified path +is created in `getApp()`. The callback receives the request body and returns +Enable debug routes for testing and development. + +This is a backward-compatibility stub matching the Python SDK. +In the TypeScript SDK, debug routes (health, ready, debug\_events) +are automatically registered in `getApp()`. + +## Signature + +```typescript +enableDebugRoutes(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1754. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-mcp-server.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-mcp-server.mdx new file mode 100644 index 0000000000..864dfce66b --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-mcp-server.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/enable-mcp-server" +title: "enableMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.enableMcpServer" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableMcpServer` + +Expose this agent's tools as an MCP server endpoint at /mcp. +Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + +## Signature + +```typescript +enableMcpServer(): this +``` + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1159. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-sip-routing.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-sip-routing.mdx new file mode 100644 index 0000000000..83c74c976f --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/enable-sip-routing.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/enable-sip-routing" +title: "enableSipRouting" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.enableSipRouting" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableSipRouting` + +Enable SIP routing for this agent. + +## Signature + +```typescript +enableSipRouting(autoMap: boolean = true, path: string = '/sip'): this +``` + +## Parameters + + + When true, automatically map SIP usernames to the agent route (defaults to true). + + + + HTTP path for the SIP routing endpoint (defaults to '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1024. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/extract-sip-username.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/extract-sip-username.mdx new file mode 100644 index 0000000000..d4ff9559db --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/extract-sip-username.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/extract-sip-username" +title: "extractSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.extractSipUsername" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `extractSipUsername` + +Extract the SIP username from a request body's call.to field. + +**Modifiers:** `static` + +## Signature + +```typescript +extractSipUsername(requestBody: Record): string | null +``` + +## Parameters + + + The parsed request body containing call information. + + +## Returns + +`string | null` — The extracted SIP username, or null if not found. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1121. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-all-functions.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-all-functions.mdx new file mode 100644 index 0000000000..b40ae7b776 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-all-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-all-functions" +title: "getAllFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getAllFunctions" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getAllFunctions` + +Snapshot of all registered SWAIG functions keyed by name. +(Python parity: `ToolRegistry.get_all_functions`.) + +## Signature + +```typescript +getAllFunctions(): Record> +``` + +## Returns + +`Record>` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 529. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-app.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-app.mdx new file mode 100644 index 0000000000..350bd7c477 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-app.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-app" +title: "getApp" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getApp" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getApp` + +Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + +## Signature + +```typescript +getApp(): Hono +``` + +## Returns + +`Hono` — The configured Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2250. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..221e780eda --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-basic-auth-credentials.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-basic-auth-credentials" +title: "getBasicAuthCredentials" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getBasicAuthCredentials" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getBasicAuthCredentials` + +Get the basic-auth credentials used by this agent. + +## Signature + + + + ```typescript + getBasicAuthCredentials(includeSource?: false): [string, string] + ``` + + + + ```typescript + getBasicAuthCredentials( + includeSource: true + ): [string, string, "provided" | "environment" | "generated"] + ``` + + + +## Parameters (Overload 1) + + + When true, a third element indicating the credential source is appended. + + +## Parameters (Overload 2) + + + When true, a third element indicating the credential source is appended. + + +## Returns (Overload 1) + +`[string, string]` — A tuple of \[username, password] or \[username, password, source]. + +## Returns (Overload 2) + +`[string, string, "provided" | "environment" | "generated"]` — A tuple of \[username, password] or \[username, password, source]. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2775. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-builder.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-builder.mdx new file mode 100644 index 0000000000..c2822a054a --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-builder.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-builder" +title: "getBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getBuilder" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getBuilder` + +Get the underlying SwmlBuilder for direct manipulation. + +## Signature + +```typescript +getBuilder(): SwmlBuilder +``` + +## Returns + +`SwmlBuilder` — The SwmlBuilder instance. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 632. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-contexts.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-contexts.mdx new file mode 100644 index 0000000000..ef395fcda2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-contexts" +title: "getContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getContexts" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getContexts` + +Get the contexts dictionary as serialised SWML, or null when no +contexts have been defined yet. + +Matches Python `PromptManager.get_contexts()` which returns the +contexts dict or `None`. + +## Signature + +```typescript +getContexts(): Record | null +``` + +## Returns + +`Record | null` — Contexts dict, or null when no contexts are defined. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 640. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-document.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-document.mdx new file mode 100644 index 0000000000..4efe1f6d7a --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-document" +title: "getDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getDocument" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getDocument` + +Get the SWML document as a dictionary. +Alias for `renderSwml()` that matches Python's `get_document()` name. + +## Signature + +```typescript +getDocument(): Record +``` + +## Returns + +`Record` — The SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 706. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-full-url.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-full-url.mdx new file mode 100644 index 0000000000..32123a5c3d --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-full-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-full-url" +title: "getFullUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getFullUrl" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getFullUrl` + +Get the full external URL of this agent, using the proxy base URL if available. + +## Signature + +```typescript +getFullUrl(includeAuth: boolean = false): string +``` + +## Parameters + + + Whether to embed basic-auth credentials in the URL (defaults to false). + + +## Returns + +`string` — The fully-qualified URL string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1838. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-function.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-function.mdx new file mode 100644 index 0000000000..5a10f4d294 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-function" +title: "getFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getFunction" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getFunction` + +Get a registered SWAIG function entry, or undefined. +(Python parity: `ToolRegistry.get_function`.) + +## Signature + +```typescript +getFunction(name: string): Record | SwaigFunction | undefined +``` + +## Parameters + + + +## Returns + +`Record | SwaigFunction | undefined` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 523. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-language-params.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-language-params.mdx new file mode 100644 index 0000000000..ebfec59857 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-language-params.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-language-params" +title: "getLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getLanguageParams" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getLanguageParams` + +Read the per-language `params` dict for a previously-added language. + +Python parity: `get_language_params(code)`. Returns `undefined` if the +code is unknown or the language has no params set — no exception path. + +## Signature + +```typescript +getLanguageParams(code: string): Record | undefined +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/agent-base/agent-base/add-language). + + +## Returns + +`Record | undefined` — The params dict if set, `undefined` otherwise (including when the code is unknown). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 759. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-mcp-servers.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-mcp-servers.mdx new file mode 100644 index 0000000000..e8f932db69 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-mcp-servers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-mcp-servers" +title: "getMcpServers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getMcpServers" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getMcpServers` + +Get configured MCP servers (read-only copy). + +## Signature + +```typescript +getMcpServers(): Record[] +``` + +## Returns + +`Record[]` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1170. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-name.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-name.mdx new file mode 100644 index 0000000000..be8e1242ea --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-name" +title: "getName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getName" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getName` + +Get the agent's display name. + +## Signature + +```typescript +getName(): string +``` + +## Returns + +`string` — The agent name string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1551. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-post-prompt.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-post-prompt.mdx new file mode 100644 index 0000000000..720eeeb5a2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-post-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-post-prompt" +title: "getPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getPostPrompt" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPostPrompt` + +Get the post-prompt text, if one has been set. + +## Signature + +```typescript +getPostPrompt(): string | null +``` + +## Returns + +`string | null` — The post-prompt string, or null if not configured. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 547. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-prompt-pom.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-prompt-pom.mdx new file mode 100644 index 0000000000..f4372eadc6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-prompt-pom.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-prompt-pom" +title: "getPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getPromptPom" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPromptPom` + +Get the raw POM (Prompt Object Model) structure as an array of section data objects, +when the agent is in POM mode and has at least one section. + +Matches Python `get_prompt()` which returns `Union[str, List[Dict]]` — a raw list when +in POM mode (via `pom.to_list()` / `pom.render_dict()`), or a string otherwise. +The TS `getPrompt()` always returns a string (rendered Markdown), so this companion +method exposes the raw POM structure for callers that need it for serialisation or +inspection (e.g. skills that inspect prompt sections). + +## Signature + +```typescript +getPromptPom(): Record[] | null +``` + +## Returns + +`Record[] | null` — An array of POM section data objects, or null if not in POM mode or POM is empty. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 535. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-prompt.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-prompt.mdx new file mode 100644 index 0000000000..9df8bda96a --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-prompt" +title: "getPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getPrompt" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPrompt` + +Get the fully rendered main prompt text. + +## Signature + +```typescript +getPrompt(): string +``` + +## Returns + +`string` — The assembled prompt string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 519. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-raw-prompt.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-raw-prompt.mdx new file mode 100644 index 0000000000..c2bd385bd3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-raw-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-raw-prompt" +title: "getRawPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getRawPrompt" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getRawPrompt` + +Get the raw prompt text whatever `setPromptText` stored, or null when +no raw prompt has been set. + +Matches Python `PromptManager.get_raw_prompt()` which returns the raw +stored string or `None`. Use this instead of `getPrompt()` when you +need the unrendered text rather than the POM-rendered Markdown. + +## Signature + +```typescript +getRawPrompt(): string | null +``` + +## Returns + +`string | null` — The raw prompt string, or null if not set. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 561. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-registered-tools.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-registered-tools.mdx new file mode 100644 index 0000000000..4aec8d1294 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-registered-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-registered-tools" +title: "getRegisteredTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getRegisteredTools" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getRegisteredTools` + +Get a summary of all registered tools with their names, descriptions, and +parameter schemas. Lifted from AgentBase so the swaig-test CLI can list +tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG +host). + +## Signature + +```typescript +getRegisteredTools(): { description: string; name: string; parameters: Record }[] +``` + +## Returns + +`{ description: string; name: string; parameters: Record }[]` — Array of tool descriptors. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-tool.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-tool.mdx new file mode 100644 index 0000000000..66999bdf1f --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-tool.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-tool" +title: "getTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getTool" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getTool` + +Look up a registered SwaigFunction by name. Lifted from AgentBase so +`swaig-test --exec ` works against a non-AgentBase SWMLService +target. + +## Signature + +```typescript +getTool(name: string): SwaigFunction | undefined +``` + +## Parameters + + + The tool name to search for. + + +## Returns + +`SwaigFunction | undefined` — The SwaigFunction instance, or undefined if not found or not a SwaigFunction. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 581. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/get-tools.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-tools.mdx new file mode 100644 index 0000000000..03648c960b --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/get-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.getTools" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getTools` + +Public access to the list of registered tools. + +In Python, `define_tools()` is public and returns `List[SWAIGFunction]`. +In TypeScript, `defineTools()` is a protected setup hook (void). This +method provides the equivalent public "get all tools" capability. + +## Signature + +```typescript +getTools(): SwaigFunction[] +``` + +## Returns + +`SwaigFunction[]` — Array of all registered SwaigFunction instances. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 370. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/handle-mcp-request.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/handle-mcp-request.mdx new file mode 100644 index 0000000000..0825b48576 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/handle-mcp-request.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/handle-mcp-request" +title: "handleMcpRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.handleMcpRequest" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `handleMcpRequest` + +Handle an MCP JSON-RPC 2.0 request. Returns the response object. + +## Signature + +```typescript +handleMcpRequest( + body: Record +): Promise> +``` + +## Parameters + + + +## Returns + +`Promise>` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1203. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/has-function.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/has-function.mdx new file mode 100644 index 0000000000..beb29952d7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/has-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/has-function" +title: "hasFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.hasFunction" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasFunction` + +Whether a SWAIG function with the given name is registered. +(Python parity: `ToolRegistry.has_function`.) + +## Signature + +```typescript +hasFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 517. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/has-skill.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/has-skill.mdx new file mode 100644 index 0000000000..7abd2d3f6f --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/has-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/has-skill" +title: "hasSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.hasSkill" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `hasSkill` + +Check whether a skill with the given name is registered. + +## Signature + +```typescript +hasSkill(skillName: string): boolean +``` + +## Parameters + + + The skill name to check. + + +## Returns + +`boolean` — True if a skill with that name exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1657. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/has-tool.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/has-tool.mdx new file mode 100644 index 0000000000..f068ac7b5a --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/has-tool.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/has-tool" +title: "hasTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.hasTool" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasTool` + +Whether a tool with the given name is registered. + +## Signature + +```typescript +hasTool(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/index.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/index.mdx new file mode 100644 index 0000000000..a09dbe9fa9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/index.mdx @@ -0,0 +1,635 @@ +--- +slug: "/reference/typescript/agent-base/agent-base" +title: "AgentBase" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "AgentBase.AgentBase" + parent: "AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `AgentBase` + +Core agent class that composes an HTTP server, prompt management, session handling, +SWAIG tool registry, and 5-phase SWML rendering into a single deployable unit. + +A single `AgentBase` is one HTTP-servable voice agent: + +- `GET /` returns the SWML call-flow document +- `POST /swaig` dispatches SWAIG function calls to registered tool handlers +- `POST /post_prompt` receives the end-of-call summary and invokes [onSummary](/reference/typescript/agent-base/agent-base/on-summary) + +Most user agents either (a) subclass `AgentBase` and override `defineTools()` / `onSummary()` +or (b) use one of the `prefab agents` (e.g. `ReceptionistAgent`). + +## Signature + +```typescript +class AgentBase extends SWMLService +``` + +## Inheritance + +**Extends:** [SWMLService](/reference/typescript/swml-service) + +## Examples + + + + ```typescript + import { AgentBase, FunctionResult } from '@signalwire/sdk'; + + class WeatherAgent extends AgentBase { + static override PROMPT_SECTIONS = [ + { title: 'Role', body: 'You are a weather assistant.' }, + ]; + + protected override defineTools(): void { + this.defineTool({ + name: 'get_forecast', + description: 'Return the forecast for a city.', + parameters: { + type: 'object', + properties: { city: { type: 'string' } }, + required: ['city'], + }, + handler: async ({ city }) => { + const forecast = await fetchForecast(city as string); + return new FunctionResult(forecast); + }, + }); + } + } + + const agent = new WeatherAgent({ name: 'weather', route: '/' }); + await agent.serve({ port: 3000 }); + ``` + + + + ```typescript + const agent = new AgentBase({ name: 'hello', route: '/' }); + agent.setPromptText('You are a friendly greeter.'); + agent.defineTool({ + name: 'say_hi', + description: 'Respond with a greeting.', + parameters: { type: 'object', properties: {} }, + handler: () => new FunctionResult('Hello from SignalWire!'), + }); + await agent.serve(); + ``` + + + +## See Also + +- \- \[FunctionResult]\(/reference/typescript/function-result) — builder for tool handler responses + \- \[ContextBuilder]\(/reference/typescript/context-builder) — multi-step conversation state machines + \- \[DataMap]\(/reference/typescript/data-map) — server-side tools without webhooks + \- \[AgentServer]\(/reference/typescript/agent-server) — host multiple agents on one HTTP server + +## Properties + + + Unique identifier for this agent instance. + + + + + + + + Domain name for SSL. Mirrors Python's `self.domain`. + + + + Check if full JSON Schema validation is enabled. Mirrors Python's `@property full_validation_enabled`. + + + + Host the server binds to. + + + + Structured logger instance for this agent. Override the inherited SWMLService logger with an AgentBase-tagged one. + + + + Service display name. + + + + Public accessor for the native functions list. Python exposes `self.native_functions` as a public read/write attribute. + + + + + + Public accessor for the agent's POM as a `PromptObjectModel` instance. Python parity: `agent.pom` instance attribute (agent\_base.py line 209) is a `signalwire.pom.pom.PromptObjectModel` when `use_pom=True`, or `None` otherwise. This getter returns the equivalent TypeScript `PromptObjectModel` instance — callers can use `addSection`, `findSection`, `renderMarkdown`, `renderXml`, `toJson`, `toYaml` exactly as in Python. The instance returned is a fresh snapshot built from the current `PomBuilder` state, so mutating it does not feed back into the agent's internal builder. To mutate the agent's prompt, use `promptAddSection` / `promptAddToSection` / `promptAddSubsection`. + + + + Port the server binds to. + + + + Static prompt sections: subclasses can define these declaratively. Each entry is applied via promptAddSection() in the constructor. + + + + Public accessor for the PromptManager (POM). Python exposes `self.pom` as a public attribute. This getter provides equivalent access for direct POM manipulation. + + + + HTTP route path. + + + + Schema validation utilities. Mirrors Python's `self.schema_utils`. + + + + Unified security configuration. Mirrors Python's `self.security`. + + + + Public read-only accessor for the SkillManager. Python exposes `self.skill_manager` as a public attribute. This getter provides equivalent read access. + + + + Path to SSL certificate. Mirrors Python's `self.ssl_cert_path`. + + + + Whether SSL is enabled. Mirrors Python's `self.ssl_enabled`. + + + + Path to SSL private key. Mirrors Python's `self.ssl_key_path`. + + + + The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — addInternalFiller / setInternalFillers warn if you pass an unknown name. + + + + + + + + Custom verb handler registry. Mirrors Python's `self.verb_registry`. + + +## Methods + + + + Configure the answer verb (phase 2) with optional settings. + + + + Add a remote SWAIG function include reference. + + + + Add a single speech-recognition hint. + + + + Add multiple speech-recognition hints at once. + + + + Add internal filler phrases for a single internal function and language. + + + + Add a supported language to the AI configuration. + + + + Add an external MCP server for tool discovery and invocation. Tools are discovered via MCP protocol at session start and added to the AI's tool list. + + + + Add a pattern-based speech-recognition hint with find-and-replace behavior. + + + + Add a SWML verb to execute after the AI verb (phase 5). + + + + Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + + + + Add a SWML verb to execute before the answer phase (phase 1). + + + + Add a pronunciation override rule for the TTS engine. + + + + Add a new named section to the SWML document. Mirrors Python's `add_section()`. + + + + Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + + + + Add a skill by its registered name, looking it up in the global SkillRegistry. + + + + Add extra query parameters appended to all SWAIG webhook URLs. + + + + Add a verb to the SWML document. + + + + Add a verb to a specific named section. Mirrors Python's `add_verb_to_section()`. + + + + Return this agent's Hono app for mounting as a sub-router in an AgentServer. + + + + Automatically register common SIP usernames based on this agent's name and route. Derives cleaned variants (alphanumeric + underscore) and registers each via `registerSipUsername()`. + + + + Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` to fully replace the document for this request, or `null` to fall through to `setOnRequestCallback` or the static builder. + + + + Remove all post-AI verbs. + + + + Remove all post-answer verbs. + + + + Remove all pre-answer verbs. + + + + Clear all SWAIG query parameters. + + + + Create a new AgentBase instance. + + + + Mint a per-call SWAIG-function token via the agent's SessionManager. + + + + Define or replace the contexts configuration for the AI verb. + + + + Register a SWAIG tool (function) that the AI can invoke during a call. + + + + Lifecycle method to register tools. Subclasses should call this at the end of their own constructor (after all fields are initialized). Not called automatically — call `this.defineTools()` explicitly. + + + + Register a SWAIG tool with a typed handler that receives named parameters instead of the standard `(args, rawData)` convention. + + + + Enable debug event webhooks for this agent. + + + + Register a callback function that determines routing based on POST data. + + + + Expose this agent's tools as an MCP server endpoint at /mcp. Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + + + + Enable SIP routing for this agent. + + + + Extract the SIP username from a request body's call.to field. + + + + Snapshot of all registered SWAIG functions keyed by name. (Python parity: `ToolRegistry.get_all_functions`.) + + + + Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + + + + Get the basic-auth credentials used by this agent. + + + + Get the underlying SwmlBuilder for direct manipulation. + + + + Get the contexts dictionary as serialised SWML, or null when no contexts have been defined yet. + + + + Get the SWML document as a dictionary. Alias for `renderSwml()` that matches Python's `get_document()` name. + + + + Get the full external URL of this agent, using the proxy base URL if available. + + + + Get a registered SWAIG function entry, or undefined. (Python parity: `ToolRegistry.get_function`.) + + + + Read the per-language `params` dict for a previously-added language. + + + + Get configured MCP servers (read-only copy). + + + + Get the agent's display name. + + + + Get the post-prompt text, if one has been set. + + + + Get the fully rendered main prompt text. + + + + Get the raw POM (Prompt Object Model) structure as an array of section data objects, when the agent is in POM mode and has at least one section. + + + + Get the raw prompt text whatever `setPromptText` stored, or null when no raw prompt has been set. + + + + Get a summary of all registered tools with their names, descriptions, and parameter schemas. Lifted from AgentBase so the swaig-test CLI can list tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG host). + + + + Look up a registered SwaigFunction by name. Lifted from AgentBase so `swaig-test --exec ` works against a non-AgentBase SWMLService target. + + + + Public access to the list of registered tools. + + + + Handle an MCP JSON-RPC 2.0 request. Returns the response object. + + + + Whether a SWAIG function with the given name is registered. (Python parity: `ToolRegistry.has_function`.) + + + + Check whether a skill with the given name is registered. + + + + Whether a tool with the given name is registered. + + + + Check if MCP server endpoint is enabled. + + + + List all registered skills with their names, instance IDs, and initialization status. + + + + List registered tool names in insertion order (Map preserves it). + + + + Manually set the proxy base URL used for webhook URL generation. + + + + Lifecycle hook called when a debug event webhook is received. Override in subclasses. + + + + Hook called before each SWAIG function execution. Override in subclasses. + + + + Lifecycle hook called when SWML is requested. Default delegates to [onSwmlRequest](/reference/typescript/agent-base/agent-base/on-swml-request) and returns its result. Subclasses typically override `onSwmlRequest` rather than this method. + + + + Lifecycle hook called when a post-prompt summary is received. Override in subclasses. + + + + Lifecycle hook called on every SWML request before rendering. Override in subclasses. + + + + Add a new section to the prompt with optional body, bullets, and subsections. + + + + Add a subsection under an existing prompt section. + + + + Append content to an existing prompt section. + + + + Check whether a prompt section with the given title exists. + + + + Extension point: register additional Hono routes after SWMLService mounts /health, /ready, /swaig, and the main route. AgentBase uses this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + + + + Register a callback at a specific HTTP path that decides how to route an incoming request. + + + + Register a SIP username to route to this agent. + + + + Register a SwaigFunction instance or a raw function descriptor (DataMap). + + + + Register a custom verb handler. Mirrors Python's `register_verb_handler()`. + + + + Remove a registered SWAIG function. Returns true when removed, false when not found. (Python parity: `ToolRegistry.remove_function`.) + + + + Remove a previously added skill by its instance ID. + + + + Remove a skill by its name (Python parity). + + + + Render the SWML document as a JSON string. Mirrors Python's `render_document()`. + + + + Render the complete SWML document by assembling all 5 phases: pre-answer, answer, post-answer, AI, and post-AI verbs. + + + + Remove all contexts, returning the agent to a no-contexts state. + + + + Reset the SWML document to an empty state. Mirrors Python's `reset_document()`. + + + + Alias for [serve](/reference/typescript/agent-base/agent-base/serve). Starts the HTTP server. + + + + Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + + + + Start the HTTP server and begin listening for requests. + + + + Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + + + + Replace the entire list of function includes. Each include must have a `url` and `functions` array. + + + + Merge data into the global\_data object passed into the AI configuration. + + + + Set internal fillers for native SWAIG functions. + + + + Set (or replace) the per-language `params` dict on an already-added language. Useful when language entries are built up via [addLanguage](/reference/typescript/agent-base/agent-base/add-language) first and engine-specific tuning is added later (e.g., from a config loader). + + + + Replace all configured languages with a new list. + + + + Set the list of native SWAIG function names (built-in platform functions). + + + + Set a callback invoked per-request to dynamically build SWML. When set, the static SwmlBuilder is ignored and the callback's returned SwmlBuilder is used instead. + + + + Set a single AI parameter (e.g. "temperature", "top\_p"). + + + + Merge multiple AI parameters into the existing params object. + + + + Set the post-prompt text evaluated after the call ends. + + + + Merge LLM-specific parameters into the post-prompt configuration. + + + + Override the default post-prompt webhook URL with a custom one. + + + + Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + + + + Set the prompt as a POM (Prompt Object Model) dictionary. + + + + Set the main system prompt text for the AI. + + + + Replace all pronunciation rules with a new list. + + + + Register process signal handlers for clean Kubernetes/Docker shutdown. Handles SIGTERM and SIGINT, waits for a timeout, then exits. + + + + Override the default SWAIG webhook URL with a custom one. + + + + Stop the HTTP server. Mirrors Python's `stop()`. + + + + Extension point: invoked between argument parsing and function dispatch on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is non-null, it's returned directly without dispatching. AgentBase may override to add session-token validation or ephemeral dynamic-config. + + + + Merge additional entries into the existing global\_data object. + + + + Override to add custom basic-auth validation logic beyond credential matching. + + + + Validate a tool-call token for the given function. + + + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 110. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/is-mcp-server-enabled.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/is-mcp-server-enabled.mdx new file mode 100644 index 0000000000..da6e07e7a7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/is-mcp-server-enabled.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/is-mcp-server-enabled" +title: "isMcpServerEnabled" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.isMcpServerEnabled" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `isMcpServerEnabled` + +Check if MCP server endpoint is enabled. + +## Signature + +```typescript +isMcpServerEnabled(): boolean +``` + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1165. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/list-skills.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/list-skills.mdx new file mode 100644 index 0000000000..f97ad9c61c --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/list-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/list-skills" +title: "listSkills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.listSkills" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `listSkills` + +List all registered skills with their names, instance IDs, and initialization status. + +## Signature + +```typescript +listSkills(): { initialized: boolean; instanceId: string; name: string }[] +``` + +## Returns + +`{ initialized: boolean; instanceId: string; name: string }[]` — Array of skill descriptors. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1648. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/list-tool-names.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/list-tool-names.mdx new file mode 100644 index 0000000000..973162c1ea --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/list-tool-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/list-tool-names" +title: "listToolNames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.listToolNames" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `listToolNames` + +List registered tool names in insertion order (Map preserves it). + +## Signature + +```typescript +listToolNames(): string[] +``` + +## Returns + +`string[]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 545. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/manual-set-proxy-url.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..6dc5b87383 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/manual-set-proxy-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/manual-set-proxy-url" +title: "manualSetProxyUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.manualSetProxyUrl" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `manualSetProxyUrl` + +Manually set the proxy base URL used for webhook URL generation. + +## Signature + +```typescript +manualSetProxyUrl(url: string): this +``` + +## Parameters + + + The external-facing base URL (trailing slashes are stripped). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1735. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/on-debug-event.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/on-debug-event.mdx new file mode 100644 index 0000000000..436453a76b --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/on-debug-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/on-debug-event" +title: "onDebugEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.onDebugEvent" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onDebugEvent` + +Lifecycle hook called when a debug event webhook is received. Override in subclasses. + +## Signature + +```typescript +onDebugEvent(_event: Record): void | Promise +``` + +## Parameters + + + The debug event payload. + + +## Returns + +`void | Promise` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1951. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/on-function-call.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/on-function-call.mdx new file mode 100644 index 0000000000..db38529d03 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/on-function-call.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/on-function-call" +title: "onFunctionCall" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.onFunctionCall" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onFunctionCall` + +Hook called before each SWAIG function execution. Override in subclasses. + +**Behavioral note:** In the Python SDK, `on_function_call` IS the dispatcher +— it retrieves and executes the function, returning the result. In TypeScript, +`fn.execute()` is called separately after this hook. However, if this method +returns a non-void value, it is used as the result and the default execution +is skipped, enabling dispatch interception parity with Python. + +## Signature + +```typescript +onFunctionCall( + _name: string, + _args: Record, + _rawData: Record +): void | Record | Promise> +``` + +## Parameters + + + Name of the function about to execute. + + + + Parsed arguments for the function. + + + + The full raw SWAIG request payload. + + +## Returns + +`void | Record | Promise>` — Optionally a result dict to short-circuit default execution, or void/undefined to proceed normally. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1980. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/on-request.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/on-request.mdx new file mode 100644 index 0000000000..6435d47ba0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/on-request.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/on-request" +title: "onRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.onRequest" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onRequest` + +Lifecycle hook called when SWML is requested. Default delegates to +[onSwmlRequest](/reference/typescript/agent-base/agent-base/on-swml-request) and returns its result. Subclasses typically +override `onSwmlRequest` rather than this method. + +Matches Python `WebMixin.on_request(request_data, callback_path)`. The +cross-language API is the two-arg form; the Hono `context` argument is +a TypeScript-side extra preserved for callers that already have it but +is not part of the audited surface. + +## Signature + +```typescript +onRequest( + requestData?: Record | null, + callbackPath?: string | null +): void | Record | Promise> +``` + +## Parameters + + + The parsed request body. + + + + Optional callback path from the request. + + +## Returns + +`void | Record | Promise>` — Optionally a dict of SWML modifications, or undefined for default rendering. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1916. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/on-summary.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/on-summary.mdx new file mode 100644 index 0000000000..ce016ce732 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/on-summary.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/on-summary" +title: "onSummary" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.onSummary" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onSummary` + +Lifecycle hook called when a post-prompt summary is received. Override in subclasses. + +Invoked once at the end of a call when the AI has produced a structured summary +(configured via `setPostPrompt()` / `setPostPromptJson()`). Use this hook to persist +call data, notify other systems, or trigger follow-up workflows. + +## Signature + +```typescript +onSummary( + _summary: Record | null, + _rawData: Record +): void | Promise +``` + +## Parameters + + + Parsed summary object (JSON when the post-prompt requests structured output), or `null` if extraction/parsing failed. + + + + Full raw post-prompt payload received from the platform, including call metadata, conversation history, and the summary text. + + +## Returns + +`void | Promise` + +## Examples + +```typescript +class MyAgent extends AgentBase { + async onSummary(summary, rawData) { + if (!summary) return; + await db.calls.insert({ + callSid: rawData.call_id, + summary, + endedAt: new Date(), + }); + } +} +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1897. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/on-swml-request.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/on-swml-request.mdx new file mode 100644 index 0000000000..6ed7c00be7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/on-swml-request.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/on-swml-request" +title: "onSwmlRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.onSwmlRequest" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onSwmlRequest` + +Lifecycle hook called on every SWML request before rendering. Override in subclasses. + +May optionally return a modification dict that will be merged into the +rendered SWML document (matching Python's `Optional[dict]` return type). + +Matches Python `on_swml_request(request_data, callback_path, request)` — the third +parameter is the FastAPI `Request` in Python; here it is the raw Hono context object +so that subclasses can access query parameters (`context.req.query()`), raw request +headers (`context.req.raw.headers`), etc. + +## Signature + +```typescript +onSwmlRequest( + _rawData: Record, + _callbackPath?: string, + _context?: any +): void | Record | Promise> +``` + +## Parameters + + + The parsed request body. + + + + Optional callback path from the request. + + + + The raw Hono context object (c), providing access to headers and query params. + + +## Returns + +`void | Record | Promise>` — Optionally a dict of SWML modifications, or void. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1939. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-add-section.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-add-section.mdx new file mode 100644 index 0000000000..bfde52050f --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-add-section.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/prompt-add-section" +title: "promptAddSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.promptAddSection" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSection` + +Add a new section to the prompt with optional body, bullets, and subsections. + +## Signature + +```typescript +promptAddSection(title: string, opts?: { ...5 fields }): this +``` + +## Parameters + + + Section heading. + + + + Optional section content including body text, bullet points, and subsections. + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 466. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-add-subsection.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-add-subsection.mdx new file mode 100644 index 0000000000..785e731148 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-add-subsection.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/prompt-add-subsection" +title: "promptAddSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.promptAddSubsection" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSubsection` + +Add a subsection under an existing prompt section. + +## Signature + +```typescript +promptAddSubsection( + parentTitle: string, + title: string, + opts?: { ...2 fields } +): this +``` + +## Parameters + + + Title of the parent section. + + + + Title of the new subsection. + + + + Optional body text and bullet points for the subsection. + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 501. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-add-to-section.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-add-to-section.mdx new file mode 100644 index 0000000000..cc2063548b --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-add-to-section.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/prompt-add-to-section" +title: "promptAddToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.promptAddToSection" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddToSection` + +Append content to an existing prompt section. + +## Signature + +```typescript +promptAddToSection(title: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + Title of the section to append to. + + + + Content to add: body text, a single bullet, or multiple bullets. + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-has-section.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-has-section.mdx new file mode 100644 index 0000000000..a758e51380 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/prompt-has-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/prompt-has-section" +title: "promptHasSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.promptHasSection" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptHasSection` + +Check whether a prompt section with the given title exists. + +## Signature + +```typescript +promptHasSection(title: string): boolean +``` + +## Parameters + + + Section title to look for. + + +## Returns + +`boolean` — True if the section exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/register-additional-routes.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/register-additional-routes.mdx new file mode 100644 index 0000000000..6ea76ed76c --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/register-additional-routes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/register-additional-routes" +title: "registerAdditionalRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.registerAdditionalRoutes" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `registerAdditionalRoutes` + +Extension point: register additional Hono routes after SWMLService +mounts /health, /ready, /swaig, and the main route. AgentBase uses +this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + +## Signature + +```typescript +registerAdditionalRoutes(_app: Hono): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 604. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/register-routing-callback.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/register-routing-callback.mdx new file mode 100644 index 0000000000..261dcd7882 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/register-routing-callback.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/register-routing-callback" +title: "registerRoutingCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.registerRoutingCallback" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerRoutingCallback` + +Register a callback at a specific HTTP path that decides how to route an +incoming request. + +When called, the endpoint at `path` will invoke `callback` with the parsed +request body. If `callback` returns a non-empty route string the server +responds with `{ action: "redirect", route }` so the platform can forward the +request to the right agent. If `callback` returns `null` / `undefined` the +agent's own SWML is returned instead (normal processing). + +Mirrors Python `swml_service.register_routing_callback` / +`web_mixin.register_routing_callback`. + +## Signature + +```typescript +registerRoutingCallback(callback: RoutingCallback, path: string = '/sip'): this +``` + +## Parameters + + + Function receiving the parsed request body and returning a route string to redirect, or null/undefined for normal processing. + + + + HTTP path where this callback endpoint is registered (default: '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1101. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/register-sip-username.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/register-sip-username.mdx new file mode 100644 index 0000000000..de1c425716 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/register-sip-username.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/register-sip-username" +title: "registerSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.registerSipUsername" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerSipUsername` + +Register a SIP username to route to this agent. + +## Signature + +```typescript +registerSipUsername(username: string): this +``` + +## Parameters + + + The SIP username to register. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1039. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/register-swaig-function.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/register-swaig-function.mdx new file mode 100644 index 0000000000..4e7c068387 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/register-swaig-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/register-swaig-function" +title: "registerSwaigFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.registerSwaigFunction" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerSwaigFunction` + +Register a SwaigFunction instance or a raw function descriptor (DataMap). + +## Signature + +```typescript +registerSwaigFunction(fn: Record | SwaigFunction): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 472. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/register-verb-handler.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/register-verb-handler.mdx new file mode 100644 index 0000000000..97f7299201 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/register-verb-handler.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/register-verb-handler" +title: "registerVerbHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.registerVerbHandler" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerVerbHandler` + +Register a custom verb handler. +Mirrors Python's `register_verb_handler()`. + +## Signature + +```typescript +registerVerbHandler(handler: SWMLVerbHandler): void +``` + +## Parameters + + + The verb handler to register. + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 726. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/remove-function.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/remove-function.mdx new file mode 100644 index 0000000000..637d7b09c4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/remove-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/remove-function" +title: "removeFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.removeFunction" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `removeFunction` + +Remove a registered SWAIG function. Returns true when removed, +false when not found. (Python parity: +`ToolRegistry.remove_function`.) + +## Signature + +```typescript +removeFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 540. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/remove-skill-by-name.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/remove-skill-by-name.mdx new file mode 100644 index 0000000000..8378543109 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/remove-skill-by-name.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/remove-skill-by-name" +title: "removeSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.removeSkillByName" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkillByName` + +Remove a skill by its name (Python parity). + +Python's `remove_skill(skill_name)` removes by skill name. +The existing `removeSkill(instanceId)` removes by instance ID. +This method provides name-based removal for cross-SDK parity. + +## Signature + +```typescript +removeSkillByName(skillName: string): Promise +``` + +## Parameters + + + The skill name to remove. + + +## Returns + +`Promise` — True if a skill with that name was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1671. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/remove-skill.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/remove-skill.mdx new file mode 100644 index 0000000000..ed3e343b01 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/remove-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/remove-skill" +title: "removeSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.removeSkill" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkill` + +Remove a previously added skill by its instance ID. + +## Signature + +```typescript +removeSkill(instanceId: string): Promise +``` + +## Parameters + + + The unique instance ID of the skill to remove. + + +## Returns + +`Promise` — True if the skill was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1640. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/render-document.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/render-document.mdx new file mode 100644 index 0000000000..da16c3b76b --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/render-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/render-document" +title: "renderDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.renderDocument" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `renderDocument` + +Render the SWML document as a JSON string. +Mirrors Python's `render_document()`. + +## Signature + +```typescript +renderDocument(): string +``` + +## Returns + +`string` — JSON-encoded SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 715. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/render-swml.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/render-swml.mdx new file mode 100644 index 0000000000..ab44d616f5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/render-swml.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/render-swml" +title: "renderSwml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.renderSwml" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `renderSwml` + +Render the complete SWML document by assembling all 5 phases: pre-answer, answer, +post-answer, AI, and post-AI verbs. + +## Signature + +```typescript +renderSwml(callId?: string, modifications?: Record): string +``` + +## Parameters + + + Optional call ID to use for session tokens; auto-generated if omitted. + + + + Optional dict returned from `onSwmlRequest` to merge into the AI verb config before rendering. Matches Python's `_render_swml(modifications)` semantics: `global_data` is deep-merged; all other keys override the AI config directly. + + +## Returns + +`string` — The rendered SWML document as a JSON string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2000. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/reset-contexts.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/reset-contexts.mdx new file mode 100644 index 0000000000..55f1b19bc5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/reset-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/reset-contexts" +title: "resetContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.resetContexts" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `resetContexts` + +Remove all contexts, returning the agent to a no-contexts state. + +This is a convenience wrapper around `defineContexts().reset()`. +Use it in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```typescript +resetContexts(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 624. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/reset-document.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/reset-document.mdx new file mode 100644 index 0000000000..a5b78a554d --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/reset-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/reset-document" +title: "resetDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.resetDocument" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `resetDocument` + +Reset the SWML document to an empty state. +Mirrors Python's `reset_document()`. + +## Signature + +```typescript +resetDocument(): this +``` + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 679. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/run-serverless.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/run-serverless.mdx new file mode 100644 index 0000000000..e38cb66b02 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/run-serverless.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/run-serverless" +title: "runServerless" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.runServerless" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `runServerless` + +Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + +Matches Python `run(event, context)` when executed in a serverless environment. Python's +`run()` auto-detects the platform via `get_execution_mode()` and dispatches accordingly; +in TypeScript the serverless path is an **explicit** method so that `run()` keeps its +HTTP-server semantics and callers opt in to serverless dispatch deliberately. + +Platform detection follows the same environment-variable heuristics as Python's +`ServerlessMixin`: `AWS_LAMBDA_FUNCTION_NAME` → Lambda, `K_SERVICE` → GCF, +`FUNCTIONS_WORKER_RUNTIME` → Azure, `GATEWAY_INTERFACE` → CGI. + +Usage in a Lambda handler file: + +```ts +export const handler = (event: any, context: any) => agent.runServerless(event, context); +``` + +## Signature + +```typescript +runServerless( + event: ServerlessEvent, + context?: unknown, + platform?: "lambda" | "gcf" | "azure" | "cgi" | "auto" +): Promise +``` + +## Parameters + + + The serverless event payload (Lambda event, GCF request body, etc.). + + + + The serverless context object (Lambda context, Azure context, etc.). + + + + Optional platform override; defaults to 'auto' (environment detection). + + +## Returns + +`Promise` — The normalized serverless response object. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2709. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/run.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/run.mdx new file mode 100644 index 0000000000..c745a48d9b --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/run.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/run" +title: "run" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.run" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `run` + +Alias for [serve](/reference/typescript/agent-base/agent-base/serve). Starts the HTTP server. + +## Signature + +```typescript +run(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host and port overrides. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server is running. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2683. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/serve.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/serve.mdx new file mode 100644 index 0000000000..0470891e6e --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/serve.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/serve" +title: "serve" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.serve" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `serve` + +Start the HTTP server and begin listening for requests. + +Uses `@hono/node-server` under the hood. When run in CLI mode +(`SWAIG_CLI_MODE=true`, set automatically by `npx swaig-test`), this is a +no-op so agent config can be inspected without starting a server. + +## Signature + +```typescript +serve(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host/port overrides. Defaults to the values provided in the constructor options or the `PORT` environment variable. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server has begun listening. + +## Examples + +```typescript +const agent = new AgentBase({ name: 'demo', port: 3000 }); +await agent.serve(); +// Or override at runtime: +await agent.serve({ port: 8080, host: '127.0.0.1' }); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2660. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..4fe7d939a5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-dynamic-config-callback.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-dynamic-config-callback" +title: "setDynamicConfigCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setDynamicConfigCallback" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setDynamicConfigCallback` + +Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + +The callback receives a clone of this agent — mutations apply only to the current +request, so you can vary prompt, tools, languages, params, or global data per call +without affecting the long-lived agent instance. + +## Signature + +```typescript +setDynamicConfigCallback(cb: DynamicConfigCallback): this +``` + +## Parameters + + + Callback receiving `(queryParams, bodyParams, headers, agent)` where `agent` is the ephemeral `AgentBase` copy to mutate. May be async. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setDynamicConfigCallback((query, body, headers, agent) => { + const lang = query.lang ?? 'en'; + if (lang === 'es') { + (agent as AgentBase).setPromptText('Eres un asistente útil.'); + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1704. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-function-includes.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-function-includes.mdx new file mode 100644 index 0000000000..7d86816369 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-function-includes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-function-includes" +title: "setFunctionIncludes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setFunctionIncludes" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setFunctionIncludes` + +Replace the entire list of function includes. +Each include must have a `url` and `functions` array. + +## Signature + +```typescript +setFunctionIncludes(includes: FunctionInclude[]): this +``` + +## Parameters + + + Array of function include objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 978. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-global-data.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-global-data.mdx new file mode 100644 index 0000000000..0f51256621 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-global-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-global-data" +title: "setGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setGlobalData" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setGlobalData` + +Merge data into the global\_data object passed into the AI configuration. + +Matches Python `set_global_data` which calls `.update()` on the internal dict — +existing keys are preserved; incoming keys overwrite on collision. Skills and +other callers can each contribute keys without clobbering one another. + +If you need to replace the entire object, assign a new agent instance or use +`Object.assign(agent.globalData, {})` to clear first. + +## Signature + +```typescript +setGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 827. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-internal-fillers.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-internal-fillers.mdx new file mode 100644 index 0000000000..5e4173f45c --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-internal-fillers.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-internal-fillers" +title: "setInternalFillers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setInternalFillers" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setInternalFillers` + +Set internal fillers for native SWAIG functions. + +Internal fillers are short phrases the AI agent speaks (via TTS) while +an internal/native function is running, so the caller doesn't hear +dead air during transitions or background work. + +Supported function names (matches the SWAIGInternalFiller schema): + +hangup — when the agent is hanging up +check\_time — when checking the time +wait\_for\_user — when waiting for user input +wait\_seconds — during deliberate pauses +adjust\_response\_latency — when adjusting response timing +next\_step — transitioning between steps in prompt.contexts +change\_context — switching between contexts in prompt.contexts +get\_visual\_input — processing visual input (enable\_vision=true) +get\_ideal\_strategy — thinking (enable\_thinking=true) + +Notably NOT supported: change\_step, gather\_submit, or arbitrary +user-defined SWAIG function names. The runtime only honors fillers +for the names listed above; everything else is silently ignored at +the SWML level. This method warns at registration time if you pass +an unknown name so you catch the typo early. + +## Signature + +```typescript +setInternalFillers( + internalFillers: Record> +): this +``` + +## Parameters + + + Map of function name to language-keyed filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setInternalFillers({ + next_step: { + 'en-US': ['Moving to the next step...', 'Great, let us continue...'], + 'es': ['Pasando al siguiente paso...'] + }, + check_time: { + 'en-US': ['Let me check the time...'] + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 909. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-language-params.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-language-params.mdx new file mode 100644 index 0000000000..ab821d3b4a --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-language-params.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-language-params" +title: "setLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setLanguageParams" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguageParams` + +Set (or replace) the per-language `params` dict on an already-added +language. Useful when language entries are built up via [addLanguage](/reference/typescript/agent-base/agent-base/add-language) +first and engine-specific tuning is added later (e.g., from a config +loader). + +Python parity: `set_language_params(code, params)`. Passing an empty +object removes the `params` key entirely. Unknown codes are a no-op. + +## Signature + +```typescript +setLanguageParams(code: string, params: Record): this +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/agent-base/agent-base/add-language) (e.g. `"en-US"`). + + + + Engine-specific params dict to attach. Empty object removes the key. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 736. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-languages.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-languages.mdx new file mode 100644 index 0000000000..190c705038 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-languages.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-languages" +title: "setLanguages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setLanguages" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguages` + +Replace all configured languages with a new list. + +## Signature + +```typescript +setLanguages(languages: LanguageConfig[]): this +``` + +## Parameters + + + Array of language configurations. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 717. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-native-functions.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-native-functions.mdx new file mode 100644 index 0000000000..0d3928300c --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-native-functions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-native-functions" +title: "setNativeFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setNativeFunctions" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setNativeFunctions` + +Set the list of native SWAIG function names (built-in platform functions). + +## Signature + +```typescript +setNativeFunctions(funcs: string[]): this +``` + +## Parameters + + + Array of native function names. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 847. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-on-request-callback.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-on-request-callback.mdx new file mode 100644 index 0000000000..d1989a2172 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-on-request-callback.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-on-request-callback" +title: "setOnRequestCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setOnRequestCallback" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `setOnRequestCallback` + +Set a callback invoked per-request to dynamically build SWML. +When set, the static SwmlBuilder is ignored and the callback's +returned SwmlBuilder is used instead. + +## Signature + +```typescript +setOnRequestCallback(cb: OnRequestCallback): this +``` + +## Parameters + + + Callback receiving query params, body params, and headers. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 850. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-param.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-param.mdx new file mode 100644 index 0000000000..2acf32c310 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-param.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-param" +title: "setParam" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setParam" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParam` + +Set a single AI parameter (e.g. "temperature", "top\_p"). + +## Signature + +```typescript +setParam(key: string, value: unknown): this +``` + +## Parameters + + + Parameter name. + + + + Parameter value. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 799. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-params.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-params.mdx new file mode 100644 index 0000000000..5bbbe74f36 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-params" +title: "setParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setParams" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParams` + +Merge multiple AI parameters into the existing params object. + +## Signature + +```typescript +setParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 809. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..9fc8b48749 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-post-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-post-prompt-llm-params" +title: "setPostPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setPostPromptLlmParams" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptLlmParams` + +Merge LLM-specific parameters into the post-prompt configuration. + +## Signature + +```typescript +setPostPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1000. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-post-prompt-url.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-post-prompt-url.mdx new file mode 100644 index 0000000000..ee6af7f3f5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-post-prompt-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-post-prompt-url" +title: "setPostPromptUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setPostPromptUrl" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptUrl` + +Override the default post-prompt webhook URL with a custom one. + +## Signature + +```typescript +setPostPromptUrl(url: string): this +``` + +## Parameters + + + The custom post-prompt URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1828. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-post-prompt.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-post-prompt.mdx new file mode 100644 index 0000000000..eaab3cf509 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-post-prompt" +title: "setPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setPostPrompt" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPrompt` + +Set the post-prompt text evaluated after the call ends. + +## Signature + +```typescript +setPostPrompt(text: string): this +``` + +## Parameters + + + The post-prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 455. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..1e48528a4d --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-prompt-llm-params" +title: "setPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setPromptLlmParams" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptLlmParams` + +Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + +## Signature + +```typescript +setPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 990. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-prompt-pom.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-prompt-pom.mdx new file mode 100644 index 0000000000..4a08ae8d85 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-prompt-pom.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-prompt-pom" +title: "setPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setPromptPom" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptPom` + +Set the prompt as a POM (Prompt Object Model) dictionary. + +Replaces the current POM sections with the provided structured data. +Each entry should have `title`, and optionally `body`, `bullets`, +`numbered`, `numberedBullets`, and `subsections`. + +## Signature + +```typescript +setPromptPom(pom: Record[]): this +``` + +## Parameters + + + Array of POM section dictionaries. + + +## Returns + +`this` — This agent instance for chaining. + +## Throws + +- Error if POM mode is not enabled (`usePom: false`). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 576. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-prompt-text.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-prompt-text.mdx new file mode 100644 index 0000000000..e482106e1e --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-prompt-text.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-prompt-text" +title: "setPromptText" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setPromptText" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptText` + +Set the main system prompt text for the AI. + +## Signature + +```typescript +setPromptText(text: string): this +``` + +## Parameters + + + The prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 445. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-pronunciations.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-pronunciations.mdx new file mode 100644 index 0000000000..f81b2c4035 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-pronunciations.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-pronunciations" +title: "setPronunciations" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setPronunciations" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPronunciations` + +Replace all pronunciation rules with a new list. + +## Signature + +```typescript +setPronunciations(rules: PronunciationRule[]): this +``` + +## Parameters + + + Array of pronunciation rule objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 785. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/set-web-hook-url.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-web-hook-url.mdx new file mode 100644 index 0000000000..21c719a5ad --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/set-web-hook-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/set-web-hook-url" +title: "setWebHookUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setWebHookUrl" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setWebHookUrl` + +Override the default SWAIG webhook URL with a custom one. + +## Signature + +```typescript +setWebHookUrl(url: string): this +``` + +## Parameters + + + The custom webhook URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1818. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/setup-graceful-shutdown.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/setup-graceful-shutdown.mdx new file mode 100644 index 0000000000..f3eb568f86 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/setup-graceful-shutdown.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/setup-graceful-shutdown" +title: "setupGracefulShutdown" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.setupGracefulShutdown" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setupGracefulShutdown` + +Register process signal handlers for clean Kubernetes/Docker shutdown. +Handles SIGTERM and SIGINT, waits for a timeout, then exits. + +**Modifiers:** `static` + +## Signature + +```typescript +setupGracefulShutdown(opts?: { ...1 fields }): void +``` + +## Parameters + + + Optional timeout in milliseconds (default 5000). + + + + +## Returns + +`void` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2732. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/stop.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/stop.mdx new file mode 100644 index 0000000000..789a21ce13 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.stop" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `stop` + +Stop the HTTP server. +Mirrors Python's `stop()`. + +## Signature + +```typescript +stop(): void +``` + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 1009. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..0e25fc7012 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/swaig-pre-dispatch.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/swaig-pre-dispatch" +title: "swaigPreDispatch" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.swaigPreDispatch" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `swaigPreDispatch` + +Extension point: invoked between argument parsing and function dispatch +on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is +non-null, it's returned directly without dispatching. AgentBase may +override to add session-token validation or ephemeral dynamic-config. + +## Signature + +```typescript +swaigPreDispatch( + _requestData: Record, + _funcName: string +): [SWMLService, unknown] +``` + +## Parameters + + + + + +## Returns + +`[SWMLService, unknown]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 592. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/update-global-data.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/update-global-data.mdx new file mode 100644 index 0000000000..84caa166c1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/update-global-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/update-global-data" +title: "updateGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.updateGlobalData" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `updateGlobalData` + +Merge additional entries into the existing global\_data object. + +## Signature + +```typescript +updateGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 837. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/validate-basic-auth.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/validate-basic-auth.mdx new file mode 100644 index 0000000000..09a8f044ce --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/validate-basic-auth.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/validate-basic-auth" +title: "validateBasicAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.validateBasicAuth" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateBasicAuth` + +Override to add custom basic-auth validation logic beyond credential matching. + +## Signature + +```typescript +validateBasicAuth( + _username: string, + _password: string +): boolean | Promise +``` + +## Parameters + + + The username from the request. + + + + The password from the request. + + +## Returns + +`boolean | Promise` — True if the credentials are valid; false to reject the request. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1961. diff --git a/fern/products/sdk-reference/typescript/agent-base/agent-base/validate-tool-token.mdx b/fern/products/sdk-reference/typescript/agent-base/agent-base/validate-tool-token.mdx new file mode 100644 index 0000000000..27ae4f017b --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/agent-base/validate-tool-token.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/agent-base/agent-base/validate-tool-token" +title: "validateToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentBase.AgentBase.validateToolToken" + parent: "AgentBase.AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateToolToken` + +Validate a tool-call token for the given function. + +Mirrors Python reference `core/mixins/state_mixin.py validate_tool_token`: + +1. Unknown function → `false`. +2. Registered but non-secure → `true` without consulting SessionManager + (non-secure tools never require a token). +3. Raw-dict descriptors (e.g. DataMap) are treated as secure, matching + Python's `isinstance(func, dict) → is_secure = True` branch. +4. Missing token on a secure tool → `false`. +5. Otherwise delegate to `SessionManager.validateToolToken`. + +Divergences from the Python reference: + +- No debug-logging branch: `AgentBase` does not expose an agent-level + debug-mode flag, so the per-call debug telemetry Python emits is + omitted. `SessionManager` still logs its own validation outcomes. +- No token-derived call-id fallback: `SessionManager.debugToken` + truncates the embedded call-id for log safety, so an extracted value + cannot be round-tripped back through `validateToolToken`. The caller + is expected to supply a non-empty `callId`; an empty one is forwarded + unchanged and the underlying validator will reject it. + +## Signature + +```typescript +validateToolToken(functionName: string, token: string, callId: string): boolean +``` + +## Parameters + + + + + + + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1447. diff --git a/fern/products/sdk-reference/typescript/agent-base/index.mdx b/fern/products/sdk-reference/typescript/agent-base/index.mdx new file mode 100644 index 0000000000..8012ce4d99 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/agent-base" +title: "AgentBase" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `AgentBase` + +## Signature + +```typescript +module AgentBase +``` + +## Type Aliases + + + + Callback invoked at a registered routing endpoint to determine how to handle an incoming request. Return a route string to redirect to that agent route, or null / undefined to let normal SWML processing continue. + + + +## Classes + + + + Core agent class that composes an HTTP server, prompt management, session handling, SWAIG tool registry, and 5-phase SWML rendering into a single deployable unit. + + + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/agent-base/routing-callback.mdx b/fern/products/sdk-reference/typescript/agent-base/routing-callback.mdx new file mode 100644 index 0000000000..f11213c44e --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-base/routing-callback.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/agent-base/routing-callback" +title: "RoutingCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "AgentBase.RoutingCallback" + parent: "AgentBase" + module: "AgentBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `RoutingCallback` + +Callback invoked at a registered routing endpoint to determine how to handle an +incoming request. Return a route string to redirect to that agent route, or +null / undefined to let normal SWML processing continue. + +Mirrors Python `web_mixin.register_routing_callback` callback signature (body-only +variant — Hono request object is not forwarded; use the parsed body instead). + +## Signature + +```typescript +type RoutingCallback = (body: Record) => string | null | undefined | Promise +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 45. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/constructor.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/constructor.mdx new file mode 100644 index 0000000000..e1e2513ee1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/constructor.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/agent-server/agent-server/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentServer.AgentServer.constructor" + parent: "AgentServer.AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `constructor` + +Create an AgentServer. + +## Signature + +```typescript +constructor(opts?: { ...3 fields }): AgentServer +``` + +## Parameters + + + Optional host, port, and logLevel overrides; defaults to 0.0.0.0:3000, logLevel 'info'. + + + + + + + + +## Returns + +`AgentServer` + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 97. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/get-agent.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/get-agent.mdx new file mode 100644 index 0000000000..04cfef1032 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/get-agent.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-server/agent-server/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentServer.AgentServer.getAgent" + parent: "AgentServer.AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `getAgent` + +Look up a registered agent by its route prefix. + +## Signature + +```typescript +getAgent(route: string): AgentBase | undefined +``` + +## Parameters + + + The route prefix to look up. + + +## Returns + +`AgentBase | undefined` — The agent at that route, or undefined if none is registered. + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 191. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/get-agents.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/get-agents.mdx new file mode 100644 index 0000000000..d6eb1591c6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/get-agents.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-server/agent-server/get-agents" +title: "getAgents" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentServer.AgentServer.getAgents" + parent: "AgentServer.AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `getAgents` + +Get all registered agents keyed by their route prefix. + +## Signature + +```typescript +getAgents(): Map +``` + +## Returns + +`Map` — A map of route prefixes to AgentBase instances. + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 182. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/get-app.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/get-app.mdx new file mode 100644 index 0000000000..d96ff620db --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/get-app.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-server/agent-server/get-app" +title: "getApp" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentServer.AgentServer.getApp" + parent: "AgentServer.AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `getApp` + +Build and return the Hono application with all registered agents and a root listing endpoint. + +## Signature + +```typescript +getApp(): Hono +``` + +## Returns + +`Hono` — The fully configured Hono app. + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 384. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/index.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/index.mdx new file mode 100644 index 0000000000..5edcc866c7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/index.mdx @@ -0,0 +1,118 @@ +--- +slug: "/reference/typescript/agent-server/agent-server" +title: "AgentServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "AgentServer.AgentServer" + parent: "AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `AgentServer` + +Multi-agent HTTP server that hosts multiple AgentBase instances on distinct route prefixes. + +Use `AgentServer` when one process should serve more than one agent — each with its own +prompt, tools, and route. Internally, each agent's Hono router is mounted under its own +path. Static assets can also be served from a configured directory. + +## Signature + +```typescript +class AgentServer +``` + +## Examples + +```typescript +import { AgentServer, AgentBase } from '@signalwire/sdk'; + +const salesAgent = new AgentBase({ name: 'sales', route: '/sales' }); +const supportAgent = new AgentBase({ name: 'support', route: '/support' }); + +const server = new AgentServer({ host: '0.0.0.0', port: 3000 }); +server.register(salesAgent); +server.register(supportAgent); + +await server.run(); +``` + +## See Also + +- \[[AgentBase](/reference/typescript/agent-base)]\(xref://[AgentBase](/reference/typescript/agent-base)) + +## Properties + + + Hostname the server binds to. + + + + Public logger for this server instance. + + + + Logging level (debug, info, warn, error). + + + + Port the server listens on. + + +## Methods + + + + Create an AgentServer. + + + + Look up a registered agent by its route prefix. + + + + Get all registered agents keyed by their route prefix. + + + + Build and return the Hono application with all registered agents and a root listing endpoint. + + + + Register an agent at the given route prefix. + + + + Register a routing callback across all agents at the given path. + + + + Register a mapping from a SIP username to an agent route at the server level. + + + + Start the HTTP server and begin listening for requests. + + + + Serve static files from a local directory under a given route prefix. Includes path traversal protection (rejects `..`), MIME type detection, and security headers (Cache-Control, X-Content-Type-Options). + + + + Set up central SIP-based routing for the server. + + + + Remove an agent registration by route. + + + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 70. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/register-global-routing-callback.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/register-global-routing-callback.mdx new file mode 100644 index 0000000000..f18b7058a7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/register-global-routing-callback.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/agent-server/agent-server/register-global-routing-callback" +title: "registerGlobalRoutingCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentServer.AgentServer.registerGlobalRoutingCallback" + parent: "AgentServer.AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `registerGlobalRoutingCallback` + +Register a routing callback across all agents at the given path. + +This allows unified routing logic to be applied to all agents from +a central server-level coordinator. + +## Signature + +```typescript +registerGlobalRoutingCallback(callbackFn: RoutingCallback, path: string): void +``` + +## Parameters + + + The callback function that receives a request and body, returning a route string or undefined. + + + + The path to register the callback at. + + +## Returns + +`void` + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 338. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/register-sip-username.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/register-sip-username.mdx new file mode 100644 index 0000000000..835b660948 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/register-sip-username.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/agent-server/agent-server/register-sip-username" +title: "registerSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentServer.AgentServer.registerSipUsername" + parent: "AgentServer.AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `registerSipUsername` + +Register a mapping from a SIP username to an agent route at the server level. + +Allows callers to manually route an arbitrary SIP username to any already-registered +agent route, independent of the automatic mapping performed by `setupSipRouting`. + +## Signature + +```typescript +registerSipUsername(username: string, route: string): void +``` + +## Parameters + + + The SIP username to map (stored lowercase). + + + + The agent route to map the username to (leading `/` added if missing; trailing slashes stripped). + + +## Returns + +`void` + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 310. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/register.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/register.mdx new file mode 100644 index 0000000000..7ba4c280ac --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/register.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/agent-server/agent-server/register" +title: "register" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentServer.AgentServer.register" + parent: "AgentServer.AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `register` + +Register an agent at the given route prefix. + +## Signature + +```typescript +register(agent: AgentBase, route?: string): void +``` + +## Parameters + + + The AgentBase instance to mount. + + + + Route prefix; defaults to the agent's own route or '/'. + + +## Returns + +`void` + +## Throws + +- If the route is already occupied by another agent. + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 132. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/run.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/run.mdx new file mode 100644 index 0000000000..b33032623d --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/run.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/agent-server/agent-server/run" +title: "run" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentServer.AgentServer.run" + parent: "AgentServer.AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `run` + +Start the HTTP server and begin listening for requests. + +This method handles server mode only. For serverless deployments +(AWS Lambda, Google Cloud Functions, Azure Functions), use +[ServerlessAdapter](/reference/typescript/serverless-adapter) instead. When `SWAIG_CLI_MODE=true` is set in +the environment, the call is a no-op so agent config can be inspected +without starting a server. + +## Signature + +```typescript +run(host?: string, port?: number): Promise +``` + +## Parameters + + + Override the configured hostname. Defaults to the constructor value. + + + + Override the configured port. Defaults to the constructor value. + + +## Returns + +`Promise` — Resolves once the underlying Hono server has begun listening. + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 420. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/serve-static-files.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/serve-static-files.mdx new file mode 100644 index 0000000000..7b62b6a7fe --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/serve-static-files.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/agent-server/agent-server/serve-static-files" +title: "serveStaticFiles" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentServer.AgentServer.serveStaticFiles" + parent: "AgentServer.AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `serveStaticFiles` + +Serve static files from a local directory under a given route prefix. +Includes path traversal protection (rejects `..`), MIME type detection, +and security headers (Cache-Control, X-Content-Type-Options). + +## Signature + +```typescript +serveStaticFiles(directory: string, route: string = '/'): void +``` + +## Parameters + + + Absolute or relative path to the directory to serve. + + + + Route prefix for static files (defaults to '/'). + + +## Returns + +`void` + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 202. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/setup-sip-routing.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/setup-sip-routing.mdx new file mode 100644 index 0000000000..1199751a70 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/setup-sip-routing.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/agent-server/agent-server/setup-sip-routing" +title: "setupSipRouting" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentServer.AgentServer.setupSipRouting" + parent: "AgentServer.AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `setupSipRouting` + +Set up central SIP-based routing for the server. + +This configures all agents to handle SIP requests at the specified path, +using a coordinated routing system where each agent checks if it can +handle SIP requests for specific usernames. + +## Signature + +```typescript +setupSipRouting(route: string = '/sip', autoMap: boolean = true): void +``` + +## Parameters + + + The path for SIP routing (default: '/sip'). + + + + Whether to automatically map SIP usernames to agent routes (default: true). + + +## Returns + +`void` + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 254. diff --git a/fern/products/sdk-reference/typescript/agent-server/agent-server/unregister.mdx b/fern/products/sdk-reference/typescript/agent-server/agent-server/unregister.mdx new file mode 100644 index 0000000000..b37ea810f7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/agent-server/unregister.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/agent-server/agent-server/unregister" +title: "unregister" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AgentServer.AgentServer.unregister" + parent: "AgentServer.AgentServer" + module: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `unregister` + +Remove an agent registration by route. + +## Signature + +```typescript +unregister(route: string): boolean +``` + +## Parameters + + + The route prefix to unregister. + + +## Returns + +`boolean` — True if the agent was found and removed, false if not found. + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 172. diff --git a/fern/products/sdk-reference/typescript/agent-server/index.mdx b/fern/products/sdk-reference/typescript/agent-server/index.mdx new file mode 100644 index 0000000000..a5cf60722a --- /dev/null +++ b/fern/products/sdk-reference/typescript/agent-server/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/agent-server" +title: "AgentServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "AgentServer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts" +--- +# `AgentServer` + +## Signature + +```typescript +module AgentServer +``` + +## Classes + + + + Multi-agent HTTP server that hosts multiple AgentBase instances on distinct route prefixes. + + + +## Source + +[`src/AgentServer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentServer.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-config/index.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-config/index.mdx new file mode 100644 index 0000000000..020f968651 --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-config/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/auth-handler/auth-config" +title: "AuthConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "AuthHandler.AuthConfig" + parent: "AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `AuthConfig` + +Configuration for one or more authentication methods checked by [AuthHandler](/reference/typescript/auth-handler). + +## Signature + +```typescript +interface AuthConfig +``` + +## Properties + + + When explicitly set to false, deny requests if no auth methods are configured. + + + + API key matched against the X-Api-Key header. + + + + Custom header name for API key lookup (default: 'X-Api-Key'). + + + + Basic auth credentials as a \[username, password] tuple. + + + + Bearer token matched against the Authorization header. + + + + Custom validator function; return true to allow the request. + + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 14. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/constructor.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/constructor.mdx new file mode 100644 index 0000000000..b597681eb0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler.constructor" + parent: "AuthHandler.AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `constructor` + +Create a new AuthHandler. + +## Signature + +```typescript +constructor(config: AuthConfig): AuthHandler +``` + +## Parameters + + + Authentication configuration specifying one or more auth methods. + + +## Returns + +`AuthHandler` + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 50. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/express-middleware.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/express-middleware.mdx new file mode 100644 index 0000000000..3cd6161ce2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/express-middleware.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler/express-middleware" +title: "expressMiddleware" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler.expressMiddleware" + parent: "AuthHandler.AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `expressMiddleware` + +Create an Express/Connect-compatible middleware adapter. + +This serves as the framework-agnostic equivalent of Python's +`get_fastapi_dependency`. For standalone validation without a +framework, use [validate](/reference/typescript/auth-handler/auth-handler/validate) directly. + +## Signature + +```typescript +expressMiddleware( + optional: boolean = false +): (req: any, res: any, next: () => void) => Promise +``` + +## Parameters + + + When true, unauthenticated requests are allowed through (default: false). + + +## Returns + +`(req: any, res: any, next: () => void) => Promise` — An Express-compatible middleware function. + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 186. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/get-auth-info.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/get-auth-info.mdx new file mode 100644 index 0000000000..2afa08f8b8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/get-auth-info.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler/get-auth-info" +title: "getAuthInfo" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler.getAuthInfo" + parent: "AuthHandler.AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `getAuthInfo` + +Get information about configured authentication methods. + +Returns structured metadata describing each enabled auth method, +including usernames, header names, and usage hints. + +## Signature + +```typescript +getAuthInfo(): { apiKey?: { enabled: true; header: string; hint: string }; basic?: { enabled: true; username: string }; bearer?: { enabled: true; hint: string } } +``` + +## Returns + +`{ apiKey?: { enabled: true; header: string; hint: string }; basic?: { enabled: true; username: string }; bearer?: { enabled: true; hint: string } }` — An object describing the enabled auth methods and their configuration. + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 206. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/has-api-key-auth.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/has-api-key-auth.mdx new file mode 100644 index 0000000000..775d01cb5c --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/has-api-key-auth.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler/has-api-key-auth" +title: "hasApiKeyAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler.hasApiKeyAuth" + parent: "AuthHandler.AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `hasApiKeyAuth` + +Check whether API key authentication is configured. + +## Signature + +```typescript +hasApiKeyAuth(): boolean +``` + +## Returns + +`boolean` — True if an API key has been set. + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 245. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/has-basic-auth.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/has-basic-auth.mdx new file mode 100644 index 0000000000..7aa82829de --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/has-basic-auth.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler/has-basic-auth" +title: "hasBasicAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler.hasBasicAuth" + parent: "AuthHandler.AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `hasBasicAuth` + +Check whether Basic authentication is configured. + +## Signature + +```typescript +hasBasicAuth(): boolean +``` + +## Returns + +`boolean` — True if basic auth credentials have been set. + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 253. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/has-bearer-auth.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/has-bearer-auth.mdx new file mode 100644 index 0000000000..51e399e49f --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/has-bearer-auth.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler/has-bearer-auth" +title: "hasBearerAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler.hasBearerAuth" + parent: "AuthHandler.AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `hasBearerAuth` + +Check whether Bearer token authentication is configured. + +## Signature + +```typescript +hasBearerAuth(): boolean +``` + +## Returns + +`boolean` — True if a bearer token has been set. + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 237. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/index.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/index.mdx new file mode 100644 index 0000000000..6fa8671209 --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler" +title: "AuthHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler" + parent: "AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `AuthHandler` + +Multi-method authentication handler with timing-safe credential comparison. + +## Signature + +```typescript +class AuthHandler +``` + +## Properties + + + The authentication configuration for this handler. + + +## Methods + + + + Create a new AuthHandler. + + + + Create an Express/Connect-compatible middleware adapter. + + + + Get information about configured authentication methods. + + + + Check whether API key authentication is configured. + + + + Check whether Basic authentication is configured. + + + + Check whether Bearer token authentication is configured. + + + + Create a Hono-compatible middleware that rejects unauthorized requests with a 401 response. + + + + Validate request headers against configured auth methods (Bearer, API Key, Basic, Custom) in order. + + + + Verify an API key against the configured key. + + + + Verify a Basic Auth username/password pair against the configured credentials. + + + + Verify a Bearer token against the configured token. + + + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 42. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/middleware.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/middleware.mdx new file mode 100644 index 0000000000..91a1ee98be --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/middleware.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler/middleware" +title: "middleware" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler.middleware" + parent: "AuthHandler.AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `middleware` + +Create a Hono-compatible middleware that rejects unauthorized requests with a 401 response. + +## Signature + +```typescript +middleware( + optional: boolean = false +): (c: any, next: () => Promise) => Promise +``` + +## Parameters + + + When true, unauthenticated requests are allowed through instead of being rejected (default: false). + + +## Returns + +`(c: any, next: () => Promise) => Promise` — A middleware function suitable for use with Hono's `app.use()`. + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 163. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/validate.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/validate.mdx new file mode 100644 index 0000000000..e29909b87f --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/validate.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler/validate" +title: "validate" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler.validate" + parent: "AuthHandler.AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `validate` + +Validate request headers against configured auth methods (Bearer, API Key, Basic, Custom) in order. + +## Signature + +```typescript +validate(headers: Record): Promise +``` + +## Parameters + + + The request headers as a string-keyed record. + + +## Returns + +`Promise` — True if any configured method accepts the request, or if no methods are configured. + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 59. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/verify-api-key.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/verify-api-key.mdx new file mode 100644 index 0000000000..314b219a5b --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/verify-api-key.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler/verify-api-key" +title: "verifyApiKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler.verifyApiKey" + parent: "AuthHandler.AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `verifyApiKey` + +Verify an API key against the configured key. + +Returns false immediately if API key auth is not configured. +Uses constant-time comparison to prevent timing attacks. + +## Signature + +```typescript +verifyApiKey(key: string): boolean +``` + +## Parameters + + + The API key string to verify. + + +## Returns + +`boolean` — True if the key matches the configured API key. + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 153. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/verify-basic-auth.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/verify-basic-auth.mdx new file mode 100644 index 0000000000..b0eae7203e --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/verify-basic-auth.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler/verify-basic-auth" +title: "verifyBasicAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler.verifyBasicAuth" + parent: "AuthHandler.AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `verifyBasicAuth` + +Verify a Basic Auth username/password pair against the configured credentials. + +Returns false immediately if Basic Auth is not configured. +Uses constant-time comparison to prevent timing attacks. + +## Signature + +```typescript +verifyBasicAuth(username: string, password: string): boolean +``` + +## Parameters + + + The username to verify. + + + + The password to verify. + + +## Returns + +`boolean` — True if the credentials match the configured Basic Auth credentials. + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 124. diff --git a/fern/products/sdk-reference/typescript/auth-handler/auth-handler/verify-bearer-token.mdx b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/verify-bearer-token.mdx new file mode 100644 index 0000000000..f5f67d64d7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/auth-handler/verify-bearer-token.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/auth-handler/auth-handler/verify-bearer-token" +title: "verifyBearerToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "AuthHandler.AuthHandler.verifyBearerToken" + parent: "AuthHandler.AuthHandler" + module: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `verifyBearerToken` + +Verify a Bearer token against the configured token. + +Returns false immediately if Bearer token auth is not configured. +Uses constant-time comparison to prevent timing attacks. + +## Signature + +```typescript +verifyBearerToken(token: string): boolean +``` + +## Parameters + + + The Bearer token string to verify (without the "Bearer " prefix). + + +## Returns + +`boolean` — True if the token matches the configured Bearer token. + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 139. diff --git a/fern/products/sdk-reference/typescript/auth-handler/index.mdx b/fern/products/sdk-reference/typescript/auth-handler/index.mdx new file mode 100644 index 0000000000..5b017efa78 --- /dev/null +++ b/fern/products/sdk-reference/typescript/auth-handler/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/auth-handler" +title: "AuthHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "AuthHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts" +--- +# `AuthHandler` + +## Signature + +```typescript +module AuthHandler +``` + +## Classes + + + + Multi-method authentication handler with timing-safe credential comparison. + + + +## Interfaces + + + + Configuration for one or more authentication methods checked by [AuthHandler](/reference/typescript/auth-handler). + + + +## Source + +[`src/AuthHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AuthHandler.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/cli/agent-loader/index.mdx b/fern/products/sdk-reference/typescript/cli/agent-loader/index.mdx new file mode 100644 index 0000000000..674ccad363 --- /dev/null +++ b/fern/products/sdk-reference/typescript/cli/agent-loader/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/cli/agent-loader" +title: "agent-loader" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "cli.agent-loader" + module: "cli" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/agent-loader.ts" +--- +# `agent-loader` + +## Signature + +```typescript +module agent-loader +``` + +## Functions + + + + List all exported agent instances and classes in a module. + + + + Dynamically import an agent file and resolve an AgentBase instance using duck-typing heuristics. + + + +## Source + +[`src/cli/agent-loader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/agent-loader.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/cli/agent-loader/list-agents.mdx b/fern/products/sdk-reference/typescript/cli/agent-loader/list-agents.mdx new file mode 100644 index 0000000000..11740b5210 --- /dev/null +++ b/fern/products/sdk-reference/typescript/cli/agent-loader/list-agents.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/cli/agent-loader/list-agents" +title: "listAgents" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "cli.agent-loader.listAgents" + parent: "cli.agent-loader" + module: "cli.agent-loader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/agent-loader.ts" +--- +# `listAgents` + +List all exported agent instances and classes in a module. + +## Signature + +```typescript +listAgents(agentPath: string): Promise +``` + +## Parameters + + + Path to the agent module file. + + +## Returns + +`Promise` — Array of export names that are AgentBase instances or subclasses. + +## Source + +[`src/cli/agent-loader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/agent-loader.ts) + +Line 157. diff --git a/fern/products/sdk-reference/typescript/cli/agent-loader/load-agent.mdx b/fern/products/sdk-reference/typescript/cli/agent-loader/load-agent.mdx new file mode 100644 index 0000000000..622d75f245 --- /dev/null +++ b/fern/products/sdk-reference/typescript/cli/agent-loader/load-agent.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/cli/agent-loader/load-agent" +title: "loadAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "cli.agent-loader.loadAgent" + parent: "cli.agent-loader" + module: "cli.agent-loader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/agent-loader.ts" +--- +# `loadAgent` + +Dynamically import an agent file and resolve an AgentBase instance using duck-typing heuristics. + +## Signature + +```typescript +loadAgent(agentPath: string, agentClass?: string): Promise +``` + +## Parameters + + + Path to the agent module file. + + + + Optional name of a specific exported class or instance to use. + + +## Returns + +`Promise` — The resolved AgentBase instance. + +## Source + +[`src/cli/agent-loader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/agent-loader.ts) + +Line 86. diff --git a/fern/products/sdk-reference/typescript/cli/mock-data/generate-fake-post-data.mdx b/fern/products/sdk-reference/typescript/cli/mock-data/generate-fake-post-data.mdx new file mode 100644 index 0000000000..9c886e5691 --- /dev/null +++ b/fern/products/sdk-reference/typescript/cli/mock-data/generate-fake-post-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/cli/mock-data/generate-fake-post-data" +title: "generateFakePostData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "cli.mock-data.generateFakePostData" + parent: "cli.mock-data" + module: "cli.mock-data" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/mock-data.ts" +--- +# `generateFakePostData` + +Generate a full mock POST body simulating an inbound SignalWire call request. + +## Signature + +```typescript +generateFakePostData(opts?: MockCallOptions): Record +``` + +## Parameters + + + Optional overrides for call metadata fields. + + +## Returns + +`Record` — A record representing the simulated call POST data. + +## Source + +[`src/cli/mock-data.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/mock-data.ts) + +Line 40. diff --git a/fern/products/sdk-reference/typescript/cli/mock-data/generate-minimal-post-data.mdx b/fern/products/sdk-reference/typescript/cli/mock-data/generate-minimal-post-data.mdx new file mode 100644 index 0000000000..f4ea897fc0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/cli/mock-data/generate-minimal-post-data.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/cli/mock-data/generate-minimal-post-data" +title: "generateMinimalPostData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "cli.mock-data.generateMinimalPostData" + parent: "cli.mock-data" + module: "cli.mock-data" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/mock-data.ts" +--- +# `generateMinimalPostData` + +Generate a minimal mock POST body for executing a single SWAIG function. + +## Signature + +```typescript +generateMinimalPostData( + fnName: string, + args?: Record, + opts?: { ...2 fields } +): Record +``` + +## Parameters + + + Name of the SWAIG function to invoke. + + + + Arguments to pass to the function. + + + + Optional call ID and field overrides. + + + + + + +## Returns + +`Record` — A record representing the minimal POST data for function execution. + +## Source + +[`src/cli/mock-data.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/mock-data.ts) + +Line 89. diff --git a/fern/products/sdk-reference/typescript/cli/mock-data/index.mdx b/fern/products/sdk-reference/typescript/cli/mock-data/index.mdx new file mode 100644 index 0000000000..27d0c7145e --- /dev/null +++ b/fern/products/sdk-reference/typescript/cli/mock-data/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/cli/mock-data" +title: "mock-data" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "cli.mock-data" + module: "cli" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/mock-data.ts" +--- +# `mock-data` + +## Signature + +```typescript +module mock-data +``` + +## Functions + + + + Generate a full mock POST body simulating an inbound SignalWire call request. + + + + Generate a minimal mock POST body for executing a single SWAIG function. + + + +## Interfaces + + + + Options for generating mock call data in CLI testing. + + + +## Source + +[`src/cli/mock-data.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/mock-data.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/cli/mock-data/mock-call-options/index.mdx b/fern/products/sdk-reference/typescript/cli/mock-data/mock-call-options/index.mdx new file mode 100644 index 0000000000..4e91aebd64 --- /dev/null +++ b/fern/products/sdk-reference/typescript/cli/mock-data/mock-call-options/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/cli/mock-data/mock-call-options" +title: "MockCallOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "cli.mock-data.MockCallOptions" + parent: "cli.mock-data" + module: "cli.mock-data" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/mock-data.ts" +--- +# `MockCallOptions` + +Options for generating mock call data in CLI testing. + +## Signature + +```typescript +interface MockCallOptions +``` + +## Properties + + + Direction of the call. + + + + Override the auto-generated call ID. + + + + Current call state (e.g. "active", "ringing", "hold"). + + + + Call transport type. + + + + Caller's phone number. + + + + Additional key-value overrides merged into the post data. + + + + Destination extension or agent name. + + +## Source + +[`src/cli/mock-data.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/mock-data.ts) + +Line 9. diff --git a/fern/products/sdk-reference/typescript/cli/swaig-test/index.mdx b/fern/products/sdk-reference/typescript/cli/swaig-test/index.mdx new file mode 100644 index 0000000000..50af995ac2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/cli/swaig-test/index.mdx @@ -0,0 +1,26 @@ +--- +slug: "/reference/typescript/cli/swaig-test" +title: "swaig-test" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "cli.swaig-test" + module: "cli" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/swaig-test.ts" +--- +# `swaig-test` + +## Signature + +```typescript +module swaig-test +``` + +## Source + +[`src/cli/swaig-test.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/cli/swaig-test.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/constructor.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/constructor.mdx new file mode 100644 index 0000000000..0bf65156f0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/constructor.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.constructor" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `constructor` + +Create a new ConfigLoader, optionally loading a JSON file immediately. + +Accepts a single file path or an array of paths. When given an array, +the loader iterates in order and loads the first file that exists +(mirroring Python's ordered-search behaviour). + +## Signature + +```typescript +constructor(filePaths?: string | string[]): ConfigLoader +``` + +## Parameters + + + Path(s) to a JSON config file to load on construction. + + +## Returns + +`ConfigLoader` + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 33. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/find-config-file.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/find-config-file.mdx new file mode 100644 index 0000000000..d474d2bc47 --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/find-config-file.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/find-config-file" +title: "findConfigFile" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.findConfigFile" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `findConfigFile` + +Find a config file path without loading it. + +Searches service-specific filenames, additional paths, and default paths. +Returns the first found path string or null. + +**Modifiers:** `static` + +## Signature + +```typescript +findConfigFile(serviceName?: string, additionalPaths?: string[]): string | null +``` + +## Parameters + + + Optional service name for service-specific config filenames. + + + + Additional file paths to check. + + +## Returns + +`string | null` — Path to the first config file found, or null. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 109. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/get-all.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/get-all.mdx new file mode 100644 index 0000000000..956fe520db --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/get-all.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/get-all" +title: "getAll" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.getAll" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `getAll` + +Return a shallow copy of the entire configuration object. + +## Signature + +```typescript +getAll(): Record +``` + +## Returns + +`Record` — A copy of the top-level config data. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 247. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/get-config-file.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/get-config-file.mdx new file mode 100644 index 0000000000..219d8e00fd --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/get-config-file.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/get-config-file" +title: "getConfigFile" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.getConfigFile" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `getConfigFile` + +Alias for [getFilePath](/reference/typescript/config-loader/config-loader/get-file-path) — matches the Python SDK's `get_config_file()` method name. + +## Signature + +```typescript +getConfigFile(): string | null +``` + +## Returns + +`string | null` — The file path, or null if config was loaded from an object. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 271. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/get-config.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/get-config.mdx new file mode 100644 index 0000000000..03dd7120c5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/get-config.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.getConfig" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `getConfig` + +Alias for [getAll](/reference/typescript/config-loader/config-loader/get-all) — matches the Python SDK's `get_config()` method name. + +## Signature + +```typescript +getConfig(): Record +``` + +## Returns + +`Record` — A copy of the top-level config data. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 255. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/get-file-path.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/get-file-path.mdx new file mode 100644 index 0000000000..f4b3bd380b --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/get-file-path.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/get-file-path" +title: "getFilePath" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.getFilePath" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `getFilePath` + +Return the absolute path of the loaded config file, if any. + +## Signature + +```typescript +getFilePath(): string | null +``` + +## Returns + +`string | null` — The file path, or null if config was loaded from an object. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 263. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/get-section.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/get-section.mdx new file mode 100644 index 0000000000..7d4274107e --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/get-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/get-section" +title: "getSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.getSection" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `getSection` + +Get an entire configuration section with all environment variables substituted. + +## Signature + +```typescript +getSection(section: string): Record +``` + +## Parameters + + + The top-level section name (e.g. 'security', 'server'). + + +## Returns + +`Record` — The configuration section as an object, or an empty object if not found. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 298. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/get.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/get.mdx new file mode 100644 index 0000000000..9d1d2caa27 --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/get.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.get" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `get` + +Retrieve a configuration value using a dot-notation path (e.g. `'server.port'`). + +## Signature + +```typescript +get(path: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + Dot-separated key path into the config object. + + + + Value returned when the path does not exist. + + +## Returns + +`T` — The resolved value, or defaultValue if not found. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 182. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/has-config.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/has-config.mdx new file mode 100644 index 0000000000..2f7b6534bf --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/has-config.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/has-config" +title: "hasConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.hasConfig" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `hasConfig` + +Check if a configuration was loaded. + +**Deliberate deviation from Python `has_config()`:** Python returns `True` +only when a file was loaded (`self._config is not None`). This TypeScript +implementation also returns `true` when data was loaded via +[loadFromObject](/reference/typescript/config-loader/config-loader/load-from-object), because `loadFromObject` is an extra TS-only method +with no Python equivalent. Treating object-loaded data as "configured" is +the correct semantic for the TS API surface. + +If you need file-load-only detection, check `this.getFilePath() !== null`. + +## Signature + +```typescript +hasConfig(): boolean +``` + +## Returns + +`boolean` — True if configuration data exists (from file or object). + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 289. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/has.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/has.mdx new file mode 100644 index 0000000000..74e2944d2d --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/has.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/has" +title: "has" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.has" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `has` + +Check whether a dot-notation path exists in the loaded configuration. + +## Signature + +```typescript +has(path: string): boolean +``` + +## Parameters + + + Dot-separated key path to check. + + +## Returns + +`boolean` — True if the path resolves to a defined value. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 229. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/index.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/index.mdx new file mode 100644 index 0000000000..e37b4f731c --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/index.mdx @@ -0,0 +1,107 @@ +--- +slug: "/reference/typescript/config-loader/config-loader" +title: "ConfigLoader" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader" + parent: "ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `ConfigLoader` + +JSON configuration file loader with environment variable interpolation and dot-notation access. + +## Signature + +```typescript +class ConfigLoader +``` + +## Properties + + + Get the ordered list of config file paths that were passed/searched. + + +## Methods + + + + Create a new ConfigLoader, optionally loading a JSON file immediately. + + + + Find a config file path without loading it. + + + + Retrieve a configuration value using a dot-notation path (e.g. `'server.port'`). + + + + Return a shallow copy of the entire configuration object. + + + + Alias for [getAll](/reference/typescript/config-loader/config-loader/get-all) — matches the Python SDK's `get_config()` method name. + + + + Alias for [getFilePath](/reference/typescript/config-loader/config-loader/get-file-path) — matches the Python SDK's `get_config_file()` method name. + + + + Return the absolute path of the loaded config file, if any. + + + + Get an entire configuration section with all environment variables substituted. + + + + Check whether a dot-notation path exists in the loaded configuration. + + + + Check if a configuration was loaded. + + + + Interpolate $\{VAR|default\} patterns in a raw string. + + + + Load configuration from a JSON file, performing `${VAR|default}` env var interpolation on the raw text. + + + + Load configuration from a plain object instead of a file, useful for testing or programmatic setup. + + + + Merge configuration with environment variables that match a prefix. + + + + Search for a config file in standard locations. + + + + Set a configuration value at the given dot-notation path, creating intermediate objects as needed. + + + + Recursively substitute `${VAR|default}` environment variables in any value. + + + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 15. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/interpolate-env-vars.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/interpolate-env-vars.mdx new file mode 100644 index 0000000000..80fc9a39c1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/interpolate-env-vars.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/interpolate-env-vars" +title: "interpolateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.interpolateEnvVars" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `interpolateEnvVars` + +Interpolate $\{VAR|default\} patterns in a raw string. + +## Signature + +```typescript +interpolateEnvVars(input: string): string +``` + +## Parameters + + + The string containing env var references. + + +## Returns + +`string` — The string with all env var references resolved. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 439. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/load-from-object.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/load-from-object.mdx new file mode 100644 index 0000000000..be8070ff44 --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/load-from-object.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/load-from-object" +title: "loadFromObject" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.loadFromObject" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `loadFromObject` + +Load configuration from a plain object instead of a file, useful for testing or programmatic setup. + +## Signature + +```typescript +loadFromObject(obj: Record): this +``` + +## Parameters + + + The configuration object to use. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 428. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/load.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/load.mdx new file mode 100644 index 0000000000..48d5c5de7a --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/load.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/load" +title: "load" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.load" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `load` + +Load configuration from a JSON file, performing `${VAR|default}` env var interpolation on the raw text. + +## Signature + +```typescript +load(filePath: string): this +``` + +## Parameters + + + Path to the JSON config file. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 65. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/merge-with-env.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/merge-with-env.mdx new file mode 100644 index 0000000000..6ddc020978 --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/merge-with-env.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/merge-with-env" +title: "mergeWithEnv" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.mergeWithEnv" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `mergeWithEnv` + +Merge configuration with environment variables that match a prefix. + +Config file values take precedence over environment variables. Matching +env var keys are stripped of the prefix, lowercased, split on `_`, and +written into a nested object (e.g. `SWML_FOO_BAR` → `{ foo: { bar: v } }`). +Mirrors Python's `merge_with_env` in +`signalwire/signalwire/core/config_loader.py`. + +## Signature + +```typescript +mergeWithEnv(envPrefix: string = 'SWML_'): Record +``` + +## Parameters + + + Prefix for environment variables to consider (default: `'SWML_'`). + + +## Returns + +`Record` — Merged configuration dictionary. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 367. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/search.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/search.mdx new file mode 100644 index 0000000000..67e524eb63 --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/search.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/search" +title: "search" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.search" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `search` + +Search for a config file in standard locations. + +Default search paths: CWD, `./config`, `$HOME/.signalwire`, +`.swml/`, `$HOME/.swml/`, `/etc/swml/`. + +**Modifiers:** `static` + +## Signature + +```typescript +search( + filename: string, + additionalPaths?: string[], + serviceName?: string +): ConfigLoader | null +``` + +## Parameters + + + The config file name to search for. + + + + Extra directories to search before the defaults. + + + + Optional service name; prepends service-specific filenames to the search. + + +## Returns + +`ConfigLoader | null` — A loaded ConfigLoader if found, or null if the file does not exist in any search path. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 88. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/set.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/set.mdx new file mode 100644 index 0000000000..68b40299f8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/set.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/set" +title: "set" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.set" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `set` + +Set a configuration value at the given dot-notation path, creating intermediate objects as needed. + +## Signature + +```typescript +set(path: string, value: unknown): this +``` + +## Parameters + + + Dot-separated key path into the config object. + + + + The value to store. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 205. diff --git a/fern/products/sdk-reference/typescript/config-loader/config-loader/substitute-vars.mdx b/fern/products/sdk-reference/typescript/config-loader/config-loader/substitute-vars.mdx new file mode 100644 index 0000000000..69daed5402 --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/config-loader/substitute-vars.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/config-loader/config-loader/substitute-vars" +title: "substituteVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ConfigLoader.ConfigLoader.substituteVars" + parent: "ConfigLoader.ConfigLoader" + module: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `substituteVars` + +Recursively substitute `${VAR|default}` environment variables in any value. + +Walks strings, objects, and arrays. Coerces result strings to boolean +(`"true"` / `"false"`) or number when appropriate. + +## Signature + +```typescript +substituteVars(value: unknown, maxDepth: number = 10): unknown +``` + +## Parameters + + + The value to process (string, object, array, or primitive). + + + + Maximum recursion depth to prevent infinite loops (default: 10). + + +## Returns + +`unknown` — The value with all environment variables substituted. + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 316. diff --git a/fern/products/sdk-reference/typescript/config-loader/index.mdx b/fern/products/sdk-reference/typescript/config-loader/index.mdx new file mode 100644 index 0000000000..f267e43e35 --- /dev/null +++ b/fern/products/sdk-reference/typescript/config-loader/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/config-loader" +title: "ConfigLoader" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "ConfigLoader" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts" +--- +# `ConfigLoader` + +## Signature + +```typescript +module ConfigLoader +``` + +## Classes + + + + JSON configuration file loader with environment variable interpolation and dot-notation access. + + + +## Source + +[`src/ConfigLoader.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ConfigLoader.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/context-builder/context-builder/add-context.mdx b/fern/products/sdk-reference/typescript/context-builder/context-builder/add-context.mdx new file mode 100644 index 0000000000..4cc13725df --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context-builder/add-context.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/context-builder/context-builder/add-context" +title: "addContext" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.ContextBuilder.addContext" + parent: "ContextBuilder.ContextBuilder" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addContext` + +Adds a new named context to the builder. + +## Signature + +```typescript +addContext(name: string): Context +``` + +## Parameters + + + The unique context name. A single-context flow must name its only context `"default"`. + + +## Returns + +`Context` — The newly created [Context](/reference/typescript/context-builder/context) for further configuration. + +## Throws + +- When the max-context limit is exceeded or a context with the same name already exists. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 994. diff --git a/fern/products/sdk-reference/typescript/context-builder/context-builder/constructor.mdx b/fern/products/sdk-reference/typescript/context-builder/context-builder/constructor.mdx new file mode 100644 index 0000000000..d09000255d --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context-builder/constructor.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/typescript/context-builder/context-builder/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.ContextBuilder.constructor" + parent: "ContextBuilder.ContextBuilder" + module: "ContextBuilder" +--- +# `constructor` + +## Signature + +```typescript +constructor(): ContextBuilder +``` + +## Returns + +`ContextBuilder` diff --git a/fern/products/sdk-reference/typescript/context-builder/context-builder/get-context.mdx b/fern/products/sdk-reference/typescript/context-builder/context-builder/get-context.mdx new file mode 100644 index 0000000000..ec653d8a8c --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context-builder/get-context.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context-builder/get-context" +title: "getContext" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.ContextBuilder.getContext" + parent: "ContextBuilder.ContextBuilder" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `getContext` + +Returns a context by name. + +## Signature + +```typescript +getContext(name: string): Context | undefined +``` + +## Parameters + + + The context name to retrieve. + + +## Returns + +`Context | undefined` — The matching Context, or undefined if not found. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 1010. diff --git a/fern/products/sdk-reference/typescript/context-builder/context-builder/index.mdx b/fern/products/sdk-reference/typescript/context-builder/context-builder/index.mdx new file mode 100644 index 0000000000..242ad90d83 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context-builder/index.mdx @@ -0,0 +1,130 @@ +--- +slug: "/reference/typescript/context-builder/context-builder" +title: "ContextBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "ContextBuilder.ContextBuilder" + parent: "ContextBuilder" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `ContextBuilder` + +Builder for multi-step, multi-context AI agent workflows. + +A ContextBuilder owns one or more Contexts; each Context owns an ordered +list of Steps. Only one context and one step is active at a time. Per +chat turn, the runtime injects the current step's instructions as a +system message, then asks the LLM for a response. + +## Native tools auto-injected by the runtime + +When a step (or its enclosing context) declares `validSteps` or +`validContexts`, the runtime auto-injects two native tools so the model +can navigate the flow: + +- `next_step(step: enum)` — present when validSteps is set +- `change_context(context: enum)` — present when validContexts is set + +Their `enum` schemas are rewritten on every turn to match whatever +validSteps / validContexts apply to the current step. You do NOT need +to define these tools yourself; they appear automatically. + +A third native tool — `gather_submit` — is injected during gather\_info +questioning (see Step.setGatherInfo / addGatherQuestion). + +These three names — `next_step`, `change_context`, `gather_submit` — +are reserved. ContextBuilder.validate() will reject any agent that +defines a SWAIG tool with one of these names. + +## Function whitelisting (Step.setFunctions) + +Each step may declare a `functions` whitelist. The whitelist is applied +in-memory at the start of each LLM turn. CRITICALLY: if a step does NOT +declare a `functions` field, it INHERITS the previous step's active set. +See Step.setFunctions() for details and examples. + +## Validation + +Call validate() (or toDict(), which calls it) to check that: + +- At least one context is defined +- A single context must be named "default" +- Every context has at least one step +- validSteps references resolve to real step names (or "next") +- validContexts references resolve to real context names +- gather\_info questions are non-empty and have unique keys +- gather\_info completion\_action targets a reachable step +- No user-defined SWAIG tool collides with a reserved native name + +## Signature + +```typescript +class ContextBuilder +``` + +## Examples + +```typescript +import { AgentBase, ContextBuilder } from '@signalwire/sdk'; + +const agent = new AgentBase({ name: 'support', route: '/' }); + +const contexts = new ContextBuilder(); +const flow = contexts.addContext('default'); + +flow.addStep('greeting') + .setText("Greet the caller and ask if they're an existing customer.") + .setValidSteps(['existing', 'new']); + +flow.addStep('existing') + .setText('Ask for the account number and read it back to confirm.'); + +flow.addStep('new') + .setText('Collect name, email, and reason for calling.'); + +agent.defineContexts(contexts); +``` + +## See Also + +- \- \[Context]\(/reference/typescript/context-builder/context) + \- \[Step]\(/reference/typescript/context-builder/step) + \- \[GatherInfo]\(/reference/typescript/context-builder/gather-info) + \- \[AgentBase.defineContexts]\(/reference/typescript/agent-base/agent-base/define-contexts) + +## Methods + + + + Adds a new named context to the builder. + + + + + + Returns a context by name. + + + + Removes all contexts, returning the builder to its initial state. Use this in a dynamic config callback when you need to rebuild contexts from scratch for a specific request. + + + + Validates and serializes all contexts to a plain object for SWML output. + + + + Validates that all contexts have steps, naming constraints are met, and cross-context references are valid. + + + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 957. diff --git a/fern/products/sdk-reference/typescript/context-builder/context-builder/reset.mdx b/fern/products/sdk-reference/typescript/context-builder/context-builder/reset.mdx new file mode 100644 index 0000000000..eb2ffa09f3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context-builder/reset.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/context-builder/context-builder/reset" +title: "reset" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.ContextBuilder.reset" + parent: "ContextBuilder.ContextBuilder" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `reset` + +Removes all contexts, returning the builder to its initial state. +Use this in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```typescript +reset(): this +``` + +## Returns + +`this` — This builder for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 979. diff --git a/fern/products/sdk-reference/typescript/context-builder/context-builder/to-dict.mdx b/fern/products/sdk-reference/typescript/context-builder/context-builder/to-dict.mdx new file mode 100644 index 0000000000..daedc2f4a1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context-builder/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/context-builder/context-builder/to-dict" +title: "toDict" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.ContextBuilder.toDict" + parent: "ContextBuilder.ContextBuilder" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `toDict` + +Validates and serializes all contexts to a plain object for SWML output. + +## Signature + +```typescript +toDict(): Record +``` + +## Returns + +`Record` — A dictionary mapping context names to their serialized representations. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 1162. diff --git a/fern/products/sdk-reference/typescript/context-builder/context-builder/validate.mdx b/fern/products/sdk-reference/typescript/context-builder/context-builder/validate.mdx new file mode 100644 index 0000000000..f031bc466b --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context-builder/validate.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/context-builder/context-builder/validate" +title: "validate" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.ContextBuilder.validate" + parent: "ContextBuilder.ContextBuilder" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `validate` + +Validates that all contexts have steps, naming constraints are met, and cross-context references are valid. + +## Signature + +```typescript +validate(): void +``` + +## Returns + +`void` + +## Throws + +- Error if validation fails. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 1018. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/add-bullets.mdx b/fern/products/sdk-reference/typescript/context-builder/context/add-bullets.mdx new file mode 100644 index 0000000000..d7d9b95d39 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/add-bullets.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/context-builder/context/add-bullets" +title: "addBullets" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.addBullets" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addBullets` + +Adds a POM section with bullets to the context prompt, mutually exclusive with raw prompt text. + +## Signature + +```typescript +addBullets(title: string, bullets: string[]): this +``` + +## Parameters + + + The section heading. + + + + The list of bullet point strings. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 757. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/add-enter-filler.mdx b/fern/products/sdk-reference/typescript/context-builder/context/add-enter-filler.mdx new file mode 100644 index 0000000000..6ea84cc844 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/add-enter-filler.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/context-builder/context/add-enter-filler" +title: "addEnterFiller" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.addEnterFiller" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addEnterFiller` + +Adds enter filler phrases for a specific language. + +## Signature + +```typescript +addEnterFiller(languageCode: string, fillers: string[]): this +``` + +## Parameters + + + The language code (e.g., "en-US"). + + + + Array of filler phrases. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 789. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/add-exit-filler.mdx b/fern/products/sdk-reference/typescript/context-builder/context/add-exit-filler.mdx new file mode 100644 index 0000000000..ebcacf4bc3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/add-exit-filler.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/context-builder/context/add-exit-filler" +title: "addExitFiller" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.addExitFiller" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addExitFiller` + +Adds exit filler phrases for a specific language. + +## Signature + +```typescript +addExitFiller(languageCode: string, fillers: string[]): this +``` + +## Parameters + + + The language code (e.g., "en-US"). + + + + Array of filler phrases. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 801. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/add-section.mdx b/fern/products/sdk-reference/typescript/context-builder/context/add-section.mdx new file mode 100644 index 0000000000..752ecf1dff --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/add-section.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/context-builder/context/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.addSection" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addSection` + +Adds a POM section with a body to the context prompt, mutually exclusive with raw prompt text. + +## Signature + +```typescript +addSection(title: string, body: string): this +``` + +## Parameters + + + The section heading. + + + + The section body text. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 745. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/add-step.mdx b/fern/products/sdk-reference/typescript/context-builder/context/add-step.mdx new file mode 100644 index 0000000000..baeff57bf6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/add-step.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/context-builder/context/add-step" +title: "addStep" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.addStep" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addStep` + +Adds a new step to this context. + +## Signature + +```typescript +addStep(name: string, opts?: { ...5 fields }): Step +``` + +## Parameters + + + The unique step name within this context. + + + + Optional shorthand for task text, bullets, criteria, functions, and valid steps. + + + + + + + + + + + + +## Returns + +`Step` — The newly created Step for further configuration. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 532. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/add-system-bullets.mdx b/fern/products/sdk-reference/typescript/context-builder/context/add-system-bullets.mdx new file mode 100644 index 0000000000..c372d400c1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/add-system-bullets.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/context-builder/context/add-system-bullets" +title: "addSystemBullets" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.addSystemBullets" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addSystemBullets` + +Adds a POM section with bullets to the system prompt, mutually exclusive with raw system prompt text. + +## Signature + +```typescript +addSystemBullets(title: string, bullets: string[]): this +``` + +## Parameters + + + The section heading. + + + + The list of bullet point strings. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 722. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/add-system-section.mdx b/fern/products/sdk-reference/typescript/context-builder/context/add-system-section.mdx new file mode 100644 index 0000000000..5811828be7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/add-system-section.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/context-builder/context/add-system-section" +title: "addSystemSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.addSystemSection" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addSystemSection` + +Adds a POM section to the system prompt, mutually exclusive with raw system prompt text. + +## Signature + +```typescript +addSystemSection(title: string, body: string): this +``` + +## Parameters + + + The section heading. + + + + The section body text. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 710. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/constructor.mdx b/fern/products/sdk-reference/typescript/context-builder/context/constructor.mdx new file mode 100644 index 0000000000..f85bf3f395 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.constructor" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `constructor` + +Creates a new Context. + +## Signature + +```typescript +constructor(name: string): Context +``` + +## Parameters + + + The unique context name. + + +## Returns + +`Context` + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 522. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/get-step.mdx b/fern/products/sdk-reference/typescript/context-builder/context/get-step.mdx new file mode 100644 index 0000000000..09459bba3b --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/get-step.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/get-step" +title: "getStep" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.getStep" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `getStep` + +Returns a step by name. + +## Signature + +```typescript +getStep(name: string): Step | undefined +``` + +## Parameters + + + The step name to retrieve. + + +## Returns + +`Step | undefined` — The matching Step, or undefined if not found. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 562. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/index.mdx b/fern/products/sdk-reference/typescript/context-builder/context/index.mdx new file mode 100644 index 0000000000..f6bd903a9d --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/index.mdx @@ -0,0 +1,135 @@ +--- +slug: "/reference/typescript/context-builder/context" +title: "Context" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "ContextBuilder.Context" + parent: "ContextBuilder" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `Context` + +A named context containing ordered steps, prompt configuration, and navigation rules. + +## Signature + +```typescript +class Context +``` + +## Properties + + + The unique name identifying this context. + + +## Methods + + + + Adds a POM section with bullets to the context prompt, mutually exclusive with raw prompt text. + + + + Adds enter filler phrases for a specific language. + + + + Adds exit filler phrases for a specific language. + + + + Adds a POM section with a body to the context prompt, mutually exclusive with raw prompt text. + + + + Adds a new step to this context. + + + + Adds a POM section with bullets to the system prompt, mutually exclusive with raw system prompt text. + + + + Adds a POM section to the system prompt, mutually exclusive with raw system prompt text. + + + + Creates a new Context. + + + + Returns a step by name. + + + + Moves a step to a new position in the step order. + + + + Removes a step from this context by name. + + + + Sets whether to consolidate conversation history when entering this context. + + + + Sets filler phrases spoken when entering this context, keyed by language code. + + + + Sets filler phrases spoken when exiting this context, keyed by language code. + + + + Sets whether to fully reset conversation history when entering this context. + + + + Set which step the context starts on when entered. + + + + Mark this context as isolated — entering it wipes conversation history. + + + + Sets the post-prompt text for this context. + + + + Sets raw prompt text for this context, mutually exclusive with POM prompt sections. + + + + Sets raw system prompt text, mutually exclusive with system POM sections. + + + + Sets the user prompt text for this context. + + + + Sets which contexts the AI may navigate to from this context. + + + + Sets which steps the AI may navigate to from this context. + + + + Serializes this context and all its steps to a plain object for SWML output. + + + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 498. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/move-step.mdx b/fern/products/sdk-reference/typescript/context-builder/context/move-step.mdx new file mode 100644 index 0000000000..62f4b8b540 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/move-step.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/context-builder/context/move-step" +title: "moveStep" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.moveStep" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `moveStep` + +Moves a step to a new position in the step order. + +## Signature + +```typescript +moveStep(name: string, position: number): this +``` + +## Parameters + + + The step name to move. + + + + The zero-based index to insert at. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 583. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/remove-step.mdx b/fern/products/sdk-reference/typescript/context-builder/context/remove-step.mdx new file mode 100644 index 0000000000..b54c7ac4b3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/remove-step.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/remove-step" +title: "removeStep" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.removeStep" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `removeStep` + +Removes a step from this context by name. + +## Signature + +```typescript +removeStep(name: string): this +``` + +## Parameters + + + The step name to remove. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 571. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-consolidate.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-consolidate.mdx new file mode 100644 index 0000000000..6461920236 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-consolidate.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/set-consolidate" +title: "setConsolidate" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setConsolidate" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setConsolidate` + +Sets whether to consolidate conversation history when entering this context. + +## Signature + +```typescript +setConsolidate(consolidate: boolean): this +``` + +## Parameters + + + Whether to consolidate. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 636. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-enter-fillers.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-enter-fillers.mdx new file mode 100644 index 0000000000..c4775ff550 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-enter-fillers.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/set-enter-fillers" +title: "setEnterFillers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setEnterFillers" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setEnterFillers` + +Sets filler phrases spoken when entering this context, keyed by language code. + +## Signature + +```typescript +setEnterFillers(fillers: Record): this +``` + +## Parameters + + + Map of language codes to arrays of filler phrases. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 768. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-exit-fillers.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-exit-fillers.mdx new file mode 100644 index 0000000000..767d016641 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-exit-fillers.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/set-exit-fillers" +title: "setExitFillers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setExitFillers" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setExitFillers` + +Sets filler phrases spoken when exiting this context, keyed by language code. + +## Signature + +```typescript +setExitFillers(fillers: Record): this +``` + +## Parameters + + + Map of language codes to arrays of filler phrases. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 778. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-full-reset.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-full-reset.mdx new file mode 100644 index 0000000000..5cb1d0ef88 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-full-reset.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/set-full-reset" +title: "setFullReset" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setFullReset" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setFullReset` + +Sets whether to fully reset conversation history when entering this context. + +## Signature + +```typescript +setFullReset(fullReset: boolean): this +``` + +## Parameters + + + Whether to fully reset. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 646. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-initial-step.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-initial-step.mdx new file mode 100644 index 0000000000..b440a13b6f --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-initial-step.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/context-builder/context/set-initial-step" +title: "setInitialStep" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setInitialStep" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setInitialStep` + +Set which step the context starts on when entered. + +By default, a context starts on its first step (index 0). Use this to +skip a preamble step on re-entry via `change_context`. + +## Signature + +```typescript +setInitialStep(stepName: string): this +``` + +## Parameters + + + Name of the step to start on. Must exist in this context (validated by ContextBuilder.validate()). + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 670. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-isolated.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-isolated.mdx new file mode 100644 index 0000000000..899d1beebb --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-isolated.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/context-builder/context/set-isolated" +title: "setIsolated" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setIsolated" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setIsolated` + +Mark this context as isolated — entering it wipes conversation history. + +When `isolated=true` and the context is entered via change\_context, the +runtime wipes the conversation array. The model starts fresh with only +the new context's systemPrompt + step instructions, with no memory of +prior turns. + +EXCEPTION — `reset` overrides the wipe: +If the context also has a `reset` configuration (via consolidate or +full\_reset), the wipe is skipped in favor of the reset behavior. Use +reset with consolidate=true to summarize prior history into a single +message instead of dropping it entirely. + +Use cases: + +- Switching to a sensitive billing flow that should not see prior + small-talk +- Handing off to a different agent persona +- Resetting after a long off-topic detour + +## Signature + +```typescript +setIsolated(isolated: boolean): this +``` + +## Parameters + + + True to wipe conversation history on context entry (subject to the reset exception above). + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 699. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-post-prompt.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-post-prompt.mdx new file mode 100644 index 0000000000..db74053671 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/set-post-prompt" +title: "setPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setPostPrompt" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setPostPrompt` + +Sets the post-prompt text for this context. + +## Signature + +```typescript +setPostPrompt(postPrompt: string): this +``` + +## Parameters + + + The post-prompt string. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 615. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-prompt.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-prompt.mdx new file mode 100644 index 0000000000..5716734466 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/set-prompt" +title: "setPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setPrompt" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setPrompt` + +Sets raw prompt text for this context, mutually exclusive with POM prompt sections. + +## Signature + +```typescript +setPrompt(prompt: string): this +``` + +## Parameters + + + The prompt string. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 733. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-system-prompt.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-system-prompt.mdx new file mode 100644 index 0000000000..4a75820d27 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-system-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/set-system-prompt" +title: "setSystemPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setSystemPrompt" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setSystemPrompt` + +Sets raw system prompt text, mutually exclusive with system POM sections. + +## Signature + +```typescript +setSystemPrompt(systemPrompt: string): this +``` + +## Parameters + + + The system prompt string. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 625. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-user-prompt.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-user-prompt.mdx new file mode 100644 index 0000000000..a0e93fa353 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-user-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/set-user-prompt" +title: "setUserPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setUserPrompt" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setUserPrompt` + +Sets the user prompt text for this context. + +## Signature + +```typescript +setUserPrompt(userPrompt: string): this +``` + +## Parameters + + + The user prompt string. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 656. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-valid-contexts.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-valid-contexts.mdx new file mode 100644 index 0000000000..1a9c349a49 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-valid-contexts.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/set-valid-contexts" +title: "setValidContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setValidContexts" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setValidContexts` + +Sets which contexts the AI may navigate to from this context. + +## Signature + +```typescript +setValidContexts(contexts: string[]): this +``` + +## Parameters + + + List of allowed context names. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 595. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/set-valid-steps.mdx b/fern/products/sdk-reference/typescript/context-builder/context/set-valid-steps.mdx new file mode 100644 index 0000000000..09f5e836ce --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/set-valid-steps.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/context/set-valid-steps" +title: "setValidSteps" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.setValidSteps" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setValidSteps` + +Sets which steps the AI may navigate to from this context. + +## Signature + +```typescript +setValidSteps(steps: string[]): this +``` + +## Parameters + + + List of allowed step names. + + +## Returns + +`this` — This context for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 605. diff --git a/fern/products/sdk-reference/typescript/context-builder/context/to-dict.mdx b/fern/products/sdk-reference/typescript/context-builder/context/to-dict.mdx new file mode 100644 index 0000000000..ed435c81ad --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/context/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/context-builder/context/to-dict" +title: "toDict" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Context.toDict" + parent: "ContextBuilder.Context" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `toDict` + +Serializes this context and all its steps to a plain object for SWML output. + +## Signature + +```typescript +toDict(): Record +``` + +## Returns + +`Record` — A dictionary representation of this context. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 854. diff --git a/fern/products/sdk-reference/typescript/context-builder/create-simple-context.mdx b/fern/products/sdk-reference/typescript/context-builder/create-simple-context.mdx new file mode 100644 index 0000000000..4a32626591 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/create-simple-context.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/create-simple-context" +title: "createSimpleContext" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "ContextBuilder.createSimpleContext" + parent: "ContextBuilder" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `createSimpleContext` + +Creates a standalone Context instance without a ContextBuilder. + +## Signature + +```typescript +createSimpleContext(name: string = 'default'): Context +``` + +## Parameters + + + The context name (defaults to "default"). + + +## Returns + +`Context` — A new Context instance. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 1179. diff --git a/fern/products/sdk-reference/typescript/context-builder/gather-info/add-question.mdx b/fern/products/sdk-reference/typescript/context-builder/gather-info/add-question.mdx new file mode 100644 index 0000000000..24b690a2de --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/gather-info/add-question.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/context-builder/gather-info/add-question" +title: "addQuestion" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.GatherInfo.addQuestion" + parent: "ContextBuilder.GatherInfo" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addQuestion` + +Adds a question to this gather operation. + +## Signature + +```typescript +addQuestion(opts: { ...6 fields }): this +``` + +## Parameters + + + Question configuration including key, question text, and optional type/confirm/prompt/functions. + + + + + + + + + + + + + + +## Returns + +`this` — This GatherInfo for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 105. diff --git a/fern/products/sdk-reference/typescript/context-builder/gather-info/constructor.mdx b/fern/products/sdk-reference/typescript/context-builder/gather-info/constructor.mdx new file mode 100644 index 0000000000..ca818b5e38 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/gather-info/constructor.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/context-builder/gather-info/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.GatherInfo.constructor" + parent: "ContextBuilder.GatherInfo" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `constructor` + +Creates a new GatherInfo. + +## Signature + +```typescript +constructor(opts?: { ...3 fields }): GatherInfo +``` + +## Parameters + + + Optional output key, completion action, and prompt configuration. + + + + + + + + +## Returns + +`GatherInfo` + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 94. diff --git a/fern/products/sdk-reference/typescript/context-builder/gather-info/get-questions.mdx b/fern/products/sdk-reference/typescript/context-builder/gather-info/get-questions.mdx new file mode 100644 index 0000000000..8951ba5edd --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/gather-info/get-questions.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/context-builder/gather-info/get-questions" +title: "getQuestions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.GatherInfo.getQuestions" + parent: "ContextBuilder.GatherInfo" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `getQuestions` + +Returns all questions in this gather operation. + +## Signature + +```typescript +getQuestions(): GatherQuestion[] +``` + +## Returns + +`GatherQuestion[]` — The array of GatherQuestion instances. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 121. diff --git a/fern/products/sdk-reference/typescript/context-builder/gather-info/index.mdx b/fern/products/sdk-reference/typescript/context-builder/gather-info/index.mdx new file mode 100644 index 0000000000..a75102130a --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/gather-info/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/context-builder/gather-info" +title: "GatherInfo" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "ContextBuilder.GatherInfo" + parent: "ContextBuilder" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `GatherInfo` + +Collects structured information from the user through a series of questions. + +## Signature + +```typescript +class GatherInfo +``` + +## Methods + + + + Adds a question to this gather operation. + + + + Creates a new GatherInfo. + + + + Returns all questions in this gather operation. + + + + Serializes this gather operation to a plain object for SWML output. + + + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 84. diff --git a/fern/products/sdk-reference/typescript/context-builder/gather-info/to-dict.mdx b/fern/products/sdk-reference/typescript/context-builder/gather-info/to-dict.mdx new file mode 100644 index 0000000000..f1e8dfbea8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/gather-info/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/context-builder/gather-info/to-dict" +title: "toDict" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.GatherInfo.toDict" + parent: "ContextBuilder.GatherInfo" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `toDict` + +Serializes this gather operation to a plain object for SWML output. + +## Signature + +```typescript +toDict(): Record +``` + +## Returns + +`Record` — A dictionary representation of the gather info and its questions. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 137. diff --git a/fern/products/sdk-reference/typescript/context-builder/gather-question/constructor.mdx b/fern/products/sdk-reference/typescript/context-builder/gather-question/constructor.mdx new file mode 100644 index 0000000000..51c854def8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/gather-question/constructor.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/context-builder/gather-question/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.GatherQuestion.constructor" + parent: "ContextBuilder.GatherQuestion" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `constructor` + +Creates a new GatherQuestion. + +## Signature + +```typescript +constructor(opts: { ...6 fields }): GatherQuestion +``` + +## Parameters + + + Question configuration including key, question text, and optional type/confirm/prompt/functions. + + + + + + + + + + + + + + +## Returns + +`GatherQuestion` + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 51. diff --git a/fern/products/sdk-reference/typescript/context-builder/gather-question/index.mdx b/fern/products/sdk-reference/typescript/context-builder/gather-question/index.mdx new file mode 100644 index 0000000000..2d1da996a3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/gather-question/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/context-builder/gather-question" +title: "GatherQuestion" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "ContextBuilder.GatherQuestion" + parent: "ContextBuilder" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `GatherQuestion` + +Represents a single question within a gather operation. + +## Signature + +```typescript +class GatherQuestion +``` + +## Properties + + + Whether the answer requires user confirmation. + + + + Optional list of SWAIG function names available during this question. + + + + Unique key used to store the answer. + + + + Optional additional prompt context for this question. + + + + The question text presented to the user. + + + + Expected answer type (e.g., "string", "number"). + + +## Methods + + + + Creates a new GatherQuestion. + + + + Serializes this question to a plain object for SWML output. + + + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 33. diff --git a/fern/products/sdk-reference/typescript/context-builder/gather-question/to-dict.mdx b/fern/products/sdk-reference/typescript/context-builder/gather-question/to-dict.mdx new file mode 100644 index 0000000000..e8af09d745 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/gather-question/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/context-builder/gather-question/to-dict" +title: "toDict" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.GatherQuestion.toDict" + parent: "ContextBuilder.GatherQuestion" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `toDict` + +Serializes this question to a plain object for SWML output. + +## Signature + +```typescript +toDict(): Record +``` + +## Returns + +`Record` — A dictionary representation of this question. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 71. diff --git a/fern/products/sdk-reference/typescript/context-builder/index.mdx b/fern/products/sdk-reference/typescript/context-builder/index.mdx new file mode 100644 index 0000000000..ce843507ad --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/context-builder" +title: "ContextBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `ContextBuilder` + +## Signature + +```typescript +module ContextBuilder +``` + +## Constants + + + Reserved tool names auto-injected by the runtime when contexts/steps are present. User-defined SWAIG tools must not collide with these names. ContextBuilder.validate() rejects any agent that registers a user tool sharing one of these names — the runtime would never call the user tool because the native one wins. + + +## Functions + + + + Creates a standalone Context instance without a ContextBuilder. + + + +## Classes + + + + A named context containing ordered steps, prompt configuration, and navigation rules. + + + + Builder for multi-step, multi-context AI agent workflows. + + + + Collects structured information from the user through a series of questions. + + + + Represents a single question within a gather operation. + + + + A single step within a context, with prompt content, criteria, function restrictions, and navigation rules. + + + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/add-bullets.mdx b/fern/products/sdk-reference/typescript/context-builder/step/add-bullets.mdx new file mode 100644 index 0000000000..50f6af4d4c --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/add-bullets.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/context-builder/step/add-bullets" +title: "addBullets" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.addBullets" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addBullets` + +Adds a POM section with bullet points, mutually exclusive with raw text. + +## Signature + +```typescript +addBullets(title: string, bullets: string[]): this +``` + +## Parameters + + + The section heading. + + + + The list of bullet point strings. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 215. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/add-gather-question.mdx b/fern/products/sdk-reference/typescript/context-builder/step/add-gather-question.mdx new file mode 100644 index 0000000000..0f601a4c0f --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/add-gather-question.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/typescript/context-builder/step/add-gather-question" +title: "addGatherQuestion" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.addGatherQuestion" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addGatherQuestion` + +Add a question to this step's gather\_info configuration. +setGatherInfo() must be called before this method. + +IMPORTANT — gather mode locks function access: +While the model is asking gather questions, the runtime forcibly +deactivates ALL of the step's other functions. The only callable +tools during a gather question are: + +- `gather_submit` (the native answer-submission tool) +- Whatever names you list in this question's `functions` option + +`next_step` and `change_context` are also filtered out — the model +cannot navigate away until the gather completes. This is by design: +it forces a tight ask → submit → next-question loop. + +If a question needs to call out to a tool (e.g. validate an email, +geocode a ZIP), list that tool name in this question's `functions`. +Functions listed here are active ONLY for this question. + +## Signature + +```typescript +addGatherQuestion(opts: { ...6 fields }): this +``` + +## Parameters + + + Question configuration including key, question text, and optional type/confirm/prompt/functions. + + + + + + + + + + + + + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 366. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/add-section.mdx b/fern/products/sdk-reference/typescript/context-builder/step/add-section.mdx new file mode 100644 index 0000000000..c57eee7954 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/add-section.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/context-builder/step/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.addSection" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `addSection` + +Adds a POM section with a body, mutually exclusive with raw text. + +## Signature + +```typescript +addSection(title: string, body: string): this +``` + +## Parameters + + + The section heading. + + + + The section body text. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 203. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/clear-sections.mdx b/fern/products/sdk-reference/typescript/context-builder/step/clear-sections.mdx new file mode 100644 index 0000000000..de639175fa --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/clear-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/context-builder/step/clear-sections" +title: "clearSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.clearSections" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `clearSections` + +Removes all POM sections and raw text from this step. + +## Signature + +```typescript +clearSections(): this +``` + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 407. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/constructor.mdx b/fern/products/sdk-reference/typescript/context-builder/step/constructor.mdx new file mode 100644 index 0000000000..8e918473f2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/step/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.constructor" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `constructor` + +Creates a new Step. + +## Signature + +```typescript +constructor(name: string): Step +``` + +## Parameters + + + The unique step name. + + +## Returns + +`Step` + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 182. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/index.mdx b/fern/products/sdk-reference/typescript/context-builder/step/index.mdx new file mode 100644 index 0000000000..198f1bf082 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/index.mdx @@ -0,0 +1,115 @@ +--- +slug: "/reference/typescript/context-builder/step" +title: "Step" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "ContextBuilder.Step" + parent: "ContextBuilder" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `Step` + +A single step within a context, with prompt content, criteria, function restrictions, and navigation rules. + +## Signature + +```typescript +class Step +``` + +## Properties + + + The unique name identifying this step within its context. + + +## Methods + + + + Adds a POM section with bullet points, mutually exclusive with raw text. + + + + Add a question to this step's gather\_info configuration. setGatherInfo() must be called before this method. + + + + Adds a POM section with a body, mutually exclusive with raw text. + + + + Removes all POM sections and raw text from this step. + + + + Creates a new Step. + + + + Mark this step as terminal for the step flow. + + + + Set which non-internal functions are callable while this step is active. + + + + Initializes a gather info operation on this step for collecting structured data. + + + + Sets whether to consolidate conversation history when resetting at this step. + + + + Sets whether to perform a full conversation reset at this step. + + + + Sets the system prompt to use when resetting context at this step. + + + + Sets the user prompt to use when resetting context at this step. + + + + Sets whether to automatically advance to the next step after this one completes. + + + + Sets whether to skip waiting for user input when entering this step. + + + + Sets the criteria that must be met before this step is considered complete. + + + + Sets raw text content for this step, mutually exclusive with POM sections. + + + + Sets which contexts the AI may navigate to from this step. + + + + Sets which steps the AI may navigate to from this step. + + + + Serializes this step to a plain object for SWML output. + + + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 160. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-end.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-end.mdx new file mode 100644 index 0000000000..cbdd1cc0ba --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-end.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/context-builder/step/set-end" +title: "setEnd" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setEnd" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setEnd` + +Mark this step as terminal for the step flow. + +IMPORTANT: `end=true` does NOT end the conversation or hang up the +call. It exits step mode entirely after this step executes — clearing +the steps list, current step index, validSteps, and validContexts. +The agent keeps running, but operates only under the base system +prompt and the context-level prompt; no more step instructions are +injected and no more `next_step` tool is offered. + +To actually end the call, call a hangup tool or define a hangup hook. + +## Signature + +```typescript +setEnd(end: boolean): this +``` + +## Parameters + + + True to exit step mode after this step. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 308. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-functions.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-functions.mdx new file mode 100644 index 0000000000..6f2a1f4f89 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-functions.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/context-builder/step/set-functions" +title: "setFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setFunctions" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setFunctions` + +Set which non-internal functions are callable while this step is active. + +IMPORTANT — inheritance behavior: +If you do NOT call this method, the step inherits whichever function +set was active on the previous step (or the previous context's last +step). The server-side runtime only resets the active set when a +step explicitly declares its `functions` field. This is by design, +but it is the most common source of bugs in multi-step agents: +forgetting setFunctions() on a later step lets the previous step's +tools leak through. + +Best practice: call setFunctions() explicitly on every step that +should have a different toolset than the previous one. + +Keep the per-step active set small: LLM tool selection accuracy +degrades noticeably past ~7-8 simultaneously-active tools per call. +Use per-step whitelisting to partition large tool collections. + +Internal functions (e.g. `startup_hook`, `hangup_hook`, `gather_submit`) +are ALWAYS protected and cannot be deactivated by this whitelist. The +native navigation tools `next_step` and `change_context` are injected +automatically when validSteps/validContexts is set; they are not +affected by this list and do not need to appear in it. + +## Signature + +```typescript +setFunctions(functions: string | string[]): this +``` + +## Parameters + + + One of: + + +## Returns + +`this` — This step for chaining. + +## Examples + +```typescript +step.setFunctions(['lookup_account', 'check_balance']); // whitelist +step.setFunctions([]); // disable all +step.setFunctions('none'); // disable all (alt) +``` + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 268. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-gather-info.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-gather-info.mdx new file mode 100644 index 0000000000..bb415c0576 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-gather-info.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/context-builder/step/set-gather-info" +title: "setGatherInfo" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setGatherInfo" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setGatherInfo` + +Initializes a gather info operation on this step for collecting structured data. + +## Signature + +```typescript +setGatherInfo(opts?: { ...3 fields }): this +``` + +## Parameters + + + Optional output key, completion action, and prompt configuration. + + + + + + + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 338. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-reset-consolidate.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-reset-consolidate.mdx new file mode 100644 index 0000000000..6e68a66d32 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-reset-consolidate.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/step/set-reset-consolidate" +title: "setResetConsolidate" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setResetConsolidate" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setResetConsolidate` + +Sets whether to consolidate conversation history when resetting at this step. + +## Signature + +```typescript +setResetConsolidate(consolidate: boolean): this +``` + +## Parameters + + + Whether to consolidate. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 438. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-reset-full-reset.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-reset-full-reset.mdx new file mode 100644 index 0000000000..9b8596d229 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-reset-full-reset.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/step/set-reset-full-reset" +title: "setResetFullReset" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setResetFullReset" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setResetFullReset` + +Sets whether to perform a full conversation reset at this step. + +## Signature + +```typescript +setResetFullReset(fullReset: boolean): this +``` + +## Parameters + + + Whether to fully reset. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 448. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-reset-system-prompt.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-reset-system-prompt.mdx new file mode 100644 index 0000000000..1599bc7127 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-reset-system-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/step/set-reset-system-prompt" +title: "setResetSystemPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setResetSystemPrompt" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setResetSystemPrompt` + +Sets the system prompt to use when resetting context at this step. + +## Signature + +```typescript +setResetSystemPrompt(systemPrompt: string): this +``` + +## Parameters + + + The replacement system prompt text. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 418. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-reset-user-prompt.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-reset-user-prompt.mdx new file mode 100644 index 0000000000..5c550a76f1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-reset-user-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/step/set-reset-user-prompt" +title: "setResetUserPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setResetUserPrompt" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setResetUserPrompt` + +Sets the user prompt to use when resetting context at this step. + +## Signature + +```typescript +setResetUserPrompt(userPrompt: string): this +``` + +## Parameters + + + The replacement user prompt text. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 428. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-skip-to-next-step.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-skip-to-next-step.mdx new file mode 100644 index 0000000000..09fe6e99f1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-skip-to-next-step.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/step/set-skip-to-next-step" +title: "setSkipToNextStep" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setSkipToNextStep" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setSkipToNextStep` + +Sets whether to automatically advance to the next step after this one completes. + +## Signature + +```typescript +setSkipToNextStep(skip: boolean): this +``` + +## Parameters + + + Whether to skip to the next step. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 328. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-skip-user-turn.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-skip-user-turn.mdx new file mode 100644 index 0000000000..cfa7295d5c --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-skip-user-turn.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/step/set-skip-user-turn" +title: "setSkipUserTurn" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setSkipUserTurn" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setSkipUserTurn` + +Sets whether to skip waiting for user input when entering this step. + +## Signature + +```typescript +setSkipUserTurn(skip: boolean): this +``` + +## Parameters + + + Whether to skip the user turn. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 318. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-step-criteria.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-step-criteria.mdx new file mode 100644 index 0000000000..e7696ae783 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-step-criteria.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/step/set-step-criteria" +title: "setStepCriteria" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setStepCriteria" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setStepCriteria` + +Sets the criteria that must be met before this step is considered complete. + +## Signature + +```typescript +setStepCriteria(criteria: string): this +``` + +## Parameters + + + A description of the completion criteria. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 226. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-text.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-text.mdx new file mode 100644 index 0000000000..ffaedb01f3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-text.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/step/set-text" +title: "setText" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setText" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setText` + +Sets raw text content for this step, mutually exclusive with POM sections. + +## Signature + +```typescript +setText(text: string): this +``` + +## Parameters + + + The raw prompt text. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 191. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-valid-contexts.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-valid-contexts.mdx new file mode 100644 index 0000000000..3436a66ede --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-valid-contexts.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/step/set-valid-contexts" +title: "setValidContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setValidContexts" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setValidContexts` + +Sets which contexts the AI may navigate to from this step. + +## Signature + +```typescript +setValidContexts(contexts: string[]): this +``` + +## Parameters + + + List of allowed context names. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 288. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/set-valid-steps.mdx b/fern/products/sdk-reference/typescript/context-builder/step/set-valid-steps.mdx new file mode 100644 index 0000000000..f1ae4626ba --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/set-valid-steps.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/context-builder/step/set-valid-steps" +title: "setValidSteps" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.setValidSteps" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `setValidSteps` + +Sets which steps the AI may navigate to from this step. + +## Signature + +```typescript +setValidSteps(steps: string[]): this +``` + +## Parameters + + + List of allowed step names. + + +## Returns + +`this` — This step for chaining. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 278. diff --git a/fern/products/sdk-reference/typescript/context-builder/step/to-dict.mdx b/fern/products/sdk-reference/typescript/context-builder/step/to-dict.mdx new file mode 100644 index 0000000000..e87861ba0d --- /dev/null +++ b/fern/products/sdk-reference/typescript/context-builder/step/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/context-builder/step/to-dict" +title: "toDict" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ContextBuilder.Step.toDict" + parent: "ContextBuilder.Step" + module: "ContextBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts" +--- +# `toDict` + +Serializes this step to a plain object for SWML output. + +## Signature + +```typescript +toDict(): Record +``` + +## Returns + +`Record` — A dictionary representation of this step. + +## Source + +[`src/ContextBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ContextBuilder.ts) + +Line 473. diff --git a/fern/products/sdk-reference/typescript/data-map/create-expression-tool.mdx b/fern/products/sdk-reference/typescript/data-map/create-expression-tool.mdx new file mode 100644 index 0000000000..c9d9840162 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/create-expression-tool.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/data-map/create-expression-tool" +title: "createExpressionTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "DataMap.createExpressionTool" + parent: "DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `createExpressionTool` + +Create a DataMap tool that evaluates expressions against patterns without making HTTP calls. + +## Signature + +```typescript +createExpressionTool(opts: { ...3 fields }): DataMap +``` + +## Parameters + + + Configuration including name, pattern-result pairs, and optional parameters. + + + + + + + + +## Returns + +`DataMap` — A configured DataMap instance ready for registration. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 460. diff --git a/fern/products/sdk-reference/typescript/data-map/create-simple-api-tool.mdx b/fern/products/sdk-reference/typescript/data-map/create-simple-api-tool.mdx new file mode 100644 index 0000000000..46b4386e07 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/create-simple-api-tool.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/data-map/create-simple-api-tool" +title: "createSimpleApiTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "DataMap.createSimpleApiTool" + parent: "DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `createSimpleApiTool` + +Create a DataMap tool that calls a single API endpoint and formats the response. + +## Signature + +```typescript +createSimpleApiTool(opts: { ...8 fields }): DataMap +``` + +## Parameters + + + Configuration including name, URL, response template, and optional parameters. + + + + + + + + + + + + + + + + + + +## Returns + +`DataMap` — A configured DataMap instance ready for registration. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 430. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/body.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/body.mdx new file mode 100644 index 0000000000..b6823fb7c2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/body.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/data-map/data-map/body" +title: "body" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.body" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `body` + +Set the JSON body for the most recently added webhook. + +## Signature + +```typescript +body(data: Record): this +``` + +## Parameters + + + The request body object. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 292. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/constructor.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/constructor.mdx new file mode 100644 index 0000000000..aeab9aa2fe --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/data-map/data-map/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.constructor" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(functionName: string): DataMap +``` + +## Parameters + + + The unique name for this data map tool. + + +## Returns + +`DataMap` + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 109. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/description.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/description.mdx new file mode 100644 index 0000000000..55dce97f05 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/description.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/data-map/data-map/description" +title: "description" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.description" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `description` + +Alias for [purpose](/reference/typescript/data-map/data-map/purpose); sets the LLM-facing tool description. + +This string is read by the model to decide WHEN to call this tool. +See [purpose](/reference/typescript/data-map/data-map/purpose) for bad-vs-good examples. + +## Signature + +```typescript +description(description: string): this +``` + +## Parameters + + + Prompt-engineering description of when to call this tool. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 174. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/enable-env-expansion.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/enable-env-expansion.mdx new file mode 100644 index 0000000000..43e7758608 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/enable-env-expansion.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/data-map/data-map/enable-env-expansion" +title: "enableEnvExpansion" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.enableEnvExpansion" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `enableEnvExpansion` + +Enable `${ENV.*}` variable expansion in URLs, bodies, and outputs. + +## Signature + +```typescript +enableEnvExpansion(enabled: boolean = true): this +``` + +## Parameters + + + Whether to enable expansion (defaults to true). + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 118. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/error-keys.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/error-keys.mdx new file mode 100644 index 0000000000..d238474ab9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/error-keys.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/data-map/data-map/error-keys" +title: "errorKeys" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.errorKeys" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `errorKeys` + +Set error keys on the most recently added webhook, or globally if no webhook exists. + +## Signature + +```typescript +errorKeys(keys: string[]): this +``` + +## Parameters + + + Response keys that indicate an error occurred. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/expression.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/expression.mdx new file mode 100644 index 0000000000..093c0dc207 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/expression.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/data-map/data-map/expression" +title: "expression" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.expression" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `expression` + +Add a pattern-matching expression that evaluates a test value against a regex. + +## Signature + +```typescript +expression( + testValue: string, + pattern: string | RegExp, + output: FunctionResult, + nomatchOutput?: FunctionResult +): this +``` + +## Parameters + + + The string or template variable to test. + + + + A regex pattern (string or RegExp) to match against. + + + + The result to return when the pattern matches. + + + + Optional result to return when the pattern does not match. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 231. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/fallback-output.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/fallback-output.mdx new file mode 100644 index 0000000000..ef7b5c5eaa --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/fallback-output.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/data-map/data-map/fallback-output" +title: "fallbackOutput" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.fallbackOutput" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `fallbackOutput` + +Set a fallback output used when no webhook or expression matches. + +## Signature + +```typescript +fallbackOutput(result: FunctionResult): this +``` + +## Parameters + + + The FunctionResult to use as the fallback. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 341. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/foreach.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/foreach.mdx new file mode 100644 index 0000000000..adda596c66 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/foreach.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/data-map/data-map/foreach" +title: "foreach" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.foreach" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `foreach` + +Configure iteration over an array in the webhook response. + +## Signature + +```typescript +foreach(config: { ...4 fields }): this +``` + +## Parameters + + + Foreach configuration with input/output keys, append template, and optional max. + + + + + + + + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 314. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/global-error-keys.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/global-error-keys.mdx new file mode 100644 index 0000000000..c66e7f3fc5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/global-error-keys.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/data-map/data-map/global-error-keys" +title: "globalErrorKeys" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.globalErrorKeys" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `globalErrorKeys` + +Set error keys at the top-level data map scope, regardless of webhook context. + +## Signature + +```typescript +globalErrorKeys(keys: string[]): this +``` + +## Parameters + + + Response keys that indicate an error occurred. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 365. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/index.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/index.mdx new file mode 100644 index 0000000000..909eb927c5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/index.mdx @@ -0,0 +1,148 @@ +--- +slug: "/reference/typescript/data-map/data-map" +title: "DataMap" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "DataMap.DataMap" + parent: "DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `DataMap` + +Fluent builder for SWAIG data\_map configurations. + +Creates server-side tool definitions that execute on SignalWire's infrastructure +**without** requiring a webhook endpoint in your application. Ideal for simple +third-party API integrations (REST calls + pattern-matched response shaping). + +## Signature + +```typescript +class DataMap +``` + +## Examples + + + + ```typescript + import { DataMap, FunctionResult } from '@signalwire/sdk'; + + const weather = new DataMap('get_weather') + .purpose('Look up the current weather for a city') + .parameter('city', 'string', 'The city name', true) + .webhook('GET', 'https://api.example.com/weather?city=${args.city}') + .output(new FunctionResult('In ${city} it is ${response.temp}°F and ${response.condition}.')); + + // Register onto an agent: + agent.registerSwaigFunction(weather.toSwaigFunction()); + ``` + + + + ```typescript + new DataMap('classify_intent') + .purpose('Route callers to the right department.') + .parameter('utterance', 'string', 'What the caller said', true) + .expression('${args.utterance}', /billing|invoice|charge/i, new FunctionResult('billing')) + .expression('${args.utterance}', /tech|broken|error/i, new FunctionResult('support')); + ``` + + + +## See Also + +- \- \[FunctionResult]\(/reference/typescript/function-result) — response shape used in \`.output()\` / \`.expression()\` + \- \[createSimpleApiTool]\(/reference/typescript/data-map/create-simple-api-tool) — one-liner helper for REST API tools + \- \[AgentBase.defineTool]\(/reference/typescript/agent-base/agent-base/define-tool) — alternative for tools that run in your process + +## Properties + + + The name of the SWAIG function this data map defines. + + +## Methods + + + + Set the JSON body for the most recently added webhook. + + + + + + Alias for [purpose](/reference/typescript/data-map/data-map/purpose); sets the LLM-facing tool description. + + + + Enable `${ENV.*}` variable expansion in URLs, bodies, and outputs. + + + + Set error keys on the most recently added webhook, or globally if no webhook exists. + + + + Add a pattern-matching expression that evaluates a test value against a regex. + + + + Set a fallback output used when no webhook or expression matches. + + + + Configure iteration over an array in the webhook response. + + + + Set error keys at the top-level data map scope, regardless of webhook context. + + + + Set the output template for the most recently added webhook. + + + + Define a parameter for this data-map tool — `description` is READ BY THE LLM. + + + + Set query or form parameters for the most recently added webhook. + + + + Set the purpose (description) for this data-map tool — READ BY THE LLM. + + + + Register this DataMap tool with an AgentBase instance. + + + + Set the allowed env var prefixes for this DataMap instance. + + + + Serialize this data map to a SWAIG function definition object. + + + + Add a webhook that is called when this data map tool is invoked. + + + + Set pattern-matching expressions on the most recently added webhook. + + + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 94. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/output.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/output.mdx new file mode 100644 index 0000000000..a3f26b5377 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/output.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/data-map/data-map/output" +title: "output" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.output" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `output` + +Set the output template for the most recently added webhook. + +## Signature + +```typescript +output(result: FunctionResult): this +``` + +## Parameters + + + The FunctionResult to use as the output template. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 330. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/parameter.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/parameter.mdx new file mode 100644 index 0000000000..6692e21431 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/parameter.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/typescript/data-map/data-map/parameter" +title: "parameter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.parameter" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `parameter` + +Define a parameter for this data-map tool — `description` is READ BY THE LLM. + +Each parameter `description` is rendered into the OpenAI tool schema +under `parameters.properties..description` and sent to the +model. The model uses it to decide HOW to fill in the argument from +user speech. It is **prompt engineering**, not developer FYI. + +### Bad vs good + +```text +BAD : .parameter('city', 'string', 'the city') +GOOD: .parameter('city', 'string', +'The name of the city to get weather for, e.g. "San Francisco". +Ask the user if they did not provide one. Include the state +or country if the city name is ambiguous.') +``` + +## Signature + +```typescript +parameter( + name: string, + paramType: string, + description: string, + opts?: { ...2 fields } +): this +``` + +## Parameters + + + The parameter name (JSON object key). + + + + The JSON Schema type (e.g., "string", "number"). + + + + Prompt-engineering description telling the model how to extract this value from the user's utterance. Read by the LLM. + + + + Optional flags for required and enum constraints. + + + + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 203. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/params.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/params.mdx new file mode 100644 index 0000000000..493cfd7fc4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/data-map/data-map/params" +title: "params" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.params" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `params` + +Set query or form parameters for the most recently added webhook. + +## Signature + +```typescript +params(data: Record): this +``` + +## Parameters + + + The parameters object. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 303. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/purpose.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/purpose.mdx new file mode 100644 index 0000000000..40ceb7e0a4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/purpose.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/data-map/data-map/purpose" +title: "purpose" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.purpose" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `purpose` + +Set the purpose (description) for this data-map tool — READ BY THE LLM. + +This string is rendered into the OpenAI tool schema `description` +field and sent to the model on every turn. The model uses it to +decide WHEN to call this tool. It is **prompt engineering**, not +developer documentation. + +A vague `purpose()` is the #1 cause of "the model has the right tool +but doesn't call it" failures with data-map tools. + +### Bad vs good + +```text +BAD : .purpose('weather api') +GOOD: .purpose('Get the current weather conditions and forecast for +a specific city. Use this whenever the user asks about weather, +temperature, rain, or similar conditions in a named location.') +``` + +## Signature + +```typescript +purpose(description: string): this +``` + +## Parameters + + + Prompt-engineering description of when to call this tool. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 160. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/register-with-agent.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/register-with-agent.mdx new file mode 100644 index 0000000000..9825b66a13 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/register-with-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/data-map/data-map/register-with-agent" +title: "registerWithAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.registerWithAgent" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `registerWithAgent` + +Register this DataMap tool with an AgentBase instance. + +## Signature + +```typescript +registerWithAgent(agent: { ...1 fields }): this +``` + +## Parameters + + + An object with a registerSwaigFunction method (typically an AgentBase). + + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 375. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/set-allowed-env-prefixes.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/set-allowed-env-prefixes.mdx new file mode 100644 index 0000000000..d8ec1d0653 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/set-allowed-env-prefixes.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/data-map/data-map/set-allowed-env-prefixes" +title: "setAllowedEnvPrefixes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.setAllowedEnvPrefixes" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `setAllowedEnvPrefixes` + +Set the allowed env var prefixes for this DataMap instance. + +Overrides the global defaults. Only env vars whose names start with +one of these prefixes will be expanded. An empty array allows all. + +## Signature + +```typescript +setAllowedEnvPrefixes(prefixes: string[]): this +``` + +## Parameters + + + Array of prefix strings to allow. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 132. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/to-swaig-function.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/to-swaig-function.mdx new file mode 100644 index 0000000000..3c6cab4108 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/to-swaig-function.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/data-map/data-map/to-swaig-function" +title: "toSwaigFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.toSwaigFunction" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `toSwaigFunction` + +Serialize this data map to a SWAIG function definition object. + +## Signature + +```typescript +toSwaigFunction(): Record +``` + +## Returns + +`Record` — A plain object suitable for inclusion in the SWML SWAIG array. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 384. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/webhook-expressions.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/webhook-expressions.mdx new file mode 100644 index 0000000000..98793cb156 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/webhook-expressions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/data-map/data-map/webhook-expressions" +title: "webhookExpressions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.webhookExpressions" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `webhookExpressions` + +Set pattern-matching expressions on the most recently added webhook. + +## Signature + +```typescript +webhookExpressions(expressions: Record[]): this +``` + +## Parameters + + + Array of expression objects to evaluate against the webhook response. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 281. diff --git a/fern/products/sdk-reference/typescript/data-map/data-map/webhook.mdx b/fern/products/sdk-reference/typescript/data-map/data-map/webhook.mdx new file mode 100644 index 0000000000..7ff5c31121 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/data-map/webhook.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/data-map/data-map/webhook" +title: "webhook" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "DataMap.DataMap.webhook" + parent: "DataMap.DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `webhook` + +Add a webhook that is called when this data map tool is invoked. + +## Signature + +```typescript +webhook(method: string, url: string, opts?: { ...4 fields }): this +``` + +## Parameters + + + HTTP method (e.g., "GET", "POST"). + + + + The webhook URL to call. + + + + Optional headers, form parameter name, and argument settings. + + + + + + + + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 257. diff --git a/fern/products/sdk-reference/typescript/data-map/get-allowed-env-prefixes.mdx b/fern/products/sdk-reference/typescript/data-map/get-allowed-env-prefixes.mdx new file mode 100644 index 0000000000..8a07b6e9df --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/get-allowed-env-prefixes.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/data-map/get-allowed-env-prefixes" +title: "getAllowedEnvPrefixes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "DataMap.getAllowedEnvPrefixes" + parent: "DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `getAllowedEnvPrefixes` + +Get the current global allowed env var prefixes. + +## Signature + +```typescript +getAllowedEnvPrefixes(): string[] +``` + +## Returns + +`string[]` — A copy of the current prefix list. + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 31. diff --git a/fern/products/sdk-reference/typescript/data-map/index.mdx b/fern/products/sdk-reference/typescript/data-map/index.mdx new file mode 100644 index 0000000000..8a9d934d0c --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/data-map" +title: "DataMap" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `DataMap` + +## Signature + +```typescript +module DataMap +``` + +## Functions + + + + Create a DataMap tool that evaluates expressions against patterns without making HTTP calls. + + + + Create a DataMap tool that calls a single API endpoint and formats the response. + + + + Get the current global allowed env var prefixes. + + + + Set the global allowed env var prefixes for `${ENV.*}` expansion. + + + +## Classes + + + + Fluent builder for SWAIG data\_map configurations. + + + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/data-map/set-allowed-env-prefixes.mdx b/fern/products/sdk-reference/typescript/data-map/set-allowed-env-prefixes.mdx new file mode 100644 index 0000000000..14a73721d6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/data-map/set-allowed-env-prefixes.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/data-map/set-allowed-env-prefixes" +title: "setAllowedEnvPrefixes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "DataMap.setAllowedEnvPrefixes" + parent: "DataMap" + module: "DataMap" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts" +--- +# `setAllowedEnvPrefixes` + +Set the global allowed env var prefixes for `${ENV.*}` expansion. + +Only environment variables whose names start with one of these prefixes +will be expanded. An empty array allows all variables (escape hatch). + +## Signature + +```typescript +setAllowedEnvPrefixes(prefixes: string[]): void +``` + +## Parameters + + + Array of prefix strings to allow. + + +## Returns + +`void` + +## Source + +[`src/DataMap.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/DataMap.ts) + +Line 23. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/add-action.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/add-action.mdx new file mode 100644 index 0000000000..90f590ced0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/add-action.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/function-result/function-result/add-action" +title: "addAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.addAction" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `addAction` + +Append a single named action to the action list. + +## Signature + +```typescript +addAction(name: string, data: unknown): this +``` + +## Parameters + + + The action name (e.g., "hangup", "say"). + + + + The action payload. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 122. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/add-actions.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/add-actions.mdx new file mode 100644 index 0000000000..59cf25cc8f --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/add-actions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/add-actions" +title: "addActions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.addActions" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `addActions` + +Append multiple action objects to the action list. + +## Signature + +```typescript +addActions(actions: Record[]): this +``` + +## Parameters + + + Array of action objects to append. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 132. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/add-dynamic-hints.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/add-dynamic-hints.mdx new file mode 100644 index 0000000000..d6823b9dac --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/add-dynamic-hints.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/function-result/function-result/add-dynamic-hints" +title: "addDynamicHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.addDynamicHints" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `addDynamicHints` + +Add dynamic speech recognition hints to improve transcription accuracy. + +## Signature + +```typescript +addDynamicHints( + hints: string | { ignore_case?: boolean; pattern: string; replace: string }[] +): this +``` + +## Parameters + + + Array of hint strings or pattern-replacement objects. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 265. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/clear-dynamic-hints.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/clear-dynamic-hints.mdx new file mode 100644 index 0000000000..bf74bb663b --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/clear-dynamic-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/function-result/function-result/clear-dynamic-hints" +title: "clearDynamicHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.clearDynamicHints" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `clearDynamicHints` + +Remove all previously added dynamic speech hints. + +## Signature + +```typescript +clearDynamicHints(): this +``` + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 273. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/connect.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/connect.mdx new file mode 100644 index 0000000000..193d908ec8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/connect.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/function-result/function-result/connect" +title: "connect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.connect" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `connect` + +Connect the call to another destination via SWML transfer. + +## Signature + +```typescript +connect(destination: string, final: boolean = true, fromAddr?: string): this +``` + +## Parameters + + + The destination address (phone number or SIP URI). + + + + Whether this is a final transfer that ends the AI session. + + + + Optional caller ID to use for the outbound leg. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 146. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/constructor.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/constructor.mdx new file mode 100644 index 0000000000..9bad3e4a50 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/constructor.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/function-result/function-result/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.constructor" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(response?: string, postProcess: boolean = false): FunctionResult +``` + +## Parameters + + + Initial response text; defaults to empty string. + + + + Whether to enable post-processing of actions. + + +## Returns + +`FunctionResult` + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 88. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/create-payment-action.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/create-payment-action.mdx new file mode 100644 index 0000000000..fea9c5eb37 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/create-payment-action.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/function-result/function-result/create-payment-action" +title: "createPaymentAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.createPaymentAction" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `createPaymentAction` + +Create a payment action for use within a payment prompt. + +**Modifiers:** `static` + +## Signature + +```typescript +createPaymentAction(actionType: string, phrase: string): PaymentAction +``` + +## Parameters + + + The action type (e.g., "say", "play"). + + + + The phrase or URL for this action. + + +## Returns + +`PaymentAction` — A new PaymentAction object. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 867. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/create-payment-parameter.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/create-payment-parameter.mdx new file mode 100644 index 0000000000..f9f0ce4031 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/create-payment-parameter.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/function-result/function-result/create-payment-parameter" +title: "createPaymentParameter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.createPaymentParameter" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `createPaymentParameter` + +Create a custom payment parameter for the payment connector. + +**Modifiers:** `static` + +## Signature + +```typescript +createPaymentParameter(name: string, value: string): PaymentParameter +``` + +## Parameters + + + The parameter name. + + + + The parameter value. + + +## Returns + +`PaymentParameter` — A new PaymentParameter object. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 877. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/create-payment-prompt.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/create-payment-prompt.mdx new file mode 100644 index 0000000000..4a0fbb3390 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/create-payment-prompt.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/function-result/function-result/create-payment-prompt" +title: "createPaymentPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.createPaymentPrompt" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `createPaymentPrompt` + +Create a payment prompt configuration object. + +**Modifiers:** `static` + +## Signature + +```typescript +createPaymentPrompt( + forSituation: string, + actions: PaymentAction[], + cardType?: string, + errorType?: string +): PaymentPrompt +``` + +## Parameters + + + The situation this prompt applies to. + + + + Actions to perform for this prompt. + + + + Optional card type filter. + + + + Optional error type this prompt handles. + + +## Returns + +`PaymentPrompt` — A new PaymentPrompt object. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 849. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/enable-extensive-data.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/enable-extensive-data.mdx new file mode 100644 index 0000000000..e18542e38c --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/enable-extensive-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/enable-extensive-data" +title: "enableExtensiveData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.enableExtensiveData" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `enableExtensiveData` + +Enable or disable extensive data reporting in function calls. + +## Signature + +```typescript +enableExtensiveData(enabled: boolean = true): this +``` + +## Parameters + + + Whether to enable extensive data. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 463. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/enable-functions-on-timeout.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/enable-functions-on-timeout.mdx new file mode 100644 index 0000000000..60d76f6ccf --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/enable-functions-on-timeout.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/enable-functions-on-timeout" +title: "enableFunctionsOnTimeout" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.enableFunctionsOnTimeout" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `enableFunctionsOnTimeout` + +Control whether functions fire on speaker timeout. + +## Signature + +```typescript +enableFunctionsOnTimeout(enabled: boolean = true): this +``` + +## Parameters + + + Whether to enable function execution on timeout. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 434. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/execute-rpc.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/execute-rpc.mdx new file mode 100644 index 0000000000..de0055fdca --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/execute-rpc.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/function-result/function-result/execute-rpc" +title: "executeRpc" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.executeRpc" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `executeRpc` + +Execute a SignalWire RPC method via SWML. + +## Signature + +```typescript +executeRpc(opts: { ...4 fields }): this +``` + +## Parameters + + + RPC parameters including method name and optional call/node IDs. + + + + + + + + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 708. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/execute-swml.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/execute-swml.mdx new file mode 100644 index 0000000000..4f55efd7e2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/execute-swml.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/function-result/function-result/execute-swml" +title: "executeSwml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.executeSwml" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `executeSwml` + +Execute arbitrary SWML content as an action. + +## Signature + +```typescript +executeSwml( + swmlContent: string | Record | { toDict: unknown }, + transfer: boolean = false +): this +``` + +## Parameters + + + SWML as a JSON string or object. + + + + Whether this SWML execution should transfer the call. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 342. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/hangup.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/hangup.mdx new file mode 100644 index 0000000000..89532c530f --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/hangup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/function-result/function-result/hangup" +title: "hangup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.hangup" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `hangup` + +Hang up the call. + +## Signature + +```typescript +hangup(): this +``` + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 188. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/hold.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/hold.mdx new file mode 100644 index 0000000000..bda542ec18 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/hold.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/hold" +title: "hold" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.hold" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `hold` + +Place the call on hold for a specified duration. + +## Signature + +```typescript +hold(timeout: number = 300): this +``` + +## Parameters + + + Hold duration in seconds, clamped to 0-900. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 197. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/index.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/index.mdx new file mode 100644 index 0000000000..a21f11b621 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/index.mdx @@ -0,0 +1,291 @@ +--- +slug: "/reference/typescript/function-result/function-result" +title: "FunctionResult" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult" + parent: "FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `FunctionResult` + +Builder for SWAIG function responses. + +Carries response text (what the AI says to the caller) and a list of structured +actions (connect, hangup, SMS, record, transfer, etc.) that the SignalWire platform +executes after the AI speaks. Every mutating method returns `this` for fluent chaining. + +Return an instance (or a promise that resolves to one) from any SWAIG tool handler. + +## Signature + +```typescript +class FunctionResult +``` + +## Examples + + + + ```typescript + agent.defineTool({ + name: 'say_hi', + description: 'Say hello.', + parameters: { type: 'object', properties: {} }, + handler: () => new FunctionResult('Hello there!'), + }); + ``` + + + + ```typescript + agent.defineTool({ + name: 'transfer_to_sales', + description: 'Forward the caller to sales.', + parameters: { type: 'object', properties: {} }, + handler: () => + new FunctionResult('Connecting you to sales now.').connect('+15551112222'), + }); + ``` + + + + ```typescript + new FunctionResult("Thanks, you're all set.") + .sendSms({ toNumber: '+15551234567', fromNumber: '+15559998888', body: 'Confirmation!' }) + .hangup(); + ``` + + + +## See Also + +- \- \[AgentBase.defineTool]\(/reference/typescript/agent-base/agent-base/define-tool) — where handlers return a \`FunctionResult\` + \- \[DataMap]\(/reference/typescript/data-map) — alternative for purely data-driven (no handler) tools + +## Properties + + + Ordered list of actions to execute after the response. + + + + Whether actions should be post-processed after the AI responds. + + + + The text response returned to the AI agent. + + +## Methods + + + + Append a single named action to the action list. + + + + Append multiple action objects to the action list. + + + + Add dynamic speech recognition hints to improve transcription accuracy. + + + + Remove all previously added dynamic speech hints. + + + + Connect the call to another destination via SWML transfer. + + + + + + Create a payment action for use within a payment prompt. + + + + Create a custom payment parameter for the payment connector. + + + + Create a payment prompt configuration object. + + + + Enable or disable extensive data reporting in function calls. + + + + Control whether functions fire on speaker timeout. + + + + Execute a SignalWire RPC method via SWML. + + + + Execute arbitrary SWML content as an action. + + + + Hang up the call. + + + + Place the call on hold for a specified duration. + + + + Join a conference by name with optional configuration. + + + + Join a SignalWire room. + + + + Initiate a payment collection flow on the call. + + + + Play an audio file in the background during the call. + + + + Start recording the call. + + + + Remove keys from the global data store. + + + + Remove metadata keys from the current call. + + + + Replace the function call output in conversation history. + + + + Send an AI message to another call via RPC. + + + + Unhold a call that was previously placed on hold via RPC. + + + + Dial a number via RPC, optionally specifying device type. + + + + Speak text to the caller via TTS. + + + + Send an SMS or MMS message from within the call flow. + + + + Set the silence duration that marks the end of a user's speech. + + + + Set metadata key-value pairs on the current call. + + + + Enable or disable post-processing of actions. + + + + Set the response text returned to the AI agent. + + + + Set the timeout for speech event detection. + + + + Inject text as if the user had spoken it. + + + + Send a SIP REFER to transfer the call. + + + + Stop the AI session. + + + + Stop any currently playing background audio file. + + + + Stop an active call recording. + + + + Stop an active media tap. + + + + Switch the AI context with optional new prompts and reset options. + + + + Change the current SWML context. + + + + Change the current SWML step. + + + + Transfer the call to a SWML destination with a custom AI response. + + + + Emit a custom user event via SWML. + + + + Start a media tap to stream audio to an external URI. + + + + Serialize this result to a plain object for the SWAIG response. + + + + Enable or disable SWAIG functions by name. + + + + Merge key-value pairs into the global data store shared across functions. + + + + Update AI engine settings at runtime. + + + + Wait for user input before continuing. + + + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 76. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/join-conference.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/join-conference.mdx new file mode 100644 index 0000000000..6828e67c38 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/join-conference.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/function-result/function-result/join-conference" +title: "joinConference" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.joinConference" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `joinConference` + +Join a conference by name with optional configuration. + +## Signature + +```typescript +joinConference(name: string, opts?: { ...17 fields }): this +``` + +## Parameters + + + The conference name to join. + + + + Optional conference settings such as mute, recording, and callbacks. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 637. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/join-room.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/join-room.mdx new file mode 100644 index 0000000000..ff6efc9712 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/join-room.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/join-room" +title: "joinRoom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.joinRoom" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `joinRoom` + +Join a SignalWire room. + +## Signature + +```typescript +joinRoom(name: string): this +``` + +## Parameters + + + The room name to join. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 612. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/pay.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/pay.mdx new file mode 100644 index 0000000000..e695815eed --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/pay.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/function-result/function-result/pay" +title: "pay" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.pay" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `pay` + +Initiate a payment collection flow on the call. + +## Signature + +```typescript +pay(opts: { ...19 fields }): this +``` + +## Parameters + + + Payment configuration including connector URL, method, and prompt options. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 780. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/play-background-file.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/play-background-file.mdx new file mode 100644 index 0000000000..8af979fbea --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/play-background-file.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/function-result/function-result/play-background-file" +title: "playBackgroundFile" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.playBackgroundFile" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `playBackgroundFile` + +Play an audio file in the background during the call. + +## Signature + +```typescript +playBackgroundFile(filename: string, wait: boolean = false): this +``` + +## Parameters + + + URL or path of the audio file. + + + + Whether to wait for playback to complete before continuing. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 243. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/record-call.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/record-call.mdx new file mode 100644 index 0000000000..f4a29bca62 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/record-call.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/function-result/function-result/record-call" +title: "recordCall" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.recordCall" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `recordCall` + +Start recording the call. + +## Signature + +```typescript +recordCall(opts?: { ...11 fields }): this +``` + +## Parameters + + + Recording options including format, direction, and timeouts. + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 517. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/remove-global-data.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/remove-global-data.mdx new file mode 100644 index 0000000000..032b371298 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/remove-global-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/remove-global-data" +title: "removeGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.removeGlobalData" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `removeGlobalData` + +Remove keys from the global data store. + +## Signature + +```typescript +removeGlobalData(keys: string | string[]): this +``` + +## Parameters + + + A single key or array of keys to remove. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 312. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/remove-metadata.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/remove-metadata.mdx new file mode 100644 index 0000000000..e04d38ccde --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/remove-metadata.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/remove-metadata" +title: "removeMetadata" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.removeMetadata" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `removeMetadata` + +Remove metadata keys from the current call. + +## Signature + +```typescript +removeMetadata(keys: string | string[]): this +``` + +## Parameters + + + A single key or array of keys to remove. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 330. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/replace-in-history.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/replace-in-history.mdx new file mode 100644 index 0000000000..5a03b1a6ea --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/replace-in-history.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/replace-in-history" +title: "replaceInHistory" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.replaceInHistory" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `replaceInHistory` + +Replace the function call output in conversation history. + +## Signature + +```typescript +replaceInHistory(text: string | boolean = true): this +``` + +## Parameters + + + Replacement text, or true to replace with the response. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 472. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/rpc-ai-message.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/rpc-ai-message.mdx new file mode 100644 index 0000000000..2be37d0592 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/rpc-ai-message.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/function-result/function-result/rpc-ai-message" +title: "rpcAiMessage" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.rpcAiMessage" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `rpcAiMessage` + +Send an AI message to another call via RPC. + +## Signature + +```typescript +rpcAiMessage(callId: string, messageText: string, role: string = 'system'): this +``` + +## Parameters + + + The target call ID. + + + + The message text to inject. + + + + The message role (defaults to "system"). + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 752. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/rpc-ai-unhold.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/rpc-ai-unhold.mdx new file mode 100644 index 0000000000..0f729650e1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/rpc-ai-unhold.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/rpc-ai-unhold" +title: "rpcAiUnhold" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.rpcAiUnhold" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `rpcAiUnhold` + +Unhold a call that was previously placed on hold via RPC. + +## Signature + +```typescript +rpcAiUnhold(callId: string): this +``` + +## Parameters + + + The target call ID to unhold. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 765. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/rpc-dial.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/rpc-dial.mdx new file mode 100644 index 0000000000..01cc6bff55 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/rpc-dial.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/function-result/function-result/rpc-dial" +title: "rpcDial" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.rpcDial" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `rpcDial` + +Dial a number via RPC, optionally specifying device type. + +## Signature + +```typescript +rpcDial( + toNumber: string, + fromNumber: string, + destSwml: string, + deviceType: string = 'phone' +): this +``` + +## Parameters + + + The destination phone number. + + + + The caller ID number. + + + + The SWML destination for the dialed call. + + + + The device type (defaults to "phone"). + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 732. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/say.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/say.mdx new file mode 100644 index 0000000000..e8a4c787af --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/say.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/say" +title: "say" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.say" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `say` + +Speak text to the caller via TTS. + +## Signature + +```typescript +say(text: string): this +``` + +## Parameters + + + The text to speak. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 233. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/send-sms.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/send-sms.mdx new file mode 100644 index 0000000000..217710b821 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/send-sms.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/function-result/function-result/send-sms" +title: "sendSms" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.sendSms" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `sendSms` + +Send an SMS or MMS message from within the call flow. + +## Signature + +```typescript +sendSms(opts: { ...6 fields }): this +``` + +## Parameters + + + SMS parameters. Must include either `body` (text SMS) or `media` (MMS) — supplying neither throws. + + + + + + + + + + + + + + +## Returns + +`this` — This instance for chaining. + +## Throws + +- When neither `body` nor `media` is provided. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/set-end-of-speech-timeout.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/set-end-of-speech-timeout.mdx new file mode 100644 index 0000000000..09fe8fca8a --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/set-end-of-speech-timeout.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/set-end-of-speech-timeout" +title: "setEndOfSpeechTimeout" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.setEndOfSpeechTimeout" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `setEndOfSpeechTimeout` + +Set the silence duration that marks the end of a user's speech. + +## Signature + +```typescript +setEndOfSpeechTimeout(milliseconds: number): this +``` + +## Parameters + + + Timeout in milliseconds. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 283. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/set-metadata.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/set-metadata.mdx new file mode 100644 index 0000000000..45563aa163 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/set-metadata.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/set-metadata" +title: "setMetadata" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.setMetadata" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `setMetadata` + +Set metadata key-value pairs on the current call. + +## Signature + +```typescript +setMetadata(data: Record): this +``` + +## Parameters + + + Metadata key-value pairs to set. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 321. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/set-post-process.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/set-post-process.mdx new file mode 100644 index 0000000000..e5d201c79a --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/set-post-process.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/set-post-process" +title: "setPostProcess" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.setPostProcess" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `setPostProcess` + +Enable or disable post-processing of actions. + +## Signature + +```typescript +setPostProcess(postProcess: boolean): this +``` + +## Parameters + + + Whether to post-process actions. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 111. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/set-response.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/set-response.mdx new file mode 100644 index 0000000000..28fd70d0f8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/set-response.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/set-response" +title: "setResponse" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.setResponse" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `setResponse` + +Set the response text returned to the AI agent. + +## Signature + +```typescript +setResponse(response: string): this +``` + +## Parameters + + + The response text. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 101. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/set-speech-event-timeout.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/set-speech-event-timeout.mdx new file mode 100644 index 0000000000..5f37bc0867 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/set-speech-event-timeout.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/set-speech-event-timeout" +title: "setSpeechEventTimeout" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.setSpeechEventTimeout" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `setSpeechEventTimeout` + +Set the timeout for speech event detection. + +## Signature + +```typescript +setSpeechEventTimeout(milliseconds: number): this +``` + +## Parameters + + + Timeout in milliseconds. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 292. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/simulate-user-input.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/simulate-user-input.mdx new file mode 100644 index 0000000000..9f764d3338 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/simulate-user-input.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/simulate-user-input" +title: "simulateUserInput" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.simulateUserInput" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `simulateUserInput` + +Inject text as if the user had spoken it. + +## Signature + +```typescript +simulateUserInput(text: string): this +``` + +## Parameters + + + The simulated user input text. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 454. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/sip-refer.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/sip-refer.mdx new file mode 100644 index 0000000000..4261d06cd8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/sip-refer.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/sip-refer" +title: "sipRefer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.sipRefer" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `sipRefer` + +Send a SIP REFER to transfer the call. + +## Signature + +```typescript +sipRefer(toUri: string): this +``` + +## Parameters + + + The SIP URI to refer the call to. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 624. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/stop-background-file.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/stop-background-file.mdx new file mode 100644 index 0000000000..174ac9222d --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/stop-background-file.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/function-result/function-result/stop-background-file" +title: "stopBackgroundFile" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.stopBackgroundFile" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `stopBackgroundFile` + +Stop any currently playing background audio file. + +## Signature + +```typescript +stopBackgroundFile(): this +``` + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 254. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/stop-record-call.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/stop-record-call.mdx new file mode 100644 index 0000000000..296c707aac --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/stop-record-call.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/stop-record-call" +title: "stopRecordCall" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.stopRecordCall" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `stopRecordCall` + +Stop an active call recording. + +## Signature + +```typescript +stopRecordCall(controlId?: string): this +``` + +## Parameters + + + Optional control ID of the recording to stop. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/stop-tap.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/stop-tap.mdx new file mode 100644 index 0000000000..0643556ec8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/stop-tap.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/stop-tap" +title: "stopTap" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.stopTap" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `stopTap` + +Stop an active media tap. + +## Signature + +```typescript +stopTap(controlId?: string): this +``` + +## Parameters + + + Optional control ID of the tap to stop. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 596. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/stop.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/stop.mdx new file mode 100644 index 0000000000..d4a97569a3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/function-result/function-result/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.stop" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `stop` + +Stop the AI session. + +## Signature + +```typescript +stop(): this +``` + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 222. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/switch-context.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/switch-context.mdx new file mode 100644 index 0000000000..a8b61b95b5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/switch-context.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/function-result/function-result/switch-context" +title: "switchContext" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.switchContext" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `switchContext` + +Switch the AI context with optional new prompts and reset options. + +## Signature + +```typescript +switchContext(opts?: { ...4 fields }): this +``` + +## Parameters + + + Context switch options including system/user prompts and reset flags. + + + + + + + + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 396. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/swml-change-context.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/swml-change-context.mdx new file mode 100644 index 0000000000..5ff80da234 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/swml-change-context.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/swml-change-context" +title: "swmlChangeContext" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.swmlChangeContext" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `swmlChangeContext` + +Change the current SWML context. + +## Signature + +```typescript +swmlChangeContext(contextName: string): this +``` + +## Parameters + + + The name of the context to switch to. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 375. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/swml-change-step.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/swml-change-step.mdx new file mode 100644 index 0000000000..58c6b7a351 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/swml-change-step.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/swml-change-step" +title: "swmlChangeStep" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.swmlChangeStep" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `swmlChangeStep` + +Change the current SWML step. + +## Signature + +```typescript +swmlChangeStep(stepName: string): this +``` + +## Parameters + + + The name of the step to switch to. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 366. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/swml-transfer.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/swml-transfer.mdx new file mode 100644 index 0000000000..58d9cef5d5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/swml-transfer.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/function-result/function-result/swml-transfer" +title: "swmlTransfer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.swmlTransfer" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `swmlTransfer` + +Transfer the call to a SWML destination with a custom AI response. + +## Signature + +```typescript +swmlTransfer(dest: string, aiResponse: string, final: boolean = true): this +``` + +## Parameters + + + The transfer destination. + + + + The AI response text to set before transferring. + + + + Whether this is a final transfer. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 168. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/swml-user-event.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/swml-user-event.mdx new file mode 100644 index 0000000000..c2d02eafdc --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/swml-user-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/swml-user-event" +title: "swmlUserEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.swmlUserEvent" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `swmlUserEvent` + +Emit a custom user event via SWML. + +## Signature + +```typescript +swmlUserEvent(eventData: Record): this +``` + +## Parameters + + + The event payload. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 384. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/tap.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/tap.mdx new file mode 100644 index 0000000000..13acbd8be7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/tap.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/function-result/function-result/tap" +title: "tap" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.tap" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `tap` + +Start a media tap to stream audio to an external URI. + +## Signature + +```typescript +tap(opts: { ...6 fields }): this +``` + +## Parameters + + + Tap parameters including URI, direction, and codec. + + + + + + + + + + + + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 571. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/to-dict.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/to-dict.mdx new file mode 100644 index 0000000000..b9d4ff0ac9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/function-result/function-result/to-dict" +title: "toDict" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.toDict" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `toDict` + +Serialize this result to a plain object for the SWAIG response. + +## Signature + +```typescript +toDict(): Record +``` + +## Returns + +`Record` — A dictionary with response, action, and post\_process fields; falls back to "Action completed." if empty. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 887. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/toggle-functions.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/toggle-functions.mdx new file mode 100644 index 0000000000..0083fdf4b7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/toggle-functions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/toggle-functions" +title: "toggleFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.toggleFunctions" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `toggleFunctions` + +Enable or disable SWAIG functions by name. + +## Signature + +```typescript +toggleFunctions(toggles: { active: boolean; function: string }[]): this +``` + +## Parameters + + + Array of function name and active state pairs. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 425. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/update-global-data.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/update-global-data.mdx new file mode 100644 index 0000000000..12d66a78ab --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/update-global-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/update-global-data" +title: "updateGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.updateGlobalData" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `updateGlobalData` + +Merge key-value pairs into the global data store shared across functions. + +## Signature + +```typescript +updateGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to set or update. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 303. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/update-settings.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/update-settings.mdx new file mode 100644 index 0000000000..0f3816922f --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/update-settings.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/function-result/update-settings" +title: "updateSettings" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.updateSettings" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `updateSettings` + +Update AI engine settings at runtime. + +## Signature + +```typescript +updateSettings(settings: Record): this +``` + +## Parameters + + + Key-value pairs of settings to update. + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 443. diff --git a/fern/products/sdk-reference/typescript/function-result/function-result/wait-for-user.mdx b/fern/products/sdk-reference/typescript/function-result/function-result/wait-for-user.mdx new file mode 100644 index 0000000000..71905854ef --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/function-result/wait-for-user.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/function-result/function-result/wait-for-user" +title: "waitForUser" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "FunctionResult.FunctionResult.waitForUser" + parent: "FunctionResult.FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `waitForUser` + +Wait for user input before continuing. + +## Signature + +```typescript +waitForUser(opts?: { ...3 fields }): this +``` + +## Parameters + + + Options controlling wait behavior: enable/disable, timeout, or answer-first mode. + + + + + + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 206. diff --git a/fern/products/sdk-reference/typescript/function-result/index.mdx b/fern/products/sdk-reference/typescript/function-result/index.mdx new file mode 100644 index 0000000000..8258823645 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/function-result" +title: "FunctionResult" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `FunctionResult` + +## Signature + +```typescript +module FunctionResult +``` + +## Classes + + + + Builder for SWAIG function responses. + + + +## Interfaces + + + + A single action within a payment prompt (e.g., say or play). + + + + A custom key-value parameter passed to the payment connector. + + + + Prompt configuration for a payment collection flow. + + + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/function-result/payment-action/index.mdx b/fern/products/sdk-reference/typescript/function-result/payment-action/index.mdx new file mode 100644 index 0000000000..ac29ad0007 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/payment-action/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/payment-action" +title: "PaymentAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "FunctionResult.PaymentAction" + parent: "FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `PaymentAction` + +A single action within a payment prompt (e.g., say or play). + +## Signature + +```typescript +interface PaymentAction +``` + +## Properties + + + The phrase or URL to use for this action. + + + + The action type (e.g., "say", "play"). + + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 21. diff --git a/fern/products/sdk-reference/typescript/function-result/payment-parameter/index.mdx b/fern/products/sdk-reference/typescript/function-result/payment-parameter/index.mdx new file mode 100644 index 0000000000..f79d6af904 --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/payment-parameter/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/function-result/payment-parameter" +title: "PaymentParameter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "FunctionResult.PaymentParameter" + parent: "FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `PaymentParameter` + +A custom key-value parameter passed to the payment connector. + +## Signature + +```typescript +interface PaymentParameter +``` + +## Properties + + + The parameter name. + + + + The parameter value. + + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 29. diff --git a/fern/products/sdk-reference/typescript/function-result/payment-prompt/index.mdx b/fern/products/sdk-reference/typescript/function-result/payment-prompt/index.mdx new file mode 100644 index 0000000000..1d249fe8bd --- /dev/null +++ b/fern/products/sdk-reference/typescript/function-result/payment-prompt/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/function-result/payment-prompt" +title: "PaymentPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "FunctionResult.PaymentPrompt" + parent: "FunctionResult" + module: "FunctionResult" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts" +--- +# `PaymentPrompt` + +Prompt configuration for a payment collection flow. + +## Signature + +```typescript +interface PaymentPrompt +``` + +## Properties + + + Actions to perform for this prompt. + + + + Optional card type filter for this prompt. + + + + Optional error type this prompt handles. + + + + The situation this prompt applies to (e.g., "payment-card-number"). + + +## Source + +[`src/FunctionResult.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/FunctionResult.ts) + +Line 9. diff --git a/fern/products/sdk-reference/typescript/generate-verb-types/index.mdx b/fern/products/sdk-reference/typescript/generate-verb-types/index.mdx new file mode 100644 index 0000000000..3121506e50 --- /dev/null +++ b/fern/products/sdk-reference/typescript/generate-verb-types/index.mdx @@ -0,0 +1,25 @@ +--- +slug: "/reference/typescript/generate-verb-types" +title: "generateVerbTypes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "generateVerbTypes" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/generateVerbTypes.ts" +--- +# `generateVerbTypes` + +## Signature + +```typescript +module generateVerbTypes +``` + +## Source + +[`src/generateVerbTypes.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/generateVerbTypes.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/index.mdx b/fern/products/sdk-reference/typescript/index.mdx new file mode 100644 index 0000000000..7afbc1ed14 --- /dev/null +++ b/fern/products/sdk-reference/typescript/index.mdx @@ -0,0 +1,115 @@ +--- +title: "TypeScript SDK" +slug: "/reference/typescript" +lustri: + auto_generated: true + language: "typescript" + kind: "sdk" +--- +# TypeScript SDK Reference + +## Modules + +- [`Action`](/reference/typescript/relay/action) +- [`addresses`](/reference/typescript/rest/namespaces/addresses) +- [`agent-loader`](/reference/typescript/cli/agent-loader) +- [`AgentBase`](/reference/typescript/agent-base) +- [`AgentServer`](/reference/typescript/agent-server) +- [`api_ninjas_trivia`](/reference/typescript/skills/builtin/api-ninjas-trivia) +- [`ask_claude`](/reference/typescript/skills/builtin/ask-claude) +- [`AuthHandler`](/reference/typescript/auth-handler) +- [`BaseResource`](/reference/typescript/rest/base/base-resource) +- [`builtin`](/reference/typescript/skills/builtin) +- [`Call`](/reference/typescript/relay/call) +- [`callHandler`](/reference/typescript/rest/call-handler) +- [`calling`](/reference/typescript/rest/namespaces/calling) +- [`chat`](/reference/typescript/rest/namespaces/chat) +- [`claude_skills`](/reference/typescript/skills/builtin/claude-skills) +- [`compat`](/reference/typescript/rest/namespaces/compat) +- [`ConciergeAgent`](/reference/typescript/prefabs/concierge-agent) +- [`ConfigLoader`](/reference/typescript/config-loader) +- [`constants`](/reference/typescript/relay/constants) +- [`ContextBuilder`](/reference/typescript/context-builder) +- [`CrudResource`](/reference/typescript/rest/base/crud-resource) +- [`CrudWithAddresses`](/reference/typescript/rest/base/crud-with-addresses) +- [`custom_skills`](/reference/typescript/skills/builtin/custom-skills) +- [`DataMap`](/reference/typescript/data-map) +- [`datasphere`](/reference/typescript/rest/namespaces/datasphere) +- [`datasphere`](/reference/typescript/skills/builtin/datasphere) +- [`datasphere_serverless`](/reference/typescript/skills/builtin/datasphere-serverless) +- [`datetime`](/reference/typescript/skills/builtin/datetime) +- [`Deferred`](/reference/typescript/relay/deferred) +- [`fabric`](/reference/typescript/rest/namespaces/fabric) +- [`FAQBotAgent`](/reference/typescript/prefabs/faq-bot-agent) +- [`FunctionResult`](/reference/typescript/function-result) +- [`generateVerbTypes`](/reference/typescript/generate-verb-types) +- [`google_maps`](/reference/typescript/skills/builtin/google-maps) +- [`HttpClient`](/reference/typescript/rest/http-client) +- [`imported-numbers`](/reference/typescript/rest/namespaces/imported-numbers) +- [`info_gatherer`](/reference/typescript/skills/builtin/info-gatherer) +- [`InfoGathererAgent`](/reference/typescript/prefabs/info-gatherer-agent) +- [`joke`](/reference/typescript/skills/builtin/joke) +- [`livewire`](/reference/typescript/livewire) +- [`Logger`](/reference/typescript/logger) +- [`logs`](/reference/typescript/rest/namespaces/logs) +- [`lookup`](/reference/typescript/rest/namespaces/lookup) +- [`math`](/reference/typescript/skills/builtin/math) +- [`mcp_gateway`](/reference/typescript/skills/builtin/mcp-gateway) +- [`Message`](/reference/typescript/relay/message) +- [`mfa`](/reference/typescript/rest/namespaces/mfa) +- [`mock-data`](/reference/typescript/cli/mock-data) +- [`native_vector_search`](/reference/typescript/skills/builtin/native-vector-search) +- [`normalize`](/reference/typescript/relay/normalize) +- [`number-groups`](/reference/typescript/rest/namespaces/number-groups) +- [`pagination`](/reference/typescript/rest/pagination) +- [`phone-numbers`](/reference/typescript/rest/namespaces/phone-numbers) +- [`play_background_file`](/reference/typescript/skills/builtin/play-background-file) +- [`PomBuilder`](/reference/typescript/pom-builder) +- [`prefabs`](/reference/typescript/prefabs) +- [`project`](/reference/typescript/rest/namespaces/project) +- [`PromptManager`](/reference/typescript/prompt-manager) +- [`PromptObjectModel`](/reference/typescript/pom/prompt-object-model) +- [`pubsub`](/reference/typescript/rest/namespaces/pubsub) +- [`queues`](/reference/typescript/rest/namespaces/queues) +- [`ReceptionistAgent`](/reference/typescript/prefabs/receptionist-agent) +- [`recordings`](/reference/typescript/rest/namespaces/recordings) +- [`registry`](/reference/typescript/rest/namespaces/registry) +- [`relay`](/reference/typescript/relay) +- [`RelayClient`](/reference/typescript/relay/relay-client) +- [`RelayError`](/reference/typescript/relay/relay-error) +- [`RelayEvent`](/reference/typescript/relay/relay-event) +- [`rest`](/reference/typescript/rest) +- [`RestError`](/reference/typescript/rest/rest-error) +- [`SchemaUtils`](/reference/typescript/schema-utils) +- [`SecurityUtils`](/reference/typescript/security-utils) +- [`ServerlessAdapter`](/reference/typescript/serverless-adapter) +- [`SessionManager`](/reference/typescript/session-manager) +- [`short-codes`](/reference/typescript/rest/namespaces/short-codes) +- [`sip-profile`](/reference/typescript/rest/namespaces/sip-profile) +- [`SkillBase`](/reference/typescript/skills/skill-base) +- [`SkillManager`](/reference/typescript/skills/skill-manager) +- [`SkillRegistry`](/reference/typescript/skills/skill-registry) +- [`skills`](/reference/typescript/skills) +- [`spider`](/reference/typescript/skills/builtin/spider) +- [`SslConfig`](/reference/typescript/ssl-config) +- [`SurveyAgent`](/reference/typescript/prefabs/survey-agent) +- [`swaig-test`](/reference/typescript/cli/swaig-test) +- [`SwaigFunction`](/reference/typescript/swaig-function) +- [`swml_transfer`](/reference/typescript/skills/builtin/swml-transfer) +- [`SwmlBuilder`](/reference/typescript/swml-builder) +- [`SWMLHandler`](/reference/typescript/swml-handler) +- [`SWMLService`](/reference/typescript/swml-service) +- [`SwmlVerbMethods.generated`](/reference/typescript/swml-verb-methods.generated) +- [`TypeInference`](/reference/typescript/type-inference) +- [`types`](/reference/typescript/relay/types) +- [`types`](/reference/typescript/rest/types) +- [`types`](/reference/typescript/types) +- [`verified-callers`](/reference/typescript/rest/namespaces/verified-callers) +- [`video`](/reference/typescript/rest/namespaces/video) +- [`weather_api`](/reference/typescript/skills/builtin/weather-api) +- [`web_search`](/reference/typescript/skills/builtin/web-search) +- [`WebhookMiddleware`](/reference/typescript/webhook-middleware) +- [`WebhookValidator`](/reference/typescript/webhook-validator) +- [`WebService`](/reference/typescript/web-service) +- [`wikipedia_search`](/reference/typescript/skills/builtin/wikipedia-search) + diff --git a/fern/products/sdk-reference/typescript/list-skills-with-params.mdx b/fern/products/sdk-reference/typescript/list-skills-with-params.mdx new file mode 100644 index 0000000000..115035e3da --- /dev/null +++ b/fern/products/sdk-reference/typescript/list-skills-with-params.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/list-skills-with-params" +title: "listSkillsWithParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "listSkillsWithParams" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts" +--- +# `listSkillsWithParams` + +Get full schema for all registered skills, including parameter metadata. + +Equivalent to Python's `list_skills_with_params()`. Useful for GUI +configuration tools, API documentation, and programmatic skill discovery. + +## Signature + +```typescript +listSkillsWithParams(): Record +``` + +## Returns + +`Record` — Map of skill name to `schema info`. + +## Source + +[`src/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts) + +Line 286. diff --git a/fern/products/sdk-reference/typescript/list-skills.mdx b/fern/products/sdk-reference/typescript/list-skills.mdx new file mode 100644 index 0000000000..943685699e --- /dev/null +++ b/fern/products/sdk-reference/typescript/list-skills.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/list-skills" +title: "listSkills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "listSkills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts" +--- +# `listSkills` + +List metadata for all registered skills. + +Equivalent to Python's `list_skills()` — proxies to the singleton +`SkillRegistry`. Python's version returns a plain dict keyed by +skill name; this returns an array of `_SkillSchemaInfo` entries +(the TS shape is richer and includes the name field). + +## Signature + +```typescript +listSkills(): SkillSchemaInfo[] +``` + +## Returns + +`SkillSchemaInfo[]` — Array of skill metadata entries. + +## Source + +[`src/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts) + +Line 274. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-handoff/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/agent-handoff/constructor.mdx new file mode 100644 index 0000000000..6ac6160b90 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-handoff/constructor.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/typescript/livewire/agent-handoff/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.AgentHandoff.constructor" + parent: "livewire.AgentHandoff" + module: "livewire" +--- +# `constructor` + +## Signature + +```typescript +constructor(): AgentHandoff +``` + +## Returns + +`AgentHandoff` diff --git a/fern/products/sdk-reference/typescript/livewire/agent-handoff/index.mdx b/fern/products/sdk-reference/typescript/livewire/agent-handoff/index.mdx new file mode 100644 index 0000000000..1692aac93b --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-handoff/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/livewire/agent-handoff" +title: "AgentHandoff" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.AgentHandoff" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `AgentHandoff` + +Signals a handoff to another agent in multi-agent scenarios. + +## Signature + +```typescript +class AgentHandoff +``` + +## Properties + + + Target agent that should take over the conversation. + + + + Optional return value surfaced when the handoff completes. + + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 741. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-server/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/agent-server/constructor.mdx new file mode 100644 index 0000000000..62cd022c64 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-server/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/livewire/agent-server/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.AgentServer.constructor" + parent: "livewire.AgentServer" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(_opts?: any): AgentServer +``` + +## Parameters + + + +## Returns + +`AgentServer` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 988. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-server/index.mdx b/fern/products/sdk-reference/typescript/livewire/agent-server/index.mdx new file mode 100644 index 0000000000..2832c72b7f --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-server/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/livewire/agent-server" +title: "AgentServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.AgentServer" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `AgentServer` + +Mirrors a LiveKit AgentServer -- registers entrypoints and starts. + +Usage: +const server = new AgentServer(); +server.setupFnc = async (proc) => \{ ... \}; + +// Bare decorator usage: +server.rtcSession(myEntryFn); + +// Parameterized decorator usage: +server.rtcSession(\{ agentName: 'myAgent' \})(myEntryFn); + +cli.runApp(server); + +## Signature + +```typescript +class AgentServer +``` + +## Properties + + + Optional prewarm hook called before the entrypoint. Mirrors Python's setup\_fnc. + + +## Methods + + + + + + Decorator that registers the session entrypoint. + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 978. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-server/rtc-session.mdx b/fern/products/sdk-reference/typescript/livewire/agent-server/rtc-session.mdx new file mode 100644 index 0000000000..06907f2346 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-server/rtc-session.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/livewire/agent-server/rtc-session" +title: "rtcSession" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.AgentServer.rtcSession" + parent: "livewire.AgentServer" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `rtcSession` + +Decorator that registers the session entrypoint. + +Supports both bare and parameterized usage: +server.rtcSession(fn) // bare +server.rtcSession(fn, \{ agentName: 'x' \}) // with opts, explicit fn +server.rtcSession(\{ agentName: 'x' \})(fn) // parameterized decorator +@server.rtcSession // decorator (bare) +@server.rtcSession(\{ agentName: 'x' \}) // decorator (parameterized) + +## Signature + +```typescript +rtcSession( + fnOrOpts?: (ctx: JobContext) => Promise | { agentName?: string; onRequest?: (args: any[]) => any | null; onSessionEnd?: (args: any[]) => any | null; type?: string }, + opts?: { ...4 fields } +): void | (fn: (ctx: JobContext) => Promise) => (ctx: JobContext) => Promise +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`void | (fn: (ctx: JobContext) => Promise) => (ctx: JobContext) => Promise` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1000. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-session/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/agent-session/constructor.mdx new file mode 100644 index 0000000000..1fa5d7e97e --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-session/constructor.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/livewire/agent-session/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.AgentSession.constructor" + parent: "livewire.AgentSession" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(options?: { ...14 fields }): AgentSession +``` + +## Type Parameters + + + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`AgentSession` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 436. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-session/generate-reply.mdx b/fern/products/sdk-reference/typescript/livewire/agent-session/generate-reply.mdx new file mode 100644 index 0000000000..4e3902147b --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-session/generate-reply.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/livewire/agent-session/generate-reply" +title: "generateReply" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.AgentSession.generateReply" + parent: "livewire.AgentSession" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `generateReply` + +Trigger the agent to generate a reply, optionally with extra instructions. + +## Signature + +```typescript +generateReply(options?: { ...1 fields }): void +``` + +## Parameters + + + Generation options. + + + Extra instructions injected as a new prompt section before the next LLM turn. + + + +## Returns + +`void` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 619. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-session/get-sw-agent.mdx b/fern/products/sdk-reference/typescript/livewire/agent-session/get-sw-agent.mdx new file mode 100644 index 0000000000..0d0d073591 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-session/get-sw-agent.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/livewire/agent-session/get-sw-agent" +title: "getSwAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.AgentSession.getSwAgent" + parent: "livewire.AgentSession" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `getSwAgent` + +Return the underlying SignalWire [AgentBase](/reference/typescript/agent-base). Useful for tests and +advanced use cases that need to reach past the LiveKit facade. + +## Signature + +```typescript +getSwAgent(): AgentBase | undefined +``` + +## Returns + +`AgentBase | undefined` — The wrapped `AgentBase`, or `undefined` before [start](/reference/typescript/livewire/agent-session/start). + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 669. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-session/index.mdx b/fern/products/sdk-reference/typescript/livewire/agent-session/index.mdx new file mode 100644 index 0000000000..037fc43943 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-session/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/livewire/agent-session" +title: "AgentSession" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.AgentSession" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `AgentSession` + +Mirrors a LiveKit `AgentSession` — binds an [Agent](/reference/typescript/livewire/agent) to SignalWire. + +Call [AgentSession.start](/reference/typescript/livewire/agent-session/start) with an `Agent` to construct an internal +[AgentBase](/reference/typescript/agent-base) and begin serving SWML. Pipeline-related options are +accepted for API parity but are no-ops server-side. + +## Signature + +```typescript +class AgentSession +``` + +## Type Parameters + + + +## Properties + + + Conversation history entries captured over the session's lifetime. + + + + Current per-session user data. Set by the constructor or via the setter. + + +## Methods + + + + + + Trigger the agent to generate a reply, optionally with extra instructions. + + + + Return the underlying SignalWire [AgentBase](/reference/typescript/agent-base). Useful for tests and advanced use cases that need to reach past the LiveKit facade. + + + + Interrupt current speech. **No-op** on SignalWire — barge-in is handled automatically by the control plane. + + + + Queue text to be spoken by the agent. + + + + Start the session by binding the agent to a freshly-constructed [AgentBase](/reference/typescript/agent-base), mapping LiveKit-style options onto SignalWire AI params. + + + + Swap the [Agent](/reference/typescript/livewire/agent) bound to this session. + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 420. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-session/interrupt.mdx b/fern/products/sdk-reference/typescript/livewire/agent-session/interrupt.mdx new file mode 100644 index 0000000000..61ef5b12ec --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-session/interrupt.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/livewire/agent-session/interrupt" +title: "interrupt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.AgentSession.interrupt" + parent: "livewire.AgentSession" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `interrupt` + +Interrupt current speech. **No-op** on SignalWire — barge-in is handled +automatically by the control plane. + +## Signature + +```typescript +interrupt(): void +``` + +## Returns + +`void` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 629. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-session/say.mdx b/fern/products/sdk-reference/typescript/livewire/agent-session/say.mdx new file mode 100644 index 0000000000..5913b2f20c --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-session/say.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/livewire/agent-session/say" +title: "say" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.AgentSession.say" + parent: "livewire.AgentSession" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `say` + +Queue text to be spoken by the agent. + +Before [start](/reference/typescript/livewire/agent-session/start) is called, text is buffered and injected at start +time as the agent's initial greeting. After start, text is added as an +additional prompt section. + +## Signature + +```typescript +say(text: string): void +``` + +## Parameters + + + Line for the agent to speak. + + +## Returns + +`void` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 602. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-session/start.mdx b/fern/products/sdk-reference/typescript/livewire/agent-session/start.mdx new file mode 100644 index 0000000000..b976e2fd12 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-session/start.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/livewire/agent-session/start" +title: "start" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.AgentSession.start" + parent: "livewire.AgentSession" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `start` + +Start the session by binding the agent to a freshly-constructed +[AgentBase](/reference/typescript/agent-base), mapping LiveKit-style options onto SignalWire AI params. + +Must be called before any other method on this session. The underlying +`AgentBase` is not started here — use [runApp](/reference/typescript/livewire/run-app) or an `AgentServer` +to serve it. + +## Signature + +```typescript +start(params: { ...3 fields }): Promise +``` + +## Parameters + + + Start parameters. + + + The [Agent](/reference/typescript/livewire/agent) to bind. + + + + Call-recording flag placeholder; ignored on SignalWire. + + + + LiveKit room placeholder; ignored on SignalWire. + + + +## Returns + +`Promise` — Resolves once the underlying `AgentBase` has been built. + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/livewire/agent-session/update-agent.mdx b/fern/products/sdk-reference/typescript/livewire/agent-session/update-agent.mdx new file mode 100644 index 0000000000..f32c535846 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent-session/update-agent.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/livewire/agent-session/update-agent" +title: "updateAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.AgentSession.updateAgent" + parent: "livewire.AgentSession" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `updateAgent` + +Swap the [Agent](/reference/typescript/livewire/agent) bound to this session. + +Preserves the underlying `AgentBase` but replaces its prompt with the new +agent's instructions. + +## Signature + +```typescript +updateAgent(agent: Agent): void +``` + +## Parameters + + + Replacement agent. + + +## Returns + +`void` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 641. diff --git a/fern/products/sdk-reference/typescript/livewire/agent/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/agent/constructor.mdx new file mode 100644 index 0000000000..5ba2a36c27 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent/constructor.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/livewire/agent/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.Agent.constructor" + parent: "livewire.Agent" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(options?: { ...13 fields }): Agent +``` + +## Type Parameters + + + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`Agent` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 182. diff --git a/fern/products/sdk-reference/typescript/livewire/agent/index.mdx b/fern/products/sdk-reference/typescript/livewire/agent/index.mdx new file mode 100644 index 0000000000..c07dceaeb3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent/index.mdx @@ -0,0 +1,113 @@ +--- +slug: "/reference/typescript/livewire/agent" +title: "Agent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.Agent" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `Agent` + +Mirrors a LiveKit `voice.Agent` — holds instructions and tool definitions. + +Pipeline options (`stt`, `tts`, `vad`, `llm`, `turnDetection`) are accepted +for API parity but are **no-ops** — SignalWire's control plane handles the +entire AI pipeline server-side. Set instructions and tools; everything else +just logs once and continues. + +## Signature + +```typescript +class Agent +``` + +## Type Parameters + + + +## Examples + +```typescript +import { livewire } from '@signalwire/sdk'; + +const timeTool = livewire.tool({ + description: 'Return the current time.', + execute: () => new Date().toISOString(), +}); + +const agent = new livewire.Agent({ + instructions: 'You are a friendly helper.', + tools: [{ ...timeTool, name: 'time' }], +}); + +const session = new livewire.AgentSession(); +await session.start({ agent }); +``` + +## Properties + + + System instructions passed through to the SignalWire AI prompt. + + + + The currently-bound [AgentSession](/reference/typescript/livewire/agent-session), or `undefined` until [AgentSession.start](/reference/typescript/livewire/agent-session/start) is called. + + + + Registered tools keyed by name. Mutated by [updateTools](/reference/typescript/livewire/agent/update-tools). + + + + Arbitrary per-session user data passed to tool handlers via [RunContext.userData](/reference/typescript/livewire/run-context#user-data). + + +## Methods + + + + + + LiveKit-compatible LLM node. **No-op** on SignalWire — the control plane handles LLM inference server-side. + + + + Lifecycle hook called when the agent enters an active call. Override in a subclass to run setup logic — the default is a no-op. + + + + Lifecycle hook called when the agent exits (call ended or handoff). Override in a subclass to run teardown logic — the default is a no-op. + + + + Lifecycle hook called when the user finishes speaking. Override in a subclass to inspect / mutate the turn context before the LLM responds — the default is a no-op. + + + + LiveKit-compatible STT node. **No-op** on SignalWire — the control plane handles speech recognition server-side. + + + + LiveKit-compatible TTS node. **No-op** on SignalWire — the control plane handles text-to-speech server-side. + + + + Update the agent's instructions mid-session. + + + + Update the agent's tool list mid-session. + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 163. diff --git a/fern/products/sdk-reference/typescript/livewire/agent/llm-node.mdx b/fern/products/sdk-reference/typescript/livewire/agent/llm-node.mdx new file mode 100644 index 0000000000..25b92b50da --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent/llm-node.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/livewire/agent/llm-node" +title: "llmNode" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.Agent.llmNode" + parent: "livewire.Agent" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `llmNode` + +LiveKit-compatible LLM node. **No-op** on SignalWire — the control plane +handles LLM inference server-side. + +## Signature + +```typescript +llmNode( + _chatCtx?: unknown, + _tools?: unknown, + _modelSettings?: unknown +): Promise +``` + +## Parameters + + + Chat context (ignored). + + + + Tool list (ignored). + + + + Model settings (ignored). + + +## Returns + +`Promise` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 315. diff --git a/fern/products/sdk-reference/typescript/livewire/agent/on-enter.mdx b/fern/products/sdk-reference/typescript/livewire/agent/on-enter.mdx new file mode 100644 index 0000000000..0cb46bb0b0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent/on-enter.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/livewire/agent/on-enter" +title: "onEnter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.Agent.onEnter" + parent: "livewire.Agent" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `onEnter` + +Lifecycle hook called when the agent enters an active call. +Override in a subclass to run setup logic — the default is a no-op. + +## Signature + +```typescript +onEnter(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 271. diff --git a/fern/products/sdk-reference/typescript/livewire/agent/on-exit.mdx b/fern/products/sdk-reference/typescript/livewire/agent/on-exit.mdx new file mode 100644 index 0000000000..237bdb9b3d --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent/on-exit.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/livewire/agent/on-exit" +title: "onExit" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.Agent.onExit" + parent: "livewire.Agent" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `onExit` + +Lifecycle hook called when the agent exits (call ended or handoff). +Override in a subclass to run teardown logic — the default is a no-op. + +## Signature + +```typescript +onExit(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 277. diff --git a/fern/products/sdk-reference/typescript/livewire/agent/on-user-turn-completed.mdx b/fern/products/sdk-reference/typescript/livewire/agent/on-user-turn-completed.mdx new file mode 100644 index 0000000000..a4c52e2bc7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent/on-user-turn-completed.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/livewire/agent/on-user-turn-completed" +title: "onUserTurnCompleted" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.Agent.onUserTurnCompleted" + parent: "livewire.Agent" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `onUserTurnCompleted` + +Lifecycle hook called when the user finishes speaking. +Override in a subclass to inspect / mutate the turn context before the +LLM responds — the default is a no-op. + +## Signature + +```typescript +onUserTurnCompleted(_turnCtx?: unknown, _newMessage?: unknown): Promise +``` + +## Parameters + + + Turn context (LiveKit shape; passed through opaquely). + + + + Newly-captured user message. + + +## Returns + +`Promise` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 287. diff --git a/fern/products/sdk-reference/typescript/livewire/agent/stt-node.mdx b/fern/products/sdk-reference/typescript/livewire/agent/stt-node.mdx new file mode 100644 index 0000000000..abbbfda4cb --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent/stt-node.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/livewire/agent/stt-node" +title: "sttNode" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.Agent.sttNode" + parent: "livewire.Agent" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `sttNode` + +LiveKit-compatible STT node. **No-op** on SignalWire — the control plane +handles speech recognition server-side. + +## Signature + +```typescript +sttNode(_audio?: unknown, _modelSettings?: unknown): Promise +``` + +## Parameters + + + Audio input (ignored). + + + + Model settings (ignored). + + +## Returns + +`Promise` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 300. diff --git a/fern/products/sdk-reference/typescript/livewire/agent/tts-node.mdx b/fern/products/sdk-reference/typescript/livewire/agent/tts-node.mdx new file mode 100644 index 0000000000..649d4e7e43 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent/tts-node.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/livewire/agent/tts-node" +title: "ttsNode" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.Agent.ttsNode" + parent: "livewire.Agent" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `ttsNode` + +LiveKit-compatible TTS node. **No-op** on SignalWire — the control plane +handles text-to-speech server-side. + +## Signature + +```typescript +ttsNode(_text?: unknown, _modelSettings?: unknown): Promise +``` + +## Parameters + + + Text to synthesise (ignored). + + + + Model settings (ignored). + + +## Returns + +`Promise` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 329. diff --git a/fern/products/sdk-reference/typescript/livewire/agent/update-instructions.mdx b/fern/products/sdk-reference/typescript/livewire/agent/update-instructions.mdx new file mode 100644 index 0000000000..7294fb7682 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent/update-instructions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/livewire/agent/update-instructions" +title: "updateInstructions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.Agent.updateInstructions" + parent: "livewire.Agent" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `updateInstructions` + +Update the agent's instructions mid-session. + +## Signature + +```typescript +updateInstructions(instructions: string): Promise +``` + +## Parameters + + + New system-instructions string for the agent. + + +## Returns + +`Promise` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 345. diff --git a/fern/products/sdk-reference/typescript/livewire/agent/update-tools.mdx b/fern/products/sdk-reference/typescript/livewire/agent/update-tools.mdx new file mode 100644 index 0000000000..00dc5a2294 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/agent/update-tools.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/livewire/agent/update-tools" +title: "updateTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.Agent.updateTools" + parent: "livewire.Agent" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `updateTools` + +Update the agent's tool list mid-session. + +Replaces the current tool record with one built from the given array, +keyed by `tool.name`. Useful for dynamic tool injection based on +conversation state. + +## Signature + +```typescript +updateTools(tools: FunctionTool[]): Promise +``` + +## Parameters + + + Ordered array of [FunctionTool](/reference/typescript/livewire/function-tool) definitions. Each tool's `name` is used as its map key. + + +## Returns + +`Promise` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 359. diff --git a/fern/products/sdk-reference/typescript/livewire/chat-context/append.mdx b/fern/products/sdk-reference/typescript/livewire/chat-context/append.mdx new file mode 100644 index 0000000000..e1eebd96a6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/chat-context/append.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/livewire/chat-context/append" +title: "append" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.ChatContext.append" + parent: "livewire.ChatContext" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `append` + +Append a chat message. + +## Signature + +```typescript +append(options: { ...2 fields }): this +``` + +## Parameters + + + Message content. + + + Speaker role (`"user"`, `"assistant"`, or `"system"`). Defaults to `"user"`. + + + + Message text. Defaults to `""`. + + + +## Returns + +`this` — This instance for chaining. + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1232. diff --git a/fern/products/sdk-reference/typescript/livewire/chat-context/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/chat-context/constructor.mdx new file mode 100644 index 0000000000..f5711169d8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/chat-context/constructor.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/typescript/livewire/chat-context/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.ChatContext.constructor" + parent: "livewire.ChatContext" + module: "livewire" +--- +# `constructor` + +## Signature + +```typescript +constructor(): ChatContext +``` + +## Returns + +`ChatContext` diff --git a/fern/products/sdk-reference/typescript/livewire/chat-context/index.mdx b/fern/products/sdk-reference/typescript/livewire/chat-context/index.mdx new file mode 100644 index 0000000000..d7e11a0cf4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/chat-context/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/livewire/chat-context" +title: "ChatContext" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.ChatContext" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `ChatContext` + +Minimal `ChatContext` matching LiveKit's `ChatContext`. + +## Signature + +```typescript +class ChatContext +``` + +## Properties + + + Ordered chat messages, each `{ role, content }`. + + +## Methods + + + + Append a chat message. + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1219. diff --git a/fern/products/sdk-reference/typescript/livewire/define-agent.mdx b/fern/products/sdk-reference/typescript/livewire/define-agent.mdx new file mode 100644 index 0000000000..87d7525d4d --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/define-agent.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/livewire/define-agent" +title: "defineAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "livewire.defineAgent" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `defineAgent` + +Mirrors `@livekit/agents.defineAgent()`. + +Packages an entry function (plus an optional prewarm hook) for later +execution by [runApp](/reference/typescript/livewire/run-app). Pass-through — no side effects. + +## Signature + +```typescript +defineAgent( + agent: { ...2 fields } +): { entry: (ctx: JobContext) => Promise; prewarm?: (proc: JobProcess) => any } +``` + +## Parameters + + + Entry and (optional) prewarm functions. + + + Main callback invoked with a [JobContext](/reference/typescript/livewire/job-context) when the agent runs. + + + + Optional prewarm callback invoked with a [JobProcess](/reference/typescript/livewire/job-process) before `entry`. + + + +## Returns + +`{ entry: (ctx: JobContext) => Promise; prewarm?: (proc: JobProcess) => any }` — The same record (pass-through), typed consistently. + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 865. diff --git a/fern/products/sdk-reference/typescript/livewire/function-tool/index.mdx b/fern/products/sdk-reference/typescript/livewire/function-tool/index.mdx new file mode 100644 index 0000000000..daef352c08 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/function-tool/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/livewire/function-tool" +title: "FunctionTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "livewire.FunctionTool" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `FunctionTool` + +A tool definition that can be registered on an [Agent](/reference/typescript/livewire/agent). + +## Signature + +```typescript +interface FunctionTool +``` + +## Properties + + + Human-readable description shown to the LLM. + + + + Handler invoked by the platform when the LLM calls this tool. + + + + Tool name. Populated when the tool is attached to an `Agent.tools` map. + + + + JSON schema (or Zod schema passthrough) for the tool's parameters. + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 122. diff --git a/fern/products/sdk-reference/typescript/livewire/handoff.mdx b/fern/products/sdk-reference/typescript/livewire/handoff.mdx new file mode 100644 index 0000000000..5a5afab1e2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/handoff.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/livewire/handoff" +title: "handoff" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "livewire.handoff" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `handoff` + +Create an [AgentHandoff](/reference/typescript/livewire/agent-handoff) descriptor for multi-agent scenarios. + +## Signature + +```typescript +handoff(options: { ...2 fields }): AgentHandoff +``` + +## Parameters + + + Handoff parameters. + + + Agent to transfer control to. + + + + Optional string returned to the current agent when the handoff completes. + + + +## Returns + +`AgentHandoff` — A handoff descriptor that can be returned from a tool handler. + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 729. diff --git a/fern/products/sdk-reference/typescript/livewire/index.mdx b/fern/products/sdk-reference/typescript/livewire/index.mdx new file mode 100644 index 0000000000..3f4f04007c --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/index.mdx @@ -0,0 +1,157 @@ +--- +slug: "/reference/typescript/livewire" +title: "livewire" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `livewire` + +## Signature + +```typescript +module livewire +``` + +## Constants + + + + + LiveKit cli namespace equivalent. + + + + + + LiveKit llm namespace equivalent. + + + + Rotating "Did you know?" tips printed to stderr by the LiveWire banner. Exported for tests; reorder or extend to change what's displayed. + + + + LiveKit voice namespace equivalent. + + +## Functions + + + + Mirrors `@livekit/agents.defineAgent()`. + + + + Create an [AgentHandoff](/reference/typescript/livewire/agent-handoff) descriptor for multi-agent scenarios. + + + + Print the ASCII banner to stderr, using ANSI cyan when stderr is a TTY. + + + + + + Mirrors `cli.runApp()` from `@livekit/agents-js`. + + + + Create a tool definition — mirrors `llm.tool()` from `@livekit/agents-js`. + + + +## Classes + + + + Mirrors a LiveKit `voice.Agent` — holds instructions and tool definitions. + + + + Signals a handoff to another agent in multi-agent scenarios. + + + + Mirrors a LiveKit AgentServer -- registers entrypoints and starts. + + + + Mirrors a LiveKit `AgentSession` — binds an [Agent](/reference/typescript/livewire/agent) to SignalWire. + + + + Minimal `ChatContext` matching LiveKit's `ChatContext`. + + + + Mirrors a LiveKit `JobContext` — provides room and connection info to the entry-point callback registered via [defineAgent](/reference/typescript/livewire/define-agent). + + + + Mirrors a LiveKit `JobProcess` — placeholder for prewarm / setup hooks. + + + + NoopTracker ensures each informational message is logged at most once, preventing spam when the same noop path is exercised repeatedly. + + + + Stub `Room` — SignalWire does not use the LiveKit room abstraction. + + + + Mirrors a LiveKit `RunContext` — passed to tool handlers so they can read the current session, call handle, and user data. + + + + Stub class mirroring LiveKit's `ServerOptions`. + + + + Signals that a tool should not trigger another LLM reply. + + + + Error thrown from a tool to signal failure back to the LLM. + + + + Stub class mirroring LiveKit's `WorkerOptions`. + + + +## Interfaces + + + + A tool definition that can be registered on an [Agent](/reference/typescript/livewire/agent). + + + + Voice configuration options passed through to the SignalWire AI config. + + + +## Modules + + + + Stub inference types matching LiveKit's `inference` namespace. + + + + Stub providers matching common LiveKit plugin packages. + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/livewire/inference/index.mdx b/fern/products/sdk-reference/typescript/livewire/inference/index.mdx new file mode 100644 index 0000000000..d25459bc44 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/inference/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/livewire/inference" +title: "inference" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "livewire.inference" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `inference` + +Stub inference types matching LiveKit's `inference` namespace. + +None of these run inference on the client — SignalWire performs STT / LLM / +TTS in its control plane. These classes exist so LiveKit code that imports +and instantiates them still compiles. + +## Signature + +```typescript +module inference +``` + +## Classes + + + + LiveKit inference-LLM stub. Captures the model name; runs no inference locally. + + + + LiveKit inference-STT stub. Captures the model name; runs no inference locally. + + + + LiveKit inference-TTS stub. Captures the model name; runs no inference locally. + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1158. diff --git a/fern/products/sdk-reference/typescript/livewire/inference/llm/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/inference/llm/constructor.mdx new file mode 100644 index 0000000000..d6319ca264 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/inference/llm/constructor.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/livewire/inference/llm/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.inference.LLM.constructor" + parent: "livewire.inference.LLM" + module: "livewire.inference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(model: string = '', _opts?: any): LLM +``` + +## Parameters + + + Model identifier (captured). + + + + Additional options (ignored). + + +## Returns + +`LLM` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1184. diff --git a/fern/products/sdk-reference/typescript/livewire/inference/llm/index.mdx b/fern/products/sdk-reference/typescript/livewire/inference/llm/index.mdx new file mode 100644 index 0000000000..03c7ae3f2a --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/inference/llm/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/livewire/inference/llm" +title: "LLM" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.inference.LLM" + parent: "livewire.inference" + module: "livewire.inference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `LLM` + +LiveKit inference-LLM stub. Captures the model name; runs no inference locally. + +## Signature + +```typescript +class LLM +``` + +## Properties + + + Model identifier captured from the constructor. + + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1177. diff --git a/fern/products/sdk-reference/typescript/livewire/inference/stt/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/inference/stt/constructor.mdx new file mode 100644 index 0000000000..589f38c7b9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/inference/stt/constructor.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/livewire/inference/stt/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.inference.STT.constructor" + parent: "livewire.inference.STT" + module: "livewire.inference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(model: string = '', _opts?: any): STT +``` + +## Parameters + + + Model identifier (captured). + + + + Additional options (ignored). + + +## Returns + +`STT` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1167. diff --git a/fern/products/sdk-reference/typescript/livewire/inference/stt/index.mdx b/fern/products/sdk-reference/typescript/livewire/inference/stt/index.mdx new file mode 100644 index 0000000000..deca6614c8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/inference/stt/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/livewire/inference/stt" +title: "STT" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.inference.STT" + parent: "livewire.inference" + module: "livewire.inference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `STT` + +LiveKit inference-STT stub. Captures the model name; runs no inference locally. + +## Signature + +```typescript +class STT +``` + +## Properties + + + Model identifier captured from the constructor. + + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1160. diff --git a/fern/products/sdk-reference/typescript/livewire/inference/tts/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/inference/tts/constructor.mdx new file mode 100644 index 0000000000..8fa959bbfb --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/inference/tts/constructor.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/livewire/inference/tts/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.inference.TTS.constructor" + parent: "livewire.inference.TTS" + module: "livewire.inference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(model: string = '', _opts?: any): TTS +``` + +## Parameters + + + Model identifier (captured). + + + + Additional options (ignored). + + +## Returns + +`TTS` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1197. diff --git a/fern/products/sdk-reference/typescript/livewire/inference/tts/index.mdx b/fern/products/sdk-reference/typescript/livewire/inference/tts/index.mdx new file mode 100644 index 0000000000..08b693960b --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/inference/tts/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/livewire/inference/tts" +title: "TTS" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.inference.TTS" + parent: "livewire.inference" + module: "livewire.inference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `TTS` + +LiveKit inference-TTS stub. Captures the model name; runs no inference locally. + +## Signature + +```typescript +class TTS +``` + +## Properties + + + Model identifier captured from the constructor. + + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1190. diff --git a/fern/products/sdk-reference/typescript/livewire/job-context/connect.mdx b/fern/products/sdk-reference/typescript/livewire/job-context/connect.mdx new file mode 100644 index 0000000000..b1e1300d23 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/job-context/connect.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/livewire/job-context/connect" +title: "connect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.JobContext.connect" + parent: "livewire.JobContext" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `connect` + +Connect to the platform. **No-op** on SignalWire — the control plane +manages connection lifecycle automatically. + +## Signature + +```typescript +connect(): Promise +``` + +## Returns + +`Promise` — Resolves immediately. + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 827. diff --git a/fern/products/sdk-reference/typescript/livewire/job-context/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/job-context/constructor.mdx new file mode 100644 index 0000000000..e1cbddb8f9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/job-context/constructor.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/livewire/job-context/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.JobContext.constructor" + parent: "livewire.JobContext" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(): JobContext +``` + +## Returns + +`JobContext` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 816. diff --git a/fern/products/sdk-reference/typescript/livewire/job-context/index.mdx b/fern/products/sdk-reference/typescript/livewire/job-context/index.mdx new file mode 100644 index 0000000000..017faaa412 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/job-context/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/livewire/job-context" +title: "JobContext" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.JobContext" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `JobContext` + +Mirrors a LiveKit `JobContext` — provides room and connection info to the +entry-point callback registered via [defineAgent](/reference/typescript/livewire/define-agent). + +## Signature + +```typescript +class JobContext +``` + +## Properties + + + Shared [JobProcess](/reference/typescript/livewire/job-process) instance for prewarm-to-entry data passing. + + + + Placeholder [Room](/reference/typescript/livewire/room) (see class docs). + + +## Methods + + + + Connect to the platform. **No-op** on SignalWire — the control plane manages connection lifecycle automatically. + + + + + + Wait for a participant to join. **No-op** on SignalWire — returns an immediate stub participant. + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 808. diff --git a/fern/products/sdk-reference/typescript/livewire/job-context/wait-for-participant.mdx b/fern/products/sdk-reference/typescript/livewire/job-context/wait-for-participant.mdx new file mode 100644 index 0000000000..ca44ff063c --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/job-context/wait-for-participant.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/livewire/job-context/wait-for-participant" +title: "waitForParticipant" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.JobContext.waitForParticipant" + parent: "livewire.JobContext" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `waitForParticipant` + +Wait for a participant to join. **No-op** on SignalWire — returns an +immediate stub participant. + +## Signature + +```typescript +waitForParticipant(options?: { ...1 fields }): Promise +``` + +## Parameters + + + Participant match options. + + + Requested identity; echoed back in the stub. Defaults to `"caller"`. + + + +## Returns + +`Promise` — A stub participant `{ identity }` record. + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 843. diff --git a/fern/products/sdk-reference/typescript/livewire/job-process/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/job-process/constructor.mdx new file mode 100644 index 0000000000..07bab204e5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/job-process/constructor.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/typescript/livewire/job-process/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.JobProcess.constructor" + parent: "livewire.JobProcess" + module: "livewire" +--- +# `constructor` + +## Signature + +```typescript +constructor(): JobProcess +``` + +## Returns + +`JobProcess` diff --git a/fern/products/sdk-reference/typescript/livewire/job-process/index.mdx b/fern/products/sdk-reference/typescript/livewire/job-process/index.mdx new file mode 100644 index 0000000000..a4c0c31e8a --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/job-process/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/livewire/job-process" +title: "JobProcess" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.JobProcess" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `JobProcess` + +Mirrors a LiveKit `JobProcess` — placeholder for prewarm / setup hooks. + +On SignalWire the control plane pre-warms infrastructure at scale, so this +class carries no real state beyond the LiveKit-compatible `userData` bag. + +## Signature + +```typescript +class JobProcess +``` + +## Properties + + + Mutable bag shared across prewarm and entry-point callbacks. + + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 780. diff --git a/fern/products/sdk-reference/typescript/livewire/noop-tracker/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/noop-tracker/constructor.mdx new file mode 100644 index 0000000000..274f6497d4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/noop-tracker/constructor.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/typescript/livewire/noop-tracker/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.NoopTracker.constructor" + parent: "livewire.NoopTracker" + module: "livewire" +--- +# `constructor` + +## Signature + +```typescript +constructor(): NoopTracker +``` + +## Returns + +`NoopTracker` diff --git a/fern/products/sdk-reference/typescript/livewire/noop-tracker/has-logged.mdx b/fern/products/sdk-reference/typescript/livewire/noop-tracker/has-logged.mdx new file mode 100644 index 0000000000..cfade457ae --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/noop-tracker/has-logged.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/livewire/noop-tracker/has-logged" +title: "hasLogged" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.NoopTracker.hasLogged" + parent: "livewire.NoopTracker" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `hasLogged` + +Expose whether a key has been logged (for testing). + +## Signature + +```typescript +hasLogged(key: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 88. diff --git a/fern/products/sdk-reference/typescript/livewire/noop-tracker/index.mdx b/fern/products/sdk-reference/typescript/livewire/noop-tracker/index.mdx new file mode 100644 index 0000000000..fa0e3f2bac --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/noop-tracker/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/livewire/noop-tracker" +title: "NoopTracker" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.NoopTracker" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `NoopTracker` + +NoopTracker ensures each informational message is logged at most once, +preventing spam when the same noop path is exercised repeatedly. + +## Signature + +```typescript +class NoopTracker +``` + +## Methods + + + + + + Expose whether a key has been logged (for testing). + + + + Log the given message the first time this key is seen. + + + + Reset all tracked keys (for testing). + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 72. diff --git a/fern/products/sdk-reference/typescript/livewire/noop-tracker/once.mdx b/fern/products/sdk-reference/typescript/livewire/noop-tracker/once.mdx new file mode 100644 index 0000000000..76a9295485 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/noop-tracker/once.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/livewire/noop-tracker/once" +title: "once" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.NoopTracker.once" + parent: "livewire.NoopTracker" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `once` + +Log the given message the first time this key is seen. + +## Signature + +```typescript +once(key: string, message: string): void +``` + +## Parameters + + + Dedup key. Subsequent calls with the same key are silent. + + + + Message to write to stderr on first occurrence. + + +## Returns + +`void` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/livewire/noop-tracker/reset.mdx b/fern/products/sdk-reference/typescript/livewire/noop-tracker/reset.mdx new file mode 100644 index 0000000000..5647b3659c --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/noop-tracker/reset.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/livewire/noop-tracker/reset" +title: "reset" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.NoopTracker.reset" + parent: "livewire.NoopTracker" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `reset` + +Reset all tracked keys (for testing). + +## Signature + +```typescript +reset(): void +``` + +## Returns + +`void` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 93. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/cartesia-tts/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/cartesia-tts/constructor.mdx new file mode 100644 index 0000000000..29fefce0db --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/cartesia-tts/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/livewire/plugins/cartesia-tts/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.plugins.CartesiaTTS.constructor" + parent: "livewire.plugins.CartesiaTTS" + module: "livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(_opts?: any): CartesiaTTS +``` + +## Parameters + + + Cartesia options (ignored). + + +## Returns + +`CartesiaTTS` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1105. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/cartesia-tts/index.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/cartesia-tts/index.mdx new file mode 100644 index 0000000000..2a53775a29 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/cartesia-tts/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/livewire/plugins/cartesia-tts" +title: "CartesiaTTS" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.plugins.CartesiaTTS" + parent: "livewire.plugins" + module: "livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `CartesiaTTS` + +LiveKit Cartesia-TTS plugin stub. No-op on SignalWire. + +## Signature + +```typescript +class CartesiaTTS +``` + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1103. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/deepgram-stt/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/deepgram-stt/constructor.mdx new file mode 100644 index 0000000000..d0735dbf5b --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/deepgram-stt/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/livewire/plugins/deepgram-stt/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.plugins.DeepgramSTT.constructor" + parent: "livewire.plugins.DeepgramSTT" + module: "livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(_opts?: any): DeepgramSTT +``` + +## Parameters + + + Deepgram options (ignored). + + +## Returns + +`DeepgramSTT` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1075. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/deepgram-stt/index.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/deepgram-stt/index.mdx new file mode 100644 index 0000000000..e6553cfc3d --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/deepgram-stt/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/livewire/plugins/deepgram-stt" +title: "DeepgramSTT" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.plugins.DeepgramSTT" + parent: "livewire.plugins" + module: "livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `DeepgramSTT` + +LiveKit Deepgram-STT plugin stub. No-op on SignalWire. + +## Signature + +```typescript +class DeepgramSTT +``` + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1073. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/eleven-labs-tts/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/eleven-labs-tts/constructor.mdx new file mode 100644 index 0000000000..838276ae03 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/eleven-labs-tts/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/livewire/plugins/eleven-labs-tts/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.plugins.ElevenLabsTTS.constructor" + parent: "livewire.plugins.ElevenLabsTTS" + module: "livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(_opts?: any): ElevenLabsTTS +``` + +## Parameters + + + ElevenLabs options (ignored). + + +## Returns + +`ElevenLabsTTS` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1116. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/eleven-labs-tts/index.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/eleven-labs-tts/index.mdx new file mode 100644 index 0000000000..50de5e8e34 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/eleven-labs-tts/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/livewire/plugins/eleven-labs-tts" +title: "ElevenLabsTTS" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.plugins.ElevenLabsTTS" + parent: "livewire.plugins" + module: "livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `ElevenLabsTTS` + +LiveKit ElevenLabs-TTS plugin stub. No-op on SignalWire. + +## Signature + +```typescript +class ElevenLabsTTS +``` + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1114. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/index.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/index.mdx new file mode 100644 index 0000000000..dc9e1b987f --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/livewire/plugins" +title: "plugins" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "livewire.plugins" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `plugins` + +Stub providers matching common LiveKit plugin packages. + +None of these do anything — they exist so LiveKit code that imports and +constructs these classes still compiles and runs under SignalWire. The +first construction of each logs an advisory to stderr. + +## Signature + +```typescript +module plugins +``` + +## Classes + + + + LiveKit Cartesia-TTS plugin stub. No-op on SignalWire. + + + + LiveKit Deepgram-STT plugin stub. No-op on SignalWire. + + + + LiveKit ElevenLabs-TTS plugin stub. No-op on SignalWire. + + + + LiveKit OpenAI-LLM plugin stub. + + + + LiveKit Silero-VAD plugin stub. No-op on SignalWire. + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1071. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/open-aillm/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/open-aillm/constructor.mdx new file mode 100644 index 0000000000..20003d1ad9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/open-aillm/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/livewire/plugins/open-aillm/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.plugins.OpenAILLM.constructor" + parent: "livewire.plugins.OpenAILLM" + module: "livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(_opts?: any): OpenAILLM +``` + +## Parameters + + + OpenAI options. `_opts.model` is captured; everything else ignored. + + +## Returns + +`OpenAILLM` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1093. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/open-aillm/index.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/open-aillm/index.mdx new file mode 100644 index 0000000000..56ff964861 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/open-aillm/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/livewire/plugins/open-aillm" +title: "OpenAILLM" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.plugins.OpenAILLM" + parent: "livewire.plugins" + module: "livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `OpenAILLM` + +LiveKit OpenAI-LLM plugin stub. + +The `model` string is captured and mapped to the SignalWire AI `model` +param by [AgentSession.start](/reference/typescript/livewire/agent-session/start). Other options are ignored. + +## Signature + +```typescript +class OpenAILLM +``` + +## Properties + + + Model identifier captured from the constructor options. + + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1089. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/silero-vad/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/silero-vad/constructor.mdx new file mode 100644 index 0000000000..f87340c7bf --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/silero-vad/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/livewire/plugins/silero-vad/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.plugins.SileroVAD.constructor" + parent: "livewire.plugins.SileroVAD" + module: "livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(_opts?: Record): SileroVAD +``` + +## Parameters + + + Silero VAD options (ignored). + + +## Returns + +`SileroVAD` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1127. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/silero-vad/index.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/silero-vad/index.mdx new file mode 100644 index 0000000000..7e4fffc662 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/silero-vad/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/livewire/plugins/silero-vad" +title: "SileroVAD" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.plugins.SileroVAD" + parent: "livewire.plugins" + module: "livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `SileroVAD` + +LiveKit Silero-VAD plugin stub. No-op on SignalWire. + +## Signature + +```typescript +class SileroVAD +``` + +## Methods + + + + + + Load a Silero VAD model. + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1125. diff --git a/fern/products/sdk-reference/typescript/livewire/plugins/silero-vad/load.mdx b/fern/products/sdk-reference/typescript/livewire/plugins/silero-vad/load.mdx new file mode 100644 index 0000000000..e1e942112c --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/plugins/silero-vad/load.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/livewire/plugins/silero-vad/load" +title: "load" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.plugins.SileroVAD.load" + parent: "livewire.plugins.SileroVAD" + module: "livewire.plugins" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `load` + +Load a Silero VAD model. + +**No-op** on SignalWire — returns a fresh stub instance and emits a +one-time advisory to stderr. + +**Modifiers:** `static` + +## Signature + +```typescript +load(): SileroVAD +``` + +## Returns + +`SileroVAD` — A new `SileroVAD` stub. + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 1137. diff --git a/fern/products/sdk-reference/typescript/livewire/print-banner.mdx b/fern/products/sdk-reference/typescript/livewire/print-banner.mdx new file mode 100644 index 0000000000..be8f2954fc --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/print-banner.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/livewire/print-banner" +title: "printBanner" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "livewire.printBanner" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `printBanner` + +Print the ASCII banner to stderr, using ANSI cyan when stderr is a TTY. + +## Signature + +```typescript +printBanner(): void +``` + +## Returns + +`void` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 30. diff --git a/fern/products/sdk-reference/typescript/livewire/print-tip.mdx b/fern/products/sdk-reference/typescript/livewire/print-tip.mdx new file mode 100644 index 0000000000..90cc8074d1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/print-tip.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/livewire/print-tip" +title: "printTip" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "livewire.printTip" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `printTip` + +## Signature + +```typescript +printTip(): void +``` + +## Returns + +`void` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 59. diff --git a/fern/products/sdk-reference/typescript/livewire/room/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/room/constructor.mdx new file mode 100644 index 0000000000..c33367fb6d --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/room/constructor.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/typescript/livewire/room/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.Room.constructor" + parent: "livewire.Room" + module: "livewire" +--- +# `constructor` + +## Signature + +```typescript +constructor(): Room +``` + +## Returns + +`Room` diff --git a/fern/products/sdk-reference/typescript/livewire/room/index.mdx b/fern/products/sdk-reference/typescript/livewire/room/index.mdx new file mode 100644 index 0000000000..daae748357 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/room/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/livewire/room" +title: "Room" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.Room" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `Room` + +Stub `Room` — SignalWire does not use the LiveKit room abstraction. + +Present purely for API parity so LiveKit-shaped code compiles; its only +meaningful attribute is the constant name. + +## Signature + +```typescript +class Room +``` + +## Properties + + + Always `"livewire-room"` — SignalWire has no per-call room identity. + + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 795. diff --git a/fern/products/sdk-reference/typescript/livewire/run-app.mdx b/fern/products/sdk-reference/typescript/livewire/run-app.mdx new file mode 100644 index 0000000000..ce29aa6305 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/run-app.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/livewire/run-app" +title: "runApp" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "livewire.runApp" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `runApp` + +Mirrors `cli.runApp()` from `@livekit/agents-js`. + +1. Prints the LiveWire banner +2. Runs the registered prewarm callback (if any) with a fresh [JobProcess](/reference/typescript/livewire/job-process) +3. Creates a fresh [JobContext](/reference/typescript/livewire/job-context) +4. Prints a random tip +5. Invokes the entry function with the context +6. Starts the underlying SignalWire `AgentBase` once the entry function + binds one (via an `AgentSession.start()` call) + +Accepts either an object `{ entry, prewarm? }`, a bare entry function, or +an [AgentServer](/reference/typescript/agent-server) instance. + +## Signature + +```typescript +runApp(options: any): void +``` + +## Parameters + + + Agent descriptor, entry function, or `AgentServer`. + + +## Returns + +`void` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 892. diff --git a/fern/products/sdk-reference/typescript/livewire/run-context/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/run-context/constructor.mdx new file mode 100644 index 0000000000..7211f344ec --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/run-context/constructor.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/livewire/run-context/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.RunContext.constructor" + parent: "livewire.RunContext" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + session?: AgentSession, + options?: { ...2 fields } +): RunContext +``` + +## Type Parameters + + + +## Parameters + + + Owning session, when available. + + + + Optional pass-through values. + + + Opaque LiveKit function-call descriptor. + + + + Opaque LiveKit speech handle. + + + +## Returns + +`RunContext` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 390. diff --git a/fern/products/sdk-reference/typescript/livewire/run-context/index.mdx b/fern/products/sdk-reference/typescript/livewire/run-context/index.mdx new file mode 100644 index 0000000000..f7f87505c1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/run-context/index.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/livewire/run-context" +title: "RunContext" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.RunContext" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `RunContext` + +Mirrors a LiveKit `RunContext` — passed to tool handlers so they can +read the current session, call handle, and user data. + +## Signature + +```typescript +class RunContext +``` + +## Type Parameters + + + +## Properties + + + Opaque function-call descriptor (LiveKit shape; passed through untouched). + + + + The owning [AgentSession](/reference/typescript/livewire/agent-session), when one is bound. + + + + Opaque speech-turn handle (LiveKit shape; passed through untouched). + + + + Per-session user data, or an empty object when no session is bound. + + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 376. diff --git a/fern/products/sdk-reference/typescript/livewire/server-options/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/server-options/constructor.mdx new file mode 100644 index 0000000000..0d3688b6af --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/server-options/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/livewire/server-options/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.ServerOptions.constructor" + parent: "livewire.ServerOptions" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(_opts?: any): ServerOptions +``` + +## Parameters + + + LiveKit-shaped server options (ignored). + + +## Returns + +`ServerOptions` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 956. diff --git a/fern/products/sdk-reference/typescript/livewire/server-options/index.mdx b/fern/products/sdk-reference/typescript/livewire/server-options/index.mdx new file mode 100644 index 0000000000..e338245166 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/server-options/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/livewire/server-options" +title: "ServerOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.ServerOptions" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `ServerOptions` + +Stub class mirroring LiveKit's `ServerOptions`. + +Accepts any configuration for source-compatibility with LiveKit code; +SignalWire ignores these settings. + +## Signature + +```typescript +class ServerOptions +``` + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 954. diff --git a/fern/products/sdk-reference/typescript/livewire/stop-response/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/stop-response/constructor.mdx new file mode 100644 index 0000000000..f7ef843d72 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/stop-response/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/livewire/stop-response/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.StopResponse.constructor" + parent: "livewire.StopResponse" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(message?: string): StopResponse +``` + +## Parameters + + + Optional error message. Defaults to `"StopResponse"`. + + +## Returns + +`StopResponse` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 753. diff --git a/fern/products/sdk-reference/typescript/livewire/stop-response/index.mdx b/fern/products/sdk-reference/typescript/livewire/stop-response/index.mdx new file mode 100644 index 0000000000..a87e701572 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/stop-response/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/livewire/stop-response" +title: "StopResponse" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.StopResponse" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `StopResponse` + +Signals that a tool should not trigger another LLM reply. + +## Signature + +```typescript +class StopResponse extends Error +``` + +## Inheritance + +**Extends:** `Error` + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 749. diff --git a/fern/products/sdk-reference/typescript/livewire/tool-error/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/tool-error/constructor.mdx new file mode 100644 index 0000000000..953a744d03 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/tool-error/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/livewire/tool-error/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.ToolError.constructor" + parent: "livewire.ToolError" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(message: string): ToolError +``` + +## Parameters + + + Error message surfaced to the LLM. + + +## Returns + +`ToolError` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 764. diff --git a/fern/products/sdk-reference/typescript/livewire/tool-error/index.mdx b/fern/products/sdk-reference/typescript/livewire/tool-error/index.mdx new file mode 100644 index 0000000000..9769f5c05b --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/tool-error/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/livewire/tool-error" +title: "ToolError" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.ToolError" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `ToolError` + +Error thrown from a tool to signal failure back to the LLM. + +## Signature + +```typescript +class ToolError extends Error +``` + +## Inheritance + +**Extends:** `Error` + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 760. diff --git a/fern/products/sdk-reference/typescript/livewire/tool.mdx b/fern/products/sdk-reference/typescript/livewire/tool.mdx new file mode 100644 index 0000000000..bf7958866e --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/tool.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/typescript/livewire/tool" +title: "tool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "livewire.tool" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `tool` + +Create a tool definition — mirrors `llm.tool()` from `@livekit/agents-js`. + +The returned tool has an empty `name` — the caller assigns it when the tool +is attached to an agent's tools map (see the [Agent](/reference/typescript/livewire/agent) example). + +## Signature + +```typescript +tool

(options: { ...3 fields }): FunctionTool +``` + +## Type Parameters + + + Parameter type passed into `execute`. + + +## Parameters + + + Tool configuration. + + + Human-readable tool description exposed to the LLM. + + + + Handler invoked when the LLM calls the tool. + + + + JSON Schema or Zod schema describing the tool's inputs. + + + +## Returns + +`FunctionTool` — A [FunctionTool](/reference/typescript/livewire/function-tool) ready to be attached to an agent. + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 691. diff --git a/fern/products/sdk-reference/typescript/livewire/voice-options/index.mdx b/fern/products/sdk-reference/typescript/livewire/voice-options/index.mdx new file mode 100644 index 0000000000..97175cf0fb --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/voice-options/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/livewire/voice-options" +title: "VoiceOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "livewire.VoiceOptions" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `VoiceOptions` + +Voice configuration options passed through to the SignalWire AI config. + +## Signature + +```typescript +interface VoiceOptions +``` + +## Properties + + + TTS engine identifier (e.g. `"google"`, `"elevenlabs"`). + + + + BCP-47 language code (e.g. `"en-US"`). + + + + TTS voice identifier (e.g. `"en-US-Standard-A"`). + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 108. diff --git a/fern/products/sdk-reference/typescript/livewire/worker-options/constructor.mdx b/fern/products/sdk-reference/typescript/livewire/worker-options/constructor.mdx new file mode 100644 index 0000000000..0ab2b8a4af --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/worker-options/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/livewire/worker-options/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "livewire.WorkerOptions.constructor" + parent: "livewire.WorkerOptions" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(_opts?: any): WorkerOptions +``` + +## Parameters + + + LiveKit-shaped worker options (ignored). + + +## Returns + +`WorkerOptions` + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 945. diff --git a/fern/products/sdk-reference/typescript/livewire/worker-options/index.mdx b/fern/products/sdk-reference/typescript/livewire/worker-options/index.mdx new file mode 100644 index 0000000000..3316812468 --- /dev/null +++ b/fern/products/sdk-reference/typescript/livewire/worker-options/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/livewire/worker-options" +title: "WorkerOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "livewire.WorkerOptions" + parent: "livewire" + module: "livewire" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts" +--- +# `WorkerOptions` + +Stub class mirroring LiveKit's `WorkerOptions`. + +Accepts any configuration for source-compatibility with LiveKit code; +SignalWire ignores these settings. + +## Signature + +```typescript +class WorkerOptions +``` + +## Methods + + + + + +## Source + +[`src/livewire/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/livewire/index.ts) + +Line 943. diff --git a/fern/products/sdk-reference/typescript/logger/get-execution-mode.mdx b/fern/products/sdk-reference/typescript/logger/get-execution-mode.mdx new file mode 100644 index 0000000000..4da8337d0c --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/get-execution-mode.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/logger/get-execution-mode" +title: "getExecutionMode" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "Logger.getExecutionMode" + parent: "Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `getExecutionMode` + +Detect the execution environment, matching Python SDK's detection logic. + +## Signature + +```typescript +getExecutionMode(): [string, "default" | "off" | "stderr"] +``` + +## Returns + +`[string, "default" | "off" | "stderr"]` — A tuple of \[environment\_name, derived\_log\_mode]. + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 22. diff --git a/fern/products/sdk-reference/typescript/logger/get-logger.mdx b/fern/products/sdk-reference/typescript/logger/get-logger.mdx new file mode 100644 index 0000000000..cca59ba0a2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/get-logger.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/logger/get-logger" +title: "getLogger" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "Logger.getLogger" + parent: "Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `getLogger` + +Create or retrieve a cached Logger instance with the given name. + +## Signature + +```typescript +getLogger(name: string): Logger +``` + +## Parameters + + + Logger name shown in log output. + + +## Returns + +`Logger` — A Logger instance (cached by name). + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 330. diff --git a/fern/products/sdk-reference/typescript/logger/index.mdx b/fern/products/sdk-reference/typescript/logger/index.mdx new file mode 100644 index 0000000000..a185ccda0f --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/typescript/logger" +title: "Logger" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `Logger` + +## Signature + +```typescript +module Logger +``` + +## Functions + + + + Detect the execution environment, matching Python SDK's detection logic. + + + + Create or retrieve a cached Logger instance with the given name. + + + + Reset all logging settings to their environment-variable-based defaults. + + + + Enable or disable ANSI color codes in text-format output. + + + + Set the output format for all loggers. + + + + Set the minimum log level for all loggers. + + + + Set the output stream for all loggers. + + + + Strip control characters from all string values in a data record to prevent log injection attacks. Mirrors Python SDK's `strip_control_chars` structlog processor. Processes nested objects and arrays recursively. + + + + Suppress or unsuppress all log output globally. + + + +## Classes + + + + Structured logger that respects global level, format, and color settings. + + + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/logger/logger/bind.mdx b/fern/products/sdk-reference/typescript/logger/logger/bind.mdx new file mode 100644 index 0000000000..f7b9cc626c --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/logger/bind.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/logger/logger/bind" +title: "bind" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "Logger.Logger.bind" + parent: "Logger.Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `bind` + +Create a child logger with additional bound context fields merged into the parent's context. + +## Signature + +```typescript +bind(context: Record): Logger +``` + +## Parameters + + + Key-value pairs to merge into the child logger's context. + + +## Returns + +`Logger` — A new Logger instance with the merged context. + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 222. diff --git a/fern/products/sdk-reference/typescript/logger/logger/constructor.mdx b/fern/products/sdk-reference/typescript/logger/logger/constructor.mdx new file mode 100644 index 0000000000..8fb15fa49e --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/logger/constructor.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/logger/logger/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "Logger.Logger.constructor" + parent: "Logger.Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `constructor` + +Create a new Logger instance. + +## Signature + +```typescript +constructor(name: string, context?: Record): Logger +``` + +## Parameters + + + Logger name shown in log output. + + + + Optional key-value pairs included in every log entry. + + +## Returns + +`Logger` + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 212. diff --git a/fern/products/sdk-reference/typescript/logger/logger/debug.mdx b/fern/products/sdk-reference/typescript/logger/logger/debug.mdx new file mode 100644 index 0000000000..65a9fe8365 --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/logger/debug.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/logger/logger/debug" +title: "debug" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "Logger.Logger.debug" + parent: "Logger.Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `debug` + +Log a message at the debug level. + +## Signature + +```typescript +debug(msg: string, data?: Record): void +``` + +## Parameters + + + The log message. + + + + Optional structured data to include. + + +## Returns + +`void` + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 231. diff --git a/fern/products/sdk-reference/typescript/logger/logger/error.mdx b/fern/products/sdk-reference/typescript/logger/logger/error.mdx new file mode 100644 index 0000000000..ceac21fad5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/logger/error.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/logger/logger/error" +title: "error" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "Logger.Logger.error" + parent: "Logger.Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `error` + +Log a message at the error level. + +## Signature + +```typescript +error(msg: string, data?: Record): void +``` + +## Parameters + + + The log message. + + + + Optional structured data to include. + + +## Returns + +`void` + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 258. diff --git a/fern/products/sdk-reference/typescript/logger/logger/index.mdx b/fern/products/sdk-reference/typescript/logger/logger/index.mdx new file mode 100644 index 0000000000..13fb924692 --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/logger/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/logger/logger" +title: "Logger" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "Logger.Logger" + parent: "Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `Logger` + +Structured logger that respects global level, format, and color settings. + +## Signature + +```typescript +class Logger +``` + +## Methods + + + + Create a child logger with additional bound context fields merged into the parent's context. + + + + Create a new Logger instance. + + + + Log a message at the debug level. + + + + Log a message at the error level. + + + + Log a message at the info level. + + + + Log a message at the warn level. + + + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 203. diff --git a/fern/products/sdk-reference/typescript/logger/logger/info.mdx b/fern/products/sdk-reference/typescript/logger/logger/info.mdx new file mode 100644 index 0000000000..cd31c06001 --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/logger/info.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/logger/logger/info" +title: "info" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "Logger.Logger.info" + parent: "Logger.Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `info` + +Log a message at the info level. + +## Signature + +```typescript +info(msg: string, data?: Record): void +``` + +## Parameters + + + The log message. + + + + Optional structured data to include. + + +## Returns + +`void` + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 240. diff --git a/fern/products/sdk-reference/typescript/logger/logger/warn.mdx b/fern/products/sdk-reference/typescript/logger/logger/warn.mdx new file mode 100644 index 0000000000..724aa6b223 --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/logger/warn.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/logger/logger/warn" +title: "warn" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "Logger.Logger.warn" + parent: "Logger.Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `warn` + +Log a message at the warn level. + +## Signature + +```typescript +warn(msg: string, data?: Record): void +``` + +## Parameters + + + The log message. + + + + Optional structured data to include. + + +## Returns + +`void` + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 249. diff --git a/fern/products/sdk-reference/typescript/logger/reset-logging-configuration.mdx b/fern/products/sdk-reference/typescript/logger/reset-logging-configuration.mdx new file mode 100644 index 0000000000..6f2a677b2d --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/reset-logging-configuration.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/logger/reset-logging-configuration" +title: "resetLoggingConfiguration" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "Logger.resetLoggingConfiguration" + parent: "Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `resetLoggingConfiguration` + +Reset all logging settings to their environment-variable-based defaults. + +## Signature + +```typescript +resetLoggingConfiguration(): void +``` + +## Returns + +`void` + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 126. diff --git a/fern/products/sdk-reference/typescript/logger/set-global-log-color.mdx b/fern/products/sdk-reference/typescript/logger/set-global-log-color.mdx new file mode 100644 index 0000000000..5129539687 --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/set-global-log-color.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/logger/set-global-log-color" +title: "setGlobalLogColor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "Logger.setGlobalLogColor" + parent: "Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `setGlobalLogColor` + +Enable or disable ANSI color codes in text-format output. + +## Signature + +```typescript +setGlobalLogColor(enabled: boolean): void +``` + +## Parameters + + + True to enable colors, false to disable. + + +## Returns + +`void` + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 113. diff --git a/fern/products/sdk-reference/typescript/logger/set-global-log-format.mdx b/fern/products/sdk-reference/typescript/logger/set-global-log-format.mdx new file mode 100644 index 0000000000..0f735e31f3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/set-global-log-format.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/logger/set-global-log-format" +title: "setGlobalLogFormat" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "Logger.setGlobalLogFormat" + parent: "Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `setGlobalLogFormat` + +Set the output format for all loggers. + +## Signature + +```typescript +setGlobalLogFormat(format: LogFormat): void +``` + +## Parameters + + + Either 'text' (human-readable) or 'json' (structured). + + +## Returns + +`void` + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 105. diff --git a/fern/products/sdk-reference/typescript/logger/set-global-log-level.mdx b/fern/products/sdk-reference/typescript/logger/set-global-log-level.mdx new file mode 100644 index 0000000000..9e7fe426c1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/set-global-log-level.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/logger/set-global-log-level" +title: "setGlobalLogLevel" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "Logger.setGlobalLogLevel" + parent: "Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `setGlobalLogLevel` + +Set the minimum log level for all loggers. + +## Signature + +```typescript +setGlobalLogLevel(level: "debug" | "info" | "warn" | "error"): void +``` + +## Parameters + + + The minimum severity level to emit. + + +## Returns + +`void` + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 89. diff --git a/fern/products/sdk-reference/typescript/logger/set-global-log-stream.mdx b/fern/products/sdk-reference/typescript/logger/set-global-log-stream.mdx new file mode 100644 index 0000000000..a1aee807f2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/set-global-log-stream.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/logger/set-global-log-stream" +title: "setGlobalLogStream" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "Logger.setGlobalLogStream" + parent: "Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `setGlobalLogStream` + +Set the output stream for all loggers. + +## Signature + +```typescript +setGlobalLogStream(stream: LogStream): void +``` + +## Parameters + + + Either 'stdout' (default) or 'stderr'. + + +## Returns + +`void` + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 121. diff --git a/fern/products/sdk-reference/typescript/logger/strip-control-chars.mdx b/fern/products/sdk-reference/typescript/logger/strip-control-chars.mdx new file mode 100644 index 0000000000..0b7c77d7be --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/strip-control-chars.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/logger/strip-control-chars" +title: "stripControlChars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "Logger.stripControlChars" + parent: "Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `stripControlChars` + +Strip control characters from all string values in a data record to prevent +log injection attacks. Mirrors Python SDK's `strip_control_chars` structlog +processor. Processes nested objects and arrays recursively. + +## Signature + +```typescript +stripControlChars(data: T): T +``` + +## Type Parameters + + + +## Parameters + + + The record whose string values should be sanitized. + + +## Returns + +`T` — A shallow copy of `data` with control characters removed from strings. + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 166. diff --git a/fern/products/sdk-reference/typescript/logger/suppress-all-logs.mdx b/fern/products/sdk-reference/typescript/logger/suppress-all-logs.mdx new file mode 100644 index 0000000000..1564953183 --- /dev/null +++ b/fern/products/sdk-reference/typescript/logger/suppress-all-logs.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/logger/suppress-all-logs" +title: "suppressAllLogs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "Logger.suppressAllLogs" + parent: "Logger" + module: "Logger" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts" +--- +# `suppressAllLogs` + +Suppress or unsuppress all log output globally. + +## Signature + +```typescript +suppressAllLogs(suppress: boolean = true): void +``` + +## Parameters + + + True to suppress, false to restore (default true). + + +## Returns + +`void` + +## Source + +[`src/Logger.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/Logger.ts) + +Line 97. diff --git a/fern/products/sdk-reference/typescript/pom-builder/index.mdx b/fern/products/sdk-reference/typescript/pom-builder/index.mdx new file mode 100644 index 0000000000..7d2d9b9a2f --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/pom-builder" +title: "PomBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `PomBuilder` + +## Signature + +```typescript +module PomBuilder +``` + +## Classes + + + + Builds a structured prompt by composing named POM sections, with Markdown and dict export. + + + + A single section in a Prompt Object Model, with optional title, body, bullets, and nested subsections. + + + +## Interfaces + + + + Serializable representation of a POM section, used for JSON export. + + + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-pom-as-subsection.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-pom-as-subsection.mdx new file mode 100644 index 0000000000..c73ad31129 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-pom-as-subsection.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/add-pom-as-subsection" +title: "addPomAsSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.addPomAsSubsection" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `addPomAsSubsection` + +Appends every top-level section of another PomBuilder as subsections of a target section. + +## Signature + +```typescript +addPomAsSubsection(target: string | PomSection, pomToAdd: PomBuilder): this +``` + +## Parameters + + + The heading of the target section, or the PomSection to append into. + + + + The PomBuilder whose sections should be appended as subsections. + + +## Returns + +`this` — This builder for chaining. + +## Throws + +- If target is a string and no section with that title is found. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 374. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-section.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-section.mdx new file mode 100644 index 0000000000..6e39433f7d --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-section.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.addSection" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `addSection` + +Adds a new top-level section to the prompt. + +## Signature + +```typescript +addSection(title: string, opts?: { ...5 fields }): this +``` + +## Parameters + + + The section heading. + + + + Optional body, bullets, numbering, and subsection configuration. + + + + + + + + + + + + +## Returns + +`this` — This builder for chaining. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 255. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-subsection.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-subsection.mdx new file mode 100644 index 0000000000..4da302bc5a --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-subsection.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/add-subsection" +title: "addSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.addSubsection" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `addSubsection` + +Adds a subsection under an existing parent section, creating the parent if absent. + +## Signature + +```typescript +addSubsection(parentTitle: string, title: string, opts?: { ...2 fields }): this +``` + +## Parameters + + + The heading of the parent section. + + + + The subsection heading. + + + + Optional body text and bullets for the subsection. + + + + + + +## Returns + +`this` — This builder for chaining. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 316. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-to-section.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-to-section.mdx new file mode 100644 index 0000000000..27c9bc8214 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/add-to-section.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/add-to-section" +title: "addToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.addToSection" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `addToSection` + +Appends body text or bullets to an existing section, creating it if absent. + +## Signature + +```typescript +addToSection(title: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + The section heading to append to. + + + + Body text and/or bullets to add. + + + + + + + + +## Returns + +`this` — This builder for chaining. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 293. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/constructor.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/constructor.mdx new file mode 100644 index 0000000000..a570af6038 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/constructor.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.constructor" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" +--- +# `constructor` + +## Signature + +```typescript +constructor(): PomBuilder +``` + +## Returns + +`PomBuilder` diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/find-section.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/find-section.mdx new file mode 100644 index 0000000000..4dec4c6315 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/find-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/find-section" +title: "findSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.findSection" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `findSection` + +Recursively searches all sections and subsections for one matching the given title. + +## Signature + +```typescript +findSection(title: string): PomSection | undefined +``` + +## Parameters + + + The section heading to search for. + + +## Returns + +`PomSection | undefined` — The matching PomSection, or undefined if not found. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 355. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/from-sections.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/from-sections.mdx new file mode 100644 index 0000000000..ae0c075ffc --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/from-sections.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/from-sections" +title: "fromSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.fromSections" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `fromSections` + +Creates a PomBuilder from an array of section data objects. + +**Modifiers:** `static` + +## Signature + +```typescript +fromSections(sections: PomSectionData[]): PomBuilder +``` + +## Parameters + + + Array of section data to reconstruct. + + +## Returns + +`PomBuilder` — A new PomBuilder populated with the given sections. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 413. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/get-section.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/get-section.mdx new file mode 100644 index 0000000000..472f46932c --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/get-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/get-section" +title: "getSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.getSection" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `getSection` + +Returns a top-level section by title. + +## Signature + +```typescript +getSection(title: string): PomSection | undefined +``` + +## Parameters + + + The section heading to retrieve. + + +## Returns + +`PomSection | undefined` — The matching PomSection, or undefined if not found. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 346. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/has-section.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/has-section.mdx new file mode 100644 index 0000000000..554cb5157e --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/has-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/has-section" +title: "hasSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.hasSection" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `hasSection` + +Checks whether a top-level section with the given title exists. + +## Signature + +```typescript +hasSection(title: string): boolean +``` + +## Parameters + + + The section heading to look for. + + +## Returns + +`boolean` — True if the section exists. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 337. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/index.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/index.mdx new file mode 100644 index 0000000000..5be153ff72 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/index.mdx @@ -0,0 +1,122 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder" +title: "PomBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder" + parent: "PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `PomBuilder` + +Builds a structured prompt by composing named POM sections, with Markdown and dict export. + +The Prompt Object Model lets you assemble a large system prompt from reusable, +named sections (Role, Objective, Constraints, etc.) instead of a single string. +This plays well with [AgentBase](/reference/typescript/agent-base) methods like `promptAddSection()` and +`promptAddToSection()` that let user code and skills add prompt content +incrementally. + +## Signature + +```typescript +class PomBuilder +``` + +## Examples + +```typescript +import { PomBuilder } from '@signalwire/sdk'; + +const pom = new PomBuilder() + .addSection('Role', { body: 'You are a friendly customer service agent.' }) + .addSection('Objectives', { bullets: [ + 'Identify the customer politely', + 'Resolve their issue in under 3 turns if possible', + ]}) + .addSection('Constraints', { bullets: [ + 'Never reveal internal tool names', + ]}); + +const systemPrompt = pom.renderMarkdown(); +``` + +## See Also + +- \- \[PomSection]\(/reference/typescript/pom-builder/pom-section) + \- \[AgentBase.promptAddSection]\(/reference/typescript/agent-base/agent-base/prompt-add-section) + +## Properties + + + Returns the underlying `PromptObjectModel` for the builder. Mirrors Python's `PomBuilder.pom` attribute (the wrapped low-level model). Returns a fresh `PromptObjectModel` populated from the builder's current sections; mutations on the returned instance do not propagate back to this builder. + + +## Methods + + + + Appends every top-level section of another PomBuilder as subsections of a target section. + + + + Adds a new top-level section to the prompt. + + + + Adds a subsection under an existing parent section, creating the parent if absent. + + + + Appends body text or bullets to an existing section, creating it if absent. + + + + + + Recursively searches all sections and subsections for one matching the given title. + + + + Creates a PomBuilder from an array of section data objects. + + + + Returns a top-level section by title. + + + + Checks whether a top-level section with the given title exists. + + + + Renders all sections as a combined Markdown string. + + + + Renders all sections as a combined XML string with a `` root element. + + + + Clears all sections, returning the builder to its initial empty state. + + + + Serializes all sections to an array of plain data objects. + + + + Serializes all sections to a JSON string. + + + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 235. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/render-markdown.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/render-markdown.mdx new file mode 100644 index 0000000000..caa7e1ecf1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/render-markdown.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/render-markdown" +title: "renderMarkdown" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.renderMarkdown" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `renderMarkdown` + +Renders all sections as a combined Markdown string. + +## Signature + +```typescript +renderMarkdown(): string +``` + +## Returns + +`string` — The complete rendered Markdown prompt text. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 459. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/render-xml.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/render-xml.mdx new file mode 100644 index 0000000000..d15dd7a4a1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/render-xml.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/render-xml" +title: "renderXml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.renderXml" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `renderXml` + +Renders all sections as a combined XML string with a `` root element. + +## Signature + +```typescript +renderXml(): string +``` + +## Returns + +`string` — The complete rendered XML prompt text. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 480. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/reset.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/reset.mdx new file mode 100644 index 0000000000..e49bfe6ffe --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/reset.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/reset" +title: "reset" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.reset" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `reset` + +Clears all sections, returning the builder to its initial empty state. + +## Signature + +```typescript +reset(): this +``` + +## Returns + +`this` — This builder for chaining. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 243. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/to-dict.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/to-dict.mdx new file mode 100644 index 0000000000..43a963daa8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/to-dict" +title: "toDict" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.toDict" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `toDict` + +Serializes all sections to an array of plain data objects. + +## Signature + +```typescript +toDict(): PomSectionData[] +``` + +## Returns + +`PomSectionData[]` — An array of PomSectionData representing all top-level sections. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 396. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-builder/to-json.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/to-json.mdx new file mode 100644 index 0000000000..d9113d1646 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-builder/to-json.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom-builder/pom-builder/to-json" +title: "toJson" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomBuilder.toJson" + parent: "PomBuilder.PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `toJson` + +Serializes all sections to a JSON string. + +## Signature + +```typescript +toJson(): string +``` + +## Returns + +`string` — A JSON string representation of all top-level sections. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 404. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-section-data/index.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-section-data/index.mdx new file mode 100644 index 0000000000..5f8a15fe1c --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-section-data/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/pom-builder/pom-section-data" +title: "PomSectionData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "PomBuilder.PomSectionData" + parent: "PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `PomSectionData` + +Serializable representation of a POM section, used for JSON export. + +## Signature + +```typescript +interface PomSectionData +``` + +## Properties + + + Section body paragraph text. + + + + List of bullet point strings. + + + + Whether subsections are numbered. + + + + Whether bullet points are rendered as a numbered list. + + + + Nested child sections. + + + + Section heading text. + + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 12. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-section/add-subsection.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-section/add-subsection.mdx new file mode 100644 index 0000000000..430cb23fb6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-section/add-subsection.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/pom-builder/pom-section/add-subsection" +title: "addSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomSection.addSubsection" + parent: "PomBuilder.PomSection" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `addSubsection` + +Adds a nested subsection to this section. + +## Signature + +```typescript +addSubsection(opts: { ...5 fields }): PomSection +``` + +## Parameters + + + Subsection configuration including title and optional body/bullets. + + + + + + + + + + + + +## Returns + +`PomSection` — The newly created child PomSection. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-section/constructor.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-section/constructor.mdx new file mode 100644 index 0000000000..c9d4d8d10b --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-section/constructor.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/pom-builder/pom-section/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomSection.constructor" + parent: "PomBuilder.PomSection" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `constructor` + +Creates a new PomSection. + +## Signature + +```typescript +constructor(opts?: { ...5 fields }): PomSection +``` + +## Parameters + + + Optional section configuration. + + + + + + + + + + + + +## Returns + +`PomSection` + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 46. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-section/index.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-section/index.mdx new file mode 100644 index 0000000000..1f3854ae67 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-section/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/typescript/pom-builder/pom-section" +title: "PomSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "PomBuilder.PomSection" + parent: "PomBuilder" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `PomSection` + +A single section in a Prompt Object Model, with optional title, body, bullets, and nested subsections. + +## Signature + +```typescript +class PomSection +``` + +## Properties + + + Section body paragraph text. + + + + List of bullet point strings. + + + + Whether this section is numbered when rendered; null means inherit from parent context. + + + + Whether bullet points are rendered as a numbered list. + + + + Nested child sections. + + + + Section heading text, or null if untitled. + + +## Methods + + + + Adds a nested subsection to this section. + + + + Creates a new PomSection. + + + + Renders this section and its subsections as a Markdown string. + + + + Renders this section and its subsections as an XML string. + + + + Serializes this section to a plain data object. + + + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 28. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-section/render-markdown.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-section/render-markdown.mdx new file mode 100644 index 0000000000..3933fbc181 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-section/render-markdown.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/pom-builder/pom-section/render-markdown" +title: "renderMarkdown" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomSection.renderMarkdown" + parent: "PomBuilder.PomSection" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `renderMarkdown` + +Renders this section and its subsections as a Markdown string. + +## Signature + +```typescript +renderMarkdown(level: number = 2, sectionNumber: number[] = []): string +``` + +## Parameters + + + The heading level to start at (default 2 for ##). + + + + Hierarchical numbering prefix for numbered sections. + + +## Returns + +`string` — The rendered Markdown string. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 105. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-section/render-xml.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-section/render-xml.mdx new file mode 100644 index 0000000000..2df0a5a437 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-section/render-xml.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/pom-builder/pom-section/render-xml" +title: "renderXml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomSection.renderXml" + parent: "PomBuilder.PomSection" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `renderXml` + +Renders this section and its subsections as an XML string. + +## Signature + +```typescript +renderXml(indent: number = 0, sectionNumber: number[] = []): string +``` + +## Parameters + + + The indentation depth (default 0). + + + + Hierarchical numbering prefix for numbered sections. + + +## Returns + +`string` — The rendered XML string. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 154. diff --git a/fern/products/sdk-reference/typescript/pom-builder/pom-section/to-dict.mdx b/fern/products/sdk-reference/typescript/pom-builder/pom-section/to-dict.mdx new file mode 100644 index 0000000000..95af9e672d --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom-builder/pom-section/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom-builder/pom-section/to-dict" +title: "toDict" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PomBuilder.PomSection.toDict" + parent: "PomBuilder.PomSection" + module: "PomBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts" +--- +# `toDict` + +Serializes this section to a plain data object. + +## Signature + +```typescript +toDict(): PomSectionData +``` + +## Returns + +`PomSectionData` — A PomSectionData representation of this section and its subsections. + +## Source + +[`src/PomBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PomBuilder.ts) + +Line 88. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/index.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/index.mdx new file mode 100644 index 0000000000..3df00f8790 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model" +title: "PromptObjectModel" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "POM.PromptObjectModel" + module: "POM" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `PromptObjectModel` + +## Signature + +```typescript +module PromptObjectModel +``` + +## Classes + + + + The Prompt Object Model — a structured, serializable representation of a full prompt document. Direct port of Python's `signalwire.pom.pom.PromptObjectModel`. + + + + A section in the Prompt Object Model. + + + +## Interfaces + + + + Plain serializable representation of a section, used for JSON/YAML and `to_dict()` exchange. + + + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/add-pom-as-subsection.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/add-pom-as-subsection.mdx new file mode 100644 index 0000000000..dad6a8a920 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/add-pom-as-subsection.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model/add-pom-as-subsection" +title: "addPomAsSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel.addPomAsSubsection" + parent: "POM.PromptObjectModel.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `addPomAsSubsection` + +Add another PromptObjectModel as subsections of an existing section. + +## Signature + +```typescript +addPomAsSubsection(target: string | Section, pomToAdd: PromptObjectModel): void +``` + +## Parameters + + + Either the title of the target section, or a `Section` reference. + + + + The model whose top-level sections will be appended as subsections. + + +## Returns + +`void` + +## Throws + +- Error if `target` is a string and no section with that title is found. + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 412. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/add-section.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/add-section.mdx new file mode 100644 index 0000000000..8644d04a6e --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/add-section.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel.addSection" + parent: "POM.PromptObjectModel.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `addSection` + +Add a top-level section to the model. + +## Signature + +```typescript +addSection(title: string | null = null, opts: { ...4 fields } = {}): Section +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`Section` + +## Throws + +- Error if a section without a title is added after the first section. + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 269. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/constructor.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/constructor.mdx new file mode 100644 index 0000000000..eaf4a95ae9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel.constructor" + parent: "POM.PromptObjectModel.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(debug: boolean = false): PromptObjectModel +``` + +## Parameters + + + +## Returns + +`PromptObjectModel` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 259. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/find-section.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/find-section.mdx new file mode 100644 index 0000000000..7cdf66d3a4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/find-section.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model/find-section" +title: "findSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel.findSection" + parent: "POM.PromptObjectModel.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `findSection` + +Find a section by its title (recursive search through all sections and subsections). + +## Signature + +```typescript +findSection(title: string): Section | null +``` + +## Parameters + + + +## Returns + +`Section | null` — The matching Section or null if not found. + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 307. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/from-json.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/from-json.mdx new file mode 100644 index 0000000000..70a7227d58 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/from-json.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model/from-json" +title: "fromJson" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel.fromJson" + parent: "POM.PromptObjectModel.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `fromJson` + +Create a PromptObjectModel from JSON data (string or already-parsed object). + +**Modifiers:** `static` + +## Signature + +```typescript +fromJson(jsonData: unknown): PromptObjectModel +``` + +## Parameters + + + +## Returns + +`PromptObjectModel` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 434. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/from-yaml.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/from-yaml.mdx new file mode 100644 index 0000000000..b5b3a415bf --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/from-yaml.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model/from-yaml" +title: "fromYaml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel.fromYaml" + parent: "POM.PromptObjectModel.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `fromYaml` + +Create a PromptObjectModel from YAML data (string or already-parsed object). + +**Modifiers:** `static` + +## Signature + +```typescript +fromYaml(yamlData: unknown): PromptObjectModel +``` + +## Parameters + + + +## Returns + +`PromptObjectModel` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 447. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/index.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/index.mdx new file mode 100644 index 0000000000..882f122b9f --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/index.mdx @@ -0,0 +1,87 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model" +title: "PromptObjectModel" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel" + parent: "POM.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `PromptObjectModel` + +The Prompt Object Model — a structured, serializable representation of a +full prompt document. Direct port of Python's +`signalwire.pom.pom.PromptObjectModel`. + +## Signature + +```typescript +class PromptObjectModel +``` + +## Properties + + + Whether to print debug info during [renderMarkdown](/reference/typescript/pom/prompt-object-model/prompt-object-model/render-markdown). + + + + Top-level sections in the model. + + +## Methods + + + + Add another PromptObjectModel as subsections of an existing section. + + + + Add a top-level section to the model. + + + + + + Find a section by its title (recursive search through all sections and subsections). + + + + Create a PromptObjectModel from JSON data (string or already-parsed object). + + + + Create a PromptObjectModel from YAML data (string or already-parsed object). + + + + Render the entire model as markdown. + + + + Render the entire model as XML. + + + + Convert the entire model to a list of dictionaries. + + + + Convert the entire model to a JSON string (pretty-printed with 2-space indent). + + + + Convert the entire model to a YAML string. + + + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 253. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/render-markdown.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/render-markdown.mdx new file mode 100644 index 0000000000..f996ae981a --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/render-markdown.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model/render-markdown" +title: "renderMarkdown" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel.renderMarkdown" + parent: "POM.PromptObjectModel.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `renderMarkdown` + +Render the entire model as markdown. + +## Signature + +```typescript +renderMarkdown(): string +``` + +## Returns + +`string` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 337. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/render-xml.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/render-xml.mdx new file mode 100644 index 0000000000..cd019fd273 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/render-xml.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model/render-xml" +title: "renderXml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel.renderXml" + parent: "POM.PromptObjectModel.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `renderXml` + +Render the entire model as XML. + +## Signature + +```typescript +renderXml(): string +``` + +## Returns + +`string` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 381. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/to-dict.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/to-dict.mdx new file mode 100644 index 0000000000..5bfea52e00 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model/to-dict" +title: "toDict" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel.toDict" + parent: "POM.PromptObjectModel.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `toDict` + +Convert the entire model to a list of dictionaries. + +## Signature + +```typescript +toDict(): SectionData[] +``` + +## Returns + +`SectionData[]` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 320. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/to-json.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/to-json.mdx new file mode 100644 index 0000000000..12d8c87054 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/to-json.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model/to-json" +title: "toJson" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel.toJson" + parent: "POM.PromptObjectModel.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `toJson` + +Convert the entire model to a JSON string (pretty-printed with 2-space indent). + +## Signature + +```typescript +toJson(): string +``` + +## Returns + +`string` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 325. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/to-yaml.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/to-yaml.mdx new file mode 100644 index 0000000000..bc64c52caf --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/prompt-object-model/to-yaml.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/prompt-object-model/to-yaml" +title: "toYaml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.PromptObjectModel.toYaml" + parent: "POM.PromptObjectModel.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `toYaml` + +Convert the entire model to a YAML string. + +## Signature + +```typescript +toYaml(): string +``` + +## Returns + +`string` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 330. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/section-data/index.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section-data/index.mdx new file mode 100644 index 0000000000..21216a36a7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section-data/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/section-data" +title: "SectionData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "POM.PromptObjectModel.SectionData" + parent: "POM.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `SectionData` + +Plain serializable representation of a section, used for JSON/YAML and `to_dict()` exchange. + +## Signature + +```typescript +interface SectionData +``` + +## Properties + + + + + + + + + + + + + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 19. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/add-body.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/add-body.mdx new file mode 100644 index 0000000000..ba7f224218 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/add-body.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/section/add-body" +title: "addBody" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.Section.addBody" + parent: "POM.PromptObjectModel.Section" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `addBody` + +Add or replace the body text for this section. + +## Signature + +```typescript +addBody(body: string): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 84. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/add-bullets.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/add-bullets.mdx new file mode 100644 index 0000000000..eced0ebde6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/add-bullets.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/section/add-bullets" +title: "addBullets" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.Section.addBullets" + parent: "POM.PromptObjectModel.Section" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `addBullets` + +Add bullet points to this section (extends the existing list). + +## Signature + +```typescript +addBullets(bullets: string[]): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 92. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/add-subsection.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/add-subsection.mdx new file mode 100644 index 0000000000..e60b8da0e5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/add-subsection.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/section/add-subsection" +title: "addSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.Section.addSubsection" + parent: "POM.PromptObjectModel.Section" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `addSubsection` + +Add a subsection to this section. + +## Signature + +```typescript +addSubsection(title: string, opts: { ...4 fields } = {}): Section +``` + +## Parameters + + + The title of the subsection (required — subsections must have a title). + + + + Optional body / bullets / numbering for the subsection. + + + + + + + + + + +## Returns + +`Section` — The newly created Section. + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 106. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/constructor.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/constructor.mdx new file mode 100644 index 0000000000..f8e8c5f522 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/constructor.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/section/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.Section.constructor" + parent: "POM.PromptObjectModel.Section" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(title: string | null = null, opts: { ...4 fields } = {}): Section +``` + +## Parameters + + + Section title (null permitted only on the very first top-level section). + + + + Keyword-style options matching Python's `body=`/`bullets=`/`numbered=`/`numberedBullets=`. + + + + + + + + + + +## Returns + +`Section` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 52. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/index.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/index.mdx new file mode 100644 index 0000000000..5f8404e390 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/index.mdx @@ -0,0 +1,88 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/section" +title: "Section" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "POM.PromptObjectModel.Section" + parent: "POM.PromptObjectModel" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `Section` + +A section in the Prompt Object Model. + +Each section contains a title, optional body text, optional bullet points, +and can have any number of nested subsections. + +## Signature + +```typescript +class Section +``` + +## Properties + + + A paragraph of text associated with the section. + + + + Bullet-pointed items. + + + + Whether this section should be numbered. + + + + Whether bullets should be numbered instead of using bullet points. + + + + Nested sections with the same structure. + + + + The name of the section. + + +## Methods + + + + Add or replace the body text for this section. + + + + Add bullet points to this section (extends the existing list). + + + + Add a subsection to this section. + + + + + + Render this section and all its subsections as markdown. + + + + Render this section and all its subsections as XML. + + + + Convert the section to a dictionary representation. + + + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/render-markdown.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/render-markdown.mdx new file mode 100644 index 0000000000..8576e862f2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/render-markdown.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/section/render-markdown" +title: "renderMarkdown" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.Section.renderMarkdown" + parent: "POM.PromptObjectModel.Section" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `renderMarkdown` + +Render this section and all its subsections as markdown. + +## Signature + +```typescript +renderMarkdown(level: number = 2, sectionNumber: number[] | null = null): string +``` + +## Parameters + + + The heading level to start with (default 2 = `##`). + + + + The current section number for numbered sections. + + +## Returns + +`string` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 147. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/render-xml.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/render-xml.mdx new file mode 100644 index 0000000000..94e3bcb17a --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/render-xml.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/section/render-xml" +title: "renderXml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.Section.renderXml" + parent: "POM.PromptObjectModel.Section" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `renderXml` + +Render this section and all its subsections as XML. + +## Signature + +```typescript +renderXml(indent: number = 0, sectionNumber: number[] | null = null): string +``` + +## Parameters + + + The indentation level to start with (default 0). + + + + The current section number for numbered sections. + + +## Returns + +`string` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 194. diff --git a/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/to-dict.mdx b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/to-dict.mdx new file mode 100644 index 0000000000..285346ff78 --- /dev/null +++ b/fern/products/sdk-reference/typescript/pom/prompt-object-model/section/to-dict.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/pom/prompt-object-model/section/to-dict" +title: "toDict" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "POM.PromptObjectModel.Section.toDict" + parent: "POM.PromptObjectModel.Section" + module: "POM.PromptObjectModel" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts" +--- +# `toDict` + +Convert the section to a dictionary representation. + +## Signature + +```typescript +toDict(): SectionData +``` + +## Returns + +`SectionData` + +## Source + +[`src/POM/PromptObjectModel.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/POM/PromptObjectModel.ts) + +Line 129. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-answer-verb.mdx new file mode 100644 index 0000000000..57959418f2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-answer-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-answer-verb" +title: "addAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addAnswerVerb" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addAnswerVerb` + +Configure the answer verb (phase 2) with optional settings. + +## Signature + +```typescript +addAnswerVerb(config?: Record): this +``` + +## Parameters + + + Optional answer verb configuration. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1493. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-function-include.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-function-include.mdx new file mode 100644 index 0000000000..48e4f2c408 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-function-include.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-function-include" +title: "addFunctionInclude" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addFunctionInclude" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addFunctionInclude` + +Add a remote SWAIG function include reference. + +## Signature + +```typescript +addFunctionInclude( + url: string, + functions: string[], + metaData?: Record +): this +``` + +## Parameters + + + URL of the remote SWAIG endpoint. + + + + Function names available at that endpoint. + + + + Optional metadata to attach to the include. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 965. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-hint.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-hint.mdx new file mode 100644 index 0000000000..da97137d4e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-hint.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-hint" +title: "addHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addHint" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHint` + +Add a single speech-recognition hint. + +## Signature + +```typescript +addHint(hint: string): this +``` + +## Parameters + + + Word or phrase to boost in speech recognition. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 652. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-hints.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-hints.mdx new file mode 100644 index 0000000000..ac3f476b7b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-hints.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-hints" +title: "addHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addHints" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHints` + +Add multiple speech-recognition hints at once. + +## Signature + +```typescript +addHints(hints: string[]): this +``` + +## Parameters + + + Array of words or phrases to boost. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 662. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-internal-filler.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-internal-filler.mdx new file mode 100644 index 0000000000..0597f33075 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-internal-filler.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-internal-filler" +title: "addInternalFiller" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addInternalFiller" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addInternalFiller` + +Add internal filler phrases for a single internal function and language. + +See [setInternalFillers](/reference/typescript/prefabs/concierge-agent/concierge-agent/set-internal-fillers) for the complete list of supported +functionName values and an explanation of what fillers do. + +## Signature + +```typescript +addInternalFiller( + functionName: string, + languageCode: string, + fillers: string[] +): this +``` + +## Parameters + + + One of the supported internal function names (see SUPPORTED\_INTERNAL\_FILLER\_NAMES). Names outside the supported set log a warning and are ignored by the runtime. + + + + BCP-47 language code for the fillers (e.g. 'en-US'). + + + + Array of filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 942. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-language.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-language.mdx new file mode 100644 index 0000000000..d8976ed74c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-language.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-language" +title: "addLanguage" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addLanguage" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addLanguage` + +Add a supported language to the AI configuration. + +## Signature + +```typescript +addLanguage(config: LanguageConfig): this +``` + +## Parameters + + + Language configuration including name, code, voice, and optional fillers. `params` may be set to attach engine-specific tuning (voice stability, similarity boost, model knobs, etc.); only emitted into SWML when non-empty so existing entries stay byte-identical when no params are passed (Python ai\_config\_mixin.py `add_language`). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 693. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-mcp-server.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-mcp-server.mdx new file mode 100644 index 0000000000..fb7eb49ce0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-mcp-server.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-mcp-server" +title: "addMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addMcpServer" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addMcpServer` + +Add an external MCP server for tool discovery and invocation. +Tools are discovered via MCP protocol at session start and added to the AI's tool list. + +## Signature + +```typescript +addMcpServer(url: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + MCP server HTTP endpoint URL + + + + Optional configuration: headers, resources, resourceVars + + + + + + + + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1145. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-pattern-hint.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-pattern-hint.mdx new file mode 100644 index 0000000000..1cc8ecabdf --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-pattern-hint.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-pattern-hint" +title: "addPatternHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addPatternHint" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPatternHint` + +Add a pattern-based speech-recognition hint with find-and-replace behavior. + +## Signature + +```typescript +addPatternHint(opts: { ...4 fields }): this +``` + +## Parameters + + + Pattern hint configuration with a descriptive hint label, regex pattern, replacement string, and optional case-insensitive flag. + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 673. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-post-ai-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-post-ai-verb.mdx new file mode 100644 index 0000000000..9b095608f5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-post-ai-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-post-ai-verb" +title: "addPostAiVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addPostAiVerb" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAiVerb` + +Add a SWML verb to execute after the AI verb (phase 5). + +## Signature + +```typescript +addPostAiVerb(verbName: string, config: Record): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1515. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-post-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-post-answer-verb.mdx new file mode 100644 index 0000000000..bebfe65808 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-post-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-post-answer-verb" +title: "addPostAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addPostAnswerVerb" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAnswerVerb` + +Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + +## Signature + +```typescript +addPostAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1504. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-pre-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..e79ff80a28 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-pre-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-pre-answer-verb" +title: "addPreAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addPreAnswerVerb" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPreAnswerVerb` + +Add a SWML verb to execute before the answer phase (phase 1). + +## Signature + +```typescript +addPreAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb (e.g. "play", "record"). + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1483. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-pronunciation.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-pronunciation.mdx new file mode 100644 index 0000000000..a1eac88880 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-pronunciation.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-pronunciation" +title: "addPronunciation" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addPronunciation" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPronunciation` + +Add a pronunciation override rule for the TTS engine. + +## Signature + +```typescript +addPronunciation(rule: PronunciationRule): this +``` + +## Parameters + + + Pronunciation rule specifying the text to replace and its substitute. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 773. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-section.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-section.mdx new file mode 100644 index 0000000000..76c879b120 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addSection" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addSection` + +Add a new named section to the SWML document. +Mirrors Python's `add_section()`. + +## Signature + +```typescript +addSection(sectionName: string): this +``` + +## Parameters + + + Name of the section to create. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 653. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-skill-by-name.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-skill-by-name.mdx new file mode 100644 index 0000000000..792846abf9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-skill-by-name.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-skill-by-name" +title: "addSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addSkillByName" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkillByName` + +Add a skill by its registered name, looking it up in the global SkillRegistry. + +Matches Python's `add_skill(skill_name, params)` which loads skills by string +name via the SkillManager registry. Throws a `ValueError`-equivalent if the +skill name is not found in the registry. + +## Signature + +```typescript +addSkillByName(skillName: string, params?: SkillConfig): Promise +``` + +## Parameters + + + The name the skill was registered under in the SkillRegistry. + + + + Optional configuration parameters forwarded to the skill factory. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Throws + +- Error if no skill with the given name is registered. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1627. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-skill.mdx new file mode 100644 index 0000000000..4d263fbba0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-skill" +title: "addSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addSkill" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkill` + +Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + +## Signature + +```typescript +addSkill(skill: SkillBase): Promise +``` + +## Parameters + + + The skill instance to add. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1562. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-swaig-query-params.mdx new file mode 100644 index 0000000000..89810c6928 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-swaig-query-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-swaig-query-params" +title: "addSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addSwaigQueryParams" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSwaigQueryParams` + +Add extra query parameters appended to all SWAIG webhook URLs. + +## Signature + +```typescript +addSwaigQueryParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to append as query parameters. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1714. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-verb-to-section.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-verb-to-section.mdx new file mode 100644 index 0000000000..2995d8e575 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-verb-to-section.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-verb-to-section" +title: "addVerbToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addVerbToSection" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerbToSection` + +Add a verb to a specific named section. +Mirrors Python's `add_verb_to_section()`. + +## Signature + +```typescript +addVerbToSection(sectionName: string, verbName: string, config: unknown): this +``` + +## Parameters + + + Target section name (auto-created if missing). + + + + Verb name. + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 669. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-verb.mdx new file mode 100644 index 0000000000..35e37f1648 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/add-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/add-verb" +title: "addVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.addVerb" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerb` + +Add a verb to the SWML document. + +## Signature + +```typescript +addVerb(name: string, config: unknown): this +``` + +## Parameters + + + Verb name (e.g., 'answer', 'play', 'hangup'). + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 642. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/as-router.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/as-router.mdx new file mode 100644 index 0000000000..c1b0d2cefe --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/as-router.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/as-router" +title: "asRouter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.asRouter" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `asRouter` + +Return this agent's Hono app for mounting as a sub-router in an AgentServer. + +## Signature + +```typescript +asRouter(): Hono +``` + +## Returns + +`Hono` — The Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2637. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/auto-map-sip-usernames.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/auto-map-sip-usernames.mdx new file mode 100644 index 0000000000..fde9d45150 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/auto-map-sip-usernames.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/auto-map-sip-usernames" +title: "autoMapSipUsernames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.autoMapSipUsernames" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `autoMapSipUsernames` + +Automatically register common SIP usernames based on this agent's +name and route. Derives cleaned variants (alphanumeric + underscore) +and registers each via `registerSipUsername()`. + +Port of Python's `auto_map_sip_usernames()`: + +- Registers a cleaned version of the agent name +- Registers a cleaned version of the route (if different from name) +- For names longer than 3 characters, also registers a vowel-stripped variant + +## Signature + +```typescript +autoMapSipUsernames(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1057. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/build-swml-for-request.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/build-swml-for-request.mdx new file mode 100644 index 0000000000..6691a984c1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/build-swml-for-request.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/build-swml-for-request" +title: "buildSwmlForRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.buildSwmlForRequest" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `buildSwmlForRequest` + +Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` +to fully replace the document for this request, or `null` to fall +through to `setOnRequestCallback` or the static builder. + +This is distinct from the WebMixin `onRequest(requestData, +callbackPath)` hook on AgentBase (which mirrors Python's +`on_request -> on_swml_request` modification-merge contract). +Use this hook when you want to swap the entire SWML builder; use +`onRequest` / `onSwmlRequest` on AgentBase when you want to merge +targeted modifications into the rendered document. + +Default implementation returns `null` (no-op). + +## Signature + +```typescript +buildSwmlForRequest( + _queryParams: Record, + _bodyParams: Record, + _headers: Record, + _callbackPath?: string +): SwmlBuilder | null +``` + +## Parameters + + + + + + + + + +## Returns + +`SwmlBuilder | null` — A `SwmlBuilder` whose document is sent as the response, or `null` to delegate to the next handler in the chain. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 834. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..bd56acafd4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-post-ai-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/clear-post-ai-verbs" +title: "clearPostAiVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.clearPostAiVerbs" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAiVerbs` + +Remove all post-AI verbs. + +## Signature + +```typescript +clearPostAiVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1542. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..1b4ad13f74 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-post-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/clear-post-answer-verbs" +title: "clearPostAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.clearPostAnswerVerbs" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAnswerVerbs` + +Remove all post-answer verbs. + +## Signature + +```typescript +clearPostAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1533. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..af97ecf3cc --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-pre-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/clear-pre-answer-verbs" +title: "clearPreAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.clearPreAnswerVerbs" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPreAnswerVerbs` + +Remove all pre-answer verbs. + +## Signature + +```typescript +clearPreAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1524. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..cbd778530f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/clear-swaig-query-params.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/clear-swaig-query-params" +title: "clearSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.clearSwaigQueryParams" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearSwaigQueryParams` + +Clear all SWAIG query parameters. + +## Signature + +```typescript +clearSwaigQueryParams(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1723. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/constructor.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/constructor.mdx new file mode 100644 index 0000000000..ff76fa527a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.constructor" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts" +--- +# `constructor` + +Create a ConciergeAgent for a venue with the given services, amenities, and hours. + +## Signature + +```typescript +constructor(config: ConciergeConfig): ConciergeAgent +``` + +## Parameters + + + Configuration including venue name, services, amenities, and optional hours/instructions/welcome. + + +## Returns + +`ConciergeAgent` + +## Source + +[`src/prefabs/ConciergeAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts) + +Line 80. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/create-tool-token.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/create-tool-token.mdx new file mode 100644 index 0000000000..fb30394bce --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/create-tool-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/create-tool-token" +title: "createToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.createToolToken" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `createToolToken` + +Mint a per-call SWAIG-function token via the agent's SessionManager. + +Mirrors Python reference `core/mixins/state_mixin.py _create_tool_token`: +delegates to `SessionManager.createToolToken` and returns an empty +string on any failure (Python catches all exceptions and returns ""). + +## Signature + +```typescript +createToolToken(toolName: string, callId: string): string +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1467. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-contexts.mdx new file mode 100644 index 0000000000..29c8f89453 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-contexts.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/define-contexts" +title: "defineContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.defineContexts" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineContexts` + +Define or replace the contexts configuration for the AI verb. + +## Signature + +```typescript +defineContexts( + contexts?: Record | ContextBuilder +): ContextBuilder +``` + +## Parameters + + + An existing ContextBuilder instance or a plain object; a new ContextBuilder is created if omitted. + + +## Returns + +`ContextBuilder` — The active ContextBuilder for further configuration. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 603. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-tool.mdx new file mode 100644 index 0000000000..472d9b3899 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-tool.mdx @@ -0,0 +1,114 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.defineTool" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTool` + +Register a SWAIG tool (function) that the AI can invoke during a call. + +## How this becomes a tool the model sees + +A SWAIG function is **exactly the same concept** as a "tool" in +native OpenAI / Anthropic tool calling. On every LLM turn, the SDK +renders each registered SWAIG function into the OpenAI tool schema: + +```json +{ +"type": "function", +"function": { +"name": "your_name_here", +"description": "your description text", +"parameters": { /* your JSON schema */ } +} +} +``` + +That schema goes to the model in the same API call that produces +the next assistant message. The model reads: + +- the **function `description`** to decide WHEN to call this tool +- each **parameter `description`** (inside the JSON schema) to + decide HOW to fill in each argument + +This means **descriptions are prompt engineering**, not developer +comments. A vague description is the #1 cause of "the model has the +right tool but doesn't call it" failures. + +### Bad vs good descriptions + +```text +BAD : description: 'Lookup function' +GOOD: description: 'Look up a customer's account details by account +number. Use this BEFORE quoting any account-specific info +(balance, plan, status). Do not use for general product +questions.' + +BAD : parameters: { id: { type: 'string', description: 'the id' } } +GOOD: parameters: { account_number: { type: 'string', description: +'The customer's 8-digit account number, no dashes or spaces. +Ask the user if they don't provide it.' } } +``` + +### Tool count matters + +LLM tool selection accuracy degrades past ~7-8 simultaneously-active +tools per call. Use Step.setFunctions() to partition tools across +steps so only the relevant subset is active at any moment. + +## Signature + +```typescript +defineTool(opts: { ...11 fields }): this +``` + +## Parameters + + + Tool definition including name, description, parameter schema, and handler callback. `description` and per-parameter `description` strings are LLM-facing prompt engineering. + + + + + Additional fields to pass through to the SWAIG function definition (Python `**swaig_fields` equivalent). + + + + + + + + + + + + + + + + + + + + External webhook URL; makes this an externally-hosted tool. + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1329. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-tools.mdx new file mode 100644 index 0000000000..2fcbb7ddd3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/define-tools" +title: "defineTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.defineTools" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts" + visibility: "protected" +--- +# `defineTools` + +Register the `check_availability` and `get_directions` SWAIG tools. + +## Signature + +```typescript +defineTools(): void +``` + +## Returns + +`void` + +## Source + +[`src/prefabs/ConciergeAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts) + +Line 203. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-typed-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-typed-tool.mdx new file mode 100644 index 0000000000..f5205b87d4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/define-typed-tool.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/define-typed-tool" +title: "defineTypedTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.defineTypedTool" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTypedTool` + +Register a SWAIG tool with a typed handler that receives named parameters +instead of the standard `(args, rawData)` convention. + +The SDK wraps the handler to unpack the args dict into positional params. +If no `parameters` schema is provided, one is inferred from the handler's +source code (parameter names and default values). + +## Signature + +```typescript +defineTypedTool(opts: { ...9 fields }): this +``` + +## Parameters + + + Tool definition with a typed handler function. + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1372. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-debug-events.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-debug-events.mdx new file mode 100644 index 0000000000..6620a2d287 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-debug-events.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/enable-debug-events" +title: "enableDebugEvents" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.enableDebugEvents" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugEvents` + +Enable debug event webhooks for this agent. + +## Signature + +```typescript +enableDebugEvents(level: number = 1): this +``` + +## Parameters + + + Debug verbosity level (defaults to 1). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1010. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-debug-routes.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-debug-routes.mdx new file mode 100644 index 0000000000..96cdb34af9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-debug-routes.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/enable-debug-routes" +title: "enableDebugRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.enableDebugRoutes" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugRoutes` + +Register a callback function that determines routing based on POST data. + +When a routing callback is registered, an endpoint at the specified path +is created in `getApp()`. The callback receives the request body and returns +Enable debug routes for testing and development. + +This is a backward-compatibility stub matching the Python SDK. +In the TypeScript SDK, debug routes (health, ready, debug\_events) +are automatically registered in `getApp()`. + +## Signature + +```typescript +enableDebugRoutes(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1754. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-mcp-server.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-mcp-server.mdx new file mode 100644 index 0000000000..04ff9ab303 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-mcp-server.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/enable-mcp-server" +title: "enableMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.enableMcpServer" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableMcpServer` + +Expose this agent's tools as an MCP server endpoint at /mcp. +Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + +## Signature + +```typescript +enableMcpServer(): this +``` + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1159. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-sip-routing.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-sip-routing.mdx new file mode 100644 index 0000000000..b5e8d619e8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/enable-sip-routing.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/enable-sip-routing" +title: "enableSipRouting" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.enableSipRouting" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableSipRouting` + +Enable SIP routing for this agent. + +## Signature + +```typescript +enableSipRouting(autoMap: boolean = true, path: string = '/sip'): this +``` + +## Parameters + + + When true, automatically map SIP usernames to the agent route (defaults to true). + + + + HTTP path for the SIP routing endpoint (defaults to '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1024. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/extract-sip-username.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/extract-sip-username.mdx new file mode 100644 index 0000000000..a4cfde1e7c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/extract-sip-username.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/extract-sip-username" +title: "extractSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.extractSipUsername" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `extractSipUsername` + +Extract the SIP username from a request body's call.to field. + +**Modifiers:** `static` + +## Signature + +```typescript +extractSipUsername(requestBody: Record): string | null +``` + +## Parameters + + + The parsed request body containing call information. + + +## Returns + +`string | null` — The extracted SIP username, or null if not found. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1121. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-all-functions.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-all-functions.mdx new file mode 100644 index 0000000000..141f3f886c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-all-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-all-functions" +title: "getAllFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getAllFunctions" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getAllFunctions` + +Snapshot of all registered SWAIG functions keyed by name. +(Python parity: `ToolRegistry.get_all_functions`.) + +## Signature + +```typescript +getAllFunctions(): Record> +``` + +## Returns + +`Record>` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 529. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-app.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-app.mdx new file mode 100644 index 0000000000..b6a2ebab8a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-app.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-app" +title: "getApp" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getApp" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getApp` + +Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + +## Signature + +```typescript +getApp(): Hono +``` + +## Returns + +`Hono` — The configured Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2250. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..75b181b696 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-basic-auth-credentials.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-basic-auth-credentials" +title: "getBasicAuthCredentials" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getBasicAuthCredentials" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getBasicAuthCredentials` + +Get the basic-auth credentials used by this agent. + +## Signature + + + + ```typescript + getBasicAuthCredentials(includeSource?: false): [string, string] + ``` + + + + ```typescript + getBasicAuthCredentials( + includeSource: true + ): [string, string, "provided" | "environment" | "generated"] + ``` + + + +## Parameters (Overload 1) + + + When true, a third element indicating the credential source is appended. + + +## Parameters (Overload 2) + + + When true, a third element indicating the credential source is appended. + + +## Returns (Overload 1) + +`[string, string]` — A tuple of \[username, password] or \[username, password, source]. + +## Returns (Overload 2) + +`[string, string, "provided" | "environment" | "generated"]` — A tuple of \[username, password] or \[username, password, source]. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2775. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-builder.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-builder.mdx new file mode 100644 index 0000000000..f670eeb5f4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-builder.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-builder" +title: "getBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getBuilder" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getBuilder` + +Get the underlying SwmlBuilder for direct manipulation. + +## Signature + +```typescript +getBuilder(): SwmlBuilder +``` + +## Returns + +`SwmlBuilder` — The SwmlBuilder instance. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 632. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-contexts.mdx new file mode 100644 index 0000000000..f2f0bc558a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-contexts" +title: "getContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getContexts" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getContexts` + +Get the contexts dictionary as serialised SWML, or null when no +contexts have been defined yet. + +Matches Python `PromptManager.get_contexts()` which returns the +contexts dict or `None`. + +## Signature + +```typescript +getContexts(): Record | null +``` + +## Returns + +`Record | null` — Contexts dict, or null when no contexts are defined. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 640. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-document.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-document.mdx new file mode 100644 index 0000000000..ec970b65a5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-document" +title: "getDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getDocument" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getDocument` + +Get the SWML document as a dictionary. +Alias for `renderSwml()` that matches Python's `get_document()` name. + +## Signature + +```typescript +getDocument(): Record +``` + +## Returns + +`Record` — The SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 706. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-full-url.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-full-url.mdx new file mode 100644 index 0000000000..90fa1a326d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-full-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-full-url" +title: "getFullUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getFullUrl" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getFullUrl` + +Get the full external URL of this agent, using the proxy base URL if available. + +## Signature + +```typescript +getFullUrl(includeAuth: boolean = false): string +``` + +## Parameters + + + Whether to embed basic-auth credentials in the URL (defaults to false). + + +## Returns + +`string` — The fully-qualified URL string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1838. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-function.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-function.mdx new file mode 100644 index 0000000000..34f2aeb9cc --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-function" +title: "getFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getFunction" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getFunction` + +Get a registered SWAIG function entry, or undefined. +(Python parity: `ToolRegistry.get_function`.) + +## Signature + +```typescript +getFunction(name: string): Record | SwaigFunction | undefined +``` + +## Parameters + + + +## Returns + +`Record | SwaigFunction | undefined` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 523. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-language-params.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-language-params.mdx new file mode 100644 index 0000000000..719dc003c7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-language-params.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-language-params" +title: "getLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getLanguageParams" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getLanguageParams` + +Read the per-language `params` dict for a previously-added language. + +Python parity: `get_language_params(code)`. Returns `undefined` if the +code is unknown or the language has no params set — no exception path. + +## Signature + +```typescript +getLanguageParams(code: string): Record | undefined +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/prefabs/concierge-agent/concierge-agent/add-language). + + +## Returns + +`Record | undefined` — The params dict if set, `undefined` otherwise (including when the code is unknown). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 759. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-mcp-servers.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-mcp-servers.mdx new file mode 100644 index 0000000000..27926bba2a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-mcp-servers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-mcp-servers" +title: "getMcpServers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getMcpServers" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getMcpServers` + +Get configured MCP servers (read-only copy). + +## Signature + +```typescript +getMcpServers(): Record[] +``` + +## Returns + +`Record[]` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1170. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-name.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-name.mdx new file mode 100644 index 0000000000..4784110a41 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-name" +title: "getName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getName" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getName` + +Get the agent's display name. + +## Signature + +```typescript +getName(): string +``` + +## Returns + +`string` — The agent name string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1551. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-post-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-post-prompt.mdx new file mode 100644 index 0000000000..9f0b1fd74a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-post-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-post-prompt" +title: "getPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getPostPrompt" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPostPrompt` + +Get the post-prompt text, if one has been set. + +## Signature + +```typescript +getPostPrompt(): string | null +``` + +## Returns + +`string | null` — The post-prompt string, or null if not configured. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 547. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-prompt-pom.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-prompt-pom.mdx new file mode 100644 index 0000000000..969a90a44b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-prompt-pom.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-prompt-pom" +title: "getPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getPromptPom" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPromptPom` + +Get the raw POM (Prompt Object Model) structure as an array of section data objects, +when the agent is in POM mode and has at least one section. + +Matches Python `get_prompt()` which returns `Union[str, List[Dict]]` — a raw list when +in POM mode (via `pom.to_list()` / `pom.render_dict()`), or a string otherwise. +The TS `getPrompt()` always returns a string (rendered Markdown), so this companion +method exposes the raw POM structure for callers that need it for serialisation or +inspection (e.g. skills that inspect prompt sections). + +## Signature + +```typescript +getPromptPom(): Record[] | null +``` + +## Returns + +`Record[] | null` — An array of POM section data objects, or null if not in POM mode or POM is empty. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 535. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-prompt.mdx new file mode 100644 index 0000000000..d50d0901e7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-prompt" +title: "getPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getPrompt" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPrompt` + +Get the fully rendered main prompt text. + +## Signature + +```typescript +getPrompt(): string +``` + +## Returns + +`string` — The assembled prompt string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 519. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-raw-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-raw-prompt.mdx new file mode 100644 index 0000000000..509c1471f7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-raw-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-raw-prompt" +title: "getRawPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getRawPrompt" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getRawPrompt` + +Get the raw prompt text whatever `setPromptText` stored, or null when +no raw prompt has been set. + +Matches Python `PromptManager.get_raw_prompt()` which returns the raw +stored string or `None`. Use this instead of `getPrompt()` when you +need the unrendered text rather than the POM-rendered Markdown. + +## Signature + +```typescript +getRawPrompt(): string | null +``` + +## Returns + +`string | null` — The raw prompt string, or null if not set. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 561. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-registered-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-registered-tools.mdx new file mode 100644 index 0000000000..8d56e93fdf --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-registered-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-registered-tools" +title: "getRegisteredTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getRegisteredTools" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getRegisteredTools` + +Get a summary of all registered tools with their names, descriptions, and +parameter schemas. Lifted from AgentBase so the swaig-test CLI can list +tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG +host). + +## Signature + +```typescript +getRegisteredTools(): { description: string; name: string; parameters: Record }[] +``` + +## Returns + +`{ description: string; name: string; parameters: Record }[]` — Array of tool descriptors. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-tool.mdx new file mode 100644 index 0000000000..6ebc4d4364 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-tool.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-tool" +title: "getTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getTool" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getTool` + +Look up a registered SwaigFunction by name. Lifted from AgentBase so +`swaig-test --exec ` works against a non-AgentBase SWMLService +target. + +## Signature + +```typescript +getTool(name: string): SwaigFunction | undefined +``` + +## Parameters + + + The tool name to search for. + + +## Returns + +`SwaigFunction | undefined` — The SwaigFunction instance, or undefined if not found or not a SwaigFunction. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 581. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-tools.mdx new file mode 100644 index 0000000000..c26532176d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/get-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.getTools" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getTools` + +Public access to the list of registered tools. + +In Python, `define_tools()` is public and returns `List[SWAIGFunction]`. +In TypeScript, `defineTools()` is a protected setup hook (void). This +method provides the equivalent public "get all tools" capability. + +## Signature + +```typescript +getTools(): SwaigFunction[] +``` + +## Returns + +`SwaigFunction[]` — Array of all registered SwaigFunction instances. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 370. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/handle-mcp-request.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/handle-mcp-request.mdx new file mode 100644 index 0000000000..f930f2c19d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/handle-mcp-request.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/handle-mcp-request" +title: "handleMcpRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.handleMcpRequest" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `handleMcpRequest` + +Handle an MCP JSON-RPC 2.0 request. Returns the response object. + +## Signature + +```typescript +handleMcpRequest( + body: Record +): Promise> +``` + +## Parameters + + + +## Returns + +`Promise>` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1203. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/has-function.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/has-function.mdx new file mode 100644 index 0000000000..3f04000b64 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/has-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/has-function" +title: "hasFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.hasFunction" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasFunction` + +Whether a SWAIG function with the given name is registered. +(Python parity: `ToolRegistry.has_function`.) + +## Signature + +```typescript +hasFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 517. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/has-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/has-skill.mdx new file mode 100644 index 0000000000..6b3afea7a2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/has-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/has-skill" +title: "hasSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.hasSkill" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `hasSkill` + +Check whether a skill with the given name is registered. + +## Signature + +```typescript +hasSkill(skillName: string): boolean +``` + +## Parameters + + + The skill name to check. + + +## Returns + +`boolean` — True if a skill with that name exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1657. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/has-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/has-tool.mdx new file mode 100644 index 0000000000..44c4a2d86e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/has-tool.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/has-tool" +title: "hasTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.hasTool" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasTool` + +Whether a tool with the given name is registered. + +## Signature + +```typescript +hasTool(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/index.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/index.mdx new file mode 100644 index 0000000000..6b10eb0c47 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/index.mdx @@ -0,0 +1,612 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent" +title: "ConciergeAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent" + parent: "prefabs.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts" +--- +# `ConciergeAgent` + +Prefab agent that acts as a virtual concierge for a venue, providing information +about services, amenities, hours of operation, availability, and directions. + +## Signature + +```typescript +class ConciergeAgent extends AgentBase +``` + +## Inheritance + +**Extends:** [AgentBase](/reference/typescript/agent-base) + +## Examples + +```typescript +import { ConciergeAgent } from '@signalwire/sdk'; + +const agent = new ConciergeAgent({ + venueName: 'The Park Hotel', + services: ['Room service', 'Valet parking', 'Spa', 'Restaurant'], + hoursOfOperation: { + restaurant: '7 AM - 10 PM daily', + spa: '9 AM - 9 PM daily', + default: '24 hours', + }, + amenities: { + pool: { location: 'Rooftop', hours: '6 AM - 10 PM' }, + gym: { location: 'Floor 2', hours: '24 hours' }, + }, +}); + +await agent.serve({ port: 3000 }); +``` + +## Properties + + + Unique identifier for this agent instance. + + + + Dictionary of amenities, each mapping to a dict of detail keys/values. + + + + + + + + Domain name for SSL. Mirrors Python's `self.domain`. + + + + Check if full JSON Schema validation is enabled. Mirrors Python's `@property full_validation_enabled`. + + + + Host the server binds to. + + + + Hours of operation by category. Defaults to `{ default: "9 AM - 5 PM" }`. + + + + Structured logger instance for this agent. Override the inherited SWMLService logger with an AgentBase-tagged one. + + + + Service display name. + + + + Public accessor for the native functions list. Python exposes `self.native_functions` as a public read/write attribute. + + + + + + Public accessor for the agent's POM as a `PromptObjectModel` instance. Python parity: `agent.pom` instance attribute (agent\_base.py line 209) is a `signalwire.pom.pom.PromptObjectModel` when `use_pom=True`, or `None` otherwise. This getter returns the equivalent TypeScript `PromptObjectModel` instance — callers can use `addSection`, `findSection`, `renderMarkdown`, `renderXml`, `toJson`, `toYaml` exactly as in Python. The instance returned is a fresh snapshot built from the current `PomBuilder` state, so mutating it does not feed back into the agent's internal builder. To mutate the agent's prompt, use `promptAddSection` / `promptAddToSection` / `promptAddSubsection`. + + + + Port the server binds to. + + + + Static prompt sections: subclasses can define these declaratively. Each entry is applied via promptAddSection() in the constructor. + + + + Public accessor for the PromptManager (POM). Python exposes `self.pom` as a public attribute. This getter provides equivalent access for direct POM manipulation. + + + + HTTP route path. + + + + Schema validation utilities. Mirrors Python's `self.schema_utils`. + + + + Unified security configuration. Mirrors Python's `self.security`. + + + + List of services offered by the venue. + + + + Public read-only accessor for the SkillManager. Python exposes `self.skill_manager` as a public attribute. This getter provides equivalent read access. + + + + Special instructions appended to the agent's instruction bullets. + + + + Path to SSL certificate. Mirrors Python's `self.ssl_cert_path`. + + + + Whether SSL is enabled. Mirrors Python's `self.ssl_enabled`. + + + + Path to SSL private key. Mirrors Python's `self.ssl_key_path`. + + + + The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — addInternalFiller / setInternalFillers warn if you pass an unknown name. + + + + + + + + Name of the venue or business. + + + + Custom verb handler registry. Mirrors Python's `self.verb_registry`. + + +## Methods + + + + Configure the answer verb (phase 2) with optional settings. + + + + Add a remote SWAIG function include reference. + + + + Add a single speech-recognition hint. + + + + Add multiple speech-recognition hints at once. + + + + Add internal filler phrases for a single internal function and language. + + + + Add a supported language to the AI configuration. + + + + Add an external MCP server for tool discovery and invocation. Tools are discovered via MCP protocol at session start and added to the AI's tool list. + + + + Add a pattern-based speech-recognition hint with find-and-replace behavior. + + + + Add a SWML verb to execute after the AI verb (phase 5). + + + + Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + + + + Add a SWML verb to execute before the answer phase (phase 1). + + + + Add a pronunciation override rule for the TTS engine. + + + + Add a new named section to the SWML document. Mirrors Python's `add_section()`. + + + + Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + + + + Add a skill by its registered name, looking it up in the global SkillRegistry. + + + + Add extra query parameters appended to all SWAIG webhook URLs. + + + + Add a verb to the SWML document. + + + + Add a verb to a specific named section. Mirrors Python's `add_verb_to_section()`. + + + + Return this agent's Hono app for mounting as a sub-router in an AgentServer. + + + + Automatically register common SIP usernames based on this agent's name and route. Derives cleaned variants (alphanumeric + underscore) and registers each via `registerSipUsername()`. + + + + Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` to fully replace the document for this request, or `null` to fall through to `setOnRequestCallback` or the static builder. + + + + Remove all post-AI verbs. + + + + Remove all post-answer verbs. + + + + Remove all pre-answer verbs. + + + + Clear all SWAIG query parameters. + + + + Create a ConciergeAgent for a venue with the given services, amenities, and hours. + + + + Mint a per-call SWAIG-function token via the agent's SessionManager. + + + + Define or replace the contexts configuration for the AI verb. + + + + Register a SWAIG tool (function) that the AI can invoke during a call. + + + + Register the `check_availability` and `get_directions` SWAIG tools. + + + + Register a SWAIG tool with a typed handler that receives named parameters instead of the standard `(args, rawData)` convention. + + + + Enable debug event webhooks for this agent. + + + + Register a callback function that determines routing based on POST data. + + + + Expose this agent's tools as an MCP server endpoint at /mcp. Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + + + + Enable SIP routing for this agent. + + + + Extract the SIP username from a request body's call.to field. + + + + Snapshot of all registered SWAIG functions keyed by name. (Python parity: `ToolRegistry.get_all_functions`.) + + + + Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + + + + Get the basic-auth credentials used by this agent. + + + + Get the underlying SwmlBuilder for direct manipulation. + + + + Get the contexts dictionary as serialised SWML, or null when no contexts have been defined yet. + + + + Get the SWML document as a dictionary. Alias for `renderSwml()` that matches Python's `get_document()` name. + + + + Get the full external URL of this agent, using the proxy base URL if available. + + + + Get a registered SWAIG function entry, or undefined. (Python parity: `ToolRegistry.get_function`.) + + + + Read the per-language `params` dict for a previously-added language. + + + + Get configured MCP servers (read-only copy). + + + + Get the agent's display name. + + + + Get the post-prompt text, if one has been set. + + + + Get the fully rendered main prompt text. + + + + Get the raw POM (Prompt Object Model) structure as an array of section data objects, when the agent is in POM mode and has at least one section. + + + + Get the raw prompt text whatever `setPromptText` stored, or null when no raw prompt has been set. + + + + Get a summary of all registered tools with their names, descriptions, and parameter schemas. Lifted from AgentBase so the swaig-test CLI can list tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG host). + + + + Look up a registered SwaigFunction by name. Lifted from AgentBase so `swaig-test --exec ` works against a non-AgentBase SWMLService target. + + + + Public access to the list of registered tools. + + + + Handle an MCP JSON-RPC 2.0 request. Returns the response object. + + + + Whether a SWAIG function with the given name is registered. (Python parity: `ToolRegistry.has_function`.) + + + + Check whether a skill with the given name is registered. + + + + Whether a tool with the given name is registered. + + + + Check if MCP server endpoint is enabled. + + + + List all registered skills with their names, instance IDs, and initialization status. + + + + List registered tool names in insertion order (Map preserves it). + + + + Manually set the proxy base URL used for webhook URL generation. + + + + Lifecycle hook called when a debug event webhook is received. Override in subclasses. + + + + Hook called before each SWAIG function execution. Override in subclasses. + + + + Lifecycle hook called when SWML is requested. Default delegates to [onSwmlRequest](/reference/typescript/prefabs/concierge-agent/concierge-agent/on-swml-request) and returns its result. Subclasses typically override `onSwmlRequest` rather than this method. + + + + Process the interaction summary returned at the end of a call. Logs structured summaries as JSON. Subclasses may override to persist or process. + + + + Lifecycle hook called on every SWML request before rendering. Override in subclasses. + + + + Add a new section to the prompt with optional body, bullets, and subsections. + + + + Add a subsection under an existing prompt section. + + + + Append content to an existing prompt section. + + + + Check whether a prompt section with the given title exists. + + + + Extension point: register additional Hono routes after SWMLService mounts /health, /ready, /swaig, and the main route. AgentBase uses this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + + + + Register a callback at a specific HTTP path that decides how to route an incoming request. + + + + Register a SIP username to route to this agent. + + + + Register a SwaigFunction instance or a raw function descriptor (DataMap). + + + + Register a custom verb handler. Mirrors Python's `register_verb_handler()`. + + + + Remove a registered SWAIG function. Returns true when removed, false when not found. (Python parity: `ToolRegistry.remove_function`.) + + + + Remove a previously added skill by its instance ID. + + + + Remove a skill by its name (Python parity). + + + + Render the SWML document as a JSON string. Mirrors Python's `render_document()`. + + + + Render the complete SWML document by assembling all 5 phases: pre-answer, answer, post-answer, AI, and post-AI verbs. + + + + Remove all contexts, returning the agent to a no-contexts state. + + + + Reset the SWML document to an empty state. Mirrors Python's `reset_document()`. + + + + Alias for [serve](/reference/typescript/prefabs/concierge-agent/concierge-agent/serve). Starts the HTTP server. + + + + Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + + + + Start the HTTP server and begin listening for requests. + + + + Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + + + + Replace the entire list of function includes. Each include must have a `url` and `functions` array. + + + + Merge data into the global\_data object passed into the AI configuration. + + + + Set internal fillers for native SWAIG functions. + + + + Set (or replace) the per-language `params` dict on an already-added language. Useful when language entries are built up via [addLanguage](/reference/typescript/prefabs/concierge-agent/concierge-agent/add-language) first and engine-specific tuning is added later (e.g., from a config loader). + + + + Replace all configured languages with a new list. + + + + Set the list of native SWAIG function names (built-in platform functions). + + + + Set a callback invoked per-request to dynamically build SWML. When set, the static SwmlBuilder is ignored and the callback's returned SwmlBuilder is used instead. + + + + Set a single AI parameter (e.g. "temperature", "top\_p"). + + + + Merge multiple AI parameters into the existing params object. + + + + Set the post-prompt text evaluated after the call ends. + + + + Merge LLM-specific parameters into the post-prompt configuration. + + + + Override the default post-prompt webhook URL with a custom one. + + + + Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + + + + Set the prompt as a POM (Prompt Object Model) dictionary. + + + + Set the main system prompt text for the AI. + + + + Replace all pronunciation rules with a new list. + + + + Register process signal handlers for clean Kubernetes/Docker shutdown. Handles SIGTERM and SIGINT, waits for a timeout, then exits. + + + + Override the default SWAIG webhook URL with a custom one. + + + + Stop the HTTP server. Mirrors Python's `stop()`. + + + + Extension point: invoked between argument parsing and function dispatch on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is non-null, it's returned directly without dispatching. AgentBase may override to add session-token validation or ephemeral dynamic-config. + + + + Merge additional entries into the existing global\_data object. + + + + Override to add custom basic-auth validation logic beyond credential matching. + + + + Validate a tool-call token for the given function. + + + +## Source + +[`src/prefabs/ConciergeAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts) + +Line 64. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/is-mcp-server-enabled.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/is-mcp-server-enabled.mdx new file mode 100644 index 0000000000..1504d66a3d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/is-mcp-server-enabled.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/is-mcp-server-enabled" +title: "isMcpServerEnabled" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.isMcpServerEnabled" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `isMcpServerEnabled` + +Check if MCP server endpoint is enabled. + +## Signature + +```typescript +isMcpServerEnabled(): boolean +``` + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1165. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/list-skills.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/list-skills.mdx new file mode 100644 index 0000000000..3d0c92e90d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/list-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/list-skills" +title: "listSkills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.listSkills" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `listSkills` + +List all registered skills with their names, instance IDs, and initialization status. + +## Signature + +```typescript +listSkills(): { initialized: boolean; instanceId: string; name: string }[] +``` + +## Returns + +`{ initialized: boolean; instanceId: string; name: string }[]` — Array of skill descriptors. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1648. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/list-tool-names.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/list-tool-names.mdx new file mode 100644 index 0000000000..c89ff9db00 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/list-tool-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/list-tool-names" +title: "listToolNames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.listToolNames" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `listToolNames` + +List registered tool names in insertion order (Map preserves it). + +## Signature + +```typescript +listToolNames(): string[] +``` + +## Returns + +`string[]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 545. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/manual-set-proxy-url.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..2379a2fa9b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/manual-set-proxy-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/manual-set-proxy-url" +title: "manualSetProxyUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.manualSetProxyUrl" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `manualSetProxyUrl` + +Manually set the proxy base URL used for webhook URL generation. + +## Signature + +```typescript +manualSetProxyUrl(url: string): this +``` + +## Parameters + + + The external-facing base URL (trailing slashes are stripped). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1735. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-debug-event.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-debug-event.mdx new file mode 100644 index 0000000000..2fcd78becd --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-debug-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/on-debug-event" +title: "onDebugEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.onDebugEvent" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onDebugEvent` + +Lifecycle hook called when a debug event webhook is received. Override in subclasses. + +## Signature + +```typescript +onDebugEvent(_event: Record): void | Promise +``` + +## Parameters + + + The debug event payload. + + +## Returns + +`void | Promise` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1951. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-function-call.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-function-call.mdx new file mode 100644 index 0000000000..acaa731cd1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-function-call.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/on-function-call" +title: "onFunctionCall" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.onFunctionCall" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onFunctionCall` + +Hook called before each SWAIG function execution. Override in subclasses. + +**Behavioral note:** In the Python SDK, `on_function_call` IS the dispatcher +— it retrieves and executes the function, returning the result. In TypeScript, +`fn.execute()` is called separately after this hook. However, if this method +returns a non-void value, it is used as the result and the default execution +is skipped, enabling dispatch interception parity with Python. + +## Signature + +```typescript +onFunctionCall( + _name: string, + _args: Record, + _rawData: Record +): void | Record | Promise> +``` + +## Parameters + + + Name of the function about to execute. + + + + Parsed arguments for the function. + + + + The full raw SWAIG request payload. + + +## Returns + +`void | Record | Promise>` — Optionally a result dict to short-circuit default execution, or void/undefined to proceed normally. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1980. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-request.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-request.mdx new file mode 100644 index 0000000000..874065e42b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-request.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/on-request" +title: "onRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.onRequest" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onRequest` + +Lifecycle hook called when SWML is requested. Default delegates to +[onSwmlRequest](/reference/typescript/prefabs/concierge-agent/concierge-agent/on-swml-request) and returns its result. Subclasses typically +override `onSwmlRequest` rather than this method. + +Matches Python `WebMixin.on_request(request_data, callback_path)`. The +cross-language API is the two-arg form; the Hono `context` argument is +a TypeScript-side extra preserved for callers that already have it but +is not part of the audited surface. + +## Signature + +```typescript +onRequest( + requestData?: Record | null, + callbackPath?: string | null +): void | Record | Promise> +``` + +## Parameters + + + The parsed request body. + + + + Optional callback path from the request. + + +## Returns + +`void | Record | Promise>` — Optionally a dict of SWML modifications, or undefined for default rendering. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1916. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-summary.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-summary.mdx new file mode 100644 index 0000000000..2b9a8fe0ab --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-summary.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/on-summary" +title: "onSummary" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.onSummary" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts" +--- +# `onSummary` + +Process the interaction summary returned at the end of a call. +Logs structured summaries as JSON. Subclasses may override to persist or process. + +## Signature + +```typescript +onSummary( + summary: Record | null, + _rawData: Record +): void | Promise +``` + +## Parameters + + + + + +## Returns + +`void | Promise` + +## Source + +[`src/prefabs/ConciergeAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-swml-request.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-swml-request.mdx new file mode 100644 index 0000000000..489af2f1fe --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/on-swml-request.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/on-swml-request" +title: "onSwmlRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.onSwmlRequest" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onSwmlRequest` + +Lifecycle hook called on every SWML request before rendering. Override in subclasses. + +May optionally return a modification dict that will be merged into the +rendered SWML document (matching Python's `Optional[dict]` return type). + +Matches Python `on_swml_request(request_data, callback_path, request)` — the third +parameter is the FastAPI `Request` in Python; here it is the raw Hono context object +so that subclasses can access query parameters (`context.req.query()`), raw request +headers (`context.req.raw.headers`), etc. + +## Signature + +```typescript +onSwmlRequest( + _rawData: Record, + _callbackPath?: string, + _context?: any +): void | Record | Promise> +``` + +## Parameters + + + The parsed request body. + + + + Optional callback path from the request. + + + + The raw Hono context object (c), providing access to headers and query params. + + +## Returns + +`void | Record | Promise>` — Optionally a dict of SWML modifications, or void. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1939. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-section.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-section.mdx new file mode 100644 index 0000000000..e2694cee8a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-section.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-section" +title: "promptAddSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.promptAddSection" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSection` + +Add a new section to the prompt with optional body, bullets, and subsections. + +## Signature + +```typescript +promptAddSection(title: string, opts?: { ...5 fields }): this +``` + +## Parameters + + + Section heading. + + + + Optional section content including body text, bullet points, and subsections. + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 466. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-subsection.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-subsection.mdx new file mode 100644 index 0000000000..96d5e1d95b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-subsection.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-subsection" +title: "promptAddSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.promptAddSubsection" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSubsection` + +Add a subsection under an existing prompt section. + +## Signature + +```typescript +promptAddSubsection( + parentTitle: string, + title: string, + opts?: { ...2 fields } +): this +``` + +## Parameters + + + Title of the parent section. + + + + Title of the new subsection. + + + + Optional body text and bullet points for the subsection. + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 501. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-to-section.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-to-section.mdx new file mode 100644 index 0000000000..9a2cb685ee --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-to-section.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-add-to-section" +title: "promptAddToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.promptAddToSection" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddToSection` + +Append content to an existing prompt section. + +## Signature + +```typescript +promptAddToSection(title: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + Title of the section to append to. + + + + Content to add: body text, a single bullet, or multiple bullets. + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-has-section.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-has-section.mdx new file mode 100644 index 0000000000..3b3df2b034 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-has-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/prompt-has-section" +title: "promptHasSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.promptHasSection" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptHasSection` + +Check whether a prompt section with the given title exists. + +## Signature + +```typescript +promptHasSection(title: string): boolean +``` + +## Parameters + + + Section title to look for. + + +## Returns + +`boolean` — True if the section exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-additional-routes.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-additional-routes.mdx new file mode 100644 index 0000000000..50463ed47c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-additional-routes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/register-additional-routes" +title: "registerAdditionalRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.registerAdditionalRoutes" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `registerAdditionalRoutes` + +Extension point: register additional Hono routes after SWMLService +mounts /health, /ready, /swaig, and the main route. AgentBase uses +this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + +## Signature + +```typescript +registerAdditionalRoutes(_app: Hono): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 604. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-routing-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-routing-callback.mdx new file mode 100644 index 0000000000..8d94e1881f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-routing-callback.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/register-routing-callback" +title: "registerRoutingCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.registerRoutingCallback" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerRoutingCallback` + +Register a callback at a specific HTTP path that decides how to route an +incoming request. + +When called, the endpoint at `path` will invoke `callback` with the parsed +request body. If `callback` returns a non-empty route string the server +responds with `{ action: "redirect", route }` so the platform can forward the +request to the right agent. If `callback` returns `null` / `undefined` the +agent's own SWML is returned instead (normal processing). + +Mirrors Python `swml_service.register_routing_callback` / +`web_mixin.register_routing_callback`. + +## Signature + +```typescript +registerRoutingCallback(callback: RoutingCallback, path: string = '/sip'): this +``` + +## Parameters + + + Function receiving the parsed request body and returning a route string to redirect, or null/undefined for normal processing. + + + + HTTP path where this callback endpoint is registered (default: '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1101. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-sip-username.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-sip-username.mdx new file mode 100644 index 0000000000..54961cb47d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-sip-username.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/register-sip-username" +title: "registerSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.registerSipUsername" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerSipUsername` + +Register a SIP username to route to this agent. + +## Signature + +```typescript +registerSipUsername(username: string): this +``` + +## Parameters + + + The SIP username to register. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1039. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-swaig-function.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-swaig-function.mdx new file mode 100644 index 0000000000..0bc159bbd7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-swaig-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/register-swaig-function" +title: "registerSwaigFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.registerSwaigFunction" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerSwaigFunction` + +Register a SwaigFunction instance or a raw function descriptor (DataMap). + +## Signature + +```typescript +registerSwaigFunction(fn: Record | SwaigFunction): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 472. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-verb-handler.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-verb-handler.mdx new file mode 100644 index 0000000000..0cb32c11cc --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/register-verb-handler.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/register-verb-handler" +title: "registerVerbHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.registerVerbHandler" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerVerbHandler` + +Register a custom verb handler. +Mirrors Python's `register_verb_handler()`. + +## Signature + +```typescript +registerVerbHandler(handler: SWMLVerbHandler): void +``` + +## Parameters + + + The verb handler to register. + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 726. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/remove-function.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/remove-function.mdx new file mode 100644 index 0000000000..caf06f9aaf --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/remove-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/remove-function" +title: "removeFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.removeFunction" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `removeFunction` + +Remove a registered SWAIG function. Returns true when removed, +false when not found. (Python parity: +`ToolRegistry.remove_function`.) + +## Signature + +```typescript +removeFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 540. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/remove-skill-by-name.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/remove-skill-by-name.mdx new file mode 100644 index 0000000000..890e3ff3d8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/remove-skill-by-name.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/remove-skill-by-name" +title: "removeSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.removeSkillByName" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkillByName` + +Remove a skill by its name (Python parity). + +Python's `remove_skill(skill_name)` removes by skill name. +The existing `removeSkill(instanceId)` removes by instance ID. +This method provides name-based removal for cross-SDK parity. + +## Signature + +```typescript +removeSkillByName(skillName: string): Promise +``` + +## Parameters + + + The skill name to remove. + + +## Returns + +`Promise` — True if a skill with that name was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1671. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/remove-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/remove-skill.mdx new file mode 100644 index 0000000000..8ef444578e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/remove-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/remove-skill" +title: "removeSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.removeSkill" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkill` + +Remove a previously added skill by its instance ID. + +## Signature + +```typescript +removeSkill(instanceId: string): Promise +``` + +## Parameters + + + The unique instance ID of the skill to remove. + + +## Returns + +`Promise` — True if the skill was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1640. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/render-document.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/render-document.mdx new file mode 100644 index 0000000000..b1122cefcd --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/render-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/render-document" +title: "renderDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.renderDocument" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `renderDocument` + +Render the SWML document as a JSON string. +Mirrors Python's `render_document()`. + +## Signature + +```typescript +renderDocument(): string +``` + +## Returns + +`string` — JSON-encoded SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 715. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/render-swml.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/render-swml.mdx new file mode 100644 index 0000000000..6874d9889f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/render-swml.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/render-swml" +title: "renderSwml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.renderSwml" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `renderSwml` + +Render the complete SWML document by assembling all 5 phases: pre-answer, answer, +post-answer, AI, and post-AI verbs. + +## Signature + +```typescript +renderSwml(callId?: string, modifications?: Record): string +``` + +## Parameters + + + Optional call ID to use for session tokens; auto-generated if omitted. + + + + Optional dict returned from `onSwmlRequest` to merge into the AI verb config before rendering. Matches Python's `_render_swml(modifications)` semantics: `global_data` is deep-merged; all other keys override the AI config directly. + + +## Returns + +`string` — The rendered SWML document as a JSON string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2000. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/reset-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/reset-contexts.mdx new file mode 100644 index 0000000000..689be62e51 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/reset-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/reset-contexts" +title: "resetContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.resetContexts" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `resetContexts` + +Remove all contexts, returning the agent to a no-contexts state. + +This is a convenience wrapper around `defineContexts().reset()`. +Use it in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```typescript +resetContexts(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 624. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/reset-document.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/reset-document.mdx new file mode 100644 index 0000000000..ec8d61c90f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/reset-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/reset-document" +title: "resetDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.resetDocument" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `resetDocument` + +Reset the SWML document to an empty state. +Mirrors Python's `reset_document()`. + +## Signature + +```typescript +resetDocument(): this +``` + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 679. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/run-serverless.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/run-serverless.mdx new file mode 100644 index 0000000000..75bd054ec6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/run-serverless.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/run-serverless" +title: "runServerless" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.runServerless" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `runServerless` + +Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + +Matches Python `run(event, context)` when executed in a serverless environment. Python's +`run()` auto-detects the platform via `get_execution_mode()` and dispatches accordingly; +in TypeScript the serverless path is an **explicit** method so that `run()` keeps its +HTTP-server semantics and callers opt in to serverless dispatch deliberately. + +Platform detection follows the same environment-variable heuristics as Python's +`ServerlessMixin`: `AWS_LAMBDA_FUNCTION_NAME` → Lambda, `K_SERVICE` → GCF, +`FUNCTIONS_WORKER_RUNTIME` → Azure, `GATEWAY_INTERFACE` → CGI. + +Usage in a Lambda handler file: + +```ts +export const handler = (event: any, context: any) => agent.runServerless(event, context); +``` + +## Signature + +```typescript +runServerless( + event: ServerlessEvent, + context?: unknown, + platform?: "lambda" | "gcf" | "azure" | "cgi" | "auto" +): Promise +``` + +## Parameters + + + The serverless event payload (Lambda event, GCF request body, etc.). + + + + The serverless context object (Lambda context, Azure context, etc.). + + + + Optional platform override; defaults to 'auto' (environment detection). + + +## Returns + +`Promise` — The normalized serverless response object. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2709. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/run.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/run.mdx new file mode 100644 index 0000000000..0375da08c7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/run.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/run" +title: "run" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.run" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `run` + +Alias for [serve](/reference/typescript/prefabs/concierge-agent/concierge-agent/serve). Starts the HTTP server. + +## Signature + +```typescript +run(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host and port overrides. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server is running. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2683. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/serve.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/serve.mdx new file mode 100644 index 0000000000..5353c50060 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/serve.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/serve" +title: "serve" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.serve" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `serve` + +Start the HTTP server and begin listening for requests. + +Uses `@hono/node-server` under the hood. When run in CLI mode +(`SWAIG_CLI_MODE=true`, set automatically by `npx swaig-test`), this is a +no-op so agent config can be inspected without starting a server. + +## Signature + +```typescript +serve(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host/port overrides. Defaults to the values provided in the constructor options or the `PORT` environment variable. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server has begun listening. + +## Examples + +```typescript +const agent = new AgentBase({ name: 'demo', port: 3000 }); +await agent.serve(); +// Or override at runtime: +await agent.serve({ port: 8080, host: '127.0.0.1' }); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2660. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..f57e1fddc6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-dynamic-config-callback.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-dynamic-config-callback" +title: "setDynamicConfigCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setDynamicConfigCallback" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setDynamicConfigCallback` + +Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + +The callback receives a clone of this agent — mutations apply only to the current +request, so you can vary prompt, tools, languages, params, or global data per call +without affecting the long-lived agent instance. + +## Signature + +```typescript +setDynamicConfigCallback(cb: DynamicConfigCallback): this +``` + +## Parameters + + + Callback receiving `(queryParams, bodyParams, headers, agent)` where `agent` is the ephemeral `AgentBase` copy to mutate. May be async. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setDynamicConfigCallback((query, body, headers, agent) => { + const lang = query.lang ?? 'en'; + if (lang === 'es') { + (agent as AgentBase).setPromptText('Eres un asistente útil.'); + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1704. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-function-includes.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-function-includes.mdx new file mode 100644 index 0000000000..52ad58daef --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-function-includes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-function-includes" +title: "setFunctionIncludes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setFunctionIncludes" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setFunctionIncludes` + +Replace the entire list of function includes. +Each include must have a `url` and `functions` array. + +## Signature + +```typescript +setFunctionIncludes(includes: FunctionInclude[]): this +``` + +## Parameters + + + Array of function include objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 978. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-global-data.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-global-data.mdx new file mode 100644 index 0000000000..5bd9a273de --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-global-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-global-data" +title: "setGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setGlobalData" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setGlobalData` + +Merge data into the global\_data object passed into the AI configuration. + +Matches Python `set_global_data` which calls `.update()` on the internal dict — +existing keys are preserved; incoming keys overwrite on collision. Skills and +other callers can each contribute keys without clobbering one another. + +If you need to replace the entire object, assign a new agent instance or use +`Object.assign(agent.globalData, {})` to clear first. + +## Signature + +```typescript +setGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 827. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-internal-fillers.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-internal-fillers.mdx new file mode 100644 index 0000000000..c928cd7eda --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-internal-fillers.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-internal-fillers" +title: "setInternalFillers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setInternalFillers" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setInternalFillers` + +Set internal fillers for native SWAIG functions. + +Internal fillers are short phrases the AI agent speaks (via TTS) while +an internal/native function is running, so the caller doesn't hear +dead air during transitions or background work. + +Supported function names (matches the SWAIGInternalFiller schema): + +hangup — when the agent is hanging up +check\_time — when checking the time +wait\_for\_user — when waiting for user input +wait\_seconds — during deliberate pauses +adjust\_response\_latency — when adjusting response timing +next\_step — transitioning between steps in prompt.contexts +change\_context — switching between contexts in prompt.contexts +get\_visual\_input — processing visual input (enable\_vision=true) +get\_ideal\_strategy — thinking (enable\_thinking=true) + +Notably NOT supported: change\_step, gather\_submit, or arbitrary +user-defined SWAIG function names. The runtime only honors fillers +for the names listed above; everything else is silently ignored at +the SWML level. This method warns at registration time if you pass +an unknown name so you catch the typo early. + +## Signature + +```typescript +setInternalFillers( + internalFillers: Record> +): this +``` + +## Parameters + + + Map of function name to language-keyed filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setInternalFillers({ + next_step: { + 'en-US': ['Moving to the next step...', 'Great, let us continue...'], + 'es': ['Pasando al siguiente paso...'] + }, + check_time: { + 'en-US': ['Let me check the time...'] + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 909. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-language-params.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-language-params.mdx new file mode 100644 index 0000000000..60e9ad44c7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-language-params.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-language-params" +title: "setLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setLanguageParams" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguageParams` + +Set (or replace) the per-language `params` dict on an already-added +language. Useful when language entries are built up via [addLanguage](/reference/typescript/prefabs/concierge-agent/concierge-agent/add-language) +first and engine-specific tuning is added later (e.g., from a config +loader). + +Python parity: `set_language_params(code, params)`. Passing an empty +object removes the `params` key entirely. Unknown codes are a no-op. + +## Signature + +```typescript +setLanguageParams(code: string, params: Record): this +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/prefabs/concierge-agent/concierge-agent/add-language) (e.g. `"en-US"`). + + + + Engine-specific params dict to attach. Empty object removes the key. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 736. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-languages.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-languages.mdx new file mode 100644 index 0000000000..de20dec89d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-languages.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-languages" +title: "setLanguages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setLanguages" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguages` + +Replace all configured languages with a new list. + +## Signature + +```typescript +setLanguages(languages: LanguageConfig[]): this +``` + +## Parameters + + + Array of language configurations. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 717. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-native-functions.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-native-functions.mdx new file mode 100644 index 0000000000..b06c645d5e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-native-functions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-native-functions" +title: "setNativeFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setNativeFunctions" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setNativeFunctions` + +Set the list of native SWAIG function names (built-in platform functions). + +## Signature + +```typescript +setNativeFunctions(funcs: string[]): this +``` + +## Parameters + + + Array of native function names. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 847. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-on-request-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-on-request-callback.mdx new file mode 100644 index 0000000000..55f62b835d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-on-request-callback.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-on-request-callback" +title: "setOnRequestCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setOnRequestCallback" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `setOnRequestCallback` + +Set a callback invoked per-request to dynamically build SWML. +When set, the static SwmlBuilder is ignored and the callback's +returned SwmlBuilder is used instead. + +## Signature + +```typescript +setOnRequestCallback(cb: OnRequestCallback): this +``` + +## Parameters + + + Callback receiving query params, body params, and headers. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 850. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-param.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-param.mdx new file mode 100644 index 0000000000..09a055cae8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-param.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-param" +title: "setParam" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setParam" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParam` + +Set a single AI parameter (e.g. "temperature", "top\_p"). + +## Signature + +```typescript +setParam(key: string, value: unknown): this +``` + +## Parameters + + + Parameter name. + + + + Parameter value. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 799. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-params.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-params.mdx new file mode 100644 index 0000000000..ca8b89d49f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-params" +title: "setParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setParams" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParams` + +Merge multiple AI parameters into the existing params object. + +## Signature + +```typescript +setParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 809. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..6c93ddbc10 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt-llm-params" +title: "setPostPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setPostPromptLlmParams" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptLlmParams` + +Merge LLM-specific parameters into the post-prompt configuration. + +## Signature + +```typescript +setPostPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1000. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt-url.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt-url.mdx new file mode 100644 index 0000000000..68e81526fd --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt-url" +title: "setPostPromptUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setPostPromptUrl" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptUrl` + +Override the default post-prompt webhook URL with a custom one. + +## Signature + +```typescript +setPostPromptUrl(url: string): this +``` + +## Parameters + + + The custom post-prompt URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1828. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt.mdx new file mode 100644 index 0000000000..c4ee24e046 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-post-prompt" +title: "setPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setPostPrompt" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPrompt` + +Set the post-prompt text evaluated after the call ends. + +## Signature + +```typescript +setPostPrompt(text: string): this +``` + +## Parameters + + + The post-prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 455. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..2028915e68 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-llm-params" +title: "setPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setPromptLlmParams" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptLlmParams` + +Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + +## Signature + +```typescript +setPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 990. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-pom.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-pom.mdx new file mode 100644 index 0000000000..6ae87ac955 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-pom.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-pom" +title: "setPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setPromptPom" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptPom` + +Set the prompt as a POM (Prompt Object Model) dictionary. + +Replaces the current POM sections with the provided structured data. +Each entry should have `title`, and optionally `body`, `bullets`, +`numbered`, `numberedBullets`, and `subsections`. + +## Signature + +```typescript +setPromptPom(pom: Record[]): this +``` + +## Parameters + + + Array of POM section dictionaries. + + +## Returns + +`this` — This agent instance for chaining. + +## Throws + +- Error if POM mode is not enabled (`usePom: false`). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 576. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-text.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-text.mdx new file mode 100644 index 0000000000..c6e6dfad81 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-text.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-prompt-text" +title: "setPromptText" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setPromptText" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptText` + +Set the main system prompt text for the AI. + +## Signature + +```typescript +setPromptText(text: string): this +``` + +## Parameters + + + The prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 445. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-pronunciations.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-pronunciations.mdx new file mode 100644 index 0000000000..a1ea83c8ff --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-pronunciations.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-pronunciations" +title: "setPronunciations" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setPronunciations" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPronunciations` + +Replace all pronunciation rules with a new list. + +## Signature + +```typescript +setPronunciations(rules: PronunciationRule[]): this +``` + +## Parameters + + + Array of pronunciation rule objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 785. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-web-hook-url.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-web-hook-url.mdx new file mode 100644 index 0000000000..887a41450d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/set-web-hook-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/set-web-hook-url" +title: "setWebHookUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setWebHookUrl" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setWebHookUrl` + +Override the default SWAIG webhook URL with a custom one. + +## Signature + +```typescript +setWebHookUrl(url: string): this +``` + +## Parameters + + + The custom webhook URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1818. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/setup-graceful-shutdown.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/setup-graceful-shutdown.mdx new file mode 100644 index 0000000000..9a23c678dc --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/setup-graceful-shutdown.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/setup-graceful-shutdown" +title: "setupGracefulShutdown" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.setupGracefulShutdown" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setupGracefulShutdown` + +Register process signal handlers for clean Kubernetes/Docker shutdown. +Handles SIGTERM and SIGINT, waits for a timeout, then exits. + +**Modifiers:** `static` + +## Signature + +```typescript +setupGracefulShutdown(opts?: { ...1 fields }): void +``` + +## Parameters + + + Optional timeout in milliseconds (default 5000). + + + + +## Returns + +`void` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2732. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/stop.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/stop.mdx new file mode 100644 index 0000000000..f78e76ab05 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.stop" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `stop` + +Stop the HTTP server. +Mirrors Python's `stop()`. + +## Signature + +```typescript +stop(): void +``` + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 1009. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..4c1b3fa254 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/swaig-pre-dispatch.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/swaig-pre-dispatch" +title: "swaigPreDispatch" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.swaigPreDispatch" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `swaigPreDispatch` + +Extension point: invoked between argument parsing and function dispatch +on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is +non-null, it's returned directly without dispatching. AgentBase may +override to add session-token validation or ephemeral dynamic-config. + +## Signature + +```typescript +swaigPreDispatch( + _requestData: Record, + _funcName: string +): [SWMLService, unknown] +``` + +## Parameters + + + + + +## Returns + +`[SWMLService, unknown]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 592. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/update-global-data.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/update-global-data.mdx new file mode 100644 index 0000000000..3cb462ad93 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/update-global-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/update-global-data" +title: "updateGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.updateGlobalData" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `updateGlobalData` + +Merge additional entries into the existing global\_data object. + +## Signature + +```typescript +updateGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 837. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/validate-basic-auth.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/validate-basic-auth.mdx new file mode 100644 index 0000000000..c9b12ea6b2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/validate-basic-auth.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/validate-basic-auth" +title: "validateBasicAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.validateBasicAuth" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateBasicAuth` + +Override to add custom basic-auth validation logic beyond credential matching. + +## Signature + +```typescript +validateBasicAuth( + _username: string, + _password: string +): boolean | Promise +``` + +## Parameters + + + The username from the request. + + + + The password from the request. + + +## Returns + +`boolean | Promise` — True if the credentials are valid; false to reject the request. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1961. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/validate-tool-token.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/validate-tool-token.mdx new file mode 100644 index 0000000000..ea7621ca33 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-agent/validate-tool-token.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-agent/validate-tool-token" +title: "validateToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeAgent.validateToolToken" + parent: "prefabs.ConciergeAgent.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateToolToken` + +Validate a tool-call token for the given function. + +Mirrors Python reference `core/mixins/state_mixin.py validate_tool_token`: + +1. Unknown function → `false`. +2. Registered but non-secure → `true` without consulting SessionManager + (non-secure tools never require a token). +3. Raw-dict descriptors (e.g. DataMap) are treated as secure, matching + Python's `isinstance(func, dict) → is_secure = True` branch. +4. Missing token on a secure tool → `false`. +5. Otherwise delegate to `SessionManager.validateToolToken`. + +Divergences from the Python reference: + +- No debug-logging branch: `AgentBase` does not expose an agent-level + debug-mode flag, so the per-call debug telemetry Python emits is + omitted. `SessionManager` still logs its own validation outcomes. +- No token-derived call-id fallback: `SessionManager.debugToken` + truncates the embedded call-id for log safety, so an extracted value + cannot be round-tripped back through `validateToolToken`. The caller + is expected to supply a non-empty `callId`; an empty one is forwarded + unchanged and the underlying validator will reject it. + +## Signature + +```typescript +validateToolToken(functionName: string, token: string, callId: string): boolean +``` + +## Parameters + + + + + + + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1447. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-config/index.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-config/index.mdx new file mode 100644 index 0000000000..89880485db --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/concierge-config/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/concierge-config" +title: "ConciergeConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.ConciergeConfig" + parent: "prefabs.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts" +--- +# `ConciergeConfig` + +Configuration for the [ConciergeAgent](/reference/typescript/prefabs/concierge-agent/concierge-agent). + +## Signature + +```typescript +interface ConciergeConfig +``` + +## Properties + + + Additional AgentBase options forwarded to `super()`. + + + + Dictionary of amenities, each mapping to a dict of detail keys/values. + + + + Optional hours of operation by category (e.g. `{ default: "9 AM - 5 PM" }`). + + + + Agent display name (defaults to `"concierge"`). + + + + HTTP route for this agent (defaults to `"/concierge"`). + + + + List of services offered by the venue (required). + + + + Optional special instructions appended to the agent's instruction bullets. + + + + Name of the venue or business (required). + + + + Optional custom welcome message spoken as a non-bargeable static greeting. + + +## Source + +[`src/prefabs/ConciergeAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/create-concierge-agent.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/create-concierge-agent.mdx new file mode 100644 index 0000000000..6b0261e0fa --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/create-concierge-agent.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent/create-concierge-agent" +title: "createConciergeAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent.createConciergeAgent" + parent: "prefabs.ConciergeAgent" + module: "prefabs.ConciergeAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts" +--- +# `createConciergeAgent` + +Factory function that creates and returns a new ConciergeAgent. + +## Signature + +```typescript +createConciergeAgent(config: ConciergeConfig): ConciergeAgent +``` + +## Parameters + + + Configuration for the concierge agent. + + +## Returns + +`ConciergeAgent` — A configured ConciergeAgent instance. + +## Source + +[`src/prefabs/ConciergeAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts) + +Line 305. diff --git a/fern/products/sdk-reference/typescript/prefabs/concierge-agent/index.mdx b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/index.mdx new file mode 100644 index 0000000000..7098e0f2b8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/concierge-agent/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/prefabs/concierge-agent" +title: "ConciergeAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "prefabs.ConciergeAgent" + module: "prefabs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts" +--- +# `ConciergeAgent` + +## Signature + +```typescript +module ConciergeAgent +``` + +## Functions + + + + Factory function that creates and returns a new ConciergeAgent. + + + +## Classes + + + + Prefab agent that acts as a virtual concierge for a venue, providing information about services, amenities, hours of operation, availability, and directions. + + + +## Interfaces + + + + Configuration for the [ConciergeAgent](/reference/typescript/prefabs/concierge-agent/concierge-agent). + + + +## Source + +[`src/prefabs/ConciergeAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ConciergeAgent.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/create-faq-bot-agent.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/create-faq-bot-agent.mdx new file mode 100644 index 0000000000..264dfc2d9d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/create-faq-bot-agent.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/create-faq-bot-agent" +title: "createFAQBotAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.createFAQBotAgent" + parent: "prefabs.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts" +--- +# `createFAQBotAgent` + +Factory function that creates and returns a new FAQBotAgent. + +## Signature + +```typescript +createFAQBotAgent(config: FAQBotConfig): FAQBotAgent +``` + +## Parameters + + + Configuration for the FAQ bot agent. + + +## Returns + +`FAQBotAgent` — A configured FAQBotAgent instance. + +## Source + +[`src/prefabs/FAQBotAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts) + +Line 411. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-answer-verb.mdx new file mode 100644 index 0000000000..b857b40fde --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-answer-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-answer-verb" +title: "addAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addAnswerVerb" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addAnswerVerb` + +Configure the answer verb (phase 2) with optional settings. + +## Signature + +```typescript +addAnswerVerb(config?: Record): this +``` + +## Parameters + + + Optional answer verb configuration. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1493. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-function-include.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-function-include.mdx new file mode 100644 index 0000000000..0431a40329 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-function-include.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-function-include" +title: "addFunctionInclude" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addFunctionInclude" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addFunctionInclude` + +Add a remote SWAIG function include reference. + +## Signature + +```typescript +addFunctionInclude( + url: string, + functions: string[], + metaData?: Record +): this +``` + +## Parameters + + + URL of the remote SWAIG endpoint. + + + + Function names available at that endpoint. + + + + Optional metadata to attach to the include. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 965. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-hint.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-hint.mdx new file mode 100644 index 0000000000..c7ee19294d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-hint.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-hint" +title: "addHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addHint" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHint` + +Add a single speech-recognition hint. + +## Signature + +```typescript +addHint(hint: string): this +``` + +## Parameters + + + Word or phrase to boost in speech recognition. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 652. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-hints.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-hints.mdx new file mode 100644 index 0000000000..25ddccafc9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-hints.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-hints" +title: "addHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addHints" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHints` + +Add multiple speech-recognition hints at once. + +## Signature + +```typescript +addHints(hints: string[]): this +``` + +## Parameters + + + Array of words or phrases to boost. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 662. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-internal-filler.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-internal-filler.mdx new file mode 100644 index 0000000000..e7c58278c9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-internal-filler.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-internal-filler" +title: "addInternalFiller" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addInternalFiller" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addInternalFiller` + +Add internal filler phrases for a single internal function and language. + +See [setInternalFillers](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-internal-fillers) for the complete list of supported +functionName values and an explanation of what fillers do. + +## Signature + +```typescript +addInternalFiller( + functionName: string, + languageCode: string, + fillers: string[] +): this +``` + +## Parameters + + + One of the supported internal function names (see SUPPORTED\_INTERNAL\_FILLER\_NAMES). Names outside the supported set log a warning and are ignored by the runtime. + + + + BCP-47 language code for the fillers (e.g. 'en-US'). + + + + Array of filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 942. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-language.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-language.mdx new file mode 100644 index 0000000000..667e231098 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-language.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-language" +title: "addLanguage" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addLanguage" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addLanguage` + +Add a supported language to the AI configuration. + +## Signature + +```typescript +addLanguage(config: LanguageConfig): this +``` + +## Parameters + + + Language configuration including name, code, voice, and optional fillers. `params` may be set to attach engine-specific tuning (voice stability, similarity boost, model knobs, etc.); only emitted into SWML when non-empty so existing entries stay byte-identical when no params are passed (Python ai\_config\_mixin.py `add_language`). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 693. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-mcp-server.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-mcp-server.mdx new file mode 100644 index 0000000000..d169320985 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-mcp-server.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-mcp-server" +title: "addMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addMcpServer" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addMcpServer` + +Add an external MCP server for tool discovery and invocation. +Tools are discovered via MCP protocol at session start and added to the AI's tool list. + +## Signature + +```typescript +addMcpServer(url: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + MCP server HTTP endpoint URL + + + + Optional configuration: headers, resources, resourceVars + + + + + + + + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1145. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pattern-hint.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pattern-hint.mdx new file mode 100644 index 0000000000..44c7381804 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pattern-hint.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pattern-hint" +title: "addPatternHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addPatternHint" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPatternHint` + +Add a pattern-based speech-recognition hint with find-and-replace behavior. + +## Signature + +```typescript +addPatternHint(opts: { ...4 fields }): this +``` + +## Parameters + + + Pattern hint configuration with a descriptive hint label, regex pattern, replacement string, and optional case-insensitive flag. + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 673. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-post-ai-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-post-ai-verb.mdx new file mode 100644 index 0000000000..d3339ee1cb --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-post-ai-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-post-ai-verb" +title: "addPostAiVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addPostAiVerb" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAiVerb` + +Add a SWML verb to execute after the AI verb (phase 5). + +## Signature + +```typescript +addPostAiVerb(verbName: string, config: Record): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1515. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-post-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-post-answer-verb.mdx new file mode 100644 index 0000000000..ca1f57f8a3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-post-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-post-answer-verb" +title: "addPostAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addPostAnswerVerb" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAnswerVerb` + +Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + +## Signature + +```typescript +addPostAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1504. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pre-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..b8ff6be869 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pre-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pre-answer-verb" +title: "addPreAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addPreAnswerVerb" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPreAnswerVerb` + +Add a SWML verb to execute before the answer phase (phase 1). + +## Signature + +```typescript +addPreAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb (e.g. "play", "record"). + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1483. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pronunciation.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pronunciation.mdx new file mode 100644 index 0000000000..a98bc64858 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pronunciation.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-pronunciation" +title: "addPronunciation" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addPronunciation" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPronunciation` + +Add a pronunciation override rule for the TTS engine. + +## Signature + +```typescript +addPronunciation(rule: PronunciationRule): this +``` + +## Parameters + + + Pronunciation rule specifying the text to replace and its substitute. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 773. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-section.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-section.mdx new file mode 100644 index 0000000000..3df12002af --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addSection" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addSection` + +Add a new named section to the SWML document. +Mirrors Python's `add_section()`. + +## Signature + +```typescript +addSection(sectionName: string): this +``` + +## Parameters + + + Name of the section to create. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 653. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-skill-by-name.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-skill-by-name.mdx new file mode 100644 index 0000000000..849963ad26 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-skill-by-name.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-skill-by-name" +title: "addSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addSkillByName" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkillByName` + +Add a skill by its registered name, looking it up in the global SkillRegistry. + +Matches Python's `add_skill(skill_name, params)` which loads skills by string +name via the SkillManager registry. Throws a `ValueError`-equivalent if the +skill name is not found in the registry. + +## Signature + +```typescript +addSkillByName(skillName: string, params?: SkillConfig): Promise +``` + +## Parameters + + + The name the skill was registered under in the SkillRegistry. + + + + Optional configuration parameters forwarded to the skill factory. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Throws + +- Error if no skill with the given name is registered. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1627. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-skill.mdx new file mode 100644 index 0000000000..f05ee5ae43 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-skill" +title: "addSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addSkill" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkill` + +Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + +## Signature + +```typescript +addSkill(skill: SkillBase): Promise +``` + +## Parameters + + + The skill instance to add. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1562. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-swaig-query-params.mdx new file mode 100644 index 0000000000..8d492d126c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-swaig-query-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-swaig-query-params" +title: "addSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addSwaigQueryParams" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSwaigQueryParams` + +Add extra query parameters appended to all SWAIG webhook URLs. + +## Signature + +```typescript +addSwaigQueryParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to append as query parameters. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1714. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-verb-to-section.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-verb-to-section.mdx new file mode 100644 index 0000000000..cacc65b98d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-verb-to-section.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-verb-to-section" +title: "addVerbToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addVerbToSection" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerbToSection` + +Add a verb to a specific named section. +Mirrors Python's `add_verb_to_section()`. + +## Signature + +```typescript +addVerbToSection(sectionName: string, verbName: string, config: unknown): this +``` + +## Parameters + + + Target section name (auto-created if missing). + + + + Verb name. + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 669. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-verb.mdx new file mode 100644 index 0000000000..52732d3054 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-verb" +title: "addVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.addVerb" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerb` + +Add a verb to the SWML document. + +## Signature + +```typescript +addVerb(name: string, config: unknown): this +``` + +## Parameters + + + Verb name (e.g., 'answer', 'play', 'hangup'). + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 642. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/as-router.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/as-router.mdx new file mode 100644 index 0000000000..926b27280b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/as-router.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/as-router" +title: "asRouter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.asRouter" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `asRouter` + +Return this agent's Hono app for mounting as a sub-router in an AgentServer. + +## Signature + +```typescript +asRouter(): Hono +``` + +## Returns + +`Hono` — The Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2637. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/auto-map-sip-usernames.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/auto-map-sip-usernames.mdx new file mode 100644 index 0000000000..e83cc2c000 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/auto-map-sip-usernames.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/auto-map-sip-usernames" +title: "autoMapSipUsernames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.autoMapSipUsernames" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `autoMapSipUsernames` + +Automatically register common SIP usernames based on this agent's +name and route. Derives cleaned variants (alphanumeric + underscore) +and registers each via `registerSipUsername()`. + +Port of Python's `auto_map_sip_usernames()`: + +- Registers a cleaned version of the agent name +- Registers a cleaned version of the route (if different from name) +- For names longer than 3 characters, also registers a vowel-stripped variant + +## Signature + +```typescript +autoMapSipUsernames(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1057. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/build-swml-for-request.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/build-swml-for-request.mdx new file mode 100644 index 0000000000..dc7a08885e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/build-swml-for-request.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/build-swml-for-request" +title: "buildSwmlForRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.buildSwmlForRequest" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `buildSwmlForRequest` + +Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` +to fully replace the document for this request, or `null` to fall +through to `setOnRequestCallback` or the static builder. + +This is distinct from the WebMixin `onRequest(requestData, +callbackPath)` hook on AgentBase (which mirrors Python's +`on_request -> on_swml_request` modification-merge contract). +Use this hook when you want to swap the entire SWML builder; use +`onRequest` / `onSwmlRequest` on AgentBase when you want to merge +targeted modifications into the rendered document. + +Default implementation returns `null` (no-op). + +## Signature + +```typescript +buildSwmlForRequest( + _queryParams: Record, + _bodyParams: Record, + _headers: Record, + _callbackPath?: string +): SwmlBuilder | null +``` + +## Parameters + + + + + + + + + +## Returns + +`SwmlBuilder | null` — A `SwmlBuilder` whose document is sent as the response, or `null` to delegate to the next handler in the chain. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 834. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..65da213189 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-post-ai-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-post-ai-verbs" +title: "clearPostAiVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.clearPostAiVerbs" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAiVerbs` + +Remove all post-AI verbs. + +## Signature + +```typescript +clearPostAiVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1542. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..36655fb7a1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-post-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-post-answer-verbs" +title: "clearPostAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.clearPostAnswerVerbs" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAnswerVerbs` + +Remove all post-answer verbs. + +## Signature + +```typescript +clearPostAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1533. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..743fbf0648 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-pre-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-pre-answer-verbs" +title: "clearPreAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.clearPreAnswerVerbs" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPreAnswerVerbs` + +Remove all pre-answer verbs. + +## Signature + +```typescript +clearPreAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1524. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..2bad135da0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-swaig-query-params.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/clear-swaig-query-params" +title: "clearSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.clearSwaigQueryParams" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearSwaigQueryParams` + +Clear all SWAIG query parameters. + +## Signature + +```typescript +clearSwaigQueryParams(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1723. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/constructor.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/constructor.mdx new file mode 100644 index 0000000000..7b7c5286ef --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.constructor" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts" +--- +# `constructor` + +Create a FAQBotAgent with the specified FAQ entries and matching threshold. + +## Signature + +```typescript +constructor(config: FAQBotConfig): FAQBotAgent +``` + +## Parameters + + + Configuration including FAQ entries, threshold, and escalation settings. + + +## Returns + +`FAQBotAgent` + +## Source + +[`src/prefabs/FAQBotAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts) + +Line 98. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/create-tool-token.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/create-tool-token.mdx new file mode 100644 index 0000000000..336bb29cd0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/create-tool-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/create-tool-token" +title: "createToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.createToolToken" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `createToolToken` + +Mint a per-call SWAIG-function token via the agent's SessionManager. + +Mirrors Python reference `core/mixins/state_mixin.py _create_tool_token`: +delegates to `SessionManager.createToolToken` and returns an empty +string on any failure (Python catches all exceptions and returns ""). + +## Signature + +```typescript +createToolToken(toolName: string, callId: string): string +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1467. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-contexts.mdx new file mode 100644 index 0000000000..eb6dce4441 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-contexts.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-contexts" +title: "defineContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.defineContexts" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineContexts` + +Define or replace the contexts configuration for the AI verb. + +## Signature + +```typescript +defineContexts( + contexts?: Record | ContextBuilder +): ContextBuilder +``` + +## Parameters + + + An existing ContextBuilder instance or a plain object; a new ContextBuilder is created if omitted. + + +## Returns + +`ContextBuilder` — The active ContextBuilder for further configuration. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 603. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-tool.mdx new file mode 100644 index 0000000000..32d6f9dc46 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-tool.mdx @@ -0,0 +1,114 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.defineTool" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTool` + +Register a SWAIG tool (function) that the AI can invoke during a call. + +## How this becomes a tool the model sees + +A SWAIG function is **exactly the same concept** as a "tool" in +native OpenAI / Anthropic tool calling. On every LLM turn, the SDK +renders each registered SWAIG function into the OpenAI tool schema: + +```json +{ +"type": "function", +"function": { +"name": "your_name_here", +"description": "your description text", +"parameters": { /* your JSON schema */ } +} +} +``` + +That schema goes to the model in the same API call that produces +the next assistant message. The model reads: + +- the **function `description`** to decide WHEN to call this tool +- each **parameter `description`** (inside the JSON schema) to + decide HOW to fill in each argument + +This means **descriptions are prompt engineering**, not developer +comments. A vague description is the #1 cause of "the model has the +right tool but doesn't call it" failures. + +### Bad vs good descriptions + +```text +BAD : description: 'Lookup function' +GOOD: description: 'Look up a customer's account details by account +number. Use this BEFORE quoting any account-specific info +(balance, plan, status). Do not use for general product +questions.' + +BAD : parameters: { id: { type: 'string', description: 'the id' } } +GOOD: parameters: { account_number: { type: 'string', description: +'The customer's 8-digit account number, no dashes or spaces. +Ask the user if they don't provide it.' } } +``` + +### Tool count matters + +LLM tool selection accuracy degrades past ~7-8 simultaneously-active +tools per call. Use Step.setFunctions() to partition tools across +steps so only the relevant subset is active at any moment. + +## Signature + +```typescript +defineTool(opts: { ...11 fields }): this +``` + +## Parameters + + + Tool definition including name, description, parameter schema, and handler callback. `description` and per-parameter `description` strings are LLM-facing prompt engineering. + + + + + Additional fields to pass through to the SWAIG function definition (Python `**swaig_fields` equivalent). + + + + + + + + + + + + + + + + + + + + External webhook URL; makes this an externally-hosted tool. + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1329. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-tools.mdx new file mode 100644 index 0000000000..c64dba9070 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-tools" +title: "defineTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.defineTools" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts" + visibility: "protected" +--- +# `defineTools` + +Register the search\_faqs and optional escalate SWAIG tools. + +## Signature + +```typescript +defineTools(): void +``` + +## Returns + +`void` + +## Source + +[`src/prefabs/FAQBotAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts) + +Line 285. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-typed-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-typed-tool.mdx new file mode 100644 index 0000000000..d4a50092e7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-typed-tool.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/define-typed-tool" +title: "defineTypedTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.defineTypedTool" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTypedTool` + +Register a SWAIG tool with a typed handler that receives named parameters +instead of the standard `(args, rawData)` convention. + +The SDK wraps the handler to unpack the args dict into positional params. +If no `parameters` schema is provided, one is inferred from the handler's +source code (parameter names and default values). + +## Signature + +```typescript +defineTypedTool(opts: { ...9 fields }): this +``` + +## Parameters + + + Tool definition with a typed handler function. + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1372. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-debug-events.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-debug-events.mdx new file mode 100644 index 0000000000..3bc31ae00b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-debug-events.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-debug-events" +title: "enableDebugEvents" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.enableDebugEvents" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugEvents` + +Enable debug event webhooks for this agent. + +## Signature + +```typescript +enableDebugEvents(level: number = 1): this +``` + +## Parameters + + + Debug verbosity level (defaults to 1). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1010. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-debug-routes.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-debug-routes.mdx new file mode 100644 index 0000000000..5931a92c14 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-debug-routes.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-debug-routes" +title: "enableDebugRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.enableDebugRoutes" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugRoutes` + +Register a callback function that determines routing based on POST data. + +When a routing callback is registered, an endpoint at the specified path +is created in `getApp()`. The callback receives the request body and returns +Enable debug routes for testing and development. + +This is a backward-compatibility stub matching the Python SDK. +In the TypeScript SDK, debug routes (health, ready, debug\_events) +are automatically registered in `getApp()`. + +## Signature + +```typescript +enableDebugRoutes(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1754. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-mcp-server.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-mcp-server.mdx new file mode 100644 index 0000000000..6fc4d6f076 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-mcp-server.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-mcp-server" +title: "enableMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.enableMcpServer" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableMcpServer` + +Expose this agent's tools as an MCP server endpoint at /mcp. +Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + +## Signature + +```typescript +enableMcpServer(): this +``` + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1159. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-sip-routing.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-sip-routing.mdx new file mode 100644 index 0000000000..98dfc55e39 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-sip-routing.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/enable-sip-routing" +title: "enableSipRouting" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.enableSipRouting" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableSipRouting` + +Enable SIP routing for this agent. + +## Signature + +```typescript +enableSipRouting(autoMap: boolean = true, path: string = '/sip'): this +``` + +## Parameters + + + When true, automatically map SIP usernames to the agent route (defaults to true). + + + + HTTP path for the SIP routing endpoint (defaults to '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1024. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/extract-sip-username.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/extract-sip-username.mdx new file mode 100644 index 0000000000..3e69ee08ec --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/extract-sip-username.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/extract-sip-username" +title: "extractSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.extractSipUsername" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `extractSipUsername` + +Extract the SIP username from a request body's call.to field. + +**Modifiers:** `static` + +## Signature + +```typescript +extractSipUsername(requestBody: Record): string | null +``` + +## Parameters + + + The parsed request body containing call information. + + +## Returns + +`string | null` — The extracted SIP username, or null if not found. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1121. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-all-functions.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-all-functions.mdx new file mode 100644 index 0000000000..2415c8b2ca --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-all-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-all-functions" +title: "getAllFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getAllFunctions" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getAllFunctions` + +Snapshot of all registered SWAIG functions keyed by name. +(Python parity: `ToolRegistry.get_all_functions`.) + +## Signature + +```typescript +getAllFunctions(): Record> +``` + +## Returns + +`Record>` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 529. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-app.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-app.mdx new file mode 100644 index 0000000000..49ebb2a28c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-app.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-app" +title: "getApp" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getApp" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getApp` + +Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + +## Signature + +```typescript +getApp(): Hono +``` + +## Returns + +`Hono` — The configured Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2250. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..3f44b7fb21 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-basic-auth-credentials.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-basic-auth-credentials" +title: "getBasicAuthCredentials" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getBasicAuthCredentials" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getBasicAuthCredentials` + +Get the basic-auth credentials used by this agent. + +## Signature + + + + ```typescript + getBasicAuthCredentials(includeSource?: false): [string, string] + ``` + + + + ```typescript + getBasicAuthCredentials( + includeSource: true + ): [string, string, "provided" | "environment" | "generated"] + ``` + + + +## Parameters (Overload 1) + + + When true, a third element indicating the credential source is appended. + + +## Parameters (Overload 2) + + + When true, a third element indicating the credential source is appended. + + +## Returns (Overload 1) + +`[string, string]` — A tuple of \[username, password] or \[username, password, source]. + +## Returns (Overload 2) + +`[string, string, "provided" | "environment" | "generated"]` — A tuple of \[username, password] or \[username, password, source]. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2775. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-builder.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-builder.mdx new file mode 100644 index 0000000000..3dc1c16f65 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-builder.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-builder" +title: "getBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getBuilder" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getBuilder` + +Get the underlying SwmlBuilder for direct manipulation. + +## Signature + +```typescript +getBuilder(): SwmlBuilder +``` + +## Returns + +`SwmlBuilder` — The SwmlBuilder instance. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 632. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-contexts.mdx new file mode 100644 index 0000000000..1520bc8d4b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-contexts" +title: "getContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getContexts" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getContexts` + +Get the contexts dictionary as serialised SWML, or null when no +contexts have been defined yet. + +Matches Python `PromptManager.get_contexts()` which returns the +contexts dict or `None`. + +## Signature + +```typescript +getContexts(): Record | null +``` + +## Returns + +`Record | null` — Contexts dict, or null when no contexts are defined. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 640. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-document.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-document.mdx new file mode 100644 index 0000000000..44068e2ec7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-document" +title: "getDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getDocument" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getDocument` + +Get the SWML document as a dictionary. +Alias for `renderSwml()` that matches Python's `get_document()` name. + +## Signature + +```typescript +getDocument(): Record +``` + +## Returns + +`Record` — The SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 706. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-full-url.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-full-url.mdx new file mode 100644 index 0000000000..4fb5ef49f6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-full-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-full-url" +title: "getFullUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getFullUrl" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getFullUrl` + +Get the full external URL of this agent, using the proxy base URL if available. + +## Signature + +```typescript +getFullUrl(includeAuth: boolean = false): string +``` + +## Parameters + + + Whether to embed basic-auth credentials in the URL (defaults to false). + + +## Returns + +`string` — The fully-qualified URL string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1838. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-function.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-function.mdx new file mode 100644 index 0000000000..b50e8aaca0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-function" +title: "getFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getFunction" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getFunction` + +Get a registered SWAIG function entry, or undefined. +(Python parity: `ToolRegistry.get_function`.) + +## Signature + +```typescript +getFunction(name: string): Record | SwaigFunction | undefined +``` + +## Parameters + + + +## Returns + +`Record | SwaigFunction | undefined` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 523. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-language-params.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-language-params.mdx new file mode 100644 index 0000000000..50477be0aa --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-language-params.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-language-params" +title: "getLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getLanguageParams" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getLanguageParams` + +Read the per-language `params` dict for a previously-added language. + +Python parity: `get_language_params(code)`. Returns `undefined` if the +code is unknown or the language has no params set — no exception path. + +## Signature + +```typescript +getLanguageParams(code: string): Record | undefined +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-language). + + +## Returns + +`Record | undefined` — The params dict if set, `undefined` otherwise (including when the code is unknown). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 759. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-mcp-servers.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-mcp-servers.mdx new file mode 100644 index 0000000000..1ffd89c7ba --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-mcp-servers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-mcp-servers" +title: "getMcpServers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getMcpServers" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getMcpServers` + +Get configured MCP servers (read-only copy). + +## Signature + +```typescript +getMcpServers(): Record[] +``` + +## Returns + +`Record[]` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1170. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-name.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-name.mdx new file mode 100644 index 0000000000..c668cbfba1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-name" +title: "getName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getName" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getName` + +Get the agent's display name. + +## Signature + +```typescript +getName(): string +``` + +## Returns + +`string` — The agent name string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1551. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-post-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-post-prompt.mdx new file mode 100644 index 0000000000..9dd1c50180 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-post-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-post-prompt" +title: "getPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getPostPrompt" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPostPrompt` + +Get the post-prompt text, if one has been set. + +## Signature + +```typescript +getPostPrompt(): string | null +``` + +## Returns + +`string | null` — The post-prompt string, or null if not configured. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 547. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-prompt-pom.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-prompt-pom.mdx new file mode 100644 index 0000000000..a53bd6ee34 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-prompt-pom.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-prompt-pom" +title: "getPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getPromptPom" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPromptPom` + +Get the raw POM (Prompt Object Model) structure as an array of section data objects, +when the agent is in POM mode and has at least one section. + +Matches Python `get_prompt()` which returns `Union[str, List[Dict]]` — a raw list when +in POM mode (via `pom.to_list()` / `pom.render_dict()`), or a string otherwise. +The TS `getPrompt()` always returns a string (rendered Markdown), so this companion +method exposes the raw POM structure for callers that need it for serialisation or +inspection (e.g. skills that inspect prompt sections). + +## Signature + +```typescript +getPromptPom(): Record[] | null +``` + +## Returns + +`Record[] | null` — An array of POM section data objects, or null if not in POM mode or POM is empty. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 535. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-prompt.mdx new file mode 100644 index 0000000000..d0564c7fb8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-prompt" +title: "getPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getPrompt" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPrompt` + +Get the fully rendered main prompt text. + +## Signature + +```typescript +getPrompt(): string +``` + +## Returns + +`string` — The assembled prompt string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 519. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-raw-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-raw-prompt.mdx new file mode 100644 index 0000000000..5f2f17755c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-raw-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-raw-prompt" +title: "getRawPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getRawPrompt" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getRawPrompt` + +Get the raw prompt text whatever `setPromptText` stored, or null when +no raw prompt has been set. + +Matches Python `PromptManager.get_raw_prompt()` which returns the raw +stored string or `None`. Use this instead of `getPrompt()` when you +need the unrendered text rather than the POM-rendered Markdown. + +## Signature + +```typescript +getRawPrompt(): string | null +``` + +## Returns + +`string | null` — The raw prompt string, or null if not set. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 561. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-registered-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-registered-tools.mdx new file mode 100644 index 0000000000..29c26d5805 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-registered-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-registered-tools" +title: "getRegisteredTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getRegisteredTools" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getRegisteredTools` + +Get a summary of all registered tools with their names, descriptions, and +parameter schemas. Lifted from AgentBase so the swaig-test CLI can list +tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG +host). + +## Signature + +```typescript +getRegisteredTools(): { description: string; name: string; parameters: Record }[] +``` + +## Returns + +`{ description: string; name: string; parameters: Record }[]` — Array of tool descriptors. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-tool.mdx new file mode 100644 index 0000000000..1d26af9dbd --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-tool.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-tool" +title: "getTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getTool" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getTool` + +Look up a registered SwaigFunction by name. Lifted from AgentBase so +`swaig-test --exec ` works against a non-AgentBase SWMLService +target. + +## Signature + +```typescript +getTool(name: string): SwaigFunction | undefined +``` + +## Parameters + + + The tool name to search for. + + +## Returns + +`SwaigFunction | undefined` — The SwaigFunction instance, or undefined if not found or not a SwaigFunction. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 581. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-tools.mdx new file mode 100644 index 0000000000..a4f3a51fe9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.getTools" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getTools` + +Public access to the list of registered tools. + +In Python, `define_tools()` is public and returns `List[SWAIGFunction]`. +In TypeScript, `defineTools()` is a protected setup hook (void). This +method provides the equivalent public "get all tools" capability. + +## Signature + +```typescript +getTools(): SwaigFunction[] +``` + +## Returns + +`SwaigFunction[]` — Array of all registered SwaigFunction instances. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 370. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/handle-mcp-request.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/handle-mcp-request.mdx new file mode 100644 index 0000000000..0e07bdd03d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/handle-mcp-request.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/handle-mcp-request" +title: "handleMcpRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.handleMcpRequest" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `handleMcpRequest` + +Handle an MCP JSON-RPC 2.0 request. Returns the response object. + +## Signature + +```typescript +handleMcpRequest( + body: Record +): Promise> +``` + +## Parameters + + + +## Returns + +`Promise>` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1203. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-function.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-function.mdx new file mode 100644 index 0000000000..d1d2e785c8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-function" +title: "hasFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.hasFunction" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasFunction` + +Whether a SWAIG function with the given name is registered. +(Python parity: `ToolRegistry.has_function`.) + +## Signature + +```typescript +hasFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 517. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-skill.mdx new file mode 100644 index 0000000000..6681a07a23 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-skill" +title: "hasSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.hasSkill" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `hasSkill` + +Check whether a skill with the given name is registered. + +## Signature + +```typescript +hasSkill(skillName: string): boolean +``` + +## Parameters + + + The skill name to check. + + +## Returns + +`boolean` — True if a skill with that name exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1657. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-tool.mdx new file mode 100644 index 0000000000..e971d476a5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-tool.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/has-tool" +title: "hasTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.hasTool" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasTool` + +Whether a tool with the given name is registered. + +## Signature + +```typescript +hasTool(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/index.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/index.mdx new file mode 100644 index 0000000000..1c77ac12c1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/index.mdx @@ -0,0 +1,609 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent" +title: "FAQBotAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent" + parent: "prefabs.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts" +--- +# `FAQBotAgent` + +Prefab agent that answers frequently asked questions using keyword matching with optional escalation to a live agent. + +Pass an array of `{ question, answer, keywords }` entries and the agent will +fuzzy-match inbound utterances against them. If no match crosses the confidence +threshold, the call can optionally escalate to a configured phone number. + +## Signature + +```typescript +class FAQBotAgent extends AgentBase +``` + +## Inheritance + +**Extends:** [AgentBase](/reference/typescript/agent-base) + +## Examples + +```typescript +import { FAQBotAgent } from '@signalwire/sdk'; + +const agent = new FAQBotAgent({ + faqs: [ + { + question: 'What are your business hours?', + answer: "We're open 9 AM to 5 PM Pacific, Monday through Friday.", + keywords: ['hours', 'open', 'closed', 'time'], + }, + { + question: 'Where are you located?', + answer: 'Our headquarters are in San Francisco, California.', + keywords: ['location', 'address', 'office'], + }, + ], + escalationNumber: '+15551234567', +}); + +await agent.serve({ port: 3000 }); +``` + +## Properties + + + Unique identifier for this agent instance. + + + + + + + + Domain name for SSL. Mirrors Python's `self.domain`. + + + + The configured FAQ entries. + + + + Check if full JSON Schema validation is enabled. Mirrors Python's `@property full_validation_enabled`. + + + + Host the server binds to. + + + + Structured logger instance for this agent. Override the inherited SWMLService logger with an AgentBase-tagged one. + + + + Service display name. + + + + Public accessor for the native functions list. Python exposes `self.native_functions` as a public read/write attribute. + + + + + + The personality description used in the prompt. + + + + Public accessor for the agent's POM as a `PromptObjectModel` instance. Python parity: `agent.pom` instance attribute (agent\_base.py line 209) is a `signalwire.pom.pom.PromptObjectModel` when `use_pom=True`, or `None` otherwise. This getter returns the equivalent TypeScript `PromptObjectModel` instance — callers can use `addSection`, `findSection`, `renderMarkdown`, `renderXml`, `toJson`, `toYaml` exactly as in Python. The instance returned is a fresh snapshot built from the current `PomBuilder` state, so mutating it does not feed back into the agent's internal builder. To mutate the agent's prompt, use `promptAddSection` / `promptAddToSection` / `promptAddSubsection`. + + + + Port the server binds to. + + + + Static prompt sections: subclasses can define these declaratively. Each entry is applied via promptAddSection() in the constructor. + + + + Public accessor for the PromptManager (POM). Python exposes `self.pom` as a public attribute. This getter provides equivalent access for direct POM manipulation. + + + + HTTP route path. + + + + Schema validation utilities. Mirrors Python's `self.schema_utils`. + + + + Unified security configuration. Mirrors Python's `self.security`. + + + + Public read-only accessor for the SkillManager. Python exposes `self.skill_manager` as a public attribute. This getter provides equivalent read access. + + + + Path to SSL certificate. Mirrors Python's `self.ssl_cert_path`. + + + + Whether SSL is enabled. Mirrors Python's `self.ssl_enabled`. + + + + Path to SSL private key. Mirrors Python's `self.ssl_key_path`. + + + + Whether runner-up FAQ suggestions are appended to matches. + + + + The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — addInternalFiller / setInternalFillers warn if you pass an unknown name. + + + + + + + + Custom verb handler registry. Mirrors Python's `self.verb_registry`. + + +## Methods + + + + Configure the answer verb (phase 2) with optional settings. + + + + Add a remote SWAIG function include reference. + + + + Add a single speech-recognition hint. + + + + Add multiple speech-recognition hints at once. + + + + Add internal filler phrases for a single internal function and language. + + + + Add a supported language to the AI configuration. + + + + Add an external MCP server for tool discovery and invocation. Tools are discovered via MCP protocol at session start and added to the AI's tool list. + + + + Add a pattern-based speech-recognition hint with find-and-replace behavior. + + + + Add a SWML verb to execute after the AI verb (phase 5). + + + + Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + + + + Add a SWML verb to execute before the answer phase (phase 1). + + + + Add a pronunciation override rule for the TTS engine. + + + + Add a new named section to the SWML document. Mirrors Python's `add_section()`. + + + + Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + + + + Add a skill by its registered name, looking it up in the global SkillRegistry. + + + + Add extra query parameters appended to all SWAIG webhook URLs. + + + + Add a verb to the SWML document. + + + + Add a verb to a specific named section. Mirrors Python's `add_verb_to_section()`. + + + + Return this agent's Hono app for mounting as a sub-router in an AgentServer. + + + + Automatically register common SIP usernames based on this agent's name and route. Derives cleaned variants (alphanumeric + underscore) and registers each via `registerSipUsername()`. + + + + Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` to fully replace the document for this request, or `null` to fall through to `setOnRequestCallback` or the static builder. + + + + Remove all post-AI verbs. + + + + Remove all post-answer verbs. + + + + Remove all pre-answer verbs. + + + + Clear all SWAIG query parameters. + + + + Create a FAQBotAgent with the specified FAQ entries and matching threshold. + + + + Mint a per-call SWAIG-function token via the agent's SessionManager. + + + + Define or replace the contexts configuration for the AI verb. + + + + Register a SWAIG tool (function) that the AI can invoke during a call. + + + + Register the search\_faqs and optional escalate SWAIG tools. + + + + Register a SWAIG tool with a typed handler that receives named parameters instead of the standard `(args, rawData)` convention. + + + + Enable debug event webhooks for this agent. + + + + Register a callback function that determines routing based on POST data. + + + + Expose this agent's tools as an MCP server endpoint at /mcp. Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + + + + Enable SIP routing for this agent. + + + + Extract the SIP username from a request body's call.to field. + + + + Snapshot of all registered SWAIG functions keyed by name. (Python parity: `ToolRegistry.get_all_functions`.) + + + + Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + + + + Get the basic-auth credentials used by this agent. + + + + Get the underlying SwmlBuilder for direct manipulation. + + + + Get the contexts dictionary as serialised SWML, or null when no contexts have been defined yet. + + + + Get the SWML document as a dictionary. Alias for `renderSwml()` that matches Python's `get_document()` name. + + + + Get the full external URL of this agent, using the proxy base URL if available. + + + + Get a registered SWAIG function entry, or undefined. (Python parity: `ToolRegistry.get_function`.) + + + + Read the per-language `params` dict for a previously-added language. + + + + Get configured MCP servers (read-only copy). + + + + Get the agent's display name. + + + + Get the post-prompt text, if one has been set. + + + + Get the fully rendered main prompt text. + + + + Get the raw POM (Prompt Object Model) structure as an array of section data objects, when the agent is in POM mode and has at least one section. + + + + Get the raw prompt text whatever `setPromptText` stored, or null when no raw prompt has been set. + + + + Get a summary of all registered tools with their names, descriptions, and parameter schemas. Lifted from AgentBase so the swaig-test CLI can list tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG host). + + + + Look up a registered SwaigFunction by name. Lifted from AgentBase so `swaig-test --exec ` works against a non-AgentBase SWMLService target. + + + + Public access to the list of registered tools. + + + + Handle an MCP JSON-RPC 2.0 request. Returns the response object. + + + + Whether a SWAIG function with the given name is registered. (Python parity: `ToolRegistry.has_function`.) + + + + Check whether a skill with the given name is registered. + + + + Whether a tool with the given name is registered. + + + + Check if MCP server endpoint is enabled. + + + + List all registered skills with their names, instance IDs, and initialization status. + + + + List registered tool names in insertion order (Map preserves it). + + + + Manually set the proxy base URL used for webhook URL generation. + + + + Lifecycle hook called when a debug event webhook is received. Override in subclasses. + + + + Hook called before each SWAIG function execution. Override in subclasses. + + + + Lifecycle hook called when SWML is requested. Default delegates to [onSwmlRequest](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-swml-request) and returns its result. Subclasses typically override `onSwmlRequest` rather than this method. + + + + Process the interaction summary returned at the end of a call. Logs structured summaries as JSON. Subclasses may override to persist or process. + + + + Lifecycle hook called on every SWML request before rendering. Override in subclasses. + + + + Add a new section to the prompt with optional body, bullets, and subsections. + + + + Add a subsection under an existing prompt section. + + + + Append content to an existing prompt section. + + + + Check whether a prompt section with the given title exists. + + + + Extension point: register additional Hono routes after SWMLService mounts /health, /ready, /swaig, and the main route. AgentBase uses this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + + + + Register a callback at a specific HTTP path that decides how to route an incoming request. + + + + Register a SIP username to route to this agent. + + + + Register a SwaigFunction instance or a raw function descriptor (DataMap). + + + + Register a custom verb handler. Mirrors Python's `register_verb_handler()`. + + + + Remove a registered SWAIG function. Returns true when removed, false when not found. (Python parity: `ToolRegistry.remove_function`.) + + + + Remove a previously added skill by its instance ID. + + + + Remove a skill by its name (Python parity). + + + + Render the SWML document as a JSON string. Mirrors Python's `render_document()`. + + + + Render the complete SWML document by assembling all 5 phases: pre-answer, answer, post-answer, AI, and post-AI verbs. + + + + Remove all contexts, returning the agent to a no-contexts state. + + + + Reset the SWML document to an empty state. Mirrors Python's `reset_document()`. + + + + Alias for [serve](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/serve). Starts the HTTP server. + + + + Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + + + + Start the HTTP server and begin listening for requests. + + + + Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + + + + Replace the entire list of function includes. Each include must have a `url` and `functions` array. + + + + Merge data into the global\_data object passed into the AI configuration. + + + + Set internal fillers for native SWAIG functions. + + + + Set (or replace) the per-language `params` dict on an already-added language. Useful when language entries are built up via [addLanguage](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-language) first and engine-specific tuning is added later (e.g., from a config loader). + + + + Replace all configured languages with a new list. + + + + Set the list of native SWAIG function names (built-in platform functions). + + + + Set a callback invoked per-request to dynamically build SWML. When set, the static SwmlBuilder is ignored and the callback's returned SwmlBuilder is used instead. + + + + Set a single AI parameter (e.g. "temperature", "top\_p"). + + + + Merge multiple AI parameters into the existing params object. + + + + Set the post-prompt text evaluated after the call ends. + + + + Merge LLM-specific parameters into the post-prompt configuration. + + + + Override the default post-prompt webhook URL with a custom one. + + + + Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + + + + Set the prompt as a POM (Prompt Object Model) dictionary. + + + + Set the main system prompt text for the AI. + + + + Replace all pronunciation rules with a new list. + + + + Register process signal handlers for clean Kubernetes/Docker shutdown. Handles SIGTERM and SIGINT, waits for a timeout, then exits. + + + + Override the default SWAIG webhook URL with a custom one. + + + + Stop the HTTP server. Mirrors Python's `stop()`. + + + + Extension point: invoked between argument parsing and function dispatch on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is non-null, it's returned directly without dispatching. AgentBase may override to add session-token validation or ephemeral dynamic-config. + + + + Merge additional entries into the existing global\_data object. + + + + Override to add custom basic-auth validation logic beyond credential matching. + + + + Validate a tool-call token for the given function. + + + +## Source + +[`src/prefabs/FAQBotAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts) + +Line 83. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/is-mcp-server-enabled.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/is-mcp-server-enabled.mdx new file mode 100644 index 0000000000..ff9f074eb6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/is-mcp-server-enabled.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/is-mcp-server-enabled" +title: "isMcpServerEnabled" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.isMcpServerEnabled" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `isMcpServerEnabled` + +Check if MCP server endpoint is enabled. + +## Signature + +```typescript +isMcpServerEnabled(): boolean +``` + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1165. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/list-skills.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/list-skills.mdx new file mode 100644 index 0000000000..66bbf8ac65 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/list-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/list-skills" +title: "listSkills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.listSkills" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `listSkills` + +List all registered skills with their names, instance IDs, and initialization status. + +## Signature + +```typescript +listSkills(): { initialized: boolean; instanceId: string; name: string }[] +``` + +## Returns + +`{ initialized: boolean; instanceId: string; name: string }[]` — Array of skill descriptors. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1648. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/list-tool-names.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/list-tool-names.mdx new file mode 100644 index 0000000000..10efa72075 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/list-tool-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/list-tool-names" +title: "listToolNames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.listToolNames" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `listToolNames` + +List registered tool names in insertion order (Map preserves it). + +## Signature + +```typescript +listToolNames(): string[] +``` + +## Returns + +`string[]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 545. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/manual-set-proxy-url.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..b03c5928ef --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/manual-set-proxy-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/manual-set-proxy-url" +title: "manualSetProxyUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.manualSetProxyUrl" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `manualSetProxyUrl` + +Manually set the proxy base URL used for webhook URL generation. + +## Signature + +```typescript +manualSetProxyUrl(url: string): this +``` + +## Parameters + + + The external-facing base URL (trailing slashes are stripped). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1735. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-debug-event.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-debug-event.mdx new file mode 100644 index 0000000000..f7f5fbf4a1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-debug-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-debug-event" +title: "onDebugEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.onDebugEvent" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onDebugEvent` + +Lifecycle hook called when a debug event webhook is received. Override in subclasses. + +## Signature + +```typescript +onDebugEvent(_event: Record): void | Promise +``` + +## Parameters + + + The debug event payload. + + +## Returns + +`void | Promise` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1951. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-function-call.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-function-call.mdx new file mode 100644 index 0000000000..6aacedd4dd --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-function-call.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-function-call" +title: "onFunctionCall" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.onFunctionCall" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onFunctionCall` + +Hook called before each SWAIG function execution. Override in subclasses. + +**Behavioral note:** In the Python SDK, `on_function_call` IS the dispatcher +— it retrieves and executes the function, returning the result. In TypeScript, +`fn.execute()` is called separately after this hook. However, if this method +returns a non-void value, it is used as the result and the default execution +is skipped, enabling dispatch interception parity with Python. + +## Signature + +```typescript +onFunctionCall( + _name: string, + _args: Record, + _rawData: Record +): void | Record | Promise> +``` + +## Parameters + + + Name of the function about to execute. + + + + Parsed arguments for the function. + + + + The full raw SWAIG request payload. + + +## Returns + +`void | Record | Promise>` — Optionally a result dict to short-circuit default execution, or void/undefined to proceed normally. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1980. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-request.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-request.mdx new file mode 100644 index 0000000000..bc0a5f9d95 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-request.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-request" +title: "onRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.onRequest" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onRequest` + +Lifecycle hook called when SWML is requested. Default delegates to +[onSwmlRequest](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-swml-request) and returns its result. Subclasses typically +override `onSwmlRequest` rather than this method. + +Matches Python `WebMixin.on_request(request_data, callback_path)`. The +cross-language API is the two-arg form; the Hono `context` argument is +a TypeScript-side extra preserved for callers that already have it but +is not part of the audited surface. + +## Signature + +```typescript +onRequest( + requestData?: Record | null, + callbackPath?: string | null +): void | Record | Promise> +``` + +## Parameters + + + The parsed request body. + + + + Optional callback path from the request. + + +## Returns + +`void | Record | Promise>` — Optionally a dict of SWML modifications, or undefined for default rendering. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1916. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-summary.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-summary.mdx new file mode 100644 index 0000000000..ed1351edc9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-summary.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-summary" +title: "onSummary" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.onSummary" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts" +--- +# `onSummary` + +Process the interaction summary returned at the end of a call. +Logs structured summaries as JSON. Subclasses may override to persist or process. + +## Signature + +```typescript +onSummary( + summary: Record | null, + _rawData: Record +): void | Promise +``` + +## Parameters + + + + + +## Returns + +`void | Promise` + +## Source + +[`src/prefabs/FAQBotAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts) + +Line 376. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-swml-request.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-swml-request.mdx new file mode 100644 index 0000000000..6e89c900e0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-swml-request.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/on-swml-request" +title: "onSwmlRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.onSwmlRequest" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onSwmlRequest` + +Lifecycle hook called on every SWML request before rendering. Override in subclasses. + +May optionally return a modification dict that will be merged into the +rendered SWML document (matching Python's `Optional[dict]` return type). + +Matches Python `on_swml_request(request_data, callback_path, request)` — the third +parameter is the FastAPI `Request` in Python; here it is the raw Hono context object +so that subclasses can access query parameters (`context.req.query()`), raw request +headers (`context.req.raw.headers`), etc. + +## Signature + +```typescript +onSwmlRequest( + _rawData: Record, + _callbackPath?: string, + _context?: any +): void | Record | Promise> +``` + +## Parameters + + + The parsed request body. + + + + Optional callback path from the request. + + + + The raw Hono context object (c), providing access to headers and query params. + + +## Returns + +`void | Record | Promise>` — Optionally a dict of SWML modifications, or void. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1939. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-section.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-section.mdx new file mode 100644 index 0000000000..78b74ddc2c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-section.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-section" +title: "promptAddSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.promptAddSection" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSection` + +Add a new section to the prompt with optional body, bullets, and subsections. + +## Signature + +```typescript +promptAddSection(title: string, opts?: { ...5 fields }): this +``` + +## Parameters + + + Section heading. + + + + Optional section content including body text, bullet points, and subsections. + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 466. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-subsection.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-subsection.mdx new file mode 100644 index 0000000000..62f0607d39 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-subsection.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-subsection" +title: "promptAddSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.promptAddSubsection" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSubsection` + +Add a subsection under an existing prompt section. + +## Signature + +```typescript +promptAddSubsection( + parentTitle: string, + title: string, + opts?: { ...2 fields } +): this +``` + +## Parameters + + + Title of the parent section. + + + + Title of the new subsection. + + + + Optional body text and bullet points for the subsection. + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 501. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-to-section.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-to-section.mdx new file mode 100644 index 0000000000..d496210d10 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-to-section.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-add-to-section" +title: "promptAddToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.promptAddToSection" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddToSection` + +Append content to an existing prompt section. + +## Signature + +```typescript +promptAddToSection(title: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + Title of the section to append to. + + + + Content to add: body text, a single bullet, or multiple bullets. + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-has-section.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-has-section.mdx new file mode 100644 index 0000000000..2af4982a58 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-has-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/prompt-has-section" +title: "promptHasSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.promptHasSection" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptHasSection` + +Check whether a prompt section with the given title exists. + +## Signature + +```typescript +promptHasSection(title: string): boolean +``` + +## Parameters + + + Section title to look for. + + +## Returns + +`boolean` — True if the section exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-additional-routes.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-additional-routes.mdx new file mode 100644 index 0000000000..84d94da42d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-additional-routes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-additional-routes" +title: "registerAdditionalRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.registerAdditionalRoutes" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `registerAdditionalRoutes` + +Extension point: register additional Hono routes after SWMLService +mounts /health, /ready, /swaig, and the main route. AgentBase uses +this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + +## Signature + +```typescript +registerAdditionalRoutes(_app: Hono): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 604. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-routing-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-routing-callback.mdx new file mode 100644 index 0000000000..bcdf6167c5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-routing-callback.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-routing-callback" +title: "registerRoutingCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.registerRoutingCallback" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerRoutingCallback` + +Register a callback at a specific HTTP path that decides how to route an +incoming request. + +When called, the endpoint at `path` will invoke `callback` with the parsed +request body. If `callback` returns a non-empty route string the server +responds with `{ action: "redirect", route }` so the platform can forward the +request to the right agent. If `callback` returns `null` / `undefined` the +agent's own SWML is returned instead (normal processing). + +Mirrors Python `swml_service.register_routing_callback` / +`web_mixin.register_routing_callback`. + +## Signature + +```typescript +registerRoutingCallback(callback: RoutingCallback, path: string = '/sip'): this +``` + +## Parameters + + + Function receiving the parsed request body and returning a route string to redirect, or null/undefined for normal processing. + + + + HTTP path where this callback endpoint is registered (default: '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1101. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-sip-username.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-sip-username.mdx new file mode 100644 index 0000000000..9e98e2c87a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-sip-username.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-sip-username" +title: "registerSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.registerSipUsername" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerSipUsername` + +Register a SIP username to route to this agent. + +## Signature + +```typescript +registerSipUsername(username: string): this +``` + +## Parameters + + + The SIP username to register. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1039. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-swaig-function.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-swaig-function.mdx new file mode 100644 index 0000000000..9d4827b577 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-swaig-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-swaig-function" +title: "registerSwaigFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.registerSwaigFunction" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerSwaigFunction` + +Register a SwaigFunction instance or a raw function descriptor (DataMap). + +## Signature + +```typescript +registerSwaigFunction(fn: Record | SwaigFunction): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 472. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-verb-handler.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-verb-handler.mdx new file mode 100644 index 0000000000..ef3fcc9887 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-verb-handler.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/register-verb-handler" +title: "registerVerbHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.registerVerbHandler" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerVerbHandler` + +Register a custom verb handler. +Mirrors Python's `register_verb_handler()`. + +## Signature + +```typescript +registerVerbHandler(handler: SWMLVerbHandler): void +``` + +## Parameters + + + The verb handler to register. + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 726. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-function.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-function.mdx new file mode 100644 index 0000000000..d87176f74a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-function" +title: "removeFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.removeFunction" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `removeFunction` + +Remove a registered SWAIG function. Returns true when removed, +false when not found. (Python parity: +`ToolRegistry.remove_function`.) + +## Signature + +```typescript +removeFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 540. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-skill-by-name.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-skill-by-name.mdx new file mode 100644 index 0000000000..52d90bc4f4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-skill-by-name.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-skill-by-name" +title: "removeSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.removeSkillByName" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkillByName` + +Remove a skill by its name (Python parity). + +Python's `remove_skill(skill_name)` removes by skill name. +The existing `removeSkill(instanceId)` removes by instance ID. +This method provides name-based removal for cross-SDK parity. + +## Signature + +```typescript +removeSkillByName(skillName: string): Promise +``` + +## Parameters + + + The skill name to remove. + + +## Returns + +`Promise` — True if a skill with that name was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1671. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-skill.mdx new file mode 100644 index 0000000000..8042aa5e97 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/remove-skill" +title: "removeSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.removeSkill" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkill` + +Remove a previously added skill by its instance ID. + +## Signature + +```typescript +removeSkill(instanceId: string): Promise +``` + +## Parameters + + + The unique instance ID of the skill to remove. + + +## Returns + +`Promise` — True if the skill was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1640. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/render-document.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/render-document.mdx new file mode 100644 index 0000000000..92a2646366 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/render-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/render-document" +title: "renderDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.renderDocument" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `renderDocument` + +Render the SWML document as a JSON string. +Mirrors Python's `render_document()`. + +## Signature + +```typescript +renderDocument(): string +``` + +## Returns + +`string` — JSON-encoded SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 715. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/render-swml.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/render-swml.mdx new file mode 100644 index 0000000000..b0733a589e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/render-swml.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/render-swml" +title: "renderSwml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.renderSwml" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `renderSwml` + +Render the complete SWML document by assembling all 5 phases: pre-answer, answer, +post-answer, AI, and post-AI verbs. + +## Signature + +```typescript +renderSwml(callId?: string, modifications?: Record): string +``` + +## Parameters + + + Optional call ID to use for session tokens; auto-generated if omitted. + + + + Optional dict returned from `onSwmlRequest` to merge into the AI verb config before rendering. Matches Python's `_render_swml(modifications)` semantics: `global_data` is deep-merged; all other keys override the AI config directly. + + +## Returns + +`string` — The rendered SWML document as a JSON string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2000. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/reset-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/reset-contexts.mdx new file mode 100644 index 0000000000..69aa6043ef --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/reset-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/reset-contexts" +title: "resetContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.resetContexts" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `resetContexts` + +Remove all contexts, returning the agent to a no-contexts state. + +This is a convenience wrapper around `defineContexts().reset()`. +Use it in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```typescript +resetContexts(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 624. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/reset-document.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/reset-document.mdx new file mode 100644 index 0000000000..39dd1d331f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/reset-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/reset-document" +title: "resetDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.resetDocument" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `resetDocument` + +Reset the SWML document to an empty state. +Mirrors Python's `reset_document()`. + +## Signature + +```typescript +resetDocument(): this +``` + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 679. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/run-serverless.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/run-serverless.mdx new file mode 100644 index 0000000000..6c61176f9c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/run-serverless.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/run-serverless" +title: "runServerless" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.runServerless" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `runServerless` + +Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + +Matches Python `run(event, context)` when executed in a serverless environment. Python's +`run()` auto-detects the platform via `get_execution_mode()` and dispatches accordingly; +in TypeScript the serverless path is an **explicit** method so that `run()` keeps its +HTTP-server semantics and callers opt in to serverless dispatch deliberately. + +Platform detection follows the same environment-variable heuristics as Python's +`ServerlessMixin`: `AWS_LAMBDA_FUNCTION_NAME` → Lambda, `K_SERVICE` → GCF, +`FUNCTIONS_WORKER_RUNTIME` → Azure, `GATEWAY_INTERFACE` → CGI. + +Usage in a Lambda handler file: + +```ts +export const handler = (event: any, context: any) => agent.runServerless(event, context); +``` + +## Signature + +```typescript +runServerless( + event: ServerlessEvent, + context?: unknown, + platform?: "lambda" | "gcf" | "azure" | "cgi" | "auto" +): Promise +``` + +## Parameters + + + The serverless event payload (Lambda event, GCF request body, etc.). + + + + The serverless context object (Lambda context, Azure context, etc.). + + + + Optional platform override; defaults to 'auto' (environment detection). + + +## Returns + +`Promise` — The normalized serverless response object. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2709. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/run.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/run.mdx new file mode 100644 index 0000000000..5b6e1e8086 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/run.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/run" +title: "run" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.run" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `run` + +Alias for [serve](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/serve). Starts the HTTP server. + +## Signature + +```typescript +run(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host and port overrides. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server is running. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2683. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/serve.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/serve.mdx new file mode 100644 index 0000000000..3133b6454e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/serve.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/serve" +title: "serve" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.serve" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `serve` + +Start the HTTP server and begin listening for requests. + +Uses `@hono/node-server` under the hood. When run in CLI mode +(`SWAIG_CLI_MODE=true`, set automatically by `npx swaig-test`), this is a +no-op so agent config can be inspected without starting a server. + +## Signature + +```typescript +serve(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host/port overrides. Defaults to the values provided in the constructor options or the `PORT` environment variable. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server has begun listening. + +## Examples + +```typescript +const agent = new AgentBase({ name: 'demo', port: 3000 }); +await agent.serve(); +// Or override at runtime: +await agent.serve({ port: 8080, host: '127.0.0.1' }); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2660. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..cc3810d85d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-dynamic-config-callback.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-dynamic-config-callback" +title: "setDynamicConfigCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setDynamicConfigCallback" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setDynamicConfigCallback` + +Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + +The callback receives a clone of this agent — mutations apply only to the current +request, so you can vary prompt, tools, languages, params, or global data per call +without affecting the long-lived agent instance. + +## Signature + +```typescript +setDynamicConfigCallback(cb: DynamicConfigCallback): this +``` + +## Parameters + + + Callback receiving `(queryParams, bodyParams, headers, agent)` where `agent` is the ephemeral `AgentBase` copy to mutate. May be async. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setDynamicConfigCallback((query, body, headers, agent) => { + const lang = query.lang ?? 'en'; + if (lang === 'es') { + (agent as AgentBase).setPromptText('Eres un asistente útil.'); + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1704. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-function-includes.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-function-includes.mdx new file mode 100644 index 0000000000..9a2d1c6a32 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-function-includes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-function-includes" +title: "setFunctionIncludes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setFunctionIncludes" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setFunctionIncludes` + +Replace the entire list of function includes. +Each include must have a `url` and `functions` array. + +## Signature + +```typescript +setFunctionIncludes(includes: FunctionInclude[]): this +``` + +## Parameters + + + Array of function include objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 978. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-global-data.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-global-data.mdx new file mode 100644 index 0000000000..d0bb39e211 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-global-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-global-data" +title: "setGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setGlobalData" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setGlobalData` + +Merge data into the global\_data object passed into the AI configuration. + +Matches Python `set_global_data` which calls `.update()` on the internal dict — +existing keys are preserved; incoming keys overwrite on collision. Skills and +other callers can each contribute keys without clobbering one another. + +If you need to replace the entire object, assign a new agent instance or use +`Object.assign(agent.globalData, {})` to clear first. + +## Signature + +```typescript +setGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 827. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-internal-fillers.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-internal-fillers.mdx new file mode 100644 index 0000000000..058f26c442 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-internal-fillers.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-internal-fillers" +title: "setInternalFillers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setInternalFillers" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setInternalFillers` + +Set internal fillers for native SWAIG functions. + +Internal fillers are short phrases the AI agent speaks (via TTS) while +an internal/native function is running, so the caller doesn't hear +dead air during transitions or background work. + +Supported function names (matches the SWAIGInternalFiller schema): + +hangup — when the agent is hanging up +check\_time — when checking the time +wait\_for\_user — when waiting for user input +wait\_seconds — during deliberate pauses +adjust\_response\_latency — when adjusting response timing +next\_step — transitioning between steps in prompt.contexts +change\_context — switching between contexts in prompt.contexts +get\_visual\_input — processing visual input (enable\_vision=true) +get\_ideal\_strategy — thinking (enable\_thinking=true) + +Notably NOT supported: change\_step, gather\_submit, or arbitrary +user-defined SWAIG function names. The runtime only honors fillers +for the names listed above; everything else is silently ignored at +the SWML level. This method warns at registration time if you pass +an unknown name so you catch the typo early. + +## Signature + +```typescript +setInternalFillers( + internalFillers: Record> +): this +``` + +## Parameters + + + Map of function name to language-keyed filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setInternalFillers({ + next_step: { + 'en-US': ['Moving to the next step...', 'Great, let us continue...'], + 'es': ['Pasando al siguiente paso...'] + }, + check_time: { + 'en-US': ['Let me check the time...'] + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 909. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-language-params.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-language-params.mdx new file mode 100644 index 0000000000..5e787fe70e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-language-params.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-language-params" +title: "setLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setLanguageParams" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguageParams` + +Set (or replace) the per-language `params` dict on an already-added +language. Useful when language entries are built up via [addLanguage](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-language) +first and engine-specific tuning is added later (e.g., from a config +loader). + +Python parity: `set_language_params(code, params)`. Passing an empty +object removes the `params` key entirely. Unknown codes are a no-op. + +## Signature + +```typescript +setLanguageParams(code: string, params: Record): this +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/add-language) (e.g. `"en-US"`). + + + + Engine-specific params dict to attach. Empty object removes the key. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 736. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-languages.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-languages.mdx new file mode 100644 index 0000000000..b1f1074bea --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-languages.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-languages" +title: "setLanguages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setLanguages" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguages` + +Replace all configured languages with a new list. + +## Signature + +```typescript +setLanguages(languages: LanguageConfig[]): this +``` + +## Parameters + + + Array of language configurations. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 717. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-native-functions.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-native-functions.mdx new file mode 100644 index 0000000000..ef0e695a6b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-native-functions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-native-functions" +title: "setNativeFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setNativeFunctions" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setNativeFunctions` + +Set the list of native SWAIG function names (built-in platform functions). + +## Signature + +```typescript +setNativeFunctions(funcs: string[]): this +``` + +## Parameters + + + Array of native function names. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 847. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-on-request-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-on-request-callback.mdx new file mode 100644 index 0000000000..178d75304c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-on-request-callback.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-on-request-callback" +title: "setOnRequestCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setOnRequestCallback" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `setOnRequestCallback` + +Set a callback invoked per-request to dynamically build SWML. +When set, the static SwmlBuilder is ignored and the callback's +returned SwmlBuilder is used instead. + +## Signature + +```typescript +setOnRequestCallback(cb: OnRequestCallback): this +``` + +## Parameters + + + Callback receiving query params, body params, and headers. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 850. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-param.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-param.mdx new file mode 100644 index 0000000000..ab44b78e2a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-param.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-param" +title: "setParam" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setParam" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParam` + +Set a single AI parameter (e.g. "temperature", "top\_p"). + +## Signature + +```typescript +setParam(key: string, value: unknown): this +``` + +## Parameters + + + Parameter name. + + + + Parameter value. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 799. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-params.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-params.mdx new file mode 100644 index 0000000000..c94778f9f3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-params" +title: "setParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setParams" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParams` + +Merge multiple AI parameters into the existing params object. + +## Signature + +```typescript +setParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 809. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..42d1858a9e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt-llm-params" +title: "setPostPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setPostPromptLlmParams" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptLlmParams` + +Merge LLM-specific parameters into the post-prompt configuration. + +## Signature + +```typescript +setPostPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1000. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt-url.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt-url.mdx new file mode 100644 index 0000000000..3a4f31313d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt-url" +title: "setPostPromptUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setPostPromptUrl" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptUrl` + +Override the default post-prompt webhook URL with a custom one. + +## Signature + +```typescript +setPostPromptUrl(url: string): this +``` + +## Parameters + + + The custom post-prompt URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1828. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt.mdx new file mode 100644 index 0000000000..43c805b077 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-post-prompt" +title: "setPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setPostPrompt" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPrompt` + +Set the post-prompt text evaluated after the call ends. + +## Signature + +```typescript +setPostPrompt(text: string): this +``` + +## Parameters + + + The post-prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 455. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..133ce4580d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-llm-params" +title: "setPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setPromptLlmParams" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptLlmParams` + +Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + +## Signature + +```typescript +setPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 990. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-pom.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-pom.mdx new file mode 100644 index 0000000000..724e8ec15b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-pom.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-pom" +title: "setPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setPromptPom" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptPom` + +Set the prompt as a POM (Prompt Object Model) dictionary. + +Replaces the current POM sections with the provided structured data. +Each entry should have `title`, and optionally `body`, `bullets`, +`numbered`, `numberedBullets`, and `subsections`. + +## Signature + +```typescript +setPromptPom(pom: Record[]): this +``` + +## Parameters + + + Array of POM section dictionaries. + + +## Returns + +`this` — This agent instance for chaining. + +## Throws + +- Error if POM mode is not enabled (`usePom: false`). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 576. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-text.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-text.mdx new file mode 100644 index 0000000000..b332a0149d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-text.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-prompt-text" +title: "setPromptText" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setPromptText" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptText` + +Set the main system prompt text for the AI. + +## Signature + +```typescript +setPromptText(text: string): this +``` + +## Parameters + + + The prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 445. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-pronunciations.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-pronunciations.mdx new file mode 100644 index 0000000000..08f65a73c0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-pronunciations.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-pronunciations" +title: "setPronunciations" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setPronunciations" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPronunciations` + +Replace all pronunciation rules with a new list. + +## Signature + +```typescript +setPronunciations(rules: PronunciationRule[]): this +``` + +## Parameters + + + Array of pronunciation rule objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 785. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-web-hook-url.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-web-hook-url.mdx new file mode 100644 index 0000000000..2266566df4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-web-hook-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/set-web-hook-url" +title: "setWebHookUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setWebHookUrl" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setWebHookUrl` + +Override the default SWAIG webhook URL with a custom one. + +## Signature + +```typescript +setWebHookUrl(url: string): this +``` + +## Parameters + + + The custom webhook URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1818. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/setup-graceful-shutdown.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/setup-graceful-shutdown.mdx new file mode 100644 index 0000000000..a2b1ca1694 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/setup-graceful-shutdown.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/setup-graceful-shutdown" +title: "setupGracefulShutdown" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.setupGracefulShutdown" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setupGracefulShutdown` + +Register process signal handlers for clean Kubernetes/Docker shutdown. +Handles SIGTERM and SIGINT, waits for a timeout, then exits. + +**Modifiers:** `static` + +## Signature + +```typescript +setupGracefulShutdown(opts?: { ...1 fields }): void +``` + +## Parameters + + + Optional timeout in milliseconds (default 5000). + + + + +## Returns + +`void` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2732. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/stop.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/stop.mdx new file mode 100644 index 0000000000..c53c69b153 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.stop" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `stop` + +Stop the HTTP server. +Mirrors Python's `stop()`. + +## Signature + +```typescript +stop(): void +``` + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 1009. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..9cee3133e3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/swaig-pre-dispatch.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/swaig-pre-dispatch" +title: "swaigPreDispatch" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.swaigPreDispatch" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `swaigPreDispatch` + +Extension point: invoked between argument parsing and function dispatch +on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is +non-null, it's returned directly without dispatching. AgentBase may +override to add session-token validation or ephemeral dynamic-config. + +## Signature + +```typescript +swaigPreDispatch( + _requestData: Record, + _funcName: string +): [SWMLService, unknown] +``` + +## Parameters + + + + + +## Returns + +`[SWMLService, unknown]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 592. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/update-global-data.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/update-global-data.mdx new file mode 100644 index 0000000000..0478e9675b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/update-global-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/update-global-data" +title: "updateGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.updateGlobalData" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `updateGlobalData` + +Merge additional entries into the existing global\_data object. + +## Signature + +```typescript +updateGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 837. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/validate-basic-auth.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/validate-basic-auth.mdx new file mode 100644 index 0000000000..486251f62c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/validate-basic-auth.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/validate-basic-auth" +title: "validateBasicAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.validateBasicAuth" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateBasicAuth` + +Override to add custom basic-auth validation logic beyond credential matching. + +## Signature + +```typescript +validateBasicAuth( + _username: string, + _password: string +): boolean | Promise +``` + +## Parameters + + + The username from the request. + + + + The password from the request. + + +## Returns + +`boolean | Promise` — True if the credentials are valid; false to reject the request. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1961. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/validate-tool-token.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/validate-tool-token.mdx new file mode 100644 index 0000000000..ca427083a7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/validate-tool-token.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent/validate-tool-token" +title: "validateToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotAgent.validateToolToken" + parent: "prefabs.FAQBotAgent.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateToolToken` + +Validate a tool-call token for the given function. + +Mirrors Python reference `core/mixins/state_mixin.py validate_tool_token`: + +1. Unknown function → `false`. +2. Registered but non-secure → `true` without consulting SessionManager + (non-secure tools never require a token). +3. Raw-dict descriptors (e.g. DataMap) are treated as secure, matching + Python's `isinstance(func, dict) → is_secure = True` branch. +4. Missing token on a secure tool → `false`. +5. Otherwise delegate to `SessionManager.validateToolToken`. + +Divergences from the Python reference: + +- No debug-logging branch: `AgentBase` does not expose an agent-level + debug-mode flag, so the per-call debug telemetry Python emits is + omitted. `SessionManager` still logs its own validation outcomes. +- No token-derived call-id fallback: `SessionManager.debugToken` + truncates the embedded call-id for log safety, so an extracted value + cannot be round-tripped back through `validateToolToken`. The caller + is expected to supply a non-empty `callId`; an empty one is forwarded + unchanged and the underlying validator will reject it. + +## Signature + +```typescript +validateToolToken(functionName: string, token: string, callId: string): boolean +``` + +## Parameters + + + + + + + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1447. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-config/index.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-config/index.mdx new file mode 100644 index 0000000000..12d5e46bf1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-bot-config/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-bot-config" +title: "FAQBotConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQBotConfig" + parent: "prefabs.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts" +--- +# `FAQBotConfig` + +Configuration for the [FAQBotAgent](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent). + +## Signature + +```typescript +interface FAQBotConfig +``` + +## Properties + + + Additional AgentBase options forwarded to super(). + + + + Message spoken when no FAQ matches the query. + + + + Phone number to transfer to on escalation. If not set, escalate tool is not registered. + + + + List of FAQ entries for the knowledge base. + + + + Agent display name (defaults to `"faq_bot"`). + + + + Custom personality description for the agent's "Personality" prompt section. + + + + HTTP route for this agent (defaults to `"/faq"`). + + + + Whether to suggest related questions alongside a match. Default `true`. + + + + Minimum match score (0-1) for an FAQ to be considered a match. Default 0.5. + + +## Source + +[`src/prefabs/FAQBotAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts) + +Line 30. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-entry/index.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-entry/index.mdx new file mode 100644 index 0000000000..c5be6943a9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/faq-entry/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent/faq-entry" +title: "FAQEntry" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent.FAQEntry" + parent: "prefabs.FAQBotAgent" + module: "prefabs.FAQBotAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts" +--- +# `FAQEntry` + +A single frequently-asked-question entry consumed by [FAQBotAgent](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent). + +## Signature + +```typescript +interface FAQEntry +``` + +## Properties + + + The answer to provide when this FAQ matches. + + + + Taxonomy categories this FAQ belongs to (used for filtering and hints). + + + + Additional keywords to boost matching accuracy. + + + + The representative question text. + + +## Source + +[`src/prefabs/FAQBotAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts) + +Line 18. diff --git a/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/index.mdx b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/index.mdx new file mode 100644 index 0000000000..77452ccae7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/faq-bot-agent/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/faq-bot-agent" +title: "FAQBotAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "prefabs.FAQBotAgent" + module: "prefabs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts" +--- +# `FAQBotAgent` + +## Signature + +```typescript +module FAQBotAgent +``` + +## Functions + + + + Factory function that creates and returns a new FAQBotAgent. + + + +## Classes + + + + Prefab agent that answers frequently asked questions using keyword matching with optional escalation to a live agent. + + + +## Interfaces + + + + Configuration for the [FAQBotAgent](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent). + + + + A single frequently-asked-question entry consumed by [FAQBotAgent](/reference/typescript/prefabs/faq-bot-agent/faq-bot-agent). + + + +## Source + +[`src/prefabs/FAQBotAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/FAQBotAgent.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/prefabs/index.mdx b/fern/products/sdk-reference/typescript/prefabs/index.mdx new file mode 100644 index 0000000000..a7e2c72470 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/index.mdx @@ -0,0 +1,25 @@ +--- +slug: "/reference/typescript/prefabs" +title: "prefabs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "prefabs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/index.ts" +--- +# `prefabs` + +## Signature + +```typescript +module prefabs +``` + +## Source + +[`src/prefabs/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/index.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/create-info-gatherer-agent.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/create-info-gatherer-agent.mdx new file mode 100644 index 0000000000..2a8f70e453 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/create-info-gatherer-agent.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/create-info-gatherer-agent" +title: "createInfoGathererAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.createInfoGathererAgent" + parent: "prefabs.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts" +--- +# `createInfoGathererAgent` + +Factory function that creates and returns a new InfoGathererAgent. + +## Signature + +```typescript +createInfoGathererAgent(config: InfoGathererConfig = {}): InfoGathererAgent +``` + +## Parameters + + + Configuration for the info gatherer agent. + + +## Returns + +`InfoGathererAgent` — A configured InfoGathererAgent instance. + +## Source + +[`src/prefabs/InfoGathererAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts) + +Line 375. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/index.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/index.mdx new file mode 100644 index 0000000000..256a8e554f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent" +title: "InfoGathererAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent" + module: "prefabs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts" +--- +# `InfoGathererAgent` + +## Signature + +```typescript +module InfoGathererAgent +``` + +## Functions + + + + Factory function that creates and returns a new InfoGathererAgent. + + + +## Type Aliases + + + + Callback invoked on each incoming SWML request to produce the list of questions for that request. Mirrors Python's `set_question_callback`. + + + +## Classes + + + + Prefab agent that gathers caller information one question at a time. + + + +## Interfaces + + + + Configuration for the InfoGathererAgent. + + + + A single question in the information-gathering flow. + + + +## Source + +[`src/prefabs/InfoGathererAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-answer-verb.mdx new file mode 100644 index 0000000000..d0f836f663 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-answer-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-answer-verb" +title: "addAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addAnswerVerb" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addAnswerVerb` + +Configure the answer verb (phase 2) with optional settings. + +## Signature + +```typescript +addAnswerVerb(config?: Record): this +``` + +## Parameters + + + Optional answer verb configuration. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1493. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-function-include.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-function-include.mdx new file mode 100644 index 0000000000..e7ea0b06b9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-function-include.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-function-include" +title: "addFunctionInclude" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addFunctionInclude" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addFunctionInclude` + +Add a remote SWAIG function include reference. + +## Signature + +```typescript +addFunctionInclude( + url: string, + functions: string[], + metaData?: Record +): this +``` + +## Parameters + + + URL of the remote SWAIG endpoint. + + + + Function names available at that endpoint. + + + + Optional metadata to attach to the include. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 965. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-hint.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-hint.mdx new file mode 100644 index 0000000000..8b7a59aebf --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-hint.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-hint" +title: "addHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addHint" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHint` + +Add a single speech-recognition hint. + +## Signature + +```typescript +addHint(hint: string): this +``` + +## Parameters + + + Word or phrase to boost in speech recognition. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 652. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-hints.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-hints.mdx new file mode 100644 index 0000000000..12e1a80a66 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-hints.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-hints" +title: "addHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addHints" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHints` + +Add multiple speech-recognition hints at once. + +## Signature + +```typescript +addHints(hints: string[]): this +``` + +## Parameters + + + Array of words or phrases to boost. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 662. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-internal-filler.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-internal-filler.mdx new file mode 100644 index 0000000000..77c1b42607 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-internal-filler.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-internal-filler" +title: "addInternalFiller" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addInternalFiller" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addInternalFiller` + +Add internal filler phrases for a single internal function and language. + +See [setInternalFillers](/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-internal-fillers) for the complete list of supported +functionName values and an explanation of what fillers do. + +## Signature + +```typescript +addInternalFiller( + functionName: string, + languageCode: string, + fillers: string[] +): this +``` + +## Parameters + + + One of the supported internal function names (see SUPPORTED\_INTERNAL\_FILLER\_NAMES). Names outside the supported set log a warning and are ignored by the runtime. + + + + BCP-47 language code for the fillers (e.g. 'en-US'). + + + + Array of filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 942. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-language.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-language.mdx new file mode 100644 index 0000000000..478691b2f9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-language.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-language" +title: "addLanguage" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addLanguage" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addLanguage` + +Add a supported language to the AI configuration. + +## Signature + +```typescript +addLanguage(config: LanguageConfig): this +``` + +## Parameters + + + Language configuration including name, code, voice, and optional fillers. `params` may be set to attach engine-specific tuning (voice stability, similarity boost, model knobs, etc.); only emitted into SWML when non-empty so existing entries stay byte-identical when no params are passed (Python ai\_config\_mixin.py `add_language`). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 693. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-mcp-server.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-mcp-server.mdx new file mode 100644 index 0000000000..1af8748d16 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-mcp-server.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-mcp-server" +title: "addMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addMcpServer" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addMcpServer` + +Add an external MCP server for tool discovery and invocation. +Tools are discovered via MCP protocol at session start and added to the AI's tool list. + +## Signature + +```typescript +addMcpServer(url: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + MCP server HTTP endpoint URL + + + + Optional configuration: headers, resources, resourceVars + + + + + + + + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1145. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pattern-hint.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pattern-hint.mdx new file mode 100644 index 0000000000..7ef880908e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pattern-hint.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pattern-hint" +title: "addPatternHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addPatternHint" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPatternHint` + +Add a pattern-based speech-recognition hint with find-and-replace behavior. + +## Signature + +```typescript +addPatternHint(opts: { ...4 fields }): this +``` + +## Parameters + + + Pattern hint configuration with a descriptive hint label, regex pattern, replacement string, and optional case-insensitive flag. + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 673. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-post-ai-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-post-ai-verb.mdx new file mode 100644 index 0000000000..d7b97a066e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-post-ai-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-post-ai-verb" +title: "addPostAiVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addPostAiVerb" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAiVerb` + +Add a SWML verb to execute after the AI verb (phase 5). + +## Signature + +```typescript +addPostAiVerb(verbName: string, config: Record): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1515. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-post-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-post-answer-verb.mdx new file mode 100644 index 0000000000..b36af4eca6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-post-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-post-answer-verb" +title: "addPostAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addPostAnswerVerb" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAnswerVerb` + +Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + +## Signature + +```typescript +addPostAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1504. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pre-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..27949f9c67 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pre-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pre-answer-verb" +title: "addPreAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addPreAnswerVerb" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPreAnswerVerb` + +Add a SWML verb to execute before the answer phase (phase 1). + +## Signature + +```typescript +addPreAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb (e.g. "play", "record"). + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1483. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pronunciation.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pronunciation.mdx new file mode 100644 index 0000000000..4e730a324a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pronunciation.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-pronunciation" +title: "addPronunciation" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addPronunciation" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPronunciation` + +Add a pronunciation override rule for the TTS engine. + +## Signature + +```typescript +addPronunciation(rule: PronunciationRule): this +``` + +## Parameters + + + Pronunciation rule specifying the text to replace and its substitute. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 773. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-section.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-section.mdx new file mode 100644 index 0000000000..1a358e7c08 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addSection" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addSection` + +Add a new named section to the SWML document. +Mirrors Python's `add_section()`. + +## Signature + +```typescript +addSection(sectionName: string): this +``` + +## Parameters + + + Name of the section to create. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 653. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-skill-by-name.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-skill-by-name.mdx new file mode 100644 index 0000000000..f93c2dbf56 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-skill-by-name.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-skill-by-name" +title: "addSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addSkillByName" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkillByName` + +Add a skill by its registered name, looking it up in the global SkillRegistry. + +Matches Python's `add_skill(skill_name, params)` which loads skills by string +name via the SkillManager registry. Throws a `ValueError`-equivalent if the +skill name is not found in the registry. + +## Signature + +```typescript +addSkillByName( + skillName: string, + params?: SkillConfig +): Promise +``` + +## Parameters + + + The name the skill was registered under in the SkillRegistry. + + + + Optional configuration parameters forwarded to the skill factory. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Throws + +- Error if no skill with the given name is registered. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1627. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-skill.mdx new file mode 100644 index 0000000000..6c658ec34d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-skill" +title: "addSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addSkill" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkill` + +Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + +## Signature + +```typescript +addSkill(skill: SkillBase): Promise +``` + +## Parameters + + + The skill instance to add. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1562. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-swaig-query-params.mdx new file mode 100644 index 0000000000..27263f58ae --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-swaig-query-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-swaig-query-params" +title: "addSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addSwaigQueryParams" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSwaigQueryParams` + +Add extra query parameters appended to all SWAIG webhook URLs. + +## Signature + +```typescript +addSwaigQueryParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to append as query parameters. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1714. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-verb-to-section.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-verb-to-section.mdx new file mode 100644 index 0000000000..69984c783c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-verb-to-section.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-verb-to-section" +title: "addVerbToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addVerbToSection" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerbToSection` + +Add a verb to a specific named section. +Mirrors Python's `add_verb_to_section()`. + +## Signature + +```typescript +addVerbToSection(sectionName: string, verbName: string, config: unknown): this +``` + +## Parameters + + + Target section name (auto-created if missing). + + + + Verb name. + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 669. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-verb.mdx new file mode 100644 index 0000000000..01dbe95ee0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-verb" +title: "addVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.addVerb" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerb` + +Add a verb to the SWML document. + +## Signature + +```typescript +addVerb(name: string, config: unknown): this +``` + +## Parameters + + + Verb name (e.g., 'answer', 'play', 'hangup'). + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 642. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/as-router.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/as-router.mdx new file mode 100644 index 0000000000..ae2d7ed929 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/as-router.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/as-router" +title: "asRouter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.asRouter" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `asRouter` + +Return this agent's Hono app for mounting as a sub-router in an AgentServer. + +## Signature + +```typescript +asRouter(): Hono +``` + +## Returns + +`Hono` — The Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2637. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/auto-map-sip-usernames.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/auto-map-sip-usernames.mdx new file mode 100644 index 0000000000..5ec9b45422 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/auto-map-sip-usernames.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/auto-map-sip-usernames" +title: "autoMapSipUsernames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.autoMapSipUsernames" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `autoMapSipUsernames` + +Automatically register common SIP usernames based on this agent's +name and route. Derives cleaned variants (alphanumeric + underscore) +and registers each via `registerSipUsername()`. + +Port of Python's `auto_map_sip_usernames()`: + +- Registers a cleaned version of the agent name +- Registers a cleaned version of the route (if different from name) +- For names longer than 3 characters, also registers a vowel-stripped variant + +## Signature + +```typescript +autoMapSipUsernames(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1057. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/build-swml-for-request.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/build-swml-for-request.mdx new file mode 100644 index 0000000000..832de0781d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/build-swml-for-request.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/build-swml-for-request" +title: "buildSwmlForRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.buildSwmlForRequest" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `buildSwmlForRequest` + +Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` +to fully replace the document for this request, or `null` to fall +through to `setOnRequestCallback` or the static builder. + +This is distinct from the WebMixin `onRequest(requestData, +callbackPath)` hook on AgentBase (which mirrors Python's +`on_request -> on_swml_request` modification-merge contract). +Use this hook when you want to swap the entire SWML builder; use +`onRequest` / `onSwmlRequest` on AgentBase when you want to merge +targeted modifications into the rendered document. + +Default implementation returns `null` (no-op). + +## Signature + +```typescript +buildSwmlForRequest( + _queryParams: Record, + _bodyParams: Record, + _headers: Record, + _callbackPath?: string +): SwmlBuilder | null +``` + +## Parameters + + + + + + + + + +## Returns + +`SwmlBuilder | null` — A `SwmlBuilder` whose document is sent as the response, or `null` to delegate to the next handler in the chain. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 834. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..b493347e7f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-post-ai-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-post-ai-verbs" +title: "clearPostAiVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.clearPostAiVerbs" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAiVerbs` + +Remove all post-AI verbs. + +## Signature + +```typescript +clearPostAiVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1542. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..99f95ccbf6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-post-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-post-answer-verbs" +title: "clearPostAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.clearPostAnswerVerbs" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAnswerVerbs` + +Remove all post-answer verbs. + +## Signature + +```typescript +clearPostAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1533. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..b253c1cd7e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-pre-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-pre-answer-verbs" +title: "clearPreAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.clearPreAnswerVerbs" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPreAnswerVerbs` + +Remove all pre-answer verbs. + +## Signature + +```typescript +clearPreAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1524. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..db69884340 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-swaig-query-params.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/clear-swaig-query-params" +title: "clearSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.clearSwaigQueryParams" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearSwaigQueryParams` + +Clear all SWAIG query parameters. + +## Signature + +```typescript +clearSwaigQueryParams(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1723. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/constructor.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/constructor.mdx new file mode 100644 index 0000000000..d7b3c1cb06 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.constructor" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts" +--- +# `constructor` + +Create an InfoGathererAgent. + +## Signature + +```typescript +constructor(config: InfoGathererConfig = {}): InfoGathererAgent +``` + +## Parameters + + + Either `questions` (static mode) or leave omitted and use `questionCallback` / `setQuestionCallback()` (dynamic mode). + + +## Returns + +`InfoGathererAgent` + +## Source + +[`src/prefabs/InfoGathererAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts) + +Line 116. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/create-tool-token.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/create-tool-token.mdx new file mode 100644 index 0000000000..1f00bda9ee --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/create-tool-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/create-tool-token" +title: "createToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.createToolToken" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `createToolToken` + +Mint a per-call SWAIG-function token via the agent's SessionManager. + +Mirrors Python reference `core/mixins/state_mixin.py _create_tool_token`: +delegates to `SessionManager.createToolToken` and returns an empty +string on any failure (Python catches all exceptions and returns ""). + +## Signature + +```typescript +createToolToken(toolName: string, callId: string): string +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1467. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-contexts.mdx new file mode 100644 index 0000000000..67124834d9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-contexts.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-contexts" +title: "defineContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.defineContexts" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineContexts` + +Define or replace the contexts configuration for the AI verb. + +## Signature + +```typescript +defineContexts( + contexts?: Record | ContextBuilder +): ContextBuilder +``` + +## Parameters + + + An existing ContextBuilder instance or a plain object; a new ContextBuilder is created if omitted. + + +## Returns + +`ContextBuilder` — The active ContextBuilder for further configuration. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 603. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-tool.mdx new file mode 100644 index 0000000000..1ee7ec825c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-tool.mdx @@ -0,0 +1,114 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.defineTool" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTool` + +Register a SWAIG tool (function) that the AI can invoke during a call. + +## How this becomes a tool the model sees + +A SWAIG function is **exactly the same concept** as a "tool" in +native OpenAI / Anthropic tool calling. On every LLM turn, the SDK +renders each registered SWAIG function into the OpenAI tool schema: + +```json +{ +"type": "function", +"function": { +"name": "your_name_here", +"description": "your description text", +"parameters": { /* your JSON schema */ } +} +} +``` + +That schema goes to the model in the same API call that produces +the next assistant message. The model reads: + +- the **function `description`** to decide WHEN to call this tool +- each **parameter `description`** (inside the JSON schema) to + decide HOW to fill in each argument + +This means **descriptions are prompt engineering**, not developer +comments. A vague description is the #1 cause of "the model has the +right tool but doesn't call it" failures. + +### Bad vs good descriptions + +```text +BAD : description: 'Lookup function' +GOOD: description: 'Look up a customer's account details by account +number. Use this BEFORE quoting any account-specific info +(balance, plan, status). Do not use for general product +questions.' + +BAD : parameters: { id: { type: 'string', description: 'the id' } } +GOOD: parameters: { account_number: { type: 'string', description: +'The customer's 8-digit account number, no dashes or spaces. +Ask the user if they don't provide it.' } } +``` + +### Tool count matters + +LLM tool selection accuracy degrades past ~7-8 simultaneously-active +tools per call. Use Step.setFunctions() to partition tools across +steps so only the relevant subset is active at any moment. + +## Signature + +```typescript +defineTool(opts: { ...11 fields }): this +``` + +## Parameters + + + Tool definition including name, description, parameter schema, and handler callback. `description` and per-parameter `description` strings are LLM-facing prompt engineering. + + + + + Additional fields to pass through to the SWAIG function definition (Python `**swaig_fields` equivalent). + + + + + + + + + + + + + + + + + + + + External webhook URL; makes this an externally-hosted tool. + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1329. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-tools.mdx new file mode 100644 index 0000000000..af06ec1223 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-tools" +title: "defineTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.defineTools" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts" + visibility: "protected" +--- +# `defineTools` + +Register the `start_questions` and `submit_answer` SWAIG tools. + +## Signature + +```typescript +defineTools(): void +``` + +## Returns + +`void` + +## Source + +[`src/prefabs/InfoGathererAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-typed-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-typed-tool.mdx new file mode 100644 index 0000000000..6cd1031911 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-typed-tool.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/define-typed-tool" +title: "defineTypedTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.defineTypedTool" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTypedTool` + +Register a SWAIG tool with a typed handler that receives named parameters +instead of the standard `(args, rawData)` convention. + +The SDK wraps the handler to unpack the args dict into positional params. +If no `parameters` schema is provided, one is inferred from the handler's +source code (parameter names and default values). + +## Signature + +```typescript +defineTypedTool(opts: { ...9 fields }): this +``` + +## Parameters + + + Tool definition with a typed handler function. + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1372. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-debug-events.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-debug-events.mdx new file mode 100644 index 0000000000..0047691114 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-debug-events.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-debug-events" +title: "enableDebugEvents" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.enableDebugEvents" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugEvents` + +Enable debug event webhooks for this agent. + +## Signature + +```typescript +enableDebugEvents(level: number = 1): this +``` + +## Parameters + + + Debug verbosity level (defaults to 1). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1010. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-debug-routes.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-debug-routes.mdx new file mode 100644 index 0000000000..50f1dffade --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-debug-routes.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-debug-routes" +title: "enableDebugRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.enableDebugRoutes" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugRoutes` + +Register a callback function that determines routing based on POST data. + +When a routing callback is registered, an endpoint at the specified path +is created in `getApp()`. The callback receives the request body and returns +Enable debug routes for testing and development. + +This is a backward-compatibility stub matching the Python SDK. +In the TypeScript SDK, debug routes (health, ready, debug\_events) +are automatically registered in `getApp()`. + +## Signature + +```typescript +enableDebugRoutes(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1754. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-mcp-server.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-mcp-server.mdx new file mode 100644 index 0000000000..b7b5c1c187 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-mcp-server.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-mcp-server" +title: "enableMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.enableMcpServer" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableMcpServer` + +Expose this agent's tools as an MCP server endpoint at /mcp. +Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + +## Signature + +```typescript +enableMcpServer(): this +``` + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1159. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-sip-routing.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-sip-routing.mdx new file mode 100644 index 0000000000..b93f3d28a2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-sip-routing.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/enable-sip-routing" +title: "enableSipRouting" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.enableSipRouting" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableSipRouting` + +Enable SIP routing for this agent. + +## Signature + +```typescript +enableSipRouting(autoMap: boolean = true, path: string = '/sip'): this +``` + +## Parameters + + + When true, automatically map SIP usernames to the agent route (defaults to true). + + + + HTTP path for the SIP routing endpoint (defaults to '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1024. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/extract-sip-username.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/extract-sip-username.mdx new file mode 100644 index 0000000000..60b1a3b223 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/extract-sip-username.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/extract-sip-username" +title: "extractSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.extractSipUsername" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `extractSipUsername` + +Extract the SIP username from a request body's call.to field. + +**Modifiers:** `static` + +## Signature + +```typescript +extractSipUsername(requestBody: Record): string | null +``` + +## Parameters + + + The parsed request body containing call information. + + +## Returns + +`string | null` — The extracted SIP username, or null if not found. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1121. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-all-functions.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-all-functions.mdx new file mode 100644 index 0000000000..06ee7fd7c8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-all-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-all-functions" +title: "getAllFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getAllFunctions" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getAllFunctions` + +Snapshot of all registered SWAIG functions keyed by name. +(Python parity: `ToolRegistry.get_all_functions`.) + +## Signature + +```typescript +getAllFunctions(): Record> +``` + +## Returns + +`Record>` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 529. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-app.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-app.mdx new file mode 100644 index 0000000000..fae64249e0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-app.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-app" +title: "getApp" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getApp" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getApp` + +Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + +## Signature + +```typescript +getApp(): Hono +``` + +## Returns + +`Hono` — The configured Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2250. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..36a3f248ec --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-basic-auth-credentials.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-basic-auth-credentials" +title: "getBasicAuthCredentials" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getBasicAuthCredentials" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getBasicAuthCredentials` + +Get the basic-auth credentials used by this agent. + +## Signature + + + + ```typescript + getBasicAuthCredentials(includeSource?: false): [string, string] + ``` + + + + ```typescript + getBasicAuthCredentials( + includeSource: true + ): [string, string, "provided" | "environment" | "generated"] + ``` + + + +## Parameters (Overload 1) + + + When true, a third element indicating the credential source is appended. + + +## Parameters (Overload 2) + + + When true, a third element indicating the credential source is appended. + + +## Returns (Overload 1) + +`[string, string]` — A tuple of \[username, password] or \[username, password, source]. + +## Returns (Overload 2) + +`[string, string, "provided" | "environment" | "generated"]` — A tuple of \[username, password] or \[username, password, source]. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2775. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-builder.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-builder.mdx new file mode 100644 index 0000000000..2182bc60f6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-builder.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-builder" +title: "getBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getBuilder" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getBuilder` + +Get the underlying SwmlBuilder for direct manipulation. + +## Signature + +```typescript +getBuilder(): SwmlBuilder +``` + +## Returns + +`SwmlBuilder` — The SwmlBuilder instance. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 632. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-contexts.mdx new file mode 100644 index 0000000000..492f2148c3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-contexts" +title: "getContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getContexts" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getContexts` + +Get the contexts dictionary as serialised SWML, or null when no +contexts have been defined yet. + +Matches Python `PromptManager.get_contexts()` which returns the +contexts dict or `None`. + +## Signature + +```typescript +getContexts(): Record | null +``` + +## Returns + +`Record | null` — Contexts dict, or null when no contexts are defined. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 640. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-document.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-document.mdx new file mode 100644 index 0000000000..468516a2cf --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-document" +title: "getDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getDocument" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getDocument` + +Get the SWML document as a dictionary. +Alias for `renderSwml()` that matches Python's `get_document()` name. + +## Signature + +```typescript +getDocument(): Record +``` + +## Returns + +`Record` — The SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 706. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-full-url.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-full-url.mdx new file mode 100644 index 0000000000..4a23502aeb --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-full-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-full-url" +title: "getFullUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getFullUrl" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getFullUrl` + +Get the full external URL of this agent, using the proxy base URL if available. + +## Signature + +```typescript +getFullUrl(includeAuth: boolean = false): string +``` + +## Parameters + + + Whether to embed basic-auth credentials in the URL (defaults to false). + + +## Returns + +`string` — The fully-qualified URL string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1838. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-function.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-function.mdx new file mode 100644 index 0000000000..2ce8df329b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-function" +title: "getFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getFunction" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getFunction` + +Get a registered SWAIG function entry, or undefined. +(Python parity: `ToolRegistry.get_function`.) + +## Signature + +```typescript +getFunction(name: string): Record | SwaigFunction | undefined +``` + +## Parameters + + + +## Returns + +`Record | SwaigFunction | undefined` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 523. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-language-params.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-language-params.mdx new file mode 100644 index 0000000000..1aabead212 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-language-params.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-language-params" +title: "getLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getLanguageParams" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getLanguageParams` + +Read the per-language `params` dict for a previously-added language. + +Python parity: `get_language_params(code)`. Returns `undefined` if the +code is unknown or the language has no params set — no exception path. + +## Signature + +```typescript +getLanguageParams(code: string): Record | undefined +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-language). + + +## Returns + +`Record | undefined` — The params dict if set, `undefined` otherwise (including when the code is unknown). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 759. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-mcp-servers.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-mcp-servers.mdx new file mode 100644 index 0000000000..ce8df60b49 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-mcp-servers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-mcp-servers" +title: "getMcpServers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getMcpServers" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getMcpServers` + +Get configured MCP servers (read-only copy). + +## Signature + +```typescript +getMcpServers(): Record[] +``` + +## Returns + +`Record[]` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1170. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-name.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-name.mdx new file mode 100644 index 0000000000..c06b3c46fe --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-name" +title: "getName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getName" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getName` + +Get the agent's display name. + +## Signature + +```typescript +getName(): string +``` + +## Returns + +`string` — The agent name string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1551. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-post-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-post-prompt.mdx new file mode 100644 index 0000000000..3551c9351a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-post-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-post-prompt" +title: "getPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getPostPrompt" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPostPrompt` + +Get the post-prompt text, if one has been set. + +## Signature + +```typescript +getPostPrompt(): string | null +``` + +## Returns + +`string | null` — The post-prompt string, or null if not configured. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 547. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-prompt-pom.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-prompt-pom.mdx new file mode 100644 index 0000000000..e7642be817 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-prompt-pom.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-prompt-pom" +title: "getPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getPromptPom" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPromptPom` + +Get the raw POM (Prompt Object Model) structure as an array of section data objects, +when the agent is in POM mode and has at least one section. + +Matches Python `get_prompt()` which returns `Union[str, List[Dict]]` — a raw list when +in POM mode (via `pom.to_list()` / `pom.render_dict()`), or a string otherwise. +The TS `getPrompt()` always returns a string (rendered Markdown), so this companion +method exposes the raw POM structure for callers that need it for serialisation or +inspection (e.g. skills that inspect prompt sections). + +## Signature + +```typescript +getPromptPom(): Record[] | null +``` + +## Returns + +`Record[] | null` — An array of POM section data objects, or null if not in POM mode or POM is empty. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 535. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-prompt.mdx new file mode 100644 index 0000000000..e9b7b7023b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-prompt" +title: "getPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getPrompt" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPrompt` + +Get the fully rendered main prompt text. + +## Signature + +```typescript +getPrompt(): string +``` + +## Returns + +`string` — The assembled prompt string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 519. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-raw-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-raw-prompt.mdx new file mode 100644 index 0000000000..edd17480f0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-raw-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-raw-prompt" +title: "getRawPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getRawPrompt" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getRawPrompt` + +Get the raw prompt text whatever `setPromptText` stored, or null when +no raw prompt has been set. + +Matches Python `PromptManager.get_raw_prompt()` which returns the raw +stored string or `None`. Use this instead of `getPrompt()` when you +need the unrendered text rather than the POM-rendered Markdown. + +## Signature + +```typescript +getRawPrompt(): string | null +``` + +## Returns + +`string | null` — The raw prompt string, or null if not set. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 561. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-registered-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-registered-tools.mdx new file mode 100644 index 0000000000..fbb97eb370 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-registered-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-registered-tools" +title: "getRegisteredTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getRegisteredTools" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getRegisteredTools` + +Get a summary of all registered tools with their names, descriptions, and +parameter schemas. Lifted from AgentBase so the swaig-test CLI can list +tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG +host). + +## Signature + +```typescript +getRegisteredTools(): { description: string; name: string; parameters: Record }[] +``` + +## Returns + +`{ description: string; name: string; parameters: Record }[]` — Array of tool descriptors. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-tool.mdx new file mode 100644 index 0000000000..186f063900 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-tool.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-tool" +title: "getTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getTool" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getTool` + +Look up a registered SwaigFunction by name. Lifted from AgentBase so +`swaig-test --exec ` works against a non-AgentBase SWMLService +target. + +## Signature + +```typescript +getTool(name: string): SwaigFunction | undefined +``` + +## Parameters + + + The tool name to search for. + + +## Returns + +`SwaigFunction | undefined` — The SwaigFunction instance, or undefined if not found or not a SwaigFunction. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 581. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-tools.mdx new file mode 100644 index 0000000000..8a719efcf5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.getTools" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getTools` + +Public access to the list of registered tools. + +In Python, `define_tools()` is public and returns `List[SWAIGFunction]`. +In TypeScript, `defineTools()` is a protected setup hook (void). This +method provides the equivalent public "get all tools" capability. + +## Signature + +```typescript +getTools(): SwaigFunction[] +``` + +## Returns + +`SwaigFunction[]` — Array of all registered SwaigFunction instances. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 370. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/handle-mcp-request.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/handle-mcp-request.mdx new file mode 100644 index 0000000000..09d17298ad --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/handle-mcp-request.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/handle-mcp-request" +title: "handleMcpRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.handleMcpRequest" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `handleMcpRequest` + +Handle an MCP JSON-RPC 2.0 request. Returns the response object. + +## Signature + +```typescript +handleMcpRequest( + body: Record +): Promise> +``` + +## Parameters + + + +## Returns + +`Promise>` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1203. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-function.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-function.mdx new file mode 100644 index 0000000000..741d4ea489 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-function" +title: "hasFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.hasFunction" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasFunction` + +Whether a SWAIG function with the given name is registered. +(Python parity: `ToolRegistry.has_function`.) + +## Signature + +```typescript +hasFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 517. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-skill.mdx new file mode 100644 index 0000000000..7c031f371b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-skill" +title: "hasSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.hasSkill" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `hasSkill` + +Check whether a skill with the given name is registered. + +## Signature + +```typescript +hasSkill(skillName: string): boolean +``` + +## Parameters + + + The skill name to check. + + +## Returns + +`boolean` — True if a skill with that name exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1657. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-tool.mdx new file mode 100644 index 0000000000..59f03f744b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-tool.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/has-tool" +title: "hasTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.hasTool" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasTool` + +Whether a tool with the given name is registered. + +## Signature + +```typescript +hasTool(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/index.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/index.mdx new file mode 100644 index 0000000000..7ab4b58098 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/index.mdx @@ -0,0 +1,617 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent" +title: "InfoGathererAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent" + parent: "prefabs.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts" +--- +# `InfoGathererAgent` + +Prefab agent that gathers caller information one question at a time. + +Supports two modes: + +- **Static** — provide `questions` at construction; the same questions are + asked on every call. +- **Dynamic** — leave `questions` unset and register a callback via + `questionCallback` (or `setQuestionCallback()`); the callback decides which + questions to ask per incoming call based on query params, body, or headers. + +## Signature + +```typescript +class InfoGathererAgent extends AgentBase +``` + +## Inheritance + +**Extends:** [AgentBase](/reference/typescript/agent-base) + +## Examples + + + + ```typescript + import { InfoGathererAgent } from '@signalwire/sdk'; + + const agent = new InfoGathererAgent({ + questions: [ + { key_name: 'name', question_text: 'What is your name?' }, + { key_name: 'email', question_text: 'What is your email address?', confirm: true }, + { key_name: 'issue', question_text: 'How can we help?' }, + ], + }); + + await agent.serve({ port: 3000 }); + ``` + + + + ```typescript + const agent = new InfoGathererAgent({ + questionCallback: async (query) => { + if (query.intake === 'medical') { + return [ + { key_name: 'dob', question_text: 'Date of birth?' }, + { key_name: 'insurance_id', question_text: 'Insurance member ID?' }, + ]; + } + return [{ key_name: 'message', question_text: 'How can I help?' }]; + }, + }); + ``` + + + +## Properties + + + Unique identifier for this agent instance. + + + + + + + + Domain name for SSL. Mirrors Python's `self.domain`. + + + + Check if full JSON Schema validation is enabled. Mirrors Python's `@property full_validation_enabled`. + + + + Host the server binds to. + + + + Structured logger instance for this agent. Override the inherited SWMLService logger with an AgentBase-tagged one. + + + + Service display name. + + + + Public accessor for the native functions list. Python exposes `self.native_functions` as a public read/write attribute. + + + + + + Public accessor for the agent's POM as a `PromptObjectModel` instance. Python parity: `agent.pom` instance attribute (agent\_base.py line 209) is a `signalwire.pom.pom.PromptObjectModel` when `use_pom=True`, or `None` otherwise. This getter returns the equivalent TypeScript `PromptObjectModel` instance — callers can use `addSection`, `findSection`, `renderMarkdown`, `renderXml`, `toJson`, `toYaml` exactly as in Python. The instance returned is a fresh snapshot built from the current `PomBuilder` state, so mutating it does not feed back into the agent's internal builder. To mutate the agent's prompt, use `promptAddSection` / `promptAddToSection` / `promptAddSubsection`. + + + + Port the server binds to. + + + + Static prompt sections: subclasses can define these declaratively. Each entry is applied via promptAddSection() in the constructor. + + + + Public accessor for the PromptManager (POM). Python exposes `self.pom` as a public attribute. This getter provides equivalent access for direct POM manipulation. + + + + HTTP route path. + + + + Schema validation utilities. Mirrors Python's `self.schema_utils`. + + + + Unified security configuration. Mirrors Python's `self.security`. + + + + Public read-only accessor for the SkillManager. Python exposes `self.skill_manager` as a public attribute. This getter provides equivalent read access. + + + + Path to SSL certificate. Mirrors Python's `self.ssl_cert_path`. + + + + Whether SSL is enabled. Mirrors Python's `self.ssl_enabled`. + + + + Path to SSL private key. Mirrors Python's `self.ssl_key_path`. + + + + The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — addInternalFiller / setInternalFillers warn if you pass an unknown name. + + + + + + + + Custom verb handler registry. Mirrors Python's `self.verb_registry`. + + +## Methods + + + + Configure the answer verb (phase 2) with optional settings. + + + + Add a remote SWAIG function include reference. + + + + Add a single speech-recognition hint. + + + + Add multiple speech-recognition hints at once. + + + + Add internal filler phrases for a single internal function and language. + + + + Add a supported language to the AI configuration. + + + + Add an external MCP server for tool discovery and invocation. Tools are discovered via MCP protocol at session start and added to the AI's tool list. + + + + Add a pattern-based speech-recognition hint with find-and-replace behavior. + + + + Add a SWML verb to execute after the AI verb (phase 5). + + + + Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + + + + Add a SWML verb to execute before the answer phase (phase 1). + + + + Add a pronunciation override rule for the TTS engine. + + + + Add a new named section to the SWML document. Mirrors Python's `add_section()`. + + + + Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + + + + Add a skill by its registered name, looking it up in the global SkillRegistry. + + + + Add extra query parameters appended to all SWAIG webhook URLs. + + + + Add a verb to the SWML document. + + + + Add a verb to a specific named section. Mirrors Python's `add_verb_to_section()`. + + + + Return this agent's Hono app for mounting as a sub-router in an AgentServer. + + + + Automatically register common SIP usernames based on this agent's name and route. Derives cleaned variants (alphanumeric + underscore) and registers each via `registerSipUsername()`. + + + + Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` to fully replace the document for this request, or `null` to fall through to `setOnRequestCallback` or the static builder. + + + + Remove all post-AI verbs. + + + + Remove all post-answer verbs. + + + + Remove all pre-answer verbs. + + + + Clear all SWAIG query parameters. + + + + Create an InfoGathererAgent. + + + + Mint a per-call SWAIG-function token via the agent's SessionManager. + + + + Define or replace the contexts configuration for the AI verb. + + + + Register a SWAIG tool (function) that the AI can invoke during a call. + + + + Register the `start_questions` and `submit_answer` SWAIG tools. + + + + Register a SWAIG tool with a typed handler that receives named parameters instead of the standard `(args, rawData)` convention. + + + + Enable debug event webhooks for this agent. + + + + Register a callback function that determines routing based on POST data. + + + + Expose this agent's tools as an MCP server endpoint at /mcp. Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + + + + Enable SIP routing for this agent. + + + + Extract the SIP username from a request body's call.to field. + + + + Snapshot of all registered SWAIG functions keyed by name. (Python parity: `ToolRegistry.get_all_functions`.) + + + + Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + + + + Get the basic-auth credentials used by this agent. + + + + Get the underlying SwmlBuilder for direct manipulation. + + + + Get the contexts dictionary as serialised SWML, or null when no contexts have been defined yet. + + + + Get the SWML document as a dictionary. Alias for `renderSwml()` that matches Python's `get_document()` name. + + + + Get the full external URL of this agent, using the proxy base URL if available. + + + + Get a registered SWAIG function entry, or undefined. (Python parity: `ToolRegistry.get_function`.) + + + + Read the per-language `params` dict for a previously-added language. + + + + Get configured MCP servers (read-only copy). + + + + Get the agent's display name. + + + + Get the post-prompt text, if one has been set. + + + + Get the fully rendered main prompt text. + + + + Get the raw POM (Prompt Object Model) structure as an array of section data objects, when the agent is in POM mode and has at least one section. + + + + Get the raw prompt text whatever `setPromptText` stored, or null when no raw prompt has been set. + + + + Get a summary of all registered tools with their names, descriptions, and parameter schemas. Lifted from AgentBase so the swaig-test CLI can list tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG host). + + + + Look up a registered SwaigFunction by name. Lifted from AgentBase so `swaig-test --exec ` works against a non-AgentBase SWMLService target. + + + + Public access to the list of registered tools. + + + + Handle an MCP JSON-RPC 2.0 request. Returns the response object. + + + + Whether a SWAIG function with the given name is registered. (Python parity: `ToolRegistry.has_function`.) + + + + Check whether a skill with the given name is registered. + + + + Whether a tool with the given name is registered. + + + + Check if MCP server endpoint is enabled. + + + + List all registered skills with their names, instance IDs, and initialization status. + + + + List registered tool names in insertion order (Map preserves it). + + + + Manually set the proxy base URL used for webhook URL generation. + + + + Lifecycle hook called when a debug event webhook is received. Override in subclasses. + + + + Hook called before each SWAIG function execution. Override in subclasses. + + + + Lifecycle hook called when SWML is requested. Default delegates to [onSwmlRequest](/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-swml-request) and returns its result. Subclasses typically override `onSwmlRequest` rather than this method. + + + + Lifecycle hook called when a post-prompt summary is received. Override in subclasses. + + + + Handle dynamic configuration using the registered callback. Returns the per-request global\_data payload which AgentBase merges into the SWML response. Mirrors Python's `on_swml_request` return-dict contract. + + + + Add a new section to the prompt with optional body, bullets, and subsections. + + + + Add a subsection under an existing prompt section. + + + + Append content to an existing prompt section. + + + + Check whether a prompt section with the given title exists. + + + + Extension point: register additional Hono routes after SWMLService mounts /health, /ready, /swaig, and the main route. AgentBase uses this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + + + + Register a callback at a specific HTTP path that decides how to route an incoming request. + + + + Register a SIP username to route to this agent. + + + + Register a SwaigFunction instance or a raw function descriptor (DataMap). + + + + Register a custom verb handler. Mirrors Python's `register_verb_handler()`. + + + + Remove a registered SWAIG function. Returns true when removed, false when not found. (Python parity: `ToolRegistry.remove_function`.) + + + + Remove a previously added skill by its instance ID. + + + + Remove a skill by its name (Python parity). + + + + Render the SWML document as a JSON string. Mirrors Python's `render_document()`. + + + + Render the complete SWML document by assembling all 5 phases: pre-answer, answer, post-answer, AI, and post-AI verbs. + + + + Remove all contexts, returning the agent to a no-contexts state. + + + + Reset the SWML document to an empty state. Mirrors Python's `reset_document()`. + + + + Alias for [serve](/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/serve). Starts the HTTP server. + + + + Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + + + + Start the HTTP server and begin listening for requests. + + + + Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + + + + Replace the entire list of function includes. Each include must have a `url` and `functions` array. + + + + Merge data into the global\_data object passed into the AI configuration. + + + + Set internal fillers for native SWAIG functions. + + + + Set (or replace) the per-language `params` dict on an already-added language. Useful when language entries are built up via [addLanguage](/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-language) first and engine-specific tuning is added later (e.g., from a config loader). + + + + Replace all configured languages with a new list. + + + + Set the list of native SWAIG function names (built-in platform functions). + + + + Set a callback invoked per-request to dynamically build SWML. When set, the static SwmlBuilder is ignored and the callback's returned SwmlBuilder is used instead. + + + + Set a single AI parameter (e.g. "temperature", "top\_p"). + + + + Merge multiple AI parameters into the existing params object. + + + + Set the post-prompt text evaluated after the call ends. + + + + Merge LLM-specific parameters into the post-prompt configuration. + + + + Override the default post-prompt webhook URL with a custom one. + + + + Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + + + + Set the prompt as a POM (Prompt Object Model) dictionary. + + + + Set the main system prompt text for the AI. + + + + Replace all pronunciation rules with a new list. + + + + Register a callback for dynamic question configuration. The callback is invoked on each incoming SWML request with the query params, body, and headers, and must return the list of questions to ask on that call. Mirrors Python `set_question_callback`. + + + + Register process signal handlers for clean Kubernetes/Docker shutdown. Handles SIGTERM and SIGINT, waits for a timeout, then exits. + + + + Override the default SWAIG webhook URL with a custom one. + + + + Stop the HTTP server. Mirrors Python's `stop()`. + + + + Extension point: invoked between argument parsing and function dispatch on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is non-null, it's returned directly without dispatching. AgentBase may override to add session-token validation or ephemeral dynamic-config. + + + + Merge additional entries into the existing global\_data object. + + + + Override to add custom basic-auth validation logic beyond credential matching. + + + + Validate a tool-call token for the given function. + + + +## Source + +[`src/prefabs/InfoGathererAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts) + +Line 107. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/is-mcp-server-enabled.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/is-mcp-server-enabled.mdx new file mode 100644 index 0000000000..594778a0ee --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/is-mcp-server-enabled.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/is-mcp-server-enabled" +title: "isMcpServerEnabled" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.isMcpServerEnabled" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `isMcpServerEnabled` + +Check if MCP server endpoint is enabled. + +## Signature + +```typescript +isMcpServerEnabled(): boolean +``` + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1165. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/list-skills.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/list-skills.mdx new file mode 100644 index 0000000000..8e48e27814 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/list-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/list-skills" +title: "listSkills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.listSkills" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `listSkills` + +List all registered skills with their names, instance IDs, and initialization status. + +## Signature + +```typescript +listSkills(): { initialized: boolean; instanceId: string; name: string }[] +``` + +## Returns + +`{ initialized: boolean; instanceId: string; name: string }[]` — Array of skill descriptors. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1648. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/list-tool-names.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/list-tool-names.mdx new file mode 100644 index 0000000000..185dc7c20b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/list-tool-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/list-tool-names" +title: "listToolNames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.listToolNames" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `listToolNames` + +List registered tool names in insertion order (Map preserves it). + +## Signature + +```typescript +listToolNames(): string[] +``` + +## Returns + +`string[]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 545. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/manual-set-proxy-url.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..4cbdfbf6ea --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/manual-set-proxy-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/manual-set-proxy-url" +title: "manualSetProxyUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.manualSetProxyUrl" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `manualSetProxyUrl` + +Manually set the proxy base URL used for webhook URL generation. + +## Signature + +```typescript +manualSetProxyUrl(url: string): this +``` + +## Parameters + + + The external-facing base URL (trailing slashes are stripped). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1735. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-debug-event.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-debug-event.mdx new file mode 100644 index 0000000000..c08a51e54d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-debug-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-debug-event" +title: "onDebugEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.onDebugEvent" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onDebugEvent` + +Lifecycle hook called when a debug event webhook is received. Override in subclasses. + +## Signature + +```typescript +onDebugEvent(_event: Record): void | Promise +``` + +## Parameters + + + The debug event payload. + + +## Returns + +`void | Promise` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1951. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-function-call.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-function-call.mdx new file mode 100644 index 0000000000..c907ddf82b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-function-call.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-function-call" +title: "onFunctionCall" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.onFunctionCall" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onFunctionCall` + +Hook called before each SWAIG function execution. Override in subclasses. + +**Behavioral note:** In the Python SDK, `on_function_call` IS the dispatcher +— it retrieves and executes the function, returning the result. In TypeScript, +`fn.execute()` is called separately after this hook. However, if this method +returns a non-void value, it is used as the result and the default execution +is skipped, enabling dispatch interception parity with Python. + +## Signature + +```typescript +onFunctionCall( + _name: string, + _args: Record, + _rawData: Record +): void | Record | Promise> +``` + +## Parameters + + + Name of the function about to execute. + + + + Parsed arguments for the function. + + + + The full raw SWAIG request payload. + + +## Returns + +`void | Record | Promise>` — Optionally a result dict to short-circuit default execution, or void/undefined to proceed normally. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1980. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-request.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-request.mdx new file mode 100644 index 0000000000..0ebf82f157 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-request.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-request" +title: "onRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.onRequest" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onRequest` + +Lifecycle hook called when SWML is requested. Default delegates to +[onSwmlRequest](/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-swml-request) and returns its result. Subclasses typically +override `onSwmlRequest` rather than this method. + +Matches Python `WebMixin.on_request(request_data, callback_path)`. The +cross-language API is the two-arg form; the Hono `context` argument is +a TypeScript-side extra preserved for callers that already have it but +is not part of the audited surface. + +## Signature + +```typescript +onRequest( + requestData?: Record | null, + callbackPath?: string | null +): void | Record | Promise> +``` + +## Parameters + + + The parsed request body. + + + + Optional callback path from the request. + + +## Returns + +`void | Record | Promise>` — Optionally a dict of SWML modifications, or undefined for default rendering. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1916. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-summary.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-summary.mdx new file mode 100644 index 0000000000..6f13df7ad5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-summary.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-summary" +title: "onSummary" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.onSummary" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onSummary` + +Lifecycle hook called when a post-prompt summary is received. Override in subclasses. + +Invoked once at the end of a call when the AI has produced a structured summary +(configured via `setPostPrompt()` / `setPostPromptJson()`). Use this hook to persist +call data, notify other systems, or trigger follow-up workflows. + +## Signature + +```typescript +onSummary( + _summary: Record | null, + _rawData: Record +): void | Promise +``` + +## Parameters + + + Parsed summary object (JSON when the post-prompt requests structured output), or `null` if extraction/parsing failed. + + + + Full raw post-prompt payload received from the platform, including call metadata, conversation history, and the summary text. + + +## Returns + +`void | Promise` + +## Examples + +```typescript +class MyAgent extends AgentBase { + async onSummary(summary, rawData) { + if (!summary) return; + await db.calls.insert({ + callSid: rawData.call_id, + summary, + endedAt: new Date(), + }); + } +} +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1897. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-swml-request.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-swml-request.mdx new file mode 100644 index 0000000000..0b948297e1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-swml-request.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/on-swml-request" +title: "onSwmlRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.onSwmlRequest" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts" +--- +# `onSwmlRequest` + +Handle dynamic configuration using the registered callback. Returns the +per-request global\_data payload which AgentBase merges into the SWML +response. Mirrors Python's `on_swml_request` return-dict contract. + +## Signature + +```typescript +onSwmlRequest( + rawData: Record +): Promise> +``` + +## Parameters + + + +## Returns + +`Promise>` + +## Source + +[`src/prefabs/InfoGathererAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts) + +Line 223. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-section.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-section.mdx new file mode 100644 index 0000000000..cee1cd836a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-section.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-section" +title: "promptAddSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.promptAddSection" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSection` + +Add a new section to the prompt with optional body, bullets, and subsections. + +## Signature + +```typescript +promptAddSection(title: string, opts?: { ...5 fields }): this +``` + +## Parameters + + + Section heading. + + + + Optional section content including body text, bullet points, and subsections. + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 466. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-subsection.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-subsection.mdx new file mode 100644 index 0000000000..3b5333874e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-subsection.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-subsection" +title: "promptAddSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.promptAddSubsection" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSubsection` + +Add a subsection under an existing prompt section. + +## Signature + +```typescript +promptAddSubsection( + parentTitle: string, + title: string, + opts?: { ...2 fields } +): this +``` + +## Parameters + + + Title of the parent section. + + + + Title of the new subsection. + + + + Optional body text and bullet points for the subsection. + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 501. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-to-section.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-to-section.mdx new file mode 100644 index 0000000000..e4a9f309d2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-to-section.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-add-to-section" +title: "promptAddToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.promptAddToSection" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddToSection` + +Append content to an existing prompt section. + +## Signature + +```typescript +promptAddToSection(title: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + Title of the section to append to. + + + + Content to add: body text, a single bullet, or multiple bullets. + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-has-section.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-has-section.mdx new file mode 100644 index 0000000000..f478a62b79 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-has-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/prompt-has-section" +title: "promptHasSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.promptHasSection" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptHasSection` + +Check whether a prompt section with the given title exists. + +## Signature + +```typescript +promptHasSection(title: string): boolean +``` + +## Parameters + + + Section title to look for. + + +## Returns + +`boolean` — True if the section exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-additional-routes.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-additional-routes.mdx new file mode 100644 index 0000000000..d2ac265f55 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-additional-routes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-additional-routes" +title: "registerAdditionalRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.registerAdditionalRoutes" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `registerAdditionalRoutes` + +Extension point: register additional Hono routes after SWMLService +mounts /health, /ready, /swaig, and the main route. AgentBase uses +this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + +## Signature + +```typescript +registerAdditionalRoutes(_app: Hono): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 604. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-routing-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-routing-callback.mdx new file mode 100644 index 0000000000..c135ab168d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-routing-callback.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-routing-callback" +title: "registerRoutingCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.registerRoutingCallback" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerRoutingCallback` + +Register a callback at a specific HTTP path that decides how to route an +incoming request. + +When called, the endpoint at `path` will invoke `callback` with the parsed +request body. If `callback` returns a non-empty route string the server +responds with `{ action: "redirect", route }` so the platform can forward the +request to the right agent. If `callback` returns `null` / `undefined` the +agent's own SWML is returned instead (normal processing). + +Mirrors Python `swml_service.register_routing_callback` / +`web_mixin.register_routing_callback`. + +## Signature + +```typescript +registerRoutingCallback(callback: RoutingCallback, path: string = '/sip'): this +``` + +## Parameters + + + Function receiving the parsed request body and returning a route string to redirect, or null/undefined for normal processing. + + + + HTTP path where this callback endpoint is registered (default: '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1101. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-sip-username.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-sip-username.mdx new file mode 100644 index 0000000000..4dfdfc7313 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-sip-username.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-sip-username" +title: "registerSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.registerSipUsername" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerSipUsername` + +Register a SIP username to route to this agent. + +## Signature + +```typescript +registerSipUsername(username: string): this +``` + +## Parameters + + + The SIP username to register. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1039. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-swaig-function.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-swaig-function.mdx new file mode 100644 index 0000000000..c4b30d66b0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-swaig-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-swaig-function" +title: "registerSwaigFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.registerSwaigFunction" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerSwaigFunction` + +Register a SwaigFunction instance or a raw function descriptor (DataMap). + +## Signature + +```typescript +registerSwaigFunction(fn: Record | SwaigFunction): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 472. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-verb-handler.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-verb-handler.mdx new file mode 100644 index 0000000000..6e3f4dbda0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-verb-handler.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/register-verb-handler" +title: "registerVerbHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.registerVerbHandler" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerVerbHandler` + +Register a custom verb handler. +Mirrors Python's `register_verb_handler()`. + +## Signature + +```typescript +registerVerbHandler(handler: SWMLVerbHandler): void +``` + +## Parameters + + + The verb handler to register. + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 726. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-function.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-function.mdx new file mode 100644 index 0000000000..2277cc8228 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-function" +title: "removeFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.removeFunction" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `removeFunction` + +Remove a registered SWAIG function. Returns true when removed, +false when not found. (Python parity: +`ToolRegistry.remove_function`.) + +## Signature + +```typescript +removeFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 540. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-skill-by-name.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-skill-by-name.mdx new file mode 100644 index 0000000000..d3a4b5a03b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-skill-by-name.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-skill-by-name" +title: "removeSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.removeSkillByName" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkillByName` + +Remove a skill by its name (Python parity). + +Python's `remove_skill(skill_name)` removes by skill name. +The existing `removeSkill(instanceId)` removes by instance ID. +This method provides name-based removal for cross-SDK parity. + +## Signature + +```typescript +removeSkillByName(skillName: string): Promise +``` + +## Parameters + + + The skill name to remove. + + +## Returns + +`Promise` — True if a skill with that name was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1671. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-skill.mdx new file mode 100644 index 0000000000..bdd74893aa --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/remove-skill" +title: "removeSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.removeSkill" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkill` + +Remove a previously added skill by its instance ID. + +## Signature + +```typescript +removeSkill(instanceId: string): Promise +``` + +## Parameters + + + The unique instance ID of the skill to remove. + + +## Returns + +`Promise` — True if the skill was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1640. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/render-document.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/render-document.mdx new file mode 100644 index 0000000000..00a9402ff2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/render-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/render-document" +title: "renderDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.renderDocument" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `renderDocument` + +Render the SWML document as a JSON string. +Mirrors Python's `render_document()`. + +## Signature + +```typescript +renderDocument(): string +``` + +## Returns + +`string` — JSON-encoded SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 715. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/render-swml.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/render-swml.mdx new file mode 100644 index 0000000000..1cca6052e1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/render-swml.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/render-swml" +title: "renderSwml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.renderSwml" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `renderSwml` + +Render the complete SWML document by assembling all 5 phases: pre-answer, answer, +post-answer, AI, and post-AI verbs. + +## Signature + +```typescript +renderSwml(callId?: string, modifications?: Record): string +``` + +## Parameters + + + Optional call ID to use for session tokens; auto-generated if omitted. + + + + Optional dict returned from `onSwmlRequest` to merge into the AI verb config before rendering. Matches Python's `_render_swml(modifications)` semantics: `global_data` is deep-merged; all other keys override the AI config directly. + + +## Returns + +`string` — The rendered SWML document as a JSON string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2000. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/reset-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/reset-contexts.mdx new file mode 100644 index 0000000000..655feecfeb --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/reset-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/reset-contexts" +title: "resetContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.resetContexts" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `resetContexts` + +Remove all contexts, returning the agent to a no-contexts state. + +This is a convenience wrapper around `defineContexts().reset()`. +Use it in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```typescript +resetContexts(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 624. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/reset-document.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/reset-document.mdx new file mode 100644 index 0000000000..fd2122104c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/reset-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/reset-document" +title: "resetDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.resetDocument" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `resetDocument` + +Reset the SWML document to an empty state. +Mirrors Python's `reset_document()`. + +## Signature + +```typescript +resetDocument(): this +``` + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 679. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/run-serverless.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/run-serverless.mdx new file mode 100644 index 0000000000..814a7e938c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/run-serverless.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/run-serverless" +title: "runServerless" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.runServerless" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `runServerless` + +Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + +Matches Python `run(event, context)` when executed in a serverless environment. Python's +`run()` auto-detects the platform via `get_execution_mode()` and dispatches accordingly; +in TypeScript the serverless path is an **explicit** method so that `run()` keeps its +HTTP-server semantics and callers opt in to serverless dispatch deliberately. + +Platform detection follows the same environment-variable heuristics as Python's +`ServerlessMixin`: `AWS_LAMBDA_FUNCTION_NAME` → Lambda, `K_SERVICE` → GCF, +`FUNCTIONS_WORKER_RUNTIME` → Azure, `GATEWAY_INTERFACE` → CGI. + +Usage in a Lambda handler file: + +```ts +export const handler = (event: any, context: any) => agent.runServerless(event, context); +``` + +## Signature + +```typescript +runServerless( + event: ServerlessEvent, + context?: unknown, + platform?: "lambda" | "gcf" | "azure" | "cgi" | "auto" +): Promise +``` + +## Parameters + + + The serverless event payload (Lambda event, GCF request body, etc.). + + + + The serverless context object (Lambda context, Azure context, etc.). + + + + Optional platform override; defaults to 'auto' (environment detection). + + +## Returns + +`Promise` — The normalized serverless response object. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2709. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/run.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/run.mdx new file mode 100644 index 0000000000..c564a6d365 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/run.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/run" +title: "run" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.run" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `run` + +Alias for [serve](/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/serve). Starts the HTTP server. + +## Signature + +```typescript +run(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host and port overrides. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server is running. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2683. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/serve.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/serve.mdx new file mode 100644 index 0000000000..55734f06b2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/serve.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/serve" +title: "serve" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.serve" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `serve` + +Start the HTTP server and begin listening for requests. + +Uses `@hono/node-server` under the hood. When run in CLI mode +(`SWAIG_CLI_MODE=true`, set automatically by `npx swaig-test`), this is a +no-op so agent config can be inspected without starting a server. + +## Signature + +```typescript +serve(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host/port overrides. Defaults to the values provided in the constructor options or the `PORT` environment variable. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server has begun listening. + +## Examples + +```typescript +const agent = new AgentBase({ name: 'demo', port: 3000 }); +await agent.serve(); +// Or override at runtime: +await agent.serve({ port: 8080, host: '127.0.0.1' }); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2660. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..d8afcd8a35 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-dynamic-config-callback.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-dynamic-config-callback" +title: "setDynamicConfigCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setDynamicConfigCallback" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setDynamicConfigCallback` + +Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + +The callback receives a clone of this agent — mutations apply only to the current +request, so you can vary prompt, tools, languages, params, or global data per call +without affecting the long-lived agent instance. + +## Signature + +```typescript +setDynamicConfigCallback(cb: DynamicConfigCallback): this +``` + +## Parameters + + + Callback receiving `(queryParams, bodyParams, headers, agent)` where `agent` is the ephemeral `AgentBase` copy to mutate. May be async. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setDynamicConfigCallback((query, body, headers, agent) => { + const lang = query.lang ?? 'en'; + if (lang === 'es') { + (agent as AgentBase).setPromptText('Eres un asistente útil.'); + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1704. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-function-includes.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-function-includes.mdx new file mode 100644 index 0000000000..610334f644 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-function-includes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-function-includes" +title: "setFunctionIncludes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setFunctionIncludes" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setFunctionIncludes` + +Replace the entire list of function includes. +Each include must have a `url` and `functions` array. + +## Signature + +```typescript +setFunctionIncludes(includes: FunctionInclude[]): this +``` + +## Parameters + + + Array of function include objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 978. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-global-data.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-global-data.mdx new file mode 100644 index 0000000000..e899453a1d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-global-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-global-data" +title: "setGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setGlobalData" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setGlobalData` + +Merge data into the global\_data object passed into the AI configuration. + +Matches Python `set_global_data` which calls `.update()` on the internal dict — +existing keys are preserved; incoming keys overwrite on collision. Skills and +other callers can each contribute keys without clobbering one another. + +If you need to replace the entire object, assign a new agent instance or use +`Object.assign(agent.globalData, {})` to clear first. + +## Signature + +```typescript +setGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 827. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-internal-fillers.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-internal-fillers.mdx new file mode 100644 index 0000000000..00e6ff7a8f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-internal-fillers.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-internal-fillers" +title: "setInternalFillers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setInternalFillers" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setInternalFillers` + +Set internal fillers for native SWAIG functions. + +Internal fillers are short phrases the AI agent speaks (via TTS) while +an internal/native function is running, so the caller doesn't hear +dead air during transitions or background work. + +Supported function names (matches the SWAIGInternalFiller schema): + +hangup — when the agent is hanging up +check\_time — when checking the time +wait\_for\_user — when waiting for user input +wait\_seconds — during deliberate pauses +adjust\_response\_latency — when adjusting response timing +next\_step — transitioning between steps in prompt.contexts +change\_context — switching between contexts in prompt.contexts +get\_visual\_input — processing visual input (enable\_vision=true) +get\_ideal\_strategy — thinking (enable\_thinking=true) + +Notably NOT supported: change\_step, gather\_submit, or arbitrary +user-defined SWAIG function names. The runtime only honors fillers +for the names listed above; everything else is silently ignored at +the SWML level. This method warns at registration time if you pass +an unknown name so you catch the typo early. + +## Signature + +```typescript +setInternalFillers( + internalFillers: Record> +): this +``` + +## Parameters + + + Map of function name to language-keyed filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setInternalFillers({ + next_step: { + 'en-US': ['Moving to the next step...', 'Great, let us continue...'], + 'es': ['Pasando al siguiente paso...'] + }, + check_time: { + 'en-US': ['Let me check the time...'] + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 909. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-language-params.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-language-params.mdx new file mode 100644 index 0000000000..5587ea3bac --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-language-params.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-language-params" +title: "setLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setLanguageParams" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguageParams` + +Set (or replace) the per-language `params` dict on an already-added +language. Useful when language entries are built up via [addLanguage](/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-language) +first and engine-specific tuning is added later (e.g., from a config +loader). + +Python parity: `set_language_params(code, params)`. Passing an empty +object removes the `params` key entirely. Unknown codes are a no-op. + +## Signature + +```typescript +setLanguageParams(code: string, params: Record): this +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/add-language) (e.g. `"en-US"`). + + + + Engine-specific params dict to attach. Empty object removes the key. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 736. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-languages.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-languages.mdx new file mode 100644 index 0000000000..806b921eaa --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-languages.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-languages" +title: "setLanguages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setLanguages" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguages` + +Replace all configured languages with a new list. + +## Signature + +```typescript +setLanguages(languages: LanguageConfig[]): this +``` + +## Parameters + + + Array of language configurations. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 717. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-native-functions.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-native-functions.mdx new file mode 100644 index 0000000000..ff7940dda0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-native-functions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-native-functions" +title: "setNativeFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setNativeFunctions" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setNativeFunctions` + +Set the list of native SWAIG function names (built-in platform functions). + +## Signature + +```typescript +setNativeFunctions(funcs: string[]): this +``` + +## Parameters + + + Array of native function names. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 847. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-on-request-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-on-request-callback.mdx new file mode 100644 index 0000000000..e3986144fb --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-on-request-callback.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-on-request-callback" +title: "setOnRequestCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setOnRequestCallback" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `setOnRequestCallback` + +Set a callback invoked per-request to dynamically build SWML. +When set, the static SwmlBuilder is ignored and the callback's +returned SwmlBuilder is used instead. + +## Signature + +```typescript +setOnRequestCallback(cb: OnRequestCallback): this +``` + +## Parameters + + + Callback receiving query params, body params, and headers. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 850. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-param.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-param.mdx new file mode 100644 index 0000000000..6b443b055f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-param.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-param" +title: "setParam" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setParam" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParam` + +Set a single AI parameter (e.g. "temperature", "top\_p"). + +## Signature + +```typescript +setParam(key: string, value: unknown): this +``` + +## Parameters + + + Parameter name. + + + + Parameter value. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 799. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-params.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-params.mdx new file mode 100644 index 0000000000..618622ab18 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-params" +title: "setParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setParams" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParams` + +Merge multiple AI parameters into the existing params object. + +## Signature + +```typescript +setParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 809. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..351a729aaa --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt-llm-params" +title: "setPostPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setPostPromptLlmParams" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptLlmParams` + +Merge LLM-specific parameters into the post-prompt configuration. + +## Signature + +```typescript +setPostPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1000. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt-url.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt-url.mdx new file mode 100644 index 0000000000..d8c88094cd --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt-url" +title: "setPostPromptUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setPostPromptUrl" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptUrl` + +Override the default post-prompt webhook URL with a custom one. + +## Signature + +```typescript +setPostPromptUrl(url: string): this +``` + +## Parameters + + + The custom post-prompt URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1828. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt.mdx new file mode 100644 index 0000000000..410882e3ca --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-post-prompt" +title: "setPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setPostPrompt" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPrompt` + +Set the post-prompt text evaluated after the call ends. + +## Signature + +```typescript +setPostPrompt(text: string): this +``` + +## Parameters + + + The post-prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 455. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..5f8e68b678 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-llm-params" +title: "setPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setPromptLlmParams" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptLlmParams` + +Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + +## Signature + +```typescript +setPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 990. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-pom.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-pom.mdx new file mode 100644 index 0000000000..adc81fac8d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-pom.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-pom" +title: "setPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setPromptPom" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptPom` + +Set the prompt as a POM (Prompt Object Model) dictionary. + +Replaces the current POM sections with the provided structured data. +Each entry should have `title`, and optionally `body`, `bullets`, +`numbered`, `numberedBullets`, and `subsections`. + +## Signature + +```typescript +setPromptPom(pom: Record[]): this +``` + +## Parameters + + + Array of POM section dictionaries. + + +## Returns + +`this` — This agent instance for chaining. + +## Throws + +- Error if POM mode is not enabled (`usePom: false`). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 576. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-text.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-text.mdx new file mode 100644 index 0000000000..8ef88d882a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-text.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-prompt-text" +title: "setPromptText" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setPromptText" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptText` + +Set the main system prompt text for the AI. + +## Signature + +```typescript +setPromptText(text: string): this +``` + +## Parameters + + + The prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 445. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-pronunciations.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-pronunciations.mdx new file mode 100644 index 0000000000..97280ce6c6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-pronunciations.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-pronunciations" +title: "setPronunciations" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setPronunciations" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPronunciations` + +Replace all pronunciation rules with a new list. + +## Signature + +```typescript +setPronunciations(rules: PronunciationRule[]): this +``` + +## Parameters + + + Array of pronunciation rule objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 785. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-question-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-question-callback.mdx new file mode 100644 index 0000000000..aa9d07f289 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-question-callback.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-question-callback" +title: "setQuestionCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setQuestionCallback" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts" +--- +# `setQuestionCallback` + +Register a callback for dynamic question configuration. The callback is +invoked on each incoming SWML request with the query params, body, and +headers, and must return the list of questions to ask on that call. +Mirrors Python `set_question_callback`. + +## Signature + +```typescript +setQuestionCallback(callback: InfoGathererQuestionCallback): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/prefabs/InfoGathererAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts) + +Line 159. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-web-hook-url.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-web-hook-url.mdx new file mode 100644 index 0000000000..6f2e0a83ab --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-web-hook-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/set-web-hook-url" +title: "setWebHookUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setWebHookUrl" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setWebHookUrl` + +Override the default SWAIG webhook URL with a custom one. + +## Signature + +```typescript +setWebHookUrl(url: string): this +``` + +## Parameters + + + The custom webhook URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1818. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/setup-graceful-shutdown.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/setup-graceful-shutdown.mdx new file mode 100644 index 0000000000..13bc5b26ca --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/setup-graceful-shutdown.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/setup-graceful-shutdown" +title: "setupGracefulShutdown" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.setupGracefulShutdown" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setupGracefulShutdown` + +Register process signal handlers for clean Kubernetes/Docker shutdown. +Handles SIGTERM and SIGINT, waits for a timeout, then exits. + +**Modifiers:** `static` + +## Signature + +```typescript +setupGracefulShutdown(opts?: { ...1 fields }): void +``` + +## Parameters + + + Optional timeout in milliseconds (default 5000). + + + + +## Returns + +`void` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2732. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/stop.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/stop.mdx new file mode 100644 index 0000000000..2a6b12c19e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.stop" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `stop` + +Stop the HTTP server. +Mirrors Python's `stop()`. + +## Signature + +```typescript +stop(): void +``` + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 1009. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..6b5bd78e1e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/swaig-pre-dispatch.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/swaig-pre-dispatch" +title: "swaigPreDispatch" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.swaigPreDispatch" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `swaigPreDispatch` + +Extension point: invoked between argument parsing and function dispatch +on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is +non-null, it's returned directly without dispatching. AgentBase may +override to add session-token validation or ephemeral dynamic-config. + +## Signature + +```typescript +swaigPreDispatch( + _requestData: Record, + _funcName: string +): [SWMLService, unknown] +``` + +## Parameters + + + + + +## Returns + +`[SWMLService, unknown]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 592. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/update-global-data.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/update-global-data.mdx new file mode 100644 index 0000000000..9189cc67ef --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/update-global-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/update-global-data" +title: "updateGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.updateGlobalData" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `updateGlobalData` + +Merge additional entries into the existing global\_data object. + +## Signature + +```typescript +updateGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 837. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/validate-basic-auth.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/validate-basic-auth.mdx new file mode 100644 index 0000000000..a2a4839ce3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/validate-basic-auth.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/validate-basic-auth" +title: "validateBasicAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.validateBasicAuth" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateBasicAuth` + +Override to add custom basic-auth validation logic beyond credential matching. + +## Signature + +```typescript +validateBasicAuth( + _username: string, + _password: string +): boolean | Promise +``` + +## Parameters + + + The username from the request. + + + + The password from the request. + + +## Returns + +`boolean | Promise` — True if the credentials are valid; false to reject the request. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1961. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/validate-tool-token.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/validate-tool-token.mdx new file mode 100644 index 0000000000..7b853da6a0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/validate-tool-token.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-agent/validate-tool-token" +title: "validateToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererAgent.validateToolToken" + parent: "prefabs.InfoGathererAgent.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateToolToken` + +Validate a tool-call token for the given function. + +Mirrors Python reference `core/mixins/state_mixin.py validate_tool_token`: + +1. Unknown function → `false`. +2. Registered but non-secure → `true` without consulting SessionManager + (non-secure tools never require a token). +3. Raw-dict descriptors (e.g. DataMap) are treated as secure, matching + Python's `isinstance(func, dict) → is_secure = True` branch. +4. Missing token on a secure tool → `false`. +5. Otherwise delegate to `SessionManager.validateToolToken`. + +Divergences from the Python reference: + +- No debug-logging branch: `AgentBase` does not expose an agent-level + debug-mode flag, so the per-call debug telemetry Python emits is + omitted. `SessionManager` still logs its own validation outcomes. +- No token-derived call-id fallback: `SessionManager.debugToken` + truncates the embedded call-id for log safety, so an extracted value + cannot be round-tripped back through `validateToolToken`. The caller + is expected to supply a non-empty `callId`; an empty one is forwarded + unchanged and the underlying validator will reject it. + +## Signature + +```typescript +validateToolToken(functionName: string, token: string, callId: string): boolean +``` + +## Parameters + + + + + + + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1447. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-config/index.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-config/index.mdx new file mode 100644 index 0000000000..e47ce8093e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-config/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-config" +title: "InfoGathererConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererConfig" + parent: "prefabs.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts" +--- +# `InfoGathererConfig` + +Configuration for the InfoGathererAgent. + +## Signature + +```typescript +interface InfoGathererConfig +``` + +## Properties + + + Additional AgentBase options forwarded to super(). + + + + Agent display name (defaults to `"info_gatherer"`). + + + + Convenience alternative to calling `setQuestionCallback()` after construction. Only consulted when `questions` is not provided. + + + + Optional list of questions to ask. When omitted, the agent runs in dynamic mode and resolves questions via the callback registered with `setQuestionCallback()` (or via `questionCallback` below). + + + + HTTP route for this agent (defaults to `"/info_gatherer"`). + + +## Source + +[`src/prefabs/InfoGathererAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts) + +Line 38. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-question-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-question-callback.mdx new file mode 100644 index 0000000000..6b7804032f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-question-callback.mdx @@ -0,0 +1,30 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-question-callback" +title: "InfoGathererQuestionCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererQuestionCallback" + parent: "prefabs.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts" +--- +# `InfoGathererQuestionCallback` + +Callback invoked on each incoming SWML request to produce the list of +questions for that request. Mirrors Python's `set_question_callback`. + +## Signature + +```typescript +type InfoGathererQuestionCallback = (queryParams: Record, bodyParams: Record, headers: Record) => InfoGathererQuestion[] | Promise +``` + +## Source + +[`src/prefabs/InfoGathererAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts) + +Line 31. diff --git a/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-question/index.mdx b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-question/index.mdx new file mode 100644 index 0000000000..4c3f6b05d0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/info-gatherer-agent/info-gatherer-question/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/info-gatherer-agent/info-gatherer-question" +title: "InfoGathererQuestion" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "prefabs.InfoGathererAgent.InfoGathererQuestion" + parent: "prefabs.InfoGathererAgent" + module: "prefabs.InfoGathererAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts" +--- +# `InfoGathererQuestion` + +A single question in the information-gathering flow. + +## Signature + +```typescript +interface InfoGathererQuestion +``` + +## Properties + + + When true, the agent insists the caller confirms before submitting. + + + + Identifier used as the key when storing the caller's answer. + + + + The question text to ask the caller. + + +## Source + +[`src/prefabs/InfoGathererAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/InfoGathererAgent.ts) + +Line 17. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/create-receptionist-agent.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/create-receptionist-agent.mdx new file mode 100644 index 0000000000..e106e6d8a0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/create-receptionist-agent.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/create-receptionist-agent" +title: "createReceptionistAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.createReceptionistAgent" + parent: "prefabs.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts" +--- +# `createReceptionistAgent` + +Factory function that creates and returns a new ReceptionistAgent. + +## Signature + +```typescript +createReceptionistAgent(config: ReceptionistConfig): ReceptionistAgent +``` + +## Parameters + + + Configuration for the receptionist agent. + + +## Returns + +`ReceptionistAgent` — A configured ReceptionistAgent instance. + +## Source + +[`src/prefabs/ReceptionistAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts) + +Line 391. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/index.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/index.mdx new file mode 100644 index 0000000000..306a06f23e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent" +title: "ReceptionistAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent" + module: "prefabs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts" +--- +# `ReceptionistAgent` + +## Signature + +```typescript +module ReceptionistAgent +``` + +## Functions + + + + Factory function that creates and returns a new ReceptionistAgent. + + + +## Classes + + + + Prefab agent that greets callers, collects basic information, and transfers them to the correct department. + + + +## Interfaces + + + + Configuration for the [ReceptionistAgent](/reference/typescript/prefabs/receptionist-agent/receptionist-agent). + + + + A department the receptionist can route callers to. + + + +## Source + +[`src/prefabs/ReceptionistAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-answer-verb.mdx new file mode 100644 index 0000000000..54b9b3a5bc --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-answer-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-answer-verb" +title: "addAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addAnswerVerb" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addAnswerVerb` + +Configure the answer verb (phase 2) with optional settings. + +## Signature + +```typescript +addAnswerVerb(config?: Record): this +``` + +## Parameters + + + Optional answer verb configuration. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1493. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-function-include.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-function-include.mdx new file mode 100644 index 0000000000..496207261e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-function-include.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-function-include" +title: "addFunctionInclude" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addFunctionInclude" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addFunctionInclude` + +Add a remote SWAIG function include reference. + +## Signature + +```typescript +addFunctionInclude( + url: string, + functions: string[], + metaData?: Record +): this +``` + +## Parameters + + + URL of the remote SWAIG endpoint. + + + + Function names available at that endpoint. + + + + Optional metadata to attach to the include. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 965. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-hint.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-hint.mdx new file mode 100644 index 0000000000..3d13519bbb --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-hint.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-hint" +title: "addHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addHint" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHint` + +Add a single speech-recognition hint. + +## Signature + +```typescript +addHint(hint: string): this +``` + +## Parameters + + + Word or phrase to boost in speech recognition. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 652. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-hints.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-hints.mdx new file mode 100644 index 0000000000..ba839b08d2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-hints.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-hints" +title: "addHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addHints" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHints` + +Add multiple speech-recognition hints at once. + +## Signature + +```typescript +addHints(hints: string[]): this +``` + +## Parameters + + + Array of words or phrases to boost. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 662. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-internal-filler.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-internal-filler.mdx new file mode 100644 index 0000000000..e4632eb775 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-internal-filler.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-internal-filler" +title: "addInternalFiller" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addInternalFiller" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addInternalFiller` + +Add internal filler phrases for a single internal function and language. + +See [setInternalFillers](/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-internal-fillers) for the complete list of supported +functionName values and an explanation of what fillers do. + +## Signature + +```typescript +addInternalFiller( + functionName: string, + languageCode: string, + fillers: string[] +): this +``` + +## Parameters + + + One of the supported internal function names (see SUPPORTED\_INTERNAL\_FILLER\_NAMES). Names outside the supported set log a warning and are ignored by the runtime. + + + + BCP-47 language code for the fillers (e.g. 'en-US'). + + + + Array of filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 942. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-language.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-language.mdx new file mode 100644 index 0000000000..5188237110 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-language.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-language" +title: "addLanguage" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addLanguage" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addLanguage` + +Add a supported language to the AI configuration. + +## Signature + +```typescript +addLanguage(config: LanguageConfig): this +``` + +## Parameters + + + Language configuration including name, code, voice, and optional fillers. `params` may be set to attach engine-specific tuning (voice stability, similarity boost, model knobs, etc.); only emitted into SWML when non-empty so existing entries stay byte-identical when no params are passed (Python ai\_config\_mixin.py `add_language`). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 693. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-mcp-server.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-mcp-server.mdx new file mode 100644 index 0000000000..494509b1ee --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-mcp-server.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-mcp-server" +title: "addMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addMcpServer" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addMcpServer` + +Add an external MCP server for tool discovery and invocation. +Tools are discovered via MCP protocol at session start and added to the AI's tool list. + +## Signature + +```typescript +addMcpServer(url: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + MCP server HTTP endpoint URL + + + + Optional configuration: headers, resources, resourceVars + + + + + + + + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1145. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pattern-hint.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pattern-hint.mdx new file mode 100644 index 0000000000..a536e64df1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pattern-hint.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pattern-hint" +title: "addPatternHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addPatternHint" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPatternHint` + +Add a pattern-based speech-recognition hint with find-and-replace behavior. + +## Signature + +```typescript +addPatternHint(opts: { ...4 fields }): this +``` + +## Parameters + + + Pattern hint configuration with a descriptive hint label, regex pattern, replacement string, and optional case-insensitive flag. + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 673. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-post-ai-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-post-ai-verb.mdx new file mode 100644 index 0000000000..21eba0140d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-post-ai-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-post-ai-verb" +title: "addPostAiVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addPostAiVerb" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAiVerb` + +Add a SWML verb to execute after the AI verb (phase 5). + +## Signature + +```typescript +addPostAiVerb(verbName: string, config: Record): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1515. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-post-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-post-answer-verb.mdx new file mode 100644 index 0000000000..eca5506efa --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-post-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-post-answer-verb" +title: "addPostAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addPostAnswerVerb" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAnswerVerb` + +Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + +## Signature + +```typescript +addPostAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1504. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pre-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..5da039efed --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pre-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pre-answer-verb" +title: "addPreAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addPreAnswerVerb" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPreAnswerVerb` + +Add a SWML verb to execute before the answer phase (phase 1). + +## Signature + +```typescript +addPreAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb (e.g. "play", "record"). + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1483. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pronunciation.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pronunciation.mdx new file mode 100644 index 0000000000..a1d8d49023 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pronunciation.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-pronunciation" +title: "addPronunciation" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addPronunciation" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPronunciation` + +Add a pronunciation override rule for the TTS engine. + +## Signature + +```typescript +addPronunciation(rule: PronunciationRule): this +``` + +## Parameters + + + Pronunciation rule specifying the text to replace and its substitute. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 773. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-section.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-section.mdx new file mode 100644 index 0000000000..ed1b711187 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addSection" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addSection` + +Add a new named section to the SWML document. +Mirrors Python's `add_section()`. + +## Signature + +```typescript +addSection(sectionName: string): this +``` + +## Parameters + + + Name of the section to create. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 653. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-skill-by-name.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-skill-by-name.mdx new file mode 100644 index 0000000000..e46f4978a6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-skill-by-name.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-skill-by-name" +title: "addSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addSkillByName" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkillByName` + +Add a skill by its registered name, looking it up in the global SkillRegistry. + +Matches Python's `add_skill(skill_name, params)` which loads skills by string +name via the SkillManager registry. Throws a `ValueError`-equivalent if the +skill name is not found in the registry. + +## Signature + +```typescript +addSkillByName( + skillName: string, + params?: SkillConfig +): Promise +``` + +## Parameters + + + The name the skill was registered under in the SkillRegistry. + + + + Optional configuration parameters forwarded to the skill factory. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Throws + +- Error if no skill with the given name is registered. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1627. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-skill.mdx new file mode 100644 index 0000000000..07cec58cd7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-skill" +title: "addSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addSkill" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkill` + +Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + +## Signature + +```typescript +addSkill(skill: SkillBase): Promise +``` + +## Parameters + + + The skill instance to add. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1562. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-swaig-query-params.mdx new file mode 100644 index 0000000000..4c1ee2baf1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-swaig-query-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-swaig-query-params" +title: "addSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addSwaigQueryParams" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSwaigQueryParams` + +Add extra query parameters appended to all SWAIG webhook URLs. + +## Signature + +```typescript +addSwaigQueryParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to append as query parameters. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1714. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-verb-to-section.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-verb-to-section.mdx new file mode 100644 index 0000000000..335f3e1912 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-verb-to-section.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-verb-to-section" +title: "addVerbToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addVerbToSection" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerbToSection` + +Add a verb to a specific named section. +Mirrors Python's `add_verb_to_section()`. + +## Signature + +```typescript +addVerbToSection(sectionName: string, verbName: string, config: unknown): this +``` + +## Parameters + + + Target section name (auto-created if missing). + + + + Verb name. + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 669. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-verb.mdx new file mode 100644 index 0000000000..5160ba9387 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-verb" +title: "addVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.addVerb" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerb` + +Add a verb to the SWML document. + +## Signature + +```typescript +addVerb(name: string, config: unknown): this +``` + +## Parameters + + + Verb name (e.g., 'answer', 'play', 'hangup'). + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 642. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/as-router.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/as-router.mdx new file mode 100644 index 0000000000..ac4b032004 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/as-router.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/as-router" +title: "asRouter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.asRouter" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `asRouter` + +Return this agent's Hono app for mounting as a sub-router in an AgentServer. + +## Signature + +```typescript +asRouter(): Hono +``` + +## Returns + +`Hono` — The Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2637. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/auto-map-sip-usernames.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/auto-map-sip-usernames.mdx new file mode 100644 index 0000000000..28fcb6b8ea --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/auto-map-sip-usernames.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/auto-map-sip-usernames" +title: "autoMapSipUsernames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.autoMapSipUsernames" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `autoMapSipUsernames` + +Automatically register common SIP usernames based on this agent's +name and route. Derives cleaned variants (alphanumeric + underscore) +and registers each via `registerSipUsername()`. + +Port of Python's `auto_map_sip_usernames()`: + +- Registers a cleaned version of the agent name +- Registers a cleaned version of the route (if different from name) +- For names longer than 3 characters, also registers a vowel-stripped variant + +## Signature + +```typescript +autoMapSipUsernames(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1057. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/build-swml-for-request.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/build-swml-for-request.mdx new file mode 100644 index 0000000000..811bacc710 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/build-swml-for-request.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/build-swml-for-request" +title: "buildSwmlForRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.buildSwmlForRequest" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `buildSwmlForRequest` + +Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` +to fully replace the document for this request, or `null` to fall +through to `setOnRequestCallback` or the static builder. + +This is distinct from the WebMixin `onRequest(requestData, +callbackPath)` hook on AgentBase (which mirrors Python's +`on_request -> on_swml_request` modification-merge contract). +Use this hook when you want to swap the entire SWML builder; use +`onRequest` / `onSwmlRequest` on AgentBase when you want to merge +targeted modifications into the rendered document. + +Default implementation returns `null` (no-op). + +## Signature + +```typescript +buildSwmlForRequest( + _queryParams: Record, + _bodyParams: Record, + _headers: Record, + _callbackPath?: string +): SwmlBuilder | null +``` + +## Parameters + + + + + + + + + +## Returns + +`SwmlBuilder | null` — A `SwmlBuilder` whose document is sent as the response, or `null` to delegate to the next handler in the chain. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 834. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..6d58b1dc1e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-post-ai-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-post-ai-verbs" +title: "clearPostAiVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.clearPostAiVerbs" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAiVerbs` + +Remove all post-AI verbs. + +## Signature + +```typescript +clearPostAiVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1542. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..3d436f326e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-post-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-post-answer-verbs" +title: "clearPostAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.clearPostAnswerVerbs" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAnswerVerbs` + +Remove all post-answer verbs. + +## Signature + +```typescript +clearPostAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1533. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..20e7943e6e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-pre-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-pre-answer-verbs" +title: "clearPreAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.clearPreAnswerVerbs" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPreAnswerVerbs` + +Remove all pre-answer verbs. + +## Signature + +```typescript +clearPreAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1524. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..b1db34bb6b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-swaig-query-params.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/clear-swaig-query-params" +title: "clearSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.clearSwaigQueryParams" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearSwaigQueryParams` + +Clear all SWAIG query parameters. + +## Signature + +```typescript +clearSwaigQueryParams(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1723. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/constructor.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/constructor.mdx new file mode 100644 index 0000000000..fa6421e315 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.constructor" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts" +--- +# `constructor` + +Create a ReceptionistAgent with the specified departments. + +## Signature + +```typescript +constructor(config: ReceptionistConfig): ReceptionistAgent +``` + +## Parameters + + + Configuration including departments (name/description/number), greeting, and voice. + + +## Returns + +`ReceptionistAgent` + +## Source + +[`src/prefabs/ReceptionistAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts) + +Line 96. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/create-tool-token.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/create-tool-token.mdx new file mode 100644 index 0000000000..2920bf24e8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/create-tool-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/create-tool-token" +title: "createToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.createToolToken" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `createToolToken` + +Mint a per-call SWAIG-function token via the agent's SessionManager. + +Mirrors Python reference `core/mixins/state_mixin.py _create_tool_token`: +delegates to `SessionManager.createToolToken` and returns an empty +string on any failure (Python catches all exceptions and returns ""). + +## Signature + +```typescript +createToolToken(toolName: string, callId: string): string +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1467. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-contexts.mdx new file mode 100644 index 0000000000..a45b912469 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-contexts.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-contexts" +title: "defineContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.defineContexts" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineContexts` + +Define or replace the contexts configuration for the AI verb. + +## Signature + +```typescript +defineContexts( + contexts?: Record | ContextBuilder +): ContextBuilder +``` + +## Parameters + + + An existing ContextBuilder instance or a plain object; a new ContextBuilder is created if omitted. + + +## Returns + +`ContextBuilder` — The active ContextBuilder for further configuration. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 603. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-tool.mdx new file mode 100644 index 0000000000..03fe61f0e5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-tool.mdx @@ -0,0 +1,114 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.defineTool" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTool` + +Register a SWAIG tool (function) that the AI can invoke during a call. + +## How this becomes a tool the model sees + +A SWAIG function is **exactly the same concept** as a "tool" in +native OpenAI / Anthropic tool calling. On every LLM turn, the SDK +renders each registered SWAIG function into the OpenAI tool schema: + +```json +{ +"type": "function", +"function": { +"name": "your_name_here", +"description": "your description text", +"parameters": { /* your JSON schema */ } +} +} +``` + +That schema goes to the model in the same API call that produces +the next assistant message. The model reads: + +- the **function `description`** to decide WHEN to call this tool +- each **parameter `description`** (inside the JSON schema) to + decide HOW to fill in each argument + +This means **descriptions are prompt engineering**, not developer +comments. A vague description is the #1 cause of "the model has the +right tool but doesn't call it" failures. + +### Bad vs good descriptions + +```text +BAD : description: 'Lookup function' +GOOD: description: 'Look up a customer's account details by account +number. Use this BEFORE quoting any account-specific info +(balance, plan, status). Do not use for general product +questions.' + +BAD : parameters: { id: { type: 'string', description: 'the id' } } +GOOD: parameters: { account_number: { type: 'string', description: +'The customer's 8-digit account number, no dashes or spaces. +Ask the user if they don't provide it.' } } +``` + +### Tool count matters + +LLM tool selection accuracy degrades past ~7-8 simultaneously-active +tools per call. Use Step.setFunctions() to partition tools across +steps so only the relevant subset is active at any moment. + +## Signature + +```typescript +defineTool(opts: { ...11 fields }): this +``` + +## Parameters + + + Tool definition including name, description, parameter schema, and handler callback. `description` and per-parameter `description` strings are LLM-facing prompt engineering. + + + + + Additional fields to pass through to the SWAIG function definition (Python `**swaig_fields` equivalent). + + + + + + + + + + + + + + + + + + + + External webhook URL; makes this an externally-hosted tool. + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1329. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-tools.mdx new file mode 100644 index 0000000000..95a212014c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-tools" +title: "defineTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.defineTools" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts" + visibility: "protected" +--- +# `defineTools` + +Register the `collect_caller_info` and `transfer_call` SWAIG tools +(Python parity). When `checkInEnabled` is `true`, also registers the +TS-specific `check_in_visitor` tool. + +## Signature + +```typescript +defineTools(): void +``` + +## Returns + +`void` + +## Source + +[`src/prefabs/ReceptionistAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts) + +Line 234. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-typed-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-typed-tool.mdx new file mode 100644 index 0000000000..baca1ba2ce --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-typed-tool.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/define-typed-tool" +title: "defineTypedTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.defineTypedTool" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTypedTool` + +Register a SWAIG tool with a typed handler that receives named parameters +instead of the standard `(args, rawData)` convention. + +The SDK wraps the handler to unpack the args dict into positional params. +If no `parameters` schema is provided, one is inferred from the handler's +source code (parameter names and default values). + +## Signature + +```typescript +defineTypedTool(opts: { ...9 fields }): this +``` + +## Parameters + + + Tool definition with a typed handler function. + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1372. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-debug-events.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-debug-events.mdx new file mode 100644 index 0000000000..643fe3384c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-debug-events.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-debug-events" +title: "enableDebugEvents" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.enableDebugEvents" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugEvents` + +Enable debug event webhooks for this agent. + +## Signature + +```typescript +enableDebugEvents(level: number = 1): this +``` + +## Parameters + + + Debug verbosity level (defaults to 1). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1010. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-debug-routes.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-debug-routes.mdx new file mode 100644 index 0000000000..25b281bcea --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-debug-routes.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-debug-routes" +title: "enableDebugRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.enableDebugRoutes" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugRoutes` + +Register a callback function that determines routing based on POST data. + +When a routing callback is registered, an endpoint at the specified path +is created in `getApp()`. The callback receives the request body and returns +Enable debug routes for testing and development. + +This is a backward-compatibility stub matching the Python SDK. +In the TypeScript SDK, debug routes (health, ready, debug\_events) +are automatically registered in `getApp()`. + +## Signature + +```typescript +enableDebugRoutes(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1754. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-mcp-server.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-mcp-server.mdx new file mode 100644 index 0000000000..5a1c33167d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-mcp-server.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-mcp-server" +title: "enableMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.enableMcpServer" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableMcpServer` + +Expose this agent's tools as an MCP server endpoint at /mcp. +Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + +## Signature + +```typescript +enableMcpServer(): this +``` + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1159. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-sip-routing.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-sip-routing.mdx new file mode 100644 index 0000000000..d7ac5bda51 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-sip-routing.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/enable-sip-routing" +title: "enableSipRouting" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.enableSipRouting" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableSipRouting` + +Enable SIP routing for this agent. + +## Signature + +```typescript +enableSipRouting(autoMap: boolean = true, path: string = '/sip'): this +``` + +## Parameters + + + When true, automatically map SIP usernames to the agent route (defaults to true). + + + + HTTP path for the SIP routing endpoint (defaults to '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1024. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/extract-sip-username.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/extract-sip-username.mdx new file mode 100644 index 0000000000..379e4eb153 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/extract-sip-username.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/extract-sip-username" +title: "extractSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.extractSipUsername" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `extractSipUsername` + +Extract the SIP username from a request body's call.to field. + +**Modifiers:** `static` + +## Signature + +```typescript +extractSipUsername(requestBody: Record): string | null +``` + +## Parameters + + + The parsed request body containing call information. + + +## Returns + +`string | null` — The extracted SIP username, or null if not found. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1121. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-all-functions.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-all-functions.mdx new file mode 100644 index 0000000000..d1c9e72ba6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-all-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-all-functions" +title: "getAllFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getAllFunctions" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getAllFunctions` + +Snapshot of all registered SWAIG functions keyed by name. +(Python parity: `ToolRegistry.get_all_functions`.) + +## Signature + +```typescript +getAllFunctions(): Record> +``` + +## Returns + +`Record>` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 529. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-app.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-app.mdx new file mode 100644 index 0000000000..487e2e2b3d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-app.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-app" +title: "getApp" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getApp" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getApp` + +Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + +## Signature + +```typescript +getApp(): Hono +``` + +## Returns + +`Hono` — The configured Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2250. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..7dd58afe16 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-basic-auth-credentials.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-basic-auth-credentials" +title: "getBasicAuthCredentials" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getBasicAuthCredentials" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getBasicAuthCredentials` + +Get the basic-auth credentials used by this agent. + +## Signature + + + + ```typescript + getBasicAuthCredentials(includeSource?: false): [string, string] + ``` + + + + ```typescript + getBasicAuthCredentials( + includeSource: true + ): [string, string, "provided" | "environment" | "generated"] + ``` + + + +## Parameters (Overload 1) + + + When true, a third element indicating the credential source is appended. + + +## Parameters (Overload 2) + + + When true, a third element indicating the credential source is appended. + + +## Returns (Overload 1) + +`[string, string]` — A tuple of \[username, password] or \[username, password, source]. + +## Returns (Overload 2) + +`[string, string, "provided" | "environment" | "generated"]` — A tuple of \[username, password] or \[username, password, source]. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2775. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-builder.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-builder.mdx new file mode 100644 index 0000000000..d1b53d3cd4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-builder.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-builder" +title: "getBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getBuilder" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getBuilder` + +Get the underlying SwmlBuilder for direct manipulation. + +## Signature + +```typescript +getBuilder(): SwmlBuilder +``` + +## Returns + +`SwmlBuilder` — The SwmlBuilder instance. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 632. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-contexts.mdx new file mode 100644 index 0000000000..09ab55cc00 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-contexts" +title: "getContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getContexts" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getContexts` + +Get the contexts dictionary as serialised SWML, or null when no +contexts have been defined yet. + +Matches Python `PromptManager.get_contexts()` which returns the +contexts dict or `None`. + +## Signature + +```typescript +getContexts(): Record | null +``` + +## Returns + +`Record | null` — Contexts dict, or null when no contexts are defined. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 640. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-document.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-document.mdx new file mode 100644 index 0000000000..e081436c39 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-document" +title: "getDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getDocument" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getDocument` + +Get the SWML document as a dictionary. +Alias for `renderSwml()` that matches Python's `get_document()` name. + +## Signature + +```typescript +getDocument(): Record +``` + +## Returns + +`Record` — The SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 706. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-full-url.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-full-url.mdx new file mode 100644 index 0000000000..ffa569bd07 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-full-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-full-url" +title: "getFullUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getFullUrl" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getFullUrl` + +Get the full external URL of this agent, using the proxy base URL if available. + +## Signature + +```typescript +getFullUrl(includeAuth: boolean = false): string +``` + +## Parameters + + + Whether to embed basic-auth credentials in the URL (defaults to false). + + +## Returns + +`string` — The fully-qualified URL string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1838. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-function.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-function.mdx new file mode 100644 index 0000000000..241943068b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-function" +title: "getFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getFunction" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getFunction` + +Get a registered SWAIG function entry, or undefined. +(Python parity: `ToolRegistry.get_function`.) + +## Signature + +```typescript +getFunction(name: string): Record | SwaigFunction | undefined +``` + +## Parameters + + + +## Returns + +`Record | SwaigFunction | undefined` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 523. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-language-params.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-language-params.mdx new file mode 100644 index 0000000000..9adf709e3d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-language-params.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-language-params" +title: "getLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getLanguageParams" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getLanguageParams` + +Read the per-language `params` dict for a previously-added language. + +Python parity: `get_language_params(code)`. Returns `undefined` if the +code is unknown or the language has no params set — no exception path. + +## Signature + +```typescript +getLanguageParams(code: string): Record | undefined +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-language). + + +## Returns + +`Record | undefined` — The params dict if set, `undefined` otherwise (including when the code is unknown). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 759. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-mcp-servers.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-mcp-servers.mdx new file mode 100644 index 0000000000..a28985e9d2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-mcp-servers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-mcp-servers" +title: "getMcpServers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getMcpServers" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getMcpServers` + +Get configured MCP servers (read-only copy). + +## Signature + +```typescript +getMcpServers(): Record[] +``` + +## Returns + +`Record[]` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1170. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-name.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-name.mdx new file mode 100644 index 0000000000..75bc40f0ce --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-name" +title: "getName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getName" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getName` + +Get the agent's display name. + +## Signature + +```typescript +getName(): string +``` + +## Returns + +`string` — The agent name string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1551. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-post-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-post-prompt.mdx new file mode 100644 index 0000000000..f0f278d515 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-post-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-post-prompt" +title: "getPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getPostPrompt" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPostPrompt` + +Get the post-prompt text, if one has been set. + +## Signature + +```typescript +getPostPrompt(): string | null +``` + +## Returns + +`string | null` — The post-prompt string, or null if not configured. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 547. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-prompt-pom.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-prompt-pom.mdx new file mode 100644 index 0000000000..0edaaed7a1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-prompt-pom.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-prompt-pom" +title: "getPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getPromptPom" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPromptPom` + +Get the raw POM (Prompt Object Model) structure as an array of section data objects, +when the agent is in POM mode and has at least one section. + +Matches Python `get_prompt()` which returns `Union[str, List[Dict]]` — a raw list when +in POM mode (via `pom.to_list()` / `pom.render_dict()`), or a string otherwise. +The TS `getPrompt()` always returns a string (rendered Markdown), so this companion +method exposes the raw POM structure for callers that need it for serialisation or +inspection (e.g. skills that inspect prompt sections). + +## Signature + +```typescript +getPromptPom(): Record[] | null +``` + +## Returns + +`Record[] | null` — An array of POM section data objects, or null if not in POM mode or POM is empty. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 535. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-prompt.mdx new file mode 100644 index 0000000000..ba7f8db127 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-prompt" +title: "getPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getPrompt" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPrompt` + +Get the fully rendered main prompt text. + +## Signature + +```typescript +getPrompt(): string +``` + +## Returns + +`string` — The assembled prompt string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 519. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-raw-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-raw-prompt.mdx new file mode 100644 index 0000000000..74ac55e58c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-raw-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-raw-prompt" +title: "getRawPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getRawPrompt" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getRawPrompt` + +Get the raw prompt text whatever `setPromptText` stored, or null when +no raw prompt has been set. + +Matches Python `PromptManager.get_raw_prompt()` which returns the raw +stored string or `None`. Use this instead of `getPrompt()` when you +need the unrendered text rather than the POM-rendered Markdown. + +## Signature + +```typescript +getRawPrompt(): string | null +``` + +## Returns + +`string | null` — The raw prompt string, or null if not set. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 561. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-registered-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-registered-tools.mdx new file mode 100644 index 0000000000..49d06bf85d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-registered-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-registered-tools" +title: "getRegisteredTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getRegisteredTools" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getRegisteredTools` + +Get a summary of all registered tools with their names, descriptions, and +parameter schemas. Lifted from AgentBase so the swaig-test CLI can list +tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG +host). + +## Signature + +```typescript +getRegisteredTools(): { description: string; name: string; parameters: Record }[] +``` + +## Returns + +`{ description: string; name: string; parameters: Record }[]` — Array of tool descriptors. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-tool.mdx new file mode 100644 index 0000000000..1305df7e90 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-tool.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-tool" +title: "getTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getTool" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getTool` + +Look up a registered SwaigFunction by name. Lifted from AgentBase so +`swaig-test --exec ` works against a non-AgentBase SWMLService +target. + +## Signature + +```typescript +getTool(name: string): SwaigFunction | undefined +``` + +## Parameters + + + The tool name to search for. + + +## Returns + +`SwaigFunction | undefined` — The SwaigFunction instance, or undefined if not found or not a SwaigFunction. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 581. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-tools.mdx new file mode 100644 index 0000000000..42da614077 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.getTools" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getTools` + +Public access to the list of registered tools. + +In Python, `define_tools()` is public and returns `List[SWAIGFunction]`. +In TypeScript, `defineTools()` is a protected setup hook (void). This +method provides the equivalent public "get all tools" capability. + +## Signature + +```typescript +getTools(): SwaigFunction[] +``` + +## Returns + +`SwaigFunction[]` — Array of all registered SwaigFunction instances. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 370. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/handle-mcp-request.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/handle-mcp-request.mdx new file mode 100644 index 0000000000..4b3fe9d20d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/handle-mcp-request.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/handle-mcp-request" +title: "handleMcpRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.handleMcpRequest" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `handleMcpRequest` + +Handle an MCP JSON-RPC 2.0 request. Returns the response object. + +## Signature + +```typescript +handleMcpRequest( + body: Record +): Promise> +``` + +## Parameters + + + +## Returns + +`Promise>` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1203. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-function.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-function.mdx new file mode 100644 index 0000000000..4cef64ba00 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-function" +title: "hasFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.hasFunction" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasFunction` + +Whether a SWAIG function with the given name is registered. +(Python parity: `ToolRegistry.has_function`.) + +## Signature + +```typescript +hasFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 517. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-skill.mdx new file mode 100644 index 0000000000..540accb401 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-skill" +title: "hasSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.hasSkill" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `hasSkill` + +Check whether a skill with the given name is registered. + +## Signature + +```typescript +hasSkill(skillName: string): boolean +``` + +## Parameters + + + The skill name to check. + + +## Returns + +`boolean` — True if a skill with that name exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1657. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-tool.mdx new file mode 100644 index 0000000000..54ddf3fc61 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-tool.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/has-tool" +title: "hasTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.hasTool" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasTool` + +Whether a tool with the given name is registered. + +## Signature + +```typescript +hasTool(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/index.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/index.mdx new file mode 100644 index 0000000000..5a0cc1bb2d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/index.mdx @@ -0,0 +1,595 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent" +title: "ReceptionistAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent" + parent: "prefabs.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts" +--- +# `ReceptionistAgent` + +Prefab agent that greets callers, collects basic information, and transfers them to the correct department. + +Optionally supports visitor check-in — when enabled, the agent can collect a visitor's name +and purpose-of-visit and invoke a callback (e.g., notify reception via Slack, write to a +database). If not transferring, the call ends after check-in. + +## Signature + +```typescript +class ReceptionistAgent extends AgentBase +``` + +## Inheritance + +**Extends:** [AgentBase](/reference/typescript/agent-base) + +## Examples + +```typescript +import { ReceptionistAgent } from '@signalwire/sdk'; + +const agent = new ReceptionistAgent({ + companyName: 'Acme Co', + greeting: 'Thanks for calling Acme! How can I direct your call?', + departments: [ + { name: 'sales', description: 'New customer inquiries', number: '+15551112222' }, + { name: 'support', description: 'Existing customer help', number: '+15553334444' }, + { name: 'billing', description: 'Billing and payments', number: '+15555556666' }, + ], + checkInEnabled: true, + onVisitorCheckIn: async (visitor) => { + await notifyFrontDesk(visitor); + }, +}); + +await agent.serve({ port: 3000 }); +``` + +## Properties + + + Unique identifier for this agent instance. + + + + + + + + Domain name for SSL. Mirrors Python's `self.domain`. + + + + Check if full JSON Schema validation is enabled. Mirrors Python's `@property full_validation_enabled`. + + + + Host the server binds to. + + + + Structured logger instance for this agent. Override the inherited SWMLService logger with an AgentBase-tagged one. + + + + Service display name. + + + + Public accessor for the native functions list. Python exposes `self.native_functions` as a public read/write attribute. + + + + + + Public accessor for the agent's POM as a `PromptObjectModel` instance. Python parity: `agent.pom` instance attribute (agent\_base.py line 209) is a `signalwire.pom.pom.PromptObjectModel` when `use_pom=True`, or `None` otherwise. This getter returns the equivalent TypeScript `PromptObjectModel` instance — callers can use `addSection`, `findSection`, `renderMarkdown`, `renderXml`, `toJson`, `toYaml` exactly as in Python. The instance returned is a fresh snapshot built from the current `PomBuilder` state, so mutating it does not feed back into the agent's internal builder. To mutate the agent's prompt, use `promptAddSection` / `promptAddToSection` / `promptAddSubsection`. + + + + Port the server binds to. + + + + Static prompt sections: subclasses can define these declaratively. Each entry is applied via promptAddSection() in the constructor. + + + + Public accessor for the PromptManager (POM). Python exposes `self.pom` as a public attribute. This getter provides equivalent access for direct POM manipulation. + + + + HTTP route path. + + + + Schema validation utilities. Mirrors Python's `self.schema_utils`. + + + + Unified security configuration. Mirrors Python's `self.security`. + + + + Public read-only accessor for the SkillManager. Python exposes `self.skill_manager` as a public attribute. This getter provides equivalent read access. + + + + Path to SSL certificate. Mirrors Python's `self.ssl_cert_path`. + + + + Whether SSL is enabled. Mirrors Python's `self.ssl_enabled`. + + + + Path to SSL private key. Mirrors Python's `self.ssl_key_path`. + + + + The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — addInternalFiller / setInternalFillers warn if you pass an unknown name. + + + + + + + + Custom verb handler registry. Mirrors Python's `self.verb_registry`. + + +## Methods + + + + Configure the answer verb (phase 2) with optional settings. + + + + Add a remote SWAIG function include reference. + + + + Add a single speech-recognition hint. + + + + Add multiple speech-recognition hints at once. + + + + Add internal filler phrases for a single internal function and language. + + + + Add a supported language to the AI configuration. + + + + Add an external MCP server for tool discovery and invocation. Tools are discovered via MCP protocol at session start and added to the AI's tool list. + + + + Add a pattern-based speech-recognition hint with find-and-replace behavior. + + + + Add a SWML verb to execute after the AI verb (phase 5). + + + + Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + + + + Add a SWML verb to execute before the answer phase (phase 1). + + + + Add a pronunciation override rule for the TTS engine. + + + + Add a new named section to the SWML document. Mirrors Python's `add_section()`. + + + + Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + + + + Add a skill by its registered name, looking it up in the global SkillRegistry. + + + + Add extra query parameters appended to all SWAIG webhook URLs. + + + + Add a verb to the SWML document. + + + + Add a verb to a specific named section. Mirrors Python's `add_verb_to_section()`. + + + + Return this agent's Hono app for mounting as a sub-router in an AgentServer. + + + + Automatically register common SIP usernames based on this agent's name and route. Derives cleaned variants (alphanumeric + underscore) and registers each via `registerSipUsername()`. + + + + Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` to fully replace the document for this request, or `null` to fall through to `setOnRequestCallback` or the static builder. + + + + Remove all post-AI verbs. + + + + Remove all post-answer verbs. + + + + Remove all pre-answer verbs. + + + + Clear all SWAIG query parameters. + + + + Create a ReceptionistAgent with the specified departments. + + + + Mint a per-call SWAIG-function token via the agent's SessionManager. + + + + Define or replace the contexts configuration for the AI verb. + + + + Register a SWAIG tool (function) that the AI can invoke during a call. + + + + Register the `collect_caller_info` and `transfer_call` SWAIG tools (Python parity). When `checkInEnabled` is `true`, also registers the TS-specific `check_in_visitor` tool. + + + + Register a SWAIG tool with a typed handler that receives named parameters instead of the standard `(args, rawData)` convention. + + + + Enable debug event webhooks for this agent. + + + + Register a callback function that determines routing based on POST data. + + + + Expose this agent's tools as an MCP server endpoint at /mcp. Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + + + + Enable SIP routing for this agent. + + + + Extract the SIP username from a request body's call.to field. + + + + Snapshot of all registered SWAIG functions keyed by name. (Python parity: `ToolRegistry.get_all_functions`.) + + + + Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + + + + Get the basic-auth credentials used by this agent. + + + + Get the underlying SwmlBuilder for direct manipulation. + + + + Get the contexts dictionary as serialised SWML, or null when no contexts have been defined yet. + + + + Get the SWML document as a dictionary. Alias for `renderSwml()` that matches Python's `get_document()` name. + + + + Get the full external URL of this agent, using the proxy base URL if available. + + + + Get a registered SWAIG function entry, or undefined. (Python parity: `ToolRegistry.get_function`.) + + + + Read the per-language `params` dict for a previously-added language. + + + + Get configured MCP servers (read-only copy). + + + + Get the agent's display name. + + + + Get the post-prompt text, if one has been set. + + + + Get the fully rendered main prompt text. + + + + Get the raw POM (Prompt Object Model) structure as an array of section data objects, when the agent is in POM mode and has at least one section. + + + + Get the raw prompt text whatever `setPromptText` stored, or null when no raw prompt has been set. + + + + Get a summary of all registered tools with their names, descriptions, and parameter schemas. Lifted from AgentBase so the swaig-test CLI can list tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG host). + + + + Look up a registered SwaigFunction by name. Lifted from AgentBase so `swaig-test --exec ` works against a non-AgentBase SWMLService target. + + + + Public access to the list of registered tools. + + + + Handle an MCP JSON-RPC 2.0 request. Returns the response object. + + + + Whether a SWAIG function with the given name is registered. (Python parity: `ToolRegistry.has_function`.) + + + + Check whether a skill with the given name is registered. + + + + Whether a tool with the given name is registered. + + + + Check if MCP server endpoint is enabled. + + + + List all registered skills with their names, instance IDs, and initialization status. + + + + List registered tool names in insertion order (Map preserves it). + + + + Manually set the proxy base URL used for webhook URL generation. + + + + Lifecycle hook called when a debug event webhook is received. Override in subclasses. + + + + Hook called before each SWAIG function execution. Override in subclasses. + + + + Lifecycle hook called when SWML is requested. Default delegates to [onSwmlRequest](/reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-swml-request) and returns its result. Subclasses typically override `onSwmlRequest` rather than this method. + + + + Python-style receptionist summary hook. Default is a no-op; subclasses may override to persist the summary. Mirrors Python `on_summary` (receptionist.py lines 278–287). + + + + Lifecycle hook called on every SWML request before rendering. Override in subclasses. + + + + Add a new section to the prompt with optional body, bullets, and subsections. + + + + Add a subsection under an existing prompt section. + + + + Append content to an existing prompt section. + + + + Check whether a prompt section with the given title exists. + + + + Extension point: register additional Hono routes after SWMLService mounts /health, /ready, /swaig, and the main route. AgentBase uses this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + + + + Register a callback at a specific HTTP path that decides how to route an incoming request. + + + + Register a SIP username to route to this agent. + + + + Register a SwaigFunction instance or a raw function descriptor (DataMap). + + + + Register a custom verb handler. Mirrors Python's `register_verb_handler()`. + + + + Remove a registered SWAIG function. Returns true when removed, false when not found. (Python parity: `ToolRegistry.remove_function`.) + + + + Remove a previously added skill by its instance ID. + + + + Remove a skill by its name (Python parity). + + + + Render the SWML document as a JSON string. Mirrors Python's `render_document()`. + + + + Render the complete SWML document by assembling all 5 phases: pre-answer, answer, post-answer, AI, and post-AI verbs. + + + + Remove all contexts, returning the agent to a no-contexts state. + + + + Reset the SWML document to an empty state. Mirrors Python's `reset_document()`. + + + + Alias for [serve](/reference/typescript/prefabs/receptionist-agent/receptionist-agent/serve). Starts the HTTP server. + + + + Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + + + + Start the HTTP server and begin listening for requests. + + + + Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + + + + Replace the entire list of function includes. Each include must have a `url` and `functions` array. + + + + Merge data into the global\_data object passed into the AI configuration. + + + + Set internal fillers for native SWAIG functions. + + + + Set (or replace) the per-language `params` dict on an already-added language. Useful when language entries are built up via [addLanguage](/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-language) first and engine-specific tuning is added later (e.g., from a config loader). + + + + Replace all configured languages with a new list. + + + + Set the list of native SWAIG function names (built-in platform functions). + + + + Set a callback invoked per-request to dynamically build SWML. When set, the static SwmlBuilder is ignored and the callback's returned SwmlBuilder is used instead. + + + + Set a single AI parameter (e.g. "temperature", "top\_p"). + + + + Merge multiple AI parameters into the existing params object. + + + + Set the post-prompt text evaluated after the call ends. + + + + Merge LLM-specific parameters into the post-prompt configuration. + + + + Override the default post-prompt webhook URL with a custom one. + + + + Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + + + + Set the prompt as a POM (Prompt Object Model) dictionary. + + + + Set the main system prompt text for the AI. + + + + Replace all pronunciation rules with a new list. + + + + Register process signal handlers for clean Kubernetes/Docker shutdown. Handles SIGTERM and SIGINT, waits for a timeout, then exits. + + + + Override the default SWAIG webhook URL with a custom one. + + + + Stop the HTTP server. Mirrors Python's `stop()`. + + + + Extension point: invoked between argument parsing and function dispatch on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is non-null, it's returned directly without dispatching. AgentBase may override to add session-token validation or ephemeral dynamic-config. + + + + Merge additional entries into the existing global\_data object. + + + + Override to add custom basic-auth validation logic beyond credential matching. + + + + Validate a tool-call token for the given function. + + + +## Source + +[`src/prefabs/ReceptionistAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts) + +Line 84. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/is-mcp-server-enabled.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/is-mcp-server-enabled.mdx new file mode 100644 index 0000000000..e6b3d80231 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/is-mcp-server-enabled.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/is-mcp-server-enabled" +title: "isMcpServerEnabled" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.isMcpServerEnabled" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `isMcpServerEnabled` + +Check if MCP server endpoint is enabled. + +## Signature + +```typescript +isMcpServerEnabled(): boolean +``` + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1165. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/list-skills.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/list-skills.mdx new file mode 100644 index 0000000000..681a3f5867 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/list-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/list-skills" +title: "listSkills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.listSkills" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `listSkills` + +List all registered skills with their names, instance IDs, and initialization status. + +## Signature + +```typescript +listSkills(): { initialized: boolean; instanceId: string; name: string }[] +``` + +## Returns + +`{ initialized: boolean; instanceId: string; name: string }[]` — Array of skill descriptors. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1648. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/list-tool-names.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/list-tool-names.mdx new file mode 100644 index 0000000000..aee3037ce2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/list-tool-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/list-tool-names" +title: "listToolNames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.listToolNames" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `listToolNames` + +List registered tool names in insertion order (Map preserves it). + +## Signature + +```typescript +listToolNames(): string[] +``` + +## Returns + +`string[]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 545. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/manual-set-proxy-url.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..441d6475cc --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/manual-set-proxy-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/manual-set-proxy-url" +title: "manualSetProxyUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.manualSetProxyUrl" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `manualSetProxyUrl` + +Manually set the proxy base URL used for webhook URL generation. + +## Signature + +```typescript +manualSetProxyUrl(url: string): this +``` + +## Parameters + + + The external-facing base URL (trailing slashes are stripped). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1735. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-debug-event.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-debug-event.mdx new file mode 100644 index 0000000000..44d8edc097 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-debug-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-debug-event" +title: "onDebugEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.onDebugEvent" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onDebugEvent` + +Lifecycle hook called when a debug event webhook is received. Override in subclasses. + +## Signature + +```typescript +onDebugEvent(_event: Record): void | Promise +``` + +## Parameters + + + The debug event payload. + + +## Returns + +`void | Promise` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1951. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-function-call.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-function-call.mdx new file mode 100644 index 0000000000..296a70ce87 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-function-call.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-function-call" +title: "onFunctionCall" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.onFunctionCall" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onFunctionCall` + +Hook called before each SWAIG function execution. Override in subclasses. + +**Behavioral note:** In the Python SDK, `on_function_call` IS the dispatcher +— it retrieves and executes the function, returning the result. In TypeScript, +`fn.execute()` is called separately after this hook. However, if this method +returns a non-void value, it is used as the result and the default execution +is skipped, enabling dispatch interception parity with Python. + +## Signature + +```typescript +onFunctionCall( + _name: string, + _args: Record, + _rawData: Record +): void | Record | Promise> +``` + +## Parameters + + + Name of the function about to execute. + + + + Parsed arguments for the function. + + + + The full raw SWAIG request payload. + + +## Returns + +`void | Record | Promise>` — Optionally a result dict to short-circuit default execution, or void/undefined to proceed normally. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1980. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-request.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-request.mdx new file mode 100644 index 0000000000..36410355af --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-request.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-request" +title: "onRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.onRequest" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onRequest` + +Lifecycle hook called when SWML is requested. Default delegates to +[onSwmlRequest](/reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-swml-request) and returns its result. Subclasses typically +override `onSwmlRequest` rather than this method. + +Matches Python `WebMixin.on_request(request_data, callback_path)`. The +cross-language API is the two-arg form; the Hono `context` argument is +a TypeScript-side extra preserved for callers that already have it but +is not part of the audited surface. + +## Signature + +```typescript +onRequest( + requestData?: Record | null, + callbackPath?: string | null +): void | Record | Promise> +``` + +## Parameters + + + The parsed request body. + + + + Optional callback path from the request. + + +## Returns + +`void | Record | Promise>` — Optionally a dict of SWML modifications, or undefined for default rendering. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1916. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-summary.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-summary.mdx new file mode 100644 index 0000000000..db3202e460 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-summary.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-summary" +title: "onSummary" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.onSummary" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts" +--- +# `onSummary` + +Python-style receptionist summary hook. Default is a no-op; subclasses +may override to persist the summary. Mirrors Python `on_summary` +(receptionist.py lines 278–287). + +## Signature + +```typescript +onSummary( + _summary: Record | null, + _rawData: Record +): void | Promise +``` + +## Parameters + + + + + +## Returns + +`void | Promise` + +## Source + +[`src/prefabs/ReceptionistAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts) + +Line 376. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-swml-request.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-swml-request.mdx new file mode 100644 index 0000000000..e2fac3c6e5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-swml-request.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/on-swml-request" +title: "onSwmlRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.onSwmlRequest" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onSwmlRequest` + +Lifecycle hook called on every SWML request before rendering. Override in subclasses. + +May optionally return a modification dict that will be merged into the +rendered SWML document (matching Python's `Optional[dict]` return type). + +Matches Python `on_swml_request(request_data, callback_path, request)` — the third +parameter is the FastAPI `Request` in Python; here it is the raw Hono context object +so that subclasses can access query parameters (`context.req.query()`), raw request +headers (`context.req.raw.headers`), etc. + +## Signature + +```typescript +onSwmlRequest( + _rawData: Record, + _callbackPath?: string, + _context?: any +): void | Record | Promise> +``` + +## Parameters + + + The parsed request body. + + + + Optional callback path from the request. + + + + The raw Hono context object (c), providing access to headers and query params. + + +## Returns + +`void | Record | Promise>` — Optionally a dict of SWML modifications, or void. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1939. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-section.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-section.mdx new file mode 100644 index 0000000000..46d2ed7381 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-section.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-section" +title: "promptAddSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.promptAddSection" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSection` + +Add a new section to the prompt with optional body, bullets, and subsections. + +## Signature + +```typescript +promptAddSection(title: string, opts?: { ...5 fields }): this +``` + +## Parameters + + + Section heading. + + + + Optional section content including body text, bullet points, and subsections. + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 466. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-subsection.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-subsection.mdx new file mode 100644 index 0000000000..cd7d84a276 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-subsection.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-subsection" +title: "promptAddSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.promptAddSubsection" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSubsection` + +Add a subsection under an existing prompt section. + +## Signature + +```typescript +promptAddSubsection( + parentTitle: string, + title: string, + opts?: { ...2 fields } +): this +``` + +## Parameters + + + Title of the parent section. + + + + Title of the new subsection. + + + + Optional body text and bullet points for the subsection. + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 501. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-to-section.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-to-section.mdx new file mode 100644 index 0000000000..cdb3615a32 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-to-section.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-add-to-section" +title: "promptAddToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.promptAddToSection" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddToSection` + +Append content to an existing prompt section. + +## Signature + +```typescript +promptAddToSection(title: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + Title of the section to append to. + + + + Content to add: body text, a single bullet, or multiple bullets. + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-has-section.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-has-section.mdx new file mode 100644 index 0000000000..38482e2de8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-has-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/prompt-has-section" +title: "promptHasSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.promptHasSection" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptHasSection` + +Check whether a prompt section with the given title exists. + +## Signature + +```typescript +promptHasSection(title: string): boolean +``` + +## Parameters + + + Section title to look for. + + +## Returns + +`boolean` — True if the section exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-additional-routes.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-additional-routes.mdx new file mode 100644 index 0000000000..6aca0d567d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-additional-routes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-additional-routes" +title: "registerAdditionalRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.registerAdditionalRoutes" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `registerAdditionalRoutes` + +Extension point: register additional Hono routes after SWMLService +mounts /health, /ready, /swaig, and the main route. AgentBase uses +this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + +## Signature + +```typescript +registerAdditionalRoutes(_app: Hono): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 604. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-routing-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-routing-callback.mdx new file mode 100644 index 0000000000..9ea92d49d4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-routing-callback.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-routing-callback" +title: "registerRoutingCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.registerRoutingCallback" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerRoutingCallback` + +Register a callback at a specific HTTP path that decides how to route an +incoming request. + +When called, the endpoint at `path` will invoke `callback` with the parsed +request body. If `callback` returns a non-empty route string the server +responds with `{ action: "redirect", route }` so the platform can forward the +request to the right agent. If `callback` returns `null` / `undefined` the +agent's own SWML is returned instead (normal processing). + +Mirrors Python `swml_service.register_routing_callback` / +`web_mixin.register_routing_callback`. + +## Signature + +```typescript +registerRoutingCallback(callback: RoutingCallback, path: string = '/sip'): this +``` + +## Parameters + + + Function receiving the parsed request body and returning a route string to redirect, or null/undefined for normal processing. + + + + HTTP path where this callback endpoint is registered (default: '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1101. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-sip-username.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-sip-username.mdx new file mode 100644 index 0000000000..87822b8269 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-sip-username.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-sip-username" +title: "registerSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.registerSipUsername" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerSipUsername` + +Register a SIP username to route to this agent. + +## Signature + +```typescript +registerSipUsername(username: string): this +``` + +## Parameters + + + The SIP username to register. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1039. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-swaig-function.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-swaig-function.mdx new file mode 100644 index 0000000000..3fa23ead13 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-swaig-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-swaig-function" +title: "registerSwaigFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.registerSwaigFunction" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerSwaigFunction` + +Register a SwaigFunction instance or a raw function descriptor (DataMap). + +## Signature + +```typescript +registerSwaigFunction(fn: Record | SwaigFunction): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 472. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-verb-handler.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-verb-handler.mdx new file mode 100644 index 0000000000..9a5a977774 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-verb-handler.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/register-verb-handler" +title: "registerVerbHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.registerVerbHandler" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerVerbHandler` + +Register a custom verb handler. +Mirrors Python's `register_verb_handler()`. + +## Signature + +```typescript +registerVerbHandler(handler: SWMLVerbHandler): void +``` + +## Parameters + + + The verb handler to register. + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 726. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-function.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-function.mdx new file mode 100644 index 0000000000..95e2864f6c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-function" +title: "removeFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.removeFunction" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `removeFunction` + +Remove a registered SWAIG function. Returns true when removed, +false when not found. (Python parity: +`ToolRegistry.remove_function`.) + +## Signature + +```typescript +removeFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 540. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-skill-by-name.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-skill-by-name.mdx new file mode 100644 index 0000000000..a8f231d777 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-skill-by-name.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-skill-by-name" +title: "removeSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.removeSkillByName" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkillByName` + +Remove a skill by its name (Python parity). + +Python's `remove_skill(skill_name)` removes by skill name. +The existing `removeSkill(instanceId)` removes by instance ID. +This method provides name-based removal for cross-SDK parity. + +## Signature + +```typescript +removeSkillByName(skillName: string): Promise +``` + +## Parameters + + + The skill name to remove. + + +## Returns + +`Promise` — True if a skill with that name was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1671. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-skill.mdx new file mode 100644 index 0000000000..6b1dcfcae6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/remove-skill" +title: "removeSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.removeSkill" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkill` + +Remove a previously added skill by its instance ID. + +## Signature + +```typescript +removeSkill(instanceId: string): Promise +``` + +## Parameters + + + The unique instance ID of the skill to remove. + + +## Returns + +`Promise` — True if the skill was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1640. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/render-document.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/render-document.mdx new file mode 100644 index 0000000000..950055e751 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/render-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/render-document" +title: "renderDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.renderDocument" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `renderDocument` + +Render the SWML document as a JSON string. +Mirrors Python's `render_document()`. + +## Signature + +```typescript +renderDocument(): string +``` + +## Returns + +`string` — JSON-encoded SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 715. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/render-swml.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/render-swml.mdx new file mode 100644 index 0000000000..d7e26b5540 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/render-swml.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/render-swml" +title: "renderSwml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.renderSwml" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `renderSwml` + +Render the complete SWML document by assembling all 5 phases: pre-answer, answer, +post-answer, AI, and post-AI verbs. + +## Signature + +```typescript +renderSwml(callId?: string, modifications?: Record): string +``` + +## Parameters + + + Optional call ID to use for session tokens; auto-generated if omitted. + + + + Optional dict returned from `onSwmlRequest` to merge into the AI verb config before rendering. Matches Python's `_render_swml(modifications)` semantics: `global_data` is deep-merged; all other keys override the AI config directly. + + +## Returns + +`string` — The rendered SWML document as a JSON string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2000. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/reset-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/reset-contexts.mdx new file mode 100644 index 0000000000..02240c629f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/reset-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/reset-contexts" +title: "resetContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.resetContexts" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `resetContexts` + +Remove all contexts, returning the agent to a no-contexts state. + +This is a convenience wrapper around `defineContexts().reset()`. +Use it in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```typescript +resetContexts(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 624. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/reset-document.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/reset-document.mdx new file mode 100644 index 0000000000..2a51b97959 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/reset-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/reset-document" +title: "resetDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.resetDocument" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `resetDocument` + +Reset the SWML document to an empty state. +Mirrors Python's `reset_document()`. + +## Signature + +```typescript +resetDocument(): this +``` + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 679. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/run-serverless.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/run-serverless.mdx new file mode 100644 index 0000000000..2786b86ae0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/run-serverless.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/run-serverless" +title: "runServerless" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.runServerless" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `runServerless` + +Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + +Matches Python `run(event, context)` when executed in a serverless environment. Python's +`run()` auto-detects the platform via `get_execution_mode()` and dispatches accordingly; +in TypeScript the serverless path is an **explicit** method so that `run()` keeps its +HTTP-server semantics and callers opt in to serverless dispatch deliberately. + +Platform detection follows the same environment-variable heuristics as Python's +`ServerlessMixin`: `AWS_LAMBDA_FUNCTION_NAME` → Lambda, `K_SERVICE` → GCF, +`FUNCTIONS_WORKER_RUNTIME` → Azure, `GATEWAY_INTERFACE` → CGI. + +Usage in a Lambda handler file: + +```ts +export const handler = (event: any, context: any) => agent.runServerless(event, context); +``` + +## Signature + +```typescript +runServerless( + event: ServerlessEvent, + context?: unknown, + platform?: "lambda" | "gcf" | "azure" | "cgi" | "auto" +): Promise +``` + +## Parameters + + + The serverless event payload (Lambda event, GCF request body, etc.). + + + + The serverless context object (Lambda context, Azure context, etc.). + + + + Optional platform override; defaults to 'auto' (environment detection). + + +## Returns + +`Promise` — The normalized serverless response object. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2709. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/run.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/run.mdx new file mode 100644 index 0000000000..7499df1a81 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/run.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/run" +title: "run" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.run" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `run` + +Alias for [serve](/reference/typescript/prefabs/receptionist-agent/receptionist-agent/serve). Starts the HTTP server. + +## Signature + +```typescript +run(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host and port overrides. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server is running. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2683. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/serve.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/serve.mdx new file mode 100644 index 0000000000..036f843aec --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/serve.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/serve" +title: "serve" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.serve" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `serve` + +Start the HTTP server and begin listening for requests. + +Uses `@hono/node-server` under the hood. When run in CLI mode +(`SWAIG_CLI_MODE=true`, set automatically by `npx swaig-test`), this is a +no-op so agent config can be inspected without starting a server. + +## Signature + +```typescript +serve(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host/port overrides. Defaults to the values provided in the constructor options or the `PORT` environment variable. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server has begun listening. + +## Examples + +```typescript +const agent = new AgentBase({ name: 'demo', port: 3000 }); +await agent.serve(); +// Or override at runtime: +await agent.serve({ port: 8080, host: '127.0.0.1' }); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2660. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..13863b4d02 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-dynamic-config-callback.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-dynamic-config-callback" +title: "setDynamicConfigCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setDynamicConfigCallback" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setDynamicConfigCallback` + +Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + +The callback receives a clone of this agent — mutations apply only to the current +request, so you can vary prompt, tools, languages, params, or global data per call +without affecting the long-lived agent instance. + +## Signature + +```typescript +setDynamicConfigCallback(cb: DynamicConfigCallback): this +``` + +## Parameters + + + Callback receiving `(queryParams, bodyParams, headers, agent)` where `agent` is the ephemeral `AgentBase` copy to mutate. May be async. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setDynamicConfigCallback((query, body, headers, agent) => { + const lang = query.lang ?? 'en'; + if (lang === 'es') { + (agent as AgentBase).setPromptText('Eres un asistente útil.'); + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1704. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-function-includes.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-function-includes.mdx new file mode 100644 index 0000000000..fd12039d46 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-function-includes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-function-includes" +title: "setFunctionIncludes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setFunctionIncludes" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setFunctionIncludes` + +Replace the entire list of function includes. +Each include must have a `url` and `functions` array. + +## Signature + +```typescript +setFunctionIncludes(includes: FunctionInclude[]): this +``` + +## Parameters + + + Array of function include objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 978. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-global-data.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-global-data.mdx new file mode 100644 index 0000000000..c487b58fe1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-global-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-global-data" +title: "setGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setGlobalData" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setGlobalData` + +Merge data into the global\_data object passed into the AI configuration. + +Matches Python `set_global_data` which calls `.update()` on the internal dict — +existing keys are preserved; incoming keys overwrite on collision. Skills and +other callers can each contribute keys without clobbering one another. + +If you need to replace the entire object, assign a new agent instance or use +`Object.assign(agent.globalData, {})` to clear first. + +## Signature + +```typescript +setGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 827. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-internal-fillers.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-internal-fillers.mdx new file mode 100644 index 0000000000..78f36884f2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-internal-fillers.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-internal-fillers" +title: "setInternalFillers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setInternalFillers" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setInternalFillers` + +Set internal fillers for native SWAIG functions. + +Internal fillers are short phrases the AI agent speaks (via TTS) while +an internal/native function is running, so the caller doesn't hear +dead air during transitions or background work. + +Supported function names (matches the SWAIGInternalFiller schema): + +hangup — when the agent is hanging up +check\_time — when checking the time +wait\_for\_user — when waiting for user input +wait\_seconds — during deliberate pauses +adjust\_response\_latency — when adjusting response timing +next\_step — transitioning between steps in prompt.contexts +change\_context — switching between contexts in prompt.contexts +get\_visual\_input — processing visual input (enable\_vision=true) +get\_ideal\_strategy — thinking (enable\_thinking=true) + +Notably NOT supported: change\_step, gather\_submit, or arbitrary +user-defined SWAIG function names. The runtime only honors fillers +for the names listed above; everything else is silently ignored at +the SWML level. This method warns at registration time if you pass +an unknown name so you catch the typo early. + +## Signature + +```typescript +setInternalFillers( + internalFillers: Record> +): this +``` + +## Parameters + + + Map of function name to language-keyed filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setInternalFillers({ + next_step: { + 'en-US': ['Moving to the next step...', 'Great, let us continue...'], + 'es': ['Pasando al siguiente paso...'] + }, + check_time: { + 'en-US': ['Let me check the time...'] + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 909. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-language-params.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-language-params.mdx new file mode 100644 index 0000000000..ac830f1bd9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-language-params.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-language-params" +title: "setLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setLanguageParams" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguageParams` + +Set (or replace) the per-language `params` dict on an already-added +language. Useful when language entries are built up via [addLanguage](/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-language) +first and engine-specific tuning is added later (e.g., from a config +loader). + +Python parity: `set_language_params(code, params)`. Passing an empty +object removes the `params` key entirely. Unknown codes are a no-op. + +## Signature + +```typescript +setLanguageParams(code: string, params: Record): this +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/prefabs/receptionist-agent/receptionist-agent/add-language) (e.g. `"en-US"`). + + + + Engine-specific params dict to attach. Empty object removes the key. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 736. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-languages.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-languages.mdx new file mode 100644 index 0000000000..b6aaa7dc0b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-languages.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-languages" +title: "setLanguages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setLanguages" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguages` + +Replace all configured languages with a new list. + +## Signature + +```typescript +setLanguages(languages: LanguageConfig[]): this +``` + +## Parameters + + + Array of language configurations. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 717. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-native-functions.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-native-functions.mdx new file mode 100644 index 0000000000..e2ecc877f6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-native-functions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-native-functions" +title: "setNativeFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setNativeFunctions" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setNativeFunctions` + +Set the list of native SWAIG function names (built-in platform functions). + +## Signature + +```typescript +setNativeFunctions(funcs: string[]): this +``` + +## Parameters + + + Array of native function names. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 847. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-on-request-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-on-request-callback.mdx new file mode 100644 index 0000000000..38f49a3423 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-on-request-callback.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-on-request-callback" +title: "setOnRequestCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setOnRequestCallback" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `setOnRequestCallback` + +Set a callback invoked per-request to dynamically build SWML. +When set, the static SwmlBuilder is ignored and the callback's +returned SwmlBuilder is used instead. + +## Signature + +```typescript +setOnRequestCallback(cb: OnRequestCallback): this +``` + +## Parameters + + + Callback receiving query params, body params, and headers. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 850. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-param.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-param.mdx new file mode 100644 index 0000000000..47226edc7a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-param.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-param" +title: "setParam" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setParam" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParam` + +Set a single AI parameter (e.g. "temperature", "top\_p"). + +## Signature + +```typescript +setParam(key: string, value: unknown): this +``` + +## Parameters + + + Parameter name. + + + + Parameter value. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 799. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-params.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-params.mdx new file mode 100644 index 0000000000..d4371da09d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-params" +title: "setParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setParams" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParams` + +Merge multiple AI parameters into the existing params object. + +## Signature + +```typescript +setParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 809. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..168fc561df --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt-llm-params" +title: "setPostPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setPostPromptLlmParams" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptLlmParams` + +Merge LLM-specific parameters into the post-prompt configuration. + +## Signature + +```typescript +setPostPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1000. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt-url.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt-url.mdx new file mode 100644 index 0000000000..c2c8f61bf1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt-url" +title: "setPostPromptUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setPostPromptUrl" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptUrl` + +Override the default post-prompt webhook URL with a custom one. + +## Signature + +```typescript +setPostPromptUrl(url: string): this +``` + +## Parameters + + + The custom post-prompt URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1828. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt.mdx new file mode 100644 index 0000000000..68137ff00e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-post-prompt" +title: "setPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setPostPrompt" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPrompt` + +Set the post-prompt text evaluated after the call ends. + +## Signature + +```typescript +setPostPrompt(text: string): this +``` + +## Parameters + + + The post-prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 455. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..af3524886e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-llm-params" +title: "setPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setPromptLlmParams" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptLlmParams` + +Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + +## Signature + +```typescript +setPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 990. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-pom.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-pom.mdx new file mode 100644 index 0000000000..cfbc17960e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-pom.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-pom" +title: "setPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setPromptPom" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptPom` + +Set the prompt as a POM (Prompt Object Model) dictionary. + +Replaces the current POM sections with the provided structured data. +Each entry should have `title`, and optionally `body`, `bullets`, +`numbered`, `numberedBullets`, and `subsections`. + +## Signature + +```typescript +setPromptPom(pom: Record[]): this +``` + +## Parameters + + + Array of POM section dictionaries. + + +## Returns + +`this` — This agent instance for chaining. + +## Throws + +- Error if POM mode is not enabled (`usePom: false`). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 576. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-text.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-text.mdx new file mode 100644 index 0000000000..c4676d9467 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-text.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-prompt-text" +title: "setPromptText" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setPromptText" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptText` + +Set the main system prompt text for the AI. + +## Signature + +```typescript +setPromptText(text: string): this +``` + +## Parameters + + + The prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 445. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-pronunciations.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-pronunciations.mdx new file mode 100644 index 0000000000..ac86ac2d45 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-pronunciations.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-pronunciations" +title: "setPronunciations" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setPronunciations" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPronunciations` + +Replace all pronunciation rules with a new list. + +## Signature + +```typescript +setPronunciations(rules: PronunciationRule[]): this +``` + +## Parameters + + + Array of pronunciation rule objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 785. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-web-hook-url.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-web-hook-url.mdx new file mode 100644 index 0000000000..0288064328 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-web-hook-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/set-web-hook-url" +title: "setWebHookUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setWebHookUrl" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setWebHookUrl` + +Override the default SWAIG webhook URL with a custom one. + +## Signature + +```typescript +setWebHookUrl(url: string): this +``` + +## Parameters + + + The custom webhook URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1818. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/setup-graceful-shutdown.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/setup-graceful-shutdown.mdx new file mode 100644 index 0000000000..0cd5ffd079 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/setup-graceful-shutdown.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/setup-graceful-shutdown" +title: "setupGracefulShutdown" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.setupGracefulShutdown" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setupGracefulShutdown` + +Register process signal handlers for clean Kubernetes/Docker shutdown. +Handles SIGTERM and SIGINT, waits for a timeout, then exits. + +**Modifiers:** `static` + +## Signature + +```typescript +setupGracefulShutdown(opts?: { ...1 fields }): void +``` + +## Parameters + + + Optional timeout in milliseconds (default 5000). + + + + +## Returns + +`void` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2732. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/stop.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/stop.mdx new file mode 100644 index 0000000000..1e0cc0f444 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.stop" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `stop` + +Stop the HTTP server. +Mirrors Python's `stop()`. + +## Signature + +```typescript +stop(): void +``` + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 1009. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..05cc7faf72 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/swaig-pre-dispatch.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/swaig-pre-dispatch" +title: "swaigPreDispatch" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.swaigPreDispatch" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `swaigPreDispatch` + +Extension point: invoked between argument parsing and function dispatch +on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is +non-null, it's returned directly without dispatching. AgentBase may +override to add session-token validation or ephemeral dynamic-config. + +## Signature + +```typescript +swaigPreDispatch( + _requestData: Record, + _funcName: string +): [SWMLService, unknown] +``` + +## Parameters + + + + + +## Returns + +`[SWMLService, unknown]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 592. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/update-global-data.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/update-global-data.mdx new file mode 100644 index 0000000000..5041771216 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/update-global-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/update-global-data" +title: "updateGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.updateGlobalData" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `updateGlobalData` + +Merge additional entries into the existing global\_data object. + +## Signature + +```typescript +updateGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 837. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/validate-basic-auth.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/validate-basic-auth.mdx new file mode 100644 index 0000000000..d9fa46f0c1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/validate-basic-auth.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/validate-basic-auth" +title: "validateBasicAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.validateBasicAuth" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateBasicAuth` + +Override to add custom basic-auth validation logic beyond credential matching. + +## Signature + +```typescript +validateBasicAuth( + _username: string, + _password: string +): boolean | Promise +``` + +## Parameters + + + The username from the request. + + + + The password from the request. + + +## Returns + +`boolean | Promise` — True if the credentials are valid; false to reject the request. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1961. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/validate-tool-token.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/validate-tool-token.mdx new file mode 100644 index 0000000000..77db002344 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-agent/validate-tool-token.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-agent/validate-tool-token" +title: "validateToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistAgent.validateToolToken" + parent: "prefabs.ReceptionistAgent.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateToolToken` + +Validate a tool-call token for the given function. + +Mirrors Python reference `core/mixins/state_mixin.py validate_tool_token`: + +1. Unknown function → `false`. +2. Registered but non-secure → `true` without consulting SessionManager + (non-secure tools never require a token). +3. Raw-dict descriptors (e.g. DataMap) are treated as secure, matching + Python's `isinstance(func, dict) → is_secure = True` branch. +4. Missing token on a secure tool → `false`. +5. Otherwise delegate to `SessionManager.validateToolToken`. + +Divergences from the Python reference: + +- No debug-logging branch: `AgentBase` does not expose an agent-level + debug-mode flag, so the per-call debug telemetry Python emits is + omitted. `SessionManager` still logs its own validation outcomes. +- No token-derived call-id fallback: `SessionManager.debugToken` + truncates the embedded call-id for log safety, so an extracted value + cannot be round-tripped back through `validateToolToken`. The caller + is expected to supply a non-empty `callId`; an empty one is forwarded + unchanged and the underlying validator will reject it. + +## Signature + +```typescript +validateToolToken(functionName: string, token: string, callId: string): boolean +``` + +## Parameters + + + + + + + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1447. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-config/index.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-config/index.mdx new file mode 100644 index 0000000000..e10a89421c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-config/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-config" +title: "ReceptionistConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistConfig" + parent: "prefabs.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts" +--- +# `ReceptionistConfig` + +Configuration for the [ReceptionistAgent](/reference/typescript/prefabs/receptionist-agent/receptionist-agent). + +## Signature + +```typescript +interface ReceptionistConfig +``` + +## Properties + + + Additional AgentBase options forwarded to super(). + + + + Whether visitor check-in functionality is enabled. Default `false`. + + + + Optional company name. Appended to the greeting when provided. + + + + Departments the agent can transfer callers to. + + + + Initial greeting message. Defaults to the Python receptionist greeting. + + + + Agent display name (defaults to `"receptionist"`). + + + + Callback fired when a visitor checks in. + + + + HTTP route for this agent (defaults to `"/receptionist"`). + + + + Voice identifier passed to `addLanguage`. Defaults to `"rime.spore"`. + + +## Source + +[`src/prefabs/ReceptionistAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts) + +Line 27. diff --git a/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-department/index.mdx b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-department/index.mdx new file mode 100644 index 0000000000..8b655338a2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/receptionist-agent/receptionist-department/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/receptionist-agent/receptionist-department" +title: "ReceptionistDepartment" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "prefabs.ReceptionistAgent.ReceptionistDepartment" + parent: "prefabs.ReceptionistAgent" + module: "prefabs.ReceptionistAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts" +--- +# `ReceptionistDepartment` + +A department the receptionist can route callers to. + +## Signature + +```typescript +interface ReceptionistDepartment +``` + +## Properties + + + Description of the department's purpose (shown to the AI). + + + + Department identifier (e.g. `"sales"`, `"support"`). + + + + Phone number (or SIP address) used by `transfer_call`. + + +## Source + +[`src/prefabs/ReceptionistAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/ReceptionistAgent.ts) + +Line 17. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/create-survey-agent.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/create-survey-agent.mdx new file mode 100644 index 0000000000..127d77b14b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/create-survey-agent.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/create-survey-agent" +title: "createSurveyAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.createSurveyAgent" + parent: "prefabs.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts" +--- +# `createSurveyAgent` + +Factory function that creates and returns a new SurveyAgent. + +## Signature + +```typescript +createSurveyAgent(config: SurveyConfig): SurveyAgent +``` + +## Parameters + + + Configuration for the survey agent. + + +## Returns + +`SurveyAgent` — A configured SurveyAgent instance. + +## Source + +[`src/prefabs/SurveyAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts) + +Line 667. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/index.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/index.mdx new file mode 100644 index 0000000000..57aeffb6f6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent" +title: "SurveyAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "prefabs.SurveyAgent" + module: "prefabs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts" +--- +# `SurveyAgent` + +## Signature + +```typescript +module SurveyAgent +``` + +## Functions + + + + Factory function that creates and returns a new SurveyAgent. + + + +## Classes + + + + Prefab agent that conducts surveys with branching logic, answer scoring, and conditional question flow. + + + +## Interfaces + + + + Configuration for the [SurveyAgent](/reference/typescript/prefabs/survey-agent/survey-agent). + + + + A single survey question consumed by [SurveyAgent](/reference/typescript/prefabs/survey-agent/survey-agent). + + + +## Source + +[`src/prefabs/SurveyAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-answer-verb.mdx new file mode 100644 index 0000000000..4db8682e2b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-answer-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-answer-verb" +title: "addAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addAnswerVerb" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addAnswerVerb` + +Configure the answer verb (phase 2) with optional settings. + +## Signature + +```typescript +addAnswerVerb(config?: Record): this +``` + +## Parameters + + + Optional answer verb configuration. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1493. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-function-include.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-function-include.mdx new file mode 100644 index 0000000000..648db31e39 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-function-include.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-function-include" +title: "addFunctionInclude" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addFunctionInclude" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addFunctionInclude` + +Add a remote SWAIG function include reference. + +## Signature + +```typescript +addFunctionInclude( + url: string, + functions: string[], + metaData?: Record +): this +``` + +## Parameters + + + URL of the remote SWAIG endpoint. + + + + Function names available at that endpoint. + + + + Optional metadata to attach to the include. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 965. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-hint.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-hint.mdx new file mode 100644 index 0000000000..11c0676f76 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-hint.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-hint" +title: "addHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addHint" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHint` + +Add a single speech-recognition hint. + +## Signature + +```typescript +addHint(hint: string): this +``` + +## Parameters + + + Word or phrase to boost in speech recognition. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 652. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-hints.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-hints.mdx new file mode 100644 index 0000000000..4d9974110b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-hints.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-hints" +title: "addHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addHints" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addHints` + +Add multiple speech-recognition hints at once. + +## Signature + +```typescript +addHints(hints: string[]): this +``` + +## Parameters + + + Array of words or phrases to boost. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 662. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-internal-filler.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-internal-filler.mdx new file mode 100644 index 0000000000..7a90467090 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-internal-filler.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-internal-filler" +title: "addInternalFiller" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addInternalFiller" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addInternalFiller` + +Add internal filler phrases for a single internal function and language. + +See [setInternalFillers](/reference/typescript/prefabs/survey-agent/survey-agent/set-internal-fillers) for the complete list of supported +functionName values and an explanation of what fillers do. + +## Signature + +```typescript +addInternalFiller( + functionName: string, + languageCode: string, + fillers: string[] +): this +``` + +## Parameters + + + One of the supported internal function names (see SUPPORTED\_INTERNAL\_FILLER\_NAMES). Names outside the supported set log a warning and are ignored by the runtime. + + + + BCP-47 language code for the fillers (e.g. 'en-US'). + + + + Array of filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 942. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-language.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-language.mdx new file mode 100644 index 0000000000..b2eb8edf90 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-language.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-language" +title: "addLanguage" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addLanguage" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addLanguage` + +Add a supported language to the AI configuration. + +## Signature + +```typescript +addLanguage(config: LanguageConfig): this +``` + +## Parameters + + + Language configuration including name, code, voice, and optional fillers. `params` may be set to attach engine-specific tuning (voice stability, similarity boost, model knobs, etc.); only emitted into SWML when non-empty so existing entries stay byte-identical when no params are passed (Python ai\_config\_mixin.py `add_language`). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 693. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-mcp-server.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-mcp-server.mdx new file mode 100644 index 0000000000..88890abe6a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-mcp-server.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-mcp-server" +title: "addMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addMcpServer" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addMcpServer` + +Add an external MCP server for tool discovery and invocation. +Tools are discovered via MCP protocol at session start and added to the AI's tool list. + +## Signature + +```typescript +addMcpServer(url: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + MCP server HTTP endpoint URL + + + + Optional configuration: headers, resources, resourceVars + + + + + + + + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1145. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-pattern-hint.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-pattern-hint.mdx new file mode 100644 index 0000000000..478f549339 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-pattern-hint.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-pattern-hint" +title: "addPatternHint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addPatternHint" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPatternHint` + +Add a pattern-based speech-recognition hint with find-and-replace behavior. + +## Signature + +```typescript +addPatternHint(opts: { ...4 fields }): this +``` + +## Parameters + + + Pattern hint configuration with a descriptive hint label, regex pattern, replacement string, and optional case-insensitive flag. + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 673. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-post-ai-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-post-ai-verb.mdx new file mode 100644 index 0000000000..f78cc1ca2f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-post-ai-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-post-ai-verb" +title: "addPostAiVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addPostAiVerb" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAiVerb` + +Add a SWML verb to execute after the AI verb (phase 5). + +## Signature + +```typescript +addPostAiVerb(verbName: string, config: Record): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1515. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-post-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-post-answer-verb.mdx new file mode 100644 index 0000000000..92338e647a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-post-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-post-answer-verb" +title: "addPostAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addPostAnswerVerb" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPostAnswerVerb` + +Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + +## Signature + +```typescript +addPostAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb. + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1504. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-pre-answer-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-pre-answer-verb.mdx new file mode 100644 index 0000000000..8e3f7b540c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-pre-answer-verb.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-pre-answer-verb" +title: "addPreAnswerVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addPreAnswerVerb" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPreAnswerVerb` + +Add a SWML verb to execute before the answer phase (phase 1). + +## Signature + +```typescript +addPreAnswerVerb( + verbName: string, + config: number | Record +): this +``` + +## Parameters + + + Name of the SWML verb (e.g. "play", "record"). + + + + Verb configuration object. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1483. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-pronunciation.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-pronunciation.mdx new file mode 100644 index 0000000000..12ef8137a7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-pronunciation.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-pronunciation" +title: "addPronunciation" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addPronunciation" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addPronunciation` + +Add a pronunciation override rule for the TTS engine. + +## Signature + +```typescript +addPronunciation(rule: PronunciationRule): this +``` + +## Parameters + + + Pronunciation rule specifying the text to replace and its substitute. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 773. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-section.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-section.mdx new file mode 100644 index 0000000000..260fa09a00 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addSection" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addSection` + +Add a new named section to the SWML document. +Mirrors Python's `add_section()`. + +## Signature + +```typescript +addSection(sectionName: string): this +``` + +## Parameters + + + Name of the section to create. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 653. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-skill-by-name.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-skill-by-name.mdx new file mode 100644 index 0000000000..522a05b720 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-skill-by-name.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-skill-by-name" +title: "addSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addSkillByName" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkillByName` + +Add a skill by its registered name, looking it up in the global SkillRegistry. + +Matches Python's `add_skill(skill_name, params)` which loads skills by string +name via the SkillManager registry. Throws a `ValueError`-equivalent if the +skill name is not found in the registry. + +## Signature + +```typescript +addSkillByName(skillName: string, params?: SkillConfig): Promise +``` + +## Parameters + + + The name the skill was registered under in the SkillRegistry. + + + + Optional configuration parameters forwarded to the skill factory. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Throws + +- Error if no skill with the given name is registered. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1627. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-skill.mdx new file mode 100644 index 0000000000..543f62da45 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-skill" +title: "addSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addSkill" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSkill` + +Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + +## Signature + +```typescript +addSkill(skill: SkillBase): Promise +``` + +## Parameters + + + The skill instance to add. + + +## Returns + +`Promise` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1562. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-swaig-query-params.mdx new file mode 100644 index 0000000000..ecfa3ce08e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-swaig-query-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-swaig-query-params" +title: "addSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addSwaigQueryParams" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `addSwaigQueryParams` + +Add extra query parameters appended to all SWAIG webhook URLs. + +## Signature + +```typescript +addSwaigQueryParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to append as query parameters. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1714. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-verb-to-section.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-verb-to-section.mdx new file mode 100644 index 0000000000..0ba5adb021 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-verb-to-section.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-verb-to-section" +title: "addVerbToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addVerbToSection" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerbToSection` + +Add a verb to a specific named section. +Mirrors Python's `add_verb_to_section()`. + +## Signature + +```typescript +addVerbToSection(sectionName: string, verbName: string, config: unknown): this +``` + +## Parameters + + + Target section name (auto-created if missing). + + + + Verb name. + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 669. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-verb.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-verb.mdx new file mode 100644 index 0000000000..8192820ac1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/add-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/add-verb" +title: "addVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.addVerb" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerb` + +Add a verb to the SWML document. + +## Signature + +```typescript +addVerb(name: string, config: unknown): this +``` + +## Parameters + + + Verb name (e.g., 'answer', 'play', 'hangup'). + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 642. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/as-router.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/as-router.mdx new file mode 100644 index 0000000000..f88fdede68 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/as-router.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/as-router" +title: "asRouter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.asRouter" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `asRouter` + +Return this agent's Hono app for mounting as a sub-router in an AgentServer. + +## Signature + +```typescript +asRouter(): Hono +``` + +## Returns + +`Hono` — The Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2637. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/auto-map-sip-usernames.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/auto-map-sip-usernames.mdx new file mode 100644 index 0000000000..2beba8c46a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/auto-map-sip-usernames.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/auto-map-sip-usernames" +title: "autoMapSipUsernames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.autoMapSipUsernames" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `autoMapSipUsernames` + +Automatically register common SIP usernames based on this agent's +name and route. Derives cleaned variants (alphanumeric + underscore) +and registers each via `registerSipUsername()`. + +Port of Python's `auto_map_sip_usernames()`: + +- Registers a cleaned version of the agent name +- Registers a cleaned version of the route (if different from name) +- For names longer than 3 characters, also registers a vowel-stripped variant + +## Signature + +```typescript +autoMapSipUsernames(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1057. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/build-swml-for-request.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/build-swml-for-request.mdx new file mode 100644 index 0000000000..c1b33be00d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/build-swml-for-request.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/build-swml-for-request" +title: "buildSwmlForRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.buildSwmlForRequest" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `buildSwmlForRequest` + +Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` +to fully replace the document for this request, or `null` to fall +through to `setOnRequestCallback` or the static builder. + +This is distinct from the WebMixin `onRequest(requestData, +callbackPath)` hook on AgentBase (which mirrors Python's +`on_request -> on_swml_request` modification-merge contract). +Use this hook when you want to swap the entire SWML builder; use +`onRequest` / `onSwmlRequest` on AgentBase when you want to merge +targeted modifications into the rendered document. + +Default implementation returns `null` (no-op). + +## Signature + +```typescript +buildSwmlForRequest( + _queryParams: Record, + _bodyParams: Record, + _headers: Record, + _callbackPath?: string +): SwmlBuilder | null +``` + +## Parameters + + + + + + + + + +## Returns + +`SwmlBuilder | null` — A `SwmlBuilder` whose document is sent as the response, or `null` to delegate to the next handler in the chain. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 834. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-post-ai-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-post-ai-verbs.mdx new file mode 100644 index 0000000000..6c596c12b5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-post-ai-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/clear-post-ai-verbs" +title: "clearPostAiVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.clearPostAiVerbs" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAiVerbs` + +Remove all post-AI verbs. + +## Signature + +```typescript +clearPostAiVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1542. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-post-answer-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-post-answer-verbs.mdx new file mode 100644 index 0000000000..7f9c5f2d4f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-post-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/clear-post-answer-verbs" +title: "clearPostAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.clearPostAnswerVerbs" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPostAnswerVerbs` + +Remove all post-answer verbs. + +## Signature + +```typescript +clearPostAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1533. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-pre-answer-verbs.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-pre-answer-verbs.mdx new file mode 100644 index 0000000000..7493de56b6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-pre-answer-verbs.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/clear-pre-answer-verbs" +title: "clearPreAnswerVerbs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.clearPreAnswerVerbs" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearPreAnswerVerbs` + +Remove all pre-answer verbs. + +## Signature + +```typescript +clearPreAnswerVerbs(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1524. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-swaig-query-params.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-swaig-query-params.mdx new file mode 100644 index 0000000000..1c39ddef83 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/clear-swaig-query-params.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/clear-swaig-query-params" +title: "clearSwaigQueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.clearSwaigQueryParams" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `clearSwaigQueryParams` + +Clear all SWAIG query parameters. + +## Signature + +```typescript +clearSwaigQueryParams(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1723. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/constructor.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/constructor.mdx new file mode 100644 index 0000000000..5d6b549d1d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.constructor" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts" +--- +# `constructor` + +Create a SurveyAgent with the specified questions and callbacks. + +## Signature + +```typescript +constructor(config: SurveyConfig): SurveyAgent +``` + +## Parameters + + + Configuration including questions, messages, and completion callback. + + +## Returns + +`SurveyAgent` + +## Source + +[`src/prefabs/SurveyAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts) + +Line 133. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/create-tool-token.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/create-tool-token.mdx new file mode 100644 index 0000000000..3573591704 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/create-tool-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/create-tool-token" +title: "createToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.createToolToken" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `createToolToken` + +Mint a per-call SWAIG-function token via the agent's SessionManager. + +Mirrors Python reference `core/mixins/state_mixin.py _create_tool_token`: +delegates to `SessionManager.createToolToken` and returns an empty +string on any failure (Python catches all exceptions and returns ""). + +## Signature + +```typescript +createToolToken(toolName: string, callId: string): string +``` + +## Parameters + + + + + +## Returns + +`string` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1467. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-contexts.mdx new file mode 100644 index 0000000000..6683c66e97 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-contexts.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/define-contexts" +title: "defineContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.defineContexts" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineContexts` + +Define or replace the contexts configuration for the AI verb. + +## Signature + +```typescript +defineContexts( + contexts?: Record | ContextBuilder +): ContextBuilder +``` + +## Parameters + + + An existing ContextBuilder instance or a plain object; a new ContextBuilder is created if omitted. + + +## Returns + +`ContextBuilder` — The active ContextBuilder for further configuration. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 603. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-tool.mdx new file mode 100644 index 0000000000..740a69d955 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-tool.mdx @@ -0,0 +1,114 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.defineTool" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTool` + +Register a SWAIG tool (function) that the AI can invoke during a call. + +## How this becomes a tool the model sees + +A SWAIG function is **exactly the same concept** as a "tool" in +native OpenAI / Anthropic tool calling. On every LLM turn, the SDK +renders each registered SWAIG function into the OpenAI tool schema: + +```json +{ +"type": "function", +"function": { +"name": "your_name_here", +"description": "your description text", +"parameters": { /* your JSON schema */ } +} +} +``` + +That schema goes to the model in the same API call that produces +the next assistant message. The model reads: + +- the **function `description`** to decide WHEN to call this tool +- each **parameter `description`** (inside the JSON schema) to + decide HOW to fill in each argument + +This means **descriptions are prompt engineering**, not developer +comments. A vague description is the #1 cause of "the model has the +right tool but doesn't call it" failures. + +### Bad vs good descriptions + +```text +BAD : description: 'Lookup function' +GOOD: description: 'Look up a customer's account details by account +number. Use this BEFORE quoting any account-specific info +(balance, plan, status). Do not use for general product +questions.' + +BAD : parameters: { id: { type: 'string', description: 'the id' } } +GOOD: parameters: { account_number: { type: 'string', description: +'The customer's 8-digit account number, no dashes or spaces. +Ask the user if they don't provide it.' } } +``` + +### Tool count matters + +LLM tool selection accuracy degrades past ~7-8 simultaneously-active +tools per call. Use Step.setFunctions() to partition tools across +steps so only the relevant subset is active at any moment. + +## Signature + +```typescript +defineTool(opts: { ...11 fields }): this +``` + +## Parameters + + + Tool definition including name, description, parameter schema, and handler callback. `description` and per-parameter `description` strings are LLM-facing prompt engineering. + + + + + Additional fields to pass through to the SWAIG function definition (Python `**swaig_fields` equivalent). + + + + + + + + + + + + + + + + + + + + External webhook URL; makes this an externally-hosted tool. + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1329. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-tools.mdx new file mode 100644 index 0000000000..d1006a5ee7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/define-tools" +title: "defineTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.defineTools" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts" + visibility: "protected" +--- +# `defineTools` + +Register SWAIG tools: + +- Python-parity tools: `validate_response`, `log_response` +- TS-specific session tools: `answer_question`, `get_current_question`, `get_survey_progress` + +## Signature + +```typescript +defineTools(): void +``` + +## Returns + +`void` + +## Source + +[`src/prefabs/SurveyAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts) + +Line 409. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-typed-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-typed-tool.mdx new file mode 100644 index 0000000000..1f694b2fb8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/define-typed-tool.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/define-typed-tool" +title: "defineTypedTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.defineTypedTool" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `defineTypedTool` + +Register a SWAIG tool with a typed handler that receives named parameters +instead of the standard `(args, rawData)` convention. + +The SDK wraps the handler to unpack the args dict into positional params. +If no `parameters` schema is provided, one is inferred from the handler's +source code (parameter names and default values). + +## Signature + +```typescript +defineTypedTool(opts: { ...9 fields }): this +``` + +## Parameters + + + Tool definition with a typed handler function. + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1372. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-debug-events.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-debug-events.mdx new file mode 100644 index 0000000000..898ff21382 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-debug-events.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/enable-debug-events" +title: "enableDebugEvents" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.enableDebugEvents" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugEvents` + +Enable debug event webhooks for this agent. + +## Signature + +```typescript +enableDebugEvents(level: number = 1): this +``` + +## Parameters + + + Debug verbosity level (defaults to 1). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1010. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-debug-routes.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-debug-routes.mdx new file mode 100644 index 0000000000..0077861033 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-debug-routes.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/enable-debug-routes" +title: "enableDebugRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.enableDebugRoutes" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableDebugRoutes` + +Register a callback function that determines routing based on POST data. + +When a routing callback is registered, an endpoint at the specified path +is created in `getApp()`. The callback receives the request body and returns +Enable debug routes for testing and development. + +This is a backward-compatibility stub matching the Python SDK. +In the TypeScript SDK, debug routes (health, ready, debug\_events) +are automatically registered in `getApp()`. + +## Signature + +```typescript +enableDebugRoutes(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1754. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-mcp-server.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-mcp-server.mdx new file mode 100644 index 0000000000..8052fefb2f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-mcp-server.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/enable-mcp-server" +title: "enableMcpServer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.enableMcpServer" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableMcpServer` + +Expose this agent's tools as an MCP server endpoint at /mcp. +Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + +## Signature + +```typescript +enableMcpServer(): this +``` + +## Returns + +`this` — This agent instance for chaining + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1159. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-sip-routing.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-sip-routing.mdx new file mode 100644 index 0000000000..bbfdad924b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/enable-sip-routing.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/enable-sip-routing" +title: "enableSipRouting" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.enableSipRouting" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `enableSipRouting` + +Enable SIP routing for this agent. + +## Signature + +```typescript +enableSipRouting(autoMap: boolean = true, path: string = '/sip'): this +``` + +## Parameters + + + When true, automatically map SIP usernames to the agent route (defaults to true). + + + + HTTP path for the SIP routing endpoint (defaults to '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1024. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/extract-sip-username.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/extract-sip-username.mdx new file mode 100644 index 0000000000..74735900de --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/extract-sip-username.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/extract-sip-username" +title: "extractSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.extractSipUsername" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `extractSipUsername` + +Extract the SIP username from a request body's call.to field. + +**Modifiers:** `static` + +## Signature + +```typescript +extractSipUsername(requestBody: Record): string | null +``` + +## Parameters + + + The parsed request body containing call information. + + +## Returns + +`string | null` — The extracted SIP username, or null if not found. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1121. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-all-functions.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-all-functions.mdx new file mode 100644 index 0000000000..361cc9a210 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-all-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-all-functions" +title: "getAllFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getAllFunctions" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getAllFunctions` + +Snapshot of all registered SWAIG functions keyed by name. +(Python parity: `ToolRegistry.get_all_functions`.) + +## Signature + +```typescript +getAllFunctions(): Record> +``` + +## Returns + +`Record>` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 529. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-app.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-app.mdx new file mode 100644 index 0000000000..84e8ed54db --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-app.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-app" +title: "getApp" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getApp" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getApp` + +Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + +## Signature + +```typescript +getApp(): Hono +``` + +## Returns + +`Hono` — The configured Hono application instance. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2250. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..03be97610b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-basic-auth-credentials.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-basic-auth-credentials" +title: "getBasicAuthCredentials" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getBasicAuthCredentials" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getBasicAuthCredentials` + +Get the basic-auth credentials used by this agent. + +## Signature + + + + ```typescript + getBasicAuthCredentials(includeSource?: false): [string, string] + ``` + + + + ```typescript + getBasicAuthCredentials( + includeSource: true + ): [string, string, "provided" | "environment" | "generated"] + ``` + + + +## Parameters (Overload 1) + + + When true, a third element indicating the credential source is appended. + + +## Parameters (Overload 2) + + + When true, a third element indicating the credential source is appended. + + +## Returns (Overload 1) + +`[string, string]` — A tuple of \[username, password] or \[username, password, source]. + +## Returns (Overload 2) + +`[string, string, "provided" | "environment" | "generated"]` — A tuple of \[username, password] or \[username, password, source]. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2775. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-builder.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-builder.mdx new file mode 100644 index 0000000000..30db9b6708 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-builder.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-builder" +title: "getBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getBuilder" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getBuilder` + +Get the underlying SwmlBuilder for direct manipulation. + +## Signature + +```typescript +getBuilder(): SwmlBuilder +``` + +## Returns + +`SwmlBuilder` — The SwmlBuilder instance. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 632. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-contexts.mdx new file mode 100644 index 0000000000..ce7425620b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-contexts" +title: "getContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getContexts" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getContexts` + +Get the contexts dictionary as serialised SWML, or null when no +contexts have been defined yet. + +Matches Python `PromptManager.get_contexts()` which returns the +contexts dict or `None`. + +## Signature + +```typescript +getContexts(): Record | null +``` + +## Returns + +`Record | null` — Contexts dict, or null when no contexts are defined. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 640. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-document.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-document.mdx new file mode 100644 index 0000000000..4d0fe05c6f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-document" +title: "getDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getDocument" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getDocument` + +Get the SWML document as a dictionary. +Alias for `renderSwml()` that matches Python's `get_document()` name. + +## Signature + +```typescript +getDocument(): Record +``` + +## Returns + +`Record` — The SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 706. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-full-url.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-full-url.mdx new file mode 100644 index 0000000000..537a43050a --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-full-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-full-url" +title: "getFullUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getFullUrl" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getFullUrl` + +Get the full external URL of this agent, using the proxy base URL if available. + +## Signature + +```typescript +getFullUrl(includeAuth: boolean = false): string +``` + +## Parameters + + + Whether to embed basic-auth credentials in the URL (defaults to false). + + +## Returns + +`string` — The fully-qualified URL string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1838. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-function.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-function.mdx new file mode 100644 index 0000000000..333e85f6e2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-function" +title: "getFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getFunction" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getFunction` + +Get a registered SWAIG function entry, or undefined. +(Python parity: `ToolRegistry.get_function`.) + +## Signature + +```typescript +getFunction(name: string): Record | SwaigFunction | undefined +``` + +## Parameters + + + +## Returns + +`Record | SwaigFunction | undefined` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 523. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-language-params.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-language-params.mdx new file mode 100644 index 0000000000..9481c3509e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-language-params.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-language-params" +title: "getLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getLanguageParams" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getLanguageParams` + +Read the per-language `params` dict for a previously-added language. + +Python parity: `get_language_params(code)`. Returns `undefined` if the +code is unknown or the language has no params set — no exception path. + +## Signature + +```typescript +getLanguageParams(code: string): Record | undefined +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/prefabs/survey-agent/survey-agent/add-language). + + +## Returns + +`Record | undefined` — The params dict if set, `undefined` otherwise (including when the code is unknown). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 759. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-mcp-servers.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-mcp-servers.mdx new file mode 100644 index 0000000000..3741755bc5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-mcp-servers.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-mcp-servers" +title: "getMcpServers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getMcpServers" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getMcpServers` + +Get configured MCP servers (read-only copy). + +## Signature + +```typescript +getMcpServers(): Record[] +``` + +## Returns + +`Record[]` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1170. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-name.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-name.mdx new file mode 100644 index 0000000000..540afb03d4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-name" +title: "getName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getName" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getName` + +Get the agent's display name. + +## Signature + +```typescript +getName(): string +``` + +## Returns + +`string` — The agent name string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1551. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-post-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-post-prompt.mdx new file mode 100644 index 0000000000..32c9128aa7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-post-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-post-prompt" +title: "getPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getPostPrompt" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPostPrompt` + +Get the post-prompt text, if one has been set. + +## Signature + +```typescript +getPostPrompt(): string | null +``` + +## Returns + +`string | null` — The post-prompt string, or null if not configured. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 547. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-prompt-pom.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-prompt-pom.mdx new file mode 100644 index 0000000000..27796a8744 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-prompt-pom.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-prompt-pom" +title: "getPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getPromptPom" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPromptPom` + +Get the raw POM (Prompt Object Model) structure as an array of section data objects, +when the agent is in POM mode and has at least one section. + +Matches Python `get_prompt()` which returns `Union[str, List[Dict]]` — a raw list when +in POM mode (via `pom.to_list()` / `pom.render_dict()`), or a string otherwise. +The TS `getPrompt()` always returns a string (rendered Markdown), so this companion +method exposes the raw POM structure for callers that need it for serialisation or +inspection (e.g. skills that inspect prompt sections). + +## Signature + +```typescript +getPromptPom(): Record[] | null +``` + +## Returns + +`Record[] | null` — An array of POM section data objects, or null if not in POM mode or POM is empty. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 535. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-prompt.mdx new file mode 100644 index 0000000000..b9454d750c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-prompt" +title: "getPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getPrompt" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getPrompt` + +Get the fully rendered main prompt text. + +## Signature + +```typescript +getPrompt(): string +``` + +## Returns + +`string` — The assembled prompt string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 519. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-raw-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-raw-prompt.mdx new file mode 100644 index 0000000000..e69ace7ad5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-raw-prompt.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-raw-prompt" +title: "getRawPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getRawPrompt" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getRawPrompt` + +Get the raw prompt text whatever `setPromptText` stored, or null when +no raw prompt has been set. + +Matches Python `PromptManager.get_raw_prompt()` which returns the raw +stored string or `None`. Use this instead of `getPrompt()` when you +need the unrendered text rather than the POM-rendered Markdown. + +## Signature + +```typescript +getRawPrompt(): string | null +``` + +## Returns + +`string | null` — The raw prompt string, or null if not set. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 561. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-registered-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-registered-tools.mdx new file mode 100644 index 0000000000..2909c24b20 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-registered-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-registered-tools" +title: "getRegisteredTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getRegisteredTools" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getRegisteredTools` + +Get a summary of all registered tools with their names, descriptions, and +parameter schemas. Lifted from AgentBase so the swaig-test CLI can list +tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG +host). + +## Signature + +```typescript +getRegisteredTools(): { description: string; name: string; parameters: Record }[] +``` + +## Returns + +`{ description: string; name: string; parameters: Record }[]` — Array of tool descriptors. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-tool.mdx new file mode 100644 index 0000000000..77dae0d2e2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-tool.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-tool" +title: "getTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getTool" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getTool` + +Look up a registered SwaigFunction by name. Lifted from AgentBase so +`swaig-test --exec ` works against a non-AgentBase SWMLService +target. + +## Signature + +```typescript +getTool(name: string): SwaigFunction | undefined +``` + +## Parameters + + + The tool name to search for. + + +## Returns + +`SwaigFunction | undefined` — The SwaigFunction instance, or undefined if not found or not a SwaigFunction. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 581. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-tools.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-tools.mdx new file mode 100644 index 0000000000..212a940875 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/get-tools.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.getTools" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `getTools` + +Public access to the list of registered tools. + +In Python, `define_tools()` is public and returns `List[SWAIGFunction]`. +In TypeScript, `defineTools()` is a protected setup hook (void). This +method provides the equivalent public "get all tools" capability. + +## Signature + +```typescript +getTools(): SwaigFunction[] +``` + +## Returns + +`SwaigFunction[]` — Array of all registered SwaigFunction instances. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 370. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/handle-mcp-request.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/handle-mcp-request.mdx new file mode 100644 index 0000000000..384da3f6a0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/handle-mcp-request.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/handle-mcp-request" +title: "handleMcpRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.handleMcpRequest" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `handleMcpRequest` + +Handle an MCP JSON-RPC 2.0 request. Returns the response object. + +## Signature + +```typescript +handleMcpRequest( + body: Record +): Promise> +``` + +## Parameters + + + +## Returns + +`Promise>` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1203. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/has-function.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/has-function.mdx new file mode 100644 index 0000000000..92e1bc326b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/has-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/has-function" +title: "hasFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.hasFunction" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasFunction` + +Whether a SWAIG function with the given name is registered. +(Python parity: `ToolRegistry.has_function`.) + +## Signature + +```typescript +hasFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 517. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/has-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/has-skill.mdx new file mode 100644 index 0000000000..d28d68f509 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/has-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/has-skill" +title: "hasSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.hasSkill" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `hasSkill` + +Check whether a skill with the given name is registered. + +## Signature + +```typescript +hasSkill(skillName: string): boolean +``` + +## Parameters + + + The skill name to check. + + +## Returns + +`boolean` — True if a skill with that name exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1657. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/has-tool.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/has-tool.mdx new file mode 100644 index 0000000000..f4dfbf5cfa --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/has-tool.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/has-tool" +title: "hasTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.hasTool" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasTool` + +Whether a tool with the given name is registered. + +## Signature + +```typescript +hasTool(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/index.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/index.mdx new file mode 100644 index 0000000000..20f4c68126 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/index.mdx @@ -0,0 +1,615 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent" +title: "SurveyAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent" + parent: "prefabs.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts" +--- +# `SurveyAgent` + +Prefab agent that conducts surveys with branching logic, answer scoring, and conditional question flow. + +Each survey question declares its response type (rating, yes/no, open text, etc.), an optional +set of conditional follow-ups, and a scoring map. The agent walks the question tree, tallies a +total score, and exposes the full response map at call end via `onSummary()`. + +## Signature + +```typescript +class SurveyAgent extends AgentBase +``` + +## Inheritance + +**Extends:** [AgentBase](/reference/typescript/agent-base) + +## Examples + +```typescript +import { SurveyAgent } from '@signalwire/sdk'; + +const agent = new SurveyAgent({ + surveyName: 'CSAT', + brandName: 'Acme Co', + questions: [ + { id: 'q1', text: 'How satisfied were you with our service?', type: 'rating', scale: 5 }, + { id: 'q2', text: 'Would you recommend us to a friend?', type: 'yesno' }, + { id: 'q3', text: 'Anything else you want to share?', type: 'open' }, + ], +}); + +await agent.serve({ port: 3000 }); +``` + +## Properties + + + Unique identifier for this agent instance. + + + + + + + + Brand/company name used in prompts. + + + + Closing message shown when the survey completes. + + + + Domain name for SSL. Mirrors Python's `self.domain`. + + + + Check if full JSON Schema validation is enabled. Mirrors Python's `@property full_validation_enabled`. + + + + Host the server binds to. + + + + Opening message before the first question. + + + + Structured logger instance for this agent. Override the inherited SWMLService logger with an AgentBase-tagged one. + + + + Maximum number of times to retry invalid answers. + + + + Service display name. + + + + Public accessor for the native functions list. Python exposes `self.native_functions` as a public read/write attribute. + + + + + + Public accessor for the agent's POM as a `PromptObjectModel` instance. Python parity: `agent.pom` instance attribute (agent\_base.py line 209) is a `signalwire.pom.pom.PromptObjectModel` when `use_pom=True`, or `None` otherwise. This getter returns the equivalent TypeScript `PromptObjectModel` instance — callers can use `addSection`, `findSection`, `renderMarkdown`, `renderXml`, `toJson`, `toYaml` exactly as in Python. The instance returned is a fresh snapshot built from the current `PomBuilder` state, so mutating it does not feed back into the agent's internal builder. To mutate the agent's prompt, use `promptAddSection` / `promptAddToSection` / `promptAddSubsection`. + + + + Port the server binds to. + + + + Static prompt sections: subclasses can define these declaratively. Each entry is applied via promptAddSection() in the constructor. + + + + Public accessor for the PromptManager (POM). Python exposes `self.pom` as a public attribute. This getter provides equivalent access for direct POM manipulation. + + + + The configured survey questions (public, matching Python). + + + + HTTP route path. + + + + Schema validation utilities. Mirrors Python's `self.schema_utils`. + + + + Unified security configuration. Mirrors Python's `self.security`. + + + + Public read-only accessor for the SkillManager. Python exposes `self.skill_manager` as a public attribute. This getter provides equivalent read access. + + + + Path to SSL certificate. Mirrors Python's `self.ssl_cert_path`. + + + + Whether SSL is enabled. Mirrors Python's `self.ssl_enabled`. + + + + Path to SSL private key. Mirrors Python's `self.ssl_key_path`. + + + + The complete set of internal SWAIG function names that accept fillers, matching the SWAIGInternalFiller schema definition. Any name outside this set is silently ignored by the runtime — addInternalFiller / setInternalFillers warn if you pass an unknown name. + + + + Human-readable survey name. + + + + + + + + Custom verb handler registry. Mirrors Python's `self.verb_registry`. + + +## Methods + + + + Configure the answer verb (phase 2) with optional settings. + + + + Add a remote SWAIG function include reference. + + + + Add a single speech-recognition hint. + + + + Add multiple speech-recognition hints at once. + + + + Add internal filler phrases for a single internal function and language. + + + + Add a supported language to the AI configuration. + + + + Add an external MCP server for tool discovery and invocation. Tools are discovered via MCP protocol at session start and added to the AI's tool list. + + + + Add a pattern-based speech-recognition hint with find-and-replace behavior. + + + + Add a SWML verb to execute after the AI verb (phase 5). + + + + Add a SWML verb to execute after the answer phase but before the AI verb (phase 3). + + + + Add a SWML verb to execute before the answer phase (phase 1). + + + + Add a pronunciation override rule for the TTS engine. + + + + Add a new named section to the SWML document. Mirrors Python's `add_section()`. + + + + Add a skill to this agent, registering its tools, prompt sections, hints, and global data. + + + + Add a skill by its registered name, looking it up in the global SkillRegistry. + + + + Add extra query parameters appended to all SWAIG webhook URLs. + + + + Add a verb to the SWML document. + + + + Add a verb to a specific named section. Mirrors Python's `add_verb_to_section()`. + + + + Return this agent's Hono app for mounting as a sub-router in an AgentServer. + + + + Automatically register common SIP usernames based on this agent's name and route. Derives cleaned variants (alphanumeric + underscore) and registers each via `registerSipUsername()`. + + + + Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` to fully replace the document for this request, or `null` to fall through to `setOnRequestCallback` or the static builder. + + + + Remove all post-AI verbs. + + + + Remove all post-answer verbs. + + + + Remove all pre-answer verbs. + + + + Clear all SWAIG query parameters. + + + + Create a SurveyAgent with the specified questions and callbacks. + + + + Mint a per-call SWAIG-function token via the agent's SessionManager. + + + + Define or replace the contexts configuration for the AI verb. + + + + Register a SWAIG tool (function) that the AI can invoke during a call. + + + + Register SWAIG tools: - Python-parity tools: `validate_response`, `log_response` - TS-specific session tools: `answer_question`, `get_current_question`, `get_survey_progress` + + + + Register a SWAIG tool with a typed handler that receives named parameters instead of the standard `(args, rawData)` convention. + + + + Enable debug event webhooks for this agent. + + + + Register a callback function that determines routing based on POST data. + + + + Expose this agent's tools as an MCP server endpoint at /mcp. Adds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to. + + + + Enable SIP routing for this agent. + + + + Extract the SIP username from a request body's call.to field. + + + + Snapshot of all registered SWAIG functions keyed by name. (Python parity: `ToolRegistry.get_all_functions`.) + + + + Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS. + + + + Get the basic-auth credentials used by this agent. + + + + Get the underlying SwmlBuilder for direct manipulation. + + + + Get the contexts dictionary as serialised SWML, or null when no contexts have been defined yet. + + + + Get the SWML document as a dictionary. Alias for `renderSwml()` that matches Python's `get_document()` name. + + + + Get the full external URL of this agent, using the proxy base URL if available. + + + + Get a registered SWAIG function entry, or undefined. (Python parity: `ToolRegistry.get_function`.) + + + + Read the per-language `params` dict for a previously-added language. + + + + Get configured MCP servers (read-only copy). + + + + Get the agent's display name. + + + + Get the post-prompt text, if one has been set. + + + + Get the fully rendered main prompt text. + + + + Get the raw POM (Prompt Object Model) structure as an array of section data objects, when the agent is in POM mode and has at least one section. + + + + Get the raw prompt text whatever `setPromptText` stored, or null when no raw prompt has been set. + + + + Get a summary of all registered tools with their names, descriptions, and parameter schemas. Lifted from AgentBase so the swaig-test CLI can list tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG host). + + + + Look up a registered SwaigFunction by name. Lifted from AgentBase so `swaig-test --exec ` works against a non-AgentBase SWMLService target. + + + + Public access to the list of registered tools. + + + + Handle an MCP JSON-RPC 2.0 request. Returns the response object. + + + + Whether a SWAIG function with the given name is registered. (Python parity: `ToolRegistry.has_function`.) + + + + Check whether a skill with the given name is registered. + + + + Whether a tool with the given name is registered. + + + + Check if MCP server endpoint is enabled. + + + + List all registered skills with their names, instance IDs, and initialization status. + + + + List registered tool names in insertion order (Map preserves it). + + + + Manually set the proxy base URL used for webhook URL generation. + + + + Lifecycle hook called when a debug event webhook is received. Override in subclasses. + + + + Hook called before each SWAIG function execution. Override in subclasses. + + + + Lifecycle hook called when SWML is requested. Default delegates to [onSwmlRequest](/reference/typescript/prefabs/survey-agent/survey-agent/on-swml-request) and returns its result. Subclasses typically override `onSwmlRequest` rather than this method. + + + + Process the survey results summary returned at the end of a call. Mirrors Python `on_summary`: structured (dict-like) summaries are logged as JSON; unstructured summaries are logged verbatim. + + + + Lifecycle hook called on every SWML request before rendering. Override in subclasses. + + + + Add a new section to the prompt with optional body, bullets, and subsections. + + + + Add a subsection under an existing prompt section. + + + + Append content to an existing prompt section. + + + + Check whether a prompt section with the given title exists. + + + + Extension point: register additional Hono routes after SWMLService mounts /health, /ready, /swaig, and the main route. AgentBase uses this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + + + + Register a callback at a specific HTTP path that decides how to route an incoming request. + + + + Register a SIP username to route to this agent. + + + + Register a SwaigFunction instance or a raw function descriptor (DataMap). + + + + Register a custom verb handler. Mirrors Python's `register_verb_handler()`. + + + + Remove a registered SWAIG function. Returns true when removed, false when not found. (Python parity: `ToolRegistry.remove_function`.) + + + + Remove a previously added skill by its instance ID. + + + + Remove a skill by its name (Python parity). + + + + Render the SWML document as a JSON string. Mirrors Python's `render_document()`. + + + + Render the complete SWML document by assembling all 5 phases: pre-answer, answer, post-answer, AI, and post-AI verbs. + + + + Remove all contexts, returning the agent to a no-contexts state. + + + + Reset the SWML document to an empty state. Mirrors Python's `reset_document()`. + + + + Alias for [serve](/reference/typescript/prefabs/survey-agent/survey-agent/serve). Starts the HTTP server. + + + + Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + + + + Start the HTTP server and begin listening for requests. + + + + Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + + + + Replace the entire list of function includes. Each include must have a `url` and `functions` array. + + + + Merge data into the global\_data object passed into the AI configuration. + + + + Set internal fillers for native SWAIG functions. + + + + Set (or replace) the per-language `params` dict on an already-added language. Useful when language entries are built up via [addLanguage](/reference/typescript/prefabs/survey-agent/survey-agent/add-language) first and engine-specific tuning is added later (e.g., from a config loader). + + + + Replace all configured languages with a new list. + + + + Set the list of native SWAIG function names (built-in platform functions). + + + + Set a callback invoked per-request to dynamically build SWML. When set, the static SwmlBuilder is ignored and the callback's returned SwmlBuilder is used instead. + + + + Set a single AI parameter (e.g. "temperature", "top\_p"). + + + + Merge multiple AI parameters into the existing params object. + + + + Set the post-prompt text evaluated after the call ends. + + + + Merge LLM-specific parameters into the post-prompt configuration. + + + + Override the default post-prompt webhook URL with a custom one. + + + + Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + + + + Set the prompt as a POM (Prompt Object Model) dictionary. + + + + Set the main system prompt text for the AI. + + + + Replace all pronunciation rules with a new list. + + + + Register process signal handlers for clean Kubernetes/Docker shutdown. Handles SIGTERM and SIGINT, waits for a timeout, then exits. + + + + Override the default SWAIG webhook URL with a custom one. + + + + Stop the HTTP server. Mirrors Python's `stop()`. + + + + Extension point: invoked between argument parsing and function dispatch on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is non-null, it's returned directly without dispatching. AgentBase may override to add session-token validation or ephemeral dynamic-config. + + + + Merge additional entries into the existing global\_data object. + + + + Override to add custom basic-auth validation logic beyond credential matching. + + + + Validate a tool-call token for the given function. + + + +## Source + +[`src/prefabs/SurveyAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts) + +Line 111. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/is-mcp-server-enabled.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/is-mcp-server-enabled.mdx new file mode 100644 index 0000000000..c200dbbf2b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/is-mcp-server-enabled.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/is-mcp-server-enabled" +title: "isMcpServerEnabled" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.isMcpServerEnabled" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `isMcpServerEnabled` + +Check if MCP server endpoint is enabled. + +## Signature + +```typescript +isMcpServerEnabled(): boolean +``` + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1165. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/list-skills.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/list-skills.mdx new file mode 100644 index 0000000000..822e847db9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/list-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/list-skills" +title: "listSkills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.listSkills" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `listSkills` + +List all registered skills with their names, instance IDs, and initialization status. + +## Signature + +```typescript +listSkills(): { initialized: boolean; instanceId: string; name: string }[] +``` + +## Returns + +`{ initialized: boolean; instanceId: string; name: string }[]` — Array of skill descriptors. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1648. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/list-tool-names.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/list-tool-names.mdx new file mode 100644 index 0000000000..c6cf1c8563 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/list-tool-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/list-tool-names" +title: "listToolNames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.listToolNames" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `listToolNames` + +List registered tool names in insertion order (Map preserves it). + +## Signature + +```typescript +listToolNames(): string[] +``` + +## Returns + +`string[]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 545. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/manual-set-proxy-url.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..937ac92741 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/manual-set-proxy-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/manual-set-proxy-url" +title: "manualSetProxyUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.manualSetProxyUrl" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `manualSetProxyUrl` + +Manually set the proxy base URL used for webhook URL generation. + +## Signature + +```typescript +manualSetProxyUrl(url: string): this +``` + +## Parameters + + + The external-facing base URL (trailing slashes are stripped). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1735. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-debug-event.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-debug-event.mdx new file mode 100644 index 0000000000..c9b10153c4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-debug-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/on-debug-event" +title: "onDebugEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.onDebugEvent" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onDebugEvent` + +Lifecycle hook called when a debug event webhook is received. Override in subclasses. + +## Signature + +```typescript +onDebugEvent(_event: Record): void | Promise +``` + +## Parameters + + + The debug event payload. + + +## Returns + +`void | Promise` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1951. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-function-call.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-function-call.mdx new file mode 100644 index 0000000000..447febd638 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-function-call.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/on-function-call" +title: "onFunctionCall" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.onFunctionCall" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onFunctionCall` + +Hook called before each SWAIG function execution. Override in subclasses. + +**Behavioral note:** In the Python SDK, `on_function_call` IS the dispatcher +— it retrieves and executes the function, returning the result. In TypeScript, +`fn.execute()` is called separately after this hook. However, if this method +returns a non-void value, it is used as the result and the default execution +is skipped, enabling dispatch interception parity with Python. + +## Signature + +```typescript +onFunctionCall( + _name: string, + _args: Record, + _rawData: Record +): void | Record | Promise> +``` + +## Parameters + + + Name of the function about to execute. + + + + Parsed arguments for the function. + + + + The full raw SWAIG request payload. + + +## Returns + +`void | Record | Promise>` — Optionally a result dict to short-circuit default execution, or void/undefined to proceed normally. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1980. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-request.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-request.mdx new file mode 100644 index 0000000000..c965b0dc31 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-request.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/on-request" +title: "onRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.onRequest" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onRequest` + +Lifecycle hook called when SWML is requested. Default delegates to +[onSwmlRequest](/reference/typescript/prefabs/survey-agent/survey-agent/on-swml-request) and returns its result. Subclasses typically +override `onSwmlRequest` rather than this method. + +Matches Python `WebMixin.on_request(request_data, callback_path)`. The +cross-language API is the two-arg form; the Hono `context` argument is +a TypeScript-side extra preserved for callers that already have it but +is not part of the audited surface. + +## Signature + +```typescript +onRequest( + requestData?: Record | null, + callbackPath?: string | null +): void | Record | Promise> +``` + +## Parameters + + + The parsed request body. + + + + Optional callback path from the request. + + +## Returns + +`void | Record | Promise>` — Optionally a dict of SWML modifications, or undefined for default rendering. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1916. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-summary.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-summary.mdx new file mode 100644 index 0000000000..e1a47a1aad --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-summary.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/on-summary" +title: "onSummary" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.onSummary" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts" +--- +# `onSummary` + +Process the survey results summary returned at the end of a call. +Mirrors Python `on_summary`: structured (dict-like) summaries are logged +as JSON; unstructured summaries are logged verbatim. + +The parameter type widens the base `AgentBase.onSummary` signature to +accept string payloads as well, matching Python's `isinstance(summary, dict)` +branch even though the current framework only surfaces object summaries. + +## Signature + +```typescript +onSummary( + summary: string | Record | null, + _rawData: Record +): void | Promise +``` + +## Parameters + + + + + +## Returns + +`void | Promise` + +## Source + +[`src/prefabs/SurveyAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts) + +Line 639. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-swml-request.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-swml-request.mdx new file mode 100644 index 0000000000..a17584b470 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/on-swml-request.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/on-swml-request" +title: "onSwmlRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.onSwmlRequest" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `onSwmlRequest` + +Lifecycle hook called on every SWML request before rendering. Override in subclasses. + +May optionally return a modification dict that will be merged into the +rendered SWML document (matching Python's `Optional[dict]` return type). + +Matches Python `on_swml_request(request_data, callback_path, request)` — the third +parameter is the FastAPI `Request` in Python; here it is the raw Hono context object +so that subclasses can access query parameters (`context.req.query()`), raw request +headers (`context.req.raw.headers`), etc. + +## Signature + +```typescript +onSwmlRequest( + _rawData: Record, + _callbackPath?: string, + _context?: any +): void | Record | Promise> +``` + +## Parameters + + + The parsed request body. + + + + Optional callback path from the request. + + + + The raw Hono context object (c), providing access to headers and query params. + + +## Returns + +`void | Record | Promise>` — Optionally a dict of SWML modifications, or void. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1939. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-section.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-section.mdx new file mode 100644 index 0000000000..ba58600a96 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-section.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-section" +title: "promptAddSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.promptAddSection" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSection` + +Add a new section to the prompt with optional body, bullets, and subsections. + +## Signature + +```typescript +promptAddSection(title: string, opts?: { ...5 fields }): this +``` + +## Parameters + + + Section heading. + + + + Optional section content including body text, bullet points, and subsections. + + + + + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 466. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-subsection.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-subsection.mdx new file mode 100644 index 0000000000..b78b8d5232 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-subsection.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-subsection" +title: "promptAddSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.promptAddSubsection" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddSubsection` + +Add a subsection under an existing prompt section. + +## Signature + +```typescript +promptAddSubsection( + parentTitle: string, + title: string, + opts?: { ...2 fields } +): this +``` + +## Parameters + + + Title of the parent section. + + + + Title of the new subsection. + + + + Optional body text and bullet points for the subsection. + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 501. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-to-section.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-to-section.mdx new file mode 100644 index 0000000000..26d48b4329 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-to-section.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/prompt-add-to-section" +title: "promptAddToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.promptAddToSection" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptAddToSection` + +Append content to an existing prompt section. + +## Signature + +```typescript +promptAddToSection(title: string, opts?: { ...3 fields }): this +``` + +## Parameters + + + Title of the section to append to. + + + + Content to add: body text, a single bullet, or multiple bullets. + + + + + + + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-has-section.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-has-section.mdx new file mode 100644 index 0000000000..e2d41ab2f1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/prompt-has-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/prompt-has-section" +title: "promptHasSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.promptHasSection" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `promptHasSection` + +Check whether a prompt section with the given title exists. + +## Signature + +```typescript +promptHasSection(title: string): boolean +``` + +## Parameters + + + Section title to look for. + + +## Returns + +`boolean` — True if the section exists. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-additional-routes.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-additional-routes.mdx new file mode 100644 index 0000000000..f1e005c943 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-additional-routes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/register-additional-routes" +title: "registerAdditionalRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.registerAdditionalRoutes" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `registerAdditionalRoutes` + +Extension point: register additional Hono routes after SWMLService +mounts /health, /ready, /swaig, and the main route. AgentBase uses +this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + +## Signature + +```typescript +registerAdditionalRoutes(_app: Hono): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 604. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-routing-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-routing-callback.mdx new file mode 100644 index 0000000000..9d2ed8135b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-routing-callback.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/register-routing-callback" +title: "registerRoutingCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.registerRoutingCallback" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerRoutingCallback` + +Register a callback at a specific HTTP path that decides how to route an +incoming request. + +When called, the endpoint at `path` will invoke `callback` with the parsed +request body. If `callback` returns a non-empty route string the server +responds with `{ action: "redirect", route }` so the platform can forward the +request to the right agent. If `callback` returns `null` / `undefined` the +agent's own SWML is returned instead (normal processing). + +Mirrors Python `swml_service.register_routing_callback` / +`web_mixin.register_routing_callback`. + +## Signature + +```typescript +registerRoutingCallback(callback: RoutingCallback, path: string = '/sip'): this +``` + +## Parameters + + + Function receiving the parsed request body and returning a route string to redirect, or null/undefined for normal processing. + + + + HTTP path where this callback endpoint is registered (default: '/sip'). + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1101. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-sip-username.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-sip-username.mdx new file mode 100644 index 0000000000..fc06b65400 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-sip-username.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/register-sip-username" +title: "registerSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.registerSipUsername" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `registerSipUsername` + +Register a SIP username to route to this agent. + +## Signature + +```typescript +registerSipUsername(username: string): this +``` + +## Parameters + + + The SIP username to register. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1039. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-swaig-function.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-swaig-function.mdx new file mode 100644 index 0000000000..8139e5ae91 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-swaig-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/register-swaig-function" +title: "registerSwaigFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.registerSwaigFunction" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerSwaigFunction` + +Register a SwaigFunction instance or a raw function descriptor (DataMap). + +## Signature + +```typescript +registerSwaigFunction(fn: Record | SwaigFunction): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 472. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-verb-handler.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-verb-handler.mdx new file mode 100644 index 0000000000..34bc161c3e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/register-verb-handler.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/register-verb-handler" +title: "registerVerbHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.registerVerbHandler" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerVerbHandler` + +Register a custom verb handler. +Mirrors Python's `register_verb_handler()`. + +## Signature + +```typescript +registerVerbHandler(handler: SWMLVerbHandler): void +``` + +## Parameters + + + The verb handler to register. + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 726. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/remove-function.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/remove-function.mdx new file mode 100644 index 0000000000..4a8912dfb0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/remove-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/remove-function" +title: "removeFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.removeFunction" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `removeFunction` + +Remove a registered SWAIG function. Returns true when removed, +false when not found. (Python parity: +`ToolRegistry.remove_function`.) + +## Signature + +```typescript +removeFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 540. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/remove-skill-by-name.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/remove-skill-by-name.mdx new file mode 100644 index 0000000000..d3a9db369b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/remove-skill-by-name.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/remove-skill-by-name" +title: "removeSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.removeSkillByName" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkillByName` + +Remove a skill by its name (Python parity). + +Python's `remove_skill(skill_name)` removes by skill name. +The existing `removeSkill(instanceId)` removes by instance ID. +This method provides name-based removal for cross-SDK parity. + +## Signature + +```typescript +removeSkillByName(skillName: string): Promise +``` + +## Parameters + + + The skill name to remove. + + +## Returns + +`Promise` — True if a skill with that name was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1671. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/remove-skill.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/remove-skill.mdx new file mode 100644 index 0000000000..a3ca6acd5d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/remove-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/remove-skill" +title: "removeSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.removeSkill" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `removeSkill` + +Remove a previously added skill by its instance ID. + +## Signature + +```typescript +removeSkill(instanceId: string): Promise +``` + +## Parameters + + + The unique instance ID of the skill to remove. + + +## Returns + +`Promise` — True if the skill was found and removed. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1640. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/render-document.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/render-document.mdx new file mode 100644 index 0000000000..273feab359 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/render-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/render-document" +title: "renderDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.renderDocument" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `renderDocument` + +Render the SWML document as a JSON string. +Mirrors Python's `render_document()`. + +## Signature + +```typescript +renderDocument(): string +``` + +## Returns + +`string` — JSON-encoded SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 715. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/render-swml.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/render-swml.mdx new file mode 100644 index 0000000000..2e6bd48588 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/render-swml.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/render-swml" +title: "renderSwml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.renderSwml" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `renderSwml` + +Render the complete SWML document by assembling all 5 phases: pre-answer, answer, +post-answer, AI, and post-AI verbs. + +## Signature + +```typescript +renderSwml(callId?: string, modifications?: Record): string +``` + +## Parameters + + + Optional call ID to use for session tokens; auto-generated if omitted. + + + + Optional dict returned from `onSwmlRequest` to merge into the AI verb config before rendering. Matches Python's `_render_swml(modifications)` semantics: `global_data` is deep-merged; all other keys override the AI config directly. + + +## Returns + +`string` — The rendered SWML document as a JSON string. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2000. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/reset-contexts.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/reset-contexts.mdx new file mode 100644 index 0000000000..cbcb5b39e0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/reset-contexts.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/reset-contexts" +title: "resetContexts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.resetContexts" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `resetContexts` + +Remove all contexts, returning the agent to a no-contexts state. + +This is a convenience wrapper around `defineContexts().reset()`. +Use it in a dynamic config callback when you need to rebuild +contexts from scratch for a specific request. + +## Signature + +```typescript +resetContexts(): this +``` + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 624. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/reset-document.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/reset-document.mdx new file mode 100644 index 0000000000..7930db536f --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/reset-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/reset-document" +title: "resetDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.resetDocument" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `resetDocument` + +Reset the SWML document to an empty state. +Mirrors Python's `reset_document()`. + +## Signature + +```typescript +resetDocument(): this +``` + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 679. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/run-serverless.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/run-serverless.mdx new file mode 100644 index 0000000000..d441622a54 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/run-serverless.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/run-serverless" +title: "runServerless" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.runServerless" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `runServerless` + +Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI). + +Matches Python `run(event, context)` when executed in a serverless environment. Python's +`run()` auto-detects the platform via `get_execution_mode()` and dispatches accordingly; +in TypeScript the serverless path is an **explicit** method so that `run()` keeps its +HTTP-server semantics and callers opt in to serverless dispatch deliberately. + +Platform detection follows the same environment-variable heuristics as Python's +`ServerlessMixin`: `AWS_LAMBDA_FUNCTION_NAME` → Lambda, `K_SERVICE` → GCF, +`FUNCTIONS_WORKER_RUNTIME` → Azure, `GATEWAY_INTERFACE` → CGI. + +Usage in a Lambda handler file: + +```ts +export const handler = (event: any, context: any) => agent.runServerless(event, context); +``` + +## Signature + +```typescript +runServerless( + event: ServerlessEvent, + context?: unknown, + platform?: "lambda" | "gcf" | "azure" | "cgi" | "auto" +): Promise +``` + +## Parameters + + + The serverless event payload (Lambda event, GCF request body, etc.). + + + + The serverless context object (Lambda context, Azure context, etc.). + + + + Optional platform override; defaults to 'auto' (environment detection). + + +## Returns + +`Promise` — The normalized serverless response object. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2709. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/run.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/run.mdx new file mode 100644 index 0000000000..97d39d1757 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/run.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/run" +title: "run" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.run" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `run` + +Alias for [serve](/reference/typescript/prefabs/survey-agent/survey-agent/serve). Starts the HTTP server. + +## Signature + +```typescript +run(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host and port overrides. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server is running. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2683. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/serve.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/serve.mdx new file mode 100644 index 0000000000..a5e6ae1b31 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/serve.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/serve" +title: "serve" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.serve" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `serve` + +Start the HTTP server and begin listening for requests. + +Uses `@hono/node-server` under the hood. When run in CLI mode +(`SWAIG_CLI_MODE=true`, set automatically by `npx swaig-test`), this is a +no-op so agent config can be inspected without starting a server. + +## Signature + +```typescript +serve(opts?: { ...2 fields }): Promise +``` + +## Parameters + + + Optional host/port overrides. Defaults to the values provided in the constructor options or the `PORT` environment variable. + + + + + + +## Returns + +`Promise` — A promise that resolves once the server has begun listening. + +## Examples + +```typescript +const agent = new AgentBase({ name: 'demo', port: 3000 }); +await agent.serve(); +// Or override at runtime: +await agent.serve({ port: 8080, host: '127.0.0.1' }); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2660. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-dynamic-config-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-dynamic-config-callback.mdx new file mode 100644 index 0000000000..3883013bf2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-dynamic-config-callback.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-dynamic-config-callback" +title: "setDynamicConfigCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setDynamicConfigCallback" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setDynamicConfigCallback` + +Set a callback invoked on each SWML request to dynamically modify an ephemeral agent copy. + +The callback receives a clone of this agent — mutations apply only to the current +request, so you can vary prompt, tools, languages, params, or global data per call +without affecting the long-lived agent instance. + +## Signature + +```typescript +setDynamicConfigCallback(cb: DynamicConfigCallback): this +``` + +## Parameters + + + Callback receiving `(queryParams, bodyParams, headers, agent)` where `agent` is the ephemeral `AgentBase` copy to mutate. May be async. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setDynamicConfigCallback((query, body, headers, agent) => { + const lang = query.lang ?? 'en'; + if (lang === 'es') { + (agent as AgentBase).setPromptText('Eres un asistente útil.'); + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1704. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-function-includes.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-function-includes.mdx new file mode 100644 index 0000000000..cc3378f3cb --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-function-includes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-function-includes" +title: "setFunctionIncludes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setFunctionIncludes" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setFunctionIncludes` + +Replace the entire list of function includes. +Each include must have a `url` and `functions` array. + +## Signature + +```typescript +setFunctionIncludes(includes: FunctionInclude[]): this +``` + +## Parameters + + + Array of function include objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 978. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-global-data.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-global-data.mdx new file mode 100644 index 0000000000..bf015976c6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-global-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-global-data" +title: "setGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setGlobalData" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setGlobalData` + +Merge data into the global\_data object passed into the AI configuration. + +Matches Python `set_global_data` which calls `.update()` on the internal dict — +existing keys are preserved; incoming keys overwrite on collision. Skills and +other callers can each contribute keys without clobbering one another. + +If you need to replace the entire object, assign a new agent instance or use +`Object.assign(agent.globalData, {})` to clear first. + +## Signature + +```typescript +setGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 827. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-internal-fillers.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-internal-fillers.mdx new file mode 100644 index 0000000000..62c92c55d4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-internal-fillers.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-internal-fillers" +title: "setInternalFillers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setInternalFillers" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setInternalFillers` + +Set internal fillers for native SWAIG functions. + +Internal fillers are short phrases the AI agent speaks (via TTS) while +an internal/native function is running, so the caller doesn't hear +dead air during transitions or background work. + +Supported function names (matches the SWAIGInternalFiller schema): + +hangup — when the agent is hanging up +check\_time — when checking the time +wait\_for\_user — when waiting for user input +wait\_seconds — during deliberate pauses +adjust\_response\_latency — when adjusting response timing +next\_step — transitioning between steps in prompt.contexts +change\_context — switching between contexts in prompt.contexts +get\_visual\_input — processing visual input (enable\_vision=true) +get\_ideal\_strategy — thinking (enable\_thinking=true) + +Notably NOT supported: change\_step, gather\_submit, or arbitrary +user-defined SWAIG function names. The runtime only honors fillers +for the names listed above; everything else is silently ignored at +the SWML level. This method warns at registration time if you pass +an unknown name so you catch the typo early. + +## Signature + +```typescript +setInternalFillers( + internalFillers: Record> +): this +``` + +## Parameters + + + Map of function name to language-keyed filler phrases. + + +## Returns + +`this` — This agent instance for chaining. + +## Examples + +```typescript +agent.setInternalFillers({ + next_step: { + 'en-US': ['Moving to the next step...', 'Great, let us continue...'], + 'es': ['Pasando al siguiente paso...'] + }, + check_time: { + 'en-US': ['Let me check the time...'] + } +}); +``` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 909. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-language-params.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-language-params.mdx new file mode 100644 index 0000000000..e7c25760e3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-language-params.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-language-params" +title: "setLanguageParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setLanguageParams" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguageParams` + +Set (or replace) the per-language `params` dict on an already-added +language. Useful when language entries are built up via [addLanguage](/reference/typescript/prefabs/survey-agent/survey-agent/add-language) +first and engine-specific tuning is added later (e.g., from a config +loader). + +Python parity: `set_language_params(code, params)`. Passing an empty +object removes the `params` key entirely. Unknown codes are a no-op. + +## Signature + +```typescript +setLanguageParams(code: string, params: Record): this +``` + +## Parameters + + + Language code as previously passed to [addLanguage](/reference/typescript/prefabs/survey-agent/survey-agent/add-language) (e.g. `"en-US"`). + + + + Engine-specific params dict to attach. Empty object removes the key. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 736. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-languages.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-languages.mdx new file mode 100644 index 0000000000..cf04b0b307 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-languages.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-languages" +title: "setLanguages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setLanguages" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setLanguages` + +Replace all configured languages with a new list. + +## Signature + +```typescript +setLanguages(languages: LanguageConfig[]): this +``` + +## Parameters + + + Array of language configurations. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 717. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-native-functions.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-native-functions.mdx new file mode 100644 index 0000000000..445e940941 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-native-functions.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-native-functions" +title: "setNativeFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setNativeFunctions" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setNativeFunctions` + +Set the list of native SWAIG function names (built-in platform functions). + +## Signature + +```typescript +setNativeFunctions(funcs: string[]): this +``` + +## Parameters + + + Array of native function names. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 847. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-on-request-callback.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-on-request-callback.mdx new file mode 100644 index 0000000000..b8781dc18e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-on-request-callback.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-on-request-callback" +title: "setOnRequestCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setOnRequestCallback" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `setOnRequestCallback` + +Set a callback invoked per-request to dynamically build SWML. +When set, the static SwmlBuilder is ignored and the callback's +returned SwmlBuilder is used instead. + +## Signature + +```typescript +setOnRequestCallback(cb: OnRequestCallback): this +``` + +## Parameters + + + Callback receiving query params, body params, and headers. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 850. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-param.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-param.mdx new file mode 100644 index 0000000000..201d59a23b --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-param.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-param" +title: "setParam" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setParam" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParam` + +Set a single AI parameter (e.g. "temperature", "top\_p"). + +## Signature + +```typescript +setParam(key: string, value: unknown): this +``` + +## Parameters + + + Parameter name. + + + + Parameter value. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 799. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-params.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-params.mdx new file mode 100644 index 0000000000..e5a24837e6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-params" +title: "setParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setParams" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setParams` + +Merge multiple AI parameters into the existing params object. + +## Signature + +```typescript +setParams(params: Record): this +``` + +## Parameters + + + Key-value pairs to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 809. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt-llm-params.mdx new file mode 100644 index 0000000000..3c37123602 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt-llm-params" +title: "setPostPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setPostPromptLlmParams" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptLlmParams` + +Merge LLM-specific parameters into the post-prompt configuration. + +## Signature + +```typescript +setPostPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1000. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt-url.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt-url.mdx new file mode 100644 index 0000000000..85d30e3772 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt-url" +title: "setPostPromptUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setPostPromptUrl" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPromptUrl` + +Override the default post-prompt webhook URL with a custom one. + +## Signature + +```typescript +setPostPromptUrl(url: string): this +``` + +## Parameters + + + The custom post-prompt URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1828. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt.mdx new file mode 100644 index 0000000000..ff5f503e31 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-post-prompt" +title: "setPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setPostPrompt" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPostPrompt` + +Set the post-prompt text evaluated after the call ends. + +## Signature + +```typescript +setPostPrompt(text: string): this +``` + +## Parameters + + + The post-prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 455. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-llm-params.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-llm-params.mdx new file mode 100644 index 0000000000..894e8e11d8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-llm-params.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-llm-params" +title: "setPromptLlmParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setPromptLlmParams" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptLlmParams` + +Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature). + +## Signature + +```typescript +setPromptLlmParams(params: Record): this +``` + +## Parameters + + + Key-value LLM parameters to merge. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 990. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-pom.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-pom.mdx new file mode 100644 index 0000000000..7c80370fe9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-pom.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-pom" +title: "setPromptPom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setPromptPom" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptPom` + +Set the prompt as a POM (Prompt Object Model) dictionary. + +Replaces the current POM sections with the provided structured data. +Each entry should have `title`, and optionally `body`, `bullets`, +`numbered`, `numberedBullets`, and `subsections`. + +## Signature + +```typescript +setPromptPom(pom: Record[]): this +``` + +## Parameters + + + Array of POM section dictionaries. + + +## Returns + +`this` — This agent instance for chaining. + +## Throws + +- Error if POM mode is not enabled (`usePom: false`). + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 576. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-text.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-text.mdx new file mode 100644 index 0000000000..3093284261 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-text.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-prompt-text" +title: "setPromptText" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setPromptText" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPromptText` + +Set the main system prompt text for the AI. + +## Signature + +```typescript +setPromptText(text: string): this +``` + +## Parameters + + + The prompt text to use. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 445. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-pronunciations.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-pronunciations.mdx new file mode 100644 index 0000000000..33a5283f25 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-pronunciations.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-pronunciations" +title: "setPronunciations" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setPronunciations" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setPronunciations` + +Replace all pronunciation rules with a new list. + +## Signature + +```typescript +setPronunciations(rules: PronunciationRule[]): this +``` + +## Parameters + + + Array of pronunciation rule objects. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 785. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-web-hook-url.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-web-hook-url.mdx new file mode 100644 index 0000000000..a7bfd69e09 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/set-web-hook-url.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/set-web-hook-url" +title: "setWebHookUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setWebHookUrl" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setWebHookUrl` + +Override the default SWAIG webhook URL with a custom one. + +## Signature + +```typescript +setWebHookUrl(url: string): this +``` + +## Parameters + + + The custom webhook URL. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1818. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/setup-graceful-shutdown.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/setup-graceful-shutdown.mdx new file mode 100644 index 0000000000..3b0a052451 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/setup-graceful-shutdown.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/setup-graceful-shutdown" +title: "setupGracefulShutdown" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.setupGracefulShutdown" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `setupGracefulShutdown` + +Register process signal handlers for clean Kubernetes/Docker shutdown. +Handles SIGTERM and SIGINT, waits for a timeout, then exits. + +**Modifiers:** `static` + +## Signature + +```typescript +setupGracefulShutdown(opts?: { ...1 fields }): void +``` + +## Parameters + + + Optional timeout in milliseconds (default 5000). + + + + +## Returns + +`void` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 2732. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/stop.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/stop.mdx new file mode 100644 index 0000000000..0278255980 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.stop" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `stop` + +Stop the HTTP server. +Mirrors Python's `stop()`. + +## Signature + +```typescript +stop(): void +``` + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 1009. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..dcf3dab6cb --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/swaig-pre-dispatch.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/swaig-pre-dispatch" +title: "swaigPreDispatch" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.swaigPreDispatch" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `swaigPreDispatch` + +Extension point: invoked between argument parsing and function dispatch +on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is +non-null, it's returned directly without dispatching. AgentBase may +override to add session-token validation or ephemeral dynamic-config. + +## Signature + +```typescript +swaigPreDispatch( + _requestData: Record, + _funcName: string +): [SWMLService, unknown] +``` + +## Parameters + + + + + +## Returns + +`[SWMLService, unknown]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 592. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/update-global-data.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/update-global-data.mdx new file mode 100644 index 0000000000..cb23054670 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/update-global-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/update-global-data" +title: "updateGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.updateGlobalData" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `updateGlobalData` + +Merge additional entries into the existing global\_data object. + +## Signature + +```typescript +updateGlobalData(data: Record): this +``` + +## Parameters + + + Key-value pairs to merge into global data. + + +## Returns + +`this` — This agent instance for chaining. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 837. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/validate-basic-auth.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/validate-basic-auth.mdx new file mode 100644 index 0000000000..66739add99 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/validate-basic-auth.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/validate-basic-auth" +title: "validateBasicAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.validateBasicAuth" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateBasicAuth` + +Override to add custom basic-auth validation logic beyond credential matching. + +## Signature + +```typescript +validateBasicAuth( + _username: string, + _password: string +): boolean | Promise +``` + +## Parameters + + + The username from the request. + + + + The password from the request. + + +## Returns + +`boolean | Promise` — True if the credentials are valid; false to reject the request. + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1961. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/validate-tool-token.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/validate-tool-token.mdx new file mode 100644 index 0000000000..2cf7b6a515 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-agent/validate-tool-token.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-agent/validate-tool-token" +title: "validateToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyAgent.validateToolToken" + parent: "prefabs.SurveyAgent.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts" +--- +# `validateToolToken` + +Validate a tool-call token for the given function. + +Mirrors Python reference `core/mixins/state_mixin.py validate_tool_token`: + +1. Unknown function → `false`. +2. Registered but non-secure → `true` without consulting SessionManager + (non-secure tools never require a token). +3. Raw-dict descriptors (e.g. DataMap) are treated as secure, matching + Python's `isinstance(func, dict) → is_secure = True` branch. +4. Missing token on a secure tool → `false`. +5. Otherwise delegate to `SessionManager.validateToolToken`. + +Divergences from the Python reference: + +- No debug-logging branch: `AgentBase` does not expose an agent-level + debug-mode flag, so the per-call debug telemetry Python emits is + omitted. `SessionManager` still logs its own validation outcomes. +- No token-derived call-id fallback: `SessionManager.debugToken` + truncates the embedded call-id for log safety, so an extracted value + cannot be round-tripped back through `validateToolToken`. The caller + is expected to supply a non-empty `callId`; an empty one is forwarded + unchanged and the underlying validator will reject it. + +## Signature + +```typescript +validateToolToken(functionName: string, token: string, callId: string): boolean +``` + +## Parameters + + + + + + + +## Returns + +`boolean` + +## Source + +[`src/AgentBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/AgentBase.ts) + +Line 1447. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-config/index.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-config/index.mdx new file mode 100644 index 0000000000..bd78e15c6c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-config/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-config" +title: "SurveyConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyConfig" + parent: "prefabs.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts" +--- +# `SurveyConfig` + +Configuration for the [SurveyAgent](/reference/typescript/prefabs/survey-agent/survey-agent). + +## Signature + +```typescript +interface SurveyConfig +``` + +## Properties + + + Additional AgentBase options forwarded to super(). + + + + Brand or company name the agent represents (matches Python `brand_name`). + + + + Message after the survey is complete (matches Python `conclusion`). + + + + Opening message before the first question (matches Python `introduction`). + + + + Maximum number of times to retry invalid answers. Defaults to 2. + + + + Agent display name (defaults to `"survey"`). + + + + Callback fired when the survey is finished. + + + + Ordered list of survey questions. + + + + HTTP route for this agent (defaults to `"/survey"`). + + + + Human-readable survey name, used in prompts and global data. + + +## Source + +[`src/prefabs/SurveyAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts) + +Line 52. diff --git a/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-question/index.mdx b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-question/index.mdx new file mode 100644 index 0000000000..90505c7b16 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prefabs/survey-agent/survey-question/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/prefabs/survey-agent/survey-question" +title: "SurveyQuestion" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "prefabs.SurveyAgent.SurveyQuestion" + parent: "prefabs.SurveyAgent" + module: "prefabs.SurveyAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts" +--- +# `SurveyQuestion` + +A single survey question consumed by [SurveyAgent](/reference/typescript/prefabs/survey-agent/survey-agent). + +## Signature + +```typescript +interface SurveyQuestion +``` + +## Properties + + + Unique question identifier. + + + + Next question ID after this one. + + + + Options for multiple\_choice questions. + + + + Points awarded for answers. + + + + Whether the question requires an answer. Defaults to `true`. Mirrors the Python `required` flag on each question dict. + + + + For `rating` questions, the upper bound of the scale (1..scale). Defaults to 5 (matching the Python prefab) when unspecified. + + + + The question text to ask the caller. + + + + Question type determines validation and display. + + +## Source + +[`src/prefabs/SurveyAgent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/prefabs/SurveyAgent.ts) + +Line 17. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/index.mdx b/fern/products/sdk-reference/typescript/prompt-manager/index.mdx new file mode 100644 index 0000000000..cf18a4cb33 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prompt-manager" +title: "PromptManager" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `PromptManager` + +## Signature + +```typescript +module PromptManager +``` + +## Classes + + + + Manages agent prompt text, supporting both raw text and structured POM-based prompts. + + + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/add-section.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/add-section.mdx new file mode 100644 index 0000000000..32513b7031 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/add-section.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PromptManager.PromptManager.addSection" + parent: "PromptManager.PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `addSection` + +Adds a POM section to the prompt, initializing the PomBuilder if needed. + +## Signature + +```typescript +addSection(title: string, opts?: { ...5 fields }): void +``` + +## Parameters + + + The section heading. + + + + Optional body, bullets, numbering, and subsection configuration. + + + + + + + + + + + + +## Returns + +`void` + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 48. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/add-subsection.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/add-subsection.mdx new file mode 100644 index 0000000000..0939059e33 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/add-subsection.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager/add-subsection" +title: "addSubsection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PromptManager.PromptManager.addSubsection" + parent: "PromptManager.PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `addSubsection` + +Adds a subsection under a parent POM section, creating the parent if absent. + +## Signature + +```typescript +addSubsection(parentTitle: string, title: string, opts?: { ...2 fields }): void +``` + +## Parameters + + + The heading of the parent section. + + + + The subsection heading. + + + + Optional body text and bullets for the subsection. + + + + + + +## Returns + +`void` + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 87. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/add-to-section.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/add-to-section.mdx new file mode 100644 index 0000000000..eabf28a5b0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/add-to-section.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager/add-to-section" +title: "addToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PromptManager.PromptManager.addToSection" + parent: "PromptManager.PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `addToSection` + +Appends body text or bullets to an existing POM section, creating it if absent. + +## Signature + +```typescript +addToSection(title: string, opts?: { ...3 fields }): void +``` + +## Parameters + + + The section heading to append to. + + + + Body text and/or bullets to add. + + + + + + + + +## Returns + +`void` + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 70. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/constructor.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/constructor.mdx new file mode 100644 index 0000000000..a2c485563e --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PromptManager.PromptManager.constructor" + parent: "PromptManager.PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `constructor` + +Creates a new PromptManager. + +## Signature + +```typescript +constructor(usePom: boolean = true): PromptManager +``` + +## Parameters + + + Whether to use structured POM sections (default true). + + +## Returns + +`PromptManager` + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 20. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-pom-builder.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-pom-builder.mdx new file mode 100644 index 0000000000..14d62abe3c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-pom-builder.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager/get-pom-builder" +title: "getPomBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PromptManager.PromptManager.getPomBuilder" + parent: "PromptManager.PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `getPomBuilder` + +Returns the underlying PomBuilder instance, if POM mode is active. + +## Signature + +```typescript +getPomBuilder(): PomBuilder | null +``` + +## Returns + +`PomBuilder | null` — The PomBuilder, or null if POM is not in use. + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 130. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-post-prompt.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-post-prompt.mdx new file mode 100644 index 0000000000..0dde84b5f5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-post-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager/get-post-prompt" +title: "getPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PromptManager.PromptManager.getPostPrompt" + parent: "PromptManager.PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `getPostPrompt` + +Returns the post-prompt text. + +## Signature + +```typescript +getPostPrompt(): string | null +``` + +## Returns + +`string | null` — The post-prompt string, or null if not set. + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 122. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-prompt.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-prompt.mdx new file mode 100644 index 0000000000..c391ec7b3c --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-prompt.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager/get-prompt" +title: "getPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PromptManager.PromptManager.getPrompt" + parent: "PromptManager.PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `getPrompt` + +Returns the fully rendered prompt text, either raw text or POM-rendered Markdown. + +## Signature + +```typescript +getPrompt(): string +``` + +## Returns + +`string` — The prompt string, or empty string if nothing is set. + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 112. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-raw-prompt.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-raw-prompt.mdx new file mode 100644 index 0000000000..ed472b785d --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/get-raw-prompt.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager/get-raw-prompt" +title: "getRawPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PromptManager.PromptManager.getRawPrompt" + parent: "PromptManager.PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `getRawPrompt` + +Returns the raw prompt text whatever `setPromptText` stored, or null +when no raw prompt has been set. Mirrors Python's +`PromptManager.get_raw_prompt`. + +## Signature + +```typescript +getRawPrompt(): string | null +``` + +## Returns + +`string | null` — The raw prompt string, or null if not set. + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 140. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/has-section.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/has-section.mdx new file mode 100644 index 0000000000..e725afac06 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/has-section.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager/has-section" +title: "hasSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PromptManager.PromptManager.hasSection" + parent: "PromptManager.PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `hasSection` + +Checks whether a POM section with the given title exists. + +## Signature + +```typescript +hasSection(title: string): boolean +``` + +## Parameters + + + The section heading to look for. + + +## Returns + +`boolean` — True if the section exists. + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 104. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/index.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/index.mdx new file mode 100644 index 0000000000..4c7af135be --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager" +title: "PromptManager" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "PromptManager.PromptManager" + parent: "PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `PromptManager` + +Manages agent prompt text, supporting both raw text and structured POM-based prompts. + +## Signature + +```typescript +class PromptManager +``` + +## Methods + + + + Adds a POM section to the prompt, initializing the PomBuilder if needed. + + + + Adds a subsection under a parent POM section, creating the parent if absent. + + + + Appends body text or bullets to an existing POM section, creating it if absent. + + + + Creates a new PromptManager. + + + + Returns the underlying PomBuilder instance, if POM mode is active. + + + + Returns the post-prompt text. + + + + Returns the fully rendered prompt text, either raw text or POM-rendered Markdown. + + + + Returns the raw prompt text whatever `setPromptText` stored, or null when no raw prompt has been set. Mirrors Python's `PromptManager.get_raw_prompt`. + + + + Checks whether a POM section with the given title exists. + + + + Sets the post-prompt text appended after the main prompt. + + + + Sets the raw prompt text, bypassing POM rendering. + + + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 10. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/set-post-prompt.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/set-post-prompt.mdx new file mode 100644 index 0000000000..f7b0630247 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/set-post-prompt.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager/set-post-prompt" +title: "setPostPrompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PromptManager.PromptManager.setPostPrompt" + parent: "PromptManager.PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `setPostPrompt` + +Sets the post-prompt text appended after the main prompt. + +## Signature + +```typescript +setPostPrompt(text: string): void +``` + +## Parameters + + + The post-prompt string. + + +## Returns + +`void` + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 39. diff --git a/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/set-prompt-text.mdx b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/set-prompt-text.mdx new file mode 100644 index 0000000000..017da63270 --- /dev/null +++ b/fern/products/sdk-reference/typescript/prompt-manager/prompt-manager/set-prompt-text.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/prompt-manager/prompt-manager/set-prompt-text" +title: "setPromptText" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "PromptManager.PromptManager.setPromptText" + parent: "PromptManager.PromptManager" + module: "PromptManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts" +--- +# `setPromptText` + +Sets the raw prompt text, bypassing POM rendering. + +## Signature + +```typescript +setPromptText(text: string): void +``` + +## Parameters + + + The raw prompt string. + + +## Returns + +`void` + +## Source + +[`src/PromptManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/PromptManager.ts) + +Line 31. diff --git a/fern/products/sdk-reference/typescript/register-skill.mdx b/fern/products/sdk-reference/typescript/register-skill.mdx new file mode 100644 index 0000000000..8d18c87253 --- /dev/null +++ b/fern/products/sdk-reference/typescript/register-skill.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/register-skill" +title: "registerSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "registerSkill" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts" +--- +# `registerSkill` + +Register a custom skill class with the global `SkillRegistry`. + +Equivalent to Python's `register_skill(skill_class)`. Allows third-party +code to register skills directly, bypassing the built-in directory scan. + +## Signature + +```typescript +registerSkill(skillClass: typeof SkillBase): void +``` + +## Parameters + + + Skill class to register (a subclass of `SkillBase`). + + +## Returns + +`void` + +## Source + +[`src/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts) + +Line 298. diff --git a/fern/products/sdk-reference/typescript/relay/action/action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/action/constructor.mdx new file mode 100644 index 0000000000..199ac15abb --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/action/constructor.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/relay/action/action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.Action.constructor" + parent: "relay.Action.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + call: CallLike, + controlId: string, + terminalEvent: string, + terminalStates: readonly string[] +): Action +``` + +## Parameters + + + Owning call (via the structural [CallLike](/reference/typescript/relay/action/call-like) interface). + + + + Unique control ID the server will echo on events. + + + + Event type that carries terminal state transitions. + + + + State values that mark this action as completed. + + +## Returns + +`Action` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 75. diff --git a/fern/products/sdk-reference/typescript/relay/action/action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/action/index.mdx new file mode 100644 index 0000000000..9340db3358 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/action/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/typescript/relay/action/action" +title: "Action" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.Action" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `Action` + +Async handle for a controllable call operation (play, record, tap, detect, etc.). + +An Action is returned from the async variants on [Call](/reference/typescript/relay/call) (e.g. `call.playAsync`). +It resolves when the server emits a terminal event for its `controlId`. Use +[Action.wait](/reference/typescript/relay/action/action/wait) to await completion, or register an `onCompleted` callback. + +## Signature + +```typescript +class Action +``` + +## Examples + +```typescript +const play = await call.playAsync({ play: [{ type: 'tts', text: 'Hello!' }] }); +// do other work while the greeting plays... +const event = await play.wait(10); // seconds +console.log('Playback finished with state', event.params.state); +``` + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/relay/action/action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/action/wait.mdx new file mode 100644 index 0000000000..b68561abe4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.Action.wait" + parent: "relay.Action.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/action/ai-action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/ai-action/constructor.mdx new file mode 100644 index 0000000000..38301e8076 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/ai-action/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/ai-action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.AIAction.constructor" + parent: "relay.Action.AIAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(call: CallLike, controlId: string): AIAction +``` + +## Parameters + + + + + +## Returns + +`AIAction` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/relay/action/ai-action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/ai-action/index.mdx new file mode 100644 index 0000000000..7ea46b7b45 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/ai-action/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/action/ai-action" +title: "AIAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.AIAction" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `AIAction` + +Async handle for a `calling.call.ai` action (on-call AI agent session). + +## Signature + +```typescript +class AIAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/typescript/relay/action/action) + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + + + Stop the AI agent session. + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 468. diff --git a/fern/products/sdk-reference/typescript/relay/action/ai-action/stop.mdx b/fern/products/sdk-reference/typescript/relay/action/ai-action/stop.mdx new file mode 100644 index 0000000000..84f35e4b60 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/ai-action/stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/ai-action/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.AIAction.stop" + parent: "relay.Action.AIAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `stop` + +Stop the AI agent session. + +## Signature + +```typescript +stop(): Promise> +``` + +## Returns + +`Promise>` — The platform's stop response. + +## Throws + +- When the stop command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 479. diff --git a/fern/products/sdk-reference/typescript/relay/action/ai-action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/ai-action/wait.mdx new file mode 100644 index 0000000000..331d93b23b --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/ai-action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/ai-action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.AIAction.wait" + parent: "relay.Action.AIAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/action/call-like/execute.mdx b/fern/products/sdk-reference/typescript/relay/action/call-like/execute.mdx new file mode 100644 index 0000000000..c1cc25db3f --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/call-like/execute.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/relay/action/call-like/execute" +title: "_execute" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.CallLike._execute" + parent: "relay.Action.CallLike" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `_execute` + +## Signature + +```typescript +_execute( + method: string, + extraParams?: Record +): Promise> +``` + +## Parameters + + + + + +## Returns + +`Promise>` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 35. diff --git a/fern/products/sdk-reference/typescript/relay/action/call-like/index.mdx b/fern/products/sdk-reference/typescript/relay/action/call-like/index.mdx new file mode 100644 index 0000000000..c836a7556d --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/call-like/index.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/relay/action/call-like" +title: "CallLike" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.Action.CallLike" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `CallLike` + +Structural subset of [Call](/reference/typescript/relay/call) that an Action needs — avoids a circular +import between `Call.ts` and `Action.ts`. + +## Signature + +```typescript +interface CallLike +``` + +## Methods + + + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/relay/action/collect-action/check-event.mdx b/fern/products/sdk-reference/typescript/relay/action/collect-action/check-event.mdx new file mode 100644 index 0000000000..464434ff62 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/collect-action/check-event.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/relay/action/collect-action/check-event" +title: "_checkEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.CollectAction._checkEvent" + parent: "relay.Action.CollectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `_checkEvent` + +play\_and\_collect shares a control\_id across play and collect phases. +Only resolve on collect events, not play events. + +## Signature + +```typescript +_checkEvent(event: RelayEvent): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 286. diff --git a/fern/products/sdk-reference/typescript/relay/action/collect-action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/collect-action/constructor.mdx new file mode 100644 index 0000000000..ef2a1197f4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/collect-action/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/collect-action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.CollectAction.constructor" + parent: "relay.Action.CollectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(call: CallLike, controlId: string): CollectAction +``` + +## Parameters + + + + + +## Returns + +`CollectAction` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 278. diff --git a/fern/products/sdk-reference/typescript/relay/action/collect-action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/collect-action/index.mdx new file mode 100644 index 0000000000..6fe5e24099 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/collect-action/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/typescript/relay/action/collect-action" +title: "CollectAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.CollectAction" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `CollectAction` + +Async handle for a `play_and_collect` action (combined playback + input collection). + +## Signature + +```typescript +class CollectAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/typescript/relay/action/action) + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + play\_and\_collect shares a control\_id across play and collect phases. Only resolve on collect events, not play events. + + + + + + Start the collect input timers (useful when `initial_timeout` should be reset after an async side effect completes). + + + + Stop the play\_and\_collect operation. + + + + Adjust playback volume of the prompt audio mid-collect. + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 277. diff --git a/fern/products/sdk-reference/typescript/relay/action/collect-action/start-input-timers.mdx b/fern/products/sdk-reference/typescript/relay/action/collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..72515f0a33 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/collect-action/start-input-timers.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/relay/action/collect-action/start-input-timers" +title: "startInputTimers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.CollectAction.startInputTimers" + parent: "relay.Action.CollectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `startInputTimers` + +Start the collect input timers (useful when `initial_timeout` should be +reset after an async side effect completes). + +## Signature + +```typescript +startInputTimers(): Promise> +``` + +## Returns + +`Promise>` — The platform's start\_input\_timers response. + +## Throws + +- When the command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 324. diff --git a/fern/products/sdk-reference/typescript/relay/action/collect-action/stop.mdx b/fern/products/sdk-reference/typescript/relay/action/collect-action/stop.mdx new file mode 100644 index 0000000000..a1c6708721 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/collect-action/stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/collect-action/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.CollectAction.stop" + parent: "relay.Action.CollectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `stop` + +Stop the play\_and\_collect operation. + +## Signature + +```typescript +stop(): Promise> +``` + +## Returns + +`Promise>` — The platform's stop response. + +## Throws + +- When the stop command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 302. diff --git a/fern/products/sdk-reference/typescript/relay/action/collect-action/volume.mdx b/fern/products/sdk-reference/typescript/relay/action/collect-action/volume.mdx new file mode 100644 index 0000000000..caba92848d --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/collect-action/volume.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/collect-action/volume" +title: "volume" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.CollectAction.volume" + parent: "relay.Action.CollectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `volume` + +Adjust playback volume of the prompt audio mid-collect. + +## Signature + +```typescript +volume(volume: number): Promise> +``` + +## Parameters + + + Volume adjustment in dB. + + +## Returns + +`Promise>` — The platform's volume response. + +## Throws + +- When the volume command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 313. diff --git a/fern/products/sdk-reference/typescript/relay/action/collect-action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/collect-action/wait.mdx new file mode 100644 index 0000000000..87f97dca42 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/collect-action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/collect-action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.CollectAction.wait" + parent: "relay.Action.CollectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/action/detect-action/check-event.mdx b/fern/products/sdk-reference/typescript/relay/action/detect-action/check-event.mdx new file mode 100644 index 0000000000..688ae9cd57 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/detect-action/check-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/detect-action/check-event" +title: "_checkEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.DetectAction._checkEvent" + parent: "relay.Action.DetectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `_checkEvent` + +Resolve on first meaningful result OR terminal state. + +## Signature + +```typescript +_checkEvent(event: RelayEvent): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 255. diff --git a/fern/products/sdk-reference/typescript/relay/action/detect-action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/detect-action/constructor.mdx new file mode 100644 index 0000000000..6546f3365d --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/detect-action/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/detect-action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.DetectAction.constructor" + parent: "relay.Action.DetectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(call: CallLike, controlId: string): DetectAction +``` + +## Parameters + + + + + +## Returns + +`DetectAction` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 250. diff --git a/fern/products/sdk-reference/typescript/relay/action/detect-action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/detect-action/index.mdx new file mode 100644 index 0000000000..59226e587a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/detect-action/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/typescript/relay/action/detect-action" +title: "DetectAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.DetectAction" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `DetectAction` + +Async handle for a `calling.call.detect` action (machine / fax / digit). + +## Signature + +```typescript +class DetectAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/typescript/relay/action/action) + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + Resolve on first meaningful result OR terminal state. + + + + + + Stop detection before the timeout elapses. + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 249. diff --git a/fern/products/sdk-reference/typescript/relay/action/detect-action/stop.mdx b/fern/products/sdk-reference/typescript/relay/action/detect-action/stop.mdx new file mode 100644 index 0000000000..1410db610c --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/detect-action/stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/detect-action/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.DetectAction.stop" + parent: "relay.Action.DetectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `stop` + +Stop detection before the timeout elapses. + +## Signature + +```typescript +stop(): Promise> +``` + +## Returns + +`Promise>` — The platform's stop response. + +## Throws + +- When the stop command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 269. diff --git a/fern/products/sdk-reference/typescript/relay/action/detect-action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/detect-action/wait.mdx new file mode 100644 index 0000000000..c0d9f6ba85 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/detect-action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/detect-action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.DetectAction.wait" + parent: "relay.Action.DetectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/action/fax-action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/fax-action/constructor.mdx new file mode 100644 index 0000000000..0b47794567 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/fax-action/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/relay/action/fax-action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.FaxAction.constructor" + parent: "relay.Action.FaxAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(call: CallLike, controlId: string, methodPrefix: string): FaxAction +``` + +## Parameters + + + + + + + +## Returns + +`FaxAction` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 373. diff --git a/fern/products/sdk-reference/typescript/relay/action/fax-action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/fax-action/index.mdx new file mode 100644 index 0000000000..73f27817f5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/fax-action/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/action/fax-action" +title: "FaxAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.FaxAction" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `FaxAction` + +Async handle for a `send_fax` or `receive_fax` action. + +## Signature + +```typescript +class FaxAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/typescript/relay/action/action) + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + + + Stop the fax transfer mid-stream. + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 370. diff --git a/fern/products/sdk-reference/typescript/relay/action/fax-action/stop.mdx b/fern/products/sdk-reference/typescript/relay/action/fax-action/stop.mdx new file mode 100644 index 0000000000..8895325d3c --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/fax-action/stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/fax-action/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.FaxAction.stop" + parent: "relay.Action.FaxAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `stop` + +Stop the fax transfer mid-stream. + +## Signature + +```typescript +stop(): Promise> +``` + +## Returns + +`Promise>` — The platform's stop response. + +## Throws + +- When the stop command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 384. diff --git a/fern/products/sdk-reference/typescript/relay/action/fax-action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/fax-action/wait.mdx new file mode 100644 index 0000000000..9a71db4966 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/fax-action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/fax-action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.FaxAction.wait" + parent: "relay.Action.FaxAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/index.mdx new file mode 100644 index 0000000000..0b222c2868 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/index.mdx @@ -0,0 +1,86 @@ +--- +slug: "/reference/typescript/relay/action" +title: "Action" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "relay.Action" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `Action` + +## Signature + +```typescript +module Action +``` + +## Classes + + + + Async handle for a controllable call operation (play, record, tap, detect, etc.). + + + + Async handle for a `calling.call.ai` action (on-call AI agent session). + + + + Async handle for a `play_and_collect` action (combined playback + input collection). + + + + Async handle for a `calling.call.detect` action (machine / fax / digit). + + + + Async handle for a `send_fax` or `receive_fax` action. + + + + Async handle for a `calling.call.pay` action (PCI-compliant payment collection). + + + + Async handle for a `calling.call.play` action — controls playback in progress. + + + + Async handle for a `calling.call.record` action — controls recording in progress. + + + + Async handle for a bare `calling.call.collect` action (no accompanying play). + + + + Async handle for a `calling.call.stream` action (outbound media stream). + + + + Async handle for a `calling.call.tap` action (media mirroring). + + + + Async handle for a `calling.call.transcribe` action (real-time transcription). + + + +## Interfaces + + + + Structural subset of [Call](/reference/typescript/relay/call) that an Action needs — avoids a circular import between `Call.ts` and `Action.ts`. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/relay/action/pay-action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/pay-action/constructor.mdx new file mode 100644 index 0000000000..c9bf10f7f4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/pay-action/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/pay-action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.PayAction.constructor" + parent: "relay.Action.PayAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(call: CallLike, controlId: string): PayAction +``` + +## Parameters + + + + + +## Returns + +`PayAction` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 431. diff --git a/fern/products/sdk-reference/typescript/relay/action/pay-action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/pay-action/index.mdx new file mode 100644 index 0000000000..efd67f9b80 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/pay-action/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/action/pay-action" +title: "PayAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.PayAction" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `PayAction` + +Async handle for a `calling.call.pay` action (PCI-compliant payment collection). + +## Signature + +```typescript +class PayAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/typescript/relay/action/action) + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + + + Cancel the payment collection before it completes. + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 430. diff --git a/fern/products/sdk-reference/typescript/relay/action/pay-action/stop.mdx b/fern/products/sdk-reference/typescript/relay/action/pay-action/stop.mdx new file mode 100644 index 0000000000..c0a3cf73fa --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/pay-action/stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/pay-action/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.PayAction.stop" + parent: "relay.Action.PayAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `stop` + +Cancel the payment collection before it completes. + +## Signature + +```typescript +stop(): Promise> +``` + +## Returns + +`Promise>` — The platform's stop response. + +## Throws + +- When the stop command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 441. diff --git a/fern/products/sdk-reference/typescript/relay/action/pay-action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/pay-action/wait.mdx new file mode 100644 index 0000000000..7bb5b12b56 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/pay-action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/pay-action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.PayAction.wait" + parent: "relay.Action.PayAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/action/play-action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/play-action/constructor.mdx new file mode 100644 index 0000000000..42bda6eb0b --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/play-action/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/play-action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.PlayAction.constructor" + parent: "relay.Action.PlayAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(call: CallLike, controlId: string): PlayAction +``` + +## Parameters + + + + + +## Returns + +`PlayAction` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 157. diff --git a/fern/products/sdk-reference/typescript/relay/action/play-action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/play-action/index.mdx new file mode 100644 index 0000000000..8373fbe9c3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/play-action/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/typescript/relay/action/play-action" +title: "PlayAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.PlayAction" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `PlayAction` + +Async handle for a `calling.call.play` action — controls playback in progress. + +## Signature + +```typescript +class PlayAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/typescript/relay/action/action) + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + + + Pause active playback (resumable with [resume](/reference/typescript/relay/action/play-action/resume)). + + + + Resume playback paused by [pause](/reference/typescript/relay/action/play-action/pause). + + + + Stop the playback. + + + + Adjust playback volume. + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 156. diff --git a/fern/products/sdk-reference/typescript/relay/action/play-action/pause.mdx b/fern/products/sdk-reference/typescript/relay/action/play-action/pause.mdx new file mode 100644 index 0000000000..f327245215 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/play-action/pause.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/play-action/pause" +title: "pause" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.PlayAction.pause" + parent: "relay.Action.PlayAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `pause` + +Pause active playback (resumable with [resume](/reference/typescript/relay/action/play-action/resume)). + +## Signature + +```typescript +pause(): Promise> +``` + +## Returns + +`Promise>` — The platform's pause response. + +## Throws + +- When the pause command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 177. diff --git a/fern/products/sdk-reference/typescript/relay/action/play-action/resume.mdx b/fern/products/sdk-reference/typescript/relay/action/play-action/resume.mdx new file mode 100644 index 0000000000..5aae71264f --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/play-action/resume.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/play-action/resume" +title: "resume" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.PlayAction.resume" + parent: "relay.Action.PlayAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `resume` + +Resume playback paused by [pause](/reference/typescript/relay/action/play-action/pause). + +## Signature + +```typescript +resume(): Promise> +``` + +## Returns + +`Promise>` — The platform's resume response. + +## Throws + +- When the resume command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 187. diff --git a/fern/products/sdk-reference/typescript/relay/action/play-action/stop.mdx b/fern/products/sdk-reference/typescript/relay/action/play-action/stop.mdx new file mode 100644 index 0000000000..cec018e100 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/play-action/stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/play-action/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.PlayAction.stop" + parent: "relay.Action.PlayAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `stop` + +Stop the playback. + +## Signature + +```typescript +stop(): Promise> +``` + +## Returns + +`Promise>` — The platform's stop response. + +## Throws + +- When the stop command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 167. diff --git a/fern/products/sdk-reference/typescript/relay/action/play-action/volume.mdx b/fern/products/sdk-reference/typescript/relay/action/play-action/volume.mdx new file mode 100644 index 0000000000..975110a205 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/play-action/volume.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/play-action/volume" +title: "volume" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.PlayAction.volume" + parent: "relay.Action.PlayAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `volume` + +Adjust playback volume. + +## Signature + +```typescript +volume(volume: number): Promise> +``` + +## Parameters + + + Volume adjustment in dB. + + +## Returns + +`Promise>` — The platform's volume response. + +## Throws + +- When the volume command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 198. diff --git a/fern/products/sdk-reference/typescript/relay/action/play-action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/play-action/wait.mdx new file mode 100644 index 0000000000..7e7aea50ef --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/play-action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/play-action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.PlayAction.wait" + parent: "relay.Action.PlayAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/action/record-action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/record-action/constructor.mdx new file mode 100644 index 0000000000..449fafdb8f --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/record-action/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/record-action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.RecordAction.constructor" + parent: "relay.Action.RecordAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(call: CallLike, controlId: string): RecordAction +``` + +## Parameters + + + + + +## Returns + +`RecordAction` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 207. diff --git a/fern/products/sdk-reference/typescript/relay/action/record-action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/record-action/index.mdx new file mode 100644 index 0000000000..c4d6775691 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/record-action/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/relay/action/record-action" +title: "RecordAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.RecordAction" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `RecordAction` + +Async handle for a `calling.call.record` action — controls recording in progress. + +## Signature + +```typescript +class RecordAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/typescript/relay/action/action) + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + + + Pause the recording (resumable with [resume](/reference/typescript/relay/action/record-action/resume)). + + + + Resume recording paused by [pause](/reference/typescript/relay/action/record-action/pause). + + + + Stop the recording and finalise the file. + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 206. diff --git a/fern/products/sdk-reference/typescript/relay/action/record-action/pause.mdx b/fern/products/sdk-reference/typescript/relay/action/record-action/pause.mdx new file mode 100644 index 0000000000..c3523c6641 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/record-action/pause.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/record-action/pause" +title: "pause" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.RecordAction.pause" + parent: "relay.Action.RecordAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `pause` + +Pause the recording (resumable with [resume](/reference/typescript/relay/action/record-action/resume)). + +## Signature + +```typescript +pause(behavior?: string): Promise> +``` + +## Parameters + + + Optional behaviour hint (e.g. `"silence"`) controlling what is recorded in place of paused audio. + + +## Returns + +`Promise>` — The platform's pause response. + +## Throws + +- When the pause command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 229. diff --git a/fern/products/sdk-reference/typescript/relay/action/record-action/resume.mdx b/fern/products/sdk-reference/typescript/relay/action/record-action/resume.mdx new file mode 100644 index 0000000000..802f7725c5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/record-action/resume.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/record-action/resume" +title: "resume" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.RecordAction.resume" + parent: "relay.Action.RecordAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `resume` + +Resume recording paused by [pause](/reference/typescript/relay/action/record-action/pause). + +## Signature + +```typescript +resume(): Promise> +``` + +## Returns + +`Promise>` — The platform's resume response. + +## Throws + +- When the resume command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 241. diff --git a/fern/products/sdk-reference/typescript/relay/action/record-action/stop.mdx b/fern/products/sdk-reference/typescript/relay/action/record-action/stop.mdx new file mode 100644 index 0000000000..6d65a15a39 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/record-action/stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/record-action/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.RecordAction.stop" + parent: "relay.Action.RecordAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `stop` + +Stop the recording and finalise the file. + +## Signature + +```typescript +stop(): Promise> +``` + +## Returns + +`Promise>` — The platform's stop response. + +## Throws + +- When the stop command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 217. diff --git a/fern/products/sdk-reference/typescript/relay/action/record-action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/record-action/wait.mdx new file mode 100644 index 0000000000..edb4bd77fb --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/record-action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/record-action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.RecordAction.wait" + parent: "relay.Action.RecordAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/constructor.mdx new file mode 100644 index 0000000000..8654622f28 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/standalone-collect-action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.StandaloneCollectAction.constructor" + parent: "relay.Action.StandaloneCollectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(call: CallLike, controlId: string): StandaloneCollectAction +``` + +## Parameters + + + + + +## Returns + +`StandaloneCollectAction` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 333. diff --git a/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/index.mdx new file mode 100644 index 0000000000..69a9c5e70b --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/typescript/relay/action/standalone-collect-action" +title: "StandaloneCollectAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.StandaloneCollectAction" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `StandaloneCollectAction` + +Async handle for a bare `calling.call.collect` action (no accompanying play). + +## Signature + +```typescript +class StandaloneCollectAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/typescript/relay/action/action) + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + + + Start the collect input timers. + + + + Stop the collect operation before input is received. + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 332. diff --git a/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/start-input-timers.mdx b/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/start-input-timers.mdx new file mode 100644 index 0000000000..bf006edce1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/start-input-timers.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/standalone-collect-action/start-input-timers" +title: "startInputTimers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.StandaloneCollectAction.startInputTimers" + parent: "relay.Action.StandaloneCollectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `startInputTimers` + +Start the collect input timers. + +## Signature + +```typescript +startInputTimers(): Promise> +``` + +## Returns + +`Promise>` — The platform's start\_input\_timers response. + +## Throws + +- When the command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 362. diff --git a/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/stop.mdx b/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/stop.mdx new file mode 100644 index 0000000000..fae111413d --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/standalone-collect-action/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.StandaloneCollectAction.stop" + parent: "relay.Action.StandaloneCollectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `stop` + +Stop the collect operation before input is received. + +## Signature + +```typescript +stop(): Promise> +``` + +## Returns + +`Promise>` — The platform's stop response. + +## Throws + +- When the stop command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 352. diff --git a/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/wait.mdx new file mode 100644 index 0000000000..4105036a64 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/standalone-collect-action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/standalone-collect-action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.StandaloneCollectAction.wait" + parent: "relay.Action.StandaloneCollectAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/action/stream-action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/stream-action/constructor.mdx new file mode 100644 index 0000000000..5ae537a04b --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/stream-action/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/stream-action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.StreamAction.constructor" + parent: "relay.Action.StreamAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(call: CallLike, controlId: string): StreamAction +``` + +## Parameters + + + + + +## Returns + +`StreamAction` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 412. diff --git a/fern/products/sdk-reference/typescript/relay/action/stream-action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/stream-action/index.mdx new file mode 100644 index 0000000000..fe23440e71 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/stream-action/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/action/stream-action" +title: "StreamAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.StreamAction" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `StreamAction` + +Async handle for a `calling.call.stream` action (outbound media stream). + +## Signature + +```typescript +class StreamAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/typescript/relay/action/action) + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + + + Stop the outbound stream. + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 411. diff --git a/fern/products/sdk-reference/typescript/relay/action/stream-action/stop.mdx b/fern/products/sdk-reference/typescript/relay/action/stream-action/stop.mdx new file mode 100644 index 0000000000..1b60c8f606 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/stream-action/stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/stream-action/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.StreamAction.stop" + parent: "relay.Action.StreamAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `stop` + +Stop the outbound stream. + +## Signature + +```typescript +stop(): Promise> +``` + +## Returns + +`Promise>` — The platform's stop response. + +## Throws + +- When the stop command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 422. diff --git a/fern/products/sdk-reference/typescript/relay/action/stream-action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/stream-action/wait.mdx new file mode 100644 index 0000000000..868cf500e6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/stream-action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/stream-action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.StreamAction.wait" + parent: "relay.Action.StreamAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/action/tap-action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/tap-action/constructor.mdx new file mode 100644 index 0000000000..743923dfdb --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/tap-action/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/tap-action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.TapAction.constructor" + parent: "relay.Action.TapAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(call: CallLike, controlId: string): TapAction +``` + +## Parameters + + + + + +## Returns + +`TapAction` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 393. diff --git a/fern/products/sdk-reference/typescript/relay/action/tap-action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/tap-action/index.mdx new file mode 100644 index 0000000000..b124aa1cee --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/tap-action/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/action/tap-action" +title: "TapAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.TapAction" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `TapAction` + +Async handle for a `calling.call.tap` action (media mirroring). + +## Signature + +```typescript +class TapAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/typescript/relay/action/action) + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + + + Stop the media tap. + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 392. diff --git a/fern/products/sdk-reference/typescript/relay/action/tap-action/stop.mdx b/fern/products/sdk-reference/typescript/relay/action/tap-action/stop.mdx new file mode 100644 index 0000000000..d3567e672a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/tap-action/stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/tap-action/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.TapAction.stop" + parent: "relay.Action.TapAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `stop` + +Stop the media tap. + +## Signature + +```typescript +stop(): Promise> +``` + +## Returns + +`Promise>` — The platform's stop response. + +## Throws + +- When the stop command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 403. diff --git a/fern/products/sdk-reference/typescript/relay/action/tap-action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/tap-action/wait.mdx new file mode 100644 index 0000000000..44a788625b --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/tap-action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/tap-action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.TapAction.wait" + parent: "relay.Action.TapAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/action/transcribe-action/constructor.mdx b/fern/products/sdk-reference/typescript/relay/action/transcribe-action/constructor.mdx new file mode 100644 index 0000000000..75a5b6fe37 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/transcribe-action/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/transcribe-action/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.TranscribeAction.constructor" + parent: "relay.Action.TranscribeAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(call: CallLike, controlId: string): TranscribeAction +``` + +## Parameters + + + + + +## Returns + +`TranscribeAction` + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/relay/action/transcribe-action/index.mdx b/fern/products/sdk-reference/typescript/relay/action/transcribe-action/index.mdx new file mode 100644 index 0000000000..4d94423fdf --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/transcribe-action/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/action/transcribe-action" +title: "TranscribeAction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Action.TranscribeAction" + parent: "relay.Action" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `TranscribeAction` + +Async handle for a `calling.call.transcribe` action (real-time transcription). + +## Signature + +```typescript +class TranscribeAction extends Action +``` + +## Inheritance + +**Extends:** [Action](/reference/typescript/relay/action/action) + +## Properties + + + Reference to the owning call. + + + + Whether the action has reached a terminal state. + + + + Unique control ID used by the server to route events back to this action. + + + + True once the action has reached a terminal state. + + + + Final event once the action terminates, or `null` while still running. + + +## Methods + + + + + + Stop the transcription. + + + + Wait for the action to complete. + + + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 449. diff --git a/fern/products/sdk-reference/typescript/relay/action/transcribe-action/stop.mdx b/fern/products/sdk-reference/typescript/relay/action/transcribe-action/stop.mdx new file mode 100644 index 0000000000..26f6950bbe --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/transcribe-action/stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/action/transcribe-action/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.TranscribeAction.stop" + parent: "relay.Action.TranscribeAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `stop` + +Stop the transcription. + +## Signature + +```typescript +stop(): Promise> +``` + +## Returns + +`Promise>` — The platform's stop response. + +## Throws + +- When the stop command is rejected. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 460. diff --git a/fern/products/sdk-reference/typescript/relay/action/transcribe-action/wait.mdx b/fern/products/sdk-reference/typescript/relay/action/transcribe-action/wait.mdx new file mode 100644 index 0000000000..783181818c --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/action/transcribe-action/wait.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/action/transcribe-action/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Action.TranscribeAction.wait" + parent: "relay.Action.TranscribeAction" + module: "relay.Action" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts" +--- +# `wait` + +Wait for the action to complete. + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The terminal [RelayEvent](/reference/typescript/relay/relay-event) for this action. + +## Throws + +- When the optional timeout elapses before the action ends. + +## Source + +[`src/relay/Action.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Action.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/ai-hold.mdx b/fern/products/sdk-reference/typescript/relay/call/call/ai-hold.mdx new file mode 100644 index 0000000000..0f3944560c --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/ai-hold.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/relay/call/call/ai-hold" +title: "aiHold" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.aiHold" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `aiHold` + +Put the AI agent session on hold (pause turn-taking). + +## Signature + +```typescript +aiHold(options: { ...2 fields } = {}): Promise> +``` + +## Parameters + + + Hold behaviour. + + + Prompt played to the caller during the hold. + + + + Maximum hold duration. + + + +## Returns + +`Promise>` — The platform's ai\_hold response. + +## Throws + +- When the ai\_hold command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1185. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/ai-message.mdx b/fern/products/sdk-reference/typescript/relay/call/call/ai-message.mdx new file mode 100644 index 0000000000..45bdee6746 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/ai-message.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/relay/call/call/ai-message" +title: "aiMessage" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.aiMessage" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `aiMessage` + +Send a message into an active AI agent session. + +## Signature + +```typescript +aiMessage(options: { ...4 fields } = {}): Promise> +``` + +## Parameters + + + Message parameters. + + + Global-data updates to merge. + + + + Text content to inject into the conversation. + + + + Reset directives for the conversation state. + + + + Speaker role (`"system"`, `"user"`, or `"assistant"`). + + + +## Returns + +`Promise>` — The platform's ai\_message response. + +## Throws + +- When the ai\_message command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1162. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/ai-unhold.mdx b/fern/products/sdk-reference/typescript/relay/call/call/ai-unhold.mdx new file mode 100644 index 0000000000..20e964c29e --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/ai-unhold.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/relay/call/call/ai-unhold" +title: "aiUnhold" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.aiUnhold" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `aiUnhold` + +Resume an AI agent session from hold. + +## Signature + +```typescript +aiUnhold(options: { ...1 fields } = {}): Promise> +``` + +## Parameters + + + Unhold behaviour. + + + Prompt played to the caller on resume. + + + +## Returns + +`Promise>` — The platform's ai\_unhold response. + +## Throws + +- When the ai\_unhold command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1200. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/ai.mdx b/fern/products/sdk-reference/typescript/relay/call/call/ai.mdx new file mode 100644 index 0000000000..5606f2ad3c --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/ai.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/relay/call/call/ai" +title: "ai" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.ai" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `ai` + +Start an AI agent session on the call. + +## Signature + +```typescript +ai(options: { ...14 fields } = {}): Promise +``` + +## Parameters + + + AI configuration — prompts, voices, tools, languages, etc. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`Promise` — An [AIAction](/reference/typescript/relay/action/ai-action) for control and completion tracking. + +## Throws + +- When the ai command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1086. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/amazon-bedrock.mdx b/fern/products/sdk-reference/typescript/relay/call/call/amazon-bedrock.mdx new file mode 100644 index 0000000000..8b729024f8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/amazon-bedrock.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/relay/call/call/amazon-bedrock" +title: "amazonBedrock" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.amazonBedrock" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `amazonBedrock` + +Connect the call to an Amazon Bedrock AI agent. + +## Signature + +```typescript +amazonBedrock(options: { ...6 fields } = {}): Promise> +``` + +## Parameters + + + Bedrock agent configuration. + + + AI engine parameters. + + + + Global-data object available to SWAIG tools. + + + + Post-prompt configuration. + + + + URL to POST the final summary to. + + + + Prompt to send to the Bedrock agent. + + + + SWAIG configuration (functions, includes, etc.). + + + +## Returns + +`Promise>` — The platform's amazon\_bedrock response. + +## Throws + +- When the amazon\_bedrock command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1133. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/answer.mdx b/fern/products/sdk-reference/typescript/relay/call/call/answer.mdx new file mode 100644 index 0000000000..b6ec9a9ed0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/answer.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/call/call/answer" +title: "answer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.answer" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `answer` + +Answer an inbound call. + +## Signature + +```typescript +answer(extra?: Record): Promise> +``` + +## Parameters + + + Optional additional params merged into the answer request (e.g. SIP headers, codec hints). + + +## Returns + +`Promise>` — The platform's answer response. + +## Throws + +- When the answer command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 318. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/bind-digit.mdx b/fern/products/sdk-reference/typescript/relay/call/call/bind-digit.mdx new file mode 100644 index 0000000000..3bb075f95a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/bind-digit.mdx @@ -0,0 +1,68 @@ +--- +slug: "/reference/typescript/relay/call/call/bind-digit" +title: "bindDigit" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.bindDigit" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `bindDigit` + +Bind a DTMF digit sequence to trigger a RELAY method automatically when +the caller presses it. + +## Signature + +```typescript +bindDigit( + digits: string, + bindMethod: string, + options: { ...3 fields } = {} +): Promise> +``` + +## Parameters + + + DTMF sequence that triggers the binding (e.g. `"*9"`). + + + + RELAY method to invoke when the sequence is detected. + + + + Binding behaviour. + + + Params forwarded to `bindMethod` on trigger. + + + + Maximum number of times the binding can fire. + + + + Optional realm label so bindings can be cleared in groups. + + + +## Returns + +`Promise>` — The platform's bind\_digit response. + +## Throws + +- When the bind\_digit command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 980. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/clear-digit-bindings.mdx b/fern/products/sdk-reference/typescript/relay/call/call/clear-digit-bindings.mdx new file mode 100644 index 0000000000..998190338a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/clear-digit-bindings.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/call/call/clear-digit-bindings" +title: "clearDigitBindings" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.clearDigitBindings" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `clearDigitBindings` + +Clear all digit bindings, optionally filtered by realm. + +## Signature + +```typescript +clearDigitBindings(realm?: string): Promise> +``` + +## Parameters + + + When provided, only bindings with this realm label are cleared. + + +## Returns + +`Promise>` — The platform's clear\_digit\_bindings response. + +## Throws + +- When the clear\_digit\_bindings command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1006. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/collect.mdx b/fern/products/sdk-reference/typescript/relay/call/call/collect.mdx new file mode 100644 index 0000000000..d54e7ef3b6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/collect.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/typescript/relay/call/call/collect" +title: "collect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.collect" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `collect` + +Collect digit / speech input without playing media. + +## Signature + +```typescript +collect(options: { ...9 fields } = {}): Promise +``` + +## Parameters + + + Collect configuration. + + + Keep collecting until explicitly stopped. + + + + Explicit control ID. Auto-generated when omitted. + + + + DTMF digit-collection config. + + + + Seconds to wait for the first input. + + + + Callback fired when collect completes. + + + + Emit partial (interim) results. + + + + Emit a start-of-input event when detected. + + + + Speech-recognition config. + + + + Start input timers immediately. + + + +## Returns + +`Promise` — A [StandaloneCollectAction](/reference/typescript/relay/action/standalone-collect-action) for control and completion tracking. + +## Throws + +- When the collect command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/connect.mdx b/fern/products/sdk-reference/typescript/relay/call/call/connect.mdx new file mode 100644 index 0000000000..2a78a4a3a7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/connect.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/typescript/relay/call/call/connect" +title: "connect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.connect" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `connect` + +Bridge the call to one or more destinations. + +## Signature + +```typescript +connect( + devices: Record[][], + options: { ...5 fields } = {} +): Promise> +``` + +## Parameters + + + Serial/parallel dial plan — outer array of serial groups, inner arrays dialled in parallel. + + + + Connect behaviour. + + + Maximum connect duration in seconds. + + + + Price cap per minute. + + + + Ringback media played to the originating party. + + + + Webhook URL for status events. + + + + Tag for event correlation. + + + +## Returns + +`Promise>` — The platform's connect response. + +## Throws + +- When the connect command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 509. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/constructor.mdx b/fern/products/sdk-reference/typescript/relay/call/call/constructor.mdx new file mode 100644 index 0000000000..8680fcdbea --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/constructor.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/relay/call/call/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.constructor" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + client: RelayClientLike, + callId: string, + nodeId: string, + projectId: string, + context: string, + options: { ...5 fields } = {} +): Call +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`Call` + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 91. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/denoise-stop.mdx b/fern/products/sdk-reference/typescript/relay/call/call/denoise-stop.mdx new file mode 100644 index 0000000000..4f031feb9f --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/denoise-stop.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/call/call/denoise-stop" +title: "denoiseStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.denoiseStop" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `denoiseStop` + +Stop noise reduction on the call. + +## Signature + +```typescript +denoiseStop(): Promise> +``` + +## Returns + +`Promise>` — The platform's denoise-stop response. + +## Throws + +- When the denoise.stop command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 917. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/denoise.mdx b/fern/products/sdk-reference/typescript/relay/call/call/denoise.mdx new file mode 100644 index 0000000000..5d9d9cca2a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/denoise.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/call/call/denoise" +title: "denoise" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.denoise" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `denoise` + +Start noise reduction on the call. + +## Signature + +```typescript +denoise(): Promise> +``` + +## Returns + +`Promise>` — The platform's denoise response. + +## Throws + +- When the denoise command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 907. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/detect.mdx b/fern/products/sdk-reference/typescript/relay/call/call/detect.mdx new file mode 100644 index 0000000000..11c04597e2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/detect.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/relay/call/call/detect" +title: "detect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.detect" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `detect` + +Start audio detection (answering machine, fax, DTMF). + +## Signature + +```typescript +detect( + detect: Record, + options: { ...3 fields } = {} +): Promise +``` + +## Parameters + + + Platform-shaped detect configuration. + + + + Detection behaviour. + + + Explicit control ID. Auto-generated when omitted. + + + + Callback fired when detection completes. + + + + Detection timeout in seconds. + + + +## Returns + +`Promise` — A [DetectAction](/reference/typescript/relay/action/detect-action) for control and completion tracking. + +## Throws + +- When the detect command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 566. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/disconnect.mdx b/fern/products/sdk-reference/typescript/relay/call/call/disconnect.mdx new file mode 100644 index 0000000000..b2423c1eb0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/disconnect.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/call/call/disconnect" +title: "disconnect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.disconnect" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `disconnect` + +Disconnect (unbridge) a connected call. + +## Signature + +```typescript +disconnect(): Promise> +``` + +## Returns + +`Promise>` — The platform's disconnect response. + +## Throws + +- When the disconnect command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/echo.mdx b/fern/products/sdk-reference/typescript/relay/call/call/echo.mdx new file mode 100644 index 0000000000..e725e1ddf3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/echo.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/relay/call/call/echo" +title: "echo" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.echo" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `echo` + +Echo audio back to the caller (useful for testing network round-trip). + +## Signature + +```typescript +echo(options: { ...2 fields } = {}): Promise> +``` + +## Parameters + + + Echo behaviour. + + + Webhook URL for echo status events. + + + + How long to echo, in seconds. + + + +## Returns + +`Promise>` — The platform's echo response. + +## Throws + +- When the echo command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 958. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/hangup.mdx b/fern/products/sdk-reference/typescript/relay/call/call/hangup.mdx new file mode 100644 index 0000000000..d5795a90fe --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/hangup.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/call/call/hangup" +title: "hangup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.hangup" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `hangup` + +End / hang up the call. + +## Signature + +```typescript +hangup(reason: string = 'hangup'): Promise> +``` + +## Parameters + + + Hangup reason delivered to the platform. Defaults to `"hangup"`. + + +## Returns + +`Promise>` — The platform's end response. + +## Throws + +- When the end command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 330. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/hold.mdx b/fern/products/sdk-reference/typescript/relay/call/call/hold.mdx new file mode 100644 index 0000000000..103f0a8103 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/hold.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/call/call/hold" +title: "hold" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.hold" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `hold` + +Put the call on hold. + +## Signature + +```typescript +hold(): Promise> +``` + +## Returns + +`Promise>` — The platform's hold response. + +## Throws + +- When the hold command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 885. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/index.mdx b/fern/products/sdk-reference/typescript/relay/call/call/index.mdx new file mode 100644 index 0000000000..6b2b6ade32 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/index.mdx @@ -0,0 +1,272 @@ +--- +slug: "/reference/typescript/relay/call/call" +title: "Call" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Call.Call" + parent: "relay.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `Call` + +Live RELAY call with command methods. + +Don't construct directly — `Call` instances are created by [RelayClient](/reference/typescript/relay/relay-client) +for inbound calls (delivered to your `onCall` handler) and for outbound dials. + +Each command method (`answer()`, `play()`, `record()`, etc.) returns when the +platform acknowledges the command; event-driven completion is exposed via +[Action](/reference/typescript/relay/action) objects returned from the async "play/record/..." variants. + +## Signature + +```typescript +class Call +``` + +## Examples + +```typescript +client.onCall(async (call) => { + await call.answer(); + const play = await call.playAsync({ play: [{ type: 'tts', text: 'Hello!' }] }); + await play.wait(); + await call.hangup(); +}); +``` + +## See Also + +- \- \[RelayClient]\(/reference/typescript/relay/relay-client) + \- \[Action]\(/reference/typescript/relay/action) + +## Properties + + + Unique call identifier assigned by the platform. + + + + RELAY context this call was received on. + + + + Device descriptor the call is associated with (phone, SIP, etc.). + + + + `"inbound"` or `"outbound"`. + + + + RELAY node that owns this call. + + + + SignalWire project ID. + + + + Call segment ID used for event correlation. + + + + Current call state (e.g. `"created"`, `"answered"`, `"ended"`). + + + + Opaque correlation tag attached at dial time. + + +## Methods + + + + Start an AI agent session on the call. + + + + Put the AI agent session on hold (pause turn-taking). + + + + Send a message into an active AI agent session. + + + + Resume an AI agent session from hold. + + + + Connect the call to an Amazon Bedrock AI agent. + + + + Answer an inbound call. + + + + Bind a DTMF digit sequence to trigger a RELAY method automatically when the caller presses it. + + + + Clear all digit bindings, optionally filtered by realm. + + + + Collect digit / speech input without playing media. + + + + Bridge the call to one or more destinations. + + + + + + Start noise reduction on the call. + + + + Stop noise reduction on the call. + + + + Start audio detection (answering machine, fax, DTMF). + + + + Disconnect (unbridge) a connected call. + + + + Echo audio back to the caller (useful for testing network round-trip). + + + + End / hang up the call. + + + + Put the call on hold. + + + + Join an ad-hoc audio conference. + + + + Join a video / audio room. + + + + Leave an audio conference. + + + + Leave the current room. + + + + Start or stop live transcription on the call. + + + + Start or stop live translation on the call. + + + + Register an event listener for this call. + + + + Decline control of an inbound call, returning it to routing. + + + + Start a PCI-compliant payment collection flow. + + + + Play audio content on the call. + + + + Play audio and collect digit / speech input in a single operation. + + + + Place the call into a named queue. + + + + Remove the call from a queue. + + + + Receive a fax and save it server-side. + + + + Record audio from the call. + + + + Transfer a SIP call via REFER. + + + + Send DTMF digits on the call. + + + + Send a fax document. + + + + Start streaming call audio to a WebSocket endpoint. + + + + Intercept call media and stream it to an external destination. + + + + Return a human-readable diagnostic string. + + + + Start transcribing the call. + + + + Transfer call control to another RELAY app or SWML script. + + + + Release the call from hold. + + + + Emit a custom user-defined event on the call for your webhooks. + + + + Wait for a specific event, optionally filtered by predicate. + + + + Wait for the call to reach the `ended` state. + + + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/join-conference.mdx b/fern/products/sdk-reference/typescript/relay/call/call/join-conference.mdx new file mode 100644 index 0000000000..8500c3baf4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/join-conference.mdx @@ -0,0 +1,88 @@ +--- +slug: "/reference/typescript/relay/call/call/join-conference" +title: "joinConference" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.joinConference" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `joinConference` + +Join an ad-hoc audio conference. + +## Signature + +```typescript +joinConference( + name: string, + options: { ...19 fields } = {} +): Promise> +``` + +## Parameters + + + Conference name. Participants on the same name hear each other. + + + + Conference behaviour (muting, recording, status callbacks, etc.). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`Promise>` — The platform's join-conference response. + +## Throws + +- When the join\_conference command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 818. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/join-room.mdx b/fern/products/sdk-reference/typescript/relay/call/call/join-room.mdx new file mode 100644 index 0000000000..56896dd1ec --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/join-room.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/relay/call/call/join-room" +title: "joinRoom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.joinRoom" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `joinRoom` + +Join a video / audio room. + +## Signature + +```typescript +joinRoom( + name: string, + options: { ...1 fields } = {} +): Promise> +``` + +## Parameters + + + Room name — callers on the same name share the same room. + + + + Room behaviour. + + + Webhook URL for room status events. + + + +## Returns + +`Promise>` — The platform's join\_room response. + +## Throws + +- When the join\_room command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1057. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/leave-conference.mdx b/fern/products/sdk-reference/typescript/relay/call/call/leave-conference.mdx new file mode 100644 index 0000000000..a027a04763 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/leave-conference.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/relay/call/call/leave-conference" +title: "leaveConference" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.leaveConference" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `leaveConference` + +Leave an audio conference. + +## Signature + +```typescript +leaveConference( + conferenceId: string, + extra?: Record +): Promise> +``` + +## Parameters + + + Identifier of the conference to leave. + + + + Optional additional params merged into the request. + + +## Returns + +`Promise>` — The platform's leave-conference response. + +## Throws + +- When the leave\_conference command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 873. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/leave-room.mdx b/fern/products/sdk-reference/typescript/relay/call/call/leave-room.mdx new file mode 100644 index 0000000000..f93ab6b619 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/leave-room.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/call/call/leave-room" +title: "leaveRoom" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.leaveRoom" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `leaveRoom` + +Leave the current room. + +## Signature + +```typescript +leaveRoom(extra?: Record): Promise> +``` + +## Parameters + + + Optional additional params merged into the request. + + +## Returns + +`Promise>` — The platform's leave\_room response. + +## Throws + +- When the leave\_room command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1073. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/live-transcribe.mdx b/fern/products/sdk-reference/typescript/relay/call/call/live-transcribe.mdx new file mode 100644 index 0000000000..dfe8cb3b17 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/live-transcribe.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/relay/call/call/live-transcribe" +title: "liveTranscribe" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.liveTranscribe" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `liveTranscribe` + +Start or stop live transcription on the call. + +## Signature + +```typescript +liveTranscribe( + action: Record, + extra?: Record +): Promise> +``` + +## Parameters + + + Platform-shaped action block (`start` or `stop` plus configuration). + + + + Optional additional params merged into the request. + + +## Returns + +`Promise>` — The platform's live\_transcribe response. + +## Throws + +- When the live\_transcribe command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1023. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/live-translate.mdx b/fern/products/sdk-reference/typescript/relay/call/call/live-translate.mdx new file mode 100644 index 0000000000..240a608076 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/live-translate.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/relay/call/call/live-translate" +title: "liveTranslate" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.liveTranslate" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `liveTranslate` + +Start or stop live translation on the call. + +## Signature + +```typescript +liveTranslate( + action: Record, + options: { ...1 fields } = {} +): Promise> +``` + +## Parameters + + + Platform-shaped action block (`start` or `stop` plus source/target languages). + + + + Live-translate behaviour. + + + Webhook URL for translation status events. + + + +## Returns + +`Promise>` — The platform's live\_translate response. + +## Throws + +- When the live\_translate command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1037. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/on.mdx b/fern/products/sdk-reference/typescript/relay/call/call/on.mdx new file mode 100644 index 0000000000..3ce3002c4d --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/on.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/relay/call/call/on" +title: "on" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.on" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `on` + +Register an event listener for this call. + +Multiple listeners for the same event type are supported. Listener errors +are logged but do not disrupt dispatch to other listeners. + +## Signature + +```typescript +on(eventType: string, handler: EventHandler): void +``` + +## Parameters + + + Fully-qualified event type (e.g. `"calling.call.state"`, `"calling.call.play"`). + + + + Callback invoked for each matching event. + + +## Returns + +`void` + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 153. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/pass.mdx b/fern/products/sdk-reference/typescript/relay/call/call/pass.mdx new file mode 100644 index 0000000000..82bf65ce7f --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/pass.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/relay/call/call/pass" +title: "pass" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.pass" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `pass` + +Decline control of an inbound call, returning it to routing. + +Use instead of [answer](/reference/typescript/relay/call/call/answer) when you want the call to fall through to +the next matching route rather than be handled by this client. + +## Signature + +```typescript +pass(): Promise> +``` + +## Returns + +`Promise>` — The platform's pass response. + +## Throws + +- When the pass command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 343. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/pay.mdx b/fern/products/sdk-reference/typescript/relay/call/call/pay.mdx new file mode 100644 index 0000000000..60a82950e8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/pay.mdx @@ -0,0 +1,88 @@ +--- +slug: "/reference/typescript/relay/call/call/pay" +title: "pay" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.pay" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `pay` + +Start a PCI-compliant payment collection flow. + +## Signature + +```typescript +pay( + paymentConnectorUrl: string, + options: { ...19 fields } = {} +): Promise +``` + +## Parameters + + + URL of the configured payment connector to tokenise the card with. + + + + Payment configuration — card-type filters, prompts, charge amount, etc. See the SignalWire pay documentation for field details. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`Promise` — A [PayAction](/reference/typescript/relay/action/pay-action) tracking the payment-collection flow. + +## Throws + +- When the pay command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 613. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/play-and-collect.mdx b/fern/products/sdk-reference/typescript/relay/call/call/play-and-collect.mdx new file mode 100644 index 0000000000..3c3aa753d4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/play-and-collect.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/call/call/play-and-collect" +title: "playAndCollect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.playAndCollect" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `playAndCollect` + +Play audio and collect digit / speech input in a single operation. + +Convenient for IVR prompts — playback stops as soon as input is received. + +## Signature + +```typescript +playAndCollect( + media: Record[], + collect: Record, + options: { ...3 fields } = {} +): Promise +``` + +## Parameters + + + Audio items to play while collecting. + + + + Platform-shaped collect config (`digits`, `speech`, etc.). + + + + Playback and collection behaviour. + + + Explicit control ID. Auto-generated when omitted. + + + + Callback fired when collect completes. + + + + Playback volume adjustment in dB. + + + +## Returns + +`Promise` — A [CollectAction](/reference/typescript/relay/action/collect-action) for the combined play-and-collect flow. + +## Throws + +- When the play\_and\_collect command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 433. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/play.mdx b/fern/products/sdk-reference/typescript/relay/call/call/play.mdx new file mode 100644 index 0000000000..ee56e9a871 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/play.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/typescript/relay/call/call/play" +title: "play" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.play" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `play` + +Play audio content on the call. + +Returns immediately with a [PlayAction](/reference/typescript/relay/action/play-action) — `await action.wait()` to +block until playback finishes, or call `stop()` / `pause()` / `resume()` +/ `volume()` on it to control playback. + +## Signature + +```typescript +play( + media: Record[], + options: { ...5 fields } = {} +): Promise +``` + +## Parameters + + + Platform-shaped play items (TTS, audio URLs, silence, etc.). + + + + Optional playback controls. + + + Explicit control ID. Auto-generated when omitted. + + + + `"speak"`, `"hear"`, or `"both"`. + + + + Number of times to loop the playback. + + + + Callback fired when playback reaches a terminal state. + + + + Volume adjustment in dB. + + + +## Returns + +`Promise` — A [PlayAction](/reference/typescript/relay/action/play-action) for control and completion tracking. + +## Throws + +- When the play command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 367. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/queue-enter.mdx b/fern/products/sdk-reference/typescript/relay/call/call/queue-enter.mdx new file mode 100644 index 0000000000..f38a3df8d3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/queue-enter.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/relay/call/call/queue-enter" +title: "queueEnter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.queueEnter" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `queueEnter` + +Place the call into a named queue. + +## Signature + +```typescript +queueEnter( + queueName: string, + options: { ...2 fields } = {} +): Promise> +``` + +## Parameters + + + Name of the queue to enter. + + + + Queue-entry behaviour. + + + Explicit control ID. Auto-generated when omitted. + + + + Webhook URL for queue status events. + + + +## Returns + +`Promise>` — The platform's queue.enter response. + +## Throws + +- When the queue.enter command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1234. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/queue-leave.mdx b/fern/products/sdk-reference/typescript/relay/call/call/queue-leave.mdx new file mode 100644 index 0000000000..b779cc85bb --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/queue-leave.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/relay/call/call/queue-leave" +title: "queueLeave" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.queueLeave" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `queueLeave` + +Remove the call from a queue. + +## Signature + +```typescript +queueLeave( + queueName: string, + options: { ...3 fields } = {} +): Promise> +``` + +## Parameters + + + Name of the queue to leave. + + + + Queue-exit behaviour. + + + Explicit control ID. Auto-generated when omitted. + + + + Queue ID override (when multiple queues share a name). + + + + Webhook URL for queue status events. + + + +## Returns + +`Promise>` — The platform's queue.leave response. + +## Throws + +- When the queue.leave command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1258. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/receive-fax.mdx b/fern/products/sdk-reference/typescript/relay/call/call/receive-fax.mdx new file mode 100644 index 0000000000..4ddad7f8fa --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/receive-fax.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/relay/call/call/receive-fax" +title: "receiveFax" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.receiveFax" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `receiveFax` + +Receive a fax and save it server-side. + +## Signature + +```typescript +receiveFax(options: { ...2 fields } = {}): Promise +``` + +## Parameters + + + Fax reception behaviour. + + + Explicit control ID. Auto-generated when omitted. + + + + Callback fired when the fax completes. + + + +## Returns + +`Promise` — A [FaxAction](/reference/typescript/relay/action/fax-action) for control and completion tracking. + +## Throws + +- When the receive\_fax command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 703. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/record.mdx b/fern/products/sdk-reference/typescript/relay/call/call/record.mdx new file mode 100644 index 0000000000..2f96ceffe2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/record.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/relay/call/call/record" +title: "record" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.record" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `record` + +Record audio from the call. + +## Signature + +```typescript +record( + audio?: Record, + options: { ...2 fields } = {} +): Promise +``` + +## Parameters + + + Platform-shaped audio recording options (direction, codec, timeouts, etc.). Defaults to `{}`. + + + + Recording behaviour. + + + Explicit control ID. Auto-generated when omitted. + + + + Callback fired when the recording reaches a terminal state. + + + +## Returns + +`Promise` — A [RecordAction](/reference/typescript/relay/action/record-action) for control and completion tracking. + +## Throws + +- When the record command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 403. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/refer.mdx b/fern/products/sdk-reference/typescript/relay/call/call/refer.mdx new file mode 100644 index 0000000000..4fae58afc3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/refer.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/relay/call/call/refer" +title: "refer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.refer" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `refer` + +Transfer a SIP call via REFER. + +## Signature + +```typescript +refer( + device: Record, + options: { ...1 fields } = {} +): Promise> +``` + +## Parameters + + + Platform-shaped SIP target device descriptor. + + + + Optional REFER behaviour. + + + Webhook URL for REFER status events. + + + +## Returns + +`Promise>` — The platform's refer response. + +## Throws + +- When the refer command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 592. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/send-digits.mdx b/fern/products/sdk-reference/typescript/relay/call/call/send-digits.mdx new file mode 100644 index 0000000000..c0cd97bbd9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/send-digits.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/relay/call/call/send-digits" +title: "sendDigits" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.sendDigits" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `sendDigits` + +Send DTMF digits on the call. + +## Signature + +```typescript +sendDigits(digits: string, controlId?: string): Promise> +``` + +## Parameters + + + The DTMF digit string to send (e.g. `"1234#"`, `"ww*9"`). + + + + Explicit control ID. Auto-generated when omitted. + + +## Returns + +`Promise>` — The platform's send-digits response. + +## Throws + +- When the send\_digits command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 548. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/send-fax.mdx b/fern/products/sdk-reference/typescript/relay/call/call/send-fax.mdx new file mode 100644 index 0000000000..7feed7c48b --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/send-fax.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/relay/call/call/send-fax" +title: "sendFax" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.sendFax" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `sendFax` + +Send a fax document. + +## Signature + +```typescript +sendFax(document: string, options: { ...4 fields } = {}): Promise +``` + +## Parameters + + + URL of the document to fax (TIFF or PDF). + + + + Fax behaviour. + + + Explicit control ID. Auto-generated when omitted. + + + + Additional fax header text. + + + + Caller identity string sent in the fax header. + + + + Callback fired when the fax completes. + + + +## Returns + +`Promise` — A [FaxAction](/reference/typescript/relay/action/fax-action) for control and completion tracking. + +## Throws + +- When the send\_fax command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 677. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/stream.mdx b/fern/products/sdk-reference/typescript/relay/call/call/stream.mdx new file mode 100644 index 0000000000..66a8f2bd9b --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/stream.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/typescript/relay/call/call/stream" +title: "stream" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.stream" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `stream` + +Start streaming call audio to a WebSocket endpoint. + +## Signature + +```typescript +stream(url: string, options: { ...9 fields } = {}): Promise +``` + +## Parameters + + + WebSocket URL to stream audio to. + + + + Stream behaviour. + + + Bearer token sent to the stream endpoint. + + + + Audio codec (e.g. `"PCMU"`, `"PCMA"`). + + + + Explicit control ID. Auto-generated when omitted. + + + + Extra parameters forwarded to the stream endpoint. + + + + Friendly name for the stream. + + + + Callback fired when the stream completes. + + + + Webhook URL for stream status events. + + + + HTTP method for `statusUrl` requests. + + + + Which track to send: `"inbound"`, `"outbound"`, or `"both"`. + + + +## Returns + +`Promise` — A [StreamAction](/reference/typescript/relay/action/stream-action) for control and completion tracking. + +## Throws + +- When the stream command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 766. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/tap.mdx b/fern/products/sdk-reference/typescript/relay/call/call/tap.mdx new file mode 100644 index 0000000000..061b182c8a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/tap.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/relay/call/call/tap" +title: "tap" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.tap" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `tap` + +Intercept call media and stream it to an external destination. + +## Signature + +```typescript +tap( + tap: Record, + device: Record, + options: { ...2 fields } = {} +): Promise +``` + +## Parameters + + + Platform-shaped tap configuration (direction, codec, etc.). + + + + Destination device descriptor (WebSocket URL, etc.). + + + + Tap behaviour. + + + Explicit control ID. Auto-generated when omitted. + + + + Callback fired when the tap completes. + + + +## Returns + +`Promise` — A [TapAction](/reference/typescript/relay/action/tap-action) for control and completion tracking. + +## Throws + +- When the tap command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 728. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/to-string.mdx b/fern/products/sdk-reference/typescript/relay/call/call/to-string.mdx new file mode 100644 index 0000000000..fc509e1544 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/to-string.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/relay/call/call/to-string" +title: "toString" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.toString" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `toString` + +Return a human-readable diagnostic string. + +## Signature + +```typescript +toString(): string +``` + +## Returns + +`string` — `` — handy for log output. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1279. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/transcribe.mdx b/fern/products/sdk-reference/typescript/relay/call/call/transcribe.mdx new file mode 100644 index 0000000000..063b0000b8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/transcribe.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/relay/call/call/transcribe" +title: "transcribe" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.transcribe" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `transcribe` + +Start transcribing the call. + +## Signature + +```typescript +transcribe(options: { ...3 fields } = {}): Promise +``` + +## Parameters + + + Transcription behaviour. + + + Explicit control ID. Auto-generated when omitted. + + + + Callback fired when transcription completes. + + + + Webhook URL for transcription status events. + + + +## Returns + +`Promise` — A [TranscribeAction](/reference/typescript/relay/action/transcribe-action) for control and completion tracking. + +## Throws + +- When the transcribe command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 933. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/transfer.mdx b/fern/products/sdk-reference/typescript/relay/call/call/transfer.mdx new file mode 100644 index 0000000000..1f3106a542 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/transfer.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/relay/call/call/transfer" +title: "transfer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.transfer" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `transfer` + +Transfer call control to another RELAY app or SWML script. + +## Signature + +```typescript +transfer( + dest: string, + extra?: Record +): Promise> +``` + +## Parameters + + + Destination identifier (RELAY context, SWML URL, etc.). + + + + Optional additional params merged into the transfer request. + + +## Returns + +`Promise>` — The platform's transfer response. + +## Throws + +- When the transfer command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 803. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/unhold.mdx b/fern/products/sdk-reference/typescript/relay/call/call/unhold.mdx new file mode 100644 index 0000000000..b8bf648d16 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/unhold.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/call/call/unhold" +title: "unhold" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.unhold" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `unhold` + +Release the call from hold. + +## Signature + +```typescript +unhold(): Promise> +``` + +## Returns + +`Promise>` — The platform's unhold response. + +## Throws + +- When the unhold command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 895. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/user-event.mdx b/fern/products/sdk-reference/typescript/relay/call/call/user-event.mdx new file mode 100644 index 0000000000..c2df6e4572 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/user-event.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/relay/call/call/user-event" +title: "userEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.userEvent" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `userEvent` + +Emit a custom user-defined event on the call for your webhooks. + +## Signature + +```typescript +userEvent( + options: { event?: string } & Record = {} +): Promise> +``` + +## Parameters + + + Freeform event payload. Set `options.event` for the event name and include any additional fields your webhook expects. + + +## Returns + +`Promise>` — The platform's user\_event response. + +## Throws + +- When the user\_event command is rejected. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1216. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/wait-for-ended.mdx b/fern/products/sdk-reference/typescript/relay/call/call/wait-for-ended.mdx new file mode 100644 index 0000000000..bb9ae70395 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/wait-for-ended.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/call/call/wait-for-ended" +title: "waitForEnded" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.waitForEnded" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `waitForEnded` + +Wait for the call to reach the `ended` state. + +## Signature + +```typescript +waitForEnded(timeout?: number): Promise +``` + +## Parameters + + + Optional timeout in milliseconds. + + +## Returns + +`Promise` — The terminating `calling.call.state` [RelayEvent](/reference/typescript/relay/relay-event). + +## Throws + +- When the optional timeout elapses before the call ends. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 254. diff --git a/fern/products/sdk-reference/typescript/relay/call/call/wait-for.mdx b/fern/products/sdk-reference/typescript/relay/call/call/wait-for.mdx new file mode 100644 index 0000000000..552af70efd --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/call/wait-for.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/relay/call/call/wait-for" +title: "waitFor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.Call.waitFor" + parent: "relay.Call.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `waitFor` + +Wait for a specific event, optionally filtered by predicate. + +Registers a one-shot listener that is removed after resolving (or after +the timeout elapses). Useful for awaiting a specific state transition. + +## Signature + +```typescript +waitFor( + eventType: string, + predicate?: (event: RelayEvent) => boolean, + timeout?: number +): Promise +``` + +## Parameters + + + Event type to wait for. + + + + Optional filter — only events for which this returns `true` resolve the wait. + + + + Optional timeout in milliseconds. Omit to wait forever. + + +## Returns + +`Promise` — The first matching [RelayEvent](/reference/typescript/relay/relay-event). + +## Throws + +- When the optional timeout elapses before a match. + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 209. diff --git a/fern/products/sdk-reference/typescript/relay/call/index.mdx b/fern/products/sdk-reference/typescript/relay/call/index.mdx new file mode 100644 index 0000000000..e25587e832 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/call" +title: "Call" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "relay.Call" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `Call` + +## Signature + +```typescript +module Call +``` + +## Classes + + + + Live RELAY call with command methods. + + + +## Interfaces + + + + Interface the Call needs from RelayClient (avoids circular import). + + + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/relay/call/relay-client-like/execute.mdx b/fern/products/sdk-reference/typescript/relay/call/relay-client-like/execute.mdx new file mode 100644 index 0000000000..7ec01facd9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/relay-client-like/execute.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/relay/call/relay-client-like/execute" +title: "execute" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Call.RelayClientLike.execute" + parent: "relay.Call.RelayClientLike" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `execute` + +## Signature + +```typescript +execute( + method: string, + params: Record +): Promise> +``` + +## Parameters + + + + + +## Returns + +`Promise>` + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 40. diff --git a/fern/products/sdk-reference/typescript/relay/call/relay-client-like/index.mdx b/fern/products/sdk-reference/typescript/relay/call/relay-client-like/index.mdx new file mode 100644 index 0000000000..4e46ab40ea --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/call/relay-client-like/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/relay/call/relay-client-like" +title: "RelayClientLike" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.Call.RelayClientLike" + parent: "relay.Call" + module: "relay.Call" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts" +--- +# `RelayClientLike` + +Interface the Call needs from RelayClient (avoids circular import). + +## Signature + +```typescript +interface RelayClientLike +``` + +## Methods + + + + + +## Source + +[`src/relay/Call.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Call.ts) + +Line 39. diff --git a/fern/products/sdk-reference/typescript/relay/constants/index.mdx b/fern/products/sdk-reference/typescript/relay/constants/index.mdx new file mode 100644 index 0000000000..55958da008 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/constants/index.mdx @@ -0,0 +1,196 @@ +--- +slug: "/reference/typescript/relay/constants" +title: "constants" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "relay.constants" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/constants.ts" +--- +# `constants` + +## Signature + +```typescript +module constants +``` + +## Constants + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Protocol constants for the SignalWire RELAY calling API. + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Source + +[`src/relay/constants.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/constants.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/relay/deferred/create-deferred.mdx b/fern/products/sdk-reference/typescript/relay/deferred/create-deferred.mdx new file mode 100644 index 0000000000..e1d17cd91f --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/deferred/create-deferred.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/relay/deferred/create-deferred" +title: "createDeferred" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "relay.Deferred.createDeferred" + parent: "relay.Deferred" + module: "relay.Deferred" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Deferred.ts" +--- +# `createDeferred` + +Create a [Deferred](/reference/typescript/relay/deferred/deferred) with externalised `resolve` / `reject` and a +`settled` flag. + +The returned object exposes the promise plus its resolve and reject +functions so callers outside the executor can settle it. Later calls to +`resolve` or `reject` are idempotent. + +## Signature + +```typescript +createDeferred(): Deferred +``` + +## Type Parameters + + + Resolution value type of the wrapped promise. + + +## Returns + +`Deferred` — A fresh `Deferred` in pending state. + +## Source + +[`src/relay/Deferred.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Deferred.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/relay/deferred/deferred/index.mdx b/fern/products/sdk-reference/typescript/relay/deferred/deferred/index.mdx new file mode 100644 index 0000000000..05573e35c6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/deferred/deferred/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/relay/deferred/deferred" +title: "Deferred" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.Deferred.Deferred" + parent: "relay.Deferred" + module: "relay.Deferred" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Deferred.ts" +--- +# `Deferred` + +A promise with externalised `resolve`/`reject` and a `settled` flag, +used by the RELAY client to bridge server-push events back to in-flight +JSON-RPC request callers. + +## Signature + +```typescript +interface Deferred +``` + +## Type Parameters + + + +## Properties + + + The wrapped promise. + + + + Reject the promise idempotently (later calls are ignored). + + + + Resolve the promise idempotently (later calls are ignored). + + + + True once either `resolve` or `reject` has been called. + + +## Source + +[`src/relay/Deferred.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Deferred.ts) + +Line 12. diff --git a/fern/products/sdk-reference/typescript/relay/deferred/index.mdx b/fern/products/sdk-reference/typescript/relay/deferred/index.mdx new file mode 100644 index 0000000000..2d32ae54f2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/deferred/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/relay/deferred" +title: "Deferred" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "relay.Deferred" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Deferred.ts" +--- +# `Deferred` + +## Signature + +```typescript +module Deferred +``` + +## Functions + + + + Create a [Deferred](/reference/typescript/relay/deferred/deferred) with externalised `resolve` / `reject` and a `settled` flag. + + + + Race a promise against a timeout. + + + +## Interfaces + + + + A promise with externalised `resolve`/`reject` and a `settled` flag, used by the RELAY client to bridge server-push events back to in-flight JSON-RPC request callers. + + + +## Source + +[`src/relay/Deferred.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Deferred.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/relay/deferred/with-timeout.mdx b/fern/products/sdk-reference/typescript/relay/deferred/with-timeout.mdx new file mode 100644 index 0000000000..7515e9f0f6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/deferred/with-timeout.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/relay/deferred/with-timeout" +title: "withTimeout" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "relay.Deferred.withTimeout" + parent: "relay.Deferred" + module: "relay.Deferred" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Deferred.ts" +--- +# `withTimeout` + +Race a promise against a timeout. + +## Signature + +```typescript +withTimeout( + promise: Promise, + ms: number, + label: string = 'Operation' +): Promise +``` + +## Type Parameters + + + Resolution value type of the input promise. + + +## Parameters + + + Promise to race against the timeout. + + + + Timeout in milliseconds. + + + + Label used in the timeout error message. Defaults to `"Operation"`. + + +## Returns + +`Promise` — A new promise that resolves with `promise`'s value if it settles before the timeout, and rejects with a timeout `Error` otherwise. + +## Source + +[`src/relay/Deferred.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Deferred.ts) + +Line 73. diff --git a/fern/products/sdk-reference/typescript/relay/index.mdx b/fern/products/sdk-reference/typescript/relay/index.mdx new file mode 100644 index 0000000000..993f35b32b --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/index.mdx @@ -0,0 +1,25 @@ +--- +slug: "/reference/typescript/relay" +title: "relay" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "relay" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/index.ts" +--- +# `relay` + +## Signature + +```typescript +module relay +``` + +## Source + +[`src/relay/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/index.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/relay/message/index.mdx b/fern/products/sdk-reference/typescript/relay/message/index.mdx new file mode 100644 index 0000000000..4ce024e699 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/message/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/relay/message" +title: "Message" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "relay.Message" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts" +--- +# `Message` + +## Signature + +```typescript +module Message +``` + +## Classes + + + + SMS/MMS message in the RELAY messaging namespace. + + + +## Source + +[`src/relay/Message.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/relay/message/message/constructor.mdx b/fern/products/sdk-reference/typescript/relay/message/message/constructor.mdx new file mode 100644 index 0000000000..4d9f7e6889 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/message/message/constructor.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/relay/message/message/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Message.Message.constructor" + parent: "relay.Message.Message" + module: "relay.Message" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(options: { ...11 fields } = {}): Message +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`Message` + +## Source + +[`src/relay/Message.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts) + +Line 64. diff --git a/fern/products/sdk-reference/typescript/relay/message/message/index.mdx b/fern/products/sdk-reference/typescript/relay/message/message/index.mdx new file mode 100644 index 0000000000..24034fbccb --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/message/message/index.mdx @@ -0,0 +1,118 @@ +--- +slug: "/reference/typescript/relay/message/message" +title: "Message" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.Message.Message" + parent: "relay.Message" + module: "relay.Message" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts" +--- +# `Message` + +SMS/MMS message in the RELAY messaging namespace. + +Outbound messages progress through `queued` → `initiated` → `sent` → `delivered` +(or `undelivered` / `failed`). Inbound messages arrive with state `received`. +Call [Message.wait](/reference/typescript/relay/message/message/wait) to await a terminal state. + +## Signature + +```typescript +class Message +``` + +## Examples + +```typescript +const msg = await client.sendMessage({ + to: '+15551234567', + from: '+15557654321', + body: 'Your code is 4242', +}); + +const final = await msg.wait(30); // seconds +console.log('Final state:', final.params.message_state); +``` + +## Properties + + + Plain-text message body. + + + + RELAY context the message belongs to. + + + + `"inbound"` or `"outbound"`. + + + + Sender phone number in E.164 format. + + + + True once the message has reached a terminal state. + + + + Media URLs attached to the message (MMS). + + + + Unique message identifier assigned by the platform. + + + + Failure / undelivery reason when `state` is non-successful. + + + + Final event that terminated the message, or `null` if still in-flight. + + + + Number of segments the carrier split the message into. + + + + Current message state (e.g. `"sent"`, `"delivered"`, `"failed"`). + + + + Opaque tags attached to the message. + + + + Destination phone number in E.164 format. + + +## Methods + + + + + + Register an event listener for state changes on this message. + + + + Return a human-readable diagnostic string. + + + + Wait for the message to reach a terminal state (`delivered`, `failed`, `undelivered`, etc.). + + + +## Source + +[`src/relay/Message.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts) + +Line 36. diff --git a/fern/products/sdk-reference/typescript/relay/message/message/on.mdx b/fern/products/sdk-reference/typescript/relay/message/message/on.mdx new file mode 100644 index 0000000000..cfdb511627 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/message/message/on.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/message/message/on" +title: "on" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Message.Message.on" + parent: "relay.Message.Message" + module: "relay.Message" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts" +--- +# `on` + +Register an event listener for state changes on this message. + +The handler fires every time the server emits a `messaging.state` event +for this message (multiple listeners are supported). Listener errors are +logged but do not disrupt dispatch. + +## Signature + +```typescript +on(handler: EventHandler): void +``` + +## Parameters + + + Callback invoked for each state-change event. + + +## Returns + +`void` + +## Source + +[`src/relay/Message.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts) + +Line 113. diff --git a/fern/products/sdk-reference/typescript/relay/message/message/to-string.mdx b/fern/products/sdk-reference/typescript/relay/message/message/to-string.mdx new file mode 100644 index 0000000000..2b34cfd5f2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/message/message/to-string.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/relay/message/message/to-string" +title: "toString" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Message.Message.toString" + parent: "relay.Message.Message" + module: "relay.Message" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts" +--- +# `toString` + +Return a human-readable diagnostic string. + +## Signature + +```typescript +toString(): string +``` + +## Returns + +`string` — `Message(id=..., direction=..., state=..., from=..., to=...)` — handy for log output. + +## Source + +[`src/relay/Message.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts) + +Line 196. diff --git a/fern/products/sdk-reference/typescript/relay/message/message/wait.mdx b/fern/products/sdk-reference/typescript/relay/message/message/wait.mdx new file mode 100644 index 0000000000..4317c4b523 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/message/message/wait.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/relay/message/message/wait" +title: "wait" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.Message.Message.wait" + parent: "relay.Message.Message" + module: "relay.Message" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts" +--- +# `wait` + +Wait for the message to reach a terminal state (`delivered`, `failed`, +`undelivered`, etc.). + +## Signature + +```typescript +wait(timeout?: number): Promise +``` + +## Parameters + + + Maximum time to wait in **seconds** (matches the Python SDK convention — not milliseconds). + + +## Returns + +`Promise` — The final `messaging.state` [RelayEvent](/reference/typescript/relay/relay-event). + +## Throws + +- When the optional timeout elapses before a terminal state. + +## Source + +[`src/relay/Message.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/Message.ts) + +Line 126. diff --git a/fern/products/sdk-reference/typescript/relay/normalize/index.mdx b/fern/products/sdk-reference/typescript/relay/normalize/index.mdx new file mode 100644 index 0000000000..ed734f078c --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/normalize/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/relay/normalize" +title: "normalize" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "relay.normalize" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/normalize.ts" +--- +# `normalize` + +## Signature + +```typescript +module normalize +``` + +## Functions + + + + Normalize a single device descriptor (phone/sip/webrtc/agora/stream/...). + + + + Normalize a 2D dial plan (outer = serial groups, inner = parallel devices). + + + + Normalize a single play item (tts/audio/silence/ringtone). + + + + Normalize an array of play items. + + + +## Source + +[`src/relay/normalize.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/normalize.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/relay/normalize/normalize-device-plan.mdx b/fern/products/sdk-reference/typescript/relay/normalize/normalize-device-plan.mdx new file mode 100644 index 0000000000..c2511dce5e --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/normalize/normalize-device-plan.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/relay/normalize/normalize-device-plan" +title: "normalizeDevicePlan" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "relay.normalize.normalizeDevicePlan" + parent: "relay.normalize" + module: "relay.normalize" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/normalize.ts" +--- +# `normalizeDevicePlan` + +Normalize a 2D dial plan (outer = serial groups, inner = parallel devices). + +## Signature + +```typescript +normalizeDevicePlan( + plan: Record[][] +): Record[][] +``` + +## Parameters + + + +## Returns + +`Record[][]` + +## Source + +[`src/relay/normalize.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/normalize.ts) + +Line 58. diff --git a/fern/products/sdk-reference/typescript/relay/normalize/normalize-device.mdx b/fern/products/sdk-reference/typescript/relay/normalize/normalize-device.mdx new file mode 100644 index 0000000000..c55ffa20f2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/normalize/normalize-device.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/relay/normalize/normalize-device" +title: "normalizeDevice" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "relay.normalize.normalizeDevice" + parent: "relay.normalize" + module: "relay.normalize" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/normalize.ts" +--- +# `normalizeDevice` + +Normalize a single device descriptor (phone/sip/webrtc/agora/stream/...). + +For `phone`, also renames the SDK's short `to`/`from` keys to the wire-format +`to_number`/`from_number` that the platform expects. + +## Signature + +```typescript +normalizeDevice(device: Record): Record +``` + +## Parameters + + + +## Returns + +`Record` + +## Source + +[`src/relay/normalize.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/normalize.ts) + +Line 38. diff --git a/fern/products/sdk-reference/typescript/relay/normalize/normalize-play-item.mdx b/fern/products/sdk-reference/typescript/relay/normalize/normalize-play-item.mdx new file mode 100644 index 0000000000..69fc3c4216 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/normalize/normalize-play-item.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/normalize/normalize-play-item" +title: "normalizePlayItem" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "relay.normalize.normalizePlayItem" + parent: "relay.normalize" + module: "relay.normalize" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/normalize.ts" +--- +# `normalizePlayItem` + +Normalize a single play item (tts/audio/silence/ringtone). + +## Signature + +```typescript +normalizePlayItem(item: Record): Record +``` + +## Parameters + + + +## Returns + +`Record` + +## Source + +[`src/relay/normalize.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/normalize.ts) + +Line 17. diff --git a/fern/products/sdk-reference/typescript/relay/normalize/normalize-play-items.mdx b/fern/products/sdk-reference/typescript/relay/normalize/normalize-play-items.mdx new file mode 100644 index 0000000000..f90a36f724 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/normalize/normalize-play-items.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/normalize/normalize-play-items" +title: "normalizePlayItems" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "relay.normalize.normalizePlayItems" + parent: "relay.normalize" + module: "relay.normalize" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/normalize.ts" +--- +# `normalizePlayItems` + +Normalize an array of play items. + +## Signature + +```typescript +normalizePlayItems(items: Record[]): Record[] +``` + +## Parameters + + + +## Returns + +`Record[]` + +## Source + +[`src/relay/normalize.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/normalize.ts) + +Line 26. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/index.mdx new file mode 100644 index 0000000000..6ee456375a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/relay/relay-client" +title: "RelayClient" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "relay.RelayClient" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `RelayClient` + +## Signature + +```typescript +module RelayClient +``` + +## Classes + + + + Real-time WebSocket client for SignalWire RELAY. + + + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/async-dispose.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/async-dispose.mdx new file mode 100644 index 0000000000..1be445270c --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/async-dispose.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/async-dispose" +title: "[asyncDispose]" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.[asyncDispose]" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `[asyncDispose]` + +Async disposable support — equivalent to Python's `__aexit__`. + +Enables usage with `await using`: + +```ts +await using client = new RelayClient({ ... }); +await client.connect(); +// ... automatically disconnects when scope exits +``` + +For environments without `await using`, use try/finally: + +```ts +const client = new RelayClient({ ... }); +try { await client.connect(); ... } +finally { await client.disconnect(); } +``` + +## Signature + +```typescript +[asyncDispose](): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 266. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/connect.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/connect.mdx new file mode 100644 index 0000000000..1c65e99062 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/connect.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/connect" +title: "connect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.connect" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `connect` + +Connect to RELAY and authenticate. + +Opens the WebSocket, runs the JSON-RPC `signalwire.connect` handshake, +and starts the client-side ping loop. Safe to call again after a +`disconnect()` to reconnect; the process-wide concurrent-connection limit +is enforced here. + +## Signature + +```typescript +connect(): Promise +``` + +## Returns + +`Promise` — Resolves once the client is connected and authenticated. + +## Throws + +- When the process-wide connection limit is reached, authentication fails, or the WebSocket cannot be opened. + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 340. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/constructor.mdx new file mode 100644 index 0000000000..d79ea3cf2e --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/constructor.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.constructor" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `constructor` + +Create a new RELAY client. +Credentials fall back to the `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_API_TOKEN`, +`SIGNALWIRE_JWT_TOKEN`, and `SIGNALWIRE_SPACE` env vars when omitted. + +## Signature + +```typescript +constructor(options: RelayClientOptions = {}): RelayClient +``` + +## Parameters + + + Optional client configuration. + + +## Returns + +`RelayClient` + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 196. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/dial.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/dial.mdx new file mode 100644 index 0000000000..76790110eb --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/dial.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/dial" +title: "dial" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.dial" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `dial` + +Initiate an outbound call. + +Accepts a "dial plan" — an outer array of serial groups, each containing +an inner array of devices dialled in parallel. Resolves when any device +answers; rejects if no device answers within `dialTimeout`. + +## Signature + +```typescript +dial( + devices: Record[][], + options: { ...3 fields } = {} +): Promise +``` + +## Parameters + + + Serial/parallel dial plan. `[[A], [B, C]]` dials A first, then B and C in parallel. + + + + Optional dial behaviour overrides. + + + Dial timeout in seconds (default 120). + + + + Maximum call duration in minutes. + + + + Client-provided tag for event correlation. Auto-generated (UUID) when omitted. + + + +## Returns + +`Promise` — A [Call](/reference/typescript/relay/call) representing the answered leg. + +## Throws + +- When the dial times out. +- When the server rejects the dial request. + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 586. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/disconnect.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/disconnect.mdx new file mode 100644 index 0000000000..51e0d209bf --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/disconnect.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/disconnect" +title: "disconnect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.disconnect" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `disconnect` + +Cleanly close the connection. + +Stops the ping loop, drops the WebSocket, rejects every pending request +and dial with a `Connection closed` [RelayError](/reference/typescript/relay/relay-error), and removes the +client from the process-wide active set. Safe to call repeatedly. + +## Signature + +```typescript +disconnect(): Promise +``` + +## Returns + +`Promise` — Resolves once all resources have been released. + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 488. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/execute.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/execute.mdx new file mode 100644 index 0000000000..eeb6d2f00a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/execute.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/execute" +title: "execute" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.execute" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `execute` + +Send a JSON-RPC request and await the response. + +This is the low-level escape hatch for calling RELAY methods that don't +yet have a higher-level helper on this class. Queued if the client is +currently disconnected; sent immediately otherwise. + +## Signature + +```typescript +execute( + method: string, + params: Record +): Promise> +``` + +## Parameters + + + Fully-qualified JSON-RPC method name (e.g. `"calling.play"`). + + + + Method-specific params object. + + +## Returns + +`Promise>` — The `result` field of the JSON-RPC response. + +## Throws + +- When the server returns a non-2xx code. + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 542. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/index.mdx new file mode 100644 index 0000000000..205f0b9400 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/index.mdx @@ -0,0 +1,165 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client" +title: "RelayClient" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient" + parent: "relay.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `RelayClient` + +Real-time WebSocket client for SignalWire RELAY. + +One instance = one persistent JSON-RPC 2.0 WebSocket connection. Lets you +place / receive calls and SMS, play/record media, run TTS, conference calls +together, and subscribe to platform events — all without HTTP polling. + +Authentication supports either a project/token pair or a JWT. + +## Signature + +```typescript +class RelayClient +``` + +## Examples + + + + ```typescript + import { RelayClient } from '@signalwire/sdk'; + + const client = new RelayClient({ + project: process.env.SIGNALWIRE_PROJECT_ID!, + token: process.env.SIGNALWIRE_API_TOKEN!, + host: 'example.signalwire.com', + contexts: ['office'], + }); + + client.onCall(async (call) => { + await call.answer(); + await call.playTTS({ text: 'Thanks for calling!' }); + await call.hangup(); + }); + + await client.connect(); + ``` + + + + ```typescript + await client.connect(); + const call = await client.dial({ + devices: [[{ type: 'phone', to: '+15551234567', from: '+15557654321' }]], + }); + await client.sendMessage({ to: '+15551234567', from: '+15557654321', body: 'Hi!' }); + ``` + + + +## See Also + +- \- \[Call]\(/reference/typescript/relay/call) + \- \[Message]\(/reference/typescript/relay/message) + +## Properties + + + Contexts this client subscribes to for inbound events. + + + + Hostname of the RELAY endpoint (e.g. `example.signalwire.com`). + + + + JWT used instead of project/token if provided. + + + + Project ID used for Basic Auth. + + + + The protocol name the server assigned to this client after `connect()`. + + + + WebSocket scheme — `'wss'` (production) or `'ws'` (loopback audits). See [RelayClientOptions.scheme](/reference/typescript/relay/types/relay-client-options#scheme) for the full rationale. + + + + API token used for Basic Auth. + + +## Methods + + + + Async disposable support — equivalent to Python's `__aexit__`. + + + + Connect to RELAY and authenticate. + + + + Create a new RELAY client. Credentials fall back to the `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_API_TOKEN`, `SIGNALWIRE_JWT_TOKEN`, and `SIGNALWIRE_SPACE` env vars when omitted. + + + + Initiate an outbound call. + + + + Cleanly close the connection. + + + + Send a JSON-RPC request and await the response. + + + + Fire-and-forget JSON-RPC notification (no response awaited). + + + + Register the inbound call handler. + + + + Register a low-level observer that fires for every inbound `signalwire.event`, regardless of event type or whether a typed Call / Message could be matched. + + + + Register the inbound message handler. + + + + Subscribe to additional RELAY contexts on an already-connected client. + + + + Blocking entry point — connects and maintains the connection with auto-reconnect, returning only after a clean shutdown (Ctrl+C, SIGTERM, or [disconnect](/reference/typescript/relay/relay-client/relay-client/disconnect) from another scope). + + + + Send an outbound SMS / MMS message. + + + + Unsubscribe from contexts previously passed to [receive](/reference/typescript/relay/relay-client/relay-client/receive) (or the constructor). A no-op when `contexts` is empty. + + + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 129. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/notify.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/notify.mdx new file mode 100644 index 0000000000..e24e15a7b3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/notify.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/notify" +title: "notify" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.notify" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `notify` + +Fire-and-forget JSON-RPC notification (no response awaited). + +Sends a JSON-RPC frame on the open socket without registering a +pending-response future. Used by the audit harness to emit a +`signalwire.event`-method frame the fixture watches for; production +users should always use [execute](/reference/typescript/relay/relay-client/relay-client/execute) instead so the response code +is checked. + +No-ops when the socket is closed. + +## Signature + +```typescript +notify(method: string, params: Record): void +``` + +## Parameters + + + JSON-RPC method name. + + + + Method params object. + + +## Returns + +`void` + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 560. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/on-call.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/on-call.mdx new file mode 100644 index 0000000000..c3c16797a4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/on-call.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/on-call" +title: "onCall" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.onCall" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `onCall` + +Register the inbound call handler. + +The handler is invoked once per inbound call, with a fully-formed +[Call](/reference/typescript/relay/call) already in state `"created"`. Answer, reject, or forward +the call from inside the handler. + +## Signature + +```typescript +onCall(handler: CallHandler): CallHandler +``` + +## Parameters + + + Callback invoked for each inbound call. May return a promise; errors are logged but do not tear down the client. + + +## Returns + +`CallHandler` — The same handler, to support decorator-style usage. + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 283. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/on-event.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/on-event.mdx new file mode 100644 index 0000000000..da06e54cf8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/on-event.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/on-event" +title: "onEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.onEvent" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `onEvent` + +Register a low-level observer that fires for every inbound +`signalwire.event`, regardless of event type or whether a typed +Call / Message could be matched. + +Most users want [onCall](/reference/typescript/relay/relay-client/relay-client/on-call) / [onMessage](/reference/typescript/relay/relay-client/relay-client/on-message) — those deliver +typed objects and handle correlation. `onEvent` is the generic +escape hatch used by the porting-sdk audit harness to react to +every event the platform pushes. + +Fires BEFORE typed routing, so the same event will be observed here +AND on any matching [Call](/reference/typescript/relay/call) / [Message](/reference/typescript/relay/message). + +## Signature + +```typescript +onEvent( + handler: (eventType: string, params: Record) => void | Promise +): (eventType: string, params: Record) => void | Promise +``` + +## Parameters + + + Callback receiving `(eventType, params)`. May be async. + + +## Returns + +`(eventType: string, params: Record) => void | Promise` — The same handler, for decorator-style usage. + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 319. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/on-message.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/on-message.mdx new file mode 100644 index 0000000000..7142e70f4e --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/on-message.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/on-message" +title: "onMessage" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.onMessage" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `onMessage` + +Register the inbound message handler. + +The handler is invoked once per inbound SMS/MMS delivered to a subscribed +context, with a [Message](/reference/typescript/relay/message) already in state `"received"`. + +## Signature + +```typescript +onMessage(handler: MessageHandler): MessageHandler +``` + +## Parameters + + + Callback invoked for each inbound message. May return a promise; errors are logged but do not tear down the client. + + +## Returns + +`MessageHandler` — The same handler, to support decorator-style usage. + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 298. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/receive.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/receive.mdx new file mode 100644 index 0000000000..64da7ef9da --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/receive.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/receive" +title: "receive" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.receive" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `receive` + +Subscribe to additional RELAY contexts on an already-connected client. + +Inbound calls and messages on any of the listed contexts will be delivered +to the `onCall` / `onMessage` handlers. A no-op when `contexts` is empty. + +## Signature + +```typescript +receive(contexts: string[]): Promise +``` + +## Parameters + + + Context names to subscribe to. + + +## Returns + +`Promise` — Resolves once the server has confirmed the subscription. + +## Throws + +- When the server rejects the subscribe request. + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 714. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/run.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/run.mdx new file mode 100644 index 0000000000..91d9dad226 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/run.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/run" +title: "run" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.run" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `run` + +Blocking entry point — connects and maintains the connection with +auto-reconnect, returning only after a clean shutdown (Ctrl+C, SIGTERM, +or [disconnect](/reference/typescript/relay/relay-client/relay-client/disconnect) from another scope). + +Installs `SIGINT` / `SIGTERM` handlers, so typically only one `RelayClient` +per process should call `run()`. + +## Signature + +```typescript +run(): Promise +``` + +## Returns + +`Promise` — Resolves once a shutdown has been requested and cleanup completes. + +## Throws + +- Only on unrecoverable startup failures — normal disconnects are handled internally by the reconnect loop. + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 748. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/send-message.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/send-message.mdx new file mode 100644 index 0000000000..bc5593a17c --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/send-message.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/send-message" +title: "sendMessage" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.sendMessage" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `sendMessage` + +Send an outbound SMS / MMS message. + +The method returns as soon as the server has accepted the send; track the +message's terminal state with [Message.wait](/reference/typescript/relay/message/message/wait) or the `onCompleted` +callback. + +## Signature + +```typescript +sendMessage(options: { ...8 fields }): Promise +``` + +## Parameters + + + Send parameters. + + + Text body of the message. + + + + Context for receiving state events. Defaults to the negotiated relay protocol. + + + + Sender phone number in E.164 format. + + + + List of media URLs for MMS. + + + + Optional callback fired when the message reaches a terminal state (delivered / failed / undelivered). + + + + Origination region override. + + + + Tags attached to the message for correlation. + + + + Destination phone number in E.164 format. + + + +## Returns + +`Promise` — A [Message](/reference/typescript/relay/message) tracking the outbound send. + +## Throws + +- When the server rejects the send request. + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 655. diff --git a/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/unreceive.mdx b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/unreceive.mdx new file mode 100644 index 0000000000..d521100d5f --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-client/relay-client/unreceive.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/relay/relay-client/relay-client/unreceive" +title: "unreceive" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayClient.RelayClient.unreceive" + parent: "relay.RelayClient.RelayClient" + module: "relay.RelayClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts" +--- +# `unreceive` + +Unsubscribe from contexts previously passed to [receive](/reference/typescript/relay/relay-client/relay-client/receive) (or the +constructor). A no-op when `contexts` is empty. + +## Signature + +```typescript +unreceive(contexts: string[]): Promise +``` + +## Parameters + + + Context names to unsubscribe from. + + +## Returns + +`Promise` — Resolves once the server has confirmed the unsubscribe. + +## Throws + +- When the server rejects the unsubscribe request. + +## Source + +[`src/relay/RelayClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayClient.ts) + +Line 728. diff --git a/fern/products/sdk-reference/typescript/relay/relay-error/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-error/index.mdx new file mode 100644 index 0000000000..ebd8d46b81 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-error/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/relay/relay-error" +title: "RelayError" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "relay.RelayError" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayError.ts" +--- +# `RelayError` + +## Signature + +```typescript +module RelayError +``` + +## Classes + + + + Custom error class for RELAY protocol errors. + + + +## Source + +[`src/relay/RelayError.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayError.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/relay/relay-error/relay-error/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-error/relay-error/constructor.mdx new file mode 100644 index 0000000000..61f6fecff0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-error/relay-error/constructor.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/relay/relay-error/relay-error/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayError.RelayError.constructor" + parent: "relay.RelayError.RelayError" + module: "relay.RelayError" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayError.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(code: number, message: string): RelayError +``` + +## Parameters + + + Numeric RELAY result code (e.g. `404`, `503`). + + + + Human-readable error message from the server. + + +## Returns + +`RelayError` + +## Source + +[`src/relay/RelayError.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayError.ts) + +Line 15. diff --git a/fern/products/sdk-reference/typescript/relay/relay-error/relay-error/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-error/relay-error/index.mdx new file mode 100644 index 0000000000..67b817c9d3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-error/relay-error/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/relay/relay-error/relay-error" +title: "RelayError" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayError.RelayError" + parent: "relay.RelayError" + module: "relay.RelayError" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayError.ts" +--- +# `RelayError` + +Custom error class for RELAY protocol errors. + +Thrown when the server returns a non-2xx JSON-RPC result code. Mirrors the +Python SDK signature: `RelayError(code, message)`. + +## Signature + +```typescript +class RelayError extends Error +``` + +## Inheritance + +**Extends:** `Error` + +## Properties + + + Numeric RELAY result code returned by the server. + + +## Methods + + + + + +## Source + +[`src/relay/RelayError.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayError.ts) + +Line 7. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/call-receive-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/call-receive-event/constructor.mdx new file mode 100644 index 0000000000..4a58a882e9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/call-receive-event/constructor.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/typescript/relay/relay-event/call-receive-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.CallReceiveEvent.constructor" + parent: "relay.RelayEvent.CallReceiveEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + callState: string, + direction: string, + device: Record, + nodeId: string, + projectId: string, + context: string, + segmentId: string, + tag: string +): CallReceiveEvent +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`CallReceiveEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 128. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/call-receive-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/call-receive-event/from-payload.mdx new file mode 100644 index 0000000000..3d7b052bf3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/call-receive-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/call-receive-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.CallReceiveEvent.fromPayload" + parent: "relay.RelayEvent.CallReceiveEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): CallReceiveEvent +``` + +## Parameters + + + +## Returns + +`CallReceiveEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 153. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/call-receive-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/call-receive-event/index.mdx new file mode 100644 index 0000000000..823881af5a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/call-receive-event/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/relay/relay-event/call-receive-event" +title: "CallReceiveEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.CallReceiveEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `CallReceiveEvent` + +`calling.call.receive` — fires when an inbound call arrives on a subscribed context. + +## Signature + +```typescript +class CallReceiveEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + + + Raw params dict from the RELAY notification. + + + + + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 118. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/call-state-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/call-state-event/constructor.mdx new file mode 100644 index 0000000000..f0e93f96a9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/call-state-event/constructor.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/relay/relay-event/call-state-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.CallStateEvent.constructor" + parent: "relay.RelayEvent.CallStateEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + callState: string, + endReason: string, + direction: string, + device: Record +): CallStateEvent +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`CallStateEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 88. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/call-state-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/call-state-event/from-payload.mdx new file mode 100644 index 0000000000..11477fa3b8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/call-state-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/call-state-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.CallStateEvent.fromPayload" + parent: "relay.RelayEvent.CallStateEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): CallStateEvent +``` + +## Parameters + + + +## Returns + +`CallStateEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 105. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/call-state-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/call-state-event/index.mdx new file mode 100644 index 0000000000..1f64043527 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/call-state-event/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/relay-event/call-state-event" +title: "CallStateEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.CallStateEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `CallStateEvent` + +`calling.call.state` — fires on every lifecycle transition (created, ringing, answered, ending, ended). + +## Signature + +```typescript +class CallStateEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 82. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/calling-error-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/calling-error-event/constructor.mdx new file mode 100644 index 0000000000..df3c12f006 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/calling-error-event/constructor.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/relay/relay-event/calling-error-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.CallingErrorEvent.constructor" + parent: "relay.RelayEvent.CallingErrorEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + code: string, + message: string +): CallingErrorEvent +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`CallingErrorEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 755. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/calling-error-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/calling-error-event/from-payload.mdx new file mode 100644 index 0000000000..c3659d6220 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/calling-error-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/calling-error-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.CallingErrorEvent.fromPayload" + parent: "relay.RelayEvent.CallingErrorEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): CallingErrorEvent +``` + +## Parameters + + + +## Returns + +`CallingErrorEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 768. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/calling-error-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/calling-error-event/index.mdx new file mode 100644 index 0000000000..15395194e2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/calling-error-event/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/relay/relay-event/calling-error-event" +title: "CallingErrorEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.CallingErrorEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `CallingErrorEvent` + +`calling.error` — platform-emitted error against the calling namespace. + +## Signature + +```typescript +class CallingErrorEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + + + Raw params dict from the RELAY notification. + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 751. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/collect-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/collect-event/constructor.mdx new file mode 100644 index 0000000000..dfaf9fcdc8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/collect-event/constructor.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/relay/relay-event/collect-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.CollectEvent.constructor" + parent: "relay.RelayEvent.CollectEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + controlId: string = '', + state: string = '', + result: Record = {}, + final_: boolean | undefined = undefined +): CollectEvent +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`CollectEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 249. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/collect-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/collect-event/from-payload.mdx new file mode 100644 index 0000000000..7249e3091d --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/collect-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/collect-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.CollectEvent.fromPayload" + parent: "relay.RelayEvent.CollectEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): CollectEvent +``` + +## Parameters + + + +## Returns + +`CollectEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 266. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/collect-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/collect-event/index.mdx new file mode 100644 index 0000000000..ce19fb6369 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/collect-event/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/relay-event/collect-event" +title: "CollectEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.CollectEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `CollectEvent` + +`calling.call.collect` — caller input (DTMF or speech) collected by a collect action. + +## Signature + +```typescript +class CollectEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + + + Raw params dict from the RELAY notification. + + + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 243. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/conference-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/conference-event/constructor.mdx new file mode 100644 index 0000000000..efcdf40a77 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/conference-event/constructor.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/relay/relay-event/conference-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.ConferenceEvent.constructor" + parent: "relay.RelayEvent.ConferenceEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + conferenceId: string, + name: string, + status: string +): ConferenceEvent +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`ConferenceEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 724. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/conference-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/conference-event/from-payload.mdx new file mode 100644 index 0000000000..06aea872a4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/conference-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/conference-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.ConferenceEvent.fromPayload" + parent: "relay.RelayEvent.ConferenceEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): ConferenceEvent +``` + +## Parameters + + + +## Returns + +`ConferenceEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 739. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/conference-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/conference-event/index.mdx new file mode 100644 index 0000000000..2199374936 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/conference-event/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/relay/relay-event/conference-event" +title: "ConferenceEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.ConferenceEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `ConferenceEvent` + +`calling.conference` — conference lifecycle change (created, active, ended). + +## Signature + +```typescript +class ConferenceEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + + + Raw params dict from the RELAY notification. + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 719. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/connect-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/connect-event/constructor.mdx new file mode 100644 index 0000000000..c96e59bf9a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/connect-event/constructor.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/relay/relay-event/connect-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.ConnectEvent.constructor" + parent: "relay.RelayEvent.ConnectEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + connectState: string, + peer: Record +): ConnectEvent +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`ConnectEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 283. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/connect-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/connect-event/from-payload.mdx new file mode 100644 index 0000000000..6440205d3a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/connect-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/connect-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.ConnectEvent.fromPayload" + parent: "relay.RelayEvent.ConnectEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): ConnectEvent +``` + +## Parameters + + + +## Returns + +`ConnectEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 296. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/connect-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/connect-event/index.mdx new file mode 100644 index 0000000000..56239ebd78 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/connect-event/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/relay/relay-event/connect-event" +title: "ConnectEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.ConnectEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `ConnectEvent` + +`calling.call.connect` — state transition when one call connects to another (dialplan/bridge). + +## Signature + +```typescript +class ConnectEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 279. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/denoise-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/denoise-event/constructor.mdx new file mode 100644 index 0000000000..ebe3881876 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/denoise-event/constructor.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/relay/relay-event/denoise-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.DenoiseEvent.constructor" + parent: "relay.RelayEvent.DenoiseEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + denoised: boolean +): DenoiseEvent +``` + +## Parameters + + + + + + + + + + + +## Returns + +`DenoiseEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/denoise-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/denoise-event/from-payload.mdx new file mode 100644 index 0000000000..f0ca386a17 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/denoise-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/denoise-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.DenoiseEvent.fromPayload" + parent: "relay.RelayEvent.DenoiseEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): DenoiseEvent +``` + +## Parameters + + + +## Returns + +`DenoiseEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 545. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/denoise-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/denoise-event/index.mdx new file mode 100644 index 0000000000..a95e41d227 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/denoise-event/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/relay/relay-event/denoise-event" +title: "DenoiseEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.DenoiseEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `DenoiseEvent` + +`calling.call.denoise` — noise-reduction on/off confirmation. + +## Signature + +```typescript +class DenoiseEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 531. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/detect-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/detect-event/constructor.mdx new file mode 100644 index 0000000000..d0e76ae381 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/detect-event/constructor.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/relay/relay-event/detect-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.DetectEvent.constructor" + parent: "relay.RelayEvent.DetectEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + controlId: string, + detect: Record +): DetectEvent +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`DetectEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 311. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/detect-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/detect-event/from-payload.mdx new file mode 100644 index 0000000000..9847ee4246 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/detect-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/detect-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.DetectEvent.fromPayload" + parent: "relay.RelayEvent.DetectEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): DetectEvent +``` + +## Parameters + + + +## Returns + +`DetectEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 324. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/detect-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/detect-event/index.mdx new file mode 100644 index 0000000000..2a2b7b12c7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/detect-event/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/relay/relay-event/detect-event" +title: "DetectEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.DetectEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `DetectEvent` + +`calling.call.detect` — answering-machine / fax / DTMF detection result. + +## Signature + +```typescript +class DetectEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 307. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/dial-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/dial-event/constructor.mdx new file mode 100644 index 0000000000..f5cb3d7034 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/dial-event/constructor.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/relay/relay-event/dial-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.DialEvent.constructor" + parent: "relay.RelayEvent.DialEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + tag: string, + dialState: string, + call: Record +): DialEvent +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`DialEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 468. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/dial-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/dial-event/from-payload.mdx new file mode 100644 index 0000000000..b62675f41c --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/dial-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/dial-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.DialEvent.fromPayload" + parent: "relay.RelayEvent.DialEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): DialEvent +``` + +## Parameters + + + +## Returns + +`DialEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 483. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/dial-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/dial-event/index.mdx new file mode 100644 index 0000000000..8de9ce0479 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/dial-event/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/relay/relay-event/dial-event" +title: "DialEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.DialEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `DialEvent` + +`calling.call.dial` — outbound dial progress (answered, failed, no-answer, etc.). + +## Signature + +```typescript +class DialEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 463. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/echo-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/echo-event/constructor.mdx new file mode 100644 index 0000000000..52ffbd7f23 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/echo-event/constructor.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/relay/relay-event/echo-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.EchoEvent.constructor" + parent: "relay.RelayEvent.EchoEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + state: string +): EchoEvent +``` + +## Parameters + + + + + + + + + + + +## Returns + +`EchoEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 630. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/echo-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/echo-event/from-payload.mdx new file mode 100644 index 0000000000..25fedea8e8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/echo-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/echo-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.EchoEvent.fromPayload" + parent: "relay.RelayEvent.EchoEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): EchoEvent +``` + +## Parameters + + + +## Returns + +`EchoEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 641. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/echo-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/echo-event/index.mdx new file mode 100644 index 0000000000..04a0dd0dc1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/echo-event/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/relay/relay-event/echo-event" +title: "EchoEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.EchoEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `EchoEvent` + +`calling.call.echo` — test/diagnostic echo reflection from the server. + +## Signature + +```typescript +class EchoEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 627. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/event-class.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/event-class.mdx new file mode 100644 index 0000000000..72153449a3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/event-class.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/relay/relay-event/event-class" +title: "EventClass" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "relay.RelayEvent.EventClass" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `EventClass` + +Structural type for an event class that exposes a `fromPayload` factory. + +## Signature + +```typescript +type EventClass = unknown +``` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 907. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/fax-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/fax-event/constructor.mdx new file mode 100644 index 0000000000..cea5da87bd --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/fax-event/constructor.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/relay/relay-event/fax-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.FaxEvent.constructor" + parent: "relay.RelayEvent.FaxEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + controlId: string, + fax: Record +): FaxEvent +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`FaxEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 339. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/fax-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/fax-event/from-payload.mdx new file mode 100644 index 0000000000..caea12867f --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/fax-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/fax-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.FaxEvent.fromPayload" + parent: "relay.RelayEvent.FaxEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): FaxEvent +``` + +## Parameters + + + +## Returns + +`FaxEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 352. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/fax-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/fax-event/index.mdx new file mode 100644 index 0000000000..5035ce522b --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/fax-event/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/relay/relay-event/fax-event" +title: "FaxEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.FaxEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `FaxEvent` + +`calling.call.fax` — fax send/receive progress update. + +## Signature + +```typescript +class FaxEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + + + Raw params dict from the RELAY notification. + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 335. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/from-payload.mdx new file mode 100644 index 0000000000..da9f336d90 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/from-payload.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/relay/relay-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.EventClass.fromPayload" + parent: "relay.RelayEvent.EventClass" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +## Signature + +```typescript +fromPayload(payload: Record): RelayEvent +``` + +## Parameters + + + +## Returns + +`RelayEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 907. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/hold-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/hold-event/constructor.mdx new file mode 100644 index 0000000000..e20d1a8652 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/hold-event/constructor.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/relay/relay-event/hold-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.HoldEvent.constructor" + parent: "relay.RelayEvent.HoldEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + state: string +): HoldEvent +``` + +## Parameters + + + + + + + + + + + +## Returns + +`HoldEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 698. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/hold-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/hold-event/from-payload.mdx new file mode 100644 index 0000000000..4893e1849d --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/hold-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/hold-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.HoldEvent.fromPayload" + parent: "relay.RelayEvent.HoldEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): HoldEvent +``` + +## Parameters + + + +## Returns + +`HoldEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 709. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/hold-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/hold-event/index.mdx new file mode 100644 index 0000000000..12466c4268 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/hold-event/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/relay/relay-event/hold-event" +title: "HoldEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.HoldEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `HoldEvent` + +`calling.call.hold` — hold/unhold state change on the call. + +## Signature + +```typescript +class HoldEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 695. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/index.mdx new file mode 100644 index 0000000000..84b2ef000d --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/index.mdx @@ -0,0 +1,148 @@ +--- +slug: "/reference/typescript/relay/relay-event" +title: "RelayEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "relay.RelayEvent" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `RelayEvent` + +## Signature + +```typescript +module RelayEvent +``` + +## Constants + + + Maps RELAY `event_type` strings to the typed event subclass that builds its wrapper. Used by [parseEvent](/reference/typescript/relay/relay-event/parse-event) to dispatch raw payloads. + + +## Functions + + + + Parse a raw signalwire.event params dict into a typed event object. + + + +## Type Aliases + + + + Structural type for an event class that exposes a `fromPayload` factory. + + + +## Classes + + + + `calling.error` — platform-emitted error against the calling namespace. + + + + `calling.call.receive` — fires when an inbound call arrives on a subscribed context. + + + + `calling.call.state` — fires on every lifecycle transition (created, ringing, answered, ending, ended). + + + + `calling.call.collect` — caller input (DTMF or speech) collected by a collect action. + + + + `calling.conference` — conference lifecycle change (created, active, ended). + + + + `calling.call.connect` — state transition when one call connects to another (dialplan/bridge). + + + + `calling.call.denoise` — noise-reduction on/off confirmation. + + + + `calling.call.detect` — answering-machine / fax / DTMF detection result. + + + + `calling.call.dial` — outbound dial progress (answered, failed, no-answer, etc.). + + + + `calling.call.echo` — test/diagnostic echo reflection from the server. + + + + `calling.call.fax` — fax send/receive progress update. + + + + `calling.call.hold` — hold/unhold state change on the call. + + + + `messaging.receive` — inbound SMS/MMS received on a subscribed context. + + + + `messaging.state` — state change for an outbound message (queued → sent → delivered/failed). + + + + `calling.call.pay` — PCI-compliant payment collection progress update. + + + + `calling.call.play` — play-media action state change (`playing`, `paused`, `finished`, `error`). + + + + `calling.call.queue` — call-queue position update (queued, waiting, member answered, timed out). + + + + `calling.call.record` — recording state change with final URL, duration, and size when finished. + + + + `calling.call.refer` — SIP REFER result (off-platform transfer response codes). + + + + Base class for all typed RELAY events. + + + + `calling.call.send_digits` — progress update for DTMF digits sent out on a call. + + + + `calling.call.stream` — outbound media stream state change (e.g. RTMP/WebSocket streaming). + + + + `calling.call.tap` — media tap state change (audio mirror to an external endpoint). + + + + `calling.call.transcribe` — transcription state change and final URL/duration when finished. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/message-receive-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/message-receive-event/constructor.mdx new file mode 100644 index 0000000000..138dc27d26 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/message-receive-event/constructor.mdx @@ -0,0 +1,76 @@ +--- +slug: "/reference/typescript/relay/relay-event/message-receive-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.MessageReceiveEvent.constructor" + parent: "relay.RelayEvent.MessageReceiveEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + messageId: string, + context: string, + direction: string, + fromNumber: string, + toNumber: string, + body: string, + media: string[], + segments: number, + messageState: string, + tags: string[] +): MessageReceiveEvent +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`MessageReceiveEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 793. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/message-receive-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/message-receive-event/from-payload.mdx new file mode 100644 index 0000000000..f07b4b866a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/message-receive-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/message-receive-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.MessageReceiveEvent.fromPayload" + parent: "relay.RelayEvent.MessageReceiveEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): MessageReceiveEvent +``` + +## Parameters + + + +## Returns + +`MessageReceiveEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 822. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/message-receive-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/message-receive-event/index.mdx new file mode 100644 index 0000000000..94aeada0f5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/message-receive-event/index.mdx @@ -0,0 +1,81 @@ +--- +slug: "/reference/typescript/relay/relay-event/message-receive-event" +title: "MessageReceiveEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.MessageReceiveEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `MessageReceiveEvent` + +`messaging.receive` — inbound SMS/MMS received on a subscribed context. + +## Signature + +```typescript +class MessageReceiveEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + + + Call ID associated with the event, or `""` for non-call events. + + + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + + + + + + + + + Raw params dict from the RELAY notification. + + + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 781. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/message-state-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/message-state-event/constructor.mdx new file mode 100644 index 0000000000..c4016268b0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/message-state-event/constructor.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/typescript/relay/relay-event/message-state-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.MessageStateEvent.constructor" + parent: "relay.RelayEvent.MessageStateEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + messageId: string, + context: string, + direction: string, + fromNumber: string, + toNumber: string, + body: string, + media: string[], + segments: number, + messageState: string, + reason: string, + tags: string[] +): MessageStateEvent +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`MessageStateEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 854. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/message-state-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/message-state-event/from-payload.mdx new file mode 100644 index 0000000000..26a20cc731 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/message-state-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/message-state-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.MessageStateEvent.fromPayload" + parent: "relay.RelayEvent.MessageStateEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): MessageStateEvent +``` + +## Parameters + + + +## Returns + +`MessageStateEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 885. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/message-state-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/message-state-event/index.mdx new file mode 100644 index 0000000000..bc8f341a0f --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/message-state-event/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/typescript/relay/relay-event/message-state-event" +title: "MessageStateEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.MessageStateEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `MessageStateEvent` + +`messaging.state` — state change for an outbound message (queued → sent → delivered/failed). + +## Signature + +```typescript +class MessageStateEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + + + Call ID associated with the event, or `""` for non-call events. + + + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + + + + + + + + + Raw params dict from the RELAY notification. + + + + + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 841. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/parse-event.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/parse-event.mdx new file mode 100644 index 0000000000..bffbe64e01 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/parse-event.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/relay-event/parse-event" +title: "parseEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "relay.RelayEvent.parseEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `parseEvent` + +Parse a raw signalwire.event params dict into a typed event object. + +## Signature + +```typescript +parseEvent(payload: Record): RelayEvent +``` + +## Parameters + + + +## Returns + +`RelayEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 940. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/pay-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/pay-event/constructor.mdx new file mode 100644 index 0000000000..9d4163d033 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/pay-event/constructor.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/relay/relay-event/pay-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.PayEvent.constructor" + parent: "relay.RelayEvent.PayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + controlId: string, + state: string +): PayEvent +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`PayEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 559. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/pay-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/pay-event/from-payload.mdx new file mode 100644 index 0000000000..9d86eaf626 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/pay-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/pay-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.PayEvent.fromPayload" + parent: "relay.RelayEvent.PayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): PayEvent +``` + +## Parameters + + + +## Returns + +`PayEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 572. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/pay-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/pay-event/index.mdx new file mode 100644 index 0000000000..f6dfcea3d2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/pay-event/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/relay/relay-event/pay-event" +title: "PayEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.PayEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `PayEvent` + +`calling.call.pay` — PCI-compliant payment collection progress update. + +## Signature + +```typescript +class PayEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 555. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/play-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/play-event/constructor.mdx new file mode 100644 index 0000000000..d65cb8e9a6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/play-event/constructor.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/relay/relay-event/play-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.PlayEvent.constructor" + parent: "relay.RelayEvent.PlayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + controlId: string, + state: string +): PlayEvent +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`PlayEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 174. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/play-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/play-event/from-payload.mdx new file mode 100644 index 0000000000..5c623c8f77 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/play-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/play-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.PlayEvent.fromPayload" + parent: "relay.RelayEvent.PlayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): PlayEvent +``` + +## Parameters + + + +## Returns + +`PlayEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 187. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/play-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/play-event/index.mdx new file mode 100644 index 0000000000..581a974b31 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/play-event/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/relay/relay-event/play-event" +title: "PlayEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.PlayEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `PlayEvent` + +`calling.call.play` — play-media action state change (`playing`, `paused`, `finished`, `error`). + +## Signature + +```typescript +class PlayEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 170. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/queue-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/queue-event/constructor.mdx new file mode 100644 index 0000000000..71a40cea32 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/queue-event/constructor.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/typescript/relay/relay-event/queue-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.QueueEvent.constructor" + parent: "relay.RelayEvent.QueueEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + controlId: string, + status: string, + queueId: string, + queueName: string, + position: number, + size: number +): QueueEvent +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + +## Returns + +`QueueEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 591. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/queue-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/queue-event/from-payload.mdx new file mode 100644 index 0000000000..b551b7c4b3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/queue-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/queue-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.QueueEvent.fromPayload" + parent: "relay.RelayEvent.QueueEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): QueueEvent +``` + +## Parameters + + + +## Returns + +`QueueEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 612. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/queue-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/queue-event/index.mdx new file mode 100644 index 0000000000..92c2925939 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/queue-event/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/typescript/relay/relay-event/queue-event" +title: "QueueEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.QueueEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `QueueEvent` + +`calling.call.queue` — call-queue position update (queued, waiting, member answered, timed out). + +## Signature + +```typescript +class QueueEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + + + + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 583. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/record-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/record-event/constructor.mdx new file mode 100644 index 0000000000..b273f39b69 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/record-event/constructor.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/typescript/relay/relay-event/record-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.RecordEvent.constructor" + parent: "relay.RelayEvent.RecordEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + controlId: string, + state: string, + url: string, + duration: number, + size: number, + record: Record +): RecordEvent +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + +## Returns + +`RecordEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 206. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/record-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/record-event/from-payload.mdx new file mode 100644 index 0000000000..5179d660ee --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/record-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/record-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.RecordEvent.fromPayload" + parent: "relay.RelayEvent.RecordEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): RecordEvent +``` + +## Parameters + + + +## Returns + +`RecordEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 227. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/record-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/record-event/index.mdx new file mode 100644 index 0000000000..5b3773999e --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/record-event/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/typescript/relay/relay-event/record-event" +title: "RecordEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.RecordEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `RecordEvent` + +`calling.call.record` — recording state change with final URL, duration, and size when finished. + +## Signature + +```typescript +class RecordEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 198. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/refer-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/refer-event/constructor.mdx new file mode 100644 index 0000000000..0e053d9c92 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/refer-event/constructor.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/relay/relay-event/refer-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.ReferEvent.constructor" + parent: "relay.RelayEvent.ReferEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + state: string, + sipReferTo: string, + sipReferResponseCode: string, + sipNotifyResponseCode: string +): ReferEvent +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`ReferEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 501. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/refer-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/refer-event/from-payload.mdx new file mode 100644 index 0000000000..b064296153 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/refer-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/refer-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.ReferEvent.fromPayload" + parent: "relay.RelayEvent.ReferEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): ReferEvent +``` + +## Parameters + + + +## Returns + +`ReferEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 518. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/refer-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/refer-event/index.mdx new file mode 100644 index 0000000000..6002e97191 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/refer-event/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/relay-event/refer-event" +title: "ReferEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.ReferEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `ReferEvent` + +`calling.call.refer` — SIP REFER result (off-platform transfer response codes). + +## Signature + +```typescript +class ReferEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 495. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/relay-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/relay-event/constructor.mdx new file mode 100644 index 0000000000..9906d39e5c --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/relay-event/constructor.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/relay/relay-event/relay-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.RelayEvent.constructor" + parent: "relay.RelayEvent.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string = '', + timestamp: number = 0 +): RelayEvent +``` + +## Parameters + + + Fully-qualified event type. + + + + Raw event params dict. + + + + Call ID (if applicable). + + + + Server-side event timestamp. + + +## Returns + +`RelayEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 36. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/relay-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/relay-event/from-payload.mdx new file mode 100644 index 0000000000..ed42568c98 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/relay-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/relay-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.RelayEvent.fromPayload" + parent: "relay.RelayEvent.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): RelayEvent +``` + +## Parameters + + + +## Returns + +`RelayEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 54. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/relay-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/relay-event/index.mdx new file mode 100644 index 0000000000..b959eca966 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/relay-event/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/relay/relay-event/relay-event" +title: "RelayEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.RelayEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `RelayEvent` + +Base class for all typed RELAY events. + +Raw events arrive as `signalwire.event` JSON-RPC notifications; the client +looks up the correct subclass in [EVENT\_CLASS\_MAP](/reference/typescript/relay/relay-event#event-class-map) and invokes +[RelayEvent.fromPayload](/reference/typescript/relay/relay-event/relay-event/from-payload) to build a typed wrapper. Handlers receive +this wrapper; they can always read the original dict from `params`. + +## Signature + +```typescript +class RelayEvent +``` + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 20. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/send-digits-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/send-digits-event/constructor.mdx new file mode 100644 index 0000000000..31db35fdda --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/send-digits-event/constructor.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/relay/relay-event/send-digits-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.SendDigitsEvent.constructor" + parent: "relay.RelayEvent.SendDigitsEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + controlId: string, + state: string +): SendDigitsEvent +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`SendDigitsEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 439. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/send-digits-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/send-digits-event/from-payload.mdx new file mode 100644 index 0000000000..2a0702c1f9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/send-digits-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/send-digits-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.SendDigitsEvent.fromPayload" + parent: "relay.RelayEvent.SendDigitsEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): SendDigitsEvent +``` + +## Parameters + + + +## Returns + +`SendDigitsEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 452. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/send-digits-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/send-digits-event/index.mdx new file mode 100644 index 0000000000..af40d6ba1a --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/send-digits-event/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/relay/relay-event/send-digits-event" +title: "SendDigitsEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.SendDigitsEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `SendDigitsEvent` + +`calling.call.send_digits` — progress update for DTMF digits sent out on a call. + +## Signature + +```typescript +class SendDigitsEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 435. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/stream-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/stream-event/constructor.mdx new file mode 100644 index 0000000000..8c7e008d69 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/stream-event/constructor.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/relay/relay-event/stream-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.StreamEvent.constructor" + parent: "relay.RelayEvent.StreamEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + controlId: string, + state: string, + url: string, + name: string +): StreamEvent +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`StreamEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 405. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/stream-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/stream-event/from-payload.mdx new file mode 100644 index 0000000000..1e563a549e --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/stream-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/stream-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.StreamEvent.fromPayload" + parent: "relay.RelayEvent.StreamEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): StreamEvent +``` + +## Parameters + + + +## Returns + +`StreamEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 422. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/stream-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/stream-event/index.mdx new file mode 100644 index 0000000000..8a99bb0bb3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/stream-event/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/relay-event/stream-event" +title: "StreamEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.StreamEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `StreamEvent` + +`calling.call.stream` — outbound media stream state change (e.g. RTMP/WebSocket streaming). + +## Signature + +```typescript +class StreamEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + + + Raw params dict from the RELAY notification. + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 399. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/tap-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/tap-event/constructor.mdx new file mode 100644 index 0000000000..4e55ba1ec3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/tap-event/constructor.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/relay/relay-event/tap-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.TapEvent.constructor" + parent: "relay.RelayEvent.TapEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + controlId: string, + state: string, + tap: Record, + device: Record +): TapEvent +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`TapEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 369. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/tap-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/tap-event/from-payload.mdx new file mode 100644 index 0000000000..2137b77013 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/tap-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/tap-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.TapEvent.fromPayload" + parent: "relay.RelayEvent.TapEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): TapEvent +``` + +## Parameters + + + +## Returns + +`TapEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 386. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/tap-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/tap-event/index.mdx new file mode 100644 index 0000000000..ddea240eae --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/tap-event/index.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/relay/relay-event/tap-event" +title: "TapEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.TapEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `TapEvent` + +`calling.call.tap` — media tap state change (audio mirror to an external endpoint). + +## Signature + +```typescript +class TapEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 363. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/transcribe-event/constructor.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/transcribe-event/constructor.mdx new file mode 100644 index 0000000000..5f614f0ad8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/transcribe-event/constructor.mdx @@ -0,0 +1,64 @@ +--- +slug: "/reference/typescript/relay/relay-event/transcribe-event/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.TranscribeEvent.constructor" + parent: "relay.RelayEvent.TranscribeEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + eventType: string, + params: Record, + callId: string, + timestamp: number, + controlId: string, + state: string, + url: string, + recordingId: string, + duration: number, + size: number +): TranscribeEvent +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + +## Returns + +`TranscribeEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 659. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/transcribe-event/from-payload.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/transcribe-event/from-payload.mdx new file mode 100644 index 0000000000..5ab8651328 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/transcribe-event/from-payload.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/relay/relay-event/transcribe-event/from-payload" +title: "fromPayload" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "relay.RelayEvent.TranscribeEvent.fromPayload" + parent: "relay.RelayEvent.TranscribeEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `fromPayload` + +Factory that builds a typed event from a raw `signalwire.event` payload. +Subclasses override this to populate their specialised fields; the base +implementation returns a minimal `RelayEvent` used as the fallback for +unrecognised event types. + +**Modifiers:** `static` + +## Signature + +```typescript +fromPayload(payload: Record): TranscribeEvent +``` + +## Parameters + + + +## Returns + +`TranscribeEvent` + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 680. diff --git a/fern/products/sdk-reference/typescript/relay/relay-event/transcribe-event/index.mdx b/fern/products/sdk-reference/typescript/relay/relay-event/transcribe-event/index.mdx new file mode 100644 index 0000000000..d1d78ab438 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/relay-event/transcribe-event/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/typescript/relay/relay-event/transcribe-event" +title: "TranscribeEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "relay.RelayEvent.TranscribeEvent" + parent: "relay.RelayEvent" + module: "relay.RelayEvent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts" +--- +# `TranscribeEvent` + +`calling.call.transcribe` — transcription state change and final URL/duration when finished. + +## Signature + +```typescript +class TranscribeEvent extends RelayEvent +``` + +## Inheritance + +**Extends:** [RelayEvent](/reference/typescript/relay/relay-event/relay-event) + +## Properties + + + Call ID associated with the event, or `""` for non-call events. + + + + + + + + Fully-qualified event type (e.g. `"calling.call.state"`). + + + + Raw params dict from the RELAY notification. + + + + + + + + + + Server timestamp (epoch seconds) at which the event was emitted. + + + + +## Methods + + + + + + Factory that builds a typed event from a raw `signalwire.event` payload. Subclasses override this to populate their specialised fields; the base implementation returns a minimal `RelayEvent` used as the fallback for unrecognised event types. + + + +## Source + +[`src/relay/RelayEvent.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/RelayEvent.ts) + +Line 651. diff --git a/fern/products/sdk-reference/typescript/relay/types/call-handler.mdx b/fern/products/sdk-reference/typescript/relay/types/call-handler.mdx new file mode 100644 index 0000000000..ef1cf98c3e --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/call-handler.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/relay/types/call-handler" +title: "CallHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "relay.types.CallHandler" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `CallHandler` + +Handler for inbound calls. + +## Signature + +```typescript +type CallHandler = (call: Call) => void | Promise +``` + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 60. diff --git a/fern/products/sdk-reference/typescript/relay/types/collect-config/index.mdx b/fern/products/sdk-reference/typescript/relay/types/collect-config/index.mdx new file mode 100644 index 0000000000..def4820ee9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/collect-config/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/relay/types/collect-config" +title: "CollectConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.types.CollectConfig" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `CollectConfig` + +Collect input configuration. + +## Signature + +```typescript +interface CollectConfig +``` + +## Properties + + + Continuous mode? + + + + Collect digits. + + + + Initial timeout in seconds. + + + + Partial results? + + + + Collect speech. + + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 131. diff --git a/fern/products/sdk-reference/typescript/relay/types/completed-callback.mdx b/fern/products/sdk-reference/typescript/relay/types/completed-callback.mdx new file mode 100644 index 0000000000..9e3181a80d --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/completed-callback.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/relay/types/completed-callback" +title: "CompletedCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "relay.types.CompletedCallback" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `CompletedCallback` + +Callback when an action or message completes. + +## Signature + +```typescript +type CompletedCallback = (event: RelayEvent) => void | Promise +``` + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 69. diff --git a/fern/products/sdk-reference/typescript/relay/types/device.mdx b/fern/products/sdk-reference/typescript/relay/types/device.mdx new file mode 100644 index 0000000000..9177676277 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/device.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/relay/types/device" +title: "Device" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "relay.types.Device" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `Device` + +Any device specification. + +## Signature + +```typescript +type Device = PhoneDevice | SipDevice | Record +``` + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 94. diff --git a/fern/products/sdk-reference/typescript/relay/types/dial-options/index.mdx b/fern/products/sdk-reference/typescript/relay/types/dial-options/index.mdx new file mode 100644 index 0000000000..d0d3184a78 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/dial-options/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/relay/types/dial-options" +title: "DialOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.types.DialOptions" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `DialOptions` + +Options for the dial() method. + +## Signature + +```typescript +interface DialOptions +``` + +## Properties + + + Caller ID / from number. + + + + Maximum call duration in seconds. + + + + Timeout in seconds for the dial. + + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 97. diff --git a/fern/products/sdk-reference/typescript/relay/types/event-handler.mdx b/fern/products/sdk-reference/typescript/relay/types/event-handler.mdx new file mode 100644 index 0000000000..201dca0e31 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/event-handler.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/relay/types/event-handler" +title: "EventHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "relay.types.EventHandler" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `EventHandler` + +Handler for relay events. + +## Signature + +```typescript +type EventHandler = (event: RelayEvent) => void | Promise +``` + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/relay/types/index.mdx b/fern/products/sdk-reference/typescript/relay/types/index.mdx new file mode 100644 index 0000000000..4a2127fc2d --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/index.mdx @@ -0,0 +1,98 @@ +--- +slug: "/reference/typescript/relay/types" +title: "types" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "relay.types" + module: "relay" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `types` + +## Signature + +```typescript +module types +``` + +## Type Aliases + + + + Handler for inbound calls. + + + + Callback when an action or message completes. + + + + Any device specification. + + + + Handler for relay events. + + + + Handler for inbound messages. + + + + Play item: TTS, audio URL, ringtone, or silence. + + + +## Interfaces + + + + Collect input configuration. + + + + Options for the dial() method. + + + + JSON-RPC 2.0 error object. + + + + JSON-RPC 2.0 request. + + + + JSON-RPC 2.0 response (success). + + + + Phone device specification for dial/connect. + + + + Queued request waiting for reconnection. + + + + Options for constructing a RelayClient. + + + + Options for the sendMessage() method. + + + + SIP device specification for dial/connect. + + + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/relay/types/json-rpc-error/index.mdx b/fern/products/sdk-reference/typescript/relay/types/json-rpc-error/index.mdx new file mode 100644 index 0000000000..bc35822774 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/json-rpc-error/index.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/relay/types/json-rpc-error" +title: "JsonRpcError" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.types.JsonRpcError" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `JsonRpcError` + +JSON-RPC 2.0 error object. + +## Signature + +```typescript +interface JsonRpcError +``` + +## Properties + + + + + + + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 53. diff --git a/fern/products/sdk-reference/typescript/relay/types/json-rpc-request/index.mdx b/fern/products/sdk-reference/typescript/relay/types/json-rpc-request/index.mdx new file mode 100644 index 0000000000..c05faaf250 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/json-rpc-request/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/relay/types/json-rpc-request" +title: "JsonRpcRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.types.JsonRpcRequest" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `JsonRpcRequest` + +JSON-RPC 2.0 request. + +## Signature + +```typescript +interface JsonRpcRequest +``` + +## Properties + + + + + + + + + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 37. diff --git a/fern/products/sdk-reference/typescript/relay/types/json-rpc-response/index.mdx b/fern/products/sdk-reference/typescript/relay/types/json-rpc-response/index.mdx new file mode 100644 index 0000000000..ec4b414be3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/json-rpc-response/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/relay/types/json-rpc-response" +title: "JsonRpcResponse" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.types.JsonRpcResponse" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `JsonRpcResponse` + +JSON-RPC 2.0 response (success). + +## Signature + +```typescript +interface JsonRpcResponse +``` + +## Properties + + + + + + + + + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 45. diff --git a/fern/products/sdk-reference/typescript/relay/types/message-handler.mdx b/fern/products/sdk-reference/typescript/relay/types/message-handler.mdx new file mode 100644 index 0000000000..8f657a8640 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/message-handler.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/relay/types/message-handler" +title: "MessageHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "relay.types.MessageHandler" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `MessageHandler` + +Handler for inbound messages. + +## Signature + +```typescript +type MessageHandler = (message: Message) => void | Promise +``` + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 63. diff --git a/fern/products/sdk-reference/typescript/relay/types/phone-device/index.mdx b/fern/products/sdk-reference/typescript/relay/types/phone-device/index.mdx new file mode 100644 index 0000000000..0cf6cb873f --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/phone-device/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/relay/types/phone-device" +title: "PhoneDevice" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.types.PhoneDevice" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `PhoneDevice` + +Phone device specification for dial/connect. + +## Signature + +```typescript +interface PhoneDevice +``` + +## Properties + + + + + + + + + + + + + + + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 72. diff --git a/fern/products/sdk-reference/typescript/relay/types/play-item.mdx b/fern/products/sdk-reference/typescript/relay/types/play-item.mdx new file mode 100644 index 0000000000..5a9d36f116 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/play-item.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/relay/types/play-item" +title: "PlayItem" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "relay.types.PlayItem" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `PlayItem` + +Play item: TTS, audio URL, ringtone, or silence. + +## Signature + +```typescript +type PlayItem = { gender?: string; language?: string; text: string; type: "tts" } | { type: "audio"; url: string } | { duration?: number; name: string; type: "ringtone" } | { duration: number; type: "silence" } | Record +``` + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 123. diff --git a/fern/products/sdk-reference/typescript/relay/types/queued-request/index.mdx b/fern/products/sdk-reference/typescript/relay/types/queued-request/index.mdx new file mode 100644 index 0000000000..117af37799 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/queued-request/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/relay/types/queued-request" +title: "QueuedRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.types.QueuedRequest" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `QueuedRequest` + +Queued request waiting for reconnection. + +## Signature + +```typescript +interface QueuedRequest +``` + +## Properties + + + + + + + + + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 155. diff --git a/fern/products/sdk-reference/typescript/relay/types/relay-client-options/index.mdx b/fern/products/sdk-reference/typescript/relay/types/relay-client-options/index.mdx new file mode 100644 index 0000000000..e6d6790cb6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/relay-client-options/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/relay/types/relay-client-options" +title: "RelayClientOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.types.RelayClientOptions" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `RelayClientOptions` + +Options for constructing a RelayClient. + +## Signature + +```typescript +interface RelayClientOptions +``` + +## Properties + + + Contexts (topics) to receive inbound calls/messages on. + + + + RELAY host. Defaults to relay.signalwire.com. + + + + JWT token for authentication. Defaults to env SIGNALWIRE\_JWT\_TOKEN. + + + + Maximum number of concurrent active calls. Defaults to env RELAY\_MAX\_ACTIVE\_CALLS or 1000. + + + + SignalWire project ID. Defaults to env SIGNALWIRE\_PROJECT\_ID. + + + + WebSocket scheme — `'wss'` (production, the default) or `'ws'` (loopback fixtures and local audit harnesses). Reads from `SIGNALWIRE_RELAY_SCHEME` if not explicitly set; defaults to `'wss'`. Production deployments should never pass `'ws'` — the value exists solely so the porting-sdk's `audit_relay_handshake.py` can drive the real client against a plain-WS loopback fixture without standing up TLS termination. + + + + SignalWire API token. Defaults to env SIGNALWIRE\_API\_TOKEN. + + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 10. diff --git a/fern/products/sdk-reference/typescript/relay/types/send-message-options/index.mdx b/fern/products/sdk-reference/typescript/relay/types/send-message-options/index.mdx new file mode 100644 index 0000000000..8dffb1075c --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/send-message-options/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/relay/types/send-message-options" +title: "SendMessageOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.types.SendMessageOptions" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `SendMessageOptions` + +Options for the sendMessage() method. + +## Signature + +```typescript +interface SendMessageOptions +``` + +## Properties + + + Message body text. + + + + Context for the message. + + + + Sender phone number in E.164 format. + + + + Media URLs for MMS. + + + + Tags for the message. + + + + Destination phone number in E.164 format. + + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 107. diff --git a/fern/products/sdk-reference/typescript/relay/types/sip-device/index.mdx b/fern/products/sdk-reference/typescript/relay/types/sip-device/index.mdx new file mode 100644 index 0000000000..dab8e8fc61 --- /dev/null +++ b/fern/products/sdk-reference/typescript/relay/types/sip-device/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/relay/types/sip-device" +title: "SipDevice" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "relay.types.SipDevice" + parent: "relay.types" + module: "relay.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts" +--- +# `SipDevice` + +SIP device specification for dial/connect. + +## Signature + +```typescript +interface SipDevice +``` + +## Properties + + + + + + + + + + + + + + + +## Source + +[`src/relay/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/relay/types.ts) + +Line 83. diff --git a/fern/products/sdk-reference/typescript/rest-client.mdx b/fern/products/sdk-reference/typescript/rest-client.mdx new file mode 100644 index 0000000000..eb19b8e649 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest-client.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/typescript/rest-client" +title: "restClient" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "restClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts" +--- +# `restClient` + +Construct a [RestClient](/reference/typescript/rest/rest-client) instance. + +Equivalent to Python's top-level `signalwire.RestClient(*args, **kwargs)` +factory — a thin wrapper that lazy-imports `signalwire.rest.RestClient` +and instantiates it. The TS class is also exported directly at module +scope (`new RestClient(...)`); this function provides parity with the +Python-style factory call. + +Note: TypeScript exports the class `RestClient` at the same name from +`./rest/index.js`. The function below is named `restClient` (camelCase) +to avoid shadowing the class. The audit adapter remaps the emitted +surface entry from `signalwire.rest_client` to `signalwire.RestClient` +via the FREE\_FN\_NAME\_OVERRIDES table in enumerate-signatures.ts. + +The signature accepts a positional `args` rest parameter and a trailing +`kwargs` record. This mirrors Python's `(*args, **kwargs)` shape so the +cross-language signature audit recognizes them as compatible. In +practice callers pass either the `kwargs` object alone or nothing. + +## Signature + +```typescript +restClient(args?: string[], kwargs?: Record): RestClient +``` + +## Parameters + + + Positional credentials (compat shim for ports that pass project/token/host positionally). Usually empty in TS. + + + + Keyword-style credentials. When omitted, reads `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_API_TOKEN`, and `SIGNALWIRE_SPACE` from the environment. + + +## Returns + +`RestClient` — A new `_RestClient` instance bound to the supplied (or environment-derived) credentials. + +## Examples + +```typescript +import { restClient } from '@signalwire/sdk'; + +const client = restClient([], { project: 'p', token: 't', host: 'h.signalwire.com' }); +await client.compat.calls.list(); + +// Or using just the options form: +const env = restClient(); // reads env vars +``` + +## Source + +[`src/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts) + +Line 248. diff --git a/fern/products/sdk-reference/typescript/rest/base/base-resource/base-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/base/base-resource/base-resource/constructor.mdx new file mode 100644 index 0000000000..a83491872b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/base-resource/base-resource/constructor.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/rest/base/base-resource/base-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.BaseResource.BaseResource.constructor" + parent: "rest.base.BaseResource.BaseResource" + module: "rest.base.BaseResource" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/BaseResource.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): BaseResource +``` + +## Parameters + + + Shared HTTP client to issue requests through. + + + + Absolute path prefix (e.g. `'/api/relay/rest/phone_numbers'`). + + +## Returns + +`BaseResource` + +## Source + +[`src/rest/base/BaseResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/BaseResource.ts) + +Line 18. diff --git a/fern/products/sdk-reference/typescript/rest/base/base-resource/base-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/base/base-resource/base-resource/index.mdx new file mode 100644 index 0000000000..d909b62cf6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/base-resource/base-resource/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/rest/base/base-resource/base-resource" +title: "BaseResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.base.BaseResource.BaseResource" + parent: "rest.base.BaseResource" + module: "rest.base.BaseResource" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/BaseResource.ts" +--- +# `BaseResource` + +Abstract base class for all REST resources. + +Every namespace resource (e.g. [PhoneNumbersResource](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource), [VideoRooms](/reference/typescript/rest/namespaces/video/video-rooms)) +extends this class to get a typed reference to the shared [HttpClient](/reference/typescript/rest/http-client) +and a small path-building helper. Not exported for direct use — subclass it. + +**Modifiers:** `abstract` + +## Signature + +```typescript +class BaseResource +``` + +## Methods + + + + + +## Source + +[`src/rest/base/BaseResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/BaseResource.ts) + +Line 10. diff --git a/fern/products/sdk-reference/typescript/rest/base/base-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/base/base-resource/index.mdx new file mode 100644 index 0000000000..36e0411685 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/base-resource/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/base/base-resource" +title: "BaseResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.base.BaseResource" + module: "rest.base" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/BaseResource.ts" +--- +# `BaseResource` + +## Signature + +```typescript +module BaseResource +``` + +## Classes + + + + Abstract base class for all REST resources. + + + +## Source + +[`src/rest/base/BaseResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/BaseResource.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/constructor.mdx new file mode 100644 index 0000000000..153c7a0e9d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/constructor.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/rest/base/crud-resource/crud-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudResource.CrudResource.constructor" + parent: "rest.base.CrudResource.CrudResource" + module: "rest.base.CrudResource" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + http: HttpClient, + basePath: string +): CrudResource +``` + +## Type Parameters + + + Type of the paginated list response. + + + + Type of a single resource item. + + + + Request body type for `create()`. + + + + Request body type for `update()`. + + +## Parameters + + + + + +## Returns + +`CrudResource` + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 33. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/create.mdx new file mode 100644 index 0000000000..fe66b70471 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/base/crud-resource/crud-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudResource.CrudResource.create" + parent: "rest.base.CrudResource.CrudResource" + module: "rest.base.CrudResource" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: TCreate): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/delete.mdx new file mode 100644 index 0000000000..aff8bd15a4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/base/crud-resource/crud-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudResource.CrudResource.delete" + parent: "rest.base.CrudResource.CrudResource" + module: "rest.base.CrudResource" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/get.mdx new file mode 100644 index 0000000000..c8762cbfc0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/base/crud-resource/crud-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudResource.CrudResource.get" + parent: "rest.base.CrudResource.CrudResource" + module: "rest.base.CrudResource" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/index.mdx new file mode 100644 index 0000000000..cecab57d84 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/index.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/typescript/rest/base/crud-resource/crud-resource" +title: "CrudResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.base.CrudResource.CrudResource" + parent: "rest.base.CrudResource" + module: "rest.base.CrudResource" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `CrudResource` + +Generic CRUD resource with configurable update method. + +Provides `list()`, `create()`, `get()`, `update()`, and `delete()` out of the +box — most namespace resources extend this and narrow the generic types. +`_updateMethod` may be overridden to `'PUT'` for APIs that replace instead +of patch. + +## Signature + +```typescript +class CrudResource extends BaseResource +``` + +## Type Parameters + + + Type of the paginated list response. + + + + Type of a single resource item. + + + + Request body type for `create()`. + + + + Request body type for `update()`. + + +## Inheritance + +**Extends:** [BaseResource](/reference/typescript/rest/base/base-resource) + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 24. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/list.mdx new file mode 100644 index 0000000000..0134ce4900 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/base/crud-resource/crud-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudResource.CrudResource.list" + parent: "rest.base.CrudResource.CrudResource" + module: "rest.base.CrudResource" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/update.mdx new file mode 100644 index 0000000000..f48bf7de26 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-resource/crud-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/base/crud-resource/crud-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudResource.CrudResource.update" + parent: "rest.base.CrudResource.CrudResource" + module: "rest.base.CrudResource" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: TUpdate): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-resource/index.mdx new file mode 100644 index 0000000000..a2475d3574 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-resource/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/base/crud-resource" +title: "CrudResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.base.CrudResource" + module: "rest.base" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `CrudResource` + +## Signature + +```typescript +module CrudResource +``` + +## Classes + + + + Generic CRUD resource with configurable update method. + + + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/constructor.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/constructor.mdx new file mode 100644 index 0000000000..c898db2157 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/constructor.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudWithAddresses.CrudWithAddresses.constructor" + parent: "rest.base.CrudWithAddresses.CrudWithAddresses" + module: "rest.base.CrudWithAddresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + http: HttpClient, + basePath: string +): CrudWithAddresses +``` + +## Type Parameters + + + + + + + + + +## Parameters + + + + + +## Returns + +`CrudWithAddresses` + +## Source + +[`src/rest/base/CrudWithAddresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts) + +Line 22. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/create.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/create.mdx new file mode 100644 index 0000000000..94ab7532e8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudWithAddresses.CrudWithAddresses.create" + parent: "rest.base.CrudWithAddresses.CrudWithAddresses" + module: "rest.base.CrudWithAddresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: TCreate): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/delete.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/delete.mdx new file mode 100644 index 0000000000..221c4fe498 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudWithAddresses.CrudWithAddresses.delete" + parent: "rest.base.CrudWithAddresses.CrudWithAddresses" + module: "rest.base.CrudWithAddresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/get.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/get.mdx new file mode 100644 index 0000000000..ee378a7151 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudWithAddresses.CrudWithAddresses.get" + parent: "rest.base.CrudWithAddresses.CrudWithAddresses" + module: "rest.base.CrudWithAddresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/index.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/index.mdx new file mode 100644 index 0000000000..a9c3b610a5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/typescript/rest/base/crud-with-addresses/crud-with-addresses" +title: "CrudWithAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.base.CrudWithAddresses.CrudWithAddresses" + parent: "rest.base.CrudWithAddresses" + module: "rest.base.CrudWithAddresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts" +--- +# `CrudWithAddresses` + +[CrudResource](/reference/typescript/rest/base/crud-resource) extended with a `listAddresses()` helper for resources that +have associated Address records (e.g. fabric resources). + +## Signature + +```typescript +class CrudWithAddresses extends CrudResource +``` + +## Type Parameters + + + + + + + + + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + List addresses associated with a specific resource instance. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/base/CrudWithAddresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts) + +Line 15. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/list-addresses.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/list-addresses.mdx new file mode 100644 index 0000000000..107540912d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/list-addresses.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/list-addresses" +title: "listAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudWithAddresses.CrudWithAddresses.listAddresses" + parent: "rest.base.CrudWithAddresses.CrudWithAddresses" + module: "rest.base.CrudWithAddresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts" +--- +# `listAddresses` + +List addresses associated with a specific resource instance. + +## Signature + +```typescript +listAddresses(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the owning resource. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudWithAddresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/list.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/list.mdx new file mode 100644 index 0000000000..3e574195b3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudWithAddresses.CrudWithAddresses.list" + parent: "rest.base.CrudWithAddresses.CrudWithAddresses" + module: "rest.base.CrudWithAddresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/update.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/update.mdx new file mode 100644 index 0000000000..fa11def928 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/base/crud-with-addresses/crud-with-addresses/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.base.CrudWithAddresses.CrudWithAddresses.update" + parent: "rest.base.CrudWithAddresses.CrudWithAddresses" + module: "rest.base.CrudWithAddresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: TUpdate): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/index.mdx b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/index.mdx new file mode 100644 index 0000000000..ea0c58dfa6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/base/crud-with-addresses/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/base/crud-with-addresses" +title: "CrudWithAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.base.CrudWithAddresses" + module: "rest.base" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts" +--- +# `CrudWithAddresses` + +## Signature + +```typescript +module CrudWithAddresses +``` + +## Classes + + + + [CrudResource](/reference/typescript/rest/base/crud-resource) extended with a `listAddresses()` helper for resources that have associated Address records (e.g. fabric resources). + + + +## Source + +[`src/rest/base/CrudWithAddresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/call-handler/index.mdx b/fern/products/sdk-reference/typescript/rest/call-handler/index.mdx new file mode 100644 index 0000000000..a4e7ffbb99 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/call-handler/index.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/rest/call-handler" +title: "callHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.callHandler" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/callHandler.ts" +--- +# `callHandler` + +## Signature + +```typescript +module callHandler +``` + +## Constants + + + PhoneCallHandler — enum of `call_handler` values accepted by [PhoneNumbersResource.update](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/update). Named `PhoneCallHandler` (not `CallHandler`) to avoid colliding with the RELAY client's inbound-call-handler callback type already exported from `src/relay/types.ts`. Setting a phone number's `call_handler` + the handler-specific companion field routes inbound calls and auto-materializes the matching Fabric resource on the server. See the high-level helpers on [PhoneNumbersResource](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource) (`setSwmlWebhook`, `setCxmlWebhook`, `setCxmlApplication`, `setAiAgent`, `setCallFlow`, `setRelayApplication`, `setRelayTopic`). | Member | Wire value | Companion field | Auto-creates Fabric resource | |---|---|---|---| | `RELAY_SCRIPT` | `relay_script` | `call_relay_script_url` | `swml_webhook` | | `LAML_WEBHOOKS` | `laml_webhooks` | `call_request_url` | `cxml_webhook` | | `LAML_APPLICATION` | `laml_application` | `call_laml_application_id` | `cxml_application` | | `AI_AGENT` | `ai_agent` | `call_ai_agent_id` | `ai_agent` | | `CALL_FLOW` | `call_flow` | `call_flow_id` | `call_flow` | | `RELAY_APPLICATION` | `relay_application` | `call_relay_application` | `relay_application` | | `RELAY_TOPIC` | `relay_topic` | `call_relay_topic` | _(routes via RELAY)_ | | `RELAY_CONTEXT` | `relay_context` | `call_relay_context` | _(legacy, prefer topic)_ | | `RELAY_CONNECTOR` | `relay_connector` | _(connector config)_ | _(internal)_ | | `VIDEO_ROOM` | `video_room` | `call_video_room_id` | _(routes to Video API)_ | | `DIALOGFLOW` | `dialogflow` | `call_dialogflow_agent_id` | _(none)_ | Note: `LAML_WEBHOOKS` (wire value `laml_webhooks`) produces a **cXML** handler, not a generic webhook. For SWML, use `RELAY_SCRIPT`. + + +## Type Aliases + + + + Union of every valid `call_handler` wire value. + + + +## Source + +[`src/rest/callHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/callHandler.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/call-handler/phone-call-handler.mdx b/fern/products/sdk-reference/typescript/rest/call-handler/phone-call-handler.mdx new file mode 100644 index 0000000000..1ee23a7cde --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/call-handler/phone-call-handler.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/rest/call-handler/phone-call-handler" +title: "PhoneCallHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "rest.callHandler.PhoneCallHandler" + parent: "rest.callHandler" + module: "rest.callHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/callHandler.ts" +--- +# `PhoneCallHandler` + +Union of every valid `call_handler` wire value. + +## Signature + +```typescript +type PhoneCallHandler = typeof PhoneCallHandler[keyof typeof PhoneCallHandler] +``` + +## Source + +[`src/rest/callHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/callHandler.ts) + +Line 46. diff --git a/fern/products/sdk-reference/typescript/rest/http-client/http-client/constructor.mdx b/fern/products/sdk-reference/typescript/rest/http-client/http-client/constructor.mdx new file mode 100644 index 0000000000..6be68c6e48 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/http-client/http-client/constructor.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/http-client/http-client/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.HttpClient.HttpClient.constructor" + parent: "rest.HttpClient.HttpClient" + module: "rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts" +--- +# `constructor` + +Build a new HTTP client. + +## Signature + +```typescript +constructor(options: HttpClientOptions): HttpClient +``` + +## Parameters + + + Connection options. Either `host` (bare hostname; `https://` is prepended automatically) or `baseUrl` (fully-qualified) must be provided along with `project` + `token`. + + +## Returns + +`HttpClient` + +## Throws + +- When neither `host` nor `baseUrl` is supplied. + +## Source + +[`src/rest/HttpClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts) + +Line 37. diff --git a/fern/products/sdk-reference/typescript/rest/http-client/http-client/delete.mdx b/fern/products/sdk-reference/typescript/rest/http-client/http-client/delete.mdx new file mode 100644 index 0000000000..0d88ac4845 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/http-client/http-client/delete.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/rest/http-client/http-client/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.HttpClient.HttpClient.delete" + parent: "rest.HttpClient.HttpClient" + module: "rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts" +--- +# `delete` + +Perform an authenticated HTTP DELETE and return the parsed JSON response. + +## Signature + +```typescript +delete(path: string): Promise +``` + +## Type Parameters + + + Expected response body type. + + +## Parameters + + + Absolute URL or path relative to [HttpClient.baseUrl](/reference/typescript/rest/http-client/http-client#base-url). + + +## Returns + +`Promise` — The parsed JSON body, or `{}` on `204 No Content`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/HttpClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts) + +Line 161. diff --git a/fern/products/sdk-reference/typescript/rest/http-client/http-client/get.mdx b/fern/products/sdk-reference/typescript/rest/http-client/http-client/get.mdx new file mode 100644 index 0000000000..dba0e3d921 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/http-client/http-client/get.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/rest/http-client/http-client/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.HttpClient.HttpClient.get" + parent: "rest.HttpClient.HttpClient" + module: "rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts" +--- +# `get` + +Perform an authenticated HTTP GET and return the parsed JSON response. + +## Signature + +```typescript +get(path: string, params?: QueryParams): Promise +``` + +## Type Parameters + + + Expected response body type. + + +## Parameters + + + Absolute URL or path relative to [HttpClient.baseUrl](/reference/typescript/rest/http-client/http-client#base-url). + + + + Optional query parameters; `undefined` values are skipped. + + +## Returns + +`Promise` — The parsed JSON body, or `{}` on `204 No Content`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/HttpClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts) + +Line 109. diff --git a/fern/products/sdk-reference/typescript/rest/http-client/http-client/index.mdx b/fern/products/sdk-reference/typescript/rest/http-client/http-client/index.mdx new file mode 100644 index 0000000000..e66e2aaaf5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/http-client/http-client/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/rest/http-client/http-client" +title: "HttpClient" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.HttpClient.HttpClient" + parent: "rest.HttpClient" + module: "rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts" +--- +# `HttpClient` + +Low-level HTTP client used by every REST namespace resource. + +Handles Basic Auth, JSON encoding/decoding, and error normalisation +([RestError](/reference/typescript/rest/rest-error) on non-2xx). Normally you do not instantiate this +directly — construct a [RestClient](/reference/typescript/rest/rest-client) instead. + +## Signature + +```typescript +class HttpClient +``` + +## Properties + + + Fully-qualified base URL (no trailing slash). + + +## Methods + + + + Build a new HTTP client. + + + + Perform an authenticated HTTP DELETE and return the parsed JSON response. + + + + Perform an authenticated HTTP GET and return the parsed JSON response. + + + + Perform an authenticated HTTP PATCH and return the parsed JSON response. + + + + Perform an authenticated HTTP POST and return the parsed JSON response. + + + + Perform an authenticated HTTP PUT and return the parsed JSON response. + + + +## Source + +[`src/rest/HttpClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts) + +Line 23. diff --git a/fern/products/sdk-reference/typescript/rest/http-client/http-client/patch.mdx b/fern/products/sdk-reference/typescript/rest/http-client/http-client/patch.mdx new file mode 100644 index 0000000000..eb84d46aa2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/http-client/http-client/patch.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/rest/http-client/http-client/patch" +title: "patch" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.HttpClient.HttpClient.patch" + parent: "rest.HttpClient.HttpClient" + module: "rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts" +--- +# `patch` + +Perform an authenticated HTTP PATCH and return the parsed JSON response. + +## Signature + +```typescript +patch(path: string, body?: any): Promise +``` + +## Type Parameters + + + Expected response body type. + + +## Parameters + + + Absolute URL or path relative to [HttpClient.baseUrl](/reference/typescript/rest/http-client/http-client#base-url). + + + + JSON-serialisable partial request body. + + +## Returns + +`Promise` — The parsed JSON body, or `{}` on `204 No Content`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/HttpClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts) + +Line 149. diff --git a/fern/products/sdk-reference/typescript/rest/http-client/http-client/post.mdx b/fern/products/sdk-reference/typescript/rest/http-client/http-client/post.mdx new file mode 100644 index 0000000000..8b68cbcf12 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/http-client/http-client/post.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/rest/http-client/http-client/post" +title: "post" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.HttpClient.HttpClient.post" + parent: "rest.HttpClient.HttpClient" + module: "rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts" +--- +# `post` + +Perform an authenticated HTTP POST and return the parsed JSON response. + +## Signature + +```typescript +post(path: string, body?: any, params?: QueryParams): Promise +``` + +## Type Parameters + + + Expected response body type. + + +## Parameters + + + Absolute URL or path relative to [HttpClient.baseUrl](/reference/typescript/rest/http-client/http-client#base-url). + + + + JSON-serialisable request body. Omit to send no body. + + + + Optional query parameters appended to the URL. + + +## Returns + +`Promise` — The parsed JSON body, or `{}` on `204 No Content`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/HttpClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts) + +Line 123. diff --git a/fern/products/sdk-reference/typescript/rest/http-client/http-client/put.mdx b/fern/products/sdk-reference/typescript/rest/http-client/http-client/put.mdx new file mode 100644 index 0000000000..27077acc90 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/http-client/http-client/put.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/rest/http-client/http-client/put" +title: "put" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.HttpClient.HttpClient.put" + parent: "rest.HttpClient.HttpClient" + module: "rest.HttpClient" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts" +--- +# `put` + +Perform an authenticated HTTP PUT and return the parsed JSON response. + +## Signature + +```typescript +put(path: string, body?: any): Promise +``` + +## Type Parameters + + + Expected response body type. + + +## Parameters + + + Absolute URL or path relative to [HttpClient.baseUrl](/reference/typescript/rest/http-client/http-client#base-url). + + + + JSON-serialisable request body. + + +## Returns + +`Promise` — The parsed JSON body, or `{}` on `204 No Content`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/HttpClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts) + +Line 136. diff --git a/fern/products/sdk-reference/typescript/rest/http-client/index.mdx b/fern/products/sdk-reference/typescript/rest/http-client/index.mdx new file mode 100644 index 0000000000..4b8a644de4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/http-client/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/http-client" +title: "HttpClient" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.HttpClient" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts" +--- +# `HttpClient` + +## Signature + +```typescript +module HttpClient +``` + +## Classes + + + + Low-level HTTP client used by every REST namespace resource. + + + +## Source + +[`src/rest/HttpClient.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/HttpClient.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/index.mdx b/fern/products/sdk-reference/typescript/rest/index.mdx new file mode 100644 index 0000000000..8a3fa26244 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/index.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/rest" +title: "rest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/index.ts" +--- +# `rest` + +## Signature + +```typescript +module rest +``` + +## Classes + + + + REST client for the SignalWire platform APIs. + + + +## Source + +[`src/rest/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/index.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/constructor.mdx new file mode 100644 index 0000000000..e91938c241 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/addresses/addresses-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.addresses.AddressesResource.constructor" + parent: "rest.namespaces.addresses.AddressesResource" + module: "rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): AddressesResource +``` + +## Parameters + + + +## Returns + +`AddressesResource` + +## Source + +[`src/rest/namespaces/addresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts) + +Line 17. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/create.mdx new file mode 100644 index 0000000000..b367f7e237 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/addresses/addresses-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.addresses.AddressesResource.create" + parent: "rest.namespaces.addresses.AddressesResource" + module: "rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts" +--- +# `create` + +Create a new address. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Address attributes (name, display name, context, etc.). + + +## Returns + +`Promise` — The newly-created address. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/addresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts) + +Line 39. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/delete.mdx new file mode 100644 index 0000000000..5d48ce00df --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/addresses/addresses-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.addresses.AddressesResource.delete" + parent: "rest.namespaces.addresses.AddressesResource" + module: "rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts" +--- +# `delete` + +Delete an address. + +## Signature + +```typescript +delete(addressId: string): Promise +``` + +## Parameters + + + Unique identifier of the address. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/addresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts) + +Line 61. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/get.mdx new file mode 100644 index 0000000000..06b63fa202 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/addresses/addresses-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.addresses.AddressesResource.get" + parent: "rest.namespaces.addresses.AddressesResource" + module: "rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts" +--- +# `get` + +Fetch a single address by ID. + +## Signature + +```typescript +get(addressId: string): Promise +``` + +## Parameters + + + Unique identifier of the address. + + +## Returns + +`Promise` — The address record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/addresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts) + +Line 50. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/index.mdx new file mode 100644 index 0000000000..aa95d6bdd6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/rest/namespaces/addresses/addresses-resource" +title: "AddressesResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.addresses.AddressesResource" + parent: "rest.namespaces.addresses" + module: "rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts" +--- +# `AddressesResource` + +Address management (no update endpoint). + +Access via `client.addresses.*`. + +## Signature + +```typescript +class AddressesResource extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Create a new address. + + + + Delete an address. + + + + Fetch a single address by ID. + + + + List all addresses in the project. + + + +## Source + +[`src/rest/namespaces/addresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/list.mdx new file mode 100644 index 0000000000..c570a8b74d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/addresses-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/addresses/addresses-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.addresses.AddressesResource.list" + parent: "rest.namespaces.addresses.AddressesResource" + module: "rest.namespaces.addresses" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts" +--- +# `list` + +List all addresses in the project. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/addresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts) + +Line 28. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/addresses/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/index.mdx new file mode 100644 index 0000000000..e8a21b0008 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/addresses/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/addresses" +title: "addresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.addresses" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts" +--- +# `addresses` + +## Signature + +```typescript +module addresses +``` + +## Classes + + + + Address management (no update endpoint). + + + +## Source + +[`src/rest/namespaces/addresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/addresses.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-hold.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-hold.mdx new file mode 100644 index 0000000000..ffc12ffd5b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-hold.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/ai-hold" +title: "aiHold" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.aiHold" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `aiHold` + +Put the AI session on hold (pause turn-taking). + +## Signature + +```typescript +aiHold(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Platform-shaped parameters. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 424. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-message.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-message.mdx new file mode 100644 index 0000000000..012e82502c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-message.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/ai-message" +title: "aiMessage" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.aiMessage" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `aiMessage` + +Send a message into an active AI agent session. + +## Signature + +```typescript +aiMessage(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + AI message payload. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 412. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-stop.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-stop.mdx new file mode 100644 index 0000000000..7ece57274c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-stop.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/ai-stop" +title: "aiStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.aiStop" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `aiStop` + +Terminate the active AI session on a call. + +## Signature + +```typescript +aiStop(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Platform-shaped parameters. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 448. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-unhold.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-unhold.mdx new file mode 100644 index 0000000000..aba32e5ed7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/ai-unhold.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/ai-unhold" +title: "aiUnhold" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.aiUnhold" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `aiUnhold` + +Resume an AI session that was on hold. + +## Signature + +```typescript +aiUnhold(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Platform-shaped parameters. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 436. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/collect-start-input-timers.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/collect-start-input-timers.mdx new file mode 100644 index 0000000000..661d3e726e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/collect-start-input-timers.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/collect-start-input-timers" +title: "collectStartInputTimers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.collectStartInputTimers" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `collectStartInputTimers` + +Start input timers for a collect operation (useful when `initial_timeout` +should be reset after media finishes playing). + +## Signature + +```typescript +collectStartInputTimers(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 267. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/collect-stop.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/collect-stop.mdx new file mode 100644 index 0000000000..cf91bfd702 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/collect-stop.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/collect-stop" +title: "collectStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.collectStop" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `collectStop` + +Stop an in-progress collect operation. + +## Signature + +```typescript +collectStop(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 254. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/collect.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/collect.mdx new file mode 100644 index 0000000000..5e66d3b5e8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/collect.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/collect" +title: "collect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.collect" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `collect` + +Collect DTMF / speech input from the caller. + +## Signature + +```typescript +collect(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Collect configuration (`digits`, `speech`, timeouts, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The collect command response containing a `control_id`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 242. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/constructor.mdx new file mode 100644 index 0000000000..4867f259f6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.constructor" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): CallingNamespace +``` + +## Parameters + + + +## Returns + +`CallingNamespace` + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 42. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/denoise-stop.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/denoise-stop.mdx new file mode 100644 index 0000000000..36c1ab8d17 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/denoise-stop.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/denoise-stop" +title: "denoiseStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.denoiseStop" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `denoiseStop` + +Disable noise reduction. + +## Signature + +```typescript +denoiseStop(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Platform-shaped parameters. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/denoise.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/denoise.mdx new file mode 100644 index 0000000000..eed18e63e6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/denoise.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/denoise" +title: "denoise" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.denoise" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `denoise` + +Enable noise reduction on the call. + +## Signature + +```typescript +denoise(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Denoise configuration. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 360. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/detect-stop.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/detect-stop.mdx new file mode 100644 index 0000000000..7727120818 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/detect-stop.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/detect-stop" +title: "detectStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.detectStop" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `detectStop` + +Stop an active detect operation. + +## Signature + +```typescript +detectStop(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 293. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/detect.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/detect.mdx new file mode 100644 index 0000000000..296e286298 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/detect.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/detect" +title: "detect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.detect" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `detect` + +Run answering-machine / fax / DTMF detection. + +## Signature + +```typescript +detect(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Detect configuration. Defaults to `{}`. + + +## Returns + +`Promise` — The detect command response containing a `control_id`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 281. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/dial.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/dial.mdx new file mode 100644 index 0000000000..7f638392b0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/dial.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/dial" +title: "dial" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.dial" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `dial` + +Place an outbound call. + +## Signature + +```typescript +dial(params: any = {}): Promise +``` + +## Parameters + + + Platform-shaped dial parameters (from, to, timeout, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The dial command response, typically containing a new `call_id`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 64. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/disconnect.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/disconnect.mdx new file mode 100644 index 0000000000..03b8504ffc --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/disconnect.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/disconnect" +title: "disconnect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.disconnect" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `disconnect` + +Drop one leg from a call without ending the other. + +## Signature + +```typescript +disconnect(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Platform-shaped disconnect parameters. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 112. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/end.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/end.mdx new file mode 100644 index 0000000000..0f418f8331 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/end.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/end" +title: "end" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.end" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `end` + +Gracefully end a call. + +## Signature + +```typescript +end(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Platform-shaped end parameters. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 87. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/index.mdx new file mode 100644 index 0000000000..7a1ef927c5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/index.mdx @@ -0,0 +1,219 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace" +title: "CallingNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace" + parent: "rest.namespaces.calling" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `CallingNamespace` + +REST call control — all 37 commands dispatched via a single POST endpoint. + +Access via `client.calling.*`. Every method issues one command against a live +call by ID and returns the platform's JSON response. + +Every command method shares the same shape: + +- First argument (when present) is the target call's ID. +- Second argument is a platform-shaped `params` object — see the + [Calling API reference](https://developer.signalwire.com/rest/signalwire-rest/endpoints/calling/) + for the fields each command accepts. +- The method returns the JSON-decoded platform response. +- Throws [RestError](/reference/typescript/rest/rest-error) on any non-2xx HTTP response. + +## Signature + +```typescript +class CallingNamespace extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Examples + + + + ```typescript + await client.calling.play(callId, { + play: [{ type: 'audio', url: 'https://cdn.example.com/hold.mp3' }], + }); + ``` + + + + ```typescript + const rec = await client.calling.record(callId, { record: { audio: {} } }); + // ... later ... + await client.calling.recordStop(callId, { control_id: rec.control_id }); + ``` + + + +## Methods + + + + Put the AI session on hold (pause turn-taking). + + + + Send a message into an active AI agent session. + + + + Terminate the active AI session on a call. + + + + Resume an AI session that was on hold. + + + + Collect DTMF / speech input from the caller. + + + + Start input timers for a collect operation (useful when `initial_timeout` should be reset after media finishes playing). + + + + Stop an in-progress collect operation. + + + + + + Enable noise reduction on the call. + + + + Disable noise reduction. + + + + Run answering-machine / fax / DTMF detection. + + + + Stop an active detect operation. + + + + Place an outbound call. + + + + Drop one leg from a call without ending the other. + + + + Gracefully end a call. + + + + Start live transcription that emits events as speech is recognised. + + + + Start live translation between two languages. + + + + Start media playback on a call. + + + + Pause active playback. + + + + Resume paused playback. + + + + Stop active playback. + + + + Adjust the playback volume. + + + + Stop a receive-fax operation mid-stream. + + + + Start recording a call. + + + + Pause an active recording. + + + + Resume a paused recording. + + + + Stop and finalise a recording. + + + + Send a SIP REFER to transfer a call outside the platform. + + + + Stop a send-fax operation mid-stream. + + + + Start an outbound media stream (typically to a WebSocket endpoint). + + + + Stop an outbound media stream. + + + + Start a media tap (mirror audio to an external URI). + + + + Stop an active media tap. + + + + Start real-time transcription on the call. + + + + Stop real-time transcription. + + + + Transfer a call to another destination. + + + + Update properties on an in-progress call. + + + + Emit a custom user event on the call for your webhooks. + + + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 41. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/live-transcribe.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/live-transcribe.mdx new file mode 100644 index 0000000000..4682679fa5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/live-transcribe.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/live-transcribe" +title: "liveTranscribe" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.liveTranscribe" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `liveTranscribe` + +Start live transcription that emits events as speech is recognised. + +## Signature + +```typescript +liveTranscribe(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Configuration (languages, model, partials, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 463. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/live-translate.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/live-translate.mdx new file mode 100644 index 0000000000..bea5e82449 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/live-translate.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/live-translate" +title: "liveTranslate" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.liveTranslate" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `liveTranslate` + +Start live translation between two languages. + +## Signature + +```typescript +liveTranslate(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Configuration (`source_lang`, `target_lang`, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 476. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-pause.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-pause.mdx new file mode 100644 index 0000000000..a17715782e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-pause.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/play-pause" +title: "playPause" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.playPause" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `playPause` + +Pause active playback. + +## Signature + +```typescript +playPause(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id` from the matching `play()` call. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 140. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-resume.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-resume.mdx new file mode 100644 index 0000000000..5b084a3df2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-resume.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/play-resume" +title: "playResume" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.playResume" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `playResume` + +Resume paused playback. + +## Signature + +```typescript +playResume(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 152. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-stop.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-stop.mdx new file mode 100644 index 0000000000..07039bc286 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-stop.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/play-stop" +title: "playStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.playStop" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `playStop` + +Stop active playback. + +## Signature + +```typescript +playStop(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 164. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-volume.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-volume.mdx new file mode 100644 index 0000000000..c6459cfe48 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play-volume.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/play-volume" +title: "playVolume" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.playVolume" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `playVolume` + +Adjust the playback volume. + +## Signature + +```typescript +playVolume(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + `control_id` plus `volume` (integer dB). Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 176. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play.mdx new file mode 100644 index 0000000000..9b191e0019 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/play.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/play" +title: "play" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.play" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `play` + +Start media playback on a call. + +## Signature + +```typescript +play(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Playback parameters — see `Play` action schema. Defaults to `{}`. + + +## Returns + +`Promise` — The play command response, containing a `control_id` used to pause / resume / stop the playback later. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 127. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/receive-fax-stop.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/receive-fax-stop.mdx new file mode 100644 index 0000000000..a229440ce5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/receive-fax-stop.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/receive-fax-stop" +title: "receiveFaxStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.receiveFaxStop" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `receiveFaxStop` + +Stop a receive-fax operation mid-stream. + +## Signature + +```typescript +receiveFaxStop(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 502. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record-pause.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record-pause.mdx new file mode 100644 index 0000000000..d7ba0f3c88 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record-pause.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/record-pause" +title: "recordPause" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.recordPause" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `recordPause` + +Pause an active recording. + +## Signature + +```typescript +recordPause(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 203. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record-resume.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record-resume.mdx new file mode 100644 index 0000000000..8e97fbc993 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record-resume.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/record-resume" +title: "recordResume" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.recordResume" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `recordResume` + +Resume a paused recording. + +## Signature + +```typescript +recordResume(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 215. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record-stop.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record-stop.mdx new file mode 100644 index 0000000000..c50fd0bb73 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record-stop.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/record-stop" +title: "recordStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.recordStop" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `recordStop` + +Stop and finalise a recording. + +## Signature + +```typescript +recordStop(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The final recording metadata. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 227. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record.mdx new file mode 100644 index 0000000000..e80c93a7c7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/record.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/record" +title: "record" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.record" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `record` + +Start recording a call. + +## Signature + +```typescript +record(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Recording parameters (`record` config, callbacks, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The record command response containing a `control_id`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 191. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/refer.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/refer.mdx new file mode 100644 index 0000000000..c855f6b38f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/refer.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/refer" +title: "refer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.refer" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `refer` + +Send a SIP REFER to transfer a call outside the platform. + +## Signature + +```typescript +refer(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + REFER parameters (`refer_to`, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 516. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/send-fax-stop.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/send-fax-stop.mdx new file mode 100644 index 0000000000..cd0c745cc5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/send-fax-stop.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/send-fax-stop" +title: "sendFaxStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.sendFaxStop" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `sendFaxStop` + +Stop a send-fax operation mid-stream. + +## Signature + +```typescript +sendFaxStop(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 490. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/stream-stop.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/stream-stop.mdx new file mode 100644 index 0000000000..81b1c2935d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/stream-stop.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/stream-stop" +title: "streamStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.streamStop" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `streamStop` + +Stop an outbound media stream. + +## Signature + +```typescript +streamStop(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 346. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/stream.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/stream.mdx new file mode 100644 index 0000000000..faa5197a09 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/stream.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/stream" +title: "stream" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.stream" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `stream` + +Start an outbound media stream (typically to a WebSocket endpoint). + +## Signature + +```typescript +stream(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Stream configuration. Defaults to `{}`. + + +## Returns + +`Promise` — The stream command response containing a `control_id`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 334. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/tap-stop.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/tap-stop.mdx new file mode 100644 index 0000000000..486ef32279 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/tap-stop.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/tap-stop" +title: "tapStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.tapStop" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `tapStop` + +Stop an active media tap. + +## Signature + +```typescript +tapStop(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 320. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/tap.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/tap.mdx new file mode 100644 index 0000000000..587e8a63af --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/tap.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/tap" +title: "tap" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.tap" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `tap` + +Start a media tap (mirror audio to an external URI). + +## Signature + +```typescript +tap(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Tap configuration (`uri`, `direction`, `codec`, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The tap command response containing a `control_id`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 308. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/transcribe-stop.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/transcribe-stop.mdx new file mode 100644 index 0000000000..954ca544ae --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/transcribe-stop.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/transcribe-stop" +title: "transcribeStop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.transcribeStop" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `transcribeStop` + +Stop real-time transcription. + +## Signature + +```typescript +transcribeStop(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Must include `control_id`. Defaults to `{}`. + + +## Returns + +`Promise` — The final transcription metadata. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 398. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/transcribe.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/transcribe.mdx new file mode 100644 index 0000000000..8c203b91ea --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/transcribe.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/transcribe" +title: "transcribe" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.transcribe" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `transcribe` + +Start real-time transcription on the call. + +## Signature + +```typescript +transcribe(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Transcription configuration. Defaults to `{}`. + + +## Returns + +`Promise` — The transcribe command response containing a `control_id`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 386. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/transfer.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/transfer.mdx new file mode 100644 index 0000000000..503db58ae4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/transfer.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/transfer" +title: "transfer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.transfer" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `transfer` + +Transfer a call to another destination. + +## Signature + +```typescript +transfer(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Platform-shaped transfer parameters (`to`, `from`, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 100. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/update.mdx new file mode 100644 index 0000000000..b76ff3a892 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/update.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.update" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `update` + +Update properties on an in-progress call. + +## Signature + +```typescript +update(params: any = {}): Promise +``` + +## Parameters + + + Platform-shaped update parameters. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 75. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/user-event.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/user-event.mdx new file mode 100644 index 0000000000..d1b5e91d09 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/calling-namespace/user-event.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling/calling-namespace/user-event" +title: "userEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.calling.CallingNamespace.userEvent" + parent: "rest.namespaces.calling.CallingNamespace" + module: "rest.namespaces.calling" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `userEvent` + +Emit a custom user event on the call for your webhooks. + +## Signature + +```typescript +userEvent(callId: string, params: any = {}): Promise +``` + +## Parameters + + + Target call's ID. + + + + Event payload — freeform data delivered to your webhook. Defaults to `{}`. + + +## Returns + +`Promise` — The platform's response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 531. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/calling/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/calling/index.mdx new file mode 100644 index 0000000000..e88d741a4e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/calling/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/calling" +title: "calling" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.calling" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts" +--- +# `calling` + +## Signature + +```typescript +module calling +``` + +## Classes + + + + REST call control — all 37 commands dispatched via a single POST endpoint. + + + +## Source + +[`src/rest/namespaces/calling.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/calling.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/chat/chat-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/chat/chat-resource/constructor.mdx new file mode 100644 index 0000000000..d6519546f5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/chat/chat-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/chat/chat-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.chat.ChatResource.constructor" + parent: "rest.namespaces.chat.ChatResource" + module: "rest.namespaces.chat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/chat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): ChatResource +``` + +## Parameters + + + +## Returns + +`ChatResource` + +## Source + +[`src/rest/namespaces/chat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/chat.ts) + +Line 17. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/chat/chat-resource/create-token.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/chat/chat-resource/create-token.mdx new file mode 100644 index 0000000000..5585b4bc87 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/chat/chat-resource/create-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/chat/chat-resource/create-token" +title: "createToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.chat.ChatResource.createToken" + parent: "rest.namespaces.chat.ChatResource" + module: "rest.namespaces.chat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/chat.ts" +--- +# `createToken` + +Generate a short-lived Chat token. + +## Signature + +```typescript +createToken(body: any): Promise +``` + +## Parameters + + + Token payload (e.g. `{ room_name, user_name, permissions }`). + + +## Returns + +`Promise` — The token record, typically `{ token: "eyJ..." }`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/chat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/chat.ts) + +Line 28. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/chat/chat-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/chat/chat-resource/index.mdx new file mode 100644 index 0000000000..73af0fe886 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/chat/chat-resource/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/rest/namespaces/chat/chat-resource" +title: "ChatResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.chat.ChatResource" + parent: "rest.namespaces.chat" + module: "rest.namespaces.chat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/chat.ts" +--- +# `ChatResource` + +Chat token generation. + +Access via `client.chat.*`. Issues short-lived tokens that end-user clients +use to join chat channels. + +## Signature + +```typescript +class ChatResource extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Generate a short-lived Chat token. + + + +## Source + +[`src/rest/namespaces/chat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/chat.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/chat/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/chat/index.mdx new file mode 100644 index 0000000000..ef49a59481 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/chat/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/chat" +title: "chat" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.chat" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/chat.ts" +--- +# `chat` + +## Signature + +```typescript +module chat +``` + +## Classes + + + + Chat token generation. + + + +## Source + +[`src/rest/namespaces/chat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/chat.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/constructor.mdx new file mode 100644 index 0000000000..e250519ba7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-accounts/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatAccounts.constructor" + parent: "rest.namespaces.compat.CompatAccounts" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): CompatAccounts +``` + +## Parameters + + + +## Returns + +`CompatAccounts` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/create.mdx new file mode 100644 index 0000000000..edc66fe0b1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-accounts/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatAccounts.create" + parent: "rest.namespaces.compat.CompatAccounts" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `create` + +Create a new sub-account under the authenticated parent account. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Account payload (`FriendlyName`, etc.) — LAML form keys. + + +## Returns + +`Promise` — The newly-created account record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 38. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/get.mdx new file mode 100644 index 0000000000..239129fe63 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-accounts/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatAccounts.get" + parent: "rest.namespaces.compat.CompatAccounts" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `get` + +Fetch an account by SID. + +## Signature + +```typescript +get(sid: string): Promise +``` + +## Parameters + + + Account SID (e.g. `"AC..."`). + + +## Returns + +`Promise` — The account record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 49. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/index.mdx new file mode 100644 index 0000000000..454b4c9827 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-accounts" +title: "CompatAccounts" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatAccounts" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatAccounts` + +Compat account / subproject management (Twilio-compatible LAML). + +## Signature + +```typescript +class CompatAccounts extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Create a new sub-account under the authenticated parent account. + + + + Fetch an account by SID. + + + + List accounts visible to the authenticated project. + + + + Update an account's attributes. LAML uses `POST` (not PATCH/PUT). + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 15. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/list.mdx new file mode 100644 index 0000000000..9c3e36ba5f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-accounts/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatAccounts.list" + parent: "rest.namespaces.compat.CompatAccounts" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `list` + +List accounts visible to the authenticated project. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A LAML-shaped paginated account list. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 27. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/update.mdx new file mode 100644 index 0000000000..75db390bb9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-accounts/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-accounts/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatAccounts.update" + parent: "rest.namespaces.compat.CompatAccounts" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `update` + +Update an account's attributes. LAML uses `POST` (not PATCH/PUT). + +## Signature + +```typescript +update(sid: string, body: any = {}): Promise +``` + +## Parameters + + + Account SID. + + + + Partial update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The updated account record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 61. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/constructor.mdx new file mode 100644 index 0000000000..98bdb00cf0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-applications/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatApplications.constructor" + parent: "rest.namespaces.compat.CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CompatApplications +``` + +## Parameters + + + + + +## Returns + +`CompatApplications` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 536. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/create.mdx new file mode 100644 index 0000000000..f5340c6e8b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-applications/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatApplications.create" + parent: "rest.namespaces.compat.CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/delete.mdx new file mode 100644 index 0000000000..665d033089 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-applications/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatApplications.delete" + parent: "rest.namespaces.compat.CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/get.mdx new file mode 100644 index 0000000000..a2d9d0b269 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-applications/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatApplications.get" + parent: "rest.namespaces.compat.CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/index.mdx new file mode 100644 index 0000000000..faab4ed03f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-applications" +title: "CompatApplications" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatApplications" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatApplications` + +Compat application management (LAML-style `Applications`). + +## Signature + +```typescript +class CompatApplications extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + Update an application. LAML uses `POST` (not PATCH/PUT). + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 535. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/list.mdx new file mode 100644 index 0000000000..1c80b4709b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-applications/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatApplications.list" + parent: "rest.namespaces.compat.CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/update.mdx new file mode 100644 index 0000000000..ce5ab37335 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-applications/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-applications/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatApplications.update" + parent: "rest.namespaces.compat.CompatApplications" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `update` + +Update an application. LAML uses `POST` (not PATCH/PUT). + +## Signature + +```typescript +update(sid: string, body: any = {}): Promise +``` + +## Parameters + + + Application SID (e.g. `"AP..."`). + + + + LAML-form update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The updated application record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 548. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/constructor.mdx new file mode 100644 index 0000000000..f458a24f89 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-calls/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatCalls.constructor" + parent: "rest.namespaces.compat.CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CompatCalls +``` + +## Parameters + + + + + +## Returns + +`CompatCalls` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 68. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/create.mdx new file mode 100644 index 0000000000..aa7821bc27 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-calls/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatCalls.create" + parent: "rest.namespaces.compat.CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/delete.mdx new file mode 100644 index 0000000000..2236305912 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-calls/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatCalls.delete" + parent: "rest.namespaces.compat.CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/get.mdx new file mode 100644 index 0000000000..a4d3894ed3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-calls/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatCalls.get" + parent: "rest.namespaces.compat.CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/index.mdx new file mode 100644 index 0000000000..16c1f1e37a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/index.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-calls" +title: "CompatCalls" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatCalls" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatCalls` + +Compat call management with recording and stream sub-resources. + +## Signature + +```typescript +class CompatCalls extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + Start recording an active call. + + + + Start a media stream on an active call (WebSocket media forwarding). + + + + Stop an active media stream on a call. + + + + Update an in-progress or past call. LAML uses `POST` (not PATCH/PUT). + + + + Update an active recording (e.g. `Status=paused` / `Status=stopped`). + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 67. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/list.mdx new file mode 100644 index 0000000000..2d2c620f6a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-calls/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatCalls.list" + parent: "rest.namespaces.compat.CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/start-recording.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/start-recording.mdx new file mode 100644 index 0000000000..2a7afffb40 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/start-recording.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-calls/start-recording" +title: "startRecording" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatCalls.startRecording" + parent: "rest.namespaces.compat.CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `startRecording` + +Start recording an active call. + +## Signature + +```typescript +startRecording(callSid: string, body: any = {}): Promise +``` + +## Parameters + + + Call SID. + + + + Recording parameters (channels, trim, status callback, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The newly-started recording record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 93. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/start-stream.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/start-stream.mdx new file mode 100644 index 0000000000..5ef31e4e43 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/start-stream.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-calls/start-stream" +title: "startStream" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatCalls.startStream" + parent: "rest.namespaces.compat.CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `startStream` + +Start a media stream on an active call (WebSocket media forwarding). + +## Signature + +```typescript +startStream(callSid: string, body: any = {}): Promise +``` + +## Parameters + + + Call SID. + + + + Stream parameters (URL, track, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The newly-started stream record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 118. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/stop-stream.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/stop-stream.mdx new file mode 100644 index 0000000000..4c6350e8c9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/stop-stream.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-calls/stop-stream" +title: "stopStream" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatCalls.stopStream" + parent: "rest.namespaces.compat.CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `stopStream` + +Stop an active media stream on a call. + +## Signature + +```typescript +stopStream(callSid: string, streamSid: string, body: any = {}): Promise +``` + +## Parameters + + + Call SID. + + + + Stream SID returned by [startStream](/reference/typescript/rest/namespaces/compat/compat-calls/start-stream). + + + + Update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The stopped stream record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 131. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/update-recording.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/update-recording.mdx new file mode 100644 index 0000000000..f80573118a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/update-recording.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-calls/update-recording" +title: "updateRecording" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatCalls.updateRecording" + parent: "rest.namespaces.compat.CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `updateRecording` + +Update an active recording (e.g. `Status=paused` / `Status=stopped`). + +## Signature + +```typescript +updateRecording( + callSid: string, + recordingSid: string, + body: any = {} +): Promise +``` + +## Parameters + + + Call SID. + + + + Recording SID returned by [startRecording](/reference/typescript/rest/namespaces/compat/compat-calls/start-recording). + + + + Update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The updated recording record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 106. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/update.mdx new file mode 100644 index 0000000000..482f16b49e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-calls/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-calls/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatCalls.update" + parent: "rest.namespaces.compat.CompatCalls" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `update` + +Update an in-progress or past call. LAML uses `POST` (not PATCH/PUT). + +## Signature + +```typescript +update(sid: string, body: any = {}): Promise +``` + +## Parameters + + + Call SID (e.g. `"CA..."`). + + + + LAML-form update payload (`Status`, `Url`, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The updated call record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 80. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/constructor.mdx new file mode 100644 index 0000000000..2c16e6ef72 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.constructor" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CompatConferences +``` + +## Parameters + + + + + +## Returns + +`CompatConferences` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 248. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/delete-recording.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/delete-recording.mdx new file mode 100644 index 0000000000..72fd91b403 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/delete-recording.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/delete-recording" +title: "deleteRecording" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.deleteRecording" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `deleteRecording` + +Delete a conference recording. + +## Signature + +```typescript +deleteRecording(conferenceSid: string, recordingSid: string): Promise +``` + +## Parameters + + + Conference SID. + + + + Recording SID. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 386. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/get-participant.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/get-participant.mdx new file mode 100644 index 0000000000..25dd41068f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/get-participant.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/get-participant" +title: "getParticipant" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.getParticipant" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `getParticipant` + +Fetch a specific participant (by its call SID) in a conference. + +## Signature + +```typescript +getParticipant(conferenceSid: string, callSid: string): Promise +``` + +## Parameters + + + Conference SID. + + + + Participant's call SID. + + +## Returns + +`Promise` — The participant record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 309. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/get-recording.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/get-recording.mdx new file mode 100644 index 0000000000..6dc78f03c0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/get-recording.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/get-recording" +title: "getRecording" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.getRecording" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `getRecording` + +Fetch a specific conference recording. + +## Signature + +```typescript +getRecording(conferenceSid: string, recordingSid: string): Promise +``` + +## Parameters + + + Conference SID. + + + + Recording SID. + + +## Returns + +`Promise` — The recording record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 361. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/get.mdx new file mode 100644 index 0000000000..8c672ffdca --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.get" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `get` + +Fetch a conference by SID. + +## Signature + +```typescript +get(sid: string): Promise +``` + +## Parameters + + + Conference SID (e.g. `"CF..."`). + + +## Returns + +`Promise` — The conference record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 270. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/index.mdx new file mode 100644 index 0000000000..cfbb5986ce --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/index.mdx @@ -0,0 +1,91 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences" +title: "CompatConferences" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatConferences` + +Compat conference management with participants, recordings, and streams. + +## Signature + +```typescript +class CompatConferences extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Delete a conference recording. + + + + Fetch a conference by SID. + + + + Fetch a specific participant (by its call SID) in a conference. + + + + Fetch a specific conference recording. + + + + List conferences in the account. + + + + List participants in a conference. + + + + List recordings taken of a conference. + + + + Remove a participant from a conference (kick). + + + + Start a media stream on a conference. + + + + Stop an active conference media stream. + + + + Update a conference (e.g. `Status=completed` to terminate). LAML uses `POST` (not PATCH/PUT). + + + + Update a participant (mute, hold, announce, etc.). LAML uses `POST`. + + + + Update an active conference recording (pause, resume, stop). LAML uses `POST`. + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 247. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/list-participants.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/list-participants.mdx new file mode 100644 index 0000000000..6cc5d16894 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/list-participants.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/list-participants" +title: "listParticipants" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.listParticipants" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `listParticipants` + +List participants in a conference. + +## Signature + +```typescript +listParticipants(conferenceSid: string, params?: QueryParams): Promise +``` + +## Parameters + + + Conference SID. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of participants. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 297. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/list-recordings.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/list-recordings.mdx new file mode 100644 index 0000000000..67eaccb23e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/list-recordings.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/list-recordings" +title: "listRecordings" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.listRecordings" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `listRecordings` + +List recordings taken of a conference. + +## Signature + +```typescript +listRecordings(conferenceSid: string, params?: QueryParams): Promise +``` + +## Parameters + + + Conference SID. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of recordings. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 349. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/list.mdx new file mode 100644 index 0000000000..6f62b4aee7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.list" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `list` + +List conferences in the account. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of conferences. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 259. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/remove-participant.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/remove-participant.mdx new file mode 100644 index 0000000000..795bf2b922 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/remove-participant.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/remove-participant" +title: "removeParticipant" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.removeParticipant" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `removeParticipant` + +Remove a participant from a conference (kick). + +## Signature + +```typescript +removeParticipant(conferenceSid: string, callSid: string): Promise +``` + +## Parameters + + + Conference SID. + + + + Participant's call SID. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 335. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/start-stream.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/start-stream.mdx new file mode 100644 index 0000000000..02fdedd2d9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/start-stream.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/start-stream" +title: "startStream" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.startStream" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `startStream` + +Start a media stream on a conference. + +## Signature + +```typescript +startStream(conferenceSid: string, body: any = {}): Promise +``` + +## Parameters + + + Conference SID. + + + + Stream parameters (URL, track, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The newly-started stream record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 400. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/stop-stream.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/stop-stream.mdx new file mode 100644 index 0000000000..abe10c9ed8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/stop-stream.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/stop-stream" +title: "stopStream" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.stopStream" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `stopStream` + +Stop an active conference media stream. + +## Signature + +```typescript +stopStream( + conferenceSid: string, + streamSid: string, + body: any = {} +): Promise +``` + +## Parameters + + + Conference SID. + + + + Stream SID returned by [startStream](/reference/typescript/rest/namespaces/compat/compat-conferences/start-stream). + + + + Update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The stopped stream record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 413. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/update-participant.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/update-participant.mdx new file mode 100644 index 0000000000..016750f758 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/update-participant.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/update-participant" +title: "updateParticipant" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.updateParticipant" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `updateParticipant` + +Update a participant (mute, hold, announce, etc.). LAML uses `POST`. + +## Signature + +```typescript +updateParticipant( + conferenceSid: string, + callSid: string, + body: any = {} +): Promise +``` + +## Parameters + + + Conference SID. + + + + Participant's call SID. + + + + LAML-form update payload (e.g. `{ Muted: 'true' }`). Defaults to `{}`. + + +## Returns + +`Promise` — The updated participant record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 323. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/update-recording.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/update-recording.mdx new file mode 100644 index 0000000000..44aa186db5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/update-recording.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/update-recording" +title: "updateRecording" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.updateRecording" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `updateRecording` + +Update an active conference recording (pause, resume, stop). LAML uses `POST`. + +## Signature + +```typescript +updateRecording( + conferenceSid: string, + recordingSid: string, + body: any = {} +): Promise +``` + +## Parameters + + + Conference SID. + + + + Recording SID. + + + + LAML-form update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The updated recording record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 374. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/update.mdx new file mode 100644 index 0000000000..7bb2063ccd --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-conferences/update.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-conferences/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatConferences.update" + parent: "rest.namespaces.compat.CompatConferences" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `update` + +Update a conference (e.g. `Status=completed` to terminate). +LAML uses `POST` (not PATCH/PUT). + +## Signature + +```typescript +update(sid: string, body: any = {}): Promise +``` + +## Parameters + + + Conference SID. + + + + LAML-form update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The updated conference record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 283. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/constructor.mdx new file mode 100644 index 0000000000..59aa208d61 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-faxes/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatFaxes.constructor" + parent: "rest.namespaces.compat.CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CompatFaxes +``` + +## Parameters + + + + + +## Returns + +`CompatFaxes` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 193. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/create.mdx new file mode 100644 index 0000000000..89ba9a8c22 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-faxes/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatFaxes.create" + parent: "rest.namespaces.compat.CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/delete-media.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/delete-media.mdx new file mode 100644 index 0000000000..8bac4a9ceb --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/delete-media.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-faxes/delete-media" +title: "deleteMedia" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatFaxes.deleteMedia" + parent: "rest.namespaces.compat.CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `deleteMedia` + +Delete a media attachment from a fax. + +## Signature + +```typescript +deleteMedia(faxSid: string, mediaSid: string): Promise +``` + +## Parameters + + + Fax SID. + + + + Media SID. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 241. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/delete.mdx new file mode 100644 index 0000000000..6949a93d64 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-faxes/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatFaxes.delete" + parent: "rest.namespaces.compat.CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/get-media.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/get-media.mdx new file mode 100644 index 0000000000..686d9c5134 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/get-media.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-faxes/get-media" +title: "getMedia" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatFaxes.getMedia" + parent: "rest.namespaces.compat.CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `getMedia` + +Fetch a specific media attachment on a fax. + +## Signature + +```typescript +getMedia(faxSid: string, mediaSid: string): Promise +``` + +## Parameters + + + Fax SID. + + + + Media SID. + + +## Returns + +`Promise` — The media record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 229. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/get.mdx new file mode 100644 index 0000000000..a6dc89a576 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-faxes/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatFaxes.get" + parent: "rest.namespaces.compat.CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/index.mdx new file mode 100644 index 0000000000..be42a1ac0e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-faxes" +title: "CompatFaxes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatFaxes" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatFaxes` + +Compat fax management with media sub-resources. + +## Signature + +```typescript +class CompatFaxes extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Delete a media attachment from a fax. + + + + Fetch a single resource by ID. + + + + Fetch a specific media attachment on a fax. + + + + List resources with optional query parameters. + + + + List media attachments for a fax. + + + + Update a fax. LAML uses `POST` (not PATCH/PUT). + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 192. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/list-media.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/list-media.mdx new file mode 100644 index 0000000000..3dd7cddd0a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/list-media.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-faxes/list-media" +title: "listMedia" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatFaxes.listMedia" + parent: "rest.namespaces.compat.CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `listMedia` + +List media attachments for a fax. + +## Signature + +```typescript +listMedia(faxSid: string, params?: QueryParams): Promise +``` + +## Parameters + + + Fax SID. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of media records. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 217. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/list.mdx new file mode 100644 index 0000000000..b04b10dc9b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-faxes/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatFaxes.list" + parent: "rest.namespaces.compat.CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/update.mdx new file mode 100644 index 0000000000..00a920c8cc --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-faxes/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-faxes/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatFaxes.update" + parent: "rest.namespaces.compat.CompatFaxes" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `update` + +Update a fax. LAML uses `POST` (not PATCH/PUT). + +## Signature + +```typescript +update(sid: string, body: any = {}): Promise +``` + +## Parameters + + + Fax SID (e.g. `"FX..."`). + + + + LAML-form update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The updated fax record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 205. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/constructor.mdx new file mode 100644 index 0000000000..629c1918db --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-laml-bins/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatLamlBins.constructor" + parent: "rest.namespaces.compat.CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CompatLamlBins +``` + +## Parameters + + + + + +## Returns + +`CompatLamlBins` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 555. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/create.mdx new file mode 100644 index 0000000000..f2bef00989 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-laml-bins/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatLamlBins.create" + parent: "rest.namespaces.compat.CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/delete.mdx new file mode 100644 index 0000000000..7805239276 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-laml-bins/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatLamlBins.delete" + parent: "rest.namespaces.compat.CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/get.mdx new file mode 100644 index 0000000000..bfb5b2933b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-laml-bins/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatLamlBins.get" + parent: "rest.namespaces.compat.CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/index.mdx new file mode 100644 index 0000000000..8f89e1697d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-laml-bins" +title: "CompatLamlBins" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatLamlBins" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatLamlBins` + +Compat cXML / LaML Bin management. + +## Signature + +```typescript +class CompatLamlBins extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + Update a LaML Bin's stored script. LAML uses `POST` (not PATCH/PUT). + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 554. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/list.mdx new file mode 100644 index 0000000000..09437610dc --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-laml-bins/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatLamlBins.list" + parent: "rest.namespaces.compat.CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/update.mdx new file mode 100644 index 0000000000..16d0ced206 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-laml-bins/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-laml-bins/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatLamlBins.update" + parent: "rest.namespaces.compat.CompatLamlBins" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `update` + +Update a LaML Bin's stored script. LAML uses `POST` (not PATCH/PUT). + +## Signature + +```typescript +update(sid: string, body: any = {}): Promise +``` + +## Parameters + + + LaML Bin SID (e.g. `"LA..."`). + + + + Payload containing the new `VoiceMethod`, `Url`, etc. Defaults to `{}`. + + +## Returns + +`Promise` — The updated LaML Bin record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 568. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/constructor.mdx new file mode 100644 index 0000000000..c2b051dc6e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-messages/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatMessages.constructor" + parent: "rest.namespaces.compat.CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CompatMessages +``` + +## Parameters + + + + + +## Returns + +`CompatMessages` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 138. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/create.mdx new file mode 100644 index 0000000000..d416bef336 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-messages/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatMessages.create" + parent: "rest.namespaces.compat.CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/delete-media.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/delete-media.mdx new file mode 100644 index 0000000000..2e1f9d9f4f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/delete-media.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-messages/delete-media" +title: "deleteMedia" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatMessages.deleteMedia" + parent: "rest.namespaces.compat.CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `deleteMedia` + +Delete a media attachment from a message. + +## Signature + +```typescript +deleteMedia(messageSid: string, mediaSid: string): Promise +``` + +## Parameters + + + Message SID. + + + + Media SID. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 186. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/delete.mdx new file mode 100644 index 0000000000..ed1ad21e86 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-messages/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatMessages.delete" + parent: "rest.namespaces.compat.CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/get-media.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/get-media.mdx new file mode 100644 index 0000000000..d1fc08c00b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/get-media.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-messages/get-media" +title: "getMedia" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatMessages.getMedia" + parent: "rest.namespaces.compat.CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `getMedia` + +Fetch a specific media attachment on a message. + +## Signature + +```typescript +getMedia(messageSid: string, mediaSid: string): Promise +``` + +## Parameters + + + Message SID. + + + + Media SID. + + +## Returns + +`Promise` — The media record (metadata + URL). + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 174. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/get.mdx new file mode 100644 index 0000000000..e382e031a8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-messages/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatMessages.get" + parent: "rest.namespaces.compat.CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/index.mdx new file mode 100644 index 0000000000..e862320591 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-messages" +title: "CompatMessages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatMessages" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatMessages` + +Compat message management with media sub-resources. + +## Signature + +```typescript +class CompatMessages extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Delete a media attachment from a message. + + + + Fetch a single resource by ID. + + + + Fetch a specific media attachment on a message. + + + + List resources with optional query parameters. + + + + List media attachments for a message (MMS). + + + + Update a message. LAML uses `POST` (not PATCH/PUT). + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 137. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/list-media.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/list-media.mdx new file mode 100644 index 0000000000..281866f781 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/list-media.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-messages/list-media" +title: "listMedia" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatMessages.listMedia" + parent: "rest.namespaces.compat.CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `listMedia` + +List media attachments for a message (MMS). + +## Signature + +```typescript +listMedia(messageSid: string, params?: QueryParams): Promise +``` + +## Parameters + + + Message SID. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of media records. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 162. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/list.mdx new file mode 100644 index 0000000000..f329cc5a7a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-messages/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatMessages.list" + parent: "rest.namespaces.compat.CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/update.mdx new file mode 100644 index 0000000000..f718c983c0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-messages/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-messages/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatMessages.update" + parent: "rest.namespaces.compat.CompatMessages" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `update` + +Update a message. LAML uses `POST` (not PATCH/PUT). + +## Signature + +```typescript +update(sid: string, body: any = {}): Promise +``` + +## Parameters + + + Message SID (e.g. `"SM..."` / `"MM..."`). + + + + LAML-form update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The updated message record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 150. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-namespace/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-namespace/constructor.mdx new file mode 100644 index 0000000000..42514cc615 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-namespace/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-namespace/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatNamespace.constructor" + parent: "rest.namespaces.compat.CompatNamespace" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, accountSid: string): CompatNamespace +``` + +## Parameters + + + + + +## Returns + +`CompatNamespace` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 796. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-namespace/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-namespace/index.mdx new file mode 100644 index 0000000000..bfbdc96078 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-namespace/index.mdx @@ -0,0 +1,100 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-namespace" +title: "CompatNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatNamespace" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatNamespace` + +Twilio-compatible LAML API namespace with AccountSid scoping. + +Access via `client.compat.*`. This is the legacy LAML (cXML) surface for code +migrated from Twilio — all updates use POST bodies instead of REST-idiomatic +PATCH/PUT. Prefer the native SignalWire namespaces (`client.calling`, `client.fabric`, +etc.) for greenfield projects. + +## Signature + +```typescript +class CompatNamespace +``` + +## Examples + +```typescript +await client.compat.messages.create({ + From: '+15551112222', + To: '+15553334444', + Body: 'Hello from SignalWire!', +}); +``` + +## Properties + + + Main and sub-account CRUD. + + + + LAML Application CRUD. + + + + Call CRUD plus recording / stream sub-resource management. + + + + Conference read / update with participants, recordings, and streams. + + + + Fax CRUD plus media sub-resource management. + + + + LaML Bin (hosted script) CRUD. + + + + Message CRUD plus media sub-resource management. + + + + Phone number CRUD plus search / purchase / import helpers. + + + + Queue CRUD plus member list / fetch / dequeue. + + + + Recording list / fetch / delete. + + + + Compat API token create / update / delete. + + + + Transcription list / fetch / delete. + + +## Methods + + + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 770. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/constructor.mdx new file mode 100644 index 0000000000..38670dc5d9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-phone-numbers/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatPhoneNumbers.constructor" + parent: "rest.namespaces.compat.CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CompatPhoneNumbers +``` + +## Parameters + + + + + +## Returns + +`CompatPhoneNumbers` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 422. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/delete.mdx new file mode 100644 index 0000000000..145323d87c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-phone-numbers/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatPhoneNumbers.delete" + parent: "rest.namespaces.compat.CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `delete` + +Release an owned phone number (delete). + +## Signature + +```typescript +delete(sid: string): Promise +``` + +## Parameters + + + Phone number SID. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 481. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/get.mdx new file mode 100644 index 0000000000..096759d41e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-phone-numbers/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatPhoneNumbers.get" + parent: "rest.namespaces.compat.CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `get` + +Fetch an owned phone number by SID. + +## Signature + +```typescript +get(sid: string): Promise +``` + +## Parameters + + + Phone number SID (e.g. `"PN..."`). + + +## Returns + +`Promise` — The phone-number record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 457. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/import-number.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/import-number.mdx new file mode 100644 index 0000000000..10adfa8c07 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/import-number.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-phone-numbers/import-number" +title: "importNumber" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatPhoneNumbers.importNumber" + parent: "rest.namespaces.compat.CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `importNumber` + +Import an externally-hosted phone number into the account +(LAML `/ImportedPhoneNumbers`). + +## Signature + +```typescript +importNumber(body: any): Promise +``` + +## Parameters + + + Import payload (number, carrier details, etc.). + + +## Returns + +`Promise` — The newly-imported number record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 493. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/index.mdx new file mode 100644 index 0000000000..63c419eb55 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/index.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-phone-numbers" +title: "CompatPhoneNumbers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatPhoneNumbers" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatPhoneNumbers` + +Compat phone number management with searching, purchasing, and import. + +## Signature + +```typescript +class CompatPhoneNumbers extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Release an owned phone number (delete). + + + + Fetch an owned phone number by SID. + + + + Import an externally-hosted phone number into the account (LAML `/ImportedPhoneNumbers`). + + + + List owned incoming phone numbers in the account. + + + + List countries in which numbers are available for purchase. + + + + Purchase a phone number (LAML `POST /IncomingPhoneNumbers`). + + + + Search for available local phone numbers in a country. + + + + Search for available toll-free phone numbers in a country. + + + + Update an owned phone number (webhook URLs, friendly name, etc.). LAML uses `POST`. + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 419. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/list-available-countries.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/list-available-countries.mdx new file mode 100644 index 0000000000..7bc8f42e70 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/list-available-countries.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-phone-numbers/list-available-countries" +title: "listAvailableCountries" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatPhoneNumbers.listAvailableCountries" + parent: "rest.namespaces.compat.CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `listAvailableCountries` + +List countries in which numbers are available for purchase. + +## Signature + +```typescript +listAvailableCountries(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of country records with capabilities. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 505. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/list.mdx new file mode 100644 index 0000000000..fb0e2aa198 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-phone-numbers/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatPhoneNumbers.list" + parent: "rest.namespaces.compat.CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `list` + +List owned incoming phone numbers in the account. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of owned numbers. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 434. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/purchase.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/purchase.mdx new file mode 100644 index 0000000000..91e15c457d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/purchase.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-phone-numbers/purchase" +title: "purchase" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatPhoneNumbers.purchase" + parent: "rest.namespaces.compat.CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `purchase` + +Purchase a phone number (LAML `POST /IncomingPhoneNumbers`). + +## Signature + +```typescript +purchase(body: any): Promise +``` + +## Parameters + + + Purchase payload, typically including `PhoneNumber` or `AreaCode` plus webhook URLs. + + +## Returns + +`Promise` — The newly-purchased phone-number record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 446. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/search-local.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/search-local.mdx new file mode 100644 index 0000000000..7676e86dfb --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/search-local.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-phone-numbers/search-local" +title: "searchLocal" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatPhoneNumbers.searchLocal" + parent: "rest.namespaces.compat.CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `searchLocal` + +Search for available local phone numbers in a country. + +## Signature + +```typescript +searchLocal(country: string, params?: QueryParams): Promise +``` + +## Parameters + + + ISO-3166 country code (e.g. `"US"`, `"CA"`). + + + + Search filters (`AreaCode`, `Contains`, `NearNumber`, etc.). + + +## Returns + +`Promise` — A paginated list of available local numbers. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 517. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/search-toll-free.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/search-toll-free.mdx new file mode 100644 index 0000000000..9d81e01b91 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/search-toll-free.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-phone-numbers/search-toll-free" +title: "searchTollFree" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatPhoneNumbers.searchTollFree" + parent: "rest.namespaces.compat.CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `searchTollFree` + +Search for available toll-free phone numbers in a country. + +## Signature + +```typescript +searchTollFree(country: string, params?: QueryParams): Promise +``` + +## Parameters + + + ISO-3166 country code. + + + + Search filters (`Contains`, `NearNumber`, etc.). + + +## Returns + +`Promise` — A paginated list of available toll-free numbers. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 529. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/update.mdx new file mode 100644 index 0000000000..70adebe02f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-phone-numbers/update.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-phone-numbers/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatPhoneNumbers.update" + parent: "rest.namespaces.compat.CompatPhoneNumbers" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `update` + +Update an owned phone number (webhook URLs, friendly name, etc.). +LAML uses `POST`. + +## Signature + +```typescript +update(sid: string, body: any = {}): Promise +``` + +## Parameters + + + Phone number SID. + + + + LAML-form update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The updated phone-number record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 470. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/constructor.mdx new file mode 100644 index 0000000000..16a7f629a4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-queues/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatQueues.constructor" + parent: "rest.namespaces.compat.CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CompatQueues +``` + +## Parameters + + + + + +## Returns + +`CompatQueues` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 575. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/create.mdx new file mode 100644 index 0000000000..08eaf57714 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-queues/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatQueues.create" + parent: "rest.namespaces.compat.CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/delete.mdx new file mode 100644 index 0000000000..65bb05aba6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-queues/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatQueues.delete" + parent: "rest.namespaces.compat.CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/dequeue-member.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/dequeue-member.mdx new file mode 100644 index 0000000000..4118aebe2b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/dequeue-member.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-queues/dequeue-member" +title: "dequeueMember" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatQueues.dequeueMember" + parent: "rest.namespaces.compat.CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `dequeueMember` + +Dequeue a member — LAML's `POST` on a queued call redirects it to the +given `Url` (typically to connect the caller to a queue consumer). + +## Signature + +```typescript +dequeueMember(queueSid: string, callSid: string, body: any = {}): Promise +``` + +## Parameters + + + Queue SID. + + + + Call SID of the queued member. + + + + LAML-form payload (commonly `{ Url, Method }`). Defaults to `{}`. + + +## Returns + +`Promise` — The updated queue-member record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 626. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/get-member.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/get-member.mdx new file mode 100644 index 0000000000..4da9b2aed9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/get-member.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-queues/get-member" +title: "getMember" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatQueues.getMember" + parent: "rest.namespaces.compat.CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `getMember` + +Fetch a specific member (by call SID) currently waiting in a queue. + +## Signature + +```typescript +getMember(queueSid: string, callSid: string): Promise +``` + +## Parameters + + + Queue SID. + + + + Call SID of the queued member. + + +## Returns + +`Promise` — The queue-member record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 611. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/get.mdx new file mode 100644 index 0000000000..0d62c627fe --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-queues/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatQueues.get" + parent: "rest.namespaces.compat.CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/index.mdx new file mode 100644 index 0000000000..5afe096f1e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-queues" +title: "CompatQueues" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatQueues" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatQueues` + +Compat queue management with member operations. + +## Signature + +```typescript +class CompatQueues extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Dequeue a member — LAML's `POST` on a queued call redirects it to the given `Url` (typically to connect the caller to a queue consumer). + + + + Fetch a single resource by ID. + + + + Fetch a specific member (by call SID) currently waiting in a queue. + + + + List resources with optional query parameters. + + + + List members (calls) currently waiting in a queue. + + + + Update a queue. LAML uses `POST` (not PATCH/PUT). + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 574. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/list-members.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/list-members.mdx new file mode 100644 index 0000000000..4674af76a3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/list-members.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-queues/list-members" +title: "listMembers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatQueues.listMembers" + parent: "rest.namespaces.compat.CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `listMembers` + +List members (calls) currently waiting in a queue. + +## Signature + +```typescript +listMembers(queueSid: string, params?: QueryParams): Promise +``` + +## Parameters + + + Queue SID. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of queue members. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 599. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/list.mdx new file mode 100644 index 0000000000..c44168bf51 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-queues/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatQueues.list" + parent: "rest.namespaces.compat.CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/update.mdx new file mode 100644 index 0000000000..44ead3e327 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-queues/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-queues/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatQueues.update" + parent: "rest.namespaces.compat.CompatQueues" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `update` + +Update a queue. LAML uses `POST` (not PATCH/PUT). + +## Signature + +```typescript +update(sid: string, body: any = {}): Promise +``` + +## Parameters + + + Queue SID (e.g. `"QU..."`). + + + + LAML-form update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The updated queue record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 587. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/constructor.mdx new file mode 100644 index 0000000000..acee16a29e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-recordings/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatRecordings.constructor" + parent: "rest.namespaces.compat.CompatRecordings" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CompatRecordings +``` + +## Parameters + + + + + +## Returns + +`CompatRecordings` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 633. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/delete.mdx new file mode 100644 index 0000000000..8fe382005b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-recordings/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatRecordings.delete" + parent: "rest.namespaces.compat.CompatRecordings" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `delete` + +Delete a recording. + +## Signature + +```typescript +delete(sid: string): Promise +``` + +## Parameters + + + Recording SID. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 667. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/get.mdx new file mode 100644 index 0000000000..0651629480 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-recordings/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatRecordings.get" + parent: "rest.namespaces.compat.CompatRecordings" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `get` + +Fetch a recording by SID. + +## Signature + +```typescript +get(sid: string): Promise +``` + +## Parameters + + + Recording SID (e.g. `"RE..."`). + + +## Returns + +`Promise` — The recording record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 656. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/index.mdx new file mode 100644 index 0000000000..1a8c4a0c51 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-recordings" +title: "CompatRecordings" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatRecordings" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatRecordings` + +Compat recording management (list / get / delete). + +## Signature + +```typescript +class CompatRecordings extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Delete a recording. + + + + Fetch a recording by SID. + + + + List recordings in the account. + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 632. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/list.mdx new file mode 100644 index 0000000000..375a5b2bba --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-recordings/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-recordings/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatRecordings.list" + parent: "rest.namespaces.compat.CompatRecordings" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `list` + +List recordings in the account. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters (date range, call SID, conference SID, etc.). + + +## Returns + +`Promise` — A paginated list of recordings. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 645. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/constructor.mdx new file mode 100644 index 0000000000..0026644a1d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-tokens/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatTokens.constructor" + parent: "rest.namespaces.compat.CompatTokens" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CompatTokens +``` + +## Parameters + + + + + +## Returns + +`CompatTokens` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 714. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/create.mdx new file mode 100644 index 0000000000..fc4ae9017b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-tokens/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatTokens.create" + parent: "rest.namespaces.compat.CompatTokens" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `create` + +Create a new Compat API token. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Token payload (friendly name, scopes, etc.). + + +## Returns + +`Promise` — The newly-created token record, including the secret value. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 725. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/delete.mdx new file mode 100644 index 0000000000..ed5e07708c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-tokens/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatTokens.delete" + parent: "rest.namespaces.compat.CompatTokens" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `delete` + +Revoke and delete a Compat API token. + +## Signature + +```typescript +delete(tokenId: string): Promise +``` + +## Parameters + + + Unique identifier of the token. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 748. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/index.mdx new file mode 100644 index 0000000000..0f9cada191 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-tokens" +title: "CompatTokens" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatTokens" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatTokens` + +Compat API token management (non-LAML — uses `PATCH`). + +## Signature + +```typescript +class CompatTokens extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Create a new Compat API token. + + + + Revoke and delete a Compat API token. + + + + Update a Compat API token. + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 713. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/update.mdx new file mode 100644 index 0000000000..bdd29103be --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-tokens/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-tokens/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatTokens.update" + parent: "rest.namespaces.compat.CompatTokens" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `update` + +Update a Compat API token. + +## Signature + +```typescript +update(tokenId: string, body: any = {}): Promise +``` + +## Parameters + + + Unique identifier of the token. + + + + Partial update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The updated token record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 737. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/constructor.mdx new file mode 100644 index 0000000000..78ff40dd7e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-transcriptions/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatTranscriptions.constructor" + parent: "rest.namespaces.compat.CompatTranscriptions" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CompatTranscriptions +``` + +## Parameters + + + + + +## Returns + +`CompatTranscriptions` + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 674. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/delete.mdx new file mode 100644 index 0000000000..3bc9adc5df --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-transcriptions/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatTranscriptions.delete" + parent: "rest.namespaces.compat.CompatTranscriptions" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `delete` + +Delete a transcription. + +## Signature + +```typescript +delete(sid: string): Promise +``` + +## Parameters + + + Transcription SID. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 707. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/get.mdx new file mode 100644 index 0000000000..e886ed8b6d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-transcriptions/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatTranscriptions.get" + parent: "rest.namespaces.compat.CompatTranscriptions" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `get` + +Fetch a transcription by SID. + +## Signature + +```typescript +get(sid: string): Promise +``` + +## Parameters + + + Transcription SID (e.g. `"TR..."`). + + +## Returns + +`Promise` — The transcription record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 696. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/index.mdx new file mode 100644 index 0000000000..855daa4a6b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-transcriptions" +title: "CompatTranscriptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatTranscriptions" + parent: "rest.namespaces.compat" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `CompatTranscriptions` + +Compat transcription management (list / get / delete). + +## Signature + +```typescript +class CompatTranscriptions extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Delete a transcription. + + + + Fetch a transcription by SID. + + + + List transcriptions in the account. + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 673. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/list.mdx new file mode 100644 index 0000000000..db692dfec8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/compat-transcriptions/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat/compat-transcriptions/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.compat.CompatTranscriptions.list" + parent: "rest.namespaces.compat.CompatTranscriptions" + module: "rest.namespaces.compat" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `list` + +List transcriptions in the account. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of transcriptions. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 685. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/compat/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/compat/index.mdx new file mode 100644 index 0000000000..fd34c565cd --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/compat/index.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/typescript/rest/namespaces/compat" +title: "compat" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.compat" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts" +--- +# `compat` + +## Signature + +```typescript +module compat +``` + +## Classes + + + + Compat account / subproject management (Twilio-compatible LAML). + + + + Compat application management (LAML-style `Applications`). + + + + Compat call management with recording and stream sub-resources. + + + + Compat conference management with participants, recordings, and streams. + + + + Compat fax management with media sub-resources. + + + + Compat cXML / LaML Bin management. + + + + Compat message management with media sub-resources. + + + + Twilio-compatible LAML API namespace with AccountSid scoping. + + + + Compat phone number management with searching, purchasing, and import. + + + + Compat queue management with member operations. + + + + Compat recording management (list / get / delete). + + + + Compat API token management (non-LAML — uses `PATCH`). + + + + Compat transcription management (list / get / delete). + + + +## Source + +[`src/rest/namespaces/compat.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/compat.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/constructor.mdx new file mode 100644 index 0000000000..ca555d201a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-documents/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereDocuments.constructor" + parent: "rest.namespaces.datasphere.DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): DatasphereDocuments +``` + +## Parameters + + + +## Returns + +`DatasphereDocuments` + +## Source + +[`src/rest/namespaces/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts) + +Line 13. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/create.mdx new file mode 100644 index 0000000000..739f584b93 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-documents/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereDocuments.create" + parent: "rest.namespaces.datasphere.DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/delete-chunk.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/delete-chunk.mdx new file mode 100644 index 0000000000..ee5dbca6dd --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/delete-chunk.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-documents/delete-chunk" +title: "deleteChunk" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereDocuments.deleteChunk" + parent: "rest.namespaces.datasphere.DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts" +--- +# `deleteChunk` + +Delete a specific chunk from a document. + +## Signature + +```typescript +deleteChunk(documentId: string, chunkId: string): Promise +``` + +## Parameters + + + Unique identifier of the document. + + + + Unique identifier of the chunk. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts) + +Line 61. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/delete.mdx new file mode 100644 index 0000000000..2ab471e3f4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-documents/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereDocuments.delete" + parent: "rest.namespaces.datasphere.DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/get-chunk.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/get-chunk.mdx new file mode 100644 index 0000000000..7cad37655e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/get-chunk.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-documents/get-chunk" +title: "getChunk" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereDocuments.getChunk" + parent: "rest.namespaces.datasphere.DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts" +--- +# `getChunk` + +Fetch a specific chunk of a document by ID. + +## Signature + +```typescript +getChunk(documentId: string, chunkId: string): Promise +``` + +## Parameters + + + Unique identifier of the document. + + + + Unique identifier of the chunk. + + +## Returns + +`Promise` — The chunk record with its content. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts) + +Line 49. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/get.mdx new file mode 100644 index 0000000000..8a3e0edd49 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-documents/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereDocuments.get" + parent: "rest.namespaces.datasphere.DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/index.mdx new file mode 100644 index 0000000000..0b37ad71e5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/index.mdx @@ -0,0 +1,75 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-documents" +title: "DatasphereDocuments" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereDocuments" + parent: "rest.namespaces.datasphere" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts" +--- +# `DatasphereDocuments` + +Document management with search and chunk operations. + +## Signature + +```typescript +class DatasphereDocuments extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Delete a specific chunk from a document. + + + + Fetch a single resource by ID. + + + + Fetch a specific chunk of a document by ID. + + + + List resources with optional query parameters. + + + + List content chunks for a document. + + + + Run a semantic search across indexed documents. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts) + +Line 12. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/list-chunks.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/list-chunks.mdx new file mode 100644 index 0000000000..58ab0ae34f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/list-chunks.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-documents/list-chunks" +title: "listChunks" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereDocuments.listChunks" + parent: "rest.namespaces.datasphere.DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts" +--- +# `listChunks` + +List content chunks for a document. + +## Signature + +```typescript +listChunks(documentId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the document. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of chunks. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts) + +Line 37. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/list.mdx new file mode 100644 index 0000000000..521c7d246d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-documents/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereDocuments.list" + parent: "rest.namespaces.datasphere.DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/search.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/search.mdx new file mode 100644 index 0000000000..97b1bf496f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/search.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-documents/search" +title: "search" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereDocuments.search" + parent: "rest.namespaces.datasphere.DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts" +--- +# `search` + +Run a semantic search across indexed documents. + +## Signature + +```typescript +search(body: any): Promise +``` + +## Parameters + + + Search payload (typically `{ query: "...", document_id?: "...", + limit?: 5, tags?: [...] }`). + + +## Returns + +`Promise` — The ranked search hits. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts) + +Line 25. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/update.mdx new file mode 100644 index 0000000000..e8b2fb1a95 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-documents/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-documents/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereDocuments.update" + parent: "rest.namespaces.datasphere.DatasphereDocuments" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-namespace/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-namespace/constructor.mdx new file mode 100644 index 0000000000..9c5c81d862 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-namespace/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-namespace/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereNamespace.constructor" + parent: "rest.namespaces.datasphere.DatasphereNamespace" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): DatasphereNamespace +``` + +## Parameters + + + +## Returns + +`DatasphereNamespace` + +## Source + +[`src/rest/namespaces/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts) + +Line 85. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-namespace/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-namespace/index.mdx new file mode 100644 index 0000000000..b11c1bb77e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/datasphere-namespace/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere/datasphere-namespace" +title: "DatasphereNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.datasphere.DatasphereNamespace" + parent: "rest.namespaces.datasphere" + module: "rest.namespaces.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts" +--- +# `DatasphereNamespace` + +Datasphere API namespace. + +Access via `client.datasphere.*`. Datasphere is SignalWire's RAG service — +index documents and run semantic search from within agent tools. + +## Signature + +```typescript +class DatasphereNamespace +``` + +## Examples + +```typescript +const hits = await client.datasphere.documents.search({ + query: 'refund policy', + document_id: 'doc_abc', + limit: 5, +}); +``` + +## Properties + + + Document CRUD plus semantic search and chunk management. + + +## Methods + + + + + +## Source + +[`src/rest/namespaces/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/index.mdx new file mode 100644 index 0000000000..0a5274a159 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/datasphere/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/rest/namespaces/datasphere" +title: "datasphere" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.datasphere" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts" +--- +# `datasphere` + +## Signature + +```typescript +module datasphere +``` + +## Classes + + + + Document management with search and chunk operations. + + + + Datasphere API namespace. + + + +## Source + +[`src/rest/namespaces/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/datasphere.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/constructor.mdx new file mode 100644 index 0000000000..c84692ae17 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.AutoMaterializedWebhookResource.constructor" + parent: "rest.namespaces.fabric.AutoMaterializedWebhookResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): AutoMaterializedWebhookResource +``` + +## Parameters + + + + + +## Returns + +`AutoMaterializedWebhookResource` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 190. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/create.mdx new file mode 100644 index 0000000000..60947d4b77 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/create.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.AutoMaterializedWebhookResource.create" + parent: "rest.namespaces.fabric.AutoMaterializedWebhookResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" + deprecated: true +--- +# `create` + + + **Deprecated.** Creating a webhook Fabric resource directly produces an orphan that is not bound to any phone number. Use the `phoneNumbers.setSwmlWebhook` / `setCxmlWebhook` helper instead — it updates the phone number and the server auto-materializes the resource. Kept for backwards compatibility. + + +## Signature + +```typescript +create(body: any = {}): Promise +``` + +## Parameters + + + +## Returns + +`Promise` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 201. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/delete.mdx new file mode 100644 index 0000000000..dd7c1736b4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.AutoMaterializedWebhookResource.delete" + parent: "rest.namespaces.fabric.AutoMaterializedWebhookResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/get.mdx new file mode 100644 index 0000000000..147cfddf98 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.AutoMaterializedWebhookResource.get" + parent: "rest.namespaces.fabric.AutoMaterializedWebhookResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/index.mdx new file mode 100644 index 0000000000..1df5189866 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/index.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource" +title: "AutoMaterializedWebhookResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.AutoMaterializedWebhookResource" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `AutoMaterializedWebhookResource` + +Fabric webhook resource that is normally auto-materialized by the +corresponding `phoneNumbers.set*Webhook` helper. + +Creating directly produces an orphan Fabric resource that isn't bound to +any phone number — the API's binding model configures the webhook on the +phone number, and the server materializes the Fabric resource as a +side-effect. `create` remains for backwards compatibility but emits a +one-time deprecation warning on first call. + +See the porting-sdk's `phone-binding.md` for the full model. + +## Signature + +```typescript +class AutoMaterializedWebhookResource extends FabricResource +``` + +## Inheritance + +**Extends:** [FabricResource](/reference/typescript/rest/namespaces/fabric/fabric-resource) + +## Methods + + + + + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + List addresses associated with a specific resource instance. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 185. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/list-addresses.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/list-addresses.mdx new file mode 100644 index 0000000000..c067dd3e8e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/list-addresses.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/list-addresses" +title: "listAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.AutoMaterializedWebhookResource.listAddresses" + parent: "rest.namespaces.fabric.AutoMaterializedWebhookResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts" +--- +# `listAddresses` + +List addresses associated with a specific resource instance. + +## Signature + +```typescript +listAddresses(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the owning resource. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudWithAddresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/list.mdx new file mode 100644 index 0000000000..a81b538982 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.AutoMaterializedWebhookResource.list" + parent: "rest.namespaces.fabric.AutoMaterializedWebhookResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/update.mdx new file mode 100644 index 0000000000..7084462ca5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.AutoMaterializedWebhookResource.update" + parent: "rest.namespaces.fabric.AutoMaterializedWebhookResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/constructor.mdx new file mode 100644 index 0000000000..3b2e00f8f1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/call-flows-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CallFlowsResource.constructor" + parent: "rest.namespaces.fabric.CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CallFlowsResource +``` + +## Parameters + + + + + +## Returns + +`CallFlowsResource` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 30. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/create.mdx new file mode 100644 index 0000000000..0341710610 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/call-flows-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CallFlowsResource.create" + parent: "rest.namespaces.fabric.CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/delete.mdx new file mode 100644 index 0000000000..4549e68874 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/call-flows-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CallFlowsResource.delete" + parent: "rest.namespaces.fabric.CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/deploy-version.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/deploy-version.mdx new file mode 100644 index 0000000000..1093d67c2d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/deploy-version.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/call-flows-resource/deploy-version" +title: "deployVersion" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CallFlowsResource.deployVersion" + parent: "rest.namespaces.fabric.CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `deployVersion` + +Publish a new version of a call flow. + +## Signature + +```typescript +deployVersion(resourceId: string, body: any = {}): Promise +``` + +## Parameters + + + Unique identifier of the call flow. + + + + Version payload (schema and metadata). Defaults to `{}`. + + +## Returns + +`Promise` — The newly-published version record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 68. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/get.mdx new file mode 100644 index 0000000000..1e16d9aa8d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/call-flows-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CallFlowsResource.get" + parent: "rest.namespaces.fabric.CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/index.mdx new file mode 100644 index 0000000000..029e982299 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/call-flows-resource" +title: "CallFlowsResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CallFlowsResource" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `CallFlowsResource` + +Call flows with version management. Uses singular `call_flow` for sub-resource paths. + +## Signature + +```typescript +class CallFlowsResource extends FabricResourcePUT +``` + +## Inheritance + +**Extends:** [FabricResourcePUT](/reference/typescript/rest/namespaces/fabric/fabric-resource-put) + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Publish a new version of a call flow. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + List addresses attached to a call flow resource. + + + + List all saved versions of a call flow. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 29. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/list-addresses.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/list-addresses.mdx new file mode 100644 index 0000000000..e1855a5aab --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/list-addresses.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/call-flows-resource/list-addresses" +title: "listAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CallFlowsResource.listAddresses" + parent: "rest.namespaces.fabric.CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `listAddresses` + +List addresses attached to a call flow resource. + +## Signature + +```typescript +listAddresses(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the call flow. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 42. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/list-versions.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/list-versions.mdx new file mode 100644 index 0000000000..ea5df6a12e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/list-versions.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/call-flows-resource/list-versions" +title: "listVersions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CallFlowsResource.listVersions" + parent: "rest.namespaces.fabric.CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `listVersions` + +List all saved versions of a call flow. + +## Signature + +```typescript +listVersions(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the call flow. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of call-flow versions. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/list.mdx new file mode 100644 index 0000000000..e7bc397955 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/call-flows-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CallFlowsResource.list" + parent: "rest.namespaces.fabric.CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/update.mdx new file mode 100644 index 0000000000..96cf1abc2e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/call-flows-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/call-flows-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CallFlowsResource.update" + parent: "rest.namespaces.fabric.CallFlowsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/constructor.mdx new file mode 100644 index 0000000000..8377e067a6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/conference-rooms-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.ConferenceRoomsResource.constructor" + parent: "rest.namespaces.fabric.ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): ConferenceRoomsResource +``` + +## Parameters + + + + + +## Returns + +`ConferenceRoomsResource` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 76. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/create.mdx new file mode 100644 index 0000000000..706959be86 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/conference-rooms-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.ConferenceRoomsResource.create" + parent: "rest.namespaces.fabric.ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/delete.mdx new file mode 100644 index 0000000000..a7a61b18bb --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/conference-rooms-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.ConferenceRoomsResource.delete" + parent: "rest.namespaces.fabric.ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/get.mdx new file mode 100644 index 0000000000..6a99613a4f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/conference-rooms-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.ConferenceRoomsResource.get" + parent: "rest.namespaces.fabric.ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/index.mdx new file mode 100644 index 0000000000..6b319e1ff4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/conference-rooms-resource" +title: "ConferenceRoomsResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.ConferenceRoomsResource" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `ConferenceRoomsResource` + +Conference rooms — uses singular 'conference\_room' for sub-resource paths. + +## Signature + +```typescript +class ConferenceRoomsResource extends FabricResourcePUT +``` + +## Inheritance + +**Extends:** [FabricResourcePUT](/reference/typescript/rest/namespaces/fabric/fabric-resource-put) + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + List addresses attached to a conference-room resource. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 75. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/list-addresses.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/list-addresses.mdx new file mode 100644 index 0000000000..727cbd79a4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/list-addresses.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/conference-rooms-resource/list-addresses" +title: "listAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.ConferenceRoomsResource.listAddresses" + parent: "rest.namespaces.fabric.ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `listAddresses` + +List addresses attached to a conference-room resource. + +## Signature + +```typescript +listAddresses(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the conference room. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 88. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/list.mdx new file mode 100644 index 0000000000..6597ddc0db --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/conference-rooms-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.ConferenceRoomsResource.list" + parent: "rest.namespaces.fabric.ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/update.mdx new file mode 100644 index 0000000000..75f13a7da5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/conference-rooms-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/conference-rooms-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.ConferenceRoomsResource.update" + parent: "rest.namespaces.fabric.ConferenceRoomsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/constructor.mdx new file mode 100644 index 0000000000..c139a1cb0d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-applications-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlApplicationsResource.constructor" + parent: "rest.namespaces.fabric.CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CxmlApplicationsResource +``` + +## Parameters + + + + + +## Returns + +`CxmlApplicationsResource` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 164. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/create.mdx new file mode 100644 index 0000000000..e64bb0dd81 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/create.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-applications-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlApplicationsResource.create" + parent: "rest.namespaces.fabric.CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(): Promise +``` + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 168. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/delete.mdx new file mode 100644 index 0000000000..9b0f137026 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-applications-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlApplicationsResource.delete" + parent: "rest.namespaces.fabric.CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/get.mdx new file mode 100644 index 0000000000..5c1b85e7e7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-applications-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlApplicationsResource.get" + parent: "rest.namespaces.fabric.CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/index.mdx new file mode 100644 index 0000000000..753008b8f8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-applications-resource" +title: "CxmlApplicationsResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlApplicationsResource" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `CxmlApplicationsResource` + +cXML applications — no create method (read/update/delete only). + +## Signature + +```typescript +class CxmlApplicationsResource extends FabricResourcePUT +``` + +## Inheritance + +**Extends:** [FabricResourcePUT](/reference/typescript/rest/namespaces/fabric/fabric-resource-put) + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + List addresses associated with a specific resource instance. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 163. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/list-addresses.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/list-addresses.mdx new file mode 100644 index 0000000000..69ba1b053c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/list-addresses.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-applications-resource/list-addresses" +title: "listAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlApplicationsResource.listAddresses" + parent: "rest.namespaces.fabric.CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts" +--- +# `listAddresses` + +List addresses associated with a specific resource instance. + +## Signature + +```typescript +listAddresses(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the owning resource. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudWithAddresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/list.mdx new file mode 100644 index 0000000000..9ae5aa2150 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-applications-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlApplicationsResource.list" + parent: "rest.namespaces.fabric.CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/update.mdx new file mode 100644 index 0000000000..525d62f126 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-applications-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-applications-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlApplicationsResource.update" + parent: "rest.namespaces.fabric.CxmlApplicationsResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/constructor.mdx new file mode 100644 index 0000000000..cf5a36a317 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlWebhooksResource.constructor" + parent: "rest.namespaces.fabric.CxmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): CxmlWebhooksResource +``` + +## Parameters + + + + + +## Returns + +`CxmlWebhooksResource` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 190. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/create.mdx new file mode 100644 index 0000000000..3e1618365c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/create.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlWebhooksResource.create" + parent: "rest.namespaces.fabric.CxmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" + deprecated: true +--- +# `create` + + + **Deprecated.** Creating a webhook Fabric resource directly produces an orphan that is not bound to any phone number. Use the `phoneNumbers.setSwmlWebhook` / `setCxmlWebhook` helper instead — it updates the phone number and the server auto-materializes the resource. Kept for backwards compatibility. + + +## Signature + +```typescript +create(body: any = {}): Promise +``` + +## Parameters + + + +## Returns + +`Promise` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 201. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/delete.mdx new file mode 100644 index 0000000000..e5821a7ff3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlWebhooksResource.delete" + parent: "rest.namespaces.fabric.CxmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/get.mdx new file mode 100644 index 0000000000..9fd4f6e5e7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlWebhooksResource.get" + parent: "rest.namespaces.fabric.CxmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/index.mdx new file mode 100644 index 0000000000..82f34c650f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource" +title: "CxmlWebhooksResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlWebhooksResource" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `CxmlWebhooksResource` + +Auto-materialized cXML webhook — normally created via `phoneNumbers.setCxmlWebhook`. + +## Signature + +```typescript +class CxmlWebhooksResource extends AutoMaterializedWebhookResource +``` + +## Inheritance + +**Extends:** [AutoMaterializedWebhookResource](/reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource) + +## Methods + + + + + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + List addresses associated with a specific resource instance. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 221. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/list-addresses.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/list-addresses.mdx new file mode 100644 index 0000000000..f55bd12b30 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/list-addresses.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/list-addresses" +title: "listAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlWebhooksResource.listAddresses" + parent: "rest.namespaces.fabric.CxmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts" +--- +# `listAddresses` + +List addresses associated with a specific resource instance. + +## Signature + +```typescript +listAddresses(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the owning resource. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudWithAddresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/list.mdx new file mode 100644 index 0000000000..694eb16b74 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlWebhooksResource.list" + parent: "rest.namespaces.fabric.CxmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/update.mdx new file mode 100644 index 0000000000..d336594218 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/cxml-webhooks-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.CxmlWebhooksResource.update" + parent: "rest.namespaces.fabric.CxmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/constructor.mdx new file mode 100644 index 0000000000..666309816d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-addresses/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricAddresses.constructor" + parent: "rest.namespaces.fabric.FabricAddresses" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): FabricAddresses +``` + +## Parameters + + + + + +## Returns + +`FabricAddresses` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 326. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/get.mdx new file mode 100644 index 0000000000..33e07a2a42 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-addresses/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricAddresses.get" + parent: "rest.namespaces.fabric.FabricAddresses" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `get` + +Fetch a single fabric address by ID. + +## Signature + +```typescript +get(addressId: string): Promise +``` + +## Parameters + + + Unique identifier of the address. + + +## Returns + +`Promise` — The address record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 348. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/index.mdx new file mode 100644 index 0000000000..1c9b5c8fa5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-addresses" +title: "FabricAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricAddresses" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `FabricAddresses` + +Read-only fabric addresses. + +## Signature + +```typescript +class FabricAddresses extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Fetch a single fabric address by ID. + + + + List all fabric addresses in the project. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 325. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/list.mdx new file mode 100644 index 0000000000..140eee2fb3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-addresses/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-addresses/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricAddresses.list" + parent: "rest.namespaces.fabric.FabricAddresses" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `list` + +List all fabric addresses in the project. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of fabric addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 337. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-namespace/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-namespace/constructor.mdx new file mode 100644 index 0000000000..4c0d472015 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-namespace/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-namespace/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricNamespace.constructor" + parent: "rest.namespaces.fabric.FabricNamespace" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): FabricNamespace +``` + +## Parameters + + + +## Returns + +`FabricNamespace` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 475. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-namespace/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-namespace/index.mdx new file mode 100644 index 0000000000..22b85b5702 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-namespace/index.mdx @@ -0,0 +1,111 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-namespace" +title: "FabricNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricNamespace" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `FabricNamespace` + +Fabric API namespace grouping all resource types. + +Access via `client.fabric.*`. + +## Signature + +```typescript +class FabricNamespace +``` + +## Examples + +```typescript +const agents = await client.fabric.aiAgents.list(); +const flow = await client.fabric.callFlows.create({ name: 'main-ivr' }); +const token = await client.fabric.tokens.createSubscriberToken({ subscriber_id: 'sub_123' }); +``` + +## Properties + + + Read-only access to the unified fabric address table. + + + + AI Agent CRUD — the platform-managed agent registration resource. + + + + Call Flow CRUD with version listing and publishing. + + + + Conference Room CRUD with address listing. + + + + cXML application read / update / delete (no create). + + + + cXML (LaML) script CRUD. + + + + cXML webhook CRUD. **Auto-materialized** as a side-effect of [PhoneNumbersResource.setCxmlWebhook](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-webhook); direct `create` produces an orphan resource and emits a deprecation warning. + + + + FreeSWITCH Connector CRUD. + + + + Relay Application CRUD (full-replacement `PUT` update). + + + + Generic operations across all resource types (list, get, delete, phone route assignment). + + + + Top-level SIP endpoint CRUD. + + + + SIP Gateway CRUD. + + + + Subscriber CRUD plus nested SIP endpoint management. + + + + SWML script CRUD (full-replacement `PUT` update). + + + + SWML webhook CRUD. **Auto-materialized** as a side-effect of [PhoneNumbersResource.setSwmlWebhook](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook); direct `create` produces an orphan resource and emits a deprecation warning. + + + + Subscriber, guest, invite, and embed token generation. + + +## Methods + + + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 428. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/constructor.mdx new file mode 100644 index 0000000000..681310f73d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource-put/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResourcePUT.constructor" + parent: "rest.namespaces.fabric.FabricResourcePUT" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): FabricResourcePUT +``` + +## Parameters + + + + + +## Returns + +`FabricResourcePUT` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 23. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/create.mdx new file mode 100644 index 0000000000..7653957b6e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource-put/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResourcePUT.create" + parent: "rest.namespaces.fabric.FabricResourcePUT" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/delete.mdx new file mode 100644 index 0000000000..54dbe0543c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource-put/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResourcePUT.delete" + parent: "rest.namespaces.fabric.FabricResourcePUT" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/get.mdx new file mode 100644 index 0000000000..c68063791f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource-put/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResourcePUT.get" + parent: "rest.namespaces.fabric.FabricResourcePUT" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/index.mdx new file mode 100644 index 0000000000..2501d1d452 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource-put" +title: "FabricResourcePUT" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResourcePUT" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `FabricResourcePUT` + +Fabric resource that uses PUT for updates. + +## Signature + +```typescript +class FabricResourcePUT extends CrudWithAddresses +``` + +## Inheritance + +**Extends:** `CrudWithAddresses` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + List addresses associated with a specific resource instance. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 20. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/list-addresses.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/list-addresses.mdx new file mode 100644 index 0000000000..5010fbd7d3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/list-addresses.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource-put/list-addresses" +title: "listAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResourcePUT.listAddresses" + parent: "rest.namespaces.fabric.FabricResourcePUT" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts" +--- +# `listAddresses` + +List addresses associated with a specific resource instance. + +## Signature + +```typescript +listAddresses(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the owning resource. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudWithAddresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/list.mdx new file mode 100644 index 0000000000..186b23dc84 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource-put/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResourcePUT.list" + parent: "rest.namespaces.fabric.FabricResourcePUT" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/update.mdx new file mode 100644 index 0000000000..3054078aa1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource-put/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource-put/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResourcePUT.update" + parent: "rest.namespaces.fabric.FabricResourcePUT" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/constructor.mdx new file mode 100644 index 0000000000..a85d62db82 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResource.constructor" + parent: "rest.namespaces.fabric.FabricResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): FabricResource +``` + +## Parameters + + + + + +## Returns + +`FabricResource` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 14. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/create.mdx new file mode 100644 index 0000000000..6b8d8291a9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResource.create" + parent: "rest.namespaces.fabric.FabricResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/delete.mdx new file mode 100644 index 0000000000..0cef1b000e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResource.delete" + parent: "rest.namespaces.fabric.FabricResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/get.mdx new file mode 100644 index 0000000000..29f36dd252 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResource.get" + parent: "rest.namespaces.fabric.FabricResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/index.mdx new file mode 100644 index 0000000000..040fff84b9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource" +title: "FabricResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResource" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `FabricResource` + +Standard fabric resource with CRUD + addresses (PATCH updates). + +## Signature + +```typescript +class FabricResource extends CrudWithAddresses +``` + +## Inheritance + +**Extends:** `CrudWithAddresses` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + List addresses associated with a specific resource instance. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 13. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/list-addresses.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/list-addresses.mdx new file mode 100644 index 0000000000..bdcc5f5aec --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/list-addresses.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource/list-addresses" +title: "listAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResource.listAddresses" + parent: "rest.namespaces.fabric.FabricResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts" +--- +# `listAddresses` + +List addresses associated with a specific resource instance. + +## Signature + +```typescript +listAddresses(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the owning resource. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudWithAddresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/list.mdx new file mode 100644 index 0000000000..63b234bb17 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResource.list" + parent: "rest.namespaces.fabric.FabricResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/update.mdx new file mode 100644 index 0000000000..43e57915a2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricResource.update" + parent: "rest.namespaces.fabric.FabricResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/constructor.mdx new file mode 100644 index 0000000000..dc5d40d18e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-tokens/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricTokens.constructor" + parent: "rest.namespaces.fabric.FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): FabricTokens +``` + +## Parameters + + + +## Returns + +`FabricTokens` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 355. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-embed-token.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-embed-token.mdx new file mode 100644 index 0000000000..b4c2af1b4b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-embed-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-tokens/create-embed-token" +title: "createEmbedToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricTokens.createEmbedToken" + parent: "rest.namespaces.fabric.FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `createEmbedToken` + +Issue a short-lived embed token for browser-side SignalWire widgets. + +## Signature + +```typescript +createEmbedToken(body: any = {}): Promise +``` + +## Parameters + + + Embed-token payload (allowed origins, TTL, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The token record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 411. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-guest-token.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-guest-token.mdx new file mode 100644 index 0000000000..d72c1a9724 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-guest-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-tokens/create-guest-token" +title: "createGuestToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricTokens.createGuestToken" + parent: "rest.namespaces.fabric.FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `createGuestToken` + +Issue a guest token (no subscriber account required). + +## Signature + +```typescript +createGuestToken(body: any = {}): Promise +``` + +## Parameters + + + Guest-token payload (context, TTL, etc.). Defaults to `{}`. + + +## Returns + +`Promise` — The token record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 400. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-invite-token.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-invite-token.mdx new file mode 100644 index 0000000000..d0047bbb5c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-invite-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-tokens/create-invite-token" +title: "createInviteToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricTokens.createInviteToken" + parent: "rest.namespaces.fabric.FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `createInviteToken` + +Create a single-use invite token for onboarding a new subscriber. + +## Signature + +```typescript +createInviteToken(body: any = {}): Promise +``` + +## Parameters + + + Invite payload (email, phone, permissions). Defaults to `{}`. + + +## Returns + +`Promise` — The invite record, including the share URL / code. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 389. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-subscriber-token.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-subscriber-token.mdx new file mode 100644 index 0000000000..cfad4f125c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/create-subscriber-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-tokens/create-subscriber-token" +title: "createSubscriberToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricTokens.createSubscriberToken" + parent: "rest.namespaces.fabric.FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `createSubscriberToken` + +Issue a new subscriber JWT used by end-user clients. + +## Signature + +```typescript +createSubscriberToken(body: any = {}): Promise +``` + +## Parameters + + + Token payload (subscriber ID, TTL, scopes). Defaults to `{}`. + + +## Returns + +`Promise` — The token record, typically `{ token: "eyJ..." }`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 366. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/index.mdx new file mode 100644 index 0000000000..aafc42f273 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-tokens" +title: "FabricTokens" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricTokens" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `FabricTokens` + +Subscriber, guest, invite, and embed token creation. + +## Signature + +```typescript +class FabricTokens extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Issue a short-lived embed token for browser-side SignalWire widgets. + + + + Issue a guest token (no subscriber account required). + + + + Create a single-use invite token for onboarding a new subscriber. + + + + Issue a new subscriber JWT used by end-user clients. + + + + Refresh an existing subscriber JWT, extending its lifetime. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 354. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token.mdx new file mode 100644 index 0000000000..863565113c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/fabric-tokens/refresh-subscriber-token" +title: "refreshSubscriberToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.FabricTokens.refreshSubscriberToken" + parent: "rest.namespaces.fabric.FabricTokens" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `refreshSubscriberToken` + +Refresh an existing subscriber JWT, extending its lifetime. + +## Signature + +```typescript +refreshSubscriberToken(body: any = {}): Promise +``` + +## Parameters + + + Refresh payload (usually containing the current token). Defaults to `{}`. + + +## Returns + +`Promise` — The refreshed token record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 378. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/assign-domain-application.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/assign-domain-application.mdx new file mode 100644 index 0000000000..1b42c74859 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/assign-domain-application.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/generic-resources/assign-domain-application" +title: "assignDomainApplication" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.GenericResources.assignDomainApplication" + parent: "rest.namespaces.fabric.GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `assignDomainApplication` + +Assign a domain application to a fabric resource. + +## Signature + +```typescript +assignDomainApplication(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Domain application payload. + + +## Returns + +`Promise` — The domain-application assignment record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 319. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/assign-phone-route.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/assign-phone-route.mdx new file mode 100644 index 0000000000..8a3c890840 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/assign-phone-route.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/generic-resources/assign-phone-route" +title: "assignPhoneRoute" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.GenericResources.assignPhoneRoute" + parent: "rest.namespaces.fabric.GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" + deprecated: true +--- +# `assignPhoneRoute` + + + **Deprecated.** For the common cases — SWML webhooks, cXML webhooks, AI agents — this endpoint **does not work**. Bindings for those are configured on the phone number via [PhoneNumbersResource.setSwmlWebhook](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook) / `setCxmlWebhook` / `setAiAgent`, and the Fabric resource is auto-materialized by the server. Calling this method against `swml_webhook`, `cxml_webhook`, or `ai_agent` resource IDs returns `404` or `422`. The endpoint (`POST /api/fabric/resources/{id}/phone_routes`) applies only to a narrow set of legacy resource types listed in `rest-apis/relay-rest/openapi.yaml`. Emits a one-time deprecation warning on first call; kept for backwards compatibility. + + +Assign a phone route to a fabric resource. + +## Signature + +```typescript +assignPhoneRoute(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Phone route payload. + + +## Returns + +`Promise` — The phone-route assignment record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 297. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/constructor.mdx new file mode 100644 index 0000000000..999262d46a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/generic-resources/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.GenericResources.constructor" + parent: "rest.namespaces.fabric.GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): GenericResources +``` + +## Parameters + + + + + +## Returns + +`GenericResources` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 229. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/delete.mdx new file mode 100644 index 0000000000..a4c10f8def --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/generic-resources/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.GenericResources.delete" + parent: "rest.namespaces.fabric.GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `delete` + +Delete a fabric resource. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 262. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/get.mdx new file mode 100644 index 0000000000..911e51d355 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/generic-resources/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.GenericResources.get" + parent: "rest.namespaces.fabric.GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `get` + +Fetch a single fabric resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 251. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/index.mdx new file mode 100644 index 0000000000..8c2a8f4e12 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/generic-resources" +title: "GenericResources" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.GenericResources" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `GenericResources` + +Generic resource operations across all fabric resource types. + +## Signature + +```typescript +class GenericResources extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + Assign a domain application to a fabric resource. + + + + Assign a phone route to a fabric resource. + + + + + + Delete a fabric resource. + + + + Fetch a single fabric resource by ID. + + + + List all fabric resources regardless of specific type. + + + + List addresses associated with any fabric resource. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 226. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/list-addresses.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/list-addresses.mdx new file mode 100644 index 0000000000..100e7504fd --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/list-addresses.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/generic-resources/list-addresses" +title: "listAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.GenericResources.listAddresses" + parent: "rest.namespaces.fabric.GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `listAddresses` + +List addresses associated with any fabric resource. + +## Signature + +```typescript +listAddresses(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 274. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/list.mdx new file mode 100644 index 0000000000..20dc6cb207 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/generic-resources/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/generic-resources/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.GenericResources.list" + parent: "rest.namespaces.fabric.GenericResources" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `list` + +List all fabric resources regardless of specific type. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of generic fabric resources. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 240. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/index.mdx new file mode 100644 index 0000000000..3b8facdabc --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/index.mdx @@ -0,0 +1,82 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric" +title: "fabric" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.fabric" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `fabric` + +## Signature + +```typescript +module fabric +``` + +## Classes + + + + Fabric webhook resource that is normally auto-materialized by the corresponding `phoneNumbers.set*Webhook` helper. + + + + Call flows with version management. Uses singular `call_flow` for sub-resource paths. + + + + Conference rooms — uses singular 'conference\_room' for sub-resource paths. + + + + cXML applications — no create method (read/update/delete only). + + + + Auto-materialized cXML webhook — normally created via `phoneNumbers.setCxmlWebhook`. + + + + Read-only fabric addresses. + + + + Fabric API namespace grouping all resource types. + + + + Standard fabric resource with CRUD + addresses (PATCH updates). + + + + Fabric resource that uses PUT for updates. + + + + Subscriber, guest, invite, and embed token creation. + + + + Generic resource operations across all fabric resource types. + + + + Subscribers with SIP endpoint management. + + + + Auto-materialized SWML webhook — normally created via `phoneNumbers.setSwmlWebhook`. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/constructor.mdx new file mode 100644 index 0000000000..3d5f97f2ad --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.constructor" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): SubscribersResource +``` + +## Parameters + + + + + +## Returns + +`SubscribersResource` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 96. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint.mdx new file mode 100644 index 0000000000..be462e307e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/create-sip-endpoint" +title: "createSipEndpoint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.createSipEndpoint" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `createSipEndpoint` + +Register a new SIP endpoint under a subscriber. + +## Signature + +```typescript +createSipEndpoint(subscriberId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the subscriber. + + + + SIP endpoint payload (credentials, codecs, etc.). + + +## Returns + +`Promise` — The newly-created SIP endpoint record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 120. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/create.mdx new file mode 100644 index 0000000000..d7d794111a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.create" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint.mdx new file mode 100644 index 0000000000..4acc3a5605 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/delete-sip-endpoint" +title: "deleteSipEndpoint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.deleteSipEndpoint" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `deleteSipEndpoint` + +Delete a SIP endpoint. + +## Signature + +```typescript +deleteSipEndpoint(subscriberId: string, endpointId: string): Promise +``` + +## Parameters + + + Unique identifier of the subscriber. + + + + Unique identifier of the SIP endpoint. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 157. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/delete.mdx new file mode 100644 index 0000000000..4aaa8f887d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.delete" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint.mdx new file mode 100644 index 0000000000..91884848de --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/get-sip-endpoint" +title: "getSipEndpoint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.getSipEndpoint" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `getSipEndpoint` + +Fetch a single SIP endpoint by ID. + +## Signature + +```typescript +getSipEndpoint(subscriberId: string, endpointId: string): Promise +``` + +## Parameters + + + Unique identifier of the subscriber. + + + + Unique identifier of the SIP endpoint. + + +## Returns + +`Promise` — The SIP endpoint record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 132. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/get.mdx new file mode 100644 index 0000000000..fd4542a917 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.get" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/index.mdx new file mode 100644 index 0000000000..cbea080f91 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource" +title: "SubscribersResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `SubscribersResource` + +Subscribers with SIP endpoint management. + +## Signature + +```typescript +class SubscribersResource extends FabricResourcePUT +``` + +## Inheritance + +**Extends:** [FabricResourcePUT](/reference/typescript/rest/namespaces/fabric/fabric-resource-put) + +## Methods + + + + + + Create a new resource. + + + + Register a new SIP endpoint under a subscriber. + + + + Delete a resource by ID. + + + + Delete a SIP endpoint. + + + + Fetch a single resource by ID. + + + + Fetch a single SIP endpoint by ID. + + + + List resources with optional query parameters. + + + + List addresses associated with a specific resource instance. + + + + List the SIP endpoints registered under a subscriber. + + + + Update a resource by ID. + + + + Update a SIP endpoint's settings. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/list-addresses.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/list-addresses.mdx new file mode 100644 index 0000000000..0efbc40b6a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/list-addresses.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/list-addresses" +title: "listAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.listAddresses" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts" +--- +# `listAddresses` + +List addresses associated with a specific resource instance. + +## Signature + +```typescript +listAddresses(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the owning resource. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudWithAddresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints.mdx new file mode 100644 index 0000000000..06078469d7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/list-sip-endpoints" +title: "listSipEndpoints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.listSipEndpoints" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `listSipEndpoints` + +List the SIP endpoints registered under a subscriber. + +## Signature + +```typescript +listSipEndpoints(subscriberId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the subscriber. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of SIP endpoints. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 108. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/list.mdx new file mode 100644 index 0000000000..d3b1cc7d87 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.list" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint.mdx new file mode 100644 index 0000000000..78c1325fe6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/update-sip-endpoint" +title: "updateSipEndpoint" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.updateSipEndpoint" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `updateSipEndpoint` + +Update a SIP endpoint's settings. + +## Signature + +```typescript +updateSipEndpoint( + subscriberId: string, + endpointId: string, + body: any +): Promise +``` + +## Parameters + + + Unique identifier of the subscriber. + + + + Unique identifier of the SIP endpoint. + + + + Partial update payload (PATCH semantics). + + +## Returns + +`Promise` — The updated SIP endpoint record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 145. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/update.mdx new file mode 100644 index 0000000000..fe6cd88edb --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/subscribers-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/subscribers-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SubscribersResource.update" + parent: "rest.namespaces.fabric.SubscribersResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/constructor.mdx new file mode 100644 index 0000000000..5956c460ae --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SwmlWebhooksResource.constructor" + parent: "rest.namespaces.fabric.SwmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): SwmlWebhooksResource +``` + +## Parameters + + + + + +## Returns + +`SwmlWebhooksResource` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 190. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/create.mdx new file mode 100644 index 0000000000..632648b8a0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/create.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SwmlWebhooksResource.create" + parent: "rest.namespaces.fabric.SwmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" + deprecated: true +--- +# `create` + + + **Deprecated.** Creating a webhook Fabric resource directly produces an orphan that is not bound to any phone number. Use the `phoneNumbers.setSwmlWebhook` / `setCxmlWebhook` helper instead — it updates the phone number and the server auto-materializes the resource. Kept for backwards compatibility. + + +## Signature + +```typescript +create(body: any = {}): Promise +``` + +## Parameters + + + +## Returns + +`Promise` + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 201. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/delete.mdx new file mode 100644 index 0000000000..5725fbd36c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SwmlWebhooksResource.delete" + parent: "rest.namespaces.fabric.SwmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/get.mdx new file mode 100644 index 0000000000..39c94be953 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SwmlWebhooksResource.get" + parent: "rest.namespaces.fabric.SwmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/index.mdx new file mode 100644 index 0000000000..b513f6d5b5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/swml-webhooks-resource" +title: "SwmlWebhooksResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SwmlWebhooksResource" + parent: "rest.namespaces.fabric" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts" +--- +# `SwmlWebhooksResource` + +Auto-materialized SWML webhook — normally created via `phoneNumbers.setSwmlWebhook`. + +## Signature + +```typescript +class SwmlWebhooksResource extends AutoMaterializedWebhookResource +``` + +## Inheritance + +**Extends:** [AutoMaterializedWebhookResource](/reference/typescript/rest/namespaces/fabric/auto-materialized-webhook-resource) + +## Methods + + + + + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + List addresses associated with a specific resource instance. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/fabric.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/fabric.ts) + +Line 216. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/list-addresses.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/list-addresses.mdx new file mode 100644 index 0000000000..0dfbd14488 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/list-addresses.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/list-addresses" +title: "listAddresses" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SwmlWebhooksResource.listAddresses" + parent: "rest.namespaces.fabric.SwmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts" +--- +# `listAddresses` + +List addresses associated with a specific resource instance. + +## Signature + +```typescript +listAddresses(resourceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the owning resource. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of addresses. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudWithAddresses.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudWithAddresses.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/list.mdx new file mode 100644 index 0000000000..70ceff3142 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SwmlWebhooksResource.list" + parent: "rest.namespaces.fabric.SwmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/update.mdx new file mode 100644 index 0000000000..0264484d77 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/fabric/swml-webhooks-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.fabric.SwmlWebhooksResource.update" + parent: "rest.namespaces.fabric.SwmlWebhooksResource" + module: "rest.namespaces.fabric" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource/constructor.mdx new file mode 100644 index 0000000000..6866cc209b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.imported-numbers.ImportedNumbersResource.constructor" + parent: "rest.namespaces.imported-numbers.ImportedNumbersResource" + module: "rest.namespaces.imported-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/imported-numbers.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): ImportedNumbersResource +``` + +## Parameters + + + +## Returns + +`ImportedNumbersResource` + +## Source + +[`src/rest/namespaces/imported-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/imported-numbers.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource/create.mdx new file mode 100644 index 0000000000..5a8d31f277 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.imported-numbers.ImportedNumbersResource.create" + parent: "rest.namespaces.imported-numbers.ImportedNumbersResource" + module: "rest.namespaces.imported-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/imported-numbers.ts" +--- +# `create` + +Import an externally-hosted phone number into this project. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Import payload specifying the number, carrier details, and any routing configuration required by the platform. + + +## Returns + +`Promise` — The newly-imported phone-number record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/imported-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/imported-numbers.ts) + +Line 28. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource/index.mdx new file mode 100644 index 0000000000..32dba40999 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/rest/namespaces/imported-numbers/imported-numbers-resource" +title: "ImportedNumbersResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.imported-numbers.ImportedNumbersResource" + parent: "rest.namespaces.imported-numbers" + module: "rest.namespaces.imported-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/imported-numbers.ts" +--- +# `ImportedNumbersResource` + +Import externally-hosted phone numbers. + +Access via `client.importedNumbers.*`. + +## Signature + +```typescript +class ImportedNumbersResource extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Import an externally-hosted phone number into this project. + + + +## Source + +[`src/rest/namespaces/imported-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/imported-numbers.ts) + +Line 15. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/index.mdx new file mode 100644 index 0000000000..2ba2c710b5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/imported-numbers/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/imported-numbers" +title: "imported-numbers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.imported-numbers" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/imported-numbers.ts" +--- +# `imported-numbers` + +## Signature + +```typescript +module imported-numbers +``` + +## Classes + + + + Import externally-hosted phone numbers. + + + +## Source + +[`src/rest/namespaces/imported-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/imported-numbers.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/conference-logs/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/conference-logs/constructor.mdx new file mode 100644 index 0000000000..d0df60c1ac --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/conference-logs/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/conference-logs/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.ConferenceLogs.constructor" + parent: "rest.namespaces.logs.ConferenceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): ConferenceLogs +``` + +## Parameters + + + + + +## Returns + +`ConferenceLogs` + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 113. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/conference-logs/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/conference-logs/index.mdx new file mode 100644 index 0000000000..14201a8e17 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/conference-logs/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/conference-logs" +title: "ConferenceLogs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.logs.ConferenceLogs" + parent: "rest.namespaces.logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `ConferenceLogs` + +Conference log queries. + +## Signature + +```typescript +class ConferenceLogs extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + List conference log entries. + + + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 112. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/conference-logs/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/conference-logs/list.mdx new file mode 100644 index 0000000000..891ca3b804 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/conference-logs/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/conference-logs/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.ConferenceLogs.list" + parent: "rest.namespaces.logs.ConferenceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `list` + +List conference log entries. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of conference log entries. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 124. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/constructor.mdx new file mode 100644 index 0000000000..dbff3693c4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/fax-logs/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.FaxLogs.constructor" + parent: "rest.namespaces.logs.FaxLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): FaxLogs +``` + +## Parameters + + + + + +## Returns + +`FaxLogs` + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 84. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/get.mdx new file mode 100644 index 0000000000..f9133f3369 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/fax-logs/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.FaxLogs.get" + parent: "rest.namespaces.logs.FaxLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `get` + +Fetch a single fax log entry by ID. + +## Signature + +```typescript +get(logId: string): Promise +``` + +## Parameters + + + Unique identifier of the log entry. + + +## Returns + +`Promise` — The log entry record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 106. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/index.mdx new file mode 100644 index 0000000000..92ea1c33ae --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/fax-logs" +title: "FaxLogs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.logs.FaxLogs" + parent: "rest.namespaces.logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `FaxLogs` + +Fax log queries. + +## Signature + +```typescript +class FaxLogs extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Fetch a single fax log entry by ID. + + + + List fax log entries. + + + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 83. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/list.mdx new file mode 100644 index 0000000000..11e58bb341 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/fax-logs/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/fax-logs/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.FaxLogs.list" + parent: "rest.namespaces.logs.FaxLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `list` + +List fax log entries. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of fax log entries. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/index.mdx new file mode 100644 index 0000000000..0132b4d69c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs" +title: "logs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.logs" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `logs` + +## Signature + +```typescript +module logs +``` + +## Classes + + + + Conference log queries. + + + + Fax log queries. + + + + Logs API namespace. + + + + Message log queries. + + + + Voice log queries. + + + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/logs-namespace/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/logs-namespace/constructor.mdx new file mode 100644 index 0000000000..77bd6bc7f1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/logs-namespace/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/logs-namespace/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.LogsNamespace.constructor" + parent: "rest.namespaces.logs.LogsNamespace" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): LogsNamespace +``` + +## Parameters + + + +## Returns + +`LogsNamespace` + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 145. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/logs-namespace/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/logs-namespace/index.mdx new file mode 100644 index 0000000000..eb6d00ec0c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/logs-namespace/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/logs-namespace" +title: "LogsNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.logs.LogsNamespace" + parent: "rest.namespaces.logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `LogsNamespace` + +Logs API namespace. + +Access via `client.logs.*`. Read-only access to message, voice, fax, and +conference logs for auditing and observability. + +## Signature + +```typescript +class LogsNamespace +``` + +## Properties + + + Conference log queries. + + + + Fax log queries. + + + + SMS/MMS message log queries. + + + + Voice call log queries with event drill-down. + + +## Methods + + + + + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 135. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/constructor.mdx new file mode 100644 index 0000000000..1db7f7ba81 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/message-logs/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.MessageLogs.constructor" + parent: "rest.namespaces.logs.MessageLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): MessageLogs +``` + +## Parameters + + + + + +## Returns + +`MessageLogs` + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 13. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/get.mdx new file mode 100644 index 0000000000..1d40f36e11 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/message-logs/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.MessageLogs.get" + parent: "rest.namespaces.logs.MessageLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `get` + +Fetch a single message log entry by ID. + +## Signature + +```typescript +get(logId: string): Promise +``` + +## Parameters + + + Unique identifier of the log entry. + + +## Returns + +`Promise` — The log entry record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 36. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/index.mdx new file mode 100644 index 0000000000..a6a723123c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/message-logs" +title: "MessageLogs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.logs.MessageLogs" + parent: "rest.namespaces.logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `MessageLogs` + +Message log queries. + +## Signature + +```typescript +class MessageLogs extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Fetch a single message log entry by ID. + + + + List message log entries. + + + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 12. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/list.mdx new file mode 100644 index 0000000000..930082bbdf --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/message-logs/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/message-logs/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.MessageLogs.list" + parent: "rest.namespaces.logs.MessageLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `list` + +List message log entries. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters (e.g. date range, direction, status). + + +## Returns + +`Promise` — A paginated list of message log entries. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 25. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/constructor.mdx new file mode 100644 index 0000000000..91648f8d09 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/voice-logs/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.VoiceLogs.constructor" + parent: "rest.namespaces.logs.VoiceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): VoiceLogs +``` + +## Parameters + + + + + +## Returns + +`VoiceLogs` + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 43. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/get.mdx new file mode 100644 index 0000000000..e81d260c6d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/voice-logs/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.VoiceLogs.get" + parent: "rest.namespaces.logs.VoiceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `get` + +Fetch a single voice log entry by ID. + +## Signature + +```typescript +get(logId: string): Promise +``` + +## Parameters + + + Unique identifier of the log entry. + + +## Returns + +`Promise` — The log entry record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 65. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/index.mdx new file mode 100644 index 0000000000..ec02abd05f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/voice-logs" +title: "VoiceLogs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.logs.VoiceLogs" + parent: "rest.namespaces.logs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `VoiceLogs` + +Voice log queries. + +## Signature + +```typescript +class VoiceLogs extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Fetch a single voice log entry by ID. + + + + List voice (call) log entries. + + + + List events captured during a voice log entry. + + + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 42. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/list-events.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/list-events.mdx new file mode 100644 index 0000000000..248ad65e39 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/list-events.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/voice-logs/list-events" +title: "listEvents" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.VoiceLogs.listEvents" + parent: "rest.namespaces.logs.VoiceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `listEvents` + +List events captured during a voice log entry. + +## Signature + +```typescript +listEvents(logId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the log entry. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of events for the log entry. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 77. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/list.mdx new file mode 100644 index 0000000000..bc1df27daf --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/logs/voice-logs/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/logs/voice-logs/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.logs.VoiceLogs.list" + parent: "rest.namespaces.logs.VoiceLogs" + module: "rest.namespaces.logs" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts" +--- +# `list` + +List voice (call) log entries. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of voice log entries. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/logs.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/logs.ts) + +Line 54. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/lookup/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/lookup/index.mdx new file mode 100644 index 0000000000..2b316275ec --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/lookup/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/lookup" +title: "lookup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.lookup" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/lookup.ts" +--- +# `lookup` + +## Signature + +```typescript +module lookup +``` + +## Classes + + + + Phone number lookup (carrier, CNAM). + + + +## Source + +[`src/rest/namespaces/lookup.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/lookup.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/lookup/lookup-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/lookup/lookup-resource/constructor.mdx new file mode 100644 index 0000000000..ea5fa8be72 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/lookup/lookup-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/lookup/lookup-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.lookup.LookupResource.constructor" + parent: "rest.namespaces.lookup.LookupResource" + module: "rest.namespaces.lookup" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/lookup.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): LookupResource +``` + +## Parameters + + + +## Returns + +`LookupResource` + +## Source + +[`src/rest/namespaces/lookup.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/lookup.ts) + +Line 22. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/lookup/lookup-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/lookup/lookup-resource/index.mdx new file mode 100644 index 0000000000..ca0d70b00a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/lookup/lookup-resource/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/namespaces/lookup/lookup-resource" +title: "LookupResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.lookup.LookupResource" + parent: "rest.namespaces.lookup" + module: "rest.namespaces.lookup" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/lookup.ts" +--- +# `LookupResource` + +Phone number lookup (carrier, CNAM). + +Access via `client.lookup.*`. + +## Signature + +```typescript +class LookupResource extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Examples + +```typescript +const info = await client.lookup.phoneNumber('+15551234567', { include: 'carrier,caller-name' }); +``` + +## Methods + + + + + + Look up carrier and CNAM information for a phone number. + + + +## Source + +[`src/rest/namespaces/lookup.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/lookup.ts) + +Line 21. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/lookup/lookup-resource/phone-number.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/lookup/lookup-resource/phone-number.mdx new file mode 100644 index 0000000000..6a99e9fd20 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/lookup/lookup-resource/phone-number.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/lookup/lookup-resource/phone-number" +title: "phoneNumber" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.lookup.LookupResource.phoneNumber" + parent: "rest.namespaces.lookup.LookupResource" + module: "rest.namespaces.lookup" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/lookup.ts" +--- +# `phoneNumber` + +Look up carrier and CNAM information for a phone number. + +## Signature + +```typescript +phoneNumber(e164: string, params?: QueryParams): Promise +``` + +## Parameters + + + The phone number in E.164 format (e.g. `"+15551234567"`). + + + + Optional query parameters, most commonly `include: "carrier,caller-name"` to enable carrier and CNAM lookups. + + +## Returns + +`Promise` — The lookup record containing any requested datasets. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/lookup.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/lookup.ts) + +Line 35. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/mfa/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/index.mdx new file mode 100644 index 0000000000..ba2af6fd4c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/mfa" +title: "mfa" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.mfa" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts" +--- +# `mfa` + +## Signature + +```typescript +module mfa +``` + +## Classes + + + + Multi-factor authentication via SMS or phone call. + + + +## Source + +[`src/rest/namespaces/mfa.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/call.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/call.mdx new file mode 100644 index 0000000000..c64590ab4d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/call.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/mfa/mfa-resource/call" +title: "call" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.mfa.MfaResource.call" + parent: "rest.namespaces.mfa.MfaResource" + module: "rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts" +--- +# `call` + +Initiate MFA by placing a phone call that reads out a one-time code. + +## Signature + +```typescript +call(body: any): Promise +``` + +## Parameters + + + MFA request payload (typically `{ to: "+15551234567" }`). + + +## Returns + +`Promise` — The MFA request record; its `id` is used by [verify](/reference/typescript/rest/namespaces/mfa/mfa-resource/verify). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/mfa.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts) + +Line 46. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/constructor.mdx new file mode 100644 index 0000000000..9957dbf972 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/mfa/mfa-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.mfa.MfaResource.constructor" + parent: "rest.namespaces.mfa.MfaResource" + module: "rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): MfaResource +``` + +## Parameters + + + +## Returns + +`MfaResource` + +## Source + +[`src/rest/namespaces/mfa.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts) + +Line 23. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/index.mdx new file mode 100644 index 0000000000..c8881118d1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/rest/namespaces/mfa/mfa-resource" +title: "MfaResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.mfa.MfaResource" + parent: "rest.namespaces.mfa" + module: "rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts" +--- +# `MfaResource` + +Multi-factor authentication via SMS or phone call. + +Access via `client.mfa.*`. Two-step flow: call `.sms()` or `.call()` to send +a code, then `.verify()` to confirm it. + +## Signature + +```typescript +class MfaResource extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Examples + +```typescript +const req = await client.mfa.sms({ to: '+15551234567' }); +const result = await client.mfa.verify(req.id, { token: '123456' }); +``` + +## Methods + + + + Initiate MFA by placing a phone call that reads out a one-time code. + + + + + + Initiate MFA by sending a one-time code to a phone number over SMS. + + + + Verify the one-time code the user received via SMS or call. + + + +## Source + +[`src/rest/namespaces/mfa.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts) + +Line 22. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/sms.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/sms.mdx new file mode 100644 index 0000000000..a86e90e387 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/sms.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/rest/namespaces/mfa/mfa-resource/sms" +title: "sms" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.mfa.MfaResource.sms" + parent: "rest.namespaces.mfa.MfaResource" + module: "rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts" +--- +# `sms` + +Initiate MFA by sending a one-time code to a phone number over SMS. + +## Signature + +```typescript +sms(body: any): Promise +``` + +## Parameters + + + MFA request payload (typically `{ to: "+15551234567", + message?: "Your code is {code}" }`). + + +## Returns + +`Promise` — The MFA request record; its `id` is used by [verify](/reference/typescript/rest/namespaces/mfa/mfa-resource/verify). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/mfa.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts) + +Line 35. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/verify.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/verify.mdx new file mode 100644 index 0000000000..0c267e3110 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/mfa/mfa-resource/verify.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/mfa/mfa-resource/verify" +title: "verify" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.mfa.MfaResource.verify" + parent: "rest.namespaces.mfa.MfaResource" + module: "rest.namespaces.mfa" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts" +--- +# `verify` + +Verify the one-time code the user received via SMS or call. + +## Signature + +```typescript +verify(requestId: string, body: any): Promise +``` + +## Parameters + + + The `id` returned from [sms](/reference/typescript/rest/namespaces/mfa/mfa-resource/sms) or [call](/reference/typescript/rest/namespaces/mfa/mfa-resource/call). + + + + Verification payload (typically `{ token: "123456" }`). + + +## Returns + +`Promise` — The verification result — success or failure shape. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/mfa.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/mfa.ts) + +Line 58. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/index.mdx new file mode 100644 index 0000000000..f789744f50 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups" +title: "number-groups" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.number-groups" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts" +--- +# `number-groups` + +## Signature + +```typescript +module number-groups +``` + +## Classes + + + + Number group management with membership operations. + + + +## Source + +[`src/rest/namespaces/number-groups.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/add-membership.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/add-membership.mdx new file mode 100644 index 0000000000..2ba4ca4e43 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/add-membership.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups/number-groups-resource/add-membership" +title: "addMembership" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.number-groups.NumberGroupsResource.addMembership" + parent: "rest.namespaces.number-groups.NumberGroupsResource" + module: "rest.namespaces.number-groups" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts" +--- +# `addMembership` + +Add a phone number to a group. + +## Signature + +```typescript +addMembership(groupId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the number group. + + + + Membership payload (typically `{ phone_number_id: "..." }`). + + +## Returns + +`Promise` — The newly-created membership record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/number-groups.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts) + +Line 43. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/constructor.mdx new file mode 100644 index 0000000000..b69dcd9316 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups/number-groups-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.number-groups.NumberGroupsResource.constructor" + parent: "rest.namespaces.number-groups.NumberGroupsResource" + module: "rest.namespaces.number-groups" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): NumberGroupsResource +``` + +## Parameters + + + +## Returns + +`NumberGroupsResource` + +## Source + +[`src/rest/namespaces/number-groups.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts) + +Line 19. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/create.mdx new file mode 100644 index 0000000000..0a8cf7b83e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups/number-groups-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.number-groups.NumberGroupsResource.create" + parent: "rest.namespaces.number-groups.NumberGroupsResource" + module: "rest.namespaces.number-groups" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/delete-membership.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/delete-membership.mdx new file mode 100644 index 0000000000..2c210263cc --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/delete-membership.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups/number-groups-resource/delete-membership" +title: "deleteMembership" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.number-groups.NumberGroupsResource.deleteMembership" + parent: "rest.namespaces.number-groups.NumberGroupsResource" + module: "rest.namespaces.number-groups" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts" +--- +# `deleteMembership` + +Remove a number from a group by deleting its membership. + +## Signature + +```typescript +deleteMembership(membershipId: string): Promise +``` + +## Parameters + + + Unique identifier of the membership. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/number-groups.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts) + +Line 65. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/delete.mdx new file mode 100644 index 0000000000..ba7b3e1b53 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups/number-groups-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.number-groups.NumberGroupsResource.delete" + parent: "rest.namespaces.number-groups.NumberGroupsResource" + module: "rest.namespaces.number-groups" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/get-membership.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/get-membership.mdx new file mode 100644 index 0000000000..675ba7b09a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/get-membership.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups/number-groups-resource/get-membership" +title: "getMembership" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.number-groups.NumberGroupsResource.getMembership" + parent: "rest.namespaces.number-groups.NumberGroupsResource" + module: "rest.namespaces.number-groups" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts" +--- +# `getMembership` + +Fetch a membership by ID. + +## Signature + +```typescript +getMembership(membershipId: string): Promise +``` + +## Parameters + + + Unique identifier of the membership. + + +## Returns + +`Promise` — The membership record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/number-groups.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts) + +Line 54. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/get.mdx new file mode 100644 index 0000000000..801a7ea68a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups/number-groups-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.number-groups.NumberGroupsResource.get" + parent: "rest.namespaces.number-groups.NumberGroupsResource" + module: "rest.namespaces.number-groups" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/index.mdx new file mode 100644 index 0000000000..bde5b991bb --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/index.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups/number-groups-resource" +title: "NumberGroupsResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.number-groups.NumberGroupsResource" + parent: "rest.namespaces.number-groups" + module: "rest.namespaces.number-groups" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts" +--- +# `NumberGroupsResource` + +Number group management with membership operations. + +Access via `client.numberGroups.*`. Extends standard CRUD with membership helpers. + +## Signature + +```typescript +class NumberGroupsResource extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + Add a phone number to a group. + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Remove a number from a group by deleting its membership. + + + + Fetch a single resource by ID. + + + + Fetch a membership by ID. + + + + List resources with optional query parameters. + + + + List memberships (phone-number assignments) in a group. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/number-groups.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/list-memberships.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/list-memberships.mdx new file mode 100644 index 0000000000..c1e2066e5a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/list-memberships.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups/number-groups-resource/list-memberships" +title: "listMemberships" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.number-groups.NumberGroupsResource.listMemberships" + parent: "rest.namespaces.number-groups.NumberGroupsResource" + module: "rest.namespaces.number-groups" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts" +--- +# `listMemberships` + +List memberships (phone-number assignments) in a group. + +## Signature + +```typescript +listMemberships(groupId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the number group. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of number-group memberships. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/number-groups.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/number-groups.ts) + +Line 31. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/list.mdx new file mode 100644 index 0000000000..75e4fe3624 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups/number-groups-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.number-groups.NumberGroupsResource.list" + parent: "rest.namespaces.number-groups.NumberGroupsResource" + module: "rest.namespaces.number-groups" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/update.mdx new file mode 100644 index 0000000000..2369dd7a10 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/number-groups/number-groups-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/number-groups/number-groups-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.number-groups.NumberGroupsResource.update" + parent: "rest.namespaces.number-groups.NumberGroupsResource" + module: "rest.namespaces.number-groups" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/index.mdx new file mode 100644 index 0000000000..5cbb988c92 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers" +title: "phone-numbers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `phone-numbers` + +## Signature + +```typescript +module phone-numbers +``` + +## Classes + + + + Phone number management. + + + +## Interfaces + + + + Parameters for [PhoneNumbersResource.setCallFlow](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-call-flow). + + + + Parameters for [PhoneNumbersResource.setCxmlWebhook](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-webhook). + + + + Parameters for [PhoneNumbersResource.setRelayTopic](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-topic). + + + + Optional companion fields for [PhoneNumbersResource.setSwmlWebhook](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook). + + + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/constructor.mdx new file mode 100644 index 0000000000..d1036751e6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.constructor" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): PhoneNumbersResource +``` + +## Parameters + + + +## Returns + +`PhoneNumbersResource` + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 77. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/create.mdx new file mode 100644 index 0000000000..e8bfdfd7a5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/create.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.create" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `create` + +Purchase / create a phone number resource in this project. +Body is optional to match Python's `**kwargs` call convention. + +## Signature + +```typescript +create(body: any = {}): Promise +``` + +## Parameters + + + Phone-number creation payload (platform-shaped JSON). Defaults to `{}` when omitted. + + +## Returns + +`Promise` — The newly-created phone-number resource. + +## Throws + +- On any non-2xx HTTP response. + +## Examples + +```typescript +const num = await client.phoneNumbers.create({ number: '+15551234567' }); +``` + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/delete.mdx new file mode 100644 index 0000000000..95707eef9c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.delete" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/get.mdx new file mode 100644 index 0000000000..4394c453e0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.get" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/index.mdx new file mode 100644 index 0000000000..c57104f282 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/index.mdx @@ -0,0 +1,108 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource" +title: "PhoneNumbersResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource" + parent: "rest.namespaces.phone-numbers" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `PhoneNumbersResource` + +Phone number management. + +Supports the standard CRUD surface plus typed helpers for binding an +inbound call to a handler (SWML webhook, cXML webhook, AI agent, call +flow, RELAY application/topic). The binding model is: set `call_handler` + +- the handler-specific companion field on the phone number; the server + auto-materializes the matching Fabric resource. See + `PhoneCallHandler` for the enum of valid `call_handler` values. + +`create` and `update` accept an untyped body object (`body: any = {}`). +No `PhoneNumberCreateParams` / `PhoneNumberUpdateParams` interfaces are +defined because the Python reference SDK uses bare `**kwargs` with no +named or typed parameters — there is no Python type contract to port. +This is an intentional IDIOMATIC\_DEVIATION: Python kwargs ↔ TS `any` object +literal with an optional default of `{}` to preserve call-without-args +semantics. If the REST API stabilises a known field set, consider adding +typed interfaces and specialising `CrudResource<>` generics here. + +## Signature + +```typescript +class PhoneNumbersResource extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Purchase / create a phone number resource in this project. Body is optional to match Python's `**kwargs` call convention. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + Search available phone numbers for purchase. + + + + Route inbound calls to an AI Agent Fabric resource by ID. + + + + Route inbound calls to a Call Flow by ID. + + + + Route inbound calls to an existing cXML application by ID. + + + + Route inbound calls to a cXML (Twilio-compat / LAML) webhook. + + + + Route inbound calls to a named RELAY application. + + + + Route inbound calls to a RELAY topic (client subscription). + + + + Route inbound calls to an SWML webhook URL. + + + + Update a phone number resource by ID. Body is optional to match Python `**kwargs`. + + + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 74. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/list.mdx new file mode 100644 index 0000000000..d8f5cad47b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.list" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/search.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/search.mdx new file mode 100644 index 0000000000..1818747f1e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/search.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/search" +title: "search" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.search" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `search` + +Search available phone numbers for purchase. + +## Signature + +```typescript +search(params?: QueryParams): Promise +``` + +## Parameters + + + Search filters (e.g. `areaCode`, `contains`, `region`, `number_type`, pagination). + + +## Returns + +`Promise` — A paginated list of matching available numbers. + +## Throws + +- On any non-2xx HTTP response. + +## Examples + +```typescript +const results = await client.phoneNumbers.search({ areaCode: '512', contains: '5555' }); +``` + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 129. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-ai-agent.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-ai-agent.mdx new file mode 100644 index 0000000000..827d283318 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-ai-agent.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-ai-agent" +title: "setAiAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.setAiAgent" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `setAiAgent` + +Route inbound calls to an AI Agent Fabric resource by ID. + +## Signature + +```typescript +setAiAgent( + resourceId: string, + agentId: string, + extra: Record = {} +): Promise +``` + +## Parameters + + + Unique phone-number resource ID. + + + + AI agent Fabric resource ID. + + + + Additional wire-level fields merged into the body. + + +## Returns + +`Promise` — The updated phone-number resource. + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 227. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-call-flow.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-call-flow.mdx new file mode 100644 index 0000000000..7cc95515ca --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-call-flow.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-call-flow" +title: "setCallFlow" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.setCallFlow" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `setCallFlow` + +Route inbound calls to a Call Flow by ID. + +`version` accepts `"working_copy"` or `"current_deployed"` (server +default when omitted). + +## Signature + +```typescript +setCallFlow(resourceId: string, params: SetCallFlowParams): Promise +``` + +## Parameters + + + Unique phone-number resource ID. + + + + Flow ID and optional pinned version plus any extra wire-level fields. + + +## Returns + +`Promise` — The updated phone-number resource. + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 246. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-application.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-application.mdx new file mode 100644 index 0000000000..8e9ab5cc80 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-application.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-application" +title: "setCxmlApplication" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.setCxmlApplication" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `setCxmlApplication` + +Route inbound calls to an existing cXML application by ID. + +## Signature + +```typescript +setCxmlApplication( + resourceId: string, + applicationId: string, + extra: Record = {} +): Promise +``` + +## Parameters + + + Unique phone-number resource ID. + + + + cXML application ID. + + + + Additional wire-level fields merged into the body. + + +## Returns + +`Promise` — The updated phone-number resource. + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 211. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-webhook.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-webhook.mdx new file mode 100644 index 0000000000..5e9437766a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-webhook.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-webhook" +title: "setCxmlWebhook" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.setCxmlWebhook" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `setCxmlWebhook` + +Route inbound calls to a cXML (Twilio-compat / LAML) webhook. + +Despite the wire value `laml_webhooks` being plural, this creates a +single `cxml_webhook` Fabric resource. `fallbackUrl` is used when the +primary URL fails; `statusCallbackUrl` receives call status updates. + +## Signature + +```typescript +setCxmlWebhook(resourceId: string, params: SetCxmlWebhookParams): Promise +``` + +## Parameters + + + Unique phone-number resource ID. + + + + URL and optional fallback/status URLs plus any extra wire-level fields. + + +## Returns + +`Promise` — The updated phone-number resource. + +## Examples + +```typescript +await client.phoneNumbers.setCxmlWebhook('pn-1', { + url: 'https://example.com/voice.xml', + fallbackUrl: 'https://example.com/fallback.xml', +}); +``` + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 187. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-application.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-application.mdx new file mode 100644 index 0000000000..bd19ae984d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-application.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-application" +title: "setRelayApplication" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.setRelayApplication" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `setRelayApplication` + +Route inbound calls to a named RELAY application. + +## Signature + +```typescript +setRelayApplication( + resourceId: string, + name: string, + extra: Record = {} +): Promise +``` + +## Parameters + + + Unique phone-number resource ID. + + + + RELAY application name. + + + + Additional wire-level fields merged into the body. + + +## Returns + +`Promise` — The updated phone-number resource. + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 267. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-topic.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-topic.mdx new file mode 100644 index 0000000000..c8a054931c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-topic.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-topic" +title: "setRelayTopic" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.setRelayTopic" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `setRelayTopic` + +Route inbound calls to a RELAY topic (client subscription). + +## Signature + +```typescript +setRelayTopic(resourceId: string, params: SetRelayTopicParams): Promise +``` + +## Parameters + + + Unique phone-number resource ID. + + + + Topic name and optional status-callback URL plus any extra wire-level fields. + + +## Returns + +`Promise` — The updated phone-number resource. + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 283. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook.mdx new file mode 100644 index 0000000000..b100c2a1a9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook" +title: "setSwmlWebhook" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.setSwmlWebhook" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `setSwmlWebhook` + +Route inbound calls to an SWML webhook URL. + +Your backend returns an SWML document per call. The server +auto-creates a `swml_webhook` Fabric resource keyed off this URL — +you do **not** need to call `fabric.swmlWebhooks.create` or +`fabric.resources.assignPhoneRoute`. + +## Signature + +```typescript +setSwmlWebhook( + resourceId: string, + url: string, + extra: SetSwmlWebhookExtra = {} +): Promise +``` + +## Parameters + + + Unique phone-number resource ID. + + + + Your backend's SWML endpoint. + + + + Additional wire-level fields (e.g. `name`) merged into the PUT body. + + +## Returns + +`Promise` — The updated phone-number resource. + +## Examples + +```typescript +await client.phoneNumbers.setSwmlWebhook('pn-1', 'https://example.com/swml'); +``` + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 159. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/update.mdx new file mode 100644 index 0000000000..ddbd51db12 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/update.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.PhoneNumbersResource.update" + parent: "rest.namespaces.phone-numbers.PhoneNumbersResource" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `update` + +Update a phone number resource by ID. Body is optional to match Python `**kwargs`. + +Setting `call_handler` + the matching companion field (see +`PhoneCallHandler`) on the phone number auto-materializes the +matching Fabric resource on the server; prefer the `set*` helpers +below for the common cases. + +## Signature + +```typescript +update(resourceId: string, body: any = {}): Promise +``` + +## Parameters + + + Unique phone-number resource ID. + + + + Partial update payload. Defaults to `{}`. + + +## Returns + +`Promise` — The updated phone-number resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 112. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-call-flow-params/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-call-flow-params/index.mdx new file mode 100644 index 0000000000..192becfeb6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-call-flow-params/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/set-call-flow-params" +title: "SetCallFlowParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.SetCallFlowParams" + parent: "rest.namespaces.phone-numbers" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `SetCallFlowParams` + +Parameters for [PhoneNumbersResource.setCallFlow](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-call-flow). + +## Signature + +```typescript +interface SetCallFlowParams +``` + +## Properties + + + Call Flow resource ID. Serialized as `call_flow_id`. + + + + Optional pinned version — `"working_copy"` or `"current_deployed"` (server default when omitted). Serialized as `call_flow_version`. + + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 30. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-cxml-webhook-params/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-cxml-webhook-params/index.mdx new file mode 100644 index 0000000000..1778429d97 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-cxml-webhook-params/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/set-cxml-webhook-params" +title: "SetCxmlWebhookParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.SetCxmlWebhookParams" + parent: "rest.namespaces.phone-numbers" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `SetCxmlWebhookParams` + +Parameters for [PhoneNumbersResource.setCxmlWebhook](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-cxml-webhook). + +## Signature + +```typescript +interface SetCxmlWebhookParams +``` + +## Properties + + + Fallback URL if the primary request fails. Serialized as `call_fallback_url`. + + + + Status callback URL for call status updates. Serialized as `call_status_callback_url`. + + + + Primary cXML document URL. Serialized as `call_request_url`. + + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 18. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-relay-topic-params/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-relay-topic-params/index.mdx new file mode 100644 index 0000000000..1106149288 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-relay-topic-params/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/set-relay-topic-params" +title: "SetRelayTopicParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.SetRelayTopicParams" + parent: "rest.namespaces.phone-numbers" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `SetRelayTopicParams` + +Parameters for [PhoneNumbersResource.setRelayTopic](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-relay-topic). + +## Signature + +```typescript +interface SetRelayTopicParams +``` + +## Properties + + + Optional status callback URL for RELAY topic delivery updates. Serialized as `call_relay_topic_status_callback_url`. + + + + RELAY topic name. Serialized as `call_relay_topic`. + + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 43. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-swml-webhook-extra/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-swml-webhook-extra/index.mdx new file mode 100644 index 0000000000..8710648535 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/phone-numbers/set-swml-webhook-extra/index.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/rest/namespaces/phone-numbers/set-swml-webhook-extra" +title: "SetSwmlWebhookExtra" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "rest.namespaces.phone-numbers.SetSwmlWebhookExtra" + parent: "rest.namespaces.phone-numbers" + module: "rest.namespaces.phone-numbers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts" +--- +# `SetSwmlWebhookExtra` + +Optional companion fields for [PhoneNumbersResource.setSwmlWebhook](/reference/typescript/rest/namespaces/phone-numbers/phone-numbers-resource/set-swml-webhook). + +## Signature + +```typescript +interface SetSwmlWebhookExtra +``` + +## Source + +[`src/rest/namespaces/phone-numbers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/phone-numbers.ts) + +Line 13. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/project/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/project/index.mdx new file mode 100644 index 0000000000..857f6bfc40 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/project/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/rest/namespaces/project" +title: "project" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.project" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts" +--- +# `project` + +## Signature + +```typescript +module project +``` + +## Classes + + + + Project API namespace. + + + + Project API token management. + + + +## Source + +[`src/rest/namespaces/project.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/project/project-namespace/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-namespace/constructor.mdx new file mode 100644 index 0000000000..819eef948f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-namespace/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/project/project-namespace/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.project.ProjectNamespace.constructor" + parent: "rest.namespaces.project.ProjectNamespace" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): ProjectNamespace +``` + +## Parameters + + + +## Returns + +`ProjectNamespace` + +## Source + +[`src/rest/namespaces/project.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts) + +Line 62. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/project/project-namespace/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-namespace/index.mdx new file mode 100644 index 0000000000..e3056b82d7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-namespace/index.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/rest/namespaces/project/project-namespace" +title: "ProjectNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.project.ProjectNamespace" + parent: "rest.namespaces.project" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts" +--- +# `ProjectNamespace` + +Project API namespace. + +Access via `client.project.*`. Manages project-level resources like +secondary API tokens. + +## Signature + +```typescript +class ProjectNamespace +``` + +## Properties + + + Project-scoped API token create / update / delete. + + +## Methods + + + + + +## Source + +[`src/rest/namespaces/project.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts) + +Line 58. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/constructor.mdx new file mode 100644 index 0000000000..0fc19a734f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/project/project-tokens/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.project.ProjectTokens.constructor" + parent: "rest.namespaces.project.ProjectTokens" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): ProjectTokens +``` + +## Parameters + + + +## Returns + +`ProjectTokens` + +## Source + +[`src/rest/namespaces/project.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts) + +Line 12. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/create.mdx new file mode 100644 index 0000000000..ba8e281d86 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/project/project-tokens/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.project.ProjectTokens.create" + parent: "rest.namespaces.project.ProjectTokens" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts" +--- +# `create` + +Create a new project-scoped API token. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Token creation payload (friendly name, scopes, etc.). + + +## Returns + +`Promise` — The newly-created token record, including the secret value (which is typically returned ONCE and not retrievable again). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/project.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts) + +Line 24. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/delete.mdx new file mode 100644 index 0000000000..2ec5d85d5d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/project/project-tokens/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.project.ProjectTokens.delete" + parent: "rest.namespaces.project.ProjectTokens" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts" +--- +# `delete` + +Revoke and delete a project API token. + +## Signature + +```typescript +delete(tokenId: string): Promise +``` + +## Parameters + + + Unique identifier of the token to revoke. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/project.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts) + +Line 47. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/index.mdx new file mode 100644 index 0000000000..613d63eab6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/namespaces/project/project-tokens" +title: "ProjectTokens" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.project.ProjectTokens" + parent: "rest.namespaces.project" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts" +--- +# `ProjectTokens` + +Project API token management. + +## Signature + +```typescript +class ProjectTokens extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Create a new project-scoped API token. + + + + Revoke and delete a project API token. + + + + Update a project API token's attributes (e.g. friendly name). + + + +## Source + +[`src/rest/namespaces/project.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts) + +Line 11. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/update.mdx new file mode 100644 index 0000000000..f9a79c7927 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/project/project-tokens/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/project/project-tokens/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.project.ProjectTokens.update" + parent: "rest.namespaces.project.ProjectTokens" + module: "rest.namespaces.project" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts" +--- +# `update` + +Update a project API token's attributes (e.g. friendly name). + +## Signature + +```typescript +update(tokenId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the token. + + + + Partial update payload. + + +## Returns + +`Promise` — The updated token record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/project.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/project.ts) + +Line 36. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/index.mdx new file mode 100644 index 0000000000..0e573092e1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/pubsub" +title: "pubsub" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.pubsub" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/pubsub.ts" +--- +# `pubsub` + +## Signature + +```typescript +module pubsub +``` + +## Classes + + + + PubSub token generation. + + + +## Source + +[`src/rest/namespaces/pubsub.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/pubsub.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/pub-sub-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/pub-sub-resource/constructor.mdx new file mode 100644 index 0000000000..af3cd0efdb --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/pub-sub-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/pubsub/pub-sub-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.pubsub.PubSubResource.constructor" + parent: "rest.namespaces.pubsub.PubSubResource" + module: "rest.namespaces.pubsub" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/pubsub.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): PubSubResource +``` + +## Parameters + + + +## Returns + +`PubSubResource` + +## Source + +[`src/rest/namespaces/pubsub.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/pubsub.ts) + +Line 17. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/pub-sub-resource/create-token.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/pub-sub-resource/create-token.mdx new file mode 100644 index 0000000000..cab519b40a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/pub-sub-resource/create-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/pubsub/pub-sub-resource/create-token" +title: "createToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.pubsub.PubSubResource.createToken" + parent: "rest.namespaces.pubsub.PubSubResource" + module: "rest.namespaces.pubsub" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/pubsub.ts" +--- +# `createToken` + +Generate a short-lived PubSub token. + +## Signature + +```typescript +createToken(body: any): Promise +``` + +## Parameters + + + Token payload (e.g. `{ namespace, channels, expires_in }`). + + +## Returns + +`Promise` — The token record, typically `{ token: "eyJ..." }`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/pubsub.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/pubsub.ts) + +Line 28. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/pub-sub-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/pub-sub-resource/index.mdx new file mode 100644 index 0000000000..71bad10a4f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/pubsub/pub-sub-resource/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/rest/namespaces/pubsub/pub-sub-resource" +title: "PubSubResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.pubsub.PubSubResource" + parent: "rest.namespaces.pubsub" + module: "rest.namespaces.pubsub" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/pubsub.ts" +--- +# `PubSubResource` + +PubSub token generation. + +Access via `client.pubsub.*`. Issues short-lived tokens that browser / mobile +clients can use to subscribe to project channels. + +## Signature + +```typescript +class PubSubResource extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Generate a short-lived PubSub token. + + + +## Source + +[`src/rest/namespaces/pubsub.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/pubsub.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/queues/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/queues/index.mdx new file mode 100644 index 0000000000..372b5bd189 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/queues/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/queues" +title: "queues" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.queues" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts" +--- +# `queues` + +## Signature + +```typescript +module queues +``` + +## Classes + + + + Queue management with member operations. + + + +## Source + +[`src/rest/namespaces/queues.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/constructor.mdx new file mode 100644 index 0000000000..1edc1d437f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/queues/queues-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.queues.QueuesResource.constructor" + parent: "rest.namespaces.queues.QueuesResource" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): QueuesResource +``` + +## Parameters + + + +## Returns + +`QueuesResource` + +## Source + +[`src/rest/namespaces/queues.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts) + +Line 19. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/create.mdx new file mode 100644 index 0000000000..205edc5936 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/queues/queues-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.queues.QueuesResource.create" + parent: "rest.namespaces.queues.QueuesResource" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/delete.mdx new file mode 100644 index 0000000000..66102ec07c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/queues/queues-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.queues.QueuesResource.delete" + parent: "rest.namespaces.queues.QueuesResource" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/get-member.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/get-member.mdx new file mode 100644 index 0000000000..63b58ec1a5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/get-member.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/queues/queues-resource/get-member" +title: "getMember" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.queues.QueuesResource.getMember" + parent: "rest.namespaces.queues.QueuesResource" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts" +--- +# `getMember` + +Fetch a specific queue member by ID. + +## Signature + +```typescript +getMember(queueId: string, memberId: string): Promise +``` + +## Parameters + + + Unique identifier of the queue. + + + + Unique identifier of the queue member. + + +## Returns + +`Promise` — The queue member record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/queues.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/get-next-member.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/get-next-member.mdx new file mode 100644 index 0000000000..c508f72fa5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/get-next-member.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/queues/queues-resource/get-next-member" +title: "getNextMember" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.queues.QueuesResource.getNextMember" + parent: "rest.namespaces.queues.QueuesResource" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts" +--- +# `getNextMember` + +Get the next member to be served in a queue (FIFO head). + +## Signature + +```typescript +getNextMember(queueId: string): Promise +``` + +## Parameters + + + Unique identifier of the queue. + + +## Returns + +`Promise` — The next queue member record, or a platform-shaped empty response when the queue is empty. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/queues.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts) + +Line 43. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/get.mdx new file mode 100644 index 0000000000..279fcffd32 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/queues/queues-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.queues.QueuesResource.get" + parent: "rest.namespaces.queues.QueuesResource" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/index.mdx new file mode 100644 index 0000000000..db023c4716 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/typescript/rest/namespaces/queues/queues-resource" +title: "QueuesResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.queues.QueuesResource" + parent: "rest.namespaces.queues" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts" +--- +# `QueuesResource` + +Queue management with member operations. + +Access via `client.queues.*`. Extends standard CRUD with member list/fetch. + +## Signature + +```typescript +class QueuesResource extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + Fetch a specific queue member by ID. + + + + Get the next member to be served in a queue (FIFO head). + + + + List resources with optional query parameters. + + + + List members in a queue. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/queues.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/list-members.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/list-members.mdx new file mode 100644 index 0000000000..7fa73c0405 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/list-members.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/queues/queues-resource/list-members" +title: "listMembers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.queues.QueuesResource.listMembers" + parent: "rest.namespaces.queues.QueuesResource" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts" +--- +# `listMembers` + +List members in a queue. + +## Signature + +```typescript +listMembers(queueId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the queue. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of queue members. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/queues.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/queues.ts) + +Line 31. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/list.mdx new file mode 100644 index 0000000000..87ad387676 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/queues/queues-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.queues.QueuesResource.list" + parent: "rest.namespaces.queues.QueuesResource" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/update.mdx new file mode 100644 index 0000000000..d8393bb9d9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/queues/queues-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/queues/queues-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.queues.QueuesResource.update" + parent: "rest.namespaces.queues.QueuesResource" + module: "rest.namespaces.queues" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/recordings/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/index.mdx new file mode 100644 index 0000000000..723a9c183a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/recordings" +title: "recordings" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.recordings" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts" +--- +# `recordings` + +## Signature + +```typescript +module recordings +``` + +## Classes + + + + Recording management (read-only + delete). + + + +## Source + +[`src/rest/namespaces/recordings.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/constructor.mdx new file mode 100644 index 0000000000..94eb6a60d5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/recordings/recordings-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.recordings.RecordingsResource.constructor" + parent: "rest.namespaces.recordings.RecordingsResource" + module: "rest.namespaces.recordings" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): RecordingsResource +``` + +## Parameters + + + +## Returns + +`RecordingsResource` + +## Source + +[`src/rest/namespaces/recordings.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts) + +Line 17. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/delete.mdx new file mode 100644 index 0000000000..4621d8d969 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/recordings/recordings-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.recordings.RecordingsResource.delete" + parent: "rest.namespaces.recordings.RecordingsResource" + module: "rest.namespaces.recordings" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts" +--- +# `delete` + +Delete a recording. + +## Signature + +```typescript +delete(recordingId: string): Promise +``` + +## Parameters + + + Unique identifier of the recording. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/recordings.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts) + +Line 50. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/get.mdx new file mode 100644 index 0000000000..a04568d941 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/recordings/recordings-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.recordings.RecordingsResource.get" + parent: "rest.namespaces.recordings.RecordingsResource" + module: "rest.namespaces.recordings" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts" +--- +# `get` + +Fetch a recording's metadata by ID. + +## Signature + +```typescript +get(recordingId: string): Promise +``` + +## Parameters + + + Unique identifier of the recording. + + +## Returns + +`Promise` — The recording metadata record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/recordings.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts) + +Line 39. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/index.mdx new file mode 100644 index 0000000000..a5e31d8039 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/rest/namespaces/recordings/recordings-resource" +title: "RecordingsResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.recordings.RecordingsResource" + parent: "rest.namespaces.recordings" + module: "rest.namespaces.recordings" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts" +--- +# `RecordingsResource` + +Recording management (read-only + delete). + +Access via `client.recordings.*`. + +## Signature + +```typescript +class RecordingsResource extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Delete a recording. + + + + Fetch a recording's metadata by ID. + + + + List recordings in the project. + + + +## Source + +[`src/rest/namespaces/recordings.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/list.mdx new file mode 100644 index 0000000000..46c748263b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/recordings/recordings-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/recordings/recordings-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.recordings.RecordingsResource.list" + parent: "rest.namespaces.recordings.RecordingsResource" + module: "rest.namespaces.recordings" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts" +--- +# `list` + +List recordings in the project. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of recordings. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/recordings.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/recordings.ts) + +Line 28. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/index.mdx new file mode 100644 index 0000000000..bb13a1b13d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry" +title: "registry" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.registry" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `registry` + +## Signature + +```typescript +module registry +``` + +## Classes + + + + 10DLC brand management. + + + + 10DLC campaign management. + + + + 10DLC Campaign Registry namespace. + + + + 10DLC number assignment management. + + + + 10DLC assignment order management. + + + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/constructor.mdx new file mode 100644 index 0000000000..ceefc28c04 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-brands/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryBrands.constructor" + parent: "rest.namespaces.registry.RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): RegistryBrands +``` + +## Parameters + + + + + +## Returns + +`RegistryBrands` + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 13. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/create-campaign.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/create-campaign.mdx new file mode 100644 index 0000000000..f29b8b7fef --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/create-campaign.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-brands/create-campaign" +title: "createCampaign" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryBrands.createCampaign" + parent: "rest.namespaces.registry.RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `createCampaign` + +Register a new campaign under a brand. + +## Signature + +```typescript +createCampaign(brandId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the brand. + + + + Campaign registration payload (use case, sample messages, etc.). + + +## Returns + +`Promise` — The newly-registered campaign record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 70. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/create.mdx new file mode 100644 index 0000000000..beea1a5b42 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-brands/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryBrands.create" + parent: "rest.namespaces.registry.RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `create` + +Register a new 10DLC brand. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Brand registration payload (EIN, legal name, etc.). + + +## Returns + +`Promise` — The newly-registered brand record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 35. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/get.mdx new file mode 100644 index 0000000000..deee44cfa9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-brands/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryBrands.get" + parent: "rest.namespaces.registry.RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `get` + +Fetch a brand by ID. + +## Signature + +```typescript +get(brandId: string): Promise +``` + +## Parameters + + + Unique identifier of the brand. + + +## Returns + +`Promise` — The brand record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 46. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/index.mdx new file mode 100644 index 0000000000..225dec730f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-brands" +title: "RegistryBrands" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryBrands" + parent: "rest.namespaces.registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `RegistryBrands` + +10DLC brand management. + +## Signature + +```typescript +class RegistryBrands extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Register a new 10DLC brand. + + + + Register a new campaign under a brand. + + + + Fetch a brand by ID. + + + + List all 10DLC brands in the project. + + + + List campaigns registered under a brand. + + + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 12. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/list-campaigns.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/list-campaigns.mdx new file mode 100644 index 0000000000..4766b9bb0d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/list-campaigns.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-brands/list-campaigns" +title: "listCampaigns" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryBrands.listCampaigns" + parent: "rest.namespaces.registry.RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `listCampaigns` + +List campaigns registered under a brand. + +## Signature + +```typescript +listCampaigns(brandId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the brand. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of campaigns. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 58. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/list.mdx new file mode 100644 index 0000000000..947b584683 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-brands/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-brands/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryBrands.list" + parent: "rest.namespaces.registry.RegistryBrands" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `list` + +List all 10DLC brands in the project. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of brands. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 24. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/constructor.mdx new file mode 100644 index 0000000000..a5a85f2236 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-campaigns/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryCampaigns.constructor" + parent: "rest.namespaces.registry.RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): RegistryCampaigns +``` + +## Parameters + + + + + +## Returns + +`RegistryCampaigns` + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 77. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/create-order.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/create-order.mdx new file mode 100644 index 0000000000..323ac38651 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/create-order.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-campaigns/create-order" +title: "createOrder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryCampaigns.createOrder" + parent: "rest.namespaces.registry.RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `createOrder` + +Create a new number-assignment order against a campaign. + +## Signature + +```typescript +createOrder(campaignId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the campaign. + + + + Order payload (phone number IDs, etc.). + + +## Returns + +`Promise` — The newly-created order record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 136. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/get.mdx new file mode 100644 index 0000000000..8e4869ccce --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-campaigns/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryCampaigns.get" + parent: "rest.namespaces.registry.RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `get` + +Fetch a campaign by ID. + +## Signature + +```typescript +get(campaignId: string): Promise +``` + +## Parameters + + + Unique identifier of the campaign. + + +## Returns + +`Promise` — The campaign record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 88. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/index.mdx new file mode 100644 index 0000000000..e0f7b3f86b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-campaigns" +title: "RegistryCampaigns" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryCampaigns" + parent: "rest.namespaces.registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `RegistryCampaigns` + +10DLC campaign management. + +## Signature + +```typescript +class RegistryCampaigns extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Create a new number-assignment order against a campaign. + + + + Fetch a campaign by ID. + + + + List the phone numbers assigned to a campaign. + + + + List number-assignment orders for a campaign. + + + + Update a campaign's attributes. + + + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 76. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/list-numbers.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/list-numbers.mdx new file mode 100644 index 0000000000..e963bf880c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/list-numbers.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-campaigns/list-numbers" +title: "listNumbers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryCampaigns.listNumbers" + parent: "rest.namespaces.registry.RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `listNumbers` + +List the phone numbers assigned to a campaign. + +## Signature + +```typescript +listNumbers(campaignId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the campaign. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of assigned numbers. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 112. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/list-orders.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/list-orders.mdx new file mode 100644 index 0000000000..cb88d2efc8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/list-orders.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-campaigns/list-orders" +title: "listOrders" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryCampaigns.listOrders" + parent: "rest.namespaces.registry.RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `listOrders` + +List number-assignment orders for a campaign. + +## Signature + +```typescript +listOrders(campaignId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the campaign. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of number-assignment orders. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 124. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/update.mdx new file mode 100644 index 0000000000..ae4fb163af --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-campaigns/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-campaigns/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryCampaigns.update" + parent: "rest.namespaces.registry.RegistryCampaigns" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `update` + +Update a campaign's attributes. + +## Signature + +```typescript +update(campaignId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the campaign. + + + + Full updated campaign attributes (replace semantics). + + +## Returns + +`Promise` — The updated campaign record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 100. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-namespace/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-namespace/constructor.mdx new file mode 100644 index 0000000000..ffe83b58ce --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-namespace/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-namespace/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryNamespace.constructor" + parent: "rest.namespaces.registry.RegistryNamespace" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): RegistryNamespace +``` + +## Parameters + + + +## Returns + +`RegistryNamespace` + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 193. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-namespace/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-namespace/index.mdx new file mode 100644 index 0000000000..e14d622c9a --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-namespace/index.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-namespace" +title: "RegistryNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryNamespace" + parent: "rest.namespaces.registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `RegistryNamespace` + +10DLC Campaign Registry namespace. + +Access via `client.registry.*`. Groups brand, campaign, order, and number +resources for US A2P 10DLC compliance registration. + +## Signature + +```typescript +class RegistryNamespace +``` + +## Properties + + + 10DLC brand CRUD and nested campaign operations. + + + + 10DLC campaign CRUD, number listing, and order management. + + + + 10DLC number assignment removal. + + + + 10DLC number-assignment order read access. + + +## Methods + + + + + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 183. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-numbers/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-numbers/constructor.mdx new file mode 100644 index 0000000000..f6803d0511 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-numbers/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-numbers/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryNumbers.constructor" + parent: "rest.namespaces.registry.RegistryNumbers" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): RegistryNumbers +``` + +## Parameters + + + + + +## Returns + +`RegistryNumbers` + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 161. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-numbers/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-numbers/delete.mdx new file mode 100644 index 0000000000..4810ac5713 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-numbers/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-numbers/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryNumbers.delete" + parent: "rest.namespaces.registry.RegistryNumbers" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `delete` + +Remove a number from a 10DLC campaign assignment. + +## Signature + +```typescript +delete(numberId: string): Promise +``` + +## Parameters + + + Unique identifier of the assigned number. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 172. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-numbers/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-numbers/index.mdx new file mode 100644 index 0000000000..ee17007405 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-numbers/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-numbers" +title: "RegistryNumbers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryNumbers" + parent: "rest.namespaces.registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `RegistryNumbers` + +10DLC number assignment management. + +## Signature + +```typescript +class RegistryNumbers extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Remove a number from a 10DLC campaign assignment. + + + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 160. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-orders/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-orders/constructor.mdx new file mode 100644 index 0000000000..cbd15be458 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-orders/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-orders/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryOrders.constructor" + parent: "rest.namespaces.registry.RegistryOrders" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): RegistryOrders +``` + +## Parameters + + + + + +## Returns + +`RegistryOrders` + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 143. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-orders/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-orders/get.mdx new file mode 100644 index 0000000000..af21773e52 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-orders/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-orders/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryOrders.get" + parent: "rest.namespaces.registry.RegistryOrders" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `get` + +Fetch a number-assignment order by ID. + +## Signature + +```typescript +get(orderId: string): Promise +``` + +## Parameters + + + Unique identifier of the order. + + +## Returns + +`Promise` — The order record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 154. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-orders/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-orders/index.mdx new file mode 100644 index 0000000000..34b6b32556 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/registry/registry-orders/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/registry/registry-orders" +title: "RegistryOrders" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.registry.RegistryOrders" + parent: "rest.namespaces.registry" + module: "rest.namespaces.registry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts" +--- +# `RegistryOrders` + +10DLC assignment order management. + +## Signature + +```typescript +class RegistryOrders extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Fetch a number-assignment order by ID. + + + +## Source + +[`src/rest/namespaces/registry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/registry.ts) + +Line 142. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/index.mdx new file mode 100644 index 0000000000..55bff2eac5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/short-codes" +title: "short-codes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.short-codes" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts" +--- +# `short-codes` + +## Signature + +```typescript +module short-codes +``` + +## Classes + + + + Short code management (read + update only). + + + +## Source + +[`src/rest/namespaces/short-codes.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/constructor.mdx new file mode 100644 index 0000000000..1a3fd56b5d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/short-codes/short-codes-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.short-codes.ShortCodesResource.constructor" + parent: "rest.namespaces.short-codes.ShortCodesResource" + module: "rest.namespaces.short-codes" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): ShortCodesResource +``` + +## Parameters + + + +## Returns + +`ShortCodesResource` + +## Source + +[`src/rest/namespaces/short-codes.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts) + +Line 17. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/get.mdx new file mode 100644 index 0000000000..9f6a226de2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/short-codes/short-codes-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.short-codes.ShortCodesResource.get" + parent: "rest.namespaces.short-codes.ShortCodesResource" + module: "rest.namespaces.short-codes" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts" +--- +# `get` + +Fetch a short code by ID. + +## Signature + +```typescript +get(shortCodeId: string): Promise +``` + +## Parameters + + + Unique identifier of the short code. + + +## Returns + +`Promise` — The short-code record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/short-codes.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts) + +Line 39. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/index.mdx new file mode 100644 index 0000000000..f332575fb7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/rest/namespaces/short-codes/short-codes-resource" +title: "ShortCodesResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.short-codes.ShortCodesResource" + parent: "rest.namespaces.short-codes" + module: "rest.namespaces.short-codes" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts" +--- +# `ShortCodesResource` + +Short code management (read + update only). + +Access via `client.shortCodes.*`. + +## Signature + +```typescript +class ShortCodesResource extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Fetch a short code by ID. + + + + List short codes in the project. + + + + Update a short code's configuration (webhooks, friendly name, etc.). + + + +## Source + +[`src/rest/namespaces/short-codes.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/list.mdx new file mode 100644 index 0000000000..a7d7cab3fa --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/short-codes/short-codes-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.short-codes.ShortCodesResource.list" + parent: "rest.namespaces.short-codes.ShortCodesResource" + module: "rest.namespaces.short-codes" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts" +--- +# `list` + +List short codes in the project. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of short codes. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/short-codes.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts) + +Line 28. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/update.mdx new file mode 100644 index 0000000000..e4023ce247 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/short-codes/short-codes-resource/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/short-codes/short-codes-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.short-codes.ShortCodesResource.update" + parent: "rest.namespaces.short-codes.ShortCodesResource" + module: "rest.namespaces.short-codes" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts" +--- +# `update` + +Update a short code's configuration (webhooks, friendly name, etc.). + +## Signature + +```typescript +update(shortCodeId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the short code. + + + + Full updated short-code attributes (replace semantics). + + +## Returns + +`Promise` — The updated short-code record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/short-codes.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/short-codes.ts) + +Line 51. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/index.mdx new file mode 100644 index 0000000000..a7090b5e32 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/sip-profile" +title: "sip-profile" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.sip-profile" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/sip-profile.ts" +--- +# `sip-profile` + +## Signature + +```typescript +module sip-profile +``` + +## Classes + + + + Project SIP profile (singleton resource). + + + +## Source + +[`src/rest/namespaces/sip-profile.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/sip-profile.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/constructor.mdx new file mode 100644 index 0000000000..f9834f0cea --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.sip-profile.SipProfileResource.constructor" + parent: "rest.namespaces.sip-profile.SipProfileResource" + module: "rest.namespaces.sip-profile" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/sip-profile.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): SipProfileResource +``` + +## Parameters + + + +## Returns + +`SipProfileResource` + +## Source + +[`src/rest/namespaces/sip-profile.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/sip-profile.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/get.mdx new file mode 100644 index 0000000000..7059de00b4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/get.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.sip-profile.SipProfileResource.get" + parent: "rest.namespaces.sip-profile.SipProfileResource" + module: "rest.namespaces.sip-profile" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/sip-profile.ts" +--- +# `get` + +Fetch the project's SIP profile. + +## Signature + +```typescript +get(): Promise +``` + +## Returns + +`Promise` — The SIP profile record for this project. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/sip-profile.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/sip-profile.ts) + +Line 26. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/index.mdx new file mode 100644 index 0000000000..258b12a30c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/rest/namespaces/sip-profile/sip-profile-resource" +title: "SipProfileResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.sip-profile.SipProfileResource" + parent: "rest.namespaces.sip-profile" + module: "rest.namespaces.sip-profile" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/sip-profile.ts" +--- +# `SipProfileResource` + +Project SIP profile (singleton resource). + +Access via `client.sipProfile.*`. + +## Signature + +```typescript +class SipProfileResource extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Fetch the project's SIP profile. + + + + Update the project's SIP profile. + + + +## Source + +[`src/rest/namespaces/sip-profile.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/sip-profile.ts) + +Line 15. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/update.mdx new file mode 100644 index 0000000000..3e33b00360 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/update.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/sip-profile/sip-profile-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.sip-profile.SipProfileResource.update" + parent: "rest.namespaces.sip-profile.SipProfileResource" + module: "rest.namespaces.sip-profile" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/sip-profile.ts" +--- +# `update` + +Update the project's SIP profile. + +## Signature + +```typescript +update(body: any): Promise +``` + +## Parameters + + + Full SIP profile attributes (replace semantics — not patch). + + +## Returns + +`Promise` — The updated SIP profile. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/sip-profile.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/sip-profile.ts) + +Line 37. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/index.mdx new file mode 100644 index 0000000000..a8b57dd25d --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/namespaces/verified-callers" +title: "verified-callers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.verified-callers" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/verified-callers.ts" +--- +# `verified-callers` + +## Signature + +```typescript +module verified-callers +``` + +## Classes + + + + Verified caller ID management with verification flow. + + + +## Source + +[`src/rest/namespaces/verified-callers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/verified-callers.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/constructor.mdx new file mode 100644 index 0000000000..c14402b02c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.verified-callers.VerifiedCallersResource.constructor" + parent: "rest.namespaces.verified-callers.VerifiedCallersResource" + module: "rest.namespaces.verified-callers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/verified-callers.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): VerifiedCallersResource +``` + +## Parameters + + + +## Returns + +`VerifiedCallersResource` + +## Source + +[`src/rest/namespaces/verified-callers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/verified-callers.ts) + +Line 20. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/create.mdx new file mode 100644 index 0000000000..09eef70455 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.verified-callers.VerifiedCallersResource.create" + parent: "rest.namespaces.verified-callers.VerifiedCallersResource" + module: "rest.namespaces.verified-callers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/delete.mdx new file mode 100644 index 0000000000..6c0151814e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.verified-callers.VerifiedCallersResource.delete" + parent: "rest.namespaces.verified-callers.VerifiedCallersResource" + module: "rest.namespaces.verified-callers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/get.mdx new file mode 100644 index 0000000000..7be92b42cf --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.verified-callers.VerifiedCallersResource.get" + parent: "rest.namespaces.verified-callers.VerifiedCallersResource" + module: "rest.namespaces.verified-callers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/index.mdx new file mode 100644 index 0000000000..28d85c8410 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/rest/namespaces/verified-callers/verified-callers-resource" +title: "VerifiedCallersResource" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.verified-callers.VerifiedCallersResource" + parent: "rest.namespaces.verified-callers" + module: "rest.namespaces.verified-callers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/verified-callers.ts" +--- +# `VerifiedCallersResource` + +Verified caller ID management with verification flow. + +Access via `client.verifiedCallers.*`. Extends standard CRUD with +`redialVerification()` and `submitVerification()` for the two-step +phone-number verification handshake. + +## Signature + +```typescript +class VerifiedCallersResource extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + Redial the verification call, starting the handshake over from scratch. + + + + Submit the verification code the caller received on the verification call. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/verified-callers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/verified-callers.ts) + +Line 17. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/list.mdx new file mode 100644 index 0000000000..119e8c369e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.verified-callers.VerifiedCallersResource.list" + parent: "rest.namespaces.verified-callers.VerifiedCallersResource" + module: "rest.namespaces.verified-callers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/redial-verification.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/redial-verification.mdx new file mode 100644 index 0000000000..71ad795735 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/redial-verification.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/redial-verification" +title: "redialVerification" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.verified-callers.VerifiedCallersResource.redialVerification" + parent: "rest.namespaces.verified-callers.VerifiedCallersResource" + module: "rest.namespaces.verified-callers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/verified-callers.ts" +--- +# `redialVerification` + +Redial the verification call, starting the handshake over from scratch. + +## Signature + +```typescript +redialVerification(callerId: string): Promise +``` + +## Parameters + + + Unique identifier of the verified caller ID resource. + + +## Returns + +`Promise` — The platform-shaped verification response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/verified-callers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/verified-callers.ts) + +Line 31. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/submit-verification.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/submit-verification.mdx new file mode 100644 index 0000000000..efe0867d2c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/submit-verification.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/submit-verification" +title: "submitVerification" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.verified-callers.VerifiedCallersResource.submitVerification" + parent: "rest.namespaces.verified-callers.VerifiedCallersResource" + module: "rest.namespaces.verified-callers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/verified-callers.ts" +--- +# `submitVerification` + +Submit the verification code the caller received on the verification call. + +## Signature + +```typescript +submitVerification(callerId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the verified caller ID resource. + + + + Verification payload (typically `{ verification_code: "1234" }`). + + +## Returns + +`Promise` — The completed verification record. + +## Throws + +- On any non-2xx HTTP response (including a rejected code). + +## Source + +[`src/rest/namespaces/verified-callers.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/verified-callers.ts) + +Line 43. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/update.mdx new file mode 100644 index 0000000000..3bc30b72e5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/verified-callers/verified-callers-resource/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.verified-callers.VerifiedCallersResource.update" + parent: "rest.namespaces.verified-callers.VerifiedCallersResource" + module: "rest.namespaces.verified-callers" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/index.mdx new file mode 100644 index 0000000000..c4d7c39443 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/index.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/rest/namespaces/video" +title: "video" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.namespaces.video" + module: "rest.namespaces" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `video` + +## Signature + +```typescript +module video +``` + +## Classes + + + + Video conference management with tokens and streams. + + + + Video conference token management. + + + + Video API namespace. + + + + Video room recording management. + + + + Video room management with streams. + + + + Video room session management. + + + + Video room token generation. + + + + Video stream management. + + + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/constructor.mdx new file mode 100644 index 0000000000..7c622d8fff --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conference-tokens/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferenceTokens.constructor" + parent: "rest.namespaces.video.VideoConferenceTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): VideoConferenceTokens +``` + +## Parameters + + + + + +## Returns + +`VideoConferenceTokens` + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 227. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/get.mdx new file mode 100644 index 0000000000..72e108c5bd --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conference-tokens/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferenceTokens.get" + parent: "rest.namespaces.video.VideoConferenceTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `get` + +Fetch a conference token by ID. + +## Signature + +```typescript +get(tokenId: string): Promise +``` + +## Parameters + + + Unique identifier of the conference token. + + +## Returns + +`Promise` — The conference-token record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 238. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/index.mdx new file mode 100644 index 0000000000..d6cb11944f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conference-tokens" +title: "VideoConferenceTokens" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferenceTokens" + parent: "rest.namespaces.video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `VideoConferenceTokens` + +Video conference token management. + +## Signature + +```typescript +class VideoConferenceTokens extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Fetch a conference token by ID. + + + + Reset / regenerate a conference token, invalidating the previous value. + + + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 226. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/reset.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/reset.mdx new file mode 100644 index 0000000000..3fd6fa166b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conference-tokens/reset.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conference-tokens/reset" +title: "reset" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferenceTokens.reset" + parent: "rest.namespaces.video.VideoConferenceTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `reset` + +Reset / regenerate a conference token, invalidating the previous value. + +## Signature + +```typescript +reset(tokenId: string): Promise +``` + +## Parameters + + + Unique identifier of the conference token to reset. + + +## Returns + +`Promise` — The refreshed token record with a new secret. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 249. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/constructor.mdx new file mode 100644 index 0000000000..ea2188c38e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conferences/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferences.constructor" + parent: "rest.namespaces.video.VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): VideoConferences +``` + +## Parameters + + + + + +## Returns + +`VideoConferences` + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 184. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/create-stream.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/create-stream.mdx new file mode 100644 index 0000000000..e8cf8f1caf --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/create-stream.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conferences/create-stream" +title: "createStream" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferences.createStream" + parent: "rest.namespaces.video.VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `createStream` + +Start an outbound stream from a conference (e.g. RTMP to YouTube). + +## Signature + +```typescript +createStream(conferenceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the conference. + + + + Stream configuration (destination URL, credentials, etc.). + + +## Returns + +`Promise` — The newly-created stream record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 220. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/create.mdx new file mode 100644 index 0000000000..723b915b3c --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conferences/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferences.create" + parent: "rest.namespaces.video.VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/delete.mdx new file mode 100644 index 0000000000..87513c7dfb --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conferences/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferences.delete" + parent: "rest.namespaces.video.VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/get.mdx new file mode 100644 index 0000000000..7d7aeae93f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conferences/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferences.get" + parent: "rest.namespaces.video.VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/index.mdx new file mode 100644 index 0000000000..e2f455ee57 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conferences" +title: "VideoConferences" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferences" + parent: "rest.namespaces.video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `VideoConferences` + +Video conference management with tokens and streams. + +## Signature + +```typescript +class VideoConferences extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Start an outbound stream from a conference (e.g. RTMP to YouTube). + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + List conference tokens associated with a conference. + + + + List outbound streams associated with a conference. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 181. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/list-conference-tokens.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/list-conference-tokens.mdx new file mode 100644 index 0000000000..d2e12d592b --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/list-conference-tokens.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conferences/list-conference-tokens" +title: "listConferenceTokens" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferences.listConferenceTokens" + parent: "rest.namespaces.video.VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `listConferenceTokens` + +List conference tokens associated with a conference. + +## Signature + +```typescript +listConferenceTokens(conferenceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the conference. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of conference tokens. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 196. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/list-streams.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/list-streams.mdx new file mode 100644 index 0000000000..50884e3a25 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/list-streams.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conferences/list-streams" +title: "listStreams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferences.listStreams" + parent: "rest.namespaces.video.VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `listStreams` + +List outbound streams associated with a conference. + +## Signature + +```typescript +listStreams(conferenceId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the conference. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of streams. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 208. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/list.mdx new file mode 100644 index 0000000000..858355df08 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conferences/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferences.list" + parent: "rest.namespaces.video.VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/update.mdx new file mode 100644 index 0000000000..6f9fd830be --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-conferences/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-conferences/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoConferences.update" + parent: "rest.namespaces.video.VideoConferences" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-namespace/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-namespace/constructor.mdx new file mode 100644 index 0000000000..13fd83d242 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-namespace/constructor.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-namespace/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoNamespace.constructor" + parent: "rest.namespaces.video.VideoNamespace" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient): VideoNamespace +``` + +## Parameters + + + +## Returns + +`VideoNamespace` + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 322. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-namespace/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-namespace/index.mdx new file mode 100644 index 0000000000..dc54283bfa --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-namespace/index.mdx @@ -0,0 +1,74 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-namespace" +title: "VideoNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoNamespace" + parent: "rest.namespaces.video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `VideoNamespace` + +Video API namespace. + +Access via `client.video.*`. + +## Signature + +```typescript +class VideoNamespace +``` + +## Examples + +```typescript +const room = await client.video.rooms.create({ name: 'standup' }); +const token = await client.video.roomTokens.create({ room_name: 'standup', user_name: 'Alice' }); +``` + +## Properties + + + Video conference CRUD plus stream / token management. + + + + Individual conference token read / reset operations. + + + + Room recording read, delete, and event-log access. + + + + Video room CRUD plus outbound stream management. + + + + Past and active room session read access. + + + + Issue JWT tokens for browser / mobile clients to join rooms. + + + + Individual video stream read / update / delete operations. + + +## Methods + + + + + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 306. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/constructor.mdx new file mode 100644 index 0000000000..d96a27830f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-recordings/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomRecordings.constructor" + parent: "rest.namespaces.video.VideoRoomRecordings" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): VideoRoomRecordings +``` + +## Parameters + + + + + +## Returns + +`VideoRoomRecordings` + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 130. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/delete.mdx new file mode 100644 index 0000000000..db2783ad15 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-recordings/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomRecordings.delete" + parent: "rest.namespaces.video.VideoRoomRecordings" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `delete` + +Delete a room recording. + +## Signature + +```typescript +delete(recordingId: string): Promise +``` + +## Parameters + + + Unique identifier of the recording. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 163. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/get.mdx new file mode 100644 index 0000000000..bc083a2d94 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-recordings/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomRecordings.get" + parent: "rest.namespaces.video.VideoRoomRecordings" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `get` + +Fetch a room recording by ID. + +## Signature + +```typescript +get(recordingId: string): Promise +``` + +## Parameters + + + Unique identifier of the recording. + + +## Returns + +`Promise` — The recording record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 152. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/index.mdx new file mode 100644 index 0000000000..82f95caa99 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-recordings" +title: "VideoRoomRecordings" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomRecordings" + parent: "rest.namespaces.video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `VideoRoomRecordings` + +Video room recording management. + +## Signature + +```typescript +class VideoRoomRecordings extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Delete a room recording. + + + + Fetch a room recording by ID. + + + + List all room recordings in the project. + + + + List event log entries for a room recording. + + + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 129. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/list-events.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/list-events.mdx new file mode 100644 index 0000000000..f4b37aef47 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/list-events.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-recordings/list-events" +title: "listEvents" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomRecordings.listEvents" + parent: "rest.namespaces.video.VideoRoomRecordings" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `listEvents` + +List event log entries for a room recording. + +## Signature + +```typescript +listEvents(recordingId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the recording. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of recording events. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 175. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/list.mdx new file mode 100644 index 0000000000..de12b804e1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-recordings/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-recordings/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomRecordings.list" + parent: "rest.namespaces.video.VideoRoomRecordings" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `list` + +List all room recordings in the project. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of recordings. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 141. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/constructor.mdx new file mode 100644 index 0000000000..0210e2fb9e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-sessions/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomSessions.constructor" + parent: "rest.namespaces.video.VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): VideoRoomSessions +``` + +## Parameters + + + + + +## Returns + +`VideoRoomSessions` + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 65. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/get.mdx new file mode 100644 index 0000000000..8505fec8d6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-sessions/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomSessions.get" + parent: "rest.namespaces.video.VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `get` + +Fetch a single room session by ID. + +## Signature + +```typescript +get(sessionId: string): Promise +``` + +## Parameters + + + Unique identifier of the room session. + + +## Returns + +`Promise` — The room-session record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 87. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/index.mdx new file mode 100644 index 0000000000..4fed218ba2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/index.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-sessions" +title: "VideoRoomSessions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomSessions" + parent: "rest.namespaces.video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `VideoRoomSessions` + +Video room session management. + +## Signature + +```typescript +class VideoRoomSessions extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Fetch a single room session by ID. + + + + List past and active room sessions in the project. + + + + List the event log for a room session. + + + + List members that participated in a room session. + + + + List recordings captured during a room session. + + + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 64. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list-events.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list-events.mdx new file mode 100644 index 0000000000..7aa8fd9967 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list-events.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-sessions/list-events" +title: "listEvents" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomSessions.listEvents" + parent: "rest.namespaces.video.VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `listEvents` + +List the event log for a room session. + +## Signature + +```typescript +listEvents(sessionId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the room session. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of session events. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 99. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list-members.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list-members.mdx new file mode 100644 index 0000000000..c0f67f31f6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list-members.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-sessions/list-members" +title: "listMembers" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomSessions.listMembers" + parent: "rest.namespaces.video.VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `listMembers` + +List members that participated in a room session. + +## Signature + +```typescript +listMembers(sessionId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the room session. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of members (past and current). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 111. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list-recordings.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list-recordings.mdx new file mode 100644 index 0000000000..e626b96929 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list-recordings.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-sessions/list-recordings" +title: "listRecordings" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomSessions.listRecordings" + parent: "rest.namespaces.video.VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `listRecordings` + +List recordings captured during a room session. + +## Signature + +```typescript +listRecordings(sessionId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the room session. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of session recordings. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 123. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list.mdx new file mode 100644 index 0000000000..20ad3b9595 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-sessions/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-sessions/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomSessions.list" + parent: "rest.namespaces.video.VideoRoomSessions" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `list` + +List past and active room sessions in the project. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of room sessions. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 76. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-tokens/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-tokens/constructor.mdx new file mode 100644 index 0000000000..86c4750799 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-tokens/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-tokens/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomTokens.constructor" + parent: "rest.namespaces.video.VideoRoomTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): VideoRoomTokens +``` + +## Parameters + + + + + +## Returns + +`VideoRoomTokens` + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 47. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-tokens/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-tokens/create.mdx new file mode 100644 index 0000000000..c7f813236e --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-tokens/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-tokens/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomTokens.create" + parent: "rest.namespaces.video.VideoRoomTokens" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `create` + +Issue a JWT token that grants a browser / mobile client access to a room. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Token payload (`room_name`, `user_name`, `permissions`, etc.). + + +## Returns + +`Promise` — The token record, typically `{ token: "eyJ..." }`. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 58. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-tokens/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-tokens/index.mdx new file mode 100644 index 0000000000..a96c997ea1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-room-tokens/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-room-tokens" +title: "VideoRoomTokens" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRoomTokens" + parent: "rest.namespaces.video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `VideoRoomTokens` + +Video room token generation. + +## Signature + +```typescript +class VideoRoomTokens extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Issue a JWT token that grants a browser / mobile client access to a room. + + + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 46. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/constructor.mdx new file mode 100644 index 0000000000..80d75d7f89 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-rooms/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRooms.constructor" + parent: "rest.namespaces.video.VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): VideoRooms +``` + +## Parameters + + + + + +## Returns + +`VideoRooms` + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/create-stream.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/create-stream.mdx new file mode 100644 index 0000000000..68d20df510 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/create-stream.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-rooms/create-stream" +title: "createStream" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRooms.createStream" + parent: "rest.namespaces.video.VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `createStream` + +Start a new outbound stream from a room (e.g. RTMP to YouTube, Twitch). + +## Signature + +```typescript +createStream(roomId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the video room. + + + + Stream configuration (destination URL, credentials, etc.). + + +## Returns + +`Promise` — The newly-created stream record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 40. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/create.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/create.mdx new file mode 100644 index 0000000000..c5ec223613 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/create.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-rooms/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRooms.create" + parent: "rest.namespaces.video.VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `create` + +Create a new resource. + +## Signature + +```typescript +create(body: any): Promise +``` + +## Parameters + + + Request body describing the resource to create. + + +## Returns + +`Promise` — The newly-created resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/delete.mdx new file mode 100644 index 0000000000..6a145fa8e5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-rooms/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRooms.delete" + parent: "rest.namespaces.video.VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `delete` + +Delete a resource by ID. + +## Signature + +```typescript +delete(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The platform's delete response (often an empty body on success). + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 95. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/get.mdx new file mode 100644 index 0000000000..ee3f8a0bd7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-rooms/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRooms.get" + parent: "rest.namespaces.video.VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `get` + +Fetch a single resource by ID. + +## Signature + +```typescript +get(resourceId: string): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + +## Returns + +`Promise` — The resource record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/index.mdx new file mode 100644 index 0000000000..e72fac3aaa --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-rooms" +title: "VideoRooms" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRooms" + parent: "rest.namespaces.video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `VideoRooms` + +Video room management with streams. + +## Signature + +```typescript +class VideoRooms extends CrudResource +``` + +## Inheritance + +**Extends:** `CrudResource` + +## Methods + + + + + + Create a new resource. + + + + Start a new outbound stream from a room (e.g. RTMP to YouTube, Twitch). + + + + Delete a resource by ID. + + + + Fetch a single resource by ID. + + + + List resources with optional query parameters. + + + + List outbound streams associated with a room. + + + + Update a resource by ID. + + + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 13. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/list-streams.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/list-streams.mdx new file mode 100644 index 0000000000..7498ae5a0f --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/list-streams.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-rooms/list-streams" +title: "listStreams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRooms.listStreams" + parent: "rest.namespaces.video.VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `listStreams` + +List outbound streams associated with a room. + +## Signature + +```typescript +listStreams(roomId: string, params?: QueryParams): Promise +``` + +## Parameters + + + Unique identifier of the video room. + + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — A paginated list of outbound streams. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 28. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/list.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/list.mdx new file mode 100644 index 0000000000..2b4d6784e5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/list.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-rooms/list" +title: "list" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRooms.list" + parent: "rest.namespaces.video.VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `list` + +List resources with optional query parameters. + +## Signature + +```typescript +list(params?: QueryParams): Promise +``` + +## Parameters + + + Optional filter / pagination query parameters. + + +## Returns + +`Promise` — The paginated list response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/update.mdx new file mode 100644 index 0000000000..58a64e4e21 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-rooms/update.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-rooms/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoRooms.update" + parent: "rest.namespaces.video.VideoRooms" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts" +--- +# `update` + +Update a resource by ID. + +Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'` +when the remote API requires a full-replacement semantics. + +## Signature + +```typescript +update(resourceId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the resource. + + + + Request body with updated fields. + + +## Returns + +`Promise` — The updated resource. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/base/CrudResource.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/base/CrudResource.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/constructor.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/constructor.mdx new file mode 100644 index 0000000000..c49d4bf9b5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-streams/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoStreams.constructor" + parent: "rest.namespaces.video.VideoStreams" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(http: HttpClient, basePath: string): VideoStreams +``` + +## Parameters + + + + + +## Returns + +`VideoStreams` + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 256. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/delete.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/delete.mdx new file mode 100644 index 0000000000..a31a5c33b6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/delete.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-streams/delete" +title: "delete" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoStreams.delete" + parent: "rest.namespaces.video.VideoStreams" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `delete` + +Stop and delete a video stream. + +## Signature + +```typescript +delete(streamId: string): Promise +``` + +## Parameters + + + Unique identifier of the stream. + + +## Returns + +`Promise` — The platform's delete response. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 290. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/get.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/get.mdx new file mode 100644 index 0000000000..7111bfc685 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/get.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-streams/get" +title: "get" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoStreams.get" + parent: "rest.namespaces.video.VideoStreams" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `get` + +Fetch a video stream by ID. + +## Signature + +```typescript +get(streamId: string): Promise +``` + +## Parameters + + + Unique identifier of the stream. + + +## Returns + +`Promise` — The stream record. + +## Throws + +- On any non-2xx HTTP response (including `404`). + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 267. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/index.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/index.mdx new file mode 100644 index 0000000000..25d10b92cb --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-streams" +title: "VideoStreams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoStreams" + parent: "rest.namespaces.video" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `VideoStreams` + +Video stream management. + +## Signature + +```typescript +class VideoStreams extends BaseResource +``` + +## Inheritance + +**Extends:** `BaseResource` + +## Methods + + + + + + Stop and delete a video stream. + + + + Fetch a video stream by ID. + + + + Update a video stream's configuration (e.g. destination URL). + + + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 255. diff --git a/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/update.mdx b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/update.mdx new file mode 100644 index 0000000000..d9f73be166 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/namespaces/video/video-streams/update.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/namespaces/video/video-streams/update" +title: "update" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.namespaces.video.VideoStreams.update" + parent: "rest.namespaces.video.VideoStreams" + module: "rest.namespaces.video" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts" +--- +# `update` + +Update a video stream's configuration (e.g. destination URL). + +## Signature + +```typescript +update(streamId: string, body: any): Promise +``` + +## Parameters + + + Unique identifier of the stream. + + + + Full updated stream attributes (replace semantics). + + +## Returns + +`Promise` — The updated stream record. + +## Throws + +- On any non-2xx HTTP response. + +## Source + +[`src/rest/namespaces/video.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/namespaces/video.ts) + +Line 279. diff --git a/fern/products/sdk-reference/typescript/rest/pagination/index.mdx b/fern/products/sdk-reference/typescript/rest/pagination/index.mdx new file mode 100644 index 0000000000..e90cfbaf91 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/pagination/index.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/rest/pagination" +title: "pagination" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.pagination" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/pagination.ts" +--- +# `pagination` + +## Signature + +```typescript +module pagination +``` + +## Functions + + + + Async generator that yields items across paginated API responses. + + + + Collect all paginated items into an array. + + + +## Source + +[`src/rest/pagination.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/pagination.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/pagination/paginate-all.mdx b/fern/products/sdk-reference/typescript/rest/pagination/paginate-all.mdx new file mode 100644 index 0000000000..992c641bb3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/pagination/paginate-all.mdx @@ -0,0 +1,66 @@ +--- +slug: "/reference/typescript/rest/pagination/paginate-all" +title: "paginateAll" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "rest.pagination.paginateAll" + parent: "rest.pagination" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/pagination.ts" +--- +# `paginateAll` + +Collect all paginated items into an array. + +Convenience wrapper around [paginate](/reference/typescript/rest/pagination/paginate) for callers who want the full +list. Beware: loads every page into memory — for very large result sets, +iterate via `paginate()` directly. + +## Signature + +```typescript +paginateAll( + http: HttpClient, + path: string, + params?: QueryParams, + dataKey: string = 'data' +): Promise +``` + +## Type Parameters + + + Element type collected. + + +## Parameters + + + [HttpClient](/reference/typescript/rest/http-client) instance used to fetch each page. + + + + Initial API path. + + + + Query parameters applied to the first request. + + + + Key on each response containing the array of items. Defaults to `"data"`. + + +## Returns + +`Promise` — A flat array of every item across all pages. + +## Source + +[`src/rest/pagination.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/pagination.ts) + +Line 87. diff --git a/fern/products/sdk-reference/typescript/rest/pagination/paginate.mdx b/fern/products/sdk-reference/typescript/rest/pagination/paginate.mdx new file mode 100644 index 0000000000..7e33fceed8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/pagination/paginate.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/rest/pagination/paginate" +title: "paginate" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "rest.pagination.paginate" + parent: "rest.pagination" + module: "rest.pagination" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/pagination.ts" +--- +# `paginate` + +Async generator that yields items across paginated API responses. + +Handles both relay REST (`links.next`) and LAML (`next_page_uri`) pagination +styles transparently. + +## Signature + +```typescript +paginate( + http: HttpClient, + path: string, + params?: QueryParams, + dataKey: string = 'data' +): AsyncGenerator +``` + +## Type Parameters + + + Element type yielded. + + +## Parameters + + + [HttpClient](/reference/typescript/rest/http-client) instance used to fetch each page. + + + + Initial API path (absolute URL or path relative to `http.baseUrl`). + + + + Query parameters applied to the first request only. Subsequent pages use the server-supplied next-page URL unchanged. + + + + Key on each response containing the array of items. Defaults to `"data"`. + + +## Returns + +`AsyncGenerator` — An async iterable that yields one `T` per call until exhausted. + +## Source + +[`src/rest/pagination.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/pagination.ts) + +Line 27. diff --git a/fern/products/sdk-reference/typescript/rest/rest-client/constructor.mdx b/fern/products/sdk-reference/typescript/rest/rest-client/constructor.mdx new file mode 100644 index 0000000000..702a165332 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/rest-client/constructor.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/rest-client/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.RestClient.constructor" + parent: "rest.RestClient" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/index.ts" +--- +# `constructor` + +Create a new REST client. + +## Signature + +```typescript +constructor(options: ClientOptions = {}): RestClient +``` + +## Parameters + + + Connection options. `project`, `token`, and `host` are required. If any are omitted they fall back to `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_API_TOKEN`, and `SIGNALWIRE_SPACE` environment variables. + + +## Returns + +`RestClient` + +## Throws + +- When `project`, `token`, or `host` is missing from both the options and the environment. + +## Source + +[`src/rest/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/index.ts) + +Line 128. diff --git a/fern/products/sdk-reference/typescript/rest/rest-client/index.mdx b/fern/products/sdk-reference/typescript/rest/rest-client/index.mdx new file mode 100644 index 0000000000..7ffa3d2430 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/rest-client/index.mdx @@ -0,0 +1,143 @@ +--- +slug: "/reference/typescript/rest/rest-client" +title: "RestClient" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.RestClient" + parent: "rest" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/index.ts" +--- +# `RestClient` + +REST client for the SignalWire platform APIs. + +## Signature + +```typescript +class RestClient +``` + +## Examples + +```typescript +const client = new RestClient({ + project: 'your-project-id', + token: 'your-api-token', + host: 'your-space.signalwire.com', +}); + +// Or use env vars: SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, SIGNALWIRE_SPACE +const client = new RestClient(); + +// Use namespaced resources +await client.fabric.aiAgents.list(); +await client.calling.play(callId, { play: [...] }); +await client.phoneNumbers.search({ areaCode: '512' }); +await client.video.rooms.create({ name: 'standup' }); +await client.compat.calls.list(); +``` + +## Properties + + + Relay Address CRUD. + + + + REST-based call control surface (all 37 commands as methods). + + + + Chat token issuance. + + + + Twilio-compatible LAML surface (legacy; prefer native namespaces for new work). + + + + Datasphere RAG — document indexing and semantic search. + + + + Fabric composition — AI Agents, SWML scripts, call flows, tokens, etc. + + + + Import externally-hosted phone numbers. + + + + Read-only message / voice / fax / conference logs. + + + + Carrier + CNAM phone-number lookups. + + + + Multi-factor authentication (SMS / voice code send + verify). + + + + Number-group CRUD plus membership operations. + + + + Phone-number CRUD plus availability search. + + + + Project-scoped API token management. + + + + PubSub token issuance. + + + + Call-queue CRUD plus member operations. + + + + Recording read / delete. + + + + US 10DLC Campaign Registry — brands, campaigns, orders, numbers. + + + + Short-code read / update. + + + + Project-level SIP profile read / update (singleton). + + + + Verified Caller ID CRUD plus verification flow. + + + + Video rooms, sessions, recordings, conferences, tokens, streams. + + +## Methods + + + + Create a new REST client. + + + +## Source + +[`src/rest/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/index.ts) + +Line 58. diff --git a/fern/products/sdk-reference/typescript/rest/rest-error/index.mdx b/fern/products/sdk-reference/typescript/rest/rest-error/index.mdx new file mode 100644 index 0000000000..4c7ebb7514 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/rest-error/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/rest/rest-error" +title: "RestError" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.RestError" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/RestError.ts" +--- +# `RestError` + +## Signature + +```typescript +module RestError +``` + +## Classes + + + + Custom error class for REST API errors. + + + +## Source + +[`src/rest/RestError.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/RestError.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/rest-error/rest-error/constructor.mdx b/fern/products/sdk-reference/typescript/rest/rest-error/rest-error/constructor.mdx new file mode 100644 index 0000000000..dd80f5caf1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/rest-error/rest-error/constructor.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/rest/rest-error/rest-error/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "rest.RestError.RestError.constructor" + parent: "rest.RestError.RestError" + module: "rest.RestError" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/RestError.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor( + statusCode: number, + body: string | Record, + url: string, + method: string = 'GET' +): RestError +``` + +## Parameters + + + HTTP status code returned by the server. + + + + Response body — an object if JSON-parseable, otherwise the raw response text. + + + + Fully-qualified URL that produced the error. + + + + HTTP method that produced the error. Defaults to `"GET"`. + + +## Returns + +`RestError` + +## Source + +[`src/rest/RestError.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/RestError.ts) + +Line 28. diff --git a/fern/products/sdk-reference/typescript/rest/rest-error/rest-error/index.mdx b/fern/products/sdk-reference/typescript/rest/rest-error/rest-error/index.mdx new file mode 100644 index 0000000000..6a7c53ae63 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/rest-error/rest-error/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/rest/rest-error/rest-error" +title: "RestError" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "rest.RestError.RestError" + parent: "rest.RestError" + module: "rest.RestError" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/RestError.ts" +--- +# `RestError` + +Custom error class for REST API errors. + +`body` may be a parsed JSON object (when the server returned valid JSON) +or a plain string (when JSON parsing failed), matching the Python SDK's +`SignalWireRestError` behavior. + +## Signature + +```typescript +class RestError extends Error +``` + +## Inheritance + +**Extends:** `Error` + +## Properties + + + Parsed response body. An object when the server returned valid JSON, otherwise the raw response text as a string. + + + + HTTP method that produced the error (`GET`, `POST`, etc.). + + + + HTTP status code returned by the server (e.g. `404`, `500`). + + + + Fully-qualified URL that produced the error. + + +## Methods + + + + + +## Source + +[`src/rest/RestError.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/RestError.ts) + +Line 8. diff --git a/fern/products/sdk-reference/typescript/rest/types/client-options/index.mdx b/fern/products/sdk-reference/typescript/rest/types/client-options/index.mdx new file mode 100644 index 0000000000..249a233707 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/types/client-options/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/rest/types/client-options" +title: "ClientOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "rest.types.ClientOptions" + parent: "rest.types" + module: "rest.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts" +--- +# `ClientOptions` + +Options for constructing a RestClient. + +## Signature + +```typescript +interface ClientOptions +``` + +## Properties + + + Custom fetch implementation for testing. + + + + SignalWire space host (e.g. "example.signalwire.com"). Falls back to SIGNALWIRE\_SPACE env var. + + + + SignalWire project ID. Falls back to SIGNALWIRE\_PROJECT\_ID env var. + + + + SignalWire API token. Falls back to SIGNALWIRE\_API\_TOKEN env var. + + +## Source + +[`src/rest/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts) + +Line 8. diff --git a/fern/products/sdk-reference/typescript/rest/types/http-client-options/index.mdx b/fern/products/sdk-reference/typescript/rest/types/http-client-options/index.mdx new file mode 100644 index 0000000000..228f2811a6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/types/http-client-options/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/rest/types/http-client-options" +title: "HttpClientOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "rest.types.HttpClientOptions" + parent: "rest.types" + module: "rest.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts" +--- +# `HttpClientOptions` + +Options for constructing an HttpClient. + +## Signature + +```typescript +interface HttpClientOptions +``` + +## Properties + + + Base URL (e.g. "https://example.signalwire.com"). Either `baseUrl` or `host` must be provided. If both are given, `host` takes precedence (matching the Python SDK convention where `host` is the canonical parameter). + + + + Custom fetch implementation for testing. + + + + Bare hostname (e.g. "example.signalwire.com"). `https://` is prepended automatically, matching the Python SDK's `HttpClient(project, token, host)` convention. + + + + Project ID for Basic Auth username. + + + + API token for Basic Auth password. + + +## Source + +[`src/rest/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts) + +Line 20. diff --git a/fern/products/sdk-reference/typescript/rest/types/index.mdx b/fern/products/sdk-reference/typescript/rest/types/index.mdx new file mode 100644 index 0000000000..add39891d7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/types/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/rest/types" +title: "types" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "rest.types" + module: "rest" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts" +--- +# `types` + +## Signature + +```typescript +module types +``` + +## Type Aliases + + + + Query parameters for list operations. + + + +## Interfaces + + + + Options for constructing a RestClient. + + + + Options for constructing an HttpClient. + + + + LAML-style paginated response with next\_page\_uri. + + + + Standard paginated response with links-based navigation (relay REST). + + + +## Source + +[`src/rest/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/rest/types/laml-paginated-response/index.mdx b/fern/products/sdk-reference/typescript/rest/types/laml-paginated-response/index.mdx new file mode 100644 index 0000000000..26d4bacc16 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/types/laml-paginated-response/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/rest/types/laml-paginated-response" +title: "LamlPaginatedResponse" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "rest.types.LamlPaginatedResponse" + parent: "rest.types" + module: "rest.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts" +--- +# `LamlPaginatedResponse` + +LAML-style paginated response with next\_page\_uri. + +## Signature + +```typescript +interface LamlPaginatedResponse +``` + +## Type Parameters + + + +## Properties + + + + + + + + + +## Source + +[`src/rest/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts) + +Line 52. diff --git a/fern/products/sdk-reference/typescript/rest/types/paginated-response/index.mdx b/fern/products/sdk-reference/typescript/rest/types/paginated-response/index.mdx new file mode 100644 index 0000000000..5adcb28866 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/types/paginated-response/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/rest/types/paginated-response" +title: "PaginatedResponse" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "rest.types.PaginatedResponse" + parent: "rest.types" + module: "rest.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts" +--- +# `PaginatedResponse` + +Standard paginated response with links-based navigation (relay REST). + +## Signature + +```typescript +interface PaginatedResponse +``` + +## Type Parameters + + + +## Properties + + + + + +## Source + +[`src/rest/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts) + +Line 41. diff --git a/fern/products/sdk-reference/typescript/rest/types/query-params.mdx b/fern/products/sdk-reference/typescript/rest/types/query-params.mdx new file mode 100644 index 0000000000..313b962bd5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/rest/types/query-params.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/rest/types/query-params" +title: "QueryParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "rest.types.QueryParams" + parent: "rest.types" + module: "rest.types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts" +--- +# `QueryParams` + +Query parameters for list operations. + +## Signature + +```typescript +type QueryParams = Record +``` + +## Source + +[`src/rest/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/rest/types.ts) + +Line 61. diff --git a/fern/products/sdk-reference/typescript/run-agent.mdx b/fern/products/sdk-reference/typescript/run-agent.mdx new file mode 100644 index 0000000000..9ac62c0707 --- /dev/null +++ b/fern/products/sdk-reference/typescript/run-agent.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/run-agent" +title: "runAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "runAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts" +--- +# `runAgent` + +Run an agent's HTTP server. + +Alias for [startAgent](/reference/typescript/start-agent) — equivalent to Python's `run_agent(agent)`. +Delegates to `agent.serve(options)`. + +## Signature + +```typescript +runAgent(agent: AgentBase, options?: { ...2 fields }): Promise +``` + +## Parameters + + + The [AgentBase](/reference/typescript/agent-base) instance to run. + + + + Optional host / port overrides. When omitted, values come from the agent's constructor options or the `PORT` environment variable. + + + + + + +## Returns + +`Promise` — Resolves once the HTTP server has begun listening. + +## See Also + +- \[[startAgent](/reference/typescript/start-agent)]\(xref://[startAgent](/reference/typescript/start-agent)) + +## Source + +[`src/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts) + +Line 353. diff --git a/fern/products/sdk-reference/typescript/schema-utils/index.mdx b/fern/products/sdk-reference/typescript/schema-utils/index.mdx new file mode 100644 index 0000000000..15eb1fa019 --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/index.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/schema-utils" +title: "SchemaUtils" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `SchemaUtils` + +## Signature + +```typescript +module SchemaUtils +``` + +## Classes + + + + Validates SWML documents against structural rules with an LRU-style result cache. + + + +## Interfaces + + + + Result of validating a SWML document. + + + + A verb definition extracted from the schema. + + + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/schema-utils/schema-utils/clear-cache.mdx b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/clear-cache.mdx new file mode 100644 index 0000000000..dcfb899e39 --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/clear-cache.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/schema-utils/schema-utils/clear-cache" +title: "clearCache" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SchemaUtils.SchemaUtils.clearCache" + parent: "SchemaUtils.SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `clearCache` + +Clear the validation cache + +## Signature + +```typescript +clearCache(): void +``` + +## Returns + +`void` + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 341. diff --git a/fern/products/sdk-reference/typescript/schema-utils/schema-utils/constructor.mdx b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/constructor.mdx new file mode 100644 index 0000000000..7790424822 --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/constructor.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/schema-utils/schema-utils/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SchemaUtils.SchemaUtils.constructor" + parent: "SchemaUtils.SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `constructor` + +Create a SchemaUtils instance. + +## Signature + +```typescript +constructor(opts?: { ...3 fields }): SchemaUtils +``` + +## Parameters + + + Optional settings for skipping validation, limiting cache size, or overriding the schema file path. + + + + + + + + +## Returns + +`SchemaUtils` + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 47. diff --git a/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-cache-size.mdx b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-cache-size.mdx new file mode 100644 index 0000000000..8c878f0e3e --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-cache-size.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/schema-utils/schema-utils/get-cache-size" +title: "getCacheSize" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SchemaUtils.SchemaUtils.getCacheSize" + parent: "SchemaUtils.SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `getCacheSize` + +Get the number of cached validation results. + +## Signature + +```typescript +getCacheSize(): number +``` + +## Returns + +`number` — The current cache entry count. + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 349. diff --git a/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-description.mdx b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-description.mdx new file mode 100644 index 0000000000..0ad8702259 --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-description.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/schema-utils/schema-utils/get-verb-description" +title: "getVerbDescription" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SchemaUtils.SchemaUtils.getVerbDescription" + parent: "SchemaUtils.SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `getVerbDescription` + +Get the description text for a verb. + +## Signature + +```typescript +getVerbDescription(verbName: string): string +``` + +## Parameters + + + The verb name. + + +## Returns + +`string` — The description string or empty string. + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 158. diff --git a/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-names.mdx b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-names.mdx new file mode 100644 index 0000000000..c73020a90b --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/schema-utils/schema-utils/get-verb-names" +title: "getVerbNames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SchemaUtils.SchemaUtils.getVerbNames" + parent: "SchemaUtils.SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `getVerbNames` + +Get all verb names defined in the schema. + +## Signature + +```typescript +getVerbNames(): string[] +``` + +## Returns + +`string[]` — Array of verb names (e.g. \["answer", "ai", "hangup", ...]). + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 124. diff --git a/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-properties.mdx b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-properties.mdx new file mode 100644 index 0000000000..077d682b39 --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-properties.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/schema-utils/schema-utils/get-verb-properties" +title: "getVerbProperties" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SchemaUtils.SchemaUtils.getVerbProperties" + parent: "SchemaUtils.SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `getVerbProperties` + +Get the inner properties schema for a specific verb. +For example, for "hangup" this returns `{ type: "object", properties: { reason: ... }, ... }`. + +## Signature + +```typescript +getVerbProperties(verbName: string): Record +``` + +## Parameters + + + The verb name (e.g. "answer", "tap"). + + +## Returns + +`Record` — The inner schema definition or an empty object if not found. + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 134. diff --git a/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-required-properties.mdx b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-required-properties.mdx new file mode 100644 index 0000000000..3f1f33c24f --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/get-verb-required-properties.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/schema-utils/schema-utils/get-verb-required-properties" +title: "getVerbRequiredProperties" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SchemaUtils.SchemaUtils.getVerbRequiredProperties" + parent: "SchemaUtils.SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `getVerbRequiredProperties` + +Get the required properties for a verb's inner config. + +## Signature + +```typescript +getVerbRequiredProperties(verbName: string): string[] +``` + +## Parameters + + + The verb name. + + +## Returns + +`string[]` — Array of required property names. + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 147. diff --git a/fern/products/sdk-reference/typescript/schema-utils/schema-utils/has-verb.mdx b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/has-verb.mdx new file mode 100644 index 0000000000..229d7b6e8b --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/has-verb.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/schema-utils/schema-utils/has-verb" +title: "hasVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SchemaUtils.SchemaUtils.hasVerb" + parent: "SchemaUtils.SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `hasVerb` + +Check if a verb name is defined in the schema. + +## Signature + +```typescript +hasVerb(verbName: string): boolean +``` + +## Parameters + + + The verb name. + + +## Returns + +`boolean` — True if the verb exists. + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 168. diff --git a/fern/products/sdk-reference/typescript/schema-utils/schema-utils/index.mdx b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/index.mdx new file mode 100644 index 0000000000..ce95126074 --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/index.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/typescript/schema-utils/schema-utils" +title: "SchemaUtils" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "SchemaUtils.SchemaUtils" + parent: "SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `SchemaUtils` + +Validates SWML documents against structural rules with an LRU-style result cache. + +## Signature + +```typescript +class SchemaUtils +``` + +## Methods + + + + Clear the validation cache + + + + Create a SchemaUtils instance. + + + + Get the number of cached validation results. + + + + Get the description text for a verb. + + + + Get all verb names defined in the schema. + + + + Get the inner properties schema for a specific verb. For example, for "hangup" this returns `{ type: "object", properties: { reason: ... }, ... }`. + + + + Get the required properties for a verb's inner config. + + + + Check if a verb name is defined in the schema. + + + + Validate a SWML document against structural rules. + + + + Lightweight validation of a verb config against the schema. Checks that the verb exists and required properties are present. Mirrors Python SDK's `_validate_verb_lightweight()`. + + + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/schema-utils/schema-utils/validate-verb.mdx b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/validate-verb.mdx new file mode 100644 index 0000000000..ed3de31c31 --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/validate-verb.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/schema-utils/schema-utils/validate-verb" +title: "validateVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SchemaUtils.SchemaUtils.validateVerb" + parent: "SchemaUtils.SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `validateVerb` + +Lightweight validation of a verb config against the schema. +Checks that the verb exists and required properties are present. +Mirrors Python SDK's `_validate_verb_lightweight()`. + +## Signature + +```typescript +validateVerb(verbName: string, config: unknown): ValidationResult +``` + +## Parameters + + + The verb name. + + + + The verb configuration to validate. + + +## Returns + +`ValidationResult` — Validation result. + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 181. diff --git a/fern/products/sdk-reference/typescript/schema-utils/schema-utils/validate.mdx b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/validate.mdx new file mode 100644 index 0000000000..24b0de5104 --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/schema-utils/validate.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/schema-utils/schema-utils/validate" +title: "validate" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SchemaUtils.SchemaUtils.validate" + parent: "SchemaUtils.SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `validate` + +Validate a SWML document against structural rules. + +## Signature + +```typescript +validate(swml: string | Record): ValidationResult +``` + +## Parameters + + + The SWML document as a JSON string or parsed object. + + +## Returns + +`ValidationResult` — The validation result indicating success or a list of errors. + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 231. diff --git a/fern/products/sdk-reference/typescript/schema-utils/validation-result/index.mdx b/fern/products/sdk-reference/typescript/schema-utils/validation-result/index.mdx new file mode 100644 index 0000000000..cfb1136a5a --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/validation-result/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/schema-utils/validation-result" +title: "ValidationResult" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "SchemaUtils.ValidationResult" + parent: "SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `ValidationResult` + +Result of validating a SWML document. + +## Signature + +```typescript +interface ValidationResult +``` + +## Properties + + + List of human-readable error messages; empty when valid. + + + + Whether the document passed all validation checks. + + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 12. diff --git a/fern/products/sdk-reference/typescript/schema-utils/verb-definition/index.mdx b/fern/products/sdk-reference/typescript/schema-utils/verb-definition/index.mdx new file mode 100644 index 0000000000..9fd2d8ae50 --- /dev/null +++ b/fern/products/sdk-reference/typescript/schema-utils/verb-definition/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/schema-utils/verb-definition" +title: "VerbDefinition" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "SchemaUtils.VerbDefinition" + parent: "SchemaUtils" + module: "SchemaUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts" +--- +# `VerbDefinition` + +A verb definition extracted from the schema. + +## Signature + +```typescript +interface VerbDefinition +``` + +## Properties + + + The raw JSON Schema definition object for this verb. + + + + The verb name as used in SWML (e.g. "answer", "hangup", "sip\_refer"). + + + + The PascalCase schema definition name (e.g. "Answer", "Hangup", "SIPRefer"). + + +## Source + +[`src/SchemaUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SchemaUtils.ts) + +Line 20. diff --git a/fern/products/sdk-reference/typescript/security-utils/filter-sensitive-headers.mdx b/fern/products/sdk-reference/typescript/security-utils/filter-sensitive-headers.mdx new file mode 100644 index 0000000000..39b3f40a19 --- /dev/null +++ b/fern/products/sdk-reference/typescript/security-utils/filter-sensitive-headers.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/security-utils/filter-sensitive-headers" +title: "filterSensitiveHeaders" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "SecurityUtils.filterSensitiveHeaders" + parent: "SecurityUtils" + module: "SecurityUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts" +--- +# `filterSensitiveHeaders` + +Return a copy of `headers` with sensitive entries (authorization, cookie, etc.) removed. + +## Signature + +```typescript +filterSensitiveHeaders(headers: Record): Record +``` + +## Parameters + + + Original header record. + + +## Returns + +`Record` — A new record with sensitive headers removed. + +## Source + +[`src/SecurityUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts) + +Line 47. diff --git a/fern/products/sdk-reference/typescript/security-utils/index.mdx b/fern/products/sdk-reference/typescript/security-utils/index.mdx new file mode 100644 index 0000000000..2282349a1f --- /dev/null +++ b/fern/products/sdk-reference/typescript/security-utils/index.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/security-utils" +title: "SecurityUtils" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "SecurityUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts" +--- +# `SecurityUtils` + +## Signature + +```typescript +module SecurityUtils +``` + +## Constants + + + Maximum allowed input length for skill handler arguments (characters). + + +## Functions + + + + Return a copy of `headers` with sensitive entries (authorization, cookie, etc.) removed. + + + + Check whether an IP address belongs to a private/reserved range. Covers RFC1918, loopback, link-local, IPv6 private (fc/fd, ::1, fe80). + + + + Whether the current process is running in a serverless environment (anything other than a long-lived `server` runtime). + + + + Validate that a hostname string does not contain whitespace, slashes, or control characters. + + + + Redact credentials embedded in a URL (e.g. `https://user:secret@host` -> `https://user:****@host`). Returns the URL unchanged if no credentials are present. + + + + DNS-resolve a URL's hostname and reject it if it points to a private IP. + + + + Copy properties from `source` to `target`, filtering out prototype-pollution keys. Drop-in replacement for `Object.assign(target, source)` where `source` is untrusted. + + + + Validate that a URL is safe to fetch (not pointing to private/internal resources). + + + +## Source + +[`src/SecurityUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/security-utils/is-private-ip.mdx b/fern/products/sdk-reference/typescript/security-utils/is-private-ip.mdx new file mode 100644 index 0000000000..2e1fd7198c --- /dev/null +++ b/fern/products/sdk-reference/typescript/security-utils/is-private-ip.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/security-utils/is-private-ip" +title: "isPrivateIp" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "SecurityUtils.isPrivateIp" + parent: "SecurityUtils" + module: "SecurityUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts" +--- +# `isPrivateIp` + +Check whether an IP address belongs to a private/reserved range. +Covers RFC1918, loopback, link-local, IPv6 private (fc/fd, ::1, fe80). + +## Signature + +```typescript +isPrivateIp(ip: string): boolean +``` + +## Parameters + + + The IP address string to check. + + +## Returns + +`boolean` — True if the IP is private/reserved. + +## Source + +[`src/SecurityUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts) + +Line 84. diff --git a/fern/products/sdk-reference/typescript/security-utils/is-serverless-mode.mdx b/fern/products/sdk-reference/typescript/security-utils/is-serverless-mode.mdx new file mode 100644 index 0000000000..ac29160c21 --- /dev/null +++ b/fern/products/sdk-reference/typescript/security-utils/is-serverless-mode.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/security-utils/is-serverless-mode" +title: "isServerlessMode" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "SecurityUtils.isServerlessMode" + parent: "SecurityUtils" + module: "SecurityUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts" +--- +# `isServerlessMode` + +Whether the current process is running in a serverless environment +(anything other than a long-lived `server` runtime). + +Python parity: `signalwire.utils.is_serverless_mode`. + +## Signature + +```typescript +isServerlessMode(): boolean +``` + +## Returns + +`boolean` + +## Source + +[`src/SecurityUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts) + +Line 162. diff --git a/fern/products/sdk-reference/typescript/security-utils/is-valid-hostname.mdx b/fern/products/sdk-reference/typescript/security-utils/is-valid-hostname.mdx new file mode 100644 index 0000000000..34d16b1d54 --- /dev/null +++ b/fern/products/sdk-reference/typescript/security-utils/is-valid-hostname.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/security-utils/is-valid-hostname" +title: "isValidHostname" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "SecurityUtils.isValidHostname" + parent: "SecurityUtils" + module: "SecurityUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts" +--- +# `isValidHostname` + +Validate that a hostname string does not contain whitespace, slashes, or control characters. + +## Signature + +```typescript +isValidHostname(host: string): boolean +``` + +## Parameters + + + Hostname to validate. + + +## Returns + +`boolean` — True if the hostname is valid. + +## Source + +[`src/SecurityUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts) + +Line 72. diff --git a/fern/products/sdk-reference/typescript/security-utils/redact-url.mdx b/fern/products/sdk-reference/typescript/security-utils/redact-url.mdx new file mode 100644 index 0000000000..2d0cb7c0d4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/security-utils/redact-url.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/security-utils/redact-url" +title: "redactUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "SecurityUtils.redactUrl" + parent: "SecurityUtils" + module: "SecurityUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts" +--- +# `redactUrl` + +Redact credentials embedded in a URL (e.g. `https://user:secret@host` -> `https://user:****@host`). +Returns the URL unchanged if no credentials are present. + +## Signature + +```typescript +redactUrl(url: string): string +``` + +## Parameters + + + The URL string to redact. + + +## Returns + +`string` — The URL with the password portion replaced by `****`. + +## Source + +[`src/SecurityUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts) + +Line 63. diff --git a/fern/products/sdk-reference/typescript/security-utils/resolve-and-validate-url.mdx b/fern/products/sdk-reference/typescript/security-utils/resolve-and-validate-url.mdx new file mode 100644 index 0000000000..47d682abed --- /dev/null +++ b/fern/products/sdk-reference/typescript/security-utils/resolve-and-validate-url.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/security-utils/resolve-and-validate-url" +title: "resolveAndValidateUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "SecurityUtils.resolveAndValidateUrl" + parent: "SecurityUtils" + module: "SecurityUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts" +--- +# `resolveAndValidateUrl` + +DNS-resolve a URL's hostname and reject it if it points to a private IP. + +## Signature + +```typescript +resolveAndValidateUrl(url: string, allowPrivate: boolean = false): Promise +``` + +## Parameters + + + The full URL to validate. + + + + When true, skip the private-IP check (default false). + + +## Returns + +`Promise` + +## Throws + +- If the resolved IP is private and `allowPrivate` is false. + +## Source + +[`src/SecurityUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts) + +Line 107. diff --git a/fern/products/sdk-reference/typescript/security-utils/safe-assign.mdx b/fern/products/sdk-reference/typescript/security-utils/safe-assign.mdx new file mode 100644 index 0000000000..7a4ba74e69 --- /dev/null +++ b/fern/products/sdk-reference/typescript/security-utils/safe-assign.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/security-utils/safe-assign" +title: "safeAssign" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "SecurityUtils.safeAssign" + parent: "SecurityUtils" + module: "SecurityUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts" +--- +# `safeAssign` + +Copy properties from `source` to `target`, filtering out prototype-pollution keys. +Drop-in replacement for `Object.assign(target, source)` where `source` is untrusted. + +## Signature + +```typescript +safeAssign(target: T, source: Record): T +``` + +## Type Parameters + + + +## Parameters + + + The object to assign into. + + + + The object to copy properties from. + + +## Returns + +`T` — The target object. + +## Source + +[`src/SecurityUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts) + +Line 24. diff --git a/fern/products/sdk-reference/typescript/security-utils/validate-url.mdx b/fern/products/sdk-reference/typescript/security-utils/validate-url.mdx new file mode 100644 index 0000000000..0219bc2fa2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/security-utils/validate-url.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/security-utils/validate-url" +title: "validateUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "SecurityUtils.validateUrl" + parent: "SecurityUtils" + module: "SecurityUtils" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts" +--- +# `validateUrl` + +Validate that a URL is safe to fetch (not pointing to private/internal resources). + +Matches Python's `validate_url(url, allow_private=False) -> bool` — returns `true` +if the URL is safe, `false` otherwise (never throws). + +## Signature + +```typescript +validateUrl(url: string, allowPrivate: boolean = false): Promise +``` + +## Parameters + + + The URL to validate. + + + + When true, allow private IP ranges (default false). + + +## Returns + +`Promise` — `true` if the URL is safe to fetch, `false` otherwise. + +## Source + +[`src/SecurityUtils.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SecurityUtils.ts) + +Line 147. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/index.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/index.mdx new file mode 100644 index 0000000000..5bb4b0f601 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/serverless-adapter" +title: "ServerlessAdapter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `ServerlessAdapter` + +## Signature + +```typescript +module ServerlessAdapter +``` + +## Type Aliases + + + + Supported serverless platform identifiers, or 'auto' for environment-based detection. + + + +## Classes + + + + Adapts a Hono application for deployment on AWS Lambda, Google Cloud Functions, Azure Functions, or CGI. + + + +## Interfaces + + + + Normalized incoming event from a serverless platform. + + + + Normalized outgoing response returned to a serverless platform. + + + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/constructor.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/constructor.mdx new file mode 100644 index 0000000000..a76251e825 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-adapter/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessAdapter.constructor" + parent: "ServerlessAdapter.ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `constructor` + +Create a ServerlessAdapter for the given platform. + +## Signature + +```typescript +constructor(platform: ServerlessPlatform = 'auto'): ServerlessAdapter +``` + +## Parameters + + + Target platform; defaults to 'auto' which detects from environment variables. + + +## Returns + +`ServerlessAdapter` + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 72. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/create-azure-handler.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/create-azure-handler.mdx new file mode 100644 index 0000000000..0cd97da8c5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/create-azure-handler.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-adapter/create-azure-handler" +title: "createAzureHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessAdapter.createAzureHandler" + parent: "ServerlessAdapter.ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `createAzureHandler` + +Create an Azure Functions-compatible handler from a Hono app. + +**Modifiers:** `static` + +## Signature + +```typescript +createAzureHandler( + app: { ...1 fields } +): (context: any, req: any) => Promise +``` + +## Parameters + + + A Hono-compatible application with a `fetch` method. + + + + +## Returns + +`(context: any, req: any) => Promise` — A function that accepts an Azure context and request object. + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 223. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/create-gcf-handler.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/create-gcf-handler.mdx new file mode 100644 index 0000000000..6aaee92c79 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/create-gcf-handler.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-adapter/create-gcf-handler" +title: "createGcfHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessAdapter.createGcfHandler" + parent: "ServerlessAdapter.ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `createGcfHandler` + +Create a Google Cloud Functions-compatible handler from a Hono app. + +**Modifiers:** `static` + +## Signature + +```typescript +createGcfHandler(app: { ...1 fields }): (req: any, res: any) => Promise +``` + +## Parameters + + + A Hono-compatible application with a `fetch` method. + + + + +## Returns + +`(req: any, res: any) => Promise` — A function that accepts GCF request/response objects. + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 200. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/create-lambda-handler.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/create-lambda-handler.mdx new file mode 100644 index 0000000000..a7d779a968 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/create-lambda-handler.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-adapter/create-lambda-handler" +title: "createLambdaHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessAdapter.createLambdaHandler" + parent: "ServerlessAdapter.ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `createLambdaHandler` + +Create an AWS Lambda-compatible handler function from a Hono app. + +**Modifiers:** `static` + +## Signature + +```typescript +createLambdaHandler( + app: { ...1 fields } +): (event: ServerlessEvent) => Promise +``` + +## Parameters + + + A Hono-compatible application with a `fetch` method. + + + + +## Returns + +`(event: ServerlessEvent) => Promise` — A function that accepts a Lambda event and returns a promise of a serverless response. + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 190. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/detect-platform.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/detect-platform.mdx new file mode 100644 index 0000000000..f4001b32bb --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/detect-platform.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-adapter/detect-platform" +title: "detectPlatform" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessAdapter.detectPlatform" + parent: "ServerlessAdapter.ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `detectPlatform` + +Detect the serverless platform by inspecting well-known environment variables. + +## Signature + +```typescript +detectPlatform(): ServerlessPlatform +``` + +## Returns + +`ServerlessPlatform` — The detected platform identifier; defaults to 'lambda' if no match is found. + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 80. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/generate-url.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/generate-url.mdx new file mode 100644 index 0000000000..f126896db3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/generate-url.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-adapter/generate-url" +title: "generateUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessAdapter.generateUrl" + parent: "ServerlessAdapter.ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `generateUrl` + +Generate the platform-specific invocation URL for a deployed function. + +## Signature + +```typescript +generateUrl(opts?: { ...5 fields }): string +``` + +## Parameters + + + Optional overrides for region, project, function name, stage, or API ID. + + + + + + + + + + + + +## Returns + +`string` — The constructed URL string. + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 153. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/get-platform.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/get-platform.mdx new file mode 100644 index 0000000000..aed98021a8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/get-platform.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-adapter/get-platform" +title: "getPlatform" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessAdapter.getPlatform" + parent: "ServerlessAdapter.ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `getPlatform` + +Get the resolved platform identifier. + +## Signature + +```typescript +getPlatform(): ServerlessPlatform +``` + +## Returns + +`ServerlessPlatform` — The serverless platform this adapter is configured for. + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 92. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/handle-request.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/handle-request.mdx new file mode 100644 index 0000000000..a53c8c9d29 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/handle-request.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-adapter/handle-request" +title: "handleRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessAdapter.handleRequest" + parent: "ServerlessAdapter.ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `handleRequest` + +Convert a serverless event into a standard Request, route it through the Hono app, and return a normalized response. + +## Signature + +```typescript +handleRequest( + app: { ...1 fields }, + event: ServerlessEvent +): Promise +``` + +## Parameters + + + A Hono-compatible application with a `fetch` method. + + + + + + The incoming serverless event to process. + + +## Returns + +`Promise` — The normalized serverless response. + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 102. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/index.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/index.mdx new file mode 100644 index 0000000000..fa94612fe9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-adapter/index.mdx @@ -0,0 +1,83 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-adapter" +title: "ServerlessAdapter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessAdapter" + parent: "ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `ServerlessAdapter` + +Adapts a Hono application for deployment on AWS Lambda, Google Cloud Functions, Azure Functions, or CGI. + +Accepts the provider's native event shape (`APIGatewayProxyEvent`, Google Functions `Request`, +Azure function arguments, CGI env + stdin) and returns a provider-native response. + +## Signature + +```typescript +class ServerlessAdapter +``` + +## Examples + +```typescript +import { AgentBase, ServerlessAdapter } from '@signalwire/sdk'; + +const agent = new AgentBase({ name: 'lambda', route: '/' }); +agent.setPromptText('You are a helpful assistant.'); + +const adapter = new ServerlessAdapter('aws'); + +export const handler = async (event: any) => { + return adapter.handleRequest(agent.asRouter(), event); +}; +``` + +## Methods + + + + Create a ServerlessAdapter for the given platform. + + + + Create an Azure Functions-compatible handler from a Hono app. + + + + Create a Google Cloud Functions-compatible handler from a Hono app. + + + + Create an AWS Lambda-compatible handler function from a Hono app. + + + + Detect the serverless platform by inspecting well-known environment variables. + + + + Generate the platform-specific invocation URL for a deployed function. + + + + Get the resolved platform identifier. + + + + Convert a serverless event into a standard Request, route it through the Hono app, and return a normalized response. + + + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 65. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-event/index.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-event/index.mdx new file mode 100644 index 0000000000..e4d23c13f7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-event/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-event" +title: "ServerlessEvent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessEvent" + parent: "ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `ServerlessEvent` + +Normalized incoming event from a serverless platform. + +## Signature + +```typescript +interface ServerlessEvent +``` + +## Properties + + + Request body, either raw JSON string or parsed object. + + + + Request headers as key-value pairs. + + + + HTTP method (AWS Lambda style). + + + + HTTP method (GCF/Azure style). + + + + Request path. + + + + Query string parameters as key-value pairs. + + + + Raw request path (AWS API Gateway v2). + + + + Platform-specific request context metadata. + + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 16. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-platform.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-platform.mdx new file mode 100644 index 0000000000..8c8a7f4791 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-platform.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-platform" +title: "ServerlessPlatform" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessPlatform" + parent: "ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `ServerlessPlatform` + +Supported serverless platform identifiers, or 'auto' for environment-based detection. + +## Signature + +```typescript +type ServerlessPlatform = "lambda" | "gcf" | "azure" | "cgi" | "auto" +``` + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 13. diff --git a/fern/products/sdk-reference/typescript/serverless-adapter/serverless-response/index.mdx b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-response/index.mdx new file mode 100644 index 0000000000..36890f7dc6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/serverless-adapter/serverless-response/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/serverless-adapter/serverless-response" +title: "ServerlessResponse" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "ServerlessAdapter.ServerlessResponse" + parent: "ServerlessAdapter" + module: "ServerlessAdapter" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts" +--- +# `ServerlessResponse` + +Normalized outgoing response returned to a serverless platform. + +## Signature + +```typescript +interface ServerlessResponse +``` + +## Properties + + + Response body as a string. + + + + Response headers as key-value pairs. + + + + HTTP status code. + + +## Source + +[`src/ServerlessAdapter.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/ServerlessAdapter.ts) + +Line 36. diff --git a/fern/products/sdk-reference/typescript/session-manager/debug-token-result/index.mdx b/fern/products/sdk-reference/typescript/session-manager/debug-token-result/index.mdx new file mode 100644 index 0000000000..cfe69e05a6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/debug-token-result/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/session-manager/debug-token-result" +title: "DebugTokenResult" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "SessionManager.DebugTokenResult" + parent: "SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `DebugTokenResult` + +Decoded token debug info matching the Python SDK's nested return structure. + +## Signature + +```typescript +interface DebugTokenResult +``` + +## Properties + + + + + + + + + + + + + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 12. diff --git a/fern/products/sdk-reference/typescript/session-manager/index.mdx b/fern/products/sdk-reference/typescript/session-manager/index.mdx new file mode 100644 index 0000000000..8fb5c7da73 --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/session-manager" +title: "SessionManager" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `SessionManager` + +## Signature + +```typescript +module SessionManager +``` + +## Classes + + + + Stateless HMAC-SHA256 token manager for SWAIG function call authentication and per-session metadata storage. + + + +## Interfaces + + + + Decoded token debug info matching the Python SDK's nested return structure. + + + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/activate-session.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/activate-session.mdx new file mode 100644 index 0000000000..1a3360214a --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/activate-session.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/activate-session" +title: "activateSession" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.activateSession" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `activateSession` + +Legacy method retained for API compatibility with the Python SDK. +Does nothing and returns `true`. + +## Signature + +```typescript +activateSession(_callId: string): boolean +``` + +## Parameters + + + The call/session identifier (unused). + + +## Returns + +`boolean` — Always `true`. + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 289. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/cleanup.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/cleanup.mdx new file mode 100644 index 0000000000..d9bd137057 --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/cleanup.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.cleanup" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `cleanup` + +Remove session metadata entries older than `maxAgeMs`. + +## Signature + +```typescript +cleanup(maxAgeMs?: number): void +``` + +## Parameters + + + Maximum age in milliseconds (defaults to `tokenExpirySecs * 1000`). + + +## Returns + +`void` + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 272. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/constructor.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/constructor.mdx new file mode 100644 index 0000000000..d304176871 --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/constructor.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.constructor" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `constructor` + +Create a new SessionManager. + +## Signature + +```typescript +constructor(tokenExpirySecs: number = 900, secretKey?: string): SessionManager +``` + +## Parameters + + + Token validity duration in seconds (default 900). + + + + HMAC signing secret; a random key is generated if omitted. + + +## Returns + +`SessionManager` + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 52. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/create-session.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/create-session.mdx new file mode 100644 index 0000000000..f37f8ba7f9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/create-session.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/create-session" +title: "createSession" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.createSession" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `createSession` + +Return the given callId or generate a new random session identifier. + +## Signature + +```typescript +createSession(callId?: string): string +``` + +## Parameters + + + Existing call ID to reuse. + + +## Returns + +`string` — The call ID string. + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 62. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/create-tool-token.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/create-tool-token.mdx new file mode 100644 index 0000000000..d8fb41033b --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/create-tool-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/create-tool-token" +title: "createToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.createToolToken" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `createToolToken` + +Alias for [generateToken](/reference/typescript/session-manager/session-manager/generate-token). + +## Signature + +```typescript +createToolToken(functionName: string, callId: string): string +``` + +## Parameters + + + The SWAIG function name to bind. + + + + The call ID to bind. + + +## Returns + +`string` — A base64url-encoded token string. + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 92. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/debug-token.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/debug-token.mdx new file mode 100644 index 0000000000..b61f350af7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/debug-token.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/debug-token" +title: "debugToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.debugToken" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `debugToken` + +Debug a token without validating it. + +Requires [debugMode](/reference/typescript/session-manager/session-manager#debug-mode) to be `true`. When disabled, returns +`{ error: "debug mode not enabled" }` matching the Python SDK behaviour. + +## Signature + +```typescript +debugToken(token: string): DebugTokenResult +``` + +## Parameters + + + The base64url-encoded token to decode. + + +## Returns + +`DebugTokenResult` — A nested debug structure matching the Python SDK, or an error object. + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 169. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/delete-session-metadata.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/delete-session-metadata.mdx new file mode 100644 index 0000000000..3b9d438cf3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/delete-session-metadata.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/delete-session-metadata" +title: "deleteSessionMetadata" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.deleteSessionMetadata" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `deleteSessionMetadata` + +Delete all metadata for a session. + +## Signature + +```typescript +deleteSessionMetadata(sessionId: string): boolean +``` + +## Parameters + + + The session identifier. + + +## Returns + +`boolean` — True if the session existed and was deleted. + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 308. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/end-session.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/end-session.mdx new file mode 100644 index 0000000000..4b0ab40187 --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/end-session.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/end-session" +title: "endSession" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.endSession" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `endSession` + +Legacy method retained for API compatibility with the Python SDK. +Does nothing and returns `true`. + +## Signature + +```typescript +endSession(_callId: string): boolean +``` + +## Parameters + + + The call/session identifier (unused). + + +## Returns + +`boolean` — Always `true`. + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 299. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/generate-token.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/generate-token.mdx new file mode 100644 index 0000000000..a3cce22909 --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/generate-token.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/generate-token" +title: "generateToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.generateToken" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `generateToken` + +Generate a signed, base64url-encoded token binding a function name to a call ID. + +## Signature + +```typescript +generateToken(functionName: string, callId: string): string +``` + +## Parameters + + + The SWAIG function name to bind. + + + + The call ID to bind. + + +## Returns + +`string` — A base64url-encoded token string. + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 73. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/get-session-metadata.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/get-session-metadata.mdx new file mode 100644 index 0000000000..8400b83588 --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/get-session-metadata.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/get-session-metadata" +title: "getSessionMetadata" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.getSessionMetadata" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `getSessionMetadata` + +Retrieve metadata associated with a session. + +Returns an empty object when no metadata has been stored for the session, +matching Python SDK behavior (`get_session_metadata` always returns `{}`). +Callers can safely check truthiness or iterate keys without a null guard. + +## Signature + +```typescript +getSessionMetadata(sessionId: string): Record +``` + +## Parameters + + + The session identifier. + + +## Returns + +`Record` — The metadata record for the session, or `{}` if no metadata exists. + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 233. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/index.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/index.mdx new file mode 100644 index 0000000000..813c218e5d --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/index.mdx @@ -0,0 +1,99 @@ +--- +slug: "/reference/typescript/session-manager/session-manager" +title: "SessionManager" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "SessionManager.SessionManager" + parent: "SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `SessionManager` + +Stateless HMAC-SHA256 token manager for SWAIG function call authentication and per-session metadata storage. + +## Signature + +```typescript +class SessionManager +``` + +## Properties + + + When true, [debugToken](/reference/typescript/session-manager/session-manager/debug-token) decodes token internals. When false (default), it returns `{ error: "debug mode not enabled" }`. + + + + HMAC signing secret. + + + + Token validity duration in seconds. + + +## Methods + + + + Legacy method retained for API compatibility with the Python SDK. Does nothing and returns `true`. + + + + Remove session metadata entries older than `maxAgeMs`. + + + + Create a new SessionManager. + + + + Return the given callId or generate a new random session identifier. + + + + Alias for [generateToken](/reference/typescript/session-manager/session-manager/generate-token). + + + + Debug a token without validating it. + + + + Delete all metadata for a session. + + + + Legacy method retained for API compatibility with the Python SDK. Does nothing and returns `true`. + + + + Generate a signed, base64url-encoded token binding a function name to a call ID. + + + + Retrieve metadata associated with a session. + + + + Merge metadata into a session, creating the entry if it does not exist. + + + + Validate a token against the expected call ID and function name. + + + + Alias for [validateToken](/reference/typescript/session-manager/session-manager/validate-token) with reordered parameters. + + + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 33. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/set-session-metadata.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/set-session-metadata.mdx new file mode 100644 index 0000000000..4fd5de572b --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/set-session-metadata.mdx @@ -0,0 +1,77 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/set-session-metadata" +title: "setSessionMetadata" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.setSessionMetadata" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `setSessionMetadata` + +Merge metadata into a session, creating the entry if it does not exist. + +Supports two call signatures for Python SDK compatibility: + +- `setSessionMetadata(sessionId, metadata)` — bulk merge (TS-native) +- `setSessionMetadata(sessionId, key, value)` — single key/value (Python-compatible) + +## Signature + + + + ```typescript + setSessionMetadata( + sessionId: string, + metadataOrKey: Record + ): void + ``` + + + + ```typescript + setSessionMetadata(sessionId: string, key: string, value: unknown): boolean + ``` + + + +## Parameters (Overload 1) + + + The session identifier. + + + + A metadata record to merge, or a string key when called with three arguments. + + +## Parameters (Overload 2) + + + The session identifier. + + + + + + The value to set when called with a string key. + + +## Returns (Overload 1) + +`void` + +## Returns (Overload 2) + +`boolean` + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 248. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/validate-token.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/validate-token.mdx new file mode 100644 index 0000000000..67dcd46902 --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/validate-token.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/validate-token" +title: "validateToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.validateToken" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `validateToken` + +Validate a token against the expected call ID and function name. + +## Signature + +```typescript +validateToken(callId: string, functionName: string, token: string): boolean +``` + +## Parameters + + + The expected call ID. + + + + The expected function name. + + + + The base64url-encoded token to validate. + + +## Returns + +`boolean` — True if the token is valid and not expired. + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 103. diff --git a/fern/products/sdk-reference/typescript/session-manager/session-manager/validate-tool-token.mdx b/fern/products/sdk-reference/typescript/session-manager/session-manager/validate-tool-token.mdx new file mode 100644 index 0000000000..3cf4680a6d --- /dev/null +++ b/fern/products/sdk-reference/typescript/session-manager/session-manager/validate-tool-token.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/session-manager/session-manager/validate-tool-token" +title: "validateToolToken" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SessionManager.SessionManager.validateToolToken" + parent: "SessionManager.SessionManager" + module: "SessionManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts" +--- +# `validateToolToken` + +Alias for [validateToken](/reference/typescript/session-manager/session-manager/validate-token) with reordered parameters. + +## Signature + +```typescript +validateToolToken(functionName: string, token: string, callId: string): boolean +``` + +## Parameters + + + The expected function name. + + + + The base64url-encoded token to validate. + + + + The expected call ID. + + +## Returns + +`boolean` — True if the token is valid and not expired. + +## Source + +[`src/SessionManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SessionManager.ts) + +Line 156. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/cleanup.mdx new file mode 100644 index 0000000000..79b6ebb350 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.cleanup" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/constructor.mdx new file mode 100644 index 0000000000..04ebb3bbc5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.constructor" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): ApiNinjasTriviaSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`ApiNinjasTriviaSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/define-tool.mdx new file mode 100644 index 0000000000..32406d3dfe --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.defineTool" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-agent.mdx new file mode 100644 index 0000000000..3e539e8081 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.getAgent" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-config.mdx new file mode 100644 index 0000000000..8748868ed8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.getConfig" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..a80605f91a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.getDataMapTools" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-global-data.mdx new file mode 100644 index 0000000000..77fffef3e1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.getGlobalData" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-hints.mdx new file mode 100644 index 0000000000..ca70bec78e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-hints.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.getHints" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts" +--- +# `getHints` + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Speech recognition hints for trivia-related keywords. + +## Source + +[`src/skills/builtin/api_ninjas_trivia.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts) + +Line 278. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-instance-key.mdx new file mode 100644 index 0000000000..2dd90859d3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-instance-key.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.getInstanceKey" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts" +--- +# `getInstanceKey` + +Produce a compound instance key matching Python `get_instance_key` +(skill.py:139-146): `f"{SKILL_NAME}_{self.tool_name}"` with +`tool_name` defaulting to `'get_trivia'` (skill.py:95). The base +`SkillBase.getInstanceKey` uses `this.skillName` as the fallback, +so we override to match Python's `'get_trivia'` default. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`src/skills/builtin/api_ninjas_trivia.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts) + +Line 114. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..10ba2b5191 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.getParameterSchema" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/api_ninjas_trivia.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts) + +Line 68. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..953d01dd9d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.getPromptSections" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-skill-data.mdx new file mode 100644 index 0000000000..19c6076635 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.getSkillData" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..a064cbb1aa --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.getSkillNamespace" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-tools.mdx new file mode 100644 index 0000000000..82be8ce720 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.getTools" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — A single trivia tool (configurable name) that fetches a random trivia question with optional category. + +## Source + +[`src/skills/builtin/api_ninjas_trivia.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts) + +Line 120. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..a6d4f13848 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.hasAllEnvVars" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/has-all-packages.mdx new file mode 100644 index 0000000000..46bbf2a790 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.hasAllPackages" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/index.mdx new file mode 100644 index 0000000000..1d94347403 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/index.mdx @@ -0,0 +1,184 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill" +title: "ApiNinjasTriviaSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + parent: "skills.builtin.api_ninjas_trivia" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts" +--- +# `ApiNinjasTriviaSkill` + +Fetches trivia questions from the API Ninjas service. + +Tier 2 built-in skill. Requires the `API_NINJAS_KEY` environment variable. +Supports optional `default_category` and `reveal_answer` config options. + +## Signature + +```typescript +class ApiNinjasTriviaSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('api_ninjas_trivia', { default_category: 'sciencenature' }); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + + + Produce a compound instance key matching Python `get_instance_key` (skill.py:139-146): `f"{SKILL_NAME}_{self.tool_name}"` with `tool_name` defaulting to `'get_trivia'` (skill.py:95). The base `SkillBase.getInstanceKey` uses `this.skillName` as the fallback, so we override to match Python's `'get_trivia'` default. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/api_ninjas_trivia.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts) + +Line 59. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/is-initialized.mdx new file mode 100644 index 0000000000..25bbf0df8d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.isInitialized" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/mark-initialized.mdx new file mode 100644 index 0000000000..5cf5af16b5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.markInitialized" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/set-agent.mdx new file mode 100644 index 0000000000..52209fbded --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.setAgent" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/setup.mdx new file mode 100644 index 0000000000..f8dcb2eae2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.setup" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 313. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/update-skill-data.mdx new file mode 100644 index 0000000000..fbbae9d5f4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.updateSkillData" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..05b74ed055 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.validateEnvVars" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/validate-packages.mdx new file mode 100644 index 0000000000..ed10b9ef21 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/api-ninjas-trivia-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill.validatePackages" + parent: "skills.builtin.api_ninjas_trivia.ApiNinjasTriviaSkill" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/create-skill.mdx new file mode 100644 index 0000000000..6bba991c15 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia.createSkill" + parent: "skills.builtin.api_ninjas_trivia" + module: "skills.builtin.api_ninjas_trivia" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts" +--- +# `createSkill` + +Factory function for creating ApiNinjasTriviaSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): ApiNinjasTriviaSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`ApiNinjasTriviaSkill` — A new ApiNinjasTriviaSkill instance. + +## Source + +[`src/skills/builtin/api_ninjas_trivia.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts) + +Line 288. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/index.mdx new file mode 100644 index 0000000000..0782348778 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/api-ninjas-trivia/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/api-ninjas-trivia" +title: "api_ninjas_trivia" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.api_ninjas_trivia" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts" +--- +# `api_ninjas_trivia` + +## Signature + +```typescript +module api_ninjas_trivia +``` + +## Functions + + + + Factory function for creating ApiNinjasTriviaSkill instances. + + + +## Classes + + + + Fetches trivia questions from the API Ninjas service. + + + +## Source + +[`src/skills/builtin/api_ninjas_trivia.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/api_ninjas_trivia.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/cleanup.mdx new file mode 100644 index 0000000000..96c8bd10e3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.cleanup" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/constructor.mdx new file mode 100644 index 0000000000..be72dda0c5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.constructor" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): AskClaudeSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`AskClaudeSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/define-tool.mdx new file mode 100644 index 0000000000..fc96941214 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.defineTool" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-agent.mdx new file mode 100644 index 0000000000..ab0ecd9434 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.getAgent" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-config.mdx new file mode 100644 index 0000000000..2edccc3b13 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.getConfig" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..36dac672c1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.getDataMapTools" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-global-data.mdx new file mode 100644 index 0000000000..e59bc36b92 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.getGlobalData" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-hints.mdx new file mode 100644 index 0000000000..131adc7ebe --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.getHints" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-instance-key.mdx new file mode 100644 index 0000000000..ce0b66fba4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.getInstanceKey" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 427. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..dd2c374312 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.getParameterSchema" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/ask_claude.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/ask_claude.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/ask_claude.ts) + +Line 88. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..ead07fcc50 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.getPromptSections" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-skill-data.mdx new file mode 100644 index 0000000000..7c6bc9bb51 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.getSkillData" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..42b09ed6b2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.getSkillNamespace" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-tools.mdx new file mode 100644 index 0000000000..0e59b5cc31 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.getTools" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/ask_claude.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — A single `ask_claude` tool that sends prompts to the Claude API. + +## Source + +[`src/skills/builtin/ask_claude.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/ask_claude.ts) + +Line 112. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..74a5212882 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.hasAllEnvVars" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/has-all-packages.mdx new file mode 100644 index 0000000000..75ef5a7e7a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.hasAllPackages" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/index.mdx new file mode 100644 index 0000000000..07d92a0a3d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/index.mdx @@ -0,0 +1,187 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill" +title: "AskClaudeSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill" + parent: "skills.builtin.ask_claude" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/ask_claude.ts" +--- +# `AskClaudeSkill` + +Provides access to Anthropic's Claude AI for sub-queries and complex reasoning. + +Tier 3 built-in skill. Requires the `ANTHROPIC_API_KEY` environment variable. +Supports `model` and `max_tokens` config options to control which Claude model +is used and the maximum response length. + +## Signature + +```typescript +class AskClaudeSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('ask_claude', { model: 'claude-sonnet-4-6', max_tokens: 512 }); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/ask_claude.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/ask_claude.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/is-initialized.mdx new file mode 100644 index 0000000000..174c50a6cd --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.isInitialized" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/mark-initialized.mdx new file mode 100644 index 0000000000..dd6e51f651 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.markInitialized" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/set-agent.mdx new file mode 100644 index 0000000000..4fefc84b04 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.setAgent" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/setup.mdx new file mode 100644 index 0000000000..2d82e011f6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.setup" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 313. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/update-skill-data.mdx new file mode 100644 index 0000000000..1af2f72fc5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.updateSkillData" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..2298640a07 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.validateEnvVars" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/validate-packages.mdx new file mode 100644 index 0000000000..b4c957816b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/ask-claude-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/ask-claude-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.AskClaudeSkill.validatePackages" + parent: "skills.builtin.ask_claude.AskClaudeSkill" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/create-skill.mdx new file mode 100644 index 0000000000..0e4b3983ba --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.ask_claude.createSkill" + parent: "skills.builtin.ask_claude" + module: "skills.builtin.ask_claude" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/ask_claude.ts" +--- +# `createSkill` + +Factory function for creating AskClaudeSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): AskClaudeSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`AskClaudeSkill` — A new AskClaudeSkill instance. + +## Source + +[`src/skills/builtin/ask_claude.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/ask_claude.ts) + +Line 244. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/index.mdx new file mode 100644 index 0000000000..ff1da8c5e6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/ask-claude/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/ask-claude" +title: "ask_claude" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.ask_claude" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/ask_claude.ts" +--- +# `ask_claude` + +## Signature + +```typescript +module ask_claude +``` + +## Functions + + + + Factory function for creating AskClaudeSkill instances. + + + +## Classes + + + + Provides access to Anthropic's Claude AI for sub-queries and complex reasoning. + + + +## Source + +[`src/skills/builtin/ask_claude.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/ask_claude.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/cleanup.mdx new file mode 100644 index 0000000000..7298de5e2d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.cleanup" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/constructor.mdx new file mode 100644 index 0000000000..c83579c787 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.constructor" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): ClaudeSkillsSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`ClaudeSkillsSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/define-tool.mdx new file mode 100644 index 0000000000..30ad967a69 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.defineTool" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-agent.mdx new file mode 100644 index 0000000000..249d58c7ea --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.getAgent" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-config.mdx new file mode 100644 index 0000000000..c403effac9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.getConfig" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..603e6379fc --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.getDataMapTools" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-global-data.mdx new file mode 100644 index 0000000000..7defec0657 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.getGlobalData" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-hints.mdx new file mode 100644 index 0000000000..c96d873fb2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.getHints" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/builtin/claude_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts) + +Line 898. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-instance-key.mdx new file mode 100644 index 0000000000..c4b83ee6e4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.getInstanceKey" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/builtin/claude_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts) + +Line 964. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..f71b55c05f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.getParameterSchema" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/claude_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts) + +Line 99. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..53914ab17f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.getPromptSections" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-skill-data.mdx new file mode 100644 index 0000000000..93923de349 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.getSkillData" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..956b7b54f5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.getSkillNamespace" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-tools.mdx new file mode 100644 index 0000000000..8379136662 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-tools.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.getTools" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts" +--- +# `getTools` + +Return the SWAIG tool definitions this skill provides. + +Default implementation returns tools registered imperatively via +`defineTool()`. Skills using the declarative pattern override this +method to return a static array built from their config. + +Python parity: replaces the `@abstractmethod register_tools()` contract +— Python skills call `self.define_tool(...)` inside `register_tools()`; +TypeScript skills either call `this.defineTool(...)` in `setup()` (and +let the default `getTools()` return them) or override `getTools()` +directly. + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — Array of tool definitions to register with the agent. + +## Source + +[`src/skills/builtin/claude_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts) + +Line 762. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..8368c5e8cf --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.hasAllEnvVars" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/has-all-packages.mdx new file mode 100644 index 0000000000..07e2bd24a7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.hasAllPackages" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/index.mdx new file mode 100644 index 0000000000..0f86fbdc17 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/index.mdx @@ -0,0 +1,189 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill" +title: "ClaudeSkillsSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill" + parent: "skills.builtin.claude_skills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts" +--- +# `ClaudeSkillsSkill` + +Load Claude-style SKILL.md files as SignalWire agent tools. + +This skill parses Claude Code skill directories and makes them available +as SWAIG tools that the AI can call. Each Claude skill becomes a tool +that returns the skill's instructions when invoked. + +## Signature + +```typescript +class ClaudeSkillsSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('claude_skills', { skills_dir: './claude-skills' }); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + Return the SWAIG tool definitions this skill provides. + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the Claude skills loader — discovers and parses all SKILL.md files. + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/claude_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/is-initialized.mdx new file mode 100644 index 0000000000..7c89c1f94f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.isInitialized" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/mark-initialized.mdx new file mode 100644 index 0000000000..3e06541799 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.markInitialized" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/set-agent.mdx new file mode 100644 index 0000000000..89af263688 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.setAgent" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/setup.mdx new file mode 100644 index 0000000000..b41506d123 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/setup.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.setup" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts" +--- +# `setup` + +Setup the Claude skills loader — discovers and parses all SKILL.md files. + +Returns `true` on success and `false` on any failure (missing path, +invalid path, stat failure, or non-directory), mirroring the Python +skill's `setup() -> bool` contract. + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/builtin/claude_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts) + +Line 186. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/update-skill-data.mdx new file mode 100644 index 0000000000..068f23d2d0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.updateSkillData" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..a067147d19 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.validateEnvVars" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/validate-packages.mdx new file mode 100644 index 0000000000..3da4ae482f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/claude-skills-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/claude-skills-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.ClaudeSkillsSkill.validatePackages" + parent: "skills.builtin.claude_skills.ClaudeSkillsSkill" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/create-skill.mdx new file mode 100644 index 0000000000..f66ee3055b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.claude_skills.createSkill" + parent: "skills.builtin.claude_skills" + module: "skills.builtin.claude_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts" +--- +# `createSkill` + +Factory function for creating ClaudeSkillsSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): ClaudeSkillsSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`ClaudeSkillsSkill` — A new ClaudeSkillsSkill instance. + +## Source + +[`src/skills/builtin/claude_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts) + +Line 981. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/index.mdx new file mode 100644 index 0000000000..cc1d4c1b6f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/claude-skills/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/claude-skills" +title: "claude_skills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.claude_skills" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts" +--- +# `claude_skills` + +## Signature + +```typescript +module claude_skills +``` + +## Functions + + + + Factory function for creating ClaudeSkillsSkill instances. + + + +## Classes + + + + Load Claude-style SKILL.md files as SignalWire agent tools. + + + +## Source + +[`src/skills/builtin/claude_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/claude_skills.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/create-skill.mdx new file mode 100644 index 0000000000..f0d30f7c46 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.createSkill" + parent: "skills.builtin.custom_skills" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts" +--- +# `createSkill` + +Factory function for creating CustomSkillsSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): CustomSkillsSkill +``` + +## Parameters + + + Configuration containing a `tools` array of custom tool definitions. + + +## Returns + +`CustomSkillsSkill` — A new CustomSkillsSkill instance. + +## Source + +[`src/skills/builtin/custom_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts) + +Line 325. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/cleanup.mdx new file mode 100644 index 0000000000..d2dd11deb0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.cleanup" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/constructor.mdx new file mode 100644 index 0000000000..5ac4a7f157 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/constructor.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.constructor" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(config?: SkillConfig): CustomSkillsSkill +``` + +## Parameters + + + Configuration object containing a `tools` array of custom tool definitions. + + +## Returns + +`CustomSkillsSkill` + +## Source + +[`src/skills/builtin/custom_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts) + +Line 106. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/define-tool.mdx new file mode 100644 index 0000000000..72e82bb879 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.defineTool" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-agent.mdx new file mode 100644 index 0000000000..9c8979087d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getAgent" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-compilation-errors.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-compilation-errors.mdx new file mode 100644 index 0000000000..359f2578ac --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-compilation-errors.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-compilation-errors" +title: "getCompilationErrors" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getCompilationErrors" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts" +--- +# `getCompilationErrors` + +Get handler compilation errors for diagnostic purposes. + +## Signature + +```typescript +getCompilationErrors(): Map +``` + +## Returns + +`Map` — A copy of the map from tool name to error message. + +## Source + +[`src/skills/builtin/custom_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts) + +Line 315. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-config.mdx new file mode 100644 index 0000000000..75e4ffb7f9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getConfig" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..9027493e3e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getDataMapTools" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-global-data.mdx new file mode 100644 index 0000000000..f275cb50d2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getGlobalData" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-hints.mdx new file mode 100644 index 0000000000..6f5cac6c86 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getHints" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-instance-key.mdx new file mode 100644 index 0000000000..a4c8d26867 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getInstanceKey" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 427. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..8e23cb2264 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getParameterSchema" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/custom_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts) + +Line 111. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..b203ae2ab1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getPromptSections" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-skill-data.mdx new file mode 100644 index 0000000000..3f3efd1791 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getSkillData" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..f50f5a767c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getSkillNamespace" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-tools.mdx new file mode 100644 index 0000000000..6beee762d6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.getTools" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — Array of dynamically generated tools from the configuration, with compiled handlers. + +## Source + +[`src/skills/builtin/custom_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts) + +Line 181. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..79f1b3fe35 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.hasAllEnvVars" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/has-all-packages.mdx new file mode 100644 index 0000000000..e6bdf4a18b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.hasAllPackages" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/index.mdx new file mode 100644 index 0000000000..c3631ece8e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/index.mdx @@ -0,0 +1,204 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill" +title: "CustomSkillsSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill" + parent: "skills.builtin.custom_skills" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts" +--- +# `CustomSkillsSkill` + +A meta-skill that registers user-defined tools from configuration. + +Tier 2 built-in skill with no external dependencies. Allows users to define +arbitrary tools via config without writing skill classes. Each tool definition +specifies a name, description, parameters, and a JavaScript handler function +body that is compiled via the Function constructor at instantiation time. + +**Security warning:** This skill uses `new Function()` to compile user-provided +code at runtime. It is gated behind the `SWML_ALLOW_CUSTOM_HANDLER_CODE=true` +environment variable to prevent unintended code execution. + +## Signature + +```typescript +class CustomSkillsSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +// Requires SWML_ALLOW_CUSTOM_HANDLER_CODE=true +agent.addSkill('custom_skills', { + tools: [ + { + name: 'echo', + description: 'Echo back the caller-supplied message.', + parameters: { type: 'object', properties: { msg: { type: 'string' } } }, + handlerBody: 'return new FunctionResult(args.msg);', + }, + ], +}); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get handler compilation errors for diagnostic purposes. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/custom_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts) + +Line 94. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/is-initialized.mdx new file mode 100644 index 0000000000..1855a66ecd --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.isInitialized" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/mark-initialized.mdx new file mode 100644 index 0000000000..c222bf2f5e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.markInitialized" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/set-agent.mdx new file mode 100644 index 0000000000..5347ce5008 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.setAgent" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/setup.mdx new file mode 100644 index 0000000000..b8185ebe73 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.setup" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 313. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/update-skill-data.mdx new file mode 100644 index 0000000000..ee71938afd --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.updateSkillData" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..6ca9e03692 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.validateEnvVars" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/validate-packages.mdx new file mode 100644 index 0000000000..dd93314b0c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/custom-skills-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills/custom-skills-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.custom_skills.CustomSkillsSkill.validatePackages" + parent: "skills.builtin.custom_skills.CustomSkillsSkill" + module: "skills.builtin.custom_skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/index.mdx new file mode 100644 index 0000000000..5bb4b024cb --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/custom-skills/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/custom-skills" +title: "custom_skills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.custom_skills" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts" +--- +# `custom_skills` + +## Signature + +```typescript +module custom_skills +``` + +## Functions + + + + Factory function for creating CustomSkillsSkill instances. + + + +## Classes + + + + A meta-skill that registers user-defined tools from configuration. + + + +## Source + +[`src/skills/builtin/custom_skills.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/custom_skills.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/create-skill.mdx new file mode 100644 index 0000000000..c8d90f0552 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.createSkill" + parent: "skills.builtin.datasphere_serverless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts" +--- +# `createSkill` + +Factory function for creating DataSphereServerlessSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): DataSphereServerlessSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`DataSphereServerlessSkill` — A new DataSphereServerlessSkill instance. + +## Source + +[`src/skills/builtin/datasphere_serverless.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts) + +Line 345. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/cleanup.mdx new file mode 100644 index 0000000000..f5a1e7c577 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.cleanup" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/constructor.mdx new file mode 100644 index 0000000000..bf4d7a4f3b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.constructor" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): DataSphereServerlessSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`DataSphereServerlessSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/define-tool.mdx new file mode 100644 index 0000000000..507bbd6320 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.defineTool" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-agent.mdx new file mode 100644 index 0000000000..db04b2d96c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.getAgent" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-config.mdx new file mode 100644 index 0000000000..473c6af655 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.getConfig" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..ecadb4b613 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-data-map-tools.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.getDataMapTools" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts" +--- +# `getDataMapTools` + +Get DataMap-based tool definitions for server-side execution. +These are registered directly in the SWML output as data\_map functions +rather than as webhook-backed SWAIG tools. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array containing the DataSphere search DataMap function definition. + +## Source + +[`src/skills/builtin/datasphere_serverless.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts) + +Line 317. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-global-data.mdx new file mode 100644 index 0000000000..2ee8e9144e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-global-data.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.getGlobalData" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts" +--- +# `getGlobalData` + +Global data injected into the agent's SWML/SWAIG context. Matches +Python's `get_global_data()` shape so downstream consumers can +detect DataSphere availability. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` + +## Source + +[`src/skills/builtin/datasphere_serverless.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts) + +Line 164. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-hints.mdx new file mode 100644 index 0000000000..b9472ecc8f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.getHints" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-instance-key.mdx new file mode 100644 index 0000000000..db68dba02b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-instance-key.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.getInstanceKey" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts" +--- +# `getInstanceKey` + +Instance key for the SkillManager. Defaults to +`datasphere_serverless_search_knowledge`, matching the Python SDK default. +When `tool_name` is set, uses `datasphere_serverless_`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`src/skills/builtin/datasphere_serverless.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts) + +Line 135. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..4772aa03d0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.getParameterSchema" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/datasphere_serverless.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..0415d17451 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.getPromptSections" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-skill-data.mdx new file mode 100644 index 0000000000..0f345b2bb8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.getSkillData" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..507383b36a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.getSkillNamespace" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-tools.mdx new file mode 100644 index 0000000000..65611e25f1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-tools.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.getTools" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts" +--- +# `getTools` + +Return a stub tool definition since this skill uses DataMap-based execution. +The actual DataMap function is provided by getDataMapTools(). + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — A single stub tool (named via `tool_name`) that explains its DataMap nature. + +## Source + +[`src/skills/builtin/datasphere_serverless.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts) + +Line 287. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..f8334f5258 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.hasAllEnvVars" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/has-all-packages.mdx new file mode 100644 index 0000000000..5b7fcd1c2a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.hasAllPackages" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/index.mdx new file mode 100644 index 0000000000..bd8a5bd3ab --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/index.mdx @@ -0,0 +1,193 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill" +title: "DataSphereServerlessSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + parent: "skills.builtin.datasphere_serverless" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts" +--- +# `DataSphereServerlessSkill` + +Searches SignalWire DataSphere using a server-side DataMap for serverless execution. + +Tier 3 built-in skill that generates a DataMap configuration SignalWire +executes directly, without a webhook endpoint. Supports `document_id`, +`count`, `distance`, `tags`, `language`, `pos_to_expand`, `max_synonyms`, +and `no_results_message` config options. + +## Signature + +```typescript +class DataSphereServerlessSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('datasphere_serverless', { + document_id: 'doc_abc123', + count: 3, +}); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Get DataMap-based tool definitions for server-side execution. These are registered directly in the SWML output as data\_map functions rather than as webhook-backed SWAIG tools. + + + + Global data injected into the agent's SWML/SWAIG context. Matches Python's `get_global_data()` shape so downstream consumers can detect DataSphere availability. + + + + Get speech recognition hints relevant to this skill. + + + + Instance key for the SkillManager. Defaults to `datasphere_serverless_search_knowledge`, matching the Python SDK default. When `tool_name` is set, uses `datasphere_serverless_`. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + Return a stub tool definition since this skill uses DataMap-based execution. The actual DataMap function is provided by getDataMapTools(). + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Validate required configuration parameters before the skill becomes active. + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/datasphere_serverless.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts) + +Line 45. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/is-initialized.mdx new file mode 100644 index 0000000000..4fad97035e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.isInitialized" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/mark-initialized.mdx new file mode 100644 index 0000000000..be8a147549 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.markInitialized" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/set-agent.mdx new file mode 100644 index 0000000000..be4d947faa --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.setAgent" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/setup.mdx new file mode 100644 index 0000000000..ac3e337102 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/setup.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.setup" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts" +--- +# `setup` + +Validate required configuration parameters before the skill becomes active. + +Mirrors Python's `setup()` which checks `space_name`, `project_id`, `token`, +and `document_id` and returns `False` (logging an error) if any are absent. + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if all required params are present, `false` otherwise. + +## Source + +[`src/skills/builtin/datasphere_serverless.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts) + +Line 147. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/update-skill-data.mdx new file mode 100644 index 0000000000..9dfeb1b9b4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.updateSkillData" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..531f1a2797 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.validateEnvVars" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/validate-packages.mdx new file mode 100644 index 0000000000..c86b712cba --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless/data-sphere-serverless-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill.validatePackages" + parent: "skills.builtin.datasphere_serverless.DataSphereServerlessSkill" + module: "skills.builtin.datasphere_serverless" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/index.mdx new file mode 100644 index 0000000000..827158c0dd --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere-serverless/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere-serverless" +title: "datasphere_serverless" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.datasphere_serverless" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts" +--- +# `datasphere_serverless` + +## Signature + +```typescript +module datasphere_serverless +``` + +## Functions + + + + Factory function for creating DataSphereServerlessSkill instances. + + + +## Classes + + + + Searches SignalWire DataSphere using a server-side DataMap for serverless execution. + + + +## Source + +[`src/skills/builtin/datasphere_serverless.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere_serverless.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/create-skill.mdx new file mode 100644 index 0000000000..3e48219611 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.datasphere.createSkill" + parent: "skills.builtin.datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts" +--- +# `createSkill` + +Factory function for creating DataSphereSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): DataSphereSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`DataSphereSkill` — A new DataSphereSkill instance. + +## Source + +[`src/skills/builtin/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts) + +Line 457. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/cleanup.mdx new file mode 100644 index 0000000000..3500fdaec5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.cleanup" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/constructor.mdx new file mode 100644 index 0000000000..b78178efec --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.constructor" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): DataSphereSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`DataSphereSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/define-tool.mdx new file mode 100644 index 0000000000..7f8dbdf302 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.defineTool" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-agent.mdx new file mode 100644 index 0000000000..02f3b22ae7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.getAgent" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-config.mdx new file mode 100644 index 0000000000..ec4b27008b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.getConfig" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..1cfd54ce10 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.getDataMapTools" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-global-data.mdx new file mode 100644 index 0000000000..d4d9650c81 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-global-data.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.getGlobalData" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts" +--- +# `getGlobalData` + +Global data injected into the agent's SWML context. Matches Python's +`get_global_data()` so downstream consumers can detect DataSphere +availability, the configured `document_id`, and the knowledge provider. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` + +## Source + +[`src/skills/builtin/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts) + +Line 179. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-hints.mdx new file mode 100644 index 0000000000..a906f2cd9c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.getHints" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-instance-key.mdx new file mode 100644 index 0000000000..25e689fbfc --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-instance-key.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.getInstanceKey" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts" +--- +# `getInstanceKey` + +Instance key for the SkillManager. Defaults to `datasphere_search_knowledge`, +matching the Python SDK default. When `tool_name` is set, uses +`datasphere_`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`src/skills/builtin/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts) + +Line 169. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..49ddeb406b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.getParameterSchema" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts) + +Line 81. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..98e6f51e18 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.getPromptSections" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-skill-data.mdx new file mode 100644 index 0000000000..3bec6fde6e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.getSkillData" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..548d666882 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.getSkillNamespace" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-tools.mdx new file mode 100644 index 0000000000..f9dcd746b2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.getTools" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — A single tool (named via `tool_name`) that performs semantic search. + +## Source + +[`src/skills/builtin/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts) + +Line 224. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..a1980a8656 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.hasAllEnvVars" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/has-all-packages.mdx new file mode 100644 index 0000000000..0cc14adb37 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.hasAllPackages" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/index.mdx new file mode 100644 index 0000000000..ecd41ac1bc --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/index.mdx @@ -0,0 +1,192 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill" +title: "DataSphereSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill" + parent: "skills.builtin.datasphere" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts" +--- +# `DataSphereSkill` + +Searches SignalWire DataSphere for knowledge base content using semantic search. + +Tier 3 built-in skill. Credentials can be supplied via params or fall back to +`SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_TOKEN`, and `SIGNALWIRE_SPACE` environment +variables. Supports `count`, `distance`, `tags`, `language`, `pos_to_expand`, +`max_synonyms`, and `no_results_message` config options. + +## Signature + +```typescript +class DataSphereSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('datasphere', { + document_id: 'doc_abc123', + count: 3, + tags: ['faq'], +}); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Global data injected into the agent's SWML context. Matches Python's `get_global_data()` so downstream consumers can detect DataSphere availability, the configured `document_id`, and the knowledge provider. + + + + Get speech recognition hints relevant to this skill. + + + + Instance key for the SkillManager. Defaults to `datasphere_search_knowledge`, matching the Python SDK default. When `tool_name` is set, uses `datasphere_`. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Validate required credentials before the skill becomes active. + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts) + +Line 71. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/is-initialized.mdx new file mode 100644 index 0000000000..f9b7b19ca8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.isInitialized" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/mark-initialized.mdx new file mode 100644 index 0000000000..5ae440e3ee --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.markInitialized" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/set-agent.mdx new file mode 100644 index 0000000000..b4a49a33c6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.setAgent" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/setup.mdx new file mode 100644 index 0000000000..8300427168 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.setup" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts" +--- +# `setup` + +Validate required credentials before the skill becomes active. + +Mirrors Python skills/datasphere/skill.py:120-128: `setup()` returns false +when any of `space_name`, `project_id`, `token`, or `document_id` is +missing from either config or env. Fails closed so SkillManager refuses +to register a skill that would break at call time. + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/builtin/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts) + +Line 195. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/update-skill-data.mdx new file mode 100644 index 0000000000..be54d693c0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.updateSkillData" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..2ba7e4b301 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.validateEnvVars" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/datasphere/data-sphere-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/validate-packages.mdx new file mode 100644 index 0000000000..c946666583 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/data-sphere-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere/data-sphere-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datasphere.DataSphereSkill.validatePackages" + parent: "skills.builtin.datasphere.DataSphereSkill" + module: "skills.builtin.datasphere" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datasphere/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/index.mdx new file mode 100644 index 0000000000..730bc89659 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datasphere/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/datasphere" +title: "datasphere" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.datasphere" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts" +--- +# `datasphere` + +## Signature + +```typescript +module datasphere +``` + +## Functions + + + + Factory function for creating DataSphereSkill instances. + + + +## Classes + + + + Searches SignalWire DataSphere for knowledge base content using semantic search. + + + +## Source + +[`src/skills/builtin/datasphere.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datasphere.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/create-skill.mdx new file mode 100644 index 0000000000..847fc43488 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.datetime.createSkill" + parent: "skills.builtin.datetime" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datetime.ts" +--- +# `createSkill` + +Factory function for creating DateTimeSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): DateTimeSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`DateTimeSkill` — A new DateTimeSkill instance. + +## Source + +[`src/skills/builtin/datetime.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datetime.ts) + +Line 135. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/cleanup.mdx new file mode 100644 index 0000000000..859cd9df86 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.cleanup" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/constructor.mdx new file mode 100644 index 0000000000..8bcaac27a5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.constructor" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): DateTimeSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`DateTimeSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/define-tool.mdx new file mode 100644 index 0000000000..564c7b7c07 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.defineTool" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-agent.mdx new file mode 100644 index 0000000000..fe75b7d713 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.getAgent" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-config.mdx new file mode 100644 index 0000000000..17b7757b55 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.getConfig" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..a89f7d2852 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.getDataMapTools" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-global-data.mdx new file mode 100644 index 0000000000..fa40382e9d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.getGlobalData" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-hints.mdx new file mode 100644 index 0000000000..9015780b82 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.getHints" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-instance-key.mdx new file mode 100644 index 0000000000..483668e432 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.getInstanceKey" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 427. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..063324a257 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.getParameterSchema" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datetime.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/datetime.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datetime.ts) + +Line 38. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..3f1e930366 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.getPromptSections" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-skill-data.mdx new file mode 100644 index 0000000000..61ac0216b0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.getSkillData" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..b2e805381d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.getSkillNamespace" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-tools.mdx new file mode 100644 index 0000000000..4397d6f6fb --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.getTools" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datetime.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — Two tools: `get_current_time` and `get_current_date`, each accepting an optional IANA timezone and defaulting to UTC. + +## Source + +[`src/skills/builtin/datetime.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datetime.ts) + +Line 46. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..d06514dd10 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.hasAllEnvVars" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/has-all-packages.mdx new file mode 100644 index 0000000000..9bfaa566ab --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.hasAllPackages" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/index.mdx new file mode 100644 index 0000000000..c04bfccb6e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/index.mdx @@ -0,0 +1,188 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill" +title: "DateTimeSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill" + parent: "skills.builtin.datetime" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datetime.ts" +--- +# `DateTimeSkill` + +Provides the current date and time with optional timezone support. + +Tier 1 built-in skill with no external dependencies. Supports all IANA +timezone identifiers via the Intl.DateTimeFormat API. + +Registers two SWAIG tools: `get_current_time` and `get_current_date`. + +## Signature + +```typescript +class DateTimeSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('datetime'); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/datetime.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datetime.ts) + +Line 29. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/is-initialized.mdx new file mode 100644 index 0000000000..9517eb9ccd --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.isInitialized" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/mark-initialized.mdx new file mode 100644 index 0000000000..3530a62687 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.markInitialized" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/set-agent.mdx new file mode 100644 index 0000000000..482d8ff693 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.setAgent" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/setup.mdx new file mode 100644 index 0000000000..f8d0fc400a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.setup" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 313. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/update-skill-data.mdx new file mode 100644 index 0000000000..000acff220 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.updateSkillData" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..f356cd7d8a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.validateEnvVars" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/datetime/date-time-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/validate-packages.mdx new file mode 100644 index 0000000000..caa525e7dc --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/date-time-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime/date-time-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.datetime.DateTimeSkill.validatePackages" + parent: "skills.builtin.datetime.DateTimeSkill" + module: "skills.builtin.datetime" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/datetime/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/datetime/index.mdx new file mode 100644 index 0000000000..7d5931b627 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/datetime/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/datetime" +title: "datetime" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.datetime" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datetime.ts" +--- +# `datetime` + +## Signature + +```typescript +module datetime +``` + +## Functions + + + + Factory function for creating DateTimeSkill instances. + + + +## Classes + + + + Provides the current date and time with optional timezone support. + + + +## Source + +[`src/skills/builtin/datetime.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/datetime.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/create-skill.mdx new file mode 100644 index 0000000000..f476b289aa --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.google_maps.createSkill" + parent: "skills.builtin.google_maps" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts" +--- +# `createSkill` + +Factory function for creating GoogleMapsSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): GoogleMapsSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`GoogleMapsSkill` — A new GoogleMapsSkill instance. + +## Source + +[`src/skills/builtin/google_maps.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts) + +Line 654. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/cleanup.mdx new file mode 100644 index 0000000000..45c8b99cae --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.cleanup" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/constructor.mdx new file mode 100644 index 0000000000..f557fad69b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.constructor" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): GoogleMapsSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`GoogleMapsSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/define-tool.mdx new file mode 100644 index 0000000000..a15e6e1ad4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.defineTool" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-agent.mdx new file mode 100644 index 0000000000..bb19efee4c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.getAgent" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-config.mdx new file mode 100644 index 0000000000..d102bee825 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.getConfig" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..0bfce81e55 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.getDataMapTools" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-global-data.mdx new file mode 100644 index 0000000000..8db425c133 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.getGlobalData" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-hints.mdx new file mode 100644 index 0000000000..4f698ddb47 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-hints.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.getHints" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts" +--- +# `getHints` + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Speech recognition hints for maps/directions keywords. + +## Source + +[`src/skills/builtin/google_maps.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts) + +Line 174. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-instance-key.mdx new file mode 100644 index 0000000000..11e4d49364 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.getInstanceKey" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 427. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..6ee60eff6d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.getParameterSchema" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/google_maps.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts) + +Line 119. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..8ea5907c8d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.getPromptSections" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-skill-data.mdx new file mode 100644 index 0000000000..be2cd6a5ca --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.getSkillData" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..f4861608af --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.getSkillNamespace" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-tools.mdx new file mode 100644 index 0000000000..4780786a87 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.getTools" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — Two tools: `get_directions` for route info and `find_place` for place discovery. + +## Source + +[`src/skills/builtin/google_maps.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts) + +Line 179. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..98cafa8b8a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.hasAllEnvVars" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/has-all-packages.mdx new file mode 100644 index 0000000000..f33d181237 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.hasAllPackages" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/index.mdx new file mode 100644 index 0000000000..b4112e1889 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/index.mdx @@ -0,0 +1,184 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill" +title: "GoogleMapsSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill" + parent: "skills.builtin.google_maps" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts" +--- +# `GoogleMapsSkill` + +Provides driving/walking/transit directions and place search via Google Maps APIs. + +Tier 3 built-in skill. Requires the `GOOGLE_MAPS_API_KEY` environment variable. +Supports a `default_mode` config option ("driving"|"walking"|"bicycling"|"transit"). + +## Signature + +```typescript +class GoogleMapsSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('google_maps', { default_mode: 'driving' }); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Fail-fast when GOOGLE\_MAPS\_API\_KEY is not set, mirroring Python's `setup()` validation. The env var is the only credential source for this skill, so loading it without the key would produce runtime errors on every tool call. + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/google_maps.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts) + +Line 107. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/is-initialized.mdx new file mode 100644 index 0000000000..26a9779661 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.isInitialized" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/mark-initialized.mdx new file mode 100644 index 0000000000..051d05b6d4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.markInitialized" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/set-agent.mdx new file mode 100644 index 0000000000..81280d2e56 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.setAgent" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/setup.mdx new file mode 100644 index 0000000000..8d19b17169 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/setup.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.setup" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts" +--- +# `setup` + +Fail-fast when GOOGLE\_MAPS\_API\_KEY is not set, mirroring Python's +`setup()` validation. The env var is the only credential source for +this skill, so loading it without the key would produce runtime +errors on every tool call. + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if the API key is present, `false` otherwise. + +## Source + +[`src/skills/builtin/google_maps.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts) + +Line 165. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/update-skill-data.mdx new file mode 100644 index 0000000000..fba7fcf776 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.updateSkillData" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..3f3edb0417 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.validateEnvVars" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/google-maps/google-maps-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/validate-packages.mdx new file mode 100644 index 0000000000..a3d2729372 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/google-maps-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps/google-maps-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.google_maps.GoogleMapsSkill.validatePackages" + parent: "skills.builtin.google_maps.GoogleMapsSkill" + module: "skills.builtin.google_maps" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/google-maps/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/index.mdx new file mode 100644 index 0000000000..d3400580d7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/google-maps/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/google-maps" +title: "google_maps" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.google_maps" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts" +--- +# `google_maps` + +## Signature + +```typescript +module google_maps +``` + +## Functions + + + + Factory function for creating GoogleMapsSkill instances. + + + +## Classes + + + + Provides driving/walking/transit directions and place search via Google Maps APIs. + + + +## Source + +[`src/skills/builtin/google_maps.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/google_maps.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/index.mdx new file mode 100644 index 0000000000..01ad3b9ff0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin" +title: "builtin" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin" + module: "skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/index.ts" +--- +# `builtin` + +## Signature + +```typescript +module builtin +``` + +## Functions + + + + Register all 19 built-in skills with the global SkillRegistry singleton. Matches Python's auto-discovery pattern (`skills/registry.py`) which finds SkillBase subclasses in the skills directory and registers them by class reference. Skips registration for any skill name already present. + + + +## Source + +[`src/skills/builtin/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/index.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/create-skill.mdx new file mode 100644 index 0000000000..d414a6f864 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.createSkill" + parent: "skills.builtin.info_gatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts" +--- +# `createSkill` + +Factory function for creating InfoGathererSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): InfoGathererSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`InfoGathererSkill` — A new InfoGathererSkill instance. + +## Source + +[`src/skills/builtin/info_gatherer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts) + +Line 413. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/index.mdx new file mode 100644 index 0000000000..2d81d0a6fa --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer" +title: "info_gatherer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts" +--- +# `info_gatherer` + +## Signature + +```typescript +module info_gatherer +``` + +## Functions + + + + Factory function for creating InfoGathererSkill instances. + + + +## Classes + + + + Collects answers to a configurable list of questions, one at a time. + + + +## Source + +[`src/skills/builtin/info_gatherer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/cleanup.mdx new file mode 100644 index 0000000000..6d072f53f7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.cleanup" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/constructor.mdx new file mode 100644 index 0000000000..fbc59c70e3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.constructor" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): InfoGathererSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`InfoGathererSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/define-tool.mdx new file mode 100644 index 0000000000..023e3251ad --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.defineTool" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-agent.mdx new file mode 100644 index 0000000000..8f33b887b6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.getAgent" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-config.mdx new file mode 100644 index 0000000000..f90431068e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.getConfig" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..cabcc51395 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.getDataMapTools" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-global-data.mdx new file mode 100644 index 0000000000..74cfa23d08 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-global-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.getGlobalData" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts" +--- +# `getGlobalData` + +Seed SWAIG `global_data` with the initial question state under this +skill's namespace. Mirrors Python `get_global_data()` (skill.py:127-135). + +Defensive no-op when the skill was not successfully set up (empty +`questions`). Python relies on the SkillManager to skip unloaded skills; +TS adds this guard so `getGlobalData()` called without a successful +`setup()` returns `{}` instead of a malformed state payload. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` + +## Source + +[`src/skills/builtin/info_gatherer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts) + +Line 170. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-hints.mdx new file mode 100644 index 0000000000..df9bc489f6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.getHints" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-instance-key.mdx new file mode 100644 index 0000000000..82d9b54545 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-instance-key.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.getInstanceKey" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts" +--- +# `getInstanceKey` + +Instance key for the SkillManager. When `prefix` is configured, returns +`info_gatherer_` to support multi-instance use. Matches Python's +`get_instance_key()` (skill.py:81-85). + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`src/skills/builtin/info_gatherer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts) + +Line 116. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..69d759daf2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.getParameterSchema" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/info_gatherer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts) + +Line 78. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..7896ccf2ca --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.getPromptSections" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-skill-data.mdx new file mode 100644 index 0000000000..62b8c5c074 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.getSkillData" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..bba7907975 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.getSkillNamespace" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-tools.mdx new file mode 100644 index 0000000000..03dfdf2185 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.getTools" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts" +--- +# `getTools` + +Register the two sequential-flow tools. Mirrors Python +`register_tools()` (skill.py:162-184). Returns an empty array when +`setup()` did not complete (no questions) so the skill never exposes +half-initialized tools. + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` + +## Source + +[`src/skills/builtin/info_gatherer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts) + +Line 189. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..b21ae5a1ab --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.hasAllEnvVars" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/has-all-packages.mdx new file mode 100644 index 0000000000..6781d30e28 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.hasAllPackages" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/index.mdx new file mode 100644 index 0000000000..97f8593139 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/index.mdx @@ -0,0 +1,195 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill" +title: "InfoGathererSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill" + parent: "skills.builtin.info_gatherer" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts" +--- +# `InfoGathererSkill` + +Collects answers to a configurable list of questions, one at a time. + +Mirrors Python `InfoGathererSkill` exactly: the same required +`questions` config, the same `prefix` / `completion_message` options, +the same two tools (`start_questions`, `submit_answer`), and the same +state shape in `global_data`. + +## Signature + +```typescript +class InfoGathererSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('info_gatherer', { + questions: [ + { key_name: 'name', question_text: 'What is your name?' }, + { key_name: 'email', question_text: 'Your email?', confirm: true }, + ], +}); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Seed SWAIG `global_data` with the initial question state under this skill's namespace. Mirrors Python `get_global_data()` (skill.py:127-135). + + + + Get speech recognition hints relevant to this skill. + + + + Instance key for the SkillManager. When `prefix` is configured, returns `info_gatherer_` to support multi-instance use. Matches Python's `get_instance_key()` (skill.py:81-85). + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + Register the two sequential-flow tools. Mirrors Python `register_tools()` (skill.py:162-184). Returns an empty array when `setup()` did not complete (no questions) so the skill never exposes half-initialized tools. + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Validate the `questions` config, derive tool names (with optional prefix), and cache the completion message. + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/info_gatherer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts) + +Line 60. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/is-initialized.mdx new file mode 100644 index 0000000000..6c60e9fd9c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.isInitialized" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/mark-initialized.mdx new file mode 100644 index 0000000000..6502423d9c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.markInitialized" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/set-agent.mdx new file mode 100644 index 0000000000..37beef8a91 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.setAgent" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/setup.mdx new file mode 100644 index 0000000000..529971a19b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/setup.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.setup" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts" +--- +# `setup` + +Validate the `questions` config, derive tool names (with optional prefix), +and cache the completion message. + +Python parity: skill.py:91-121. Returns `false` (logging an error) when +`questions` is missing or fails validation; setup must produce a +functional skill or fail closed. + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/builtin/info_gatherer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/info_gatherer.ts) + +Line 129. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/update-skill-data.mdx new file mode 100644 index 0000000000..0a05ecb20e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.updateSkillData" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..a7e55bac21 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.validateEnvVars" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/validate-packages.mdx new file mode 100644 index 0000000000..019bcadf42 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/info-gatherer/info-gatherer-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.info_gatherer.InfoGathererSkill.validatePackages" + parent: "skills.builtin.info_gatherer.InfoGathererSkill" + module: "skills.builtin.info_gatherer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/create-skill.mdx new file mode 100644 index 0000000000..add60d3241 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.joke.createSkill" + parent: "skills.builtin.joke" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts" +--- +# `createSkill` + +Factory function for creating JokeSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): JokeSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`JokeSkill` — A new JokeSkill instance. + +## Source + +[`src/skills/builtin/joke.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts) + +Line 194. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/index.mdx new file mode 100644 index 0000000000..46ab253460 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/joke" +title: "joke" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.joke" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts" +--- +# `joke` + +## Signature + +```typescript +module joke +``` + +## Functions + + + + Factory function for creating JokeSkill instances. + + + +## Classes + + + + Tells random jokes from a curated built-in collection. + + + +## Source + +[`src/skills/builtin/joke.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/cleanup.mdx new file mode 100644 index 0000000000..4f26f4b002 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.cleanup" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/constructor.mdx new file mode 100644 index 0000000000..09951c6d84 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.constructor" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): JokeSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`JokeSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/define-tool.mdx new file mode 100644 index 0000000000..f7a6b12c65 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.defineTool" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-agent.mdx new file mode 100644 index 0000000000..abb238cb6c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.getAgent" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-config.mdx new file mode 100644 index 0000000000..cb4bb79422 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.getConfig" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..918b98233e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.getDataMapTools" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-global-data.mdx new file mode 100644 index 0000000000..7713b95bf1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-global-data.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.getGlobalData" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts" +--- +# `getGlobalData` + +Signal to the agent prompt that the joke skill is active. Python +parity: `get_global_data` returns `{"joke_skill_enabled": true}`. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` + +## Source + +[`src/skills/builtin/joke.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts) + +Line 119. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-hints.mdx new file mode 100644 index 0000000000..7876cce9a2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.getHints" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-instance-key.mdx new file mode 100644 index 0000000000..f6cb2bc918 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.getInstanceKey" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 427. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..a10cfc3509 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.getParameterSchema" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/joke.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts) + +Line 104. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..a9f1265a75 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.getPromptSections" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-skill-data.mdx new file mode 100644 index 0000000000..3d9742a856 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.getSkillData" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..604000640d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.getSkillNamespace" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-tools.mdx new file mode 100644 index 0000000000..85fa23488a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.getTools" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — A single joke tool (configurable name) that returns a random joke with optional category filter. + +## Source + +[`src/skills/builtin/joke.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts) + +Line 124. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..a9e0ad23fa --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.hasAllEnvVars" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/has-all-packages.mdx new file mode 100644 index 0000000000..f2d37ab426 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.hasAllPackages" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/index.mdx new file mode 100644 index 0000000000..6fba4b562d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/index.mdx @@ -0,0 +1,186 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill" +title: "JokeSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill" + parent: "skills.builtin.joke" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts" +--- +# `JokeSkill` + +Tells random jokes from a curated built-in collection. + +Tier 1 built-in skill with no external dependencies. Includes general, +programming, and dad joke categories. + +## Signature + +```typescript +class JokeSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('joke'); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Signal to the agent prompt that the joke skill is active. Python parity: `get_global_data` returns `{"joke_skill_enabled": true}`. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/joke.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/joke.ts) + +Line 96. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/is-initialized.mdx new file mode 100644 index 0000000000..b18c94b992 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.isInitialized" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/mark-initialized.mdx new file mode 100644 index 0000000000..ae747d8f76 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.markInitialized" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/set-agent.mdx new file mode 100644 index 0000000000..e1425ba9b4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.setAgent" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/setup.mdx new file mode 100644 index 0000000000..ab07741fc7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.setup" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 313. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/update-skill-data.mdx new file mode 100644 index 0000000000..591e7f5cd8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.updateSkillData" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..9c89e33532 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.validateEnvVars" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/joke/joke-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/validate-packages.mdx new file mode 100644 index 0000000000..ad0bcf387c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/joke/joke-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/joke/joke-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.joke.JokeSkill.validatePackages" + parent: "skills.builtin.joke.JokeSkill" + module: "skills.builtin.joke" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/create-skill.mdx new file mode 100644 index 0000000000..354965c1b8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/math/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.math.createSkill" + parent: "skills.builtin.math" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/math.ts" +--- +# `createSkill` + +Factory function for creating MathSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): MathSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`MathSkill` — A new MathSkill instance. + +## Source + +[`src/skills/builtin/math.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/math.ts) + +Line 147. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/index.mdx new file mode 100644 index 0000000000..fd3575b653 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/math" +title: "math" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.math" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/math.ts" +--- +# `math` + +## Signature + +```typescript +module math +``` + +## Functions + + + + Factory function for creating MathSkill instances. + + + +## Classes + + + + Evaluates mathematical expressions safely using a sandboxed parser. + + + +## Source + +[`src/skills/builtin/math.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/math.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/cleanup.mdx new file mode 100644 index 0000000000..4b37882ef6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.cleanup" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/constructor.mdx new file mode 100644 index 0000000000..ad6cd3288e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.constructor" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): MathSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`MathSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/define-tool.mdx new file mode 100644 index 0000000000..9758aad7ab --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.defineTool" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-agent.mdx new file mode 100644 index 0000000000..82a181bc90 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.getAgent" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-config.mdx new file mode 100644 index 0000000000..8ec0cb9d7f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.getConfig" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..9c7caa8066 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.getDataMapTools" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-global-data.mdx new file mode 100644 index 0000000000..14a217ceb9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.getGlobalData" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-hints.mdx new file mode 100644 index 0000000000..9aa404a429 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.getHints" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-instance-key.mdx new file mode 100644 index 0000000000..3cb1a33c7a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.getInstanceKey" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 427. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..59941fc63f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.getParameterSchema" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/math.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/math.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/math.ts) + +Line 83. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..3e449aa6f8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.getPromptSections" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-skill-data.mdx new file mode 100644 index 0000000000..1ea5c7d5c2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.getSkillData" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..8261de9539 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.getSkillNamespace" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-tools.mdx new file mode 100644 index 0000000000..95e7de93d1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.getTools" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/math.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — A single `calculate` tool that evaluates a math expression string. + +## Source + +[`src/skills/builtin/math.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/math.ts) + +Line 88. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..a4bbc1eac1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.hasAllEnvVars" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/has-all-packages.mdx new file mode 100644 index 0000000000..7b11218289 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.hasAllPackages" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/index.mdx new file mode 100644 index 0000000000..9e70f87a18 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/index.mdx @@ -0,0 +1,188 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill" +title: "MathSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill" + parent: "skills.builtin.math" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/math.ts" +--- +# `MathSkill` + +Evaluates mathematical expressions safely using a sandboxed parser. + +Tier 1 built-in skill with no external dependencies. Only allows digits, +basic arithmetic operators, parentheses, decimal points, and spaces. + +Registers a single SWAIG tool: `calculate`. + +## Signature + +```typescript +class MathSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('math'); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/math.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/math.ts) + +Line 75. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/is-initialized.mdx new file mode 100644 index 0000000000..0533ca8e31 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.isInitialized" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/mark-initialized.mdx new file mode 100644 index 0000000000..c6cc89ba24 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.markInitialized" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/set-agent.mdx new file mode 100644 index 0000000000..fb06ed2dd4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.setAgent" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/setup.mdx new file mode 100644 index 0000000000..f000788c21 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.setup" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 313. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/update-skill-data.mdx new file mode 100644 index 0000000000..d5759b4594 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.updateSkillData" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..91d90705ab --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.validateEnvVars" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/math/math-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/validate-packages.mdx new file mode 100644 index 0000000000..b93b4e614d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/math/math-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/math/math-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.math.MathSkill.validatePackages" + parent: "skills.builtin.math.MathSkill" + module: "skills.builtin.math" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/create-skill.mdx new file mode 100644 index 0000000000..0bb4cbb7f2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.createSkill" + parent: "skills.builtin.mcp_gateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts" +--- +# `createSkill` + +Factory function for creating McpGatewaySkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): McpGatewaySkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`McpGatewaySkill` — A new McpGatewaySkill instance. + +## Source + +[`src/skills/builtin/mcp_gateway.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts) + +Line 683. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/index.mdx new file mode 100644 index 0000000000..6aba9d2504 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway" +title: "mcp_gateway" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts" +--- +# `mcp_gateway` + +## Signature + +```typescript +module mcp_gateway +``` + +## Functions + + + + Factory function for creating McpGatewaySkill instances. + + + +## Classes + + + + Bridge MCP (Model Context Protocol) servers with SWAIG functions. + + + +## Source + +[`src/skills/builtin/mcp_gateway.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/cleanup.mdx new file mode 100644 index 0000000000..0d15760fc7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.cleanup" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/constructor.mdx new file mode 100644 index 0000000000..cf9d615f44 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.constructor" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): McpGatewaySkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`McpGatewaySkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/define-tool.mdx new file mode 100644 index 0000000000..e2d3cd1d07 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.defineTool" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-agent.mdx new file mode 100644 index 0000000000..e5311780e0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.getAgent" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-config.mdx new file mode 100644 index 0000000000..4039983e4a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.getConfig" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..321488a3e3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.getDataMapTools" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-global-data.mdx new file mode 100644 index 0000000000..c85a0d969a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.getGlobalData" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/builtin/mcp_gateway.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts) + +Line 271. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-hints.mdx new file mode 100644 index 0000000000..de9069c0d1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.getHints" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/builtin/mcp_gateway.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts) + +Line 257. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-instance-key.mdx new file mode 100644 index 0000000000..b9b465c014 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.getInstanceKey" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 427. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..e6886a33bb --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.getParameterSchema" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/mcp_gateway.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts) + +Line 71. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..97a53dab26 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.getPromptSections" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-skill-data.mdx new file mode 100644 index 0000000000..f67d56204e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.getSkillData" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..551ea847b8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.getSkillNamespace" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-tools.mdx new file mode 100644 index 0000000000..e4bb14e9f1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.getTools" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — Dynamically discovered MCP tools plus an internal hangup-cleanup tool. If discovery has not completed, returns a single fallback `mcp_invoke` tool that explains configuration is missing. + +## Source + +[`src/skills/builtin/mcp_gateway.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts) + +Line 290. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..788a7621ed --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.hasAllEnvVars" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/has-all-packages.mdx new file mode 100644 index 0000000000..82b9bad326 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.hasAllPackages" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/index.mdx new file mode 100644 index 0000000000..0dabb79e07 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/index.mdx @@ -0,0 +1,191 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill" +title: "McpGatewaySkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill" + parent: "skills.builtin.mcp_gateway" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts" +--- +# `McpGatewaySkill` + +Bridge MCP (Model Context Protocol) servers with SWAIG functions. + +When configured, calls a gateway's `/services` endpoint to discover MCP +services, enumerates each service's tools, and registers them as SWAIG +tools prefixed with `tool_prefix` (default `mcp_`). A hidden hangup hook +tool cleans up MCP sessions when the call ends. + +## Signature + +```typescript +class McpGatewaySkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('mcp_gateway', { + gateway_url: 'https://mcp-gateway.example.com', + tool_prefix: 'mcp_', +}); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/mcp_gateway.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts) + +Line 61. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/is-initialized.mdx new file mode 100644 index 0000000000..6c88ed88bf --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.isInitialized" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/mark-initialized.mdx new file mode 100644 index 0000000000..d2753b72cc --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.markInitialized" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/set-agent.mdx new file mode 100644 index 0000000000..7db6d5e6ae --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.setAgent" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/setup.mdx new file mode 100644 index 0000000000..46bf7fb4e6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.setup" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/builtin/mcp_gateway.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/mcp_gateway.ts) + +Line 173. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/update-skill-data.mdx new file mode 100644 index 0000000000..65b7f36d87 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.updateSkillData" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..c195b4a933 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.validateEnvVars" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/validate-packages.mdx new file mode 100644 index 0000000000..e4df3bb14d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/mcp-gateway/mcp-gateway-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.mcp_gateway.McpGatewaySkill.validatePackages" + parent: "skills.builtin.mcp_gateway.McpGatewaySkill" + module: "skills.builtin.mcp_gateway" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/create-skill.mdx new file mode 100644 index 0000000000..ff68b41ab0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.createSkill" + parent: "skills.builtin.native_vector_search" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts" +--- +# `createSkill` + +Factory function for creating NativeVectorSearchSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): NativeVectorSearchSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`NativeVectorSearchSkill` — A new NativeVectorSearchSkill instance. + +## Source + +[`src/skills/builtin/native_vector_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts) + +Line 908. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/index.mdx new file mode 100644 index 0000000000..bb4ba8a160 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/index.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search" +title: "native_vector_search" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts" +--- +# `native_vector_search` + +## Signature + +```typescript +module native_vector_search +``` + +## Functions + + + + Factory function for creating NativeVectorSearchSkill instances. + + + +## Type Aliases + + + + Callback signature for customizing the formatted search response. + + + +## Classes + + + + Document search using TF-IDF in-memory scoring or a remote search server. + + + +## Source + +[`src/skills/builtin/native_vector_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/cleanup.mdx new file mode 100644 index 0000000000..fdbaf25d31 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.cleanup" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/builtin/native_vector_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts) + +Line 546. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/constructor.mdx new file mode 100644 index 0000000000..ab563800c9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.constructor" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): NativeVectorSearchSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`NativeVectorSearchSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/define-tool.mdx new file mode 100644 index 0000000000..3c1777b609 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.defineTool" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-agent.mdx new file mode 100644 index 0000000000..e400963020 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.getAgent" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-config.mdx new file mode 100644 index 0000000000..431090b2fc --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.getConfig" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..72a59c4165 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.getDataMapTools" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..a2645ba48a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.getGlobalData" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/builtin/native_vector_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts) + +Line 535. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-hints.mdx new file mode 100644 index 0000000000..b024766510 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.getHints" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/builtin/native_vector_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts) + +Line 529. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-instance-key.mdx new file mode 100644 index 0000000000..4006f767d0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.getInstanceKey" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/builtin/native_vector_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts) + +Line 406. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..8791751259 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.getParameterSchema" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/native_vector_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts) + +Line 169. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..786f1f44eb --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.getPromptSections" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-skill-data.mdx new file mode 100644 index 0000000000..d50e02b809 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.getSkillData" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..45f102ad82 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.getSkillNamespace" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-tools.mdx new file mode 100644 index 0000000000..093103b950 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.getTools" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — A single search tool using the configured `tool_name` (default `search_knowledge`). + +## Source + +[`src/skills/builtin/native_vector_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts) + +Line 588. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..d1b5e905d3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.hasAllEnvVars" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/has-all-packages.mdx new file mode 100644 index 0000000000..072e49ce1f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.hasAllPackages" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/index.mdx new file mode 100644 index 0000000000..4505a5eed7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/index.mdx @@ -0,0 +1,189 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill" +title: "NativeVectorSearchSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + parent: "skills.builtin.native_vector_search" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts" +--- +# `NativeVectorSearchSkill` + +Document search using TF-IDF in-memory scoring or a remote search server. + +Multi-instance capable (distinguished by `tool_name` + `index_file`). + +## Signature + +```typescript +class NativeVectorSearchSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('native_vector_search', { + tool_name: 'search_docs', + index_file: './data/support-docs.json', + count: 3, +}); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/native_vector_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts) + +Line 159. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/is-initialized.mdx new file mode 100644 index 0000000000..93cc524f4b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.isInitialized" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/mark-initialized.mdx new file mode 100644 index 0000000000..51c5c76ab8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.markInitialized" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/set-agent.mdx new file mode 100644 index 0000000000..e2a879d7b7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.setAgent" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/setup.mdx new file mode 100644 index 0000000000..058d9dc25c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.setup" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/builtin/native_vector_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts) + +Line 412. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/update-skill-data.mdx new file mode 100644 index 0000000000..6c560803a4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.updateSkillData" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..5097febedc --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.validateEnvVars" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/validate-packages.mdx new file mode 100644 index 0000000000..c7e15b14fe --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/native-vector-search-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.NativeVectorSearchSkill.validatePackages" + parent: "skills.builtin.native_vector_search.NativeVectorSearchSkill" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/response-format-callback.mdx b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/response-format-callback.mdx new file mode 100644 index 0000000000..f41dc64528 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/native-vector-search/response-format-callback.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/native-vector-search/response-format-callback" +title: "ResponseFormatCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "skills.builtin.native_vector_search.ResponseFormatCallback" + parent: "skills.builtin.native_vector_search" + module: "skills.builtin.native_vector_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts" +--- +# `ResponseFormatCallback` + +Callback signature for customizing the formatted search response. + +The context object is the TypeScript idiom for Python's positional-args +convention: `(response, agent, query, results, args)`. All Python fields are +present plus TS-specific additions (`count`, `skill`): + +- `response` — pre-formatted response string (same as Python arg 1) +- `agent` — the AgentBase instance that owns this skill (same as Python arg 2) +- `query` — the search query string (same as Python arg 3) +- `results` — array of search results (same as Python arg 4) +- `args` — raw tool call arguments (same as Python arg 5) +- `count` — requested result count (TS addition) +- `skill` — this skill instance (TS addition) + +## Signature + +```typescript +type ResponseFormatCallback = (ctx: { agent?: AgentBase; args: Record; count: number; query: string; response: string; results: { content: string; metadata: Record; score: number }[]; skill: NativeVectorSearchSkill }) => string +``` + +## Source + +[`src/skills/builtin/native_vector_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/native_vector_search.ts) + +Line 47. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/create-skill.mdx new file mode 100644 index 0000000000..b30aa4b644 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.createSkill" + parent: "skills.builtin.play_background_file" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts" +--- +# `createSkill` + +Factory function for creating PlayBackgroundFileSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): PlayBackgroundFileSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`PlayBackgroundFileSkill` — A new PlayBackgroundFileSkill instance. + +## Source + +[`src/skills/builtin/play_background_file.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts) + +Line 365. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/index.mdx new file mode 100644 index 0000000000..cfbfe911c2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file" +title: "play_background_file" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.play_background_file" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts" +--- +# `play_background_file` + +## Signature + +```typescript +module play_background_file +``` + +## Functions + + + + Factory function for creating PlayBackgroundFileSkill instances. + + + +## Classes + + + + Controls background audio playback during calls via SWML actions. + + + +## Source + +[`src/skills/builtin/play_background_file.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/cleanup.mdx new file mode 100644 index 0000000000..82f80dac7a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.cleanup" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/constructor.mdx new file mode 100644 index 0000000000..1232c55317 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.constructor" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): PlayBackgroundFileSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`PlayBackgroundFileSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/define-tool.mdx new file mode 100644 index 0000000000..9f1681b6e5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.defineTool" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-agent.mdx new file mode 100644 index 0000000000..d74c580312 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.getAgent" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-config.mdx new file mode 100644 index 0000000000..1834a462db --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.getConfig" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..56467c1a0f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.getDataMapTools" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-global-data.mdx new file mode 100644 index 0000000000..f7c3de1390 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.getGlobalData" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-hints.mdx new file mode 100644 index 0000000000..ac0264506c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.getHints" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-instance-key.mdx new file mode 100644 index 0000000000..c7a03d66b3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-instance-key.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.getInstanceKey" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts" +--- +# `getInstanceKey` + +Produce a compound instance key so multiple copies of the skill with +distinct `tool_name` values can coexist in a single agent. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`src/skills/builtin/play_background_file.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts) + +Line 114. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..d98f8587d3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.getParameterSchema" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/play_background_file.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts) + +Line 58. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..df70f91624 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.getPromptSections" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-skill-data.mdx new file mode 100644 index 0000000000..df49c993c6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.getSkillData" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..257c17fc81 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.getSkillNamespace" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-tools.mdx new file mode 100644 index 0000000000..168ce1ab5a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.getTools" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — Either a single enum-based tool (when pre-configured `files` are supplied — matches Python), or two free-form tools (`play_background` and `stop_background`) when only `default_file_url`/`allowed_domains` are configured. + +## Source + +[`src/skills/builtin/play_background_file.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts) + +Line 138. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..40202cc77c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.hasAllEnvVars" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/has-all-packages.mdx new file mode 100644 index 0000000000..64ef56a0f1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.hasAllPackages" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/index.mdx new file mode 100644 index 0000000000..253c0d270e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/index.mdx @@ -0,0 +1,197 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill" +title: "PlayBackgroundFileSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + parent: "skills.builtin.play_background_file" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts" +--- +# `PlayBackgroundFileSkill` + +Controls background audio playback during calls via SWML actions. + +Tier 2 built-in skill with no external dependencies. Provides tools to play +and stop background audio files (e.g., hold music, ambient sounds). Supports +two configuration modes: + +- Pre-configured `files` array (matches the Python skill): emits a single + configurable tool whose `action` enum maps to `start_` / `stop` + values that trigger the corresponding file playback. +- Free-form `default_file_url` / `allowed_domains`: emits two tools, + `play_background` (arbitrary URL) and `stop_background`. + +## Signature + +```typescript +class PlayBackgroundFileSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('play_background_file', { + files: [ + { key: 'hold', url: 'https://cdn.example.com/hold-music.mp3', description: 'Hold music' }, + ], +}); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Produce a compound instance key so multiple copies of the skill with distinct `tool_name` values can coexist in a single agent. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/play_background_file.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/play_background_file.ts) + +Line 52. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/is-initialized.mdx new file mode 100644 index 0000000000..d194604eb7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.isInitialized" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/mark-initialized.mdx new file mode 100644 index 0000000000..89ac917a2b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.markInitialized" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/set-agent.mdx new file mode 100644 index 0000000000..d91dcea479 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.setAgent" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/setup.mdx new file mode 100644 index 0000000000..a35ac6ecf3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.setup" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 313. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/update-skill-data.mdx new file mode 100644 index 0000000000..4b96a25c2b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.updateSkillData" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..fdeaa2c588 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.validateEnvVars" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/validate-packages.mdx new file mode 100644 index 0000000000..c401c5a8a2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/play-background-file/play-background-file-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/play-background-file/play-background-file-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.play_background_file.PlayBackgroundFileSkill.validatePackages" + parent: "skills.builtin.play_background_file.PlayBackgroundFileSkill" + module: "skills.builtin.play_background_file" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/register-builtin-skills.mdx b/fern/products/sdk-reference/typescript/skills/builtin/register-builtin-skills.mdx new file mode 100644 index 0000000000..c24bdbf29f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/register-builtin-skills.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/skills/builtin/register-builtin-skills" +title: "registerBuiltinSkills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.registerBuiltinSkills" + parent: "skills.builtin" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/index.ts" +--- +# `registerBuiltinSkills` + +Register all 19 built-in skills with the global SkillRegistry singleton. +Matches Python's auto-discovery pattern (`skills/registry.py`) which finds +SkillBase subclasses in the skills directory and registers them by class +reference. Skips registration for any skill name already present. + +## Signature + +```typescript +registerBuiltinSkills(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/builtin/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/index.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/create-skill.mdx new file mode 100644 index 0000000000..798bff6592 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.spider.createSkill" + parent: "skills.builtin.spider" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts" +--- +# `createSkill` + +Factory function for creating SpiderSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): SpiderSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`SpiderSkill` — A new SpiderSkill instance. + +## Source + +[`src/skills/builtin/spider.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts) + +Line 916. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/index.mdx new file mode 100644 index 0000000000..9d3e981e84 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/spider" +title: "spider" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.spider" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts" +--- +# `spider` + +## Signature + +```typescript +module spider +``` + +## Functions + + + + Factory function for creating SpiderSkill instances. + + + +## Classes + + + + Fast web scraping skill optimized for speed and token efficiency. + + + +## Source + +[`src/skills/builtin/spider.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/cleanup.mdx new file mode 100644 index 0000000000..dd395f9cca --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.cleanup" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/builtin/spider.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts) + +Line 300. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/constructor.mdx new file mode 100644 index 0000000000..8a9cf772b3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.constructor" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): SpiderSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`SpiderSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/define-tool.mdx new file mode 100644 index 0000000000..58d19ea22e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.defineTool" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-agent.mdx new file mode 100644 index 0000000000..f775cea2f5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.getAgent" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-config.mdx new file mode 100644 index 0000000000..eac864c7c1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.getConfig" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..4a2e0fc9df --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.getDataMapTools" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-global-data.mdx new file mode 100644 index 0000000000..553ac99ee4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.getGlobalData" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-hints.mdx new file mode 100644 index 0000000000..b07e05bb94 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.getHints" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/builtin/spider.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts) + +Line 287. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-instance-key.mdx new file mode 100644 index 0000000000..e211eb662a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.getInstanceKey" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/builtin/spider.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts) + +Line 202. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..579bc5e6a0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.getParameterSchema" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/spider.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts) + +Line 75. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..a85023dfc0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.getPromptSections" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-skill-data.mdx new file mode 100644 index 0000000000..40e50d5297 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.getSkillData" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..360ce4a41c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.getSkillNamespace" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-tools.mdx new file mode 100644 index 0000000000..d4045d4b30 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.getTools" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — Three tools: `scrape_url`, `crawl_site`, and `extract_structured_data`. + +## Source + +[`src/skills/builtin/spider.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts) + +Line 308. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..0d56b09f7a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.hasAllEnvVars" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/has-all-packages.mdx new file mode 100644 index 0000000000..b23aa9c192 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.hasAllPackages" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/index.mdx new file mode 100644 index 0000000000..30a283c1c7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/index.mdx @@ -0,0 +1,189 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill" +title: "SpiderSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill" + parent: "skills.builtin.spider" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts" +--- +# `SpiderSkill` + +Fast web scraping skill optimized for speed and token efficiency. + +Multi-instance capable. Port of the Python `SpiderSkill` with three tools: +`scrape_url`, `crawl_site`, and `extract_structured_data`. Configuration +mirrors the Python schema (delay, concurrent\_requests, timeout, max\_pages, +max\_depth, extract\_type, max\_text\_length, clean\_text, selectors, +follow\_patterns, user\_agent, headers, follow\_robots\_txt, cache\_enabled). + +## Signature + +```typescript +class SpiderSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('spider', { max_pages: 5, max_depth: 2 }); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/spider.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts) + +Line 65. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/is-initialized.mdx new file mode 100644 index 0000000000..d567f78d79 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.isInitialized" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/mark-initialized.mdx new file mode 100644 index 0000000000..fee163864e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.markInitialized" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/set-agent.mdx new file mode 100644 index 0000000000..9a817a69ca --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.setAgent" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/setup.mdx new file mode 100644 index 0000000000..ce2093758e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.setup" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/builtin/spider.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/spider.ts) + +Line 207. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/update-skill-data.mdx new file mode 100644 index 0000000000..0b000b11b5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.updateSkillData" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..f2fafad19a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.validateEnvVars" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/spider/spider-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/validate-packages.mdx new file mode 100644 index 0000000000..49bfdec0cc --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/spider/spider-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/spider/spider-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.spider.SpiderSkill.validatePackages" + parent: "skills.builtin.spider.SpiderSkill" + module: "skills.builtin.spider" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/create-skill.mdx new file mode 100644 index 0000000000..aadd1a5e45 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.createSkill" + parent: "skills.builtin.swml_transfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts" +--- +# `createSkill` + +Factory function for creating SwmlTransferSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): SwmlTransferSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`SwmlTransferSkill` — A new SwmlTransferSkill instance. + +## Source + +[`src/skills/builtin/swml_transfer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts) + +Line 643. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/index.mdx new file mode 100644 index 0000000000..4ed196492b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer" +title: "swml_transfer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts" +--- +# `swml_transfer` + +## Signature + +```typescript +module swml_transfer +``` + +## Functions + + + + Factory function for creating SwmlTransferSkill instances. + + + +## Classes + + + + Transfer calls between agents based on pattern matching. + + + +## Source + +[`src/skills/builtin/swml_transfer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/cleanup.mdx new file mode 100644 index 0000000000..a197a5bcf1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.cleanup" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/constructor.mdx new file mode 100644 index 0000000000..b8d8a7d55c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.constructor" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): SwmlTransferSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`SwmlTransferSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/define-tool.mdx new file mode 100644 index 0000000000..dce5971fe6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.defineTool" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-agent.mdx new file mode 100644 index 0000000000..830c994aed --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.getAgent" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-config.mdx new file mode 100644 index 0000000000..454528acee --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.getConfig" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..32a9d9e374 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.getDataMapTools" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-global-data.mdx new file mode 100644 index 0000000000..76fa324c66 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.getGlobalData" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-hints.mdx new file mode 100644 index 0000000000..fe52b8b0d5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.getHints" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/builtin/swml_transfer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts) + +Line 241. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-instance-key.mdx new file mode 100644 index 0000000000..da018a4f4e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.getInstanceKey" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/builtin/swml_transfer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts) + +Line 162. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..636d56b20a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.getParameterSchema" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/swml_transfer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts) + +Line 82. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..f9ebf4cf0e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.getPromptSections" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-skill-data.mdx new file mode 100644 index 0000000000..083de395c1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.getSkillData" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..5f90070c2b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.getSkillNamespace" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-tools.mdx new file mode 100644 index 0000000000..7bfb0f877c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.getTools" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — A `transfer_call` tool, plus `list_transfer_destinations` when patterns are configured. + +## Source + +[`src/skills/builtin/swml_transfer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts) + +Line 272. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..f884c6350a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.hasAllEnvVars" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/has-all-packages.mdx new file mode 100644 index 0000000000..0e60a9eafc --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.hasAllPackages" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/index.mdx new file mode 100644 index 0000000000..b31bd27d2c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/index.mdx @@ -0,0 +1,192 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill" +title: "SwmlTransferSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill" + parent: "skills.builtin.swml_transfer" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts" +--- +# `SwmlTransferSkill` + +Transfer calls between agents based on pattern matching. + +Multi-instance capable (distinguished by `tool_name`). +Accepts either Python-style `transfers` config (regex → per-entry config) +or TypeScript-style `patterns` array of named destinations. + +## Signature + +```typescript +class SwmlTransferSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('swml_transfer', { + patterns: [ + { name: 'sales', pattern: /sales|pricing|buy/i, to: '+15551112222' }, + { name: 'support', pattern: /help|support|broken/i, to: '+15553334444' }, + ], +}); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/swml_transfer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts) + +Line 73. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/is-initialized.mdx new file mode 100644 index 0000000000..f75d075102 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.isInitialized" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/mark-initialized.mdx new file mode 100644 index 0000000000..a5a30b9af9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.markInitialized" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/set-agent.mdx new file mode 100644 index 0000000000..c03e291e7a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.setAgent" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/setup.mdx new file mode 100644 index 0000000000..2aa55dd2b7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.setup" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/builtin/swml_transfer.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/swml_transfer.ts) + +Line 167. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/update-skill-data.mdx new file mode 100644 index 0000000000..f2611de581 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.updateSkillData" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..6c7f3432cb --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.validateEnvVars" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/validate-packages.mdx new file mode 100644 index 0000000000..e2ab851661 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/swml-transfer/swml-transfer-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.swml_transfer.SwmlTransferSkill.validatePackages" + parent: "skills.builtin.swml_transfer.SwmlTransferSkill" + module: "skills.builtin.swml_transfer" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/create-skill.mdx new file mode 100644 index 0000000000..5a3aa26097 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.weather_api.createSkill" + parent: "skills.builtin.weather_api" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts" +--- +# `createSkill` + +Factory function for creating WeatherApiSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): WeatherApiSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`WeatherApiSkill` — A new WeatherApiSkill instance. + +## Source + +[`src/skills/builtin/weather_api.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts) + +Line 271. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/index.mdx new file mode 100644 index 0000000000..2e69bc7147 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api" +title: "weather_api" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.weather_api" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts" +--- +# `weather_api` + +## Signature + +```typescript +module weather_api +``` + +## Functions + + + + Factory function for creating WeatherApiSkill instances. + + + +## Classes + + + + Fetches current weather data from OpenWeatherMap for any location worldwide. + + + +## Source + +[`src/skills/builtin/weather_api.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/cleanup.mdx new file mode 100644 index 0000000000..9ff3835219 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.cleanup" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/constructor.mdx new file mode 100644 index 0000000000..a5887ea9b7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.constructor" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): WeatherApiSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`WeatherApiSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/define-tool.mdx new file mode 100644 index 0000000000..dd9197b1b2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.defineTool" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-agent.mdx new file mode 100644 index 0000000000..4bdea0fd02 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.getAgent" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-config.mdx new file mode 100644 index 0000000000..6cc4c6fc45 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.getConfig" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..f4fe6b769b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.getDataMapTools" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-global-data.mdx new file mode 100644 index 0000000000..18bee0c6a0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.getGlobalData" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-hints.mdx new file mode 100644 index 0000000000..7d53c750ce --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.getHints" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-instance-key.mdx new file mode 100644 index 0000000000..b64b6dc60e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.getInstanceKey" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 427. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..13c13db1d6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.getParameterSchema" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/weather_api.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts) + +Line 93. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..a9f35fb9bd --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.getPromptSections" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-skill-data.mdx new file mode 100644 index 0000000000..5745499ee2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.getSkillData" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..9a24cd14b5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.getSkillNamespace" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-tools.mdx new file mode 100644 index 0000000000..3342648727 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.getTools" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — A single weather tool (configurable name) that fetches current weather for a location. + +## Source + +[`src/skills/builtin/weather_api.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts) + +Line 121. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..1e57059c21 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.hasAllEnvVars" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/has-all-packages.mdx new file mode 100644 index 0000000000..c570f6e82d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.hasAllPackages" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/index.mdx new file mode 100644 index 0000000000..2e9a19b9f9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/index.mdx @@ -0,0 +1,201 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill" +title: "WeatherApiSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill" + parent: "skills.builtin.weather_api" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts" +--- +# `WeatherApiSkill` + +Fetches current weather data from OpenWeatherMap for any location worldwide. + +Tier 2 built-in skill. Requires the `WEATHER_API_KEY` environment variable +containing a valid OpenWeatherMap API key (obtainable at openweathermap.org). +Supports metric, imperial, and standard temperature units via the `units` +config option. The `api_key` config value takes precedence over the +environment variable when both are set. + +**Provider note:** The Python reference SDK uses WeatherAPI.com +(`api.weatherapi.com/v1/current.json`). This TypeScript skill uses +OpenWeatherMap (`api.openweathermap.org/data/2.5/weather`). These providers +use different API key formats — a WeatherAPI.com key will NOT work here. +Obtain an OpenWeatherMap key at https://openweathermap.org/api. + +**Unit aliases:** For migration compatibility with the Python SDK the `units` +config also accepts `"fahrenheit"` (normalized to `"imperial"`) and +`"celsius"` (normalized to `"metric"`). + +## Signature + +```typescript +class WeatherApiSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('weather_api', { units: 'imperial' }); +// or pass the key explicitly: +agent.addSkill('weather_api', { api_key: process.env.WEATHER_API_KEY }); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Validates that an API key is available either via inline config or the `WEATHER_API_KEY` environment variable. Fails fast (returns `false`) when neither source provides a key — matching Python SDK behaviour where `_validate_config()` raises on construction when `api_key` is absent. + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/weather_api.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts) + +Line 68. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/is-initialized.mdx new file mode 100644 index 0000000000..2054f6bae9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.isInitialized" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/mark-initialized.mdx new file mode 100644 index 0000000000..382dec382a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.markInitialized" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/set-agent.mdx new file mode 100644 index 0000000000..3e3449a243 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.setAgent" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/setup.mdx new file mode 100644 index 0000000000..3a30d0d18b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/setup.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.setup" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts" +--- +# `setup` + +Validates that an API key is available either via inline config or the +`WEATHER_API_KEY` environment variable. Fails fast (returns `false`) when +neither source provides a key — matching Python SDK behaviour where +`_validate_config()` raises on construction when `api_key` is absent. + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if a key is present, `false` otherwise. + +## Source + +[`src/skills/builtin/weather_api.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/weather_api.ts) + +Line 84. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/update-skill-data.mdx new file mode 100644 index 0000000000..e7d93fe046 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.updateSkillData" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..554704fb5c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.validateEnvVars" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/weather-api/weather-api-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/validate-packages.mdx new file mode 100644 index 0000000000..a130eb903e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/weather-api/weather-api-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/weather-api/weather-api-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.weather_api.WeatherApiSkill.validatePackages" + parent: "skills.builtin.weather_api.WeatherApiSkill" + module: "skills.builtin.weather_api" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/create-skill.mdx new file mode 100644 index 0000000000..8c60751da0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.web_search.createSkill" + parent: "skills.builtin.web_search" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts" +--- +# `createSkill` + +Factory function for creating WebSearchSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): WebSearchSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`WebSearchSkill` — A new WebSearchSkill instance. + +## Source + +[`src/skills/builtin/web_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts) + +Line 1134. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/index.mdx new file mode 100644 index 0000000000..edb5777de3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search" +title: "web_search" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.web_search" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts" +--- +# `web_search` + +## Signature + +```typescript +module web_search +``` + +## Functions + + + + Factory function for creating WebSearchSkill instances. + + + +## Classes + + + + Searches the web using the Google Custom Search JSON API. + + + +## Source + +[`src/skills/builtin/web_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/cleanup.mdx new file mode 100644 index 0000000000..9b3b900e11 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.cleanup" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/constructor.mdx new file mode 100644 index 0000000000..3fdc614c02 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.constructor" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): WebSearchSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`WebSearchSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/define-tool.mdx new file mode 100644 index 0000000000..65399ff704 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.defineTool" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-agent.mdx new file mode 100644 index 0000000000..0bbbc6630c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.getAgent" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-config.mdx new file mode 100644 index 0000000000..28fbddd1cd --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.getConfig" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..f45b68680f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.getDataMapTools" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..1ded3cc9a4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.getGlobalData" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts" +--- +# `getGlobalData` + +Global data injected into the agent's SWML context (mirrors Python). + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` + +## Source + +[`src/skills/builtin/web_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts) + +Line 353. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-hints.mdx new file mode 100644 index 0000000000..fafe34ba3c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.getHints" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-instance-key.mdx new file mode 100644 index 0000000000..32042a931a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-instance-key.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.getInstanceKey" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts" +--- +# `getInstanceKey` + +Instance key for the SkillManager. Includes the configured +`search_engine_id` (or `"default"`) and `tool_name` (or `"web_search"`) +to match Python's `"{SKILL_NAME}_{search_engine_id}_{tool_name}"` scheme. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` + +## Source + +[`src/skills/builtin/web_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts) + +Line 346. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..bce3b876ed --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.getParameterSchema" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/web_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts) + +Line 215. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..0bacd89d64 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.getPromptSections" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-skill-data.mdx new file mode 100644 index 0000000000..0218315a1a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.getSkillData" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..cd6d1e5109 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.getSkillNamespace" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-tools.mdx new file mode 100644 index 0000000000..a3e689c816 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.getTools" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — A single tool (named via `tool_name`) that performs a Google Custom Search and returns formatted results. + +## Source + +[`src/skills/builtin/web_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts) + +Line 370. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..d82127c292 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.hasAllEnvVars" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/has-all-packages.mdx new file mode 100644 index 0000000000..cc74dff30e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.hasAllPackages" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/index.mdx new file mode 100644 index 0000000000..52e01094dc --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/index.mdx @@ -0,0 +1,204 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill" +title: "WebSearchSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill" + parent: "skills.builtin.web_search" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts" +--- +# `WebSearchSkill` + +Searches the web using the Google Custom Search JSON API. + +Tier 3 built-in skill. Credentials can be supplied via the `api_key` and +`search_engine_id` params or `GOOGLE_SEARCH_API_KEY` / +`GOOGLE_SEARCH_ENGINE_ID` (legacy: `GOOGLE_SEARCH_CX`) environment variables. + +The handler mirrors Python's `search_and_scrape_best` pipeline: fetches +`oversample_factor × num_results` candidates from Google, scrapes each +result page (SSRF-guarded, cheerio-based text extraction), scores for +quality (length + query relevance + boilerplate penalty), deduplicates by +domain, and returns the top `num_results` above `min_quality_score` with +full page content. If every scrape fails or falls below the threshold the +handler falls back to raw API snippets so the agent still has something +to say. + +Supported config: `tool_name`, `num_results`, `no_results_message`, +`safe_search`, `delay`, `max_content_length`, `oversample_factor`, +`min_quality_score`. + +## Signature + +```typescript +class WebSearchSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('web_search', { + api_key: process.env.GOOGLE_SEARCH_API_KEY, + search_engine_id: process.env.GOOGLE_CSE_ID, + num_results: 3, +}); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Global data injected into the agent's SWML context (mirrors Python). + + + + Get speech recognition hints relevant to this skill. + + + + Instance key for the SkillManager. Includes the configured `search_engine_id` (or `"default"`) and `tool_name` (or `"web_search"`) to match Python's `"{SKILL_NAME}_{search_engine_id}_{tool_name}"` scheme. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Validate required credentials before the skill becomes active. + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/web_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts) + +Line 204. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/is-initialized.mdx new file mode 100644 index 0000000000..ee32c9c8bf --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.isInitialized" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/mark-initialized.mdx new file mode 100644 index 0000000000..f5f8a837c3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.markInitialized" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/set-agent.mdx new file mode 100644 index 0000000000..297b268b5d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.setAgent" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/setup.mdx new file mode 100644 index 0000000000..f6ee29eeed --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/setup.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.setup" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts" +--- +# `setup` + +Validate required credentials before the skill becomes active. + +Mirrors Python's `setup()` (skill.py:559-600) which checks `api_key` and +`search_engine_id` and returns `False` (logging an error) if either is +absent. In the TS SDK credentials may also arrive via environment variables +(`GOOGLE_SEARCH_API_KEY` / `GOOGLE_SEARCH_ENGINE_ID` or the legacy alias +`GOOGLE_SEARCH_CX`), so both config params and env vars are checked. + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if all required credentials are present, `false` otherwise. + +## Source + +[`src/skills/builtin/web_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/web_search.ts) + +Line 321. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/update-skill-data.mdx new file mode 100644 index 0000000000..46ef47595d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.updateSkillData" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..acc4a12d1e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.validateEnvVars" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/web-search/web-search-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/validate-packages.mdx new file mode 100644 index 0000000000..f543c6f33e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/web-search/web-search-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/web-search/web-search-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.web_search.WebSearchSkill.validatePackages" + parent: "skills.builtin.web_search.WebSearchSkill" + module: "skills.builtin.web_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/create-skill.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/create-skill.mdx new file mode 100644 index 0000000000..95223a9638 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/create-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/create-skill" +title: "createSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.createSkill" + parent: "skills.builtin.wikipedia_search" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts" +--- +# `createSkill` + +Factory function for creating WikipediaSearchSkill instances. + +## Signature + +```typescript +createSkill(config?: SkillConfig): WikipediaSearchSkill +``` + +## Parameters + + + Optional skill configuration. + + +## Returns + +`WikipediaSearchSkill` — A new WikipediaSearchSkill instance. + +## Source + +[`src/skills/builtin/wikipedia_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts) + +Line 318. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/index.mdx new file mode 100644 index 0000000000..c76daf8381 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search" +title: "wikipedia_search" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search" + module: "skills.builtin" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts" +--- +# `wikipedia_search` + +## Signature + +```typescript +module wikipedia_search +``` + +## Functions + + + + Factory function for creating WikipediaSearchSkill instances. + + + +## Classes + + + + Searches Wikipedia for article summaries and extracts. + + + +## Source + +[`src/skills/builtin/wikipedia_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/cleanup.mdx new file mode 100644 index 0000000000..8a39b8ccb4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.cleanup" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/constructor.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/constructor.mdx new file mode 100644 index 0000000000..3f41117eca --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.constructor" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): WikipediaSearchSkill +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`WikipediaSearchSkill` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/define-tool.mdx new file mode 100644 index 0000000000..627ba126af --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.defineTool" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-agent.mdx new file mode 100644 index 0000000000..2964beaa4d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.getAgent" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-config.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-config.mdx new file mode 100644 index 0000000000..3057e7b04a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.getConfig" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-data-map-tools.mdx new file mode 100644 index 0000000000..8403fbe55b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.getDataMapTools" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-global-data.mdx new file mode 100644 index 0000000000..dd6dfb0dbe --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.getGlobalData" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-hints.mdx new file mode 100644 index 0000000000..9d85ee77ef --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.getHints" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-instance-key.mdx new file mode 100644 index 0000000000..61ce4b5b5d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.getInstanceKey" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 427. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-parameter-schema.mdx new file mode 100644 index 0000000000..5b50936ea0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.getParameterSchema" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/builtin/wikipedia_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts) + +Line 79. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-prompt-sections.mdx new file mode 100644 index 0000000000..e620f73fe2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.getPromptSections" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-skill-data.mdx new file mode 100644 index 0000000000..d8e52450cb --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.getSkillData" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-skill-namespace.mdx new file mode 100644 index 0000000000..5b6842c39f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.getSkillNamespace" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-tools.mdx new file mode 100644 index 0000000000..750b3ca751 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-tools.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.getTools" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts" +--- +# `getTools` + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — A `search_wiki` tool that fetches article summaries from Wikipedia. + +## Source + +[`src/skills/builtin/wikipedia_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts) + +Line 122. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/has-all-env-vars.mdx new file mode 100644 index 0000000000..e2c434c193 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.hasAllEnvVars" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/has-all-packages.mdx new file mode 100644 index 0000000000..58f2123832 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.hasAllPackages" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/index.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/index.mdx new file mode 100644 index 0000000000..8796bc421d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/index.mdx @@ -0,0 +1,199 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill" +title: "WikipediaSearchSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + parent: "skills.builtin.wikipedia_search" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts" +--- +# `WikipediaSearchSkill` + +Searches Wikipedia for article summaries and extracts. + +Tier 3 built-in skill with no external API key required. The configured +`num_results` drives how many articles are aggregated; `no_results_message` +customizes the fallback text (supports `{query}` interpolation). + +## Signature + +```typescript +class WikipediaSearchSkill extends SkillBase +``` + +## Inheritance + +**Extends:** [SkillBase](/reference/typescript/skills/skill-base) + +## Examples + +```typescript +agent.addSkill('wikipedia_search', { num_results: 2 }); +``` + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Resolved `no_results_message` template (populated in `setup()`). Protected to mirror Python's `self.no_results_message` public visibility within the class hierarchy. + + + + Resolved `num_results` value (populated in `setup()`). Public to mirror Python's `self.num_results` — accessible to subclasses and external test code inspecting skill state. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Search Wikipedia and return a formatted text summary. + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Extract config values into instance state. Enforces `num_results >= 1` (matching Python `skill.py:_setup` `max(1, ...)` floor). The schema's `max: 5` handles the upper bound at validation time — no runtime clamp here, so callers passing larger values get the raw value as in Python. + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/builtin/wikipedia_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/is-initialized.mdx new file mode 100644 index 0000000000..dd75647988 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.isInitialized" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/mark-initialized.mdx new file mode 100644 index 0000000000..eb2a440baa --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.markInitialized" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/search-wiki.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/search-wiki.mdx new file mode 100644 index 0000000000..0279145d6d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/search-wiki.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/search-wiki" +title: "searchWiki" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.searchWiki" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts" +--- +# `searchWiki` + +Search Wikipedia and return a formatted text summary. + +Mirrors the Python `search_wiki()` public entry point so the logic can be +tested and reused outside the SWAIG handler. Uses `num_results` to decide +how many articles to aggregate. + +## Signature + +```typescript +searchWiki(query: string): Promise +``` + +## Parameters + + + Plain-text search term. + + +## Returns + +`Promise` — Formatted text ready for display to the caller. + +## Source + +[`src/skills/builtin/wikipedia_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts) + +Line 166. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/set-agent.mdx new file mode 100644 index 0000000000..b559a1aa68 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.setAgent" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/setup.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/setup.mdx new file mode 100644 index 0000000000..380c23d440 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/setup.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.setup" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts" +--- +# `setup` + +Extract config values into instance state. Enforces `num_results >= 1` +(matching Python `skill.py:_setup` `max(1, ...)` floor). The schema's +`max: 5` handles the upper bound at validation time — no runtime clamp +here, so callers passing larger values get the raw value as in Python. + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/builtin/wikipedia_search.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/builtin/wikipedia_search.ts) + +Line 103. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/update-skill-data.mdx new file mode 100644 index 0000000000..7fe60f224d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.updateSkillData" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/validate-env-vars.mdx new file mode 100644 index 0000000000..35902f3557 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.validateEnvVars" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/validate-packages.mdx new file mode 100644 index 0000000000..2f9cf93464 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/builtin/wikipedia-search/wikipedia-search-skill/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.builtin.wikipedia_search.WikipediaSearchSkill.validatePackages" + parent: "skills.builtin.wikipedia_search.WikipediaSearchSkill" + module: "skills.builtin.wikipedia_search" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/index.mdx b/fern/products/sdk-reference/typescript/skills/index.mdx new file mode 100644 index 0000000000..554e849068 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/index.mdx @@ -0,0 +1,25 @@ +--- +slug: "/reference/typescript/skills" +title: "skills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/index.ts" +--- +# `skills` + +## Signature + +```typescript +module skills +``` + +## Source + +[`src/skills/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/index.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/index.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/index.mdx new file mode 100644 index 0000000000..2414dd99dd --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/index.mdx @@ -0,0 +1,54 @@ +--- +slug: "/reference/typescript/skills/skill-base" +title: "SkillBase" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.SkillBase" + module: "skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `SkillBase` + +## Signature + +```typescript +module SkillBase +``` + +## Classes + + + + Abstract base class for agent skills. + + + +## Interfaces + + + + Schema entry describing a single skill configuration parameter. + + + + Configuration key-value pairs passed to a skill at construction time. + + + + A section of prompt content injected into the agent's system prompt by a skill. + + + + Definition of a SWAIG tool provided by a skill. + + + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/parameter-schema-entry/index.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/parameter-schema-entry/index.mdx new file mode 100644 index 0000000000..166dabc947 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/parameter-schema-entry/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/skills/skill-base/parameter-schema-entry" +title: "ParameterSchemaEntry" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "skills.SkillBase.ParameterSchemaEntry" + parent: "skills.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `ParameterSchemaEntry` + +Schema entry describing a single skill configuration parameter. + +## Signature + +```typescript +interface ParameterSchemaEntry +``` + +## Properties + + + Default value used when the parameter is not provided. + + + + Human-readable description of the parameter. + + + + Allowed values for the parameter. + + + + Environment variable that can supply this parameter's value. + + + + Whether the parameter should be hidden from user-facing output (e.g., API keys). + + + + Item schema for array-type parameters. + + + + Maximum value (for numeric types). + + + + Minimum value (for numeric types). + + + + Whether the parameter must be supplied. + + + + JSON Schema type of the parameter value. + + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 61. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/cleanup.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/cleanup.mdx new file mode 100644 index 0000000000..30a2a8502a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/cleanup.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/cleanup" +title: "cleanup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.cleanup" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `cleanup` + +Cleanup resources. Called when the skill is removed from an agent. + +## Signature + +```typescript +cleanup(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 469. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/constructor.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/constructor.mdx new file mode 100644 index 0000000000..cee15f983d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/constructor.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.constructor" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `constructor` + +Create a new skill instance. + +Python parity: `core/skill_base.py:32-43`. +Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION` +is left as `None` on the subclass. TS throws the equivalent when the static +defaults haven't been overridden. + +## Signature + +```typescript +constructor(config?: SkillConfig): SkillBase +``` + +## Parameters + + + Optional configuration key-value pairs (Python: `params`). + + +## Returns + +`SkillBase` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/define-tool.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/define-tool.mdx new file mode 100644 index 0000000000..a2c42f5341 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/define-tool.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.defineTool" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `defineTool` + +Imperatively register a tool with this skill. + +Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`. +Merges `this.swaigFields` into the tool definition (explicit fields on +`toolDef` take precedence), then pushes the result into `_dynamicTools` +so the default `getTools()` returns it at SWML render time. + +Intended for skills whose tool shape depends on config evaluated at +`setup()` time. Skills with a static tool list should override +`getTools()` instead. + +## Signature + +```typescript +defineTool(toolDef: SkillToolDefinition): void +``` + +## Parameters + + + The tool definition to register. Must include at minimum `name`, `description`, `parameters`, and `handler`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 351. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-agent.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-agent.mdx new file mode 100644 index 0000000000..cdc1cb2265 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-agent.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/get-agent" +title: "getAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.getAgent" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" + visibility: "protected" +--- +# `getAgent` + +Return the agent that owns this skill, asserting it is non-null. +Equivalent to accessing `self.agent` in Python, where the agent reference +is always set before `setup()` is called. + +The SkillManager lifecycle guarantees that `setAgent()` is called before +`setup()`, so this method is safe to use inside `setup()` and in any +tool handler invoked during an active agent session. + +## Signature + +```typescript +getAgent(): AgentBase +``` + +## Returns + +`AgentBase` — The owning `AgentBase` instance. + +## Throws + +- If called before `setAgent()` (i.e., before the skill is attached to an agent by the SkillManager). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 261. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-config.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-config.mdx new file mode 100644 index 0000000000..0b9a733390 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/get-config" +title: "getConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.getConfig" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getConfig` + +Get a configuration value by key, falling back to a default if not set. + +## Signature + +```typescript +getConfig(key: string, defaultValue?: T): T +``` + +## Type Parameters + + + +## Parameters + + + The configuration key to look up. + + + + Value to return if the key is not present. + + +## Returns + +`T` — The configuration value cast to type T, or the default value. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 524. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-data-map-tools.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-data-map-tools.mdx new file mode 100644 index 0000000000..f05379cc35 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-data-map-tools.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/get-data-map-tools" +title: "getDataMapTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.getDataMapTools" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getDataMapTools` + +Optional DataMap-style tool definitions. Skills that build their own +SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them +here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + +Python equivalent: the direct `self.agent.register_swaig_function(fn)` +call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`). +Default returns `[]` — skills using only the declarative `getTools()` path +do not need to override this. + +## Signature + +```typescript +getDataMapTools(): Record[] +``` + +## Returns + +`Record[]` — Array of fully-built SWAIG function dicts. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-global-data.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-global-data.mdx new file mode 100644 index 0000000000..4fb6defda7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/get-global-data" +title: "getGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.getGlobalData" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getGlobalData` + +Get global data to merge into the agent's global data store. + +## Signature + +```typescript +getGlobalData(): Record +``` + +## Returns + +`Record` — Key-value pairs to be merged into the agent's global data. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 410. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-hints.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-hints.mdx new file mode 100644 index 0000000000..55bf6d3d74 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/get-hints" +title: "getHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.getHints" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getHints` + +Get speech recognition hints relevant to this skill. + +## Signature + +```typescript +getHints(): string[] +``` + +## Returns + +`string[]` — Array of hint strings to improve speech recognition accuracy. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 402. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-instance-key.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-instance-key.mdx new file mode 100644 index 0000000000..f2ed73a2e6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-instance-key.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/get-instance-key" +title: "getInstanceKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.getInstanceKey" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getInstanceKey` + +Get the instance key used for deduplication in the SkillManager. + +For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns +the skill name. For multi-instance skills, returns `${skillName}_${toolName}` +using the `tool_name` config (falls back to the skill name). + +Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`). +Multi-instance subclasses only need to override when their key derivation +depends on config beyond `tool_name`. + +## Signature + +```typescript +getInstanceKey(): string +``` + +## Returns + +`string` — A unique key identifying this skill instance. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 427. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-parameter-schema.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-parameter-schema.mdx new file mode 100644 index 0000000000..a923ef6744 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-parameter-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/get-parameter-schema" +title: "getParameterSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.getParameterSchema" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getParameterSchema` + +Get the parameter schema for this skill class, describing all accepted configuration options. +Subclasses should override and call `super.getParameterSchema()` to include base parameters. + +Mirrors Python's `SkillBase.get_parameter_schema()` (skill\_base.py:197-266): +returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a +`tool_name` entry with `default: cls.SKILL_NAME` for classes with +`SUPPORTS_MULTIPLE_INSTANCES = true`. + +**Modifiers:** `static` + +## Signature + +```typescript +getParameterSchema(): Record +``` + +## Returns + +`Record` — Record mapping parameter names to their schema entries. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 183. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-prompt-sections.mdx new file mode 100644 index 0000000000..df6b8e68d4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-prompt-sections.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/get-prompt-sections" +title: "getPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.getPromptSections" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getPromptSections` + +Get prompt sections to inject into the agent's system prompt. +Respects the `skip_prompt` config option — returns `[]` if set to `true`. +Subclasses should override `_getPromptSections()` instead of this method. + +## Signature + +```typescript +getPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Array of prompt sections with titles, bodies, and bullets. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 382. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-skill-data.mdx new file mode 100644 index 0000000000..e2bab50397 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-skill-data.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/get-skill-data" +title: "getSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.getSkillData" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillData` + +Read this skill's data from a raw call data object's global\_data. + +## Signature + +```typescript +getSkillData(rawData: Record): Record +``` + +## Parameters + + + The raw request data containing global\_data. + + +## Returns + +`Record` — The skill's stored data, or an empty object if not found. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 450. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-skill-namespace.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-skill-namespace.mdx new file mode 100644 index 0000000000..dc488ef79d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-skill-namespace.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/get-skill-namespace" +title: "getSkillNamespace" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.getSkillNamespace" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getSkillNamespace` + +Get the namespaced key for storing per-skill data in global\_data. + +## Signature + +```typescript +getSkillNamespace(): string +``` + +## Returns + +`string` — A string like "skill:datetime" or "skill:my\_prefix". + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 440. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-tools.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-tools.mdx new file mode 100644 index 0000000000..26085176e1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/get-tools.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/get-tools" +title: "getTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.getTools" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `getTools` + +Return the SWAIG tool definitions this skill provides. + +Default implementation returns tools registered imperatively via +`defineTool()`. Skills using the declarative pattern override this +method to return a static array built from their config. + +Python parity: replaces the `@abstractmethod register_tools()` contract +— Python skills call `self.define_tool(...)` inside `register_tools()`; +TypeScript skills either call `this.defineTool(...)` in `setup()` (and +let the default `getTools()` return them) or override `getTools()` +directly. + +## Signature + +```typescript +getTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — Array of tool definitions to register with the agent. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 332. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/has-all-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/has-all-env-vars.mdx new file mode 100644 index 0000000000..ccf28b50f1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/has-all-env-vars.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/has-all-env-vars" +title: "hasAllEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.hasAllEnvVars" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllEnvVars` + +Check if all required environment variables are present. +Convenience wrapper around `validateEnvVars()` that returns a boolean, +matching the Python `validate_env_vars() -> bool` return type. + +## Signature + +```typescript +hasAllEnvVars(): boolean +``` + +## Returns + +`boolean` — `true` if all required env vars are set, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 544. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/has-all-packages.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/has-all-packages.mdx new file mode 100644 index 0000000000..25aaba014e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/has-all-packages.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/has-all-packages" +title: "hasAllPackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.hasAllPackages" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `hasAllPackages` + +Check if all required packages declared in the manifest are available. +Convenience wrapper around `validatePackages()` that returns a boolean, +matching the Python `validate_packages() -> bool` return type. + +## Signature + +```typescript +hasAllPackages(): Promise +``` + +## Returns + +`Promise` — `true` if all required packages are importable, `false` otherwise. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 579. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/index.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/index.mdx new file mode 100644 index 0000000000..cb32f04ed7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/index.mdx @@ -0,0 +1,218 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base" +title: "SkillBase" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase" + parent: "skills.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `SkillBase` + +Abstract base class for agent skills. + +Skills are modular, reusable capabilities that plug into an [AgentBase](/reference/typescript/agent-base). +A single skill can contribute: + +- **Tools** (SWAIG functions) via `getTools()` or `defineTool()` +- **Prompt sections** via `_getPromptSections()` +- **Speech hints** via `getHints()` +- **Global data** seeded into each call via `getGlobalData()` + +Skills are added to an agent with `agent.addSkill('name', config)` and the +[SkillManager](/reference/typescript/skills/skill-manager) calls `setAgent()` + `setup()` in sequence before the +agent starts serving requests. + +**Modifiers:** `abstract` + +## Signature + +```typescript +class SkillBase +``` + +## Examples + +```typescript +import { SkillBase, FunctionResult, type SkillToolDefinition } from '@signalwire/sdk'; + +export class GreetingSkill extends SkillBase { + static override SKILL_NAME = 'greeting'; + static override SKILL_DESCRIPTION = 'Responds with a configurable greeting.'; + + override getTools(): SkillToolDefinition[] { + return [{ + name: 'say_hello', + description: 'Say a friendly hello.', + parameters: { type: 'object', properties: {} }, + handler: () => new FunctionResult(this.getConfig('message', 'Hi!')), + }]; + } +} + +// In your agent: +agent.addSkill(new GreetingSkill({ message: 'Howdy!' })); +``` + +## See Also + +- \- \[SkillManager]\(/reference/typescript/skills/skill-manager) + \- \[SkillRegistry]\(/reference/typescript/skills/skill-registry) + \- \[AgentBase.addSkill]\(/reference/typescript/agent-base/agent-base/add-skill) + +## Properties + + + Reference to the agent that owns this skill. Set via `setAgent()` when the skill is added to an agent. Python equivalent: `self.agent` (set in `__init__`). In the Python SDK `agent` is always non-null because it is injected in the constructor. In the TypeScript SDK the SkillManager always calls `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being safe to call inside `setup()` and any method invoked after it. + + + + Configuration options provided at construction time. + + + + Unique identifier for this skill instance (includes timestamp and random bytes). + + + + Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)` set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`. + + + + Environment variables required for the skill to function, checked at load time by `validateEnvVars()`. Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`. + + + + Packages required by the skill, checked at load time by `validatePackages()`. Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`. In TS these are npm package names importable via dynamic `import()`. + + + + Human-readable description of the skill. Subclasses MUST override. Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`. + + + + Unique skill name. Subclasses MUST override with a non-empty string. Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`. Python raises `ValueError` in `__init__` when this is left as `None`; TS throws at construction when this is left as the empty default. + + + + Semantic version string. Subclasses may override; defaults to `"1.0.0"`. Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`. + + + + The registered name of this skill type. + + + + Whether this skill type supports multiple simultaneous instances (e.g., with different tool\_name). Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`. + + + + Additional SWAIG fields extracted from config, merged into tool definitions. + + +## Methods + + + + Cleanup resources. Called when the skill is removed from an agent. + + + + Create a new skill instance. + + + + Imperatively register a tool with this skill. + + + + Return the agent that owns this skill, asserting it is non-null. Equivalent to accessing `self.agent` in Python, where the agent reference is always set before `setup()` is called. + + + + Get a configuration value by key, falling back to a default if not set. + + + + Optional DataMap-style tool definitions. Skills that build their own SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`. + + + + Get global data to merge into the agent's global data store. + + + + Get speech recognition hints relevant to this skill. + + + + Get the instance key used for deduplication in the SkillManager. + + + + Get the parameter schema for this skill class, describing all accepted configuration options. Subclasses should override and call `super.getParameterSchema()` to include base parameters. + + + + Get prompt sections to inject into the agent's system prompt. Respects the `skip_prompt` config option — returns `[]` if set to `true`. Subclasses should override `_getPromptSections()` instead of this method. + + + + Read this skill's data from a raw call data object's global\_data. + + + + Get the namespaced key for storing per-skill data in global\_data. + + + + Return the SWAIG tool definitions this skill provides. + + + + Check if all required environment variables are present. Convenience wrapper around `validateEnvVars()` that returns a boolean, matching the Python `validate_env_vars() -> bool` return type. + + + + Check if all required packages declared in the manifest are available. Convenience wrapper around `validatePackages()` that returns a boolean, matching the Python `validate_packages() -> bool` return type. + + + + Check if the skill has been initialized by the SkillManager. + + + + Mark the skill as initialized (called by SkillManager). + + + + Set the agent reference for this skill. Called by the SkillManager/AgentBase when the skill is attached to an agent. Python equivalent: `self.agent = agent` in `__init__`. + + + + Setup the skill. Called when the skill is added to an agent. Override to perform initialization (API connections, config validation, etc.) + + + + Update this skill's namespaced data on a FunctionResult via updateGlobalData. + + + + Validate that all required environment variables declared on the skill class are set in the current process environment. + + + + Validate that all required packages declared on the skill class can be imported. + + + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 125. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/is-initialized.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/is-initialized.mdx new file mode 100644 index 0000000000..fd6b8bb159 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/is-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/is-initialized" +title: "isInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.isInitialized" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `isInitialized` + +Check if the skill has been initialized by the SkillManager. + +## Signature + +```typescript +isInitialized(): boolean +``` + +## Returns + +`boolean` — True if setup() has completed and the skill is marked initialized. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 507. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/mark-initialized.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/mark-initialized.mdx new file mode 100644 index 0000000000..743067bf3c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/mark-initialized.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/mark-initialized" +title: "markInitialized" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.markInitialized" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `markInitialized` + +Mark the skill as initialized (called by SkillManager). + +## Signature + +```typescript +markInitialized(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 514. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/set-agent.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/set-agent.mdx new file mode 100644 index 0000000000..dd91f366d2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/set-agent.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/set-agent" +title: "setAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.setAgent" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setAgent` + +Set the agent reference for this skill. +Called by the SkillManager/AgentBase when the skill is attached to an agent. +Python equivalent: `self.agent = agent` in `__init__`. + +## Signature + +```typescript +setAgent(agent: AgentBase): void +``` + +## Parameters + + + The agent that owns this skill. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 534. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/setup.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/setup.mdx new file mode 100644 index 0000000000..bb6aee05a6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/setup.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/setup" +title: "setup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.setup" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `setup` + +Setup the skill. Called when the skill is added to an agent. +Override to perform initialization (API connections, config validation, etc.) + +## Signature + +```typescript +setup(): Promise +``` + +## Returns + +`Promise` — `true` if setup succeeded, `false` otherwise. Python equivalent: abstract `setup() -> bool`. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 313. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/update-skill-data.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/update-skill-data.mdx new file mode 100644 index 0000000000..ef7980341b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/update-skill-data.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/update-skill-data" +title: "updateSkillData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.updateSkillData" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `updateSkillData` + +Update this skill's namespaced data on a FunctionResult via updateGlobalData. + +## Signature + +```typescript +updateSkillData( + result: FunctionResult, + data: Record +): FunctionResult +``` + +## Parameters + + + The FunctionResult to update. + + + + The data to store under this skill's namespace. + + +## Returns + +`FunctionResult` — The FunctionResult for chaining. + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 462. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/validate-env-vars.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/validate-env-vars.mdx new file mode 100644 index 0000000000..f4e194bccd --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/validate-env-vars.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/validate-env-vars" +title: "validateEnvVars" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.validateEnvVars" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validateEnvVars` + +Validate that all required environment variables declared on the skill class +are set in the current process environment. + +Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS` +directly. TS reads the same static from the class. + +Returns the list of missing variable names so callers can produce actionable +error messages. This differs from Python's `validate_env_vars() -> bool` +return shape; [hasAllEnvVars](/reference/typescript/skills/skill-base/skill-base/has-all-env-vars) is the boolean equivalent. + +## Signature + +```typescript +validateEnvVars(): string[] +``` + +## Returns + +`string[]` — Array of missing environment variable names (empty if all are present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 486. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/validate-packages.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/validate-packages.mdx new file mode 100644 index 0000000000..2fb1a8bd7c --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-base/validate-packages.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-base/validate-packages" +title: "validatePackages" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillBase.SkillBase.validatePackages" + parent: "skills.SkillBase.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `validatePackages` + +Validate that all required packages declared on the skill class can be imported. + +Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES` +directly and tries `importlib.import_module(pkg)` for each; TS does the +equivalent with a dynamic `import()`. + +## Signature + +```typescript +validatePackages(): Promise +``` + +## Returns + +`Promise` — Array of package names that could not be imported (empty if all present). + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-config/index.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-config/index.mdx new file mode 100644 index 0000000000..96145038cb --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-config/index.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-config" +title: "SkillConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "skills.SkillBase.SkillConfig" + parent: "skills.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `SkillConfig` + +Configuration key-value pairs passed to a skill at construction time. + +## Signature + +```typescript +interface SkillConfig +``` + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 15. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-prompt-section/index.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-prompt-section/index.mdx new file mode 100644 index 0000000000..a7f4fe4492 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-prompt-section/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-prompt-section" +title: "SkillPromptSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "skills.SkillBase.SkillPromptSection" + parent: "skills.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `SkillPromptSection` + +A section of prompt content injected into the agent's system prompt by a skill. + +## Signature + +```typescript +interface SkillPromptSection +``` + +## Properties + + + Optional body text for the section. + + + + Optional bullet points appended after the body. + + + + If true, render bullets as a numbered list instead of unordered. + + + + Section heading displayed in the prompt. + + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 49. diff --git a/fern/products/sdk-reference/typescript/skills/skill-base/skill-tool-definition/index.mdx b/fern/products/sdk-reference/typescript/skills/skill-base/skill-tool-definition/index.mdx new file mode 100644 index 0000000000..59624408d3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-base/skill-tool-definition/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/skills/skill-base/skill-tool-definition" +title: "SkillToolDefinition" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "skills.SkillBase.SkillToolDefinition" + parent: "skills.SkillBase" + module: "skills.SkillBase" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts" +--- +# `SkillToolDefinition` + +Definition of a SWAIG tool provided by a skill. + +## Signature + +```typescript +interface SkillToolDefinition +``` + +## Properties + + + Human-readable description of what the tool does, shown to the AI. + + + + Filler phrases spoken while the tool executes, keyed by language. + + + + Handler function invoked when the tool is called. + + + + When true, the SignalWire platform automatically invokes this tool when the call ends (hangup), regardless of whether the AI explicitly calls it. Equivalent to Python's `is_hangup_hook=True` in `define_tool()`. The flag is serialised as `"is_hangup_hook": true` in the SWAIG JSON. + + + + Unique tool name used in SWAIG function registration. + + + + Parameter schema for the tool, keyed by parameter name. + + + + List of parameter names that are required. + + + + Whether the tool requires secure (authenticated) invocation. + + + + If true, suppress filler phrases while the tool executes. + + + + If true, wait for any in-flight fillers to complete before executing the tool. + + +## Source + +[`src/skills/SkillBase.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillBase.ts) + +Line 20. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/index.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/index.mdx new file mode 100644 index 0000000000..b04771766b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/index.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/skills/skill-manager" +title: "SkillManager" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.SkillManager" + module: "skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `SkillManager` + +## Signature + +```typescript +module SkillManager +``` + +## Classes + + + + Manages the lifecycle of skills attached to an agent. + + + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/add-skill.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/add-skill.mdx new file mode 100644 index 0000000000..9bc5737a56 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/add-skill.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/add-skill" +title: "addSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.addSkill" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `addSkill` + +Add a skill to the manager, validating env vars and calling setup(). +Uses the skill's instance key for deduplication. + +[loadSkill](/reference/typescript/skills/skill-manager/skill-manager/load-skill) / [loadSkillByName](/reference/typescript/skills/skill-manager/skill-manager/load-skill-by-name) wrap this and catch to return +`[false, msg]`, matching Python `load_skill`'s return contract +(`skill_manager.py` lines 114-118). + +## Signature + +```typescript +addSkill(skill: SkillBase): Promise +``` + +## Parameters + + + The skill instance to add. + + +## Returns + +`Promise` — Resolves once the skill is registered. + +## Throws + +- When a single-instance skill is already loaded, its required environment variables are missing, its parameter schema is empty, its required packages cannot be imported, or `setup()` returns `false`. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 74. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/clear.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/clear.mdx new file mode 100644 index 0000000000..319b001393 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/clear.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/clear" +title: "clear" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.clear" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `clear` + +Remove all skills and clean up. + +## Signature + +```typescript +clear(): Promise +``` + +## Returns + +`Promise` + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 412. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/constructor.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/constructor.mdx new file mode 100644 index 0000000000..63365a5e48 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/constructor.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.constructor" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" +--- +# `constructor` + +## Signature + +```typescript +constructor(): SkillManager +``` + +## Returns + +`SkillManager` diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-all-hints.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-all-hints.mdx new file mode 100644 index 0000000000..e4e0ed8e51 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-all-hints.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/get-all-hints" +title: "getAllHints" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.getAllHints" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `getAllHints` + +Aggregate speech recognition hints from all loaded skills. + +## Signature + +```typescript +getAllHints(): string[] +``` + +## Returns + +`string[]` — Combined array of all skill hint strings. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 369. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-all-prompt-sections.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-all-prompt-sections.mdx new file mode 100644 index 0000000000..48bd5666e1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-all-prompt-sections.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/get-all-prompt-sections" +title: "getAllPromptSections" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.getAllPromptSections" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `getAllPromptSections` + +Aggregate prompt sections from all loaded skills. + +## Signature + +```typescript +getAllPromptSections(): SkillPromptSection[] +``` + +## Returns + +`SkillPromptSection[]` — Combined array of all skill prompt sections. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 357. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-all-tools.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-all-tools.mdx new file mode 100644 index 0000000000..88d3ce0249 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-all-tools.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/get-all-tools" +title: "getAllTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.getAllTools" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `getAllTools` + +Aggregate tool definitions from all loaded skills. + +## Signature + +```typescript +getAllTools(): SkillToolDefinition[] +``` + +## Returns + +`SkillToolDefinition[]` — Combined array of all skill tool definitions. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 345. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-loaded-skill-entries.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-loaded-skill-entries.mdx new file mode 100644 index 0000000000..d00e452378 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-loaded-skill-entries.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/get-loaded-skill-entries" +title: "getLoadedSkillEntries" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.getLoadedSkillEntries" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `getLoadedSkillEntries` + +Get metadata for all loaded skills, enabling ephemeral copy re-instantiation. + +## Signature + +```typescript +getLoadedSkillEntries(): { config: SkillConfig; SkillClass: typeof SkillBase; skillName: string }[] +``` + +## Returns + +`{ config: SkillConfig; SkillClass: typeof SkillBase; skillName: string }[]` — Array of entries containing skill name, class constructor, and config. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 401. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-merged-global-data.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-merged-global-data.mdx new file mode 100644 index 0000000000..2bb543b9c2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-merged-global-data.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/get-merged-global-data" +title: "getMergedGlobalData" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.getMergedGlobalData" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `getMergedGlobalData` + +Merge global data from all loaded skills into a single object. + +## Signature + +```typescript +getMergedGlobalData(): Record +``` + +## Returns + +`Record` — Combined global data (later skills override earlier ones on key conflicts). + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 381. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-skill.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-skill.mdx new file mode 100644 index 0000000000..b01e48b151 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/get-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/get-skill" +title: "getSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.getSkill" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `getSkill` + +Get a skill by its instance key or instance ID. + +## Signature + +```typescript +getSkill(keyOrId: string): SkillBase | undefined +``` + +## Parameters + + + The instance key or instance ID to look up. + + +## Returns + +`SkillBase | undefined` — The skill instance, or undefined if not found. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 319. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/has-skill-by-key.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/has-skill-by-key.mdx new file mode 100644 index 0000000000..f99550dc49 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/has-skill-by-key.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/has-skill-by-key" +title: "hasSkillByKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.hasSkillByKey" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `hasSkillByKey` + +Check if a skill with the given instance key is currently loaded. +This matches Python's `has_skill` semantics, which performs a direct +dictionary key lookup (`skill_identifier in self.loaded_skills`). + +Use `hasSkill(name)` to check by skill name (iterates values). +Use `hasSkillByKey(key)` to check by instance key (direct map lookup). + +**Remarks:** Equivalent to Python's `has_skill(skill_identifier)`. Callers porting +from Python should change `skill_manager.has_skill(key)` → +`skillManager.hasSkillByKey(key)`. + +## Signature + +```typescript +hasSkillByKey(instanceKey: string): boolean +``` + +## Parameters + + + The instance key to look up. + + +## Returns + +`boolean` — True if a skill with this exact instance key is loaded. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 218. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/has-skill.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/has-skill.mdx new file mode 100644 index 0000000000..dabeedad4f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/has-skill.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/has-skill" +title: "hasSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.hasSkill" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `hasSkill` + +Check if any skill instance with the given name is currently loaded. + +## Signature + +```typescript +hasSkill(skillName: string): boolean +``` + +## Parameters + + + The skill name to check for. + + +## Returns + +`boolean` — True if at least one instance with this name is loaded. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 196. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/index.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/index.mdx new file mode 100644 index 0000000000..6e97f20b9f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/index.mdx @@ -0,0 +1,126 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager" +title: "SkillManager" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager" + parent: "skills.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `SkillManager` + +Manages the lifecycle of skills attached to an agent. + +Handles loading, unloading, validation, and aggregation of skill tools, +hints, global data, and prompt sections. + +**Remarks:** **Architectural note — push vs pull model:** +Python's `SkillManager.__init__(self, agent)` stores the agent reference and +uses a **push model**: when a skill is loaded via `load_skill()`, the manager +immediately calls `agent.add_hints()`, `agent.update_global_data()`, and +`agent.prompt_add_section()` to inject skill data into the agent. + +This TypeScript implementation uses a **pull model** instead: `SkillManager` +has no agent reference and no constructor. `AgentBase` owns the manager and +calls `getAllHints()`, `getMergedGlobalData()`, and `getAllPromptSections()` +at render time. Both approaches produce the same observable behavior at the +SWML / SWAIG level. The pull model avoids circular-reference issues between +`AgentBase` and `SkillManager` and is better suited to TypeScript's +import-graph constraints. + +## Signature + +```typescript +class SkillManager +``` + +## Properties + + + Public read-only view of all loaded skill instances, keyed by instance key. Python equivalent: `self.loaded_skills` (public `Dict[str, SkillBase]`). Use this to iterate or inspect loaded skills without mutating the internal map. + + + + Get the number of currently loaded skill instances. + + +## Methods + + + + Add a skill to the manager, validating env vars and calling setup(). Uses the skill's instance key for deduplication. + + + + Remove all skills and clean up. + + + + + + Aggregate speech recognition hints from all loaded skills. + + + + Aggregate prompt sections from all loaded skills. + + + + Aggregate tool definitions from all loaded skills. + + + + Get metadata for all loaded skills, enabling ephemeral copy re-instantiation. + + + + Merge global data from all loaded skills into a single object. + + + + Get a skill by its instance key or instance ID. + + + + Check if any skill instance with the given name is currently loaded. + + + + Check if a skill with the given instance key is currently loaded. This matches Python's `has_skill` semantics, which performs a direct dictionary key lookup (`skill_identifier in self.loaded_skills`). + + + + List the instance keys of all currently loaded skills. Python equivalent: `list_loaded_skills() -> List[str]` which returns `list(self.loaded_skills.keys())`. + + + + List all loaded skill instances with their name, ID, and initialization state. + + + + Load a skill by providing the class constructor directly, bypassing the registry. This is the TypeScript equivalent of Python's `load_skill(skill_name, skill_class, params)` path where a caller-provided `skill_class` is used instead of a registry lookup. + + + + Load a skill by name from the global SkillRegistry, construct it, and add it. This is the TypeScript equivalent of Python's `load_skill(skill_name)` path where `skill_class=None` triggers a registry lookup. + + + + Remove a skill by its instance key or instance ID, calling cleanup() before removal. + + + + Remove all skill instances matching a given skill name. + + + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 45. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/list-skill-keys.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/list-skill-keys.mdx new file mode 100644 index 0000000000..24866593be --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/list-skill-keys.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/list-skill-keys" +title: "listSkillKeys" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.listSkillKeys" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `listSkillKeys` + +List the instance keys of all currently loaded skills. +Python equivalent: `list_loaded_skills() -> List[str]` which returns +`list(self.loaded_skills.keys())`. + +Use `listSkills()` for richer objects (name, instanceId, initialized). +Use `listSkillKeys()` for a flat list of instance key strings. + +**Remarks:** Equivalent to Python's `list_loaded_skills()`. Callers porting from +Python should change `skill_manager.list_loaded_skills()` → +`skillManager.listSkillKeys()`. + +## Signature + +```typescript +listSkillKeys(): string[] +``` + +## Returns + +`string[]` — Array of instance key strings. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 310. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/list-skills.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/list-skills.mdx new file mode 100644 index 0000000000..c0cbbdf7d7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/list-skills.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/list-skills" +title: "listSkills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.listSkills" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `listSkills` + +List all loaded skill instances with their name, ID, and initialization state. + +## Signature + +```typescript +listSkills(): { initialized: boolean; instanceId: string; name: string }[] +``` + +## Returns + +`{ initialized: boolean; instanceId: string; name: string }[]` — Array of skill summary objects. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 333. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/load-skill-by-name.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/load-skill-by-name.mdx new file mode 100644 index 0000000000..a8c7523131 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/load-skill-by-name.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/load-skill-by-name" +title: "loadSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.loadSkillByName" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `loadSkillByName` + +Load a skill by name from the global SkillRegistry, construct it, and add it. +This is the TypeScript equivalent of Python's `load_skill(skill_name)` path +where `skill_class=None` triggers a registry lookup. + +**Remarks:** Equivalent to Python's `load_skill(skill_name)` (registry path, where +`skill_class=None`). Callers porting from Python should change +`skill_manager.load_skill(name)` → `skillManager.loadSkillByName(name)`. + +## Signature + +```typescript +loadSkillByName( + skillName: string, + config?: SkillConfig +): Promise<[boolean, string]> +``` + +## Parameters + + + The registered skill name to look up in the SkillRegistry. + + + + Optional configuration to pass to the skill factory. + + +## Returns + +`Promise<[boolean, string]>` — A tuple `[success, errorMessage]` matching Python's `load_skill` return contract. `errorMessage` is an empty string on success. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 270. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/load-skill.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/load-skill.mdx new file mode 100644 index 0000000000..d48b4fb5a4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/load-skill.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/load-skill" +title: "loadSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.loadSkill" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `loadSkill` + +Load a skill by providing the class constructor directly, bypassing the registry. +This is the TypeScript equivalent of Python's `load_skill(skill_name, skill_class, params)` +path where a caller-provided `skill_class` is used instead of a registry lookup. + +**Remarks:** Equivalent to Python's `load_skill(skill_name, skill_class=MySkillClass, params)`. + +## Signature + +```typescript +loadSkill( + skillClass: typeof SkillBase, + config?: SkillConfig +): Promise<[boolean, string]> +``` + +## Parameters + + + The skill class constructor (a subclass of `SkillBase`). + + + + Optional configuration to pass to the skill constructor. + + +## Returns + +`Promise<[boolean, string]>` — A tuple `[success, errorMessage]` matching Python's `load_skill` return contract. `errorMessage` is an empty string on success. + +## Examples + +```typescript +const [ok, err] = await manager.loadSkill(MyCustomSkill, { api_key: 'secret' }); +if (!ok) console.error(err); +``` + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 240. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/remove-skill-by-name.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/remove-skill-by-name.mdx new file mode 100644 index 0000000000..ff384e1a16 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/remove-skill-by-name.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/remove-skill-by-name" +title: "removeSkillByName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.removeSkillByName" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `removeSkillByName` + +Remove all skill instances matching a given skill name. + +## Signature + +```typescript +removeSkillByName(skillName: string): Promise +``` + +## Parameters + + + The skill name to match against. + + +## Returns + +`Promise` — The number of skill instances removed. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 178. diff --git a/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/remove-skill.mdx b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/remove-skill.mdx new file mode 100644 index 0000000000..622c528fcc --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-manager/skill-manager/remove-skill.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/skills/skill-manager/skill-manager/remove-skill" +title: "removeSkill" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillManager.SkillManager.removeSkill" + parent: "skills.SkillManager.SkillManager" + module: "skills.SkillManager" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts" +--- +# `removeSkill` + +Remove a skill by its instance key or instance ID, calling cleanup() before removal. + +**Remarks:** Equivalent to Python's `unload_skill(skill_identifier)`. Callers porting +from Python should change `skill_manager.unload_skill(id)` → +`skillManager.removeSkill(id)`. + +## Signature + +```typescript +removeSkill(keyOrId: string): Promise +``` + +## Parameters + + + The instance key or instance ID of the skill to remove. + + +## Returns + +`Promise` — True if the skill was found and removed, false otherwise. + +## Source + +[`src/skills/SkillManager.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillManager.ts) + +Line 148. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/index.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/index.mdx new file mode 100644 index 0000000000..72006417c5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/index.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/skill-registry" +title: "SkillRegistry" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "skills.SkillRegistry" + module: "skills" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `SkillRegistry` + +## Signature + +```typescript +module SkillRegistry +``` + +## Classes + + + + Global singleton registry for registering and instantiating skills. + + + +## Interfaces + + + + Metadata exposed for a registered skill. Shape matches Python's `SkillRegistry.list_skills()` / `get_all_skills_schema()` return values (`skills/registry.py:205-227`, `229-296`). + + + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/add-search-path.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/add-search-path.mdx new file mode 100644 index 0000000000..76dc5938e1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/add-search-path.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/add-search-path" +title: "addSearchPath" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.addSearchPath" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `addSearchPath` + +Add a directory path to search during skill discovery. + +## Signature + +```typescript +addSearchPath(path: string): void +``` + +## Parameters + + + Absolute path to a directory containing skill files. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 224. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/add-skill-directory.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/add-skill-directory.mdx new file mode 100644 index 0000000000..be1994f544 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/add-skill-directory.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/add-skill-directory" +title: "addSkillDirectory" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.addSkillDirectory" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `addSkillDirectory` + +Add a directory to search for skills. + +Mirrors Python's +`signalwire.skills.registry.SkillRegistry.add_skill_directory` +(`registry.py:350-375`): validate that the path exists and is a +directory, then append it (de-duplicated) to `externalPaths`. Throws +`Error` (the JS analog of Python's `ValueError`) for non-existent +paths or non-directories. Distinct from `addSearchPath`, which +silently accepts anything; `addSkillDirectory` is the strict +Python-parity surface and the recommended entry point for +registering third-party skill directories. + +## Signature + +```typescript +addSkillDirectory(path: string): void +``` + +## Parameters + + + Absolute or relative path to a directory containing skill subdirectories. + + +## Returns + +`void` + +## Throws + +- Error when the path doesn't exist or isn't a directory. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 247. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/clear.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/clear.mdx new file mode 100644 index 0000000000..abdbe3f641 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/clear.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/clear" +title: "clear" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.clear" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `clear` + +Clear all registrations. + +## Signature + +```typescript +clear(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 408. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/constructor.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/constructor.mdx new file mode 100644 index 0000000000..b0d30d2103 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/constructor.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.constructor" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(): SkillRegistry +``` + +## Returns + +`SkillRegistry` + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 69. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/create.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/create.mdx new file mode 100644 index 0000000000..026522fc10 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/create.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/create" +title: "create" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.create" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `create` + +Create a new skill instance by looking up its class in the registry. +Matches Python's `skill_manager.load_skill(name)` class-lookup + instantiate +flow (`skill_manager.py:97`: `skill_instance = skill_class(self.agent, params)`). + +## Signature + +```typescript +create(name: string, config?: SkillConfig): SkillBase | null +``` + +## Parameters + + + The registered skill name. + + + + Optional configuration to pass to the skill constructor. + + +## Returns + +`SkillBase | null` — A new skill instance, or null if the name is not registered. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 163. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/discover-all.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/discover-all.mdx new file mode 100644 index 0000000000..4312935d29 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/discover-all.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/discover-all" +title: "discoverAll" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.discoverAll" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `discoverAll` + +Discover and register skills from all configured search paths. + +## Signature + +```typescript +discoverAll(): Promise +``` + +## Returns + +`Promise` — Array of all newly discovered skill names. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 338. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/discover-from-directory.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/discover-from-directory.mdx new file mode 100644 index 0000000000..7d6b07e960 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/discover-from-directory.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/discover-from-directory" +title: "discoverFromDirectory" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.discoverFromDirectory" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `discoverFromDirectory` + +Discover and register skills from a directory by importing each file. +Looks for SkillBase subclass exports and registers them. + +## Signature + +```typescript +discoverFromDirectory(dirPath: string): Promise +``` + +## Parameters + + + Absolute path to the directory to scan. + + +## Returns + +`Promise` — Array of newly discovered skill names. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 282. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-all-skills-schema.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-all-skills-schema.mdx new file mode 100644 index 0000000000..09ecfa6d5d --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-all-skills-schema.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/get-all-skills-schema" +title: "getAllSkillsSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.getAllSkillsSchema" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `getAllSkillsSchema` + +Get combined schema info for all registered skills. + +## Signature + +```typescript +getAllSkillsSchema(): Record +``` + +## Returns + +`Record` — Record mapping skill names to their schema info. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 372. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-external-paths.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-external-paths.mdx new file mode 100644 index 0000000000..efbe245303 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-external-paths.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/get-external-paths" +title: "getExternalPaths" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.getExternalPaths" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `getExternalPaths` + +Returns a copy of the external skill directories registered via +[addSkillDirectory](/reference/typescript/add-skill-directory). Parity surface for Python's +`_external_paths`. + +## Signature + +```typescript +getExternalPaths(): string[] +``` + +## Returns + +`string[]` + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 264. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-instance.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-instance.mdx new file mode 100644 index 0000000000..e66aca14f9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-instance.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/get-instance" +title: "getInstance" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.getInstance" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `getInstance` + +Get the global singleton instance, creating it on first access. + +**Modifiers:** `static` + +## Signature + +```typescript +getInstance(): SkillRegistry +``` + +## Returns + +`SkillRegistry` — The shared SkillRegistry instance. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 78. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-search-paths.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-search-paths.mdx new file mode 100644 index 0000000000..5d15ea9ca0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-search-paths.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/get-search-paths" +title: "getSearchPaths" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.getSearchPaths" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `getSearchPaths` + +Get all configured search paths for skill discovery. + +## Signature + +```typescript +getSearchPaths(): string[] +``` + +## Returns + +`string[]` — Copy of the search paths array. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 272. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-skill-class.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-skill-class.mdx new file mode 100644 index 0000000000..4bb3c18b16 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-skill-class.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/get-skill-class" +title: "getSkillClass" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.getSkillClass" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `getSkillClass` + +Get the registered skill class by name. Matches Python's +`get_skill_class(skill_name)` (`registry.py:196-203`). + +## Signature + +```typescript +getSkillClass(name: string): typeof SkillBase | undefined +``` + +## Parameters + + + The registered skill name. + + +## Returns + +`typeof SkillBase | undefined` — The skill class reference, or undefined if not registered. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 181. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-skill-schema.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-skill-schema.mdx new file mode 100644 index 0000000000..78fd9f1edd --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/get-skill-schema.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/get-skill-schema" +title: "getSkillSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.getSkillSchema" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `getSkillSchema` + +Get the combined schema info for a registered skill. +Matches Python `get_all_skills_schema` per-skill shape +(`registry.py:287-295`). + +## Signature + +```typescript +getSkillSchema(name: string): SkillSchemaInfo | undefined +``` + +## Parameters + + + The registered skill name to query. + + +## Returns + +`SkillSchemaInfo | undefined` — The skill's schema info, or undefined if not found. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 354. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/has.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/has.mdx new file mode 100644 index 0000000000..53421edd6a --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/has.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/has" +title: "has" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.has" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `has` + +Check if a skill name is registered. + +## Signature + +```typescript +has(name: string): boolean +``` + +## Parameters + + + The skill name to check. + + +## Returns + +`boolean` — True if the skill is registered. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 190. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/index.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/index.mdx new file mode 100644 index 0000000000..9fc880196b --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/index.mdx @@ -0,0 +1,124 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry" +title: "SkillRegistry" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry" + parent: "skills.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `SkillRegistry` + +Global singleton registry for registering and instantiating skills. + +Skills can be registered programmatically via `register(SkillClass)`. +Matches Python's `skill_registry` global (`skills/registry.py:481`). + +## Signature + +```typescript +class SkillRegistry +``` + +## Properties + + + Get the number of registered skills. + + +## Methods + + + + Add a directory path to search during skill discovery. + + + + Add a directory to search for skills. + + + + Clear all registrations. + + + + + + Create a new skill instance by looking up its class in the registry. Matches Python's `skill_manager.load_skill(name)` class-lookup + instantiate flow (`skill_manager.py:97`: `skill_instance = skill_class(self.agent, params)`). + + + + Discover and register skills from all configured search paths. + + + + Discover and register skills from a directory by importing each file. Looks for SkillBase subclass exports and registers them. + + + + Get combined schema info for all registered skills. + + + + Returns a copy of the external skill directories registered via [addSkillDirectory](/reference/typescript/add-skill-directory). Parity surface for Python's `_external_paths`. + + + + Get the global singleton instance, creating it on first access. + + + + Get all configured search paths for skill discovery. + + + + Get the registered skill class by name. Matches Python's `get_skill_class(skill_name)` (`registry.py:196-203`). + + + + Get the combined schema info for a registered skill. Matches Python `get_all_skills_schema` per-skill shape (`registry.py:287-295`). + + + + Check if a skill name is registered. + + + + Group registered skill names by source category. Matches Python's `list_all_skill_sources` (`skills/registry.py:436-478`). + + + + List all registered skill names. + + + + List all registered skills with their full metadata. Matches Python's `list_skills()` shape (`registry.py:205-227`) plus TS-idiomatic camelCase keys. + + + + Lock one or more skill names to prevent overwriting. If called with no arguments, locks all currently registered skills. + + + + Register a skill class. The skill name is read from the class's static `SKILL_NAME`. Mirrors Python's `register_skill(skill_class)` (`skills/registry.py:132-194`) — including the schema-non-empty check and the protection against overwriting locked skills. + + + + Reset the global singleton (for testing). + + + + Unregister a skill by name, removing it from the registry. + + + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/list-all-skill-sources.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/list-all-skill-sources.mdx new file mode 100644 index 0000000000..228a1bd5d0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/list-all-skill-sources.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/list-all-skill-sources" +title: "listAllSkillSources" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.listAllSkillSources" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `listAllSkillSources` + +Group registered skill names by source category. Matches Python's +`list_all_skill_sources` (`skills/registry.py:436-478`). + +Current TS implementation treats every registered skill as "registered" +(the only category that fits — filesystem-based discovery is optional +and entry-points don't apply to Node the way they do to Python). + +## Signature + +```typescript +listAllSkillSources(): Record +``` + +## Returns + +`Record` — Record mapping source categories to arrays of skill names. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 391. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/list-registered.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/list-registered.mdx new file mode 100644 index 0000000000..2f54b15340 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/list-registered.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/list-registered" +title: "listRegistered" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.listRegistered" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `listRegistered` + +List all registered skill names. + +## Signature + +```typescript +listRegistered(): string[] +``` + +## Returns + +`string[]` — Array of registered skill name strings. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 198. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/list-skills.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/list-skills.mdx new file mode 100644 index 0000000000..7403bfc259 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/list-skills.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/list-skills" +title: "listSkills" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.listSkills" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `listSkills` + +List all registered skills with their full metadata. Matches Python's +`list_skills()` shape (`registry.py:205-227`) plus TS-idiomatic +camelCase keys. + +## Signature + +```typescript +listSkills(): SkillSchemaInfo[] +``` + +## Returns + +`SkillSchemaInfo[]` — Array of skill metadata objects. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 208. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/lock.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/lock.mdx new file mode 100644 index 0000000000..b0c864f949 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/lock.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/lock" +title: "lock" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.lock" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `lock` + +Lock one or more skill names to prevent overwriting. +If called with no arguments, locks all currently registered skills. + +## Signature + +```typescript +lock(names?: string[]): void +``` + +## Parameters + + + Skill names to lock; if omitted, all current names are locked. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 138. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/register.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/register.mdx new file mode 100644 index 0000000000..d4fae0dd2e --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/register.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/register" +title: "register" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.register" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `register` + +Register a skill class. The skill name is read from the class's static +`SKILL_NAME`. Mirrors Python's `register_skill(skill_class)` +(`skills/registry.py:132-194`) — including the schema-non-empty check +and the protection against overwriting locked skills. + +## Signature + +```typescript +register(SkillClass: typeof SkillBase): void +``` + +## Parameters + + + A concrete subclass of `SkillBase` with a non-empty `SKILL_NAME`. + + +## Returns + +`void` + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 101. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/reset-instance.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/reset-instance.mdx new file mode 100644 index 0000000000..6383265526 --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/reset-instance.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/reset-instance" +title: "resetInstance" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.resetInstance" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `resetInstance` + +Reset the global singleton (for testing). + +**Modifiers:** `static` + +## Signature + +```typescript +resetInstance(): void +``` + +## Returns + +`void` + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 88. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/unregister.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/unregister.mdx new file mode 100644 index 0000000000..f2bda59a9f --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-registry/unregister.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-registry/unregister" +title: "unregister" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillRegistry.unregister" + parent: "skills.SkillRegistry.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `unregister` + +Unregister a skill by name, removing it from the registry. + +## Signature + +```typescript +unregister(name: string): boolean +``` + +## Parameters + + + The skill name to unregister. + + +## Returns + +`boolean` — True if the skill was found and removed. + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 150. diff --git a/fern/products/sdk-reference/typescript/skills/skill-registry/skill-schema-info/index.mdx b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-schema-info/index.mdx new file mode 100644 index 0000000000..2666ef6edf --- /dev/null +++ b/fern/products/sdk-reference/typescript/skills/skill-registry/skill-schema-info/index.mdx @@ -0,0 +1,65 @@ +--- +slug: "/reference/typescript/skills/skill-registry/skill-schema-info" +title: "SkillSchemaInfo" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "skills.SkillRegistry.SkillSchemaInfo" + parent: "skills.SkillRegistry" + module: "skills.SkillRegistry" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts" +--- +# `SkillSchemaInfo` + +Metadata exposed for a registered skill. Shape matches Python's +`SkillRegistry.list_skills()` / `get_all_skills_schema()` return values +(`skills/registry.py:205-227`, `229-296`). + +## Signature + +```typescript +interface SkillSchemaInfo +``` + +## Properties + + + Human-readable description (from `SkillBase.SKILL_DESCRIPTION`). + + + + The skill's registered name (from `SkillBase.SKILL_NAME`). + + + + Full parameter schema with types, defaults, and constraints. + + + + Environment variables required by the skill. + + + + NPM packages required by the skill. + + + + Optional source category for grouping (e.g., "builtin", "external"). + + + + Whether this skill supports multiple simultaneous instances. + + + + Semantic version string (from `SkillBase.SKILL_VERSION`). + + +## Source + +[`src/skills/SkillRegistry.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/skills/SkillRegistry.ts) + +Line 28. diff --git a/fern/products/sdk-reference/typescript/ssl-config/index.mdx b/fern/products/sdk-reference/typescript/ssl-config/index.mdx new file mode 100644 index 0000000000..772a442b39 --- /dev/null +++ b/fern/products/sdk-reference/typescript/ssl-config/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/ssl-config" +title: "SslConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "SslConfig" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts" +--- +# `SslConfig` + +## Signature + +```typescript +module SslConfig +``` + +## Classes + + + + Manages SSL/TLS configuration sourced from explicit options or environment variables. + + + +## Interfaces + + + + Configuration options for SSL/TLS setup. + + + +## Source + +[`src/SslConfig.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/ssl-config/ssl-config/constructor.mdx b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/constructor.mdx new file mode 100644 index 0000000000..5a5185a4a8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/ssl-config/ssl-config/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SslConfig.SslConfig.constructor" + parent: "SslConfig.SslConfig" + module: "SslConfig" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts" +--- +# `constructor` + +Create an SslConfig, falling back to environment variables for any unset options. + +## Signature + +```typescript +constructor(opts?: SslOptions): SslConfig +``` + +## Parameters + + + Optional SSL configuration overrides. + + +## Returns + +`SslConfig` + +## Source + +[`src/SslConfig.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts) + +Line 48. diff --git a/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-cert.mdx b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-cert.mdx new file mode 100644 index 0000000000..e8a36744f1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-cert.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/ssl-config/ssl-config/get-cert" +title: "getCert" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SslConfig.SslConfig.getCert" + parent: "SslConfig.SslConfig" + module: "SslConfig" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts" +--- +# `getCert` + +Read the PEM certificate file from disk. + +## Signature + +```typescript +getCert(): string | null +``` + +## Returns + +`string | null` — The certificate contents, or null if the file is missing. + +## Source + +[`src/SslConfig.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts) + +Line 71. diff --git a/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-hsts-header.mdx b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-hsts-header.mdx new file mode 100644 index 0000000000..3172393b05 --- /dev/null +++ b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-hsts-header.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/ssl-config/ssl-config/get-hsts-header" +title: "getHstsHeader" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SslConfig.SslConfig.getHstsHeader" + parent: "SslConfig.SslConfig" + module: "SslConfig" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts" +--- +# `getHstsHeader` + +Build the Strict-Transport-Security header value. + +## Signature + +```typescript +getHstsHeader(): string | null +``` + +## Returns + +`string | null` — The HSTS header string, or null if HSTS is disabled or SSL is off. + +## Source + +[`src/SslConfig.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts) + +Line 89. diff --git a/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-key.mdx b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-key.mdx new file mode 100644 index 0000000000..29a8da0427 --- /dev/null +++ b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-key.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/ssl-config/ssl-config/get-key" +title: "getKey" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SslConfig.SslConfig.getKey" + parent: "SslConfig.SslConfig" + module: "SslConfig" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts" +--- +# `getKey` + +Read the PEM private key file from disk. + +## Signature + +```typescript +getKey(): string | null +``` + +## Returns + +`string | null` — The key contents, or null if the file is missing. + +## Source + +[`src/SslConfig.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts) + +Line 80. diff --git a/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-server-options.mdx b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-server-options.mdx new file mode 100644 index 0000000000..f8e1649bb6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/get-server-options.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/ssl-config/ssl-config/get-server-options" +title: "getServerOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SslConfig.SslConfig.getServerOptions" + parent: "SslConfig.SslConfig" + module: "SslConfig" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts" +--- +# `getServerOptions` + +Create the options object needed by Node.js `https.createServer()`. + +## Signature + +```typescript +getServerOptions(): { cert: string; key: string } | null +``` + +## Returns + +`{ cert: string; key: string } | null` — An object with `cert` and `key` strings, or null if either file is missing. + +## Source + +[`src/SslConfig.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts) + +Line 98. diff --git a/fern/products/sdk-reference/typescript/ssl-config/ssl-config/hsts-middleware.mdx b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/hsts-middleware.mdx new file mode 100644 index 0000000000..3089117dc2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/hsts-middleware.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/ssl-config/ssl-config/hsts-middleware" +title: "hstsMiddleware" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SslConfig.SslConfig.hstsMiddleware" + parent: "SslConfig.SslConfig" + module: "SslConfig" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts" +--- +# `hstsMiddleware` + +Return a Hono middleware that appends the HSTS header to every response. + +## Signature + +```typescript +hstsMiddleware(): (c: any, next: () => Promise) => Promise +``` + +## Returns + +`(c: any, next: () => Promise) => Promise` — A Hono-compatible middleware function. + +## Source + +[`src/SslConfig.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts) + +Line 109. diff --git a/fern/products/sdk-reference/typescript/ssl-config/ssl-config/index.mdx b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/index.mdx new file mode 100644 index 0000000000..c303fb2412 --- /dev/null +++ b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/index.mdx @@ -0,0 +1,87 @@ +--- +slug: "/reference/typescript/ssl-config/ssl-config" +title: "SslConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "SslConfig.SslConfig" + parent: "SslConfig" + module: "SslConfig" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts" +--- +# `SslConfig` + +Manages SSL/TLS configuration sourced from explicit options or environment variables. + +## Signature + +```typescript +class SslConfig +``` + +## Properties + + + Filesystem path to the PEM certificate, or null if unset. + + + + Domain name for HSTS, or null if unset. + + + + Whether SSL is enabled. + + + + Whether HSTS headers should be emitted. + + + + HSTS max-age value in seconds. + + + + Filesystem path to the PEM private key, or null if unset. + + +## Methods + + + + Create an SslConfig, falling back to environment variables for any unset options. + + + + Read the PEM certificate file from disk. + + + + Build the Strict-Transport-Security header value. + + + + Read the PEM private key file from disk. + + + + Create the options object needed by Node.js `https.createServer()`. + + + + Return a Hono middleware that appends the HSTS header to every response. + + + + Check whether SSL is fully configured: enabled with both cert and key files present on disk. + + + +## Source + +[`src/SslConfig.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts) + +Line 30. diff --git a/fern/products/sdk-reference/typescript/ssl-config/ssl-config/is-configured.mdx b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/is-configured.mdx new file mode 100644 index 0000000000..8e20438473 --- /dev/null +++ b/fern/products/sdk-reference/typescript/ssl-config/ssl-config/is-configured.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/ssl-config/ssl-config/is-configured" +title: "isConfigured" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SslConfig.SslConfig.isConfigured" + parent: "SslConfig.SslConfig" + module: "SslConfig" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts" +--- +# `isConfigured` + +Check whether SSL is fully configured: enabled with both cert and key files present on disk. + +## Signature + +```typescript +isConfigured(): boolean +``` + +## Returns + +`boolean` — True if SSL is enabled and both certificate and key files exist. + +## Source + +[`src/SslConfig.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts) + +Line 61. diff --git a/fern/products/sdk-reference/typescript/ssl-config/ssl-options/index.mdx b/fern/products/sdk-reference/typescript/ssl-config/ssl-options/index.mdx new file mode 100644 index 0000000000..84804e6fe0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/ssl-config/ssl-options/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/ssl-config/ssl-options" +title: "SslOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "SslConfig.SslOptions" + parent: "SslConfig" + module: "SslConfig" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts" +--- +# `SslOptions` + +Configuration options for SSL/TLS setup. + +## Signature + +```typescript +interface SslOptions +``` + +## Properties + + + Filesystem path to the PEM-encoded certificate. + + + + Domain name used for HSTS headers. + + + + Whether SSL is enabled. + + + + Whether to send HSTS headers; defaults to true. + + + + HSTS max-age in seconds; defaults to 31536000 (1 year). + + + + Filesystem path to the PEM-encoded private key. + + +## Source + +[`src/SslConfig.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SslConfig.ts) + +Line 14. diff --git a/fern/products/sdk-reference/typescript/start-agent.mdx b/fern/products/sdk-reference/typescript/start-agent.mdx new file mode 100644 index 0000000000..8a3c1bbc4b --- /dev/null +++ b/fern/products/sdk-reference/typescript/start-agent.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/start-agent" +title: "startAgent" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "startAgent" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts" +--- +# `startAgent` + +Start an agent's HTTP server. + +Equivalent to Python's `start_agent(agent)`. Delegates to `agent.serve(options)`. + +## Signature + +```typescript +startAgent(agent: AgentBase, options?: { ...2 fields }): Promise +``` + +## Parameters + + + The [AgentBase](/reference/typescript/agent-base) instance to start. + + + + Optional host / port overrides. When omitted, values come from the agent's constructor options or the `PORT` environment variable. + + + + + + +## Returns + +`Promise` — Resolves once the HTTP server has begun listening. + +## Examples + +```typescript +import { AgentBase, startAgent } from '@signalwire/sdk'; + +const agent = new AgentBase({ name: 'demo' }); +await startAgent(agent, { port: 3000 }); +``` + +## Source + +[`src/index.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/index.ts) + +Line 333. diff --git a/fern/products/sdk-reference/typescript/swaig-function/index.mdx b/fern/products/sdk-reference/typescript/swaig-function/index.mdx new file mode 100644 index 0000000000..b3c6316bf7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swaig-function/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/swaig-function" +title: "SwaigFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "SwaigFunction" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts" +--- +# `SwaigFunction` + +## Signature + +```typescript +module SwaigFunction +``` + +## Type Aliases + + + + Handler function for a SWAIG tool invocation. + + + +## Classes + + + + A SWAIG function — exactly the same concept as a "tool" in native OpenAI / Anthropic tool calling. + + + +## Interfaces + + + + Configuration options for creating a SwaigFunction. + + + +## Source + +[`src/SwaigFunction.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/swaig-function/swaig-function-options/index.mdx b/fern/products/sdk-reference/typescript/swaig-function/swaig-function-options/index.mdx new file mode 100644 index 0000000000..ce47413b52 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swaig-function/swaig-function-options/index.mdx @@ -0,0 +1,79 @@ +--- +slug: "/reference/typescript/swaig-function/swaig-function-options" +title: "SwaigFunctionOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "SwaigFunction.SwaigFunctionOptions" + parent: "SwaigFunction" + module: "SwaigFunction" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts" +--- +# `SwaigFunctionOptions` + +Configuration options for creating a SwaigFunction. + +## Signature + +```typescript +interface SwaigFunctionOptions +``` + +## Properties + + + Human-readable description of what the tool does, shown to the AI. + + + + Additional fields to merge directly into the SWAIG function definition. **Python equivalent:** `**extra_swaig_fields` kwargs on the constructor. In Python these are passed as bare keyword arguments and merged directly into the output dict via `function_def.update(self.extra_swaig_fields)`. In TypeScript the same fields are collected under this single options key and merged identically in `toSwaig()` — the wire format is identical. + + + + Language-keyed filler phrases spoken while the tool executes. + + + + The handler function called when the tool is invoked. + + + + Whether this tool uses a typed handler with named parameters. + + + + Unique name used to register and invoke this tool. + + + + JSON Schema properties describing the tool's parameters. + + + + List of required parameter names. + + + + Whether this tool requires session token authentication. + + + + Audio file URL to play while waiting for the tool to complete. + + + + Number of times to loop the wait file. + + + + External webhook URL; makes this an externally-hosted tool. + + +## Source + +[`src/SwaigFunction.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts) + +Line 25. diff --git a/fern/products/sdk-reference/typescript/swaig-function/swaig-function/constructor.mdx b/fern/products/sdk-reference/typescript/swaig-function/swaig-function/constructor.mdx new file mode 100644 index 0000000000..8eca8f9a75 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swaig-function/swaig-function/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swaig-function/swaig-function/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwaigFunction.SwaigFunction.constructor" + parent: "SwaigFunction.SwaigFunction" + module: "SwaigFunction" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts" +--- +# `constructor` + +Create a new SwaigFunction. + +## Signature + +```typescript +constructor(opts: SwaigFunctionOptions): SwaigFunction +``` + +## Parameters + + + Configuration options for the SWAIG function. Use `opts.extraFields` to pass any additional SWAIG-only fields (e.g. `meta_data_token`, `web_hook_auth_user`, `web_hook_auth_password`). This mirrors the Python constructor's `**extra_swaig_fields` kwargs: both are merged directly into the serialized SWAIG definition, so the wire format is identical — only the call-site syntax differs. + + +## Returns + +`SwaigFunction` + +## Source + +[`src/SwaigFunction.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts) + +Line 138. diff --git a/fern/products/sdk-reference/typescript/swaig-function/swaig-function/execute.mdx b/fern/products/sdk-reference/typescript/swaig-function/swaig-function/execute.mdx new file mode 100644 index 0000000000..9f0b5ee5b1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swaig-function/swaig-function/execute.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/swaig-function/swaig-function/execute" +title: "execute" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwaigFunction.SwaigFunction.execute" + parent: "SwaigFunction.SwaigFunction" + module: "SwaigFunction" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts" +--- +# `execute` + +Invoke the handler with the given arguments and return a serialized result. + +## Signature + +```typescript +execute( + args: Record, + rawData?: Record +): Promise> +``` + +## Parameters + + + Parsed arguments from the AI. + + + + The full raw request payload. + + +## Returns + +`Promise>` — A serialized result dictionary suitable for the SWAIG response. + +## Source + +[`src/SwaigFunction.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts) + +Line 213. diff --git a/fern/products/sdk-reference/typescript/swaig-function/swaig-function/index.mdx b/fern/products/sdk-reference/typescript/swaig-function/swaig-function/index.mdx new file mode 100644 index 0000000000..c1bc366130 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swaig-function/swaig-function/index.mdx @@ -0,0 +1,123 @@ +--- +slug: "/reference/typescript/swaig-function/swaig-function" +title: "SwaigFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "SwaigFunction.SwaigFunction" + parent: "SwaigFunction" + module: "SwaigFunction" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts" +--- +# `SwaigFunction` + +A SWAIG function — exactly the same concept as a "tool" in native +OpenAI / Anthropic tool calling. + +Each SwaigFunction is rendered, on every LLM turn, into the OpenAI +tool schema: + +```json +{ +"type": "function", +"function": { +"name": "", +"description": "", +"parameters": { "type": "object", "properties": { ... } } +} +} +``` + +The `name`, `description`, and every per-parameter `description` inside +`parameters` are **read by the model** and directly determine whether +the model picks this tool when a matching user request comes in. +They are prompt engineering, not developer comments. + +## Signature + +```typescript +class SwaigFunction +``` + +## Properties + + + LLM-facing description. Tells the model WHEN to call this tool. A vague description is the #1 cause of "model has the tool but doesn't call it" failures. + + + + Additional fields included in the SWAIG definition output. + + + + Language-keyed filler phrases spoken while the tool executes. + + + + The handler function called when the tool is invoked. + + + + Whether this tool is externally hosted (has a webhookUrl). + + + + Whether this tool uses a typed handler with named parameters. + + + + Unique name — read by the LLM; use snake\_case verbs. + + + + JSON Schema properties describing the tool's parameters. Each property's `description` field is ALSO LLM-facing — it tells the model HOW to extract that argument from the user's utterance. + + + + List of required parameter names. + + + + Whether this tool requires session token authentication. + + + + Audio file URL to play while waiting for the tool to complete. + + + + Number of times to loop the wait file. + + + + External webhook URL; set when the tool is externally hosted. + + +## Methods + + + + Create a new SwaigFunction. + + + + Invoke the handler with the given arguments and return a serialized result. + + + + Serialize this function to the SWAIG wire format for inclusion in SWML. + + + + Validate arguments against the parameter JSON schema using full JSON Schema Draft-7 validation (via ajv). + + + +## Source + +[`src/SwaigFunction.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts) + +Line 92. diff --git a/fern/products/sdk-reference/typescript/swaig-function/swaig-function/to-swaig.mdx b/fern/products/sdk-reference/typescript/swaig-function/swaig-function/to-swaig.mdx new file mode 100644 index 0000000000..c6984cbc8d --- /dev/null +++ b/fern/products/sdk-reference/typescript/swaig-function/swaig-function/to-swaig.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/swaig-function/swaig-function/to-swaig" +title: "toSwaig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwaigFunction.SwaigFunction.toSwaig" + parent: "SwaigFunction.SwaigFunction" + module: "SwaigFunction" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts" +--- +# `toSwaig` + +Serialize this function to the SWAIG wire format for inclusion in SWML. + +## Signature + +```typescript +toSwaig( + baseUrl: string, + token?: string, + callId?: string +): Record +``` + +## Parameters + + + The base URL of the agent server. + + + + Optional session token for secure functions. + + + + Optional call ID for secure function URLs. + + +## Returns + +`Record` — A SWAIG function definition object. + +## Source + +[`src/SwaigFunction.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts) + +Line 257. diff --git a/fern/products/sdk-reference/typescript/swaig-function/swaig-function/validate-args.mdx b/fern/products/sdk-reference/typescript/swaig-function/swaig-function/validate-args.mdx new file mode 100644 index 0000000000..5e1f4a50d8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swaig-function/swaig-function/validate-args.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/swaig-function/swaig-function/validate-args" +title: "validateArgs" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwaigFunction.SwaigFunction.validateArgs" + parent: "SwaigFunction.SwaigFunction" + module: "SwaigFunction" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts" +--- +# `validateArgs` + +Validate arguments against the parameter JSON schema using full +JSON Schema Draft-7 validation (via ajv). + +Mirrors Python's `validate_args` which tries `jsonschema_rs` (Rust-based +Draft-7 validator) then falls back to `jsonschema` (pure Python Draft-7). +All JSON Schema constraint keywords are honoured: `required`, `type`, +`minLength`, `maxLength`, `pattern`, `format`, `minimum`, `maximum`, +`enum`, `anyOf`, `oneOf`, `$ref`, nested object/array validation, etc. + +If the schema has no properties, validation is skipped and the args are +considered valid — matching Python's early-return path. + +## Signature + +```typescript +validateArgs(args: Record): [boolean, string[]] +``` + +## Parameters + + + Arguments to validate. + + +## Returns + +`[boolean, string[]]` — A tuple of `[isValid, errors]`. When no validation is needed (empty schema), returns `[true, []]`. + +## Source + +[`src/SwaigFunction.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts) + +Line 186. diff --git a/fern/products/sdk-reference/typescript/swaig-function/swaig-handler.mdx b/fern/products/sdk-reference/typescript/swaig-function/swaig-handler.mdx new file mode 100644 index 0000000000..f645a105bf --- /dev/null +++ b/fern/products/sdk-reference/typescript/swaig-function/swaig-handler.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/swaig-function/swaig-handler" +title: "SwaigHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "SwaigFunction.SwaigHandler" + parent: "SwaigFunction" + module: "SwaigFunction" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts" +--- +# `SwaigHandler` + +Handler function for a SWAIG tool invocation. + +## Signature + +```typescript +type SwaigHandler = (args: Record, rawData: Record) => FunctionResult | Record | string | Promise | string> +``` + +## Source + +[`src/SwaigFunction.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwaigFunction.ts) + +Line 19. diff --git a/fern/products/sdk-reference/typescript/swml-builder/index.mdx b/fern/products/sdk-reference/typescript/swml-builder/index.mdx new file mode 100644 index 0000000000..a12f57abca --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/swml-builder" +title: "SwmlBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `SwmlBuilder` + +## Signature + +```typescript +module SwmlBuilder +``` + +## Classes + + + + Builds SWML documents composed of verb instructions organized into named sections. + + + +## Interfaces + + + + Options for constructing a SwmlBuilder. + + + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder-options/index.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder-options/index.mdx new file mode 100644 index 0000000000..e8c143848a --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder-options/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder-options" +title: "SwmlBuilderOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilderOptions" + parent: "SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `SwmlBuilderOptions` + +Options for constructing a SwmlBuilder. + +## Signature + +```typescript +interface SwmlBuilderOptions +``` + +## Properties + + + When false, disables verb schema validation. Defaults to true unless `SWML_SKIP_SCHEMA_VALIDATION=true` is set in the environment. + + + + An initial SWML document to seed the builder with, enabling document injection. When provided, the builder uses this document instead of creating an empty one. This mirrors the Python SDK's pattern of injecting an SWMLService instance. + + + + Optional path to a custom SWML schema JSON file. When set, the builder uses a per-instance SchemaUtils loaded from this path instead of the bundled schema. Mirrors Python's `schema_path` constructor parameter on `SWMLService`/`AgentBase`. + + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 18. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/add-section.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/add-section.mdx new file mode 100644 index 0000000000..a1f46b757f --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/add-section.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.addSection" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `addSection` + +Creates a new empty named section in the document. +If the section already exists, this is a no-op. +Matches Python SDK's `add_section(section_name)`. + +## Signature + +```typescript +addSection(sectionName: string): this +``` + +## Parameters + + + The name of the section to create. + + +## Returns + +`this` — this for fluent chaining. + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 241. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/add-verb-to-section.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/add-verb-to-section.mdx new file mode 100644 index 0000000000..23331138f6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/add-verb-to-section.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/add-verb-to-section" +title: "addVerbToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.addVerbToSection" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `addVerbToSection` + +Appends a verb to a named section, creating the section if it does not exist. + +## Signature + +```typescript +addVerbToSection(sectionName: string, verbName: string, config: unknown): void +``` + +## Parameters + + + The target section name. + + + + The SWML verb name. + + + + The verb's configuration payload. + + +## Returns + +`void` + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 205. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/add-verb.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/add-verb.mdx new file mode 100644 index 0000000000..79af429427 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/add-verb.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/add-verb" +title: "addVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.addVerb" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `addVerb` + +Appends a verb to the main section. +Validates the verb config against the schema when validation is enabled. + +## Signature + +```typescript +addVerb(verbName: string, config: unknown): void +``` + +## Parameters + + + The SWML verb name (e.g., "answer", "ai"). + + + + The verb's configuration payload. + + +## Returns + +`void` + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 186. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/ai.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/ai.mdx new file mode 100644 index 0000000000..ea2a958ac6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/ai.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/ai" +title: "ai" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.ai" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `ai` + +Creates an AI agent that conducts voice conversations using automatic speech recognition (ASR), large language models (LLMs), and text-to-speech (TTS) synthesis. The agent processes caller speech in real-time, generates contextually appropriate responses, and can execute custom functions to interact with external systems through SignalWire AI Gateway (SWAIG). + +## Signature + +```typescript +ai(config?: AiVerbConfig): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 50. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/amazon-bedrock.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/amazon-bedrock.mdx new file mode 100644 index 0000000000..54d2755b3c --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/amazon-bedrock.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/amazon-bedrock" +title: "amazon_bedrock" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.amazon_bedrock" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `amazon_bedrock` + +Creates a new Bedrock AI Agent + +## Signature + +```typescript +amazon_bedrock(config?: unknown): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 52. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/answer.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/answer.mdx new file mode 100644 index 0000000000..b5ca427316 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/answer.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/answer" +title: "answer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.answer" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `answer` + +Answer incoming call and set an optional maximum duration. + +## Signature + +```typescript +answer(config?: { ...4 fields }): this +``` + +## Parameters + + + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 44. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/build.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/build.mdx new file mode 100644 index 0000000000..e401231d38 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/build.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/build" +title: "build" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.build" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `build` + +Alias for [getDocument](/reference/typescript/swml-builder/swml-builder/get-document). Matches the Python SDK's `build()` method. +Build and return the SWML document as a dictionary/object. + +## Signature + +```typescript +build(): Record +``` + +## Returns + +`Record` — The document with version and sections. + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 262. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/cond.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/cond.mdx new file mode 100644 index 0000000000..c58457119d --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/cond.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/cond" +title: "cond" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.cond" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `cond` + +Execute a sequence of instructions depending on the value of a JavaScript condition. + +## Signature + +```typescript +cond(config?: Record): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 54. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/connect.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/connect.mdx new file mode 100644 index 0000000000..cd4954ff69 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/connect.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/connect" +title: "connect" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.connect" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `connect` + +Dial a SIP URI or phone number. + +## Signature + +```typescript +connect(config: Record): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 56. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/constructor.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/constructor.mdx new file mode 100644 index 0000000000..599e7b4c8f --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.constructor" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `constructor` + +Creates a new SwmlBuilder. + +## Signature + +```typescript +constructor(opts?: SwmlBuilderOptions): SwmlBuilder +``` + +## Parameters + + + Optional configuration. + + +## Returns + +`SwmlBuilder` + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 72. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/denoise.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/denoise.mdx new file mode 100644 index 0000000000..163a6b93af --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/denoise.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/denoise" +title: "denoise" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.denoise" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `denoise` + +Start noise reduction. You can stop it at any time using `stop_denoise`. + +## Signature + +```typescript +denoise(config?: Record): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 58. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/detect-machine.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/detect-machine.mdx new file mode 100644 index 0000000000..cdc34a0349 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/detect-machine.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/detect-machine" +title: "detect_machine" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.detect_machine" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `detect_machine` + +A detection method that combines AMD (Answering Machine Detection) and fax detection. Detect whether the user on the other end of the call is a machine (fax, voicemail, etc.) or a human. The detection result(s) will be sent to the specified status\_url as a POST request and will also be saved in the detect\_result variable. + +## Signature + +```typescript +detect_machine(config?: { ...11 fields }): this +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 217. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/enter-queue.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/enter-queue.mdx new file mode 100644 index 0000000000..00382351e1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/enter-queue.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/enter-queue" +title: "enter_queue" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.enter_queue" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `enter_queue` + +Place the current call in a named queue where it will wait to be connected to an available agent or resource. While waiting, callers will hear music or custom audio. When an agent connects to the queue (using the connect method), the caller and agent are bridged together. After the bridge completes, execution continues with the SWML script specified in transfer\_after\_bridge. + +## Signature + +```typescript +enter_queue(config?: unknown): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 60. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/execute.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/execute.mdx new file mode 100644 index 0000000000..21a22020d9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/execute.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/execute" +title: "execute" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.execute" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `execute` + +Execute a specified section or URL as a subroutine, and upon completion, return to the current document. Use the return statement to pass any return values or objects back to the current document. + +## Signature + +```typescript +execute(config: { ...5 fields }): this +``` + +## Parameters + + + + + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 62. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/get-document.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/get-document.mdx new file mode 100644 index 0000000000..f6b8d2cb8e --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/get-document.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/get-document" +title: "getDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.getDocument" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `getDocument` + +Returns the raw SWML document object. + +## Signature + +```typescript +getDocument(): Record +``` + +## Returns + +`Record` — The document with version and sections. + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 252. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/get-schema-utils.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/get-schema-utils.mdx new file mode 100644 index 0000000000..fd8c563d53 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/get-schema-utils.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/get-schema-utils" +title: "getSchemaUtils" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.getSchemaUtils" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `getSchemaUtils` + +Get or create the shared SchemaUtils singleton. +Exposed for use by the type generator and tests. + +**Modifiers:** `static` + +## Signature + +```typescript +getSchemaUtils(): SchemaUtils +``` + +## Returns + +`SchemaUtils` + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 124. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/goto.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/goto.mdx new file mode 100644 index 0000000000..7754322d17 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/goto.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/goto" +title: "goto" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.goto" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `goto` + +Jump to a label within the current section, optionally based on a condition. The goto method will only navigate to a label within the same section. + +## Signature + +```typescript +goto(config: { ...3 fields }): this +``` + +## Parameters + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 69. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/hangup.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/hangup.mdx new file mode 100644 index 0000000000..be16346a7e --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/hangup.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/hangup" +title: "hangup" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.hangup" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `hangup` + +End the call with an optional reason. + +## Signature + +```typescript +hangup(config?: { ...1 fields }): this +``` + +## Parameters + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 82. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/index.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/index.mdx new file mode 100644 index 0000000000..28ffb9e308 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/index.mdx @@ -0,0 +1,265 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder" +title: "SwmlBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder" + parent: "SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `SwmlBuilder` + +Builds SWML documents composed of verb instructions organized into named sections. + +Verb methods (`.answer()`, `.play()`, `.hangup()`, `.transfer()`, etc.) are +auto-installed from the bundled SWML schema and all return `this` for fluent chaining. + +Most users don't instantiate `SwmlBuilder` directly — `AgentBase` uses it internally +and exposes higher-level helpers. Use this class directly for `SWMLService` (non-AI +call flows) or to hand-craft SWML returned from a route handler. + +## Signature + +```typescript +class SwmlBuilder +``` + +## Examples + +```typescript +import { SwmlBuilder } from '@signalwire/sdk'; + +const swml = new SwmlBuilder() + .answer() + .play({ url: 'https://cdn.example.com/greeting.mp3' }) + .hangup() + .build(); + +// swml is JSON ready to return from a SignalWire webhook. +``` + +## See Also + +- \- \[SWMLService]\(/reference/typescript/swml-service) — HTTP service that serves a built SWML document + \- \[AgentBase]\(/reference/typescript/agent-base) — for AI-driven call flows + +## Properties + + + Public read-only accessor for the underlying SWML document. Provides direct access to the document, equivalent to the Python SDK's `service` property on `SWMLBuilder`. + + +## Methods + + + + Creates a new empty named section in the document. If the section already exists, this is a no-op. Matches Python SDK's `add_section(section_name)`. + + + + Appends a verb to the main section. Validates the verb config against the schema when validation is enabled. + + + + Appends a verb to a named section, creating the section if it does not exist. + + + + Creates an AI agent that conducts voice conversations using automatic speech recognition (ASR), large language models (LLMs), and text-to-speech (TTS) synthesis. The agent processes caller speech in real-time, generates contextually appropriate responses, and can execute custom functions to interact with external systems through SignalWire AI Gateway (SWAIG). + + + + Creates a new Bedrock AI Agent + + + + Answer incoming call and set an optional maximum duration. + + + + Alias for [getDocument](/reference/typescript/swml-builder/swml-builder/get-document). Matches the Python SDK's `build()` method. Build and return the SWML document as a dictionary/object. + + + + Execute a sequence of instructions depending on the value of a JavaScript condition. + + + + Dial a SIP URI or phone number. + + + + Creates a new SwmlBuilder. + + + + Start noise reduction. You can stop it at any time using `stop_denoise`. + + + + A detection method that combines AMD (Answering Machine Detection) and fax detection. Detect whether the user on the other end of the call is a machine (fax, voicemail, etc.) or a human. The detection result(s) will be sent to the specified status\_url as a POST request and will also be saved in the detect\_result variable. + + + + Place the current call in a named queue where it will wait to be connected to an available agent or resource. While waiting, callers will hear music or custom audio. When an agent connects to the queue (using the connect method), the caller and agent are bridged together. After the bridge completes, execution continues with the SWML script specified in transfer\_after\_bridge. + + + + Execute a specified section or URL as a subroutine, and upon completion, return to the current document. Use the return statement to pass any return values or objects back to the current document. + + + + Returns the raw SWML document object. + + + + Get or create the shared SchemaUtils singleton. Exposed for use by the type generator and tests. + + + + Jump to a label within the current section, optionally based on a condition. The goto method will only navigate to a label within the same section. + + + + End the call with an optional reason. + + + + Join an ad-hoc audio conference started on either the SignalWire or Compatibility API. This method allows you to connect the current call to a named conference where multiple participants can communicate simultaneously. + + + + Join a RELAY room. If the room doesn't exist, it creates a new room. + + + + Mark any point of the SWML section with a label so that goto can jump to it. + + + + Start live transcription of the call. The transcription will be sent to the specified webhook URL. + + + + Start live translation of the call. The translation will be sent to the specified webhook URL. + + + + Enables secure payment processing during voice calls. When implemented, it manages the entire payment flow including data collection, validation, and processing through your configured payment gateway. + + + + Play file(s), ringtones, speech or silence. + + + + Play a prompt and wait for input. The input can be received either as digits from the keypad, or from speech, or both depending on what parameters are set. By default, only digit input is enabled. To enable speech input, set at least one speech parameter. To enable both digit and speech input, set at least one parameter for each. + + + + Receive a fax being delivered to this call. + + + + Record the call audio in the foreground, pausing further SWML execution until recording ends. Use this, for example, to record voicemails. To record calls in the background in a non-blocking fashion, use the record\_call method. + + + + Record call in the background. Unlike the record method, the record\_call method will start the recording and continue executing the SWML script while allowing the recording to happen in the background. To stop call recordings started with record\_call, use the stop\_record\_call method. + + + + Alias for [renderDocument](/reference/typescript/swml-builder/swml-builder/render-document). Matches the Python SDK's `render()` method. Build and render the SWML document as a JSON string. + + + + Serializes the SWML document to a JSON string. + + + + Send a GET, POST, PUT, or DELETE request to a remote URL. + + + + Resets the document to an empty SWML structure. + + + + Return a value from an execute call or exit the script. The value can be any type. + + + + Add a 'play' verb with say: prefix for text-to-speech. Convenience wrapper matching Python SDK's `say()` method. + + + + Send digit presses as DTMF tones. + + + + Send a fax. + + + + Send an outbound SMS or MMS message to a PSTN phone number. + + + + Set script variables to the specified values. Accepts an object mapping variable names to values. Variables set using set can be removed using unset. + + + + Enable or disable verb schema validation at runtime. Matches the Python `schema_validation` constructor parameter on AgentBase. + + + + Send SIP REFER to a SIP call. + + + + Pause execution for a specified duration. + + + + Stop noise reduction that was started with denoise. + + + + Stop an active background recording. + + + + Stop an active tap stream. + + + + Execute different instructions based on a variable's value. + + + + Start background call tap. Media is streamed over Websocket or RTP to customer controlled URI. + + + + Transfer the execution of the script to a different SWML section, URL, or Relay application. Once the transfer is complete, the script will continue executing SWML from the new location. + + + + Unset specified variables. The variables may have been set using the set method or as a byproduct of other statements or methods. Accepts a single variable name as a string or an array of variable names. + + + + Allows the user to set and send events to the connected client on the call. This is useful for triggering actions on the client side. Commonly used with the [browser-sdk](https://developer.signalwire.com/sdks/reference/browser-sdk/SignalWire%20Client/). The event object can be any valid JSON object. Any key-value pair in the object is sent to the client as an event type called `user_event`. + + + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 58. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/join-conference.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/join-conference.mdx new file mode 100644 index 0000000000..7ccfaacc81 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/join-conference.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/join-conference" +title: "join_conference" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.join_conference" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `join_conference` + +Join an ad-hoc audio conference started on either the SignalWire or Compatibility API. This method allows you to connect the current call to a named conference where multiple participants can communicate simultaneously. + +## Signature + +```typescript +join_conference(config?: unknown): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 88. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/join-room.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/join-room.mdx new file mode 100644 index 0000000000..27c60a07c4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/join-room.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/join-room" +title: "join_room" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.join_room" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `join_room` + +Join a RELAY room. If the room doesn't exist, it creates a new room. + +## Signature + +```typescript +join_room(config: { ...1 fields }): this +``` + +## Parameters + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 85. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/label.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/label.mdx new file mode 100644 index 0000000000..c5e6e076c5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/label.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/label" +title: "label" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.label" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `label` + +Mark any point of the SWML section with a label so that goto can jump to it. + +## Signature + +```typescript +label(value: string): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 74. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/live-transcribe.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/live-transcribe.mdx new file mode 100644 index 0000000000..f9b0fe47f0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/live-transcribe.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/live-transcribe" +title: "live_transcribe" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.live_transcribe" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `live_transcribe` + +Start live transcription of the call. The transcription will be sent to the specified webhook URL. + +## Signature + +```typescript +live_transcribe(config: { ...1 fields }): this +``` + +## Parameters + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 76. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/live-translate.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/live-translate.mdx new file mode 100644 index 0000000000..b5e3b7a35a --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/live-translate.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/live-translate" +title: "live_translate" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.live_translate" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `live_translate` + +Start live translation of the call. The translation will be sent to the specified webhook URL. + +## Signature + +```typescript +live_translate(config: { ...1 fields }): this +``` + +## Parameters + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 79. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/pay.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/pay.mdx new file mode 100644 index 0000000000..665e262fde --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/pay.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/pay" +title: "pay" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.pay" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `pay` + +Enables secure payment processing during voice calls. When implemented, it manages the entire payment flow including data collection, validation, and processing through your configured payment gateway. + +## Signature + +```typescript +pay(config: { ...18 fields }): this +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 197. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/play.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/play.mdx new file mode 100644 index 0000000000..b790bb3295 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/play.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/play" +title: "play" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.play" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `play` + +Play file(s), ringtones, speech or silence. + +## Signature + +```typescript +play(config?: PlayVerbConfig): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 90. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/prompt.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/prompt.mdx new file mode 100644 index 0000000000..dab49d028a --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/prompt.mdx @@ -0,0 +1,67 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/prompt" +title: "prompt" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.prompt" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `prompt` + +Play a prompt and wait for input. The input can be received either as digits from the keypad, or from speech, or both depending on what parameters are set. By default, only digit input is enabled. To enable speech input, set at least one speech parameter. To enable both digit and speech input, set at least one parameter for each. + +## Signature + +```typescript +prompt(config: { ...15 fields }): this +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 92. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/receive-fax.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/receive-fax.mdx new file mode 100644 index 0000000000..ae7ba6bddd --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/receive-fax.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/receive-fax" +title: "receive_fax" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.receive_fax" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `receive_fax` + +Receive a fax being delivered to this call. + +## Signature + +```typescript +receive_fax(config?: { ...1 fields }): this +``` + +## Parameters + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 109. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/record-call.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/record-call.mdx new file mode 100644 index 0000000000..76447908cd --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/record-call.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/record-call" +title: "record_call" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.record_call" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `record_call` + +Record call in the background. Unlike the record method, the record\_call method will start the recording and continue executing the SWML script while allowing the recording to happen in the background. To stop call recordings started with record\_call, use the stop\_record\_call method. + +## Signature + +```typescript +record_call(config?: { ...11 fields }): this +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 124. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/record.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/record.mdx new file mode 100644 index 0000000000..45610443d1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/record.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/record" +title: "record" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.record" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `record` + +Record the call audio in the foreground, pausing further SWML execution until recording ends. Use this, for example, to record voicemails. To record calls in the background in a non-blocking fashion, use the record\_call method. + +## Signature + +```typescript +record(config?: { ...10 fields }): this +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 112. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/render-document.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/render-document.mdx new file mode 100644 index 0000000000..fe9b65a720 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/render-document.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/render-document" +title: "renderDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.renderDocument" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `renderDocument` + +Serializes the SWML document to a JSON string. + +## Signature + +```typescript +renderDocument(): string +``` + +## Returns + +`string` — The JSON-encoded SWML document. + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 270. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/render.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/render.mdx new file mode 100644 index 0000000000..1ce5bba4a1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/render.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/render" +title: "render" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.render" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `render` + +Alias for [renderDocument](/reference/typescript/swml-builder/swml-builder/render-document). Matches the Python SDK's `render()` method. +Build and render the SWML document as a JSON string. + +## Signature + +```typescript +render(): string +``` + +## Returns + +`string` — The JSON-encoded SWML document. + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 280. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/request.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/request.mdx new file mode 100644 index 0000000000..8c73d5e247 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/request.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/request" +title: "request" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.request" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `request` + +Send a GET, POST, PUT, or DELETE request to a remote URL. + +## Signature + +```typescript +request(config: { ...7 fields }): this +``` + +## Parameters + + + + + + + + + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 137. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/reset.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/reset.mdx new file mode 100644 index 0000000000..e1f3c61d66 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/reset.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/reset" +title: "reset" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.reset" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `reset` + +Resets the document to an empty SWML structure. + +## Signature + +```typescript +reset(): this +``` + +## Returns + +`this` — this for fluent chaining. + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 175. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/return.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/return.mdx new file mode 100644 index 0000000000..cf352bd491 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/return.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/return" +title: "return" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.return" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `return` + +Return a value from an execute call or exit the script. The value can be any type. + +## Signature + +```typescript +return(config?: unknown): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 146. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/say.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/say.mdx new file mode 100644 index 0000000000..6f8c8f8b8a --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/say.mdx @@ -0,0 +1,52 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/say" +title: "say" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.say" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `say` + +Add a 'play' verb with say: prefix for text-to-speech. +Convenience wrapper matching Python SDK's `say()` method. + +## Signature + +```typescript +say(text: string, opts?: { ...4 fields }): this +``` + +## Parameters + + + Text to speak. + + + + Optional TTS parameters (voice, language, gender, volume). + + + + + + + + + + +## Returns + +`this` — this for fluent chaining. + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 220. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/send-digits.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/send-digits.mdx new file mode 100644 index 0000000000..8010d4d654 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/send-digits.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/send-digits" +title: "send_digits" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.send_digits" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `send_digits` + +Send digit presses as DTMF tones. + +## Signature + +```typescript +send_digits(config: { ...1 fields }): this +``` + +## Parameters + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 148. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/send-fax.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/send-fax.mdx new file mode 100644 index 0000000000..cba51e094f --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/send-fax.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/send-fax" +title: "send_fax" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.send_fax" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `send_fax` + +Send a fax. + +## Signature + +```typescript +send_fax(config: { ...4 fields }): this +``` + +## Parameters + + + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 151. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/send-sms.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/send-sms.mdx new file mode 100644 index 0000000000..470d901b13 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/send-sms.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/send-sms" +title: "send_sms" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.send_sms" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `send_sms` + +Send an outbound SMS or MMS message to a PSTN phone number. + +## Signature + +```typescript +send_sms(config: number | Record): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 157. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/set-validation.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/set-validation.mdx new file mode 100644 index 0000000000..d9d0ef66a1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/set-validation.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/set-validation" +title: "setValidation" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.setValidation" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts" +--- +# `setValidation` + +Enable or disable verb schema validation at runtime. +Matches the Python `schema_validation` constructor parameter on AgentBase. + +## Signature + +```typescript +setValidation(enabled: boolean): void +``` + +## Parameters + + + True to enable validation, false to disable. + + +## Returns + +`void` + +## Source + +[`src/SwmlBuilder.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlBuilder.ts) + +Line 112. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/set.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/set.mdx new file mode 100644 index 0000000000..324c12e29e --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/set.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/set" +title: "set" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.set" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `set` + +Set script variables to the specified values. Accepts an object mapping variable names to values. Variables set using set can be removed using unset. + +## Signature + +```typescript +set(config?: Record): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 159. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/sip-refer.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/sip-refer.mdx new file mode 100644 index 0000000000..720ee187e8 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/sip-refer.mdx @@ -0,0 +1,45 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/sip-refer" +title: "sip_refer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.sip_refer" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `sip_refer` + +Send SIP REFER to a SIP call. + +## Signature + +```typescript +sip_refer(config: { ...4 fields }): this +``` + +## Parameters + + + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 163. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/sleep.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/sleep.mdx new file mode 100644 index 0000000000..f80d3124f2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/sleep.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/sleep" +title: "sleep" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.sleep" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `sleep` + +Pause execution for a specified duration. + +## Signature + +```typescript +sleep(durationOrConfig: number | { duration: number }): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 161. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/stop-denoise.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/stop-denoise.mdx new file mode 100644 index 0000000000..de05b45658 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/stop-denoise.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/stop-denoise" +title: "stop_denoise" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.stop_denoise" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `stop_denoise` + +Stop noise reduction that was started with denoise. + +## Signature + +```typescript +stop_denoise(config?: Record): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 169. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/stop-record-call.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/stop-record-call.mdx new file mode 100644 index 0000000000..797a919dbf --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/stop-record-call.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/stop-record-call" +title: "stop_record_call" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.stop_record_call" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `stop_record_call` + +Stop an active background recording. + +## Signature + +```typescript +stop_record_call(config?: { ...1 fields }): this +``` + +## Parameters + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 171. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/stop-tap.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/stop-tap.mdx new file mode 100644 index 0000000000..753382c987 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/stop-tap.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/stop-tap" +title: "stop_tap" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.stop_tap" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `stop_tap` + +Stop an active tap stream. + +## Signature + +```typescript +stop_tap(config?: { ...1 fields }): this +``` + +## Parameters + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 174. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/switch.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/switch.mdx new file mode 100644 index 0000000000..7e545da984 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/switch.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/switch" +title: "switch" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.switch" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `switch` + +Execute different instructions based on a variable's value. + +## Signature + +```typescript +switch(config: { ...3 fields }): this +``` + +## Parameters + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 177. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/tap.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/tap.mdx new file mode 100644 index 0000000000..bee6f90bc2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/tap.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/tap" +title: "tap" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.tap" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `tap` + +Start background call tap. Media is streamed over Websocket or RTP to customer controlled URI. + +## Signature + +```typescript +tap(config: { ...6 fields }): this +``` + +## Parameters + + + + + + + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 182. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/transfer.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/transfer.mdx new file mode 100644 index 0000000000..ed9f8c8dd0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/transfer.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/transfer" +title: "transfer" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.transfer" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `transfer` + +Transfer the execution of the script to a different SWML section, URL, or Relay application. Once the transfer is complete, the script will continue executing SWML from the new location. + +## Signature + +```typescript +transfer(config: { ...3 fields }): this +``` + +## Parameters + + + + + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 190. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/unset.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/unset.mdx new file mode 100644 index 0000000000..2801dffa16 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/unset.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/unset" +title: "unset" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.unset" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `unset` + +Unset specified variables. The variables may have been set using the set method or as a byproduct of other statements or methods. Accepts a single variable name as a string or an array of variable names. + +## Signature + +```typescript +unset(config: number | Record): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 195. diff --git a/fern/products/sdk-reference/typescript/swml-builder/swml-builder/user-event.mdx b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/user-event.mdx new file mode 100644 index 0000000000..3814def16a --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-builder/swml-builder/user-event.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-builder/swml-builder/user-event" +title: "user_event" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SwmlBuilder.SwmlBuilder.user_event" + parent: "SwmlBuilder.SwmlBuilder" + module: "SwmlBuilder" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `user_event` + +Allows the user to set and send events to the connected client on the call. This is useful for triggering actions on the client side. Commonly used with the [browser-sdk](https://developer.signalwire.com/sdks/reference/browser-sdk/SignalWire%20Client/). The event object can be any valid JSON object. Any key-value pair in the object is sent to the client as an event type called `user_event`. + +## Signature + +```typescript +user_event(config: { ...1 fields }): this +``` + +## Parameters + + + + + +## Returns + +`this` + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 230. diff --git a/fern/products/sdk-reference/typescript/swml-handler/ai-verb-build-options/index.mdx b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-build-options/index.mdx new file mode 100644 index 0000000000..4a18e74fac --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-build-options/index.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/swml-handler/ai-verb-build-options" +title: "AIVerbBuildOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "SWMLHandler.AIVerbBuildOptions" + parent: "SWMLHandler" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `AIVerbBuildOptions` + +Options accepted by [AIVerbHandler.buildConfig](/reference/typescript/swml-handler/ai-verb-handler/build-config). + +## Signature + +```typescript +interface AIVerbBuildOptions +``` + +## Properties + + + Optional contexts and steps configuration (can be combined with text or pom). + + + + Optional post-prompt text. + + + + Optional URL for post-prompt processing. + + + + POM structure for the AI prompt (mutually exclusive with promptText). + + + + Text prompt for the AI (mutually exclusive with promptPom). + + + + Optional SWAIG configuration. + + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 67. diff --git a/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/build-config.mdx b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/build-config.mdx new file mode 100644 index 0000000000..045393633d --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/build-config.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/swml-handler/ai-verb-handler/build-config" +title: "buildConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.AIVerbHandler.buildConfig" + parent: "SWMLHandler.AIVerbHandler" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `buildConfig` + +Build a configuration for the AI verb. + +Requires exactly one of `promptText` or `promptPom` (mutually exclusive). +Throws an `Error` if both or neither are provided. + +Extra keys in `opts` are routed as follows: + +- `languages`, `hints`, `pronounce`, `globalData` / `global_data` are placed at the top level of the config. +- All other extra keys are placed into `config.params`. + +## Signature + +```typescript +buildConfig(opts: AIVerbBuildOptions = {}): Record +``` + +## Parameters + + + Build options for the AI verb configuration. + + +## Returns + +`Record` — AI verb configuration dictionary. + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 167. diff --git a/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/constructor.mdx b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/constructor.mdx new file mode 100644 index 0000000000..f3f8f2726a --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/constructor.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/typescript/swml-handler/ai-verb-handler/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.AIVerbHandler.constructor" + parent: "SWMLHandler.AIVerbHandler" + module: "SWMLHandler" +--- +# `constructor` + +## Signature + +```typescript +constructor(): AIVerbHandler +``` + +## Returns + +`AIVerbHandler` diff --git a/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/get-verb-name.mdx b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/get-verb-name.mdx new file mode 100644 index 0000000000..8944841293 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/get-verb-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/swml-handler/ai-verb-handler/get-verb-name" +title: "getVerbName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.AIVerbHandler.getVerbName" + parent: "SWMLHandler.AIVerbHandler" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `getVerbName` + +Get the name of the verb this handler handles. + +## Signature + +```typescript +getVerbName(): string +``` + +## Returns + +`string` — "ai" as the verb name. + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 90. diff --git a/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/index.mdx b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/index.mdx new file mode 100644 index 0000000000..edcae8ae16 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/swml-handler/ai-verb-handler" +title: "AIVerbHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "SWMLHandler.AIVerbHandler" + parent: "SWMLHandler" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `AIVerbHandler` + +Handler for the SWML 'ai' verb. + +## Signature + +```typescript +class AIVerbHandler extends SWMLVerbHandler +``` + +## Inheritance + +**Extends:** [SWMLVerbHandler](/reference/typescript/swml-handler/swml-verb-handler) + +## Methods + + + + Build a configuration for the AI verb. + + + + + + Get the name of the verb this handler handles. + + + + Validate the configuration for the AI verb. + + + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 85. diff --git a/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/validate-config.mdx b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/validate-config.mdx new file mode 100644 index 0000000000..7c3597a3c3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/ai-verb-handler/validate-config.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/swml-handler/ai-verb-handler/validate-config" +title: "validateConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.AIVerbHandler.validateConfig" + parent: "SWMLHandler.AIVerbHandler" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `validateConfig` + +Validate the configuration for the AI verb. + +Checks that: + +- `prompt` is present and is an object +- `prompt` contains exactly one of `text` or `pom` (mutually exclusive) +- `prompt.contexts`, if present, is an object +- `SWAIG`, if present, is an object + +## Signature + +```typescript +validateConfig(config: Record): [boolean, string[]] +``` + +## Parameters + + + The configuration dictionary for the AI verb. + + +## Returns + +`[boolean, string[]]` — A \[isValid, errorMessages] tuple. + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 106. diff --git a/fern/products/sdk-reference/typescript/swml-handler/index.mdx b/fern/products/sdk-reference/typescript/swml-handler/index.mdx new file mode 100644 index 0000000000..1c890f0d4f --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/swml-handler" +title: "SWMLHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `SWMLHandler` + +## Signature + +```typescript +module SWMLHandler +``` + +## Classes + + + + Handler for the SWML 'ai' verb. + + + + Abstract base class for pluggable SWML verb handlers. + + + + Registry for SWML verb handlers. + + + +## Interfaces + + + + Options accepted by [AIVerbHandler.buildConfig](/reference/typescript/swml-handler/ai-verb-handler/build-config). + + + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/build-config.mdx b/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/build-config.mdx new file mode 100644 index 0000000000..3153e5bbac --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/build-config.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/swml-handler/swml-verb-handler/build-config" +title: "buildConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.SWMLVerbHandler.buildConfig" + parent: "SWMLHandler.SWMLVerbHandler" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `buildConfig` + +Build a configuration object for this verb from the provided arguments. + +**Modifiers:** `abstract` + +## Signature + +```typescript +buildConfig(opts: Record): Record +``` + +## Parameters + + + Key-value arguments specific to this verb. + + +## Returns + +`Record` — A configuration dictionary ready for inclusion in a SWML document. + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 63. diff --git a/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/constructor.mdx b/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/constructor.mdx new file mode 100644 index 0000000000..ea4a16fa92 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/constructor.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/typescript/swml-handler/swml-verb-handler/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.SWMLVerbHandler.constructor" + parent: "SWMLHandler.SWMLVerbHandler" + module: "SWMLHandler" +--- +# `constructor` + +## Signature + +```typescript +constructor(): SWMLVerbHandler +``` + +## Returns + +`SWMLVerbHandler` diff --git a/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/get-verb-name.mdx b/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/get-verb-name.mdx new file mode 100644 index 0000000000..a5d2d95cdc --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/get-verb-name.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/swml-handler/swml-verb-handler/get-verb-name" +title: "getVerbName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.SWMLVerbHandler.getVerbName" + parent: "SWMLHandler.SWMLVerbHandler" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `getVerbName` + +Get the name of the SWML verb this handler handles. + +**Modifiers:** `abstract` + +## Signature + +```typescript +getVerbName(): string +``` + +## Returns + +`string` — The verb name as a string (e.g. "ai", "play"). + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 48. diff --git a/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/index.mdx b/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/index.mdx new file mode 100644 index 0000000000..0ce7b49ff3 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/index.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/typescript/swml-handler/swml-verb-handler" +title: "SWMLVerbHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "SWMLHandler.SWMLVerbHandler" + parent: "SWMLHandler" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `SWMLVerbHandler` + +Abstract base class for pluggable SWML verb handlers. + +Each concrete handler owns one verb name and provides validate/build +logic for that verb's configuration. Subclass this to create handlers +for custom or complex SWML verbs that require specialized handling +beyond generic schema-driven validation. + +**Modifiers:** `abstract` + +## Signature + +```typescript +class SWMLVerbHandler +``` + +## Examples + +```typescript +class MyVerbHandler extends SWMLVerbHandler { + getVerbName(): string { return 'my_verb'; } + validateConfig(config: Record): [boolean, string[]] { + const errors: string[] = []; + if (!config['url']) errors.push("Missing required field 'url'"); + return [errors.length === 0, errors]; + } + buildConfig(opts: Record): Record { + return { url: opts['url'] }; + } +} +``` + +## Methods + + + + Build a configuration object for this verb from the provided arguments. + + + + + + Get the name of the SWML verb this handler handles. + + + + Validate the configuration for this verb. + + + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 43. diff --git a/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/validate-config.mdx b/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/validate-config.mdx new file mode 100644 index 0000000000..e1aa482240 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/swml-verb-handler/validate-config.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/swml-handler/swml-verb-handler/validate-config" +title: "validateConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.SWMLVerbHandler.validateConfig" + parent: "SWMLHandler.SWMLVerbHandler" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `validateConfig` + +Validate the configuration for this verb. + +**Modifiers:** `abstract` + +## Signature + +```typescript +validateConfig(config: Record): [boolean, string[]] +``` + +## Parameters + + + The configuration dictionary for this verb. + + +## Returns + +`[boolean, string[]]` — A `[isValid, errorMessages]` tuple where `isValid` is `true` when the config is valid and `errorMessages` lists any issues found. + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 56. diff --git a/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/constructor.mdx b/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/constructor.mdx new file mode 100644 index 0000000000..234330b5a2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/constructor.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/swml-handler/verb-handler-registry/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.VerbHandlerRegistry.constructor" + parent: "SWMLHandler.VerbHandlerRegistry" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `constructor` + +Initialize the registry with default handlers. + +## Signature + +```typescript +constructor(): VerbHandlerRegistry +``` + +## Returns + +`VerbHandlerRegistry` + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 267. diff --git a/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/get-handler.mdx b/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/get-handler.mdx new file mode 100644 index 0000000000..649aee1c2f --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/get-handler.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-handler/verb-handler-registry/get-handler" +title: "getHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.VerbHandlerRegistry.getHandler" + parent: "SWMLHandler.VerbHandlerRegistry" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `getHandler` + +Get the handler for a specific verb. + +## Signature + +```typescript +getHandler(verbName: string): SWMLVerbHandler | undefined +``` + +## Parameters + + + The name of the verb (e.g. "ai"). + + +## Returns + +`SWMLVerbHandler | undefined` — The handler if found, or `undefined` otherwise. + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 286. diff --git a/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/has-handler.mdx b/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/has-handler.mdx new file mode 100644 index 0000000000..859c2f51ae --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/has-handler.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-handler/verb-handler-registry/has-handler" +title: "hasHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.VerbHandlerRegistry.hasHandler" + parent: "SWMLHandler.VerbHandlerRegistry" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `hasHandler` + +Check if a handler exists for a specific verb. + +## Signature + +```typescript +hasHandler(verbName: string): boolean +``` + +## Parameters + + + The name of the verb. + + +## Returns + +`boolean` — `true` if a handler is registered for the verb, `false` otherwise. + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 295. diff --git a/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/index.mdx b/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/index.mdx new file mode 100644 index 0000000000..d4cdd8c41e --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/swml-handler/verb-handler-registry" +title: "VerbHandlerRegistry" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "SWMLHandler.VerbHandlerRegistry" + parent: "SWMLHandler" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `VerbHandlerRegistry` + +Registry for SWML verb handlers. + +This class maintains a registry of handlers for special SWML verbs +and provides methods for accessing and using them. The "ai" verb handler +([AIVerbHandler](/reference/typescript/swml-handler/ai-verb-handler)) is registered automatically on construction. + +## Signature + +```typescript +class VerbHandlerRegistry +``` + +## Examples + +```typescript +const registry = new VerbHandlerRegistry(); + +// The "ai" handler is already registered +registry.hasHandler('ai'); // true + +// Register a custom handler +registry.registerHandler(new MyCustomVerbHandler()); + +// Look up a handler +const handler = registry.getHandler('ai'); +if (handler) { + const [valid, errors] = handler.validateConfig(config); +} +``` + +## Methods + + + + Initialize the registry with default handlers. + + + + Get the handler for a specific verb. + + + + Check if a handler exists for a specific verb. + + + + Register a new verb handler, replacing any existing handler for the same verb name. + + + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 263. diff --git a/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/register-handler.mdx b/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/register-handler.mdx new file mode 100644 index 0000000000..85a36ef32f --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-handler/verb-handler-registry/register-handler.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-handler/verb-handler-registry/register-handler" +title: "registerHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLHandler.VerbHandlerRegistry.registerHandler" + parent: "SWMLHandler.VerbHandlerRegistry" + module: "SWMLHandler" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts" +--- +# `registerHandler` + +Register a new verb handler, replacing any existing handler for the same verb name. + +## Signature + +```typescript +registerHandler(handler: SWMLVerbHandler): void +``` + +## Parameters + + + The handler to register. + + +## Returns + +`void` + +## Source + +[`src/SWMLHandler.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLHandler.ts) + +Line 276. diff --git a/fern/products/sdk-reference/typescript/swml-service/index.mdx b/fern/products/sdk-reference/typescript/swml-service/index.mdx new file mode 100644 index 0000000000..5db9815dc9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/index.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/swml-service" +title: "SWMLService" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `SWMLService` + +## Signature + +```typescript +module SWMLService +``` + +## Type Aliases + + + + Callback invoked per-request to dynamically build SWML. + + + +## Classes + + + + Unified security configuration. Mirrors Python SDK's `SecurityConfig` — reads from env vars and optional config file. + + + + HTTP service that serves non-AI SWML documents built from verb methods. + + + + Registry for custom SWML verb handlers. Mirrors Python SDK's `VerbHandlerRegistry`. + + + +## Interfaces + + + + Configuration options for SWMLService. + + + + Interface for custom SWML verb handlers. Mirrors Python SDK's `SWMLVerbHandler` abstract base class. + + + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/swml-service/on-request-callback.mdx b/fern/products/sdk-reference/typescript/swml-service/on-request-callback.mdx new file mode 100644 index 0000000000..72fbaf4d58 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/on-request-callback.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/swml-service/on-request-callback" +title: "OnRequestCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "SWMLService.OnRequestCallback" + parent: "SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `OnRequestCallback` + +Callback invoked per-request to dynamically build SWML. + +## Signature + +```typescript +type OnRequestCallback = (queryParams: Record, bodyParams: Record, headers: Record) => SwmlBuilder | Promise +``` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 140. diff --git a/fern/products/sdk-reference/typescript/swml-service/security-config/constructor.mdx b/fern/products/sdk-reference/typescript/swml-service/security-config/constructor.mdx new file mode 100644 index 0000000000..8fc2cbeb36 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/security-config/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-service/security-config/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SecurityConfig.constructor" + parent: "SWMLService.SecurityConfig" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `constructor` + +## Signature + +```typescript +constructor(opts?: { ...2 fields }): SecurityConfig +``` + +## Parameters + + + + + + + +## Returns + +`SecurityConfig` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 82. diff --git a/fern/products/sdk-reference/typescript/swml-service/security-config/get-basic-auth.mdx b/fern/products/sdk-reference/typescript/swml-service/security-config/get-basic-auth.mdx new file mode 100644 index 0000000000..ecae6b415a --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/security-config/get-basic-auth.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/swml-service/security-config/get-basic-auth" +title: "getBasicAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SecurityConfig.getBasicAuth" + parent: "SWMLService.SecurityConfig" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getBasicAuth` + +Get basic auth credentials from security config, or null if not configured. + +## Signature + +```typescript +getBasicAuth(): [string, string] | null +``` + +## Returns + +`[string, string] | null` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 121. diff --git a/fern/products/sdk-reference/typescript/swml-service/security-config/index.mdx b/fern/products/sdk-reference/typescript/swml-service/security-config/index.mdx new file mode 100644 index 0000000000..a4956e7b22 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/security-config/index.mdx @@ -0,0 +1,70 @@ +--- +slug: "/reference/typescript/swml-service/security-config" +title: "SecurityConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "SWMLService.SecurityConfig" + parent: "SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `SecurityConfig` + +Unified security configuration. +Mirrors Python SDK's `SecurityConfig` — reads from env vars and optional config file. + +## Signature + +```typescript +class SecurityConfig +``` + +## Properties + + + Basic auth password from config, or null. + + + + Basic auth username from config, or null. + + + + Domain name for SSL. + + + + Filesystem path to the PEM certificate. + + + + Whether SSL is enabled. + + + + Filesystem path to the PEM private key. + + +## Methods + + + + + + Get basic auth credentials from security config, or null if not configured. + + + + Validate that SSL cert and key files are present when SSL is enabled. + + + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 66. diff --git a/fern/products/sdk-reference/typescript/swml-service/security-config/validate-ssl-config.mdx b/fern/products/sdk-reference/typescript/swml-service/security-config/validate-ssl-config.mdx new file mode 100644 index 0000000000..7b543dfe38 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/security-config/validate-ssl-config.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/swml-service/security-config/validate-ssl-config" +title: "validateSslConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SecurityConfig.validateSslConfig" + parent: "SWMLService.SecurityConfig" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `validateSslConfig` + +Validate that SSL cert and key files are present when SSL is enabled. + +## Signature + +```typescript +validateSslConfig(): [boolean, string | null] +``` + +## Returns + +`[boolean, string | null]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 129. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service-options/index.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service-options/index.mdx new file mode 100644 index 0000000000..a4e9b64666 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service-options/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/swml-service/swml-service-options" +title: "SWMLServiceOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "SWMLService.SWMLServiceOptions" + parent: "SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `SWMLServiceOptions` + +Configuration options for SWMLService. + +## Signature + +```typescript +interface SWMLServiceOptions +``` + +## Properties + + + Basic auth credentials as \[username, password]. + + + + Path to a security configuration file. + + + + Host to bind the web server to (default '0.0.0.0'). + + + + Service display name. Required to match Python SDK where `name` is a positional required parameter. + + + + Port to bind the web server to (default PORT env var or 3000). + + + + HTTP route path (default '/'). + + + + Path to a JSON Schema file for verb validation. + + + + Enable schema validation (default true). Can also be disabled via SWML\_SKIP\_SCHEMA\_VALIDATION=true. + + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 155. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/add-section.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/add-section.mdx new file mode 100644 index 0000000000..cdd10b0eac --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/add-section.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/add-section" +title: "addSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.addSection" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addSection` + +Add a new named section to the SWML document. +Mirrors Python's `add_section()`. + +## Signature + +```typescript +addSection(sectionName: string): this +``` + +## Parameters + + + Name of the section to create. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 653. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/add-verb-to-section.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/add-verb-to-section.mdx new file mode 100644 index 0000000000..c36a55e422 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/add-verb-to-section.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/add-verb-to-section" +title: "addVerbToSection" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.addVerbToSection" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerbToSection` + +Add a verb to a specific named section. +Mirrors Python's `add_verb_to_section()`. + +## Signature + +```typescript +addVerbToSection(sectionName: string, verbName: string, config: unknown): this +``` + +## Parameters + + + Target section name (auto-created if missing). + + + + Verb name. + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 669. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/add-verb.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/add-verb.mdx new file mode 100644 index 0000000000..d244bca08c --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/add-verb.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/add-verb" +title: "addVerb" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.addVerb" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `addVerb` + +Add a verb to the SWML document. + +## Signature + +```typescript +addVerb(name: string, config: unknown): this +``` + +## Parameters + + + Verb name (e.g., 'answer', 'play', 'hangup'). + + + + Verb configuration. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 642. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/as-router.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/as-router.mdx new file mode 100644 index 0000000000..91fcd2000c --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/as-router.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/as-router" +title: "asRouter" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.asRouter" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `asRouter` + +Alias for `getApp()`. Provided for cross-SDK consistency with Python's +`as_router()` method — allows Python callers porting to TypeScript to use +the familiar name without changes. + +## Signature + +```typescript +asRouter(): Hono +``` + +## Returns + +`Hono` — The configured Hono app. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 908. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/build-swml-for-request.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/build-swml-for-request.mdx new file mode 100644 index 0000000000..7ee7d43a26 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/build-swml-for-request.mdx @@ -0,0 +1,60 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/build-swml-for-request" +title: "buildSwmlForRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.buildSwmlForRequest" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `buildSwmlForRequest` + +Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` +to fully replace the document for this request, or `null` to fall +through to `setOnRequestCallback` or the static builder. + +This is distinct from the WebMixin `onRequest(requestData, +callbackPath)` hook on AgentBase (which mirrors Python's +`on_request -> on_swml_request` modification-merge contract). +Use this hook when you want to swap the entire SWML builder; use +`onRequest` / `onSwmlRequest` on AgentBase when you want to merge +targeted modifications into the rendered document. + +Default implementation returns `null` (no-op). + +## Signature + +```typescript +buildSwmlForRequest( + _queryParams: Record, + _bodyParams: Record, + _headers: Record, + _callbackPath?: string +): SwmlBuilder | null +``` + +## Parameters + + + + + + + + + +## Returns + +`SwmlBuilder | null` — A `SwmlBuilder` whose document is sent as the response, or `null` to delegate to the next handler in the chain. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 834. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/constructor.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/constructor.mdx new file mode 100644 index 0000000000..cd060b5eb5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/constructor.mdx @@ -0,0 +1,58 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.constructor" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + deprecated: true +--- +# `constructor` + + + **Deprecated.** Prefer passing an options object with a required `name`. The no-arg form defaults name to 'swml-service'. + + +## Signature + + + + ```typescript + constructor(opts: SWMLServiceOptions): SWMLService + ``` + + + + ```typescript + constructor(opts?: Partial): SWMLService + ``` + + + +## Parameters (Overload 1) + + + +## Parameters (Overload 2) + + + +## Returns (Overload 1) + +`SWMLService` + +## Returns (Overload 2) + +`SWMLService` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 263. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/define-tool.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/define-tool.mdx new file mode 100644 index 0000000000..a878b97c85 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/define-tool.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/define-tool" +title: "defineTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.defineTool" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `defineTool` + +Define a SWAIG function the AI can call. Tool descriptions and +parameter descriptions are LLM-facing prompt engineering — see +PORTING\_GUIDE for guidance on writing them. + +Accepts the full SwaigFunctionOptions surface so AgentBase's richer +call sites (fillers, secure tokens, wait files, extra fields) work +without overriding this method on the subclass. + +## Signature + +```typescript +defineTool(opts: SwaigFunctionOptions): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 465. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/extract-sip-username.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/extract-sip-username.mdx new file mode 100644 index 0000000000..7f81116c6f --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/extract-sip-username.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/extract-sip-username" +title: "extractSipUsername" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.extractSipUsername" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `extractSipUsername` + +Extract the SIP username from a request body's call.to field. +Mirrors Python's `@staticmethod extract_sip_username()`. + +**Modifiers:** `static` + +## Signature + +```typescript +extractSipUsername(requestBody: Record): string | null +``` + +## Parameters + + + The parsed request body containing call information. + + +## Returns + +`string | null` — The extracted SIP username, or null if not found. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 787. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/get-all-functions.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-all-functions.mdx new file mode 100644 index 0000000000..4f595725c2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-all-functions.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/get-all-functions" +title: "getAllFunctions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.getAllFunctions" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getAllFunctions` + +Snapshot of all registered SWAIG functions keyed by name. +(Python parity: `ToolRegistry.get_all_functions`.) + +## Signature + +```typescript +getAllFunctions(): Record> +``` + +## Returns + +`Record>` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 529. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/get-app.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-app.mdx new file mode 100644 index 0000000000..c9d87ef6bf --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-app.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/get-app" +title: "getApp" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.getApp" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getApp` + +Get the Hono application for mounting or testing. +This is the TypeScript equivalent of Python's `as_router()`, which returns +a FastAPI `APIRouter`. Both expose the underlying app/router so callers can +mount it into a larger framework. Use `asRouter()` when porting Python code +that calls `as_router()` directly. + +## Signature + +```typescript +getApp(): Hono +``` + +## Returns + +`Hono` — The configured Hono app. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 898. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/get-basic-auth-credentials.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-basic-auth-credentials.mdx new file mode 100644 index 0000000000..1036e4ed3a --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-basic-auth-credentials.mdx @@ -0,0 +1,62 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/get-basic-auth-credentials" +title: "getBasicAuthCredentials" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.getBasicAuthCredentials" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getBasicAuthCredentials` + +Get the basic-auth credentials used by this service. +Mirrors Python's `get_basic_auth_credentials()`. + +## Signature + + + + ```typescript + getBasicAuthCredentials(includeSource?: false): [string, string] + ``` + + + + ```typescript + getBasicAuthCredentials( + includeSource: true + ): [string, string, "provided" | "environment" | "generated"] + ``` + + + +## Parameters (Overload 1) + + + When true, a third element indicating the credential source is appended. + + +## Parameters (Overload 2) + + + When true, a third element indicating the credential source is appended. + + +## Returns (Overload 1) + +`[string, string]` — A tuple of \[username, password] or \[username, password, source]. + +## Returns (Overload 2) + +`[string, string, "provided" | "environment" | "generated"]` — A tuple of \[username, password] or \[username, password, source]. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 863. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/get-builder.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-builder.mdx new file mode 100644 index 0000000000..33e02f4754 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-builder.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/get-builder" +title: "getBuilder" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.getBuilder" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getBuilder` + +Get the underlying SwmlBuilder for direct manipulation. + +## Signature + +```typescript +getBuilder(): SwmlBuilder +``` + +## Returns + +`SwmlBuilder` — The SwmlBuilder instance. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 632. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/get-document.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-document.mdx new file mode 100644 index 0000000000..5bd215cec2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/get-document" +title: "getDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.getDocument" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getDocument` + +Get the SWML document as a dictionary. +Alias for `renderSwml()` that matches Python's `get_document()` name. + +## Signature + +```typescript +getDocument(): Record +``` + +## Returns + +`Record` — The SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 706. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/get-function.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-function.mdx new file mode 100644 index 0000000000..63b84174b6 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/get-function" +title: "getFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.getFunction" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getFunction` + +Get a registered SWAIG function entry, or undefined. +(Python parity: `ToolRegistry.get_function`.) + +## Signature + +```typescript +getFunction(name: string): Record | SwaigFunction | undefined +``` + +## Parameters + + + +## Returns + +`Record | SwaigFunction | undefined` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 523. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/get-registered-tools.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-registered-tools.mdx new file mode 100644 index 0000000000..73fb42de1c --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-registered-tools.mdx @@ -0,0 +1,36 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/get-registered-tools" +title: "getRegisteredTools" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.getRegisteredTools" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getRegisteredTools` + +Get a summary of all registered tools with their names, descriptions, and +parameter schemas. Lifted from AgentBase so the swaig-test CLI can list +tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG +host). + +## Signature + +```typescript +getRegisteredTools(): { description: string; name: string; parameters: Record }[] +``` + +## Returns + +`{ description: string; name: string; parameters: Record }[]` — Array of tool descriptors. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 557. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/get-tool.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-tool.mdx new file mode 100644 index 0000000000..88e1cadb3a --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/get-tool.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/get-tool" +title: "getTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.getTool" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getTool` + +Look up a registered SwaigFunction by name. Lifted from AgentBase so +`swaig-test --exec ` works against a non-AgentBase SWMLService +target. + +## Signature + +```typescript +getTool(name: string): SwaigFunction | undefined +``` + +## Parameters + + + The tool name to search for. + + +## Returns + +`SwaigFunction | undefined` — The SwaigFunction instance, or undefined if not found or not a SwaigFunction. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 581. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/has-function.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/has-function.mdx new file mode 100644 index 0000000000..be86b73ff7 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/has-function.mdx @@ -0,0 +1,38 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/has-function" +title: "hasFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.hasFunction" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasFunction` + +Whether a SWAIG function with the given name is registered. +(Python parity: `ToolRegistry.has_function`.) + +## Signature + +```typescript +hasFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 517. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/has-tool.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/has-tool.mdx new file mode 100644 index 0000000000..7c61ff452d --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/has-tool.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/has-tool" +title: "hasTool" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.hasTool" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasTool` + +Whether a tool with the given name is registered. + +## Signature + +```typescript +hasTool(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 511. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/index.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/index.mdx new file mode 100644 index 0000000000..a9cc62b07f --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/index.mdx @@ -0,0 +1,258 @@ +--- +slug: "/reference/typescript/swml-service/swml-service" +title: "SWMLService" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "SWMLService.SWMLService" + parent: "SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `SWMLService` + +HTTP service that serves non-AI SWML documents built from verb methods. + +Use `SWMLService` when you need a SignalWire call flow but don't need AI — +plain call routing, IVR-style trees, recording workflows, static playback, etc. +For AI-powered voice agents, use [AgentBase](/reference/typescript/agent-base) instead. + +## Signature + +```typescript +class SWMLService +``` + +## Examples + +```typescript +import { SWMLService } from '@signalwire/sdk'; + +const service = new SWMLService({ name: 'greeter', route: '/', port: 3000 }); +service.builder + .answer() + .play({ url: 'https://cdn.example.com/welcome.mp3' }) + .hangup(); + +await service.serve(); +``` + +## See Also + +- \- \[SwmlBuilder]\(/reference/typescript/swml-builder) — the underlying SWML document builder + \- \[AgentBase]\(/reference/typescript/agent-base) — AI-powered alternative + +## Properties + + + + + + + Domain name for SSL. Mirrors Python's `self.domain`. + + + + Check if full JSON Schema validation is enabled. Mirrors Python's `@property full_validation_enabled`. + + + + Host the server binds to. + + + + Structured logger, exposed for subclass access. Mirrors Python's public `self.log`. + + + + Service display name. + + + + + + Port the server binds to. + + + + HTTP route path. + + + + Schema validation utilities. Mirrors Python's `self.schema_utils`. + + + + Unified security configuration. Mirrors Python's `self.security`. + + + + Path to SSL certificate. Mirrors Python's `self.ssl_cert_path`. + + + + Whether SSL is enabled. Mirrors Python's `self.ssl_enabled`. + + + + Path to SSL private key. Mirrors Python's `self.ssl_key_path`. + + + + + + + + Custom verb handler registry. Mirrors Python's `self.verb_registry`. + + +## Methods + + + + Add a new named section to the SWML document. Mirrors Python's `add_section()`. + + + + Add a verb to the SWML document. + + + + Add a verb to a specific named section. Mirrors Python's `add_verb_to_section()`. + + + + Alias for `getApp()`. Provided for cross-SDK consistency with Python's `as_router()` method — allows Python callers porting to TypeScript to use the familiar name without changes. + + + + Service-side SWML-builder hook. Subclasses return a `SwmlBuilder` to fully replace the document for this request, or `null` to fall through to `setOnRequestCallback` or the static builder. + + + + + + Define a SWAIG function the AI can call. Tool descriptions and parameter descriptions are LLM-facing prompt engineering — see PORTING\_GUIDE for guidance on writing them. + + + + Extract the SIP username from a request body's call.to field. Mirrors Python's `@staticmethod extract_sip_username()`. + + + + Snapshot of all registered SWAIG functions keyed by name. (Python parity: `ToolRegistry.get_all_functions`.) + + + + Get the Hono application for mounting or testing. This is the TypeScript equivalent of Python's `as_router()`, which returns a FastAPI `APIRouter`. Both expose the underlying app/router so callers can mount it into a larger framework. Use `asRouter()` when porting Python code that calls `as_router()` directly. + + + + Get the basic-auth credentials used by this service. Mirrors Python's `get_basic_auth_credentials()`. + + + + Get the underlying SwmlBuilder for direct manipulation. + + + + Get the SWML document as a dictionary. Alias for `renderSwml()` that matches Python's `get_document()` name. + + + + Get a registered SWAIG function entry, or undefined. (Python parity: `ToolRegistry.get_function`.) + + + + Get a summary of all registered tools with their names, descriptions, and parameter schemas. Lifted from AgentBase so the swaig-test CLI can list tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG host). + + + + Look up a registered SwaigFunction by name. Lifted from AgentBase so `swaig-test --exec ` works against a non-AgentBase SWMLService target. + + + + Whether a SWAIG function with the given name is registered. (Python parity: `ToolRegistry.has_function`.) + + + + Whether a tool with the given name is registered. + + + + List registered tool names in insertion order (Map preserves it). + + + + Manually set the proxy base URL used for webhook URL generation. Mirrors Python's `manual_set_proxy_url()`. + + + + Dispatch a function call to the registered handler. Returns null when the function isn't registered or has no handler. Subclasses (AgentBase) override to add session-token validation and FunctionResult-shape normalization. Return type is wide enough to accommodate the agent override (which may also return void shapes for fire-and-forget tool calls). + + + + Extension point: register additional Hono routes after SWMLService mounts /health, /ready, /swaig, and the main route. AgentBase uses this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + + + + Register a routing callback at a given path. When a POST request arrives at `path`, the callback is invoked with the parsed request body. If it returns a string, the response is a 307 redirect to that route; if it returns null, normal SWML serving continues. Mirrors Python's `register_routing_callback()`. + + + + Register a SwaigFunction instance or a raw function descriptor (DataMap). + + + + Register a custom verb handler. Mirrors Python's `register_verb_handler()`. + + + + Remove a registered SWAIG function. Returns true when removed, false when not found. (Python parity: `ToolRegistry.remove_function`.) + + + + Render the SWML document as a JSON string. Mirrors Python's `render_document()`. + + + + Render the SWML document. + + + + Reset the SWML document to an empty state. Mirrors Python's `reset_document()`. + + + + Start the HTTP server. + + + + Start the HTTP server. Alias for [run](/reference/typescript/swml-service/swml-service/run) provided for cross-SDK consistency with Python's `serve()` method — callers porting from Python can use this name without changes. + + + + Set a callback invoked per-request to dynamically build SWML. When set, the static SwmlBuilder is ignored and the callback's returned SwmlBuilder is used instead. + + + + Stop the HTTP server. Mirrors Python's `stop()`. + + + + Extension point: invoked between argument parsing and function dispatch on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is non-null, it's returned directly without dispatching. AgentBase may override to add session-token validation or ephemeral dynamic-config. + + + + Validate provided basic-auth credentials against the configured ones using a constant-time comparison. (Python parity: `AuthMixin.validate_basic_auth(username, password)`.) + + + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 202. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/list-tool-names.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/list-tool-names.mdx new file mode 100644 index 0000000000..0feee7e50d --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/list-tool-names.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/list-tool-names" +title: "listToolNames" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.listToolNames" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `listToolNames` + +List registered tool names in insertion order (Map preserves it). + +## Signature + +```typescript +listToolNames(): string[] +``` + +## Returns + +`string[]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 545. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/manual-set-proxy-url.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/manual-set-proxy-url.mdx new file mode 100644 index 0000000000..6880007605 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/manual-set-proxy-url.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/manual-set-proxy-url" +title: "manualSetProxyUrl" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.manualSetProxyUrl" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `manualSetProxyUrl` + +Manually set the proxy base URL used for webhook URL generation. +Mirrors Python's `manual_set_proxy_url()`. + +## Signature + +```typescript +manualSetProxyUrl(url: string): this +``` + +## Parameters + + + The external-facing base URL (trailing slashes are stripped). + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 879. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/on-function-call.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/on-function-call.mdx new file mode 100644 index 0000000000..0358f4917d --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/on-function-call.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/on-function-call" +title: "onFunctionCall" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.onFunctionCall" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `onFunctionCall` + +Dispatch a function call to the registered handler. +Returns null when the function isn't registered or has no handler. +Subclasses (AgentBase) override to add session-token validation +and FunctionResult-shape normalization. Return type is wide enough +to accommodate the agent override (which may also return void +shapes for fire-and-forget tool calls). + +## Signature + +```typescript +onFunctionCall( + name: string, + args: Record, + rawData: Record +): string | void | Record | FunctionResult | Promise | FunctionResult> | null | undefined +``` + +## Parameters + + + + + + + +## Returns + +`string | void | Record | FunctionResult | Promise | FunctionResult> | null | undefined` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 490. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/register-additional-routes.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/register-additional-routes.mdx new file mode 100644 index 0000000000..a0e7c1e3fd --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/register-additional-routes.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/register-additional-routes" +title: "registerAdditionalRoutes" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.registerAdditionalRoutes" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `registerAdditionalRoutes` + +Extension point: register additional Hono routes after SWMLService +mounts /health, /ready, /swaig, and the main route. AgentBase uses +this to add /post\_prompt, /check\_for\_input, /debug\_events, /mcp. + +## Signature + +```typescript +registerAdditionalRoutes(_app: Hono): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 604. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/register-routing-callback.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/register-routing-callback.mdx new file mode 100644 index 0000000000..40d7515d10 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/register-routing-callback.mdx @@ -0,0 +1,50 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/register-routing-callback" +title: "registerRoutingCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.registerRoutingCallback" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerRoutingCallback` + +Register a routing callback at a given path. +When a POST request arrives at `path`, the callback is invoked with the +parsed request body. If it returns a string, the response is a 307 redirect +to that route; if it returns null, normal SWML serving continues. +Mirrors Python's `register_routing_callback()`. + +## Signature + +```typescript +registerRoutingCallback( + callbackFn: RoutingCallback, + path: string = '/sip' +): void +``` + +## Parameters + + + Callback receiving the request body and returning a route or null. + + + + HTTP path for the callback (default '/sip'). + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 742. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/register-swaig-function.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/register-swaig-function.mdx new file mode 100644 index 0000000000..7819522d73 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/register-swaig-function.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/register-swaig-function" +title: "registerSwaigFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.registerSwaigFunction" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerSwaigFunction` + +Register a SwaigFunction instance or a raw function descriptor (DataMap). + +## Signature + +```typescript +registerSwaigFunction(fn: Record | SwaigFunction): this +``` + +## Parameters + + + +## Returns + +`this` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 472. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/register-verb-handler.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/register-verb-handler.mdx new file mode 100644 index 0000000000..79a166e81f --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/register-verb-handler.mdx @@ -0,0 +1,40 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/register-verb-handler" +title: "registerVerbHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.registerVerbHandler" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerVerbHandler` + +Register a custom verb handler. +Mirrors Python's `register_verb_handler()`. + +## Signature + +```typescript +registerVerbHandler(handler: SWMLVerbHandler): void +``` + +## Parameters + + + The verb handler to register. + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 726. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/remove-function.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/remove-function.mdx new file mode 100644 index 0000000000..9bbd340cf5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/remove-function.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/remove-function" +title: "removeFunction" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.removeFunction" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `removeFunction` + +Remove a registered SWAIG function. Returns true when removed, +false when not found. (Python parity: +`ToolRegistry.remove_function`.) + +## Signature + +```typescript +removeFunction(name: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 540. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/render-document.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/render-document.mdx new file mode 100644 index 0000000000..f718a7917b --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/render-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/render-document" +title: "renderDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.renderDocument" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `renderDocument` + +Render the SWML document as a JSON string. +Mirrors Python's `render_document()`. + +## Signature + +```typescript +renderDocument(): string +``` + +## Returns + +`string` — JSON-encoded SWML document. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 715. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/render-swml.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/render-swml.mdx new file mode 100644 index 0000000000..41825e4017 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/render-swml.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/render-swml" +title: "renderSwml" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.renderSwml" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `renderSwml` + +Render the SWML document. + +Subclass-override-friendly signature: AgentBase overrides this with +`(callId?: string, modifications?: Record): string` +to return a serialized JSON string built from prompts + dynamic config. +Plain SWMLService returns the in-memory document object. + +## Signature + +```typescript +renderSwml( + _callId?: string, + _modifications?: Record +): string | Record +``` + +## Parameters + + + + + +## Returns + +`string | Record` — The SWML document (object) or its serialized form (subclass). + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 694. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/reset-document.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/reset-document.mdx new file mode 100644 index 0000000000..cb62bcfa4e --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/reset-document.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/reset-document" +title: "resetDocument" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.resetDocument" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `resetDocument` + +Reset the SWML document to an empty state. +Mirrors Python's `reset_document()`. + +## Signature + +```typescript +resetDocument(): this +``` + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 679. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/run.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/run.mdx new file mode 100644 index 0000000000..76cd87ef8d --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/run.mdx @@ -0,0 +1,69 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/run" +title: "run" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.run" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `run` + +Start the HTTP server. + +Matches Python's `serve()` parameters including SSL options. When +`SWAIG_CLI_MODE=true` is set in the environment (e.g. while running the +`swaig-test` CLI) the call is a no-op. + +## Signature + +```typescript +run( + hostOrOpts?: string | { domain?: string; host?: string; port?: number; sslCert?: string; sslEnabled?: boolean; sslKey?: string }, + port?: number, + opts?: { ...4 fields } +): Promise +``` + +## Parameters + + + + + Port. Defaults to `this.port` (constructor value) or `3000`. + + + + Optional SSL/TLS configuration overrides. + + + Domain used for HSTS header configuration. + + + + Path to the PEM certificate file. + + + + When `true`, serve over HTTPS. + + + + Path to the PEM private key file. + + + +## Returns + +`Promise` — Resolves once the server has begun listening. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 929. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/serve.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/serve.mdx new file mode 100644 index 0000000000..2304f82024 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/serve.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/serve" +title: "serve" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.serve" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `serve` + +Start the HTTP server. Alias for [run](/reference/typescript/swml-service/swml-service/run) provided for cross-SDK +consistency with Python's `serve()` method — callers porting from +Python can use this name without changes. + +## Signature + +```typescript +serve( + ...args: [hostOrOpts: string | { domain?: string; host?: string; port?: number; sslCert?: string; sslEnabled?: boolean; sslKey?: string }, port: number, opts: { domain?: string; sslCert?: string; sslEnabled?: boolean; sslKey?: string }] +): Promise +``` + +## Parameters + + + Forwarded unchanged to [run](/reference/typescript/swml-service/swml-service/run). + + +## Returns + +`Promise` — Resolves once the server has begun listening. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 1001. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/set-on-request-callback.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/set-on-request-callback.mdx new file mode 100644 index 0000000000..0ff403eae0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/set-on-request-callback.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/set-on-request-callback" +title: "setOnRequestCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.setOnRequestCallback" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `setOnRequestCallback` + +Set a callback invoked per-request to dynamically build SWML. +When set, the static SwmlBuilder is ignored and the callback's +returned SwmlBuilder is used instead. + +## Signature + +```typescript +setOnRequestCallback(cb: OnRequestCallback): this +``` + +## Parameters + + + Callback receiving query params, body params, and headers. + + +## Returns + +`this` — This service for chaining. + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 850. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/stop.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/stop.mdx new file mode 100644 index 0000000000..b0f7545fc9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/stop.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.stop" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `stop` + +Stop the HTTP server. +Mirrors Python's `stop()`. + +## Signature + +```typescript +stop(): void +``` + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 1009. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/swaig-pre-dispatch.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/swaig-pre-dispatch.mdx new file mode 100644 index 0000000000..d1b58edefa --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/swaig-pre-dispatch.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/swaig-pre-dispatch" +title: "swaigPreDispatch" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.swaigPreDispatch" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" + visibility: "protected" +--- +# `swaigPreDispatch` + +Extension point: invoked between argument parsing and function dispatch +on POST /swaig. Returns \[target, shortCircuit]: when shortCircuit is +non-null, it's returned directly without dispatching. AgentBase may +override to add session-token validation or ephemeral dynamic-config. + +## Signature + +```typescript +swaigPreDispatch( + _requestData: Record, + _funcName: string +): [SWMLService, unknown] +``` + +## Parameters + + + + + +## Returns + +`[SWMLService, unknown]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 592. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-service/validate-basic-auth.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-service/validate-basic-auth.mdx new file mode 100644 index 0000000000..6a27f03b7c --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-service/validate-basic-auth.mdx @@ -0,0 +1,44 @@ +--- +slug: "/reference/typescript/swml-service/swml-service/validate-basic-auth" +title: "validateBasicAuth" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLService.validateBasicAuth" + parent: "SWMLService.SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `validateBasicAuth` + +Validate provided basic-auth credentials against the configured ones +using a constant-time comparison. (Python parity: +`AuthMixin.validate_basic_auth(username, password)`.) + +## Signature + +```typescript +validateBasicAuth( + username: string, + password: string +): boolean | Promise +``` + +## Parameters + + + + + +## Returns + +`boolean | Promise` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 241. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/build-config.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/build-config.mdx new file mode 100644 index 0000000000..0843d3f1e2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/build-config.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-service/swml-verb-handler/build-config" +title: "buildConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLVerbHandler.buildConfig" + parent: "SWMLService.SWMLVerbHandler" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `buildConfig` + +Build a verb configuration from keyword arguments. + +## Signature + +```typescript +buildConfig(kwargs: Record): Record +``` + +## Parameters + + + +## Returns + +`Record` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 34. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/get-verb-name.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/get-verb-name.mdx new file mode 100644 index 0000000000..6b669fa9be --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/get-verb-name.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/swml-service/swml-verb-handler/get-verb-name" +title: "getVerbName" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLVerbHandler.getVerbName" + parent: "SWMLService.SWMLVerbHandler" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getVerbName` + +Return the verb name this handler manages. + +## Signature + +```typescript +getVerbName(): string +``` + +## Returns + +`string` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 30. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/index.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/index.mdx new file mode 100644 index 0000000000..3f4283cbaf --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/index.mdx @@ -0,0 +1,46 @@ +--- +slug: "/reference/typescript/swml-service/swml-verb-handler" +title: "SWMLVerbHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "SWMLService.SWMLVerbHandler" + parent: "SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `SWMLVerbHandler` + +Interface for custom SWML verb handlers. +Mirrors Python SDK's `SWMLVerbHandler` abstract base class. + +## Signature + +```typescript +interface SWMLVerbHandler +``` + +## Methods + + + + Build a verb configuration from keyword arguments. + + + + Return the verb name this handler manages. + + + + Validate a verb configuration. Returns \[isValid, errorMessages]. + + + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 28. diff --git a/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/validate-config.mdx b/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/validate-config.mdx new file mode 100644 index 0000000000..2dcd25e2a0 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/swml-verb-handler/validate-config.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-service/swml-verb-handler/validate-config" +title: "validateConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.SWMLVerbHandler.validateConfig" + parent: "SWMLService.SWMLVerbHandler" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `validateConfig` + +Validate a verb configuration. Returns \[isValid, errorMessages]. + +## Signature + +```typescript +validateConfig(config: Record): [boolean, string[]] +``` + +## Parameters + + + +## Returns + +`[boolean, string[]]` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 32. diff --git a/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/constructor.mdx b/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/constructor.mdx new file mode 100644 index 0000000000..6893038867 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/constructor.mdx @@ -0,0 +1,24 @@ +--- +slug: "/reference/typescript/swml-service/verb-handler-registry/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.VerbHandlerRegistry.constructor" + parent: "SWMLService.VerbHandlerRegistry" + module: "SWMLService" +--- +# `constructor` + +## Signature + +```typescript +constructor(): VerbHandlerRegistry +``` + +## Returns + +`VerbHandlerRegistry` diff --git a/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/get-handler.mdx b/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/get-handler.mdx new file mode 100644 index 0000000000..ef64564535 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/get-handler.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-service/verb-handler-registry/get-handler" +title: "getHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.VerbHandlerRegistry.getHandler" + parent: "SWMLService.VerbHandlerRegistry" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `getHandler` + +Get the handler for a specific verb, or undefined if none registered. + +## Signature + +```typescript +getHandler(verbName: string): SWMLVerbHandler | undefined +``` + +## Parameters + + + +## Returns + +`SWMLVerbHandler | undefined` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 50. diff --git a/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/has-handler.mdx b/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/has-handler.mdx new file mode 100644 index 0000000000..8c1b56b9bb --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/has-handler.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-service/verb-handler-registry/has-handler" +title: "hasHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.VerbHandlerRegistry.hasHandler" + parent: "SWMLService.VerbHandlerRegistry" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `hasHandler` + +Check whether a handler exists for the given verb. + +## Signature + +```typescript +hasHandler(verbName: string): boolean +``` + +## Parameters + + + +## Returns + +`boolean` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 55. diff --git a/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/index.mdx b/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/index.mdx new file mode 100644 index 0000000000..be7d1d2add --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/index.mdx @@ -0,0 +1,48 @@ +--- +slug: "/reference/typescript/swml-service/verb-handler-registry" +title: "VerbHandlerRegistry" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "SWMLService.VerbHandlerRegistry" + parent: "SWMLService" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `VerbHandlerRegistry` + +Registry for custom SWML verb handlers. +Mirrors Python SDK's `VerbHandlerRegistry`. + +## Signature + +```typescript +class VerbHandlerRegistry +``` + +## Methods + + + + + + Get the handler for a specific verb, or undefined if none registered. + + + + Check whether a handler exists for the given verb. + + + + Register a custom verb handler. + + + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 41. diff --git a/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/register-handler.mdx b/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/register-handler.mdx new file mode 100644 index 0000000000..0249171e61 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-service/verb-handler-registry/register-handler.mdx @@ -0,0 +1,37 @@ +--- +slug: "/reference/typescript/swml-service/verb-handler-registry/register-handler" +title: "registerHandler" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "SWMLService.VerbHandlerRegistry.registerHandler" + parent: "SWMLService.VerbHandlerRegistry" + module: "SWMLService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts" +--- +# `registerHandler` + +Register a custom verb handler. + +## Signature + +```typescript +registerHandler(handler: SWMLVerbHandler): void +``` + +## Parameters + + + +## Returns + +`void` + +## Source + +[`src/SWMLService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SWMLService.ts) + +Line 45. diff --git a/fern/products/sdk-reference/typescript/swml-verb-methods.generated/ai-verb-config/index.mdx b/fern/products/sdk-reference/typescript/swml-verb-methods.generated/ai-verb-config/index.mdx new file mode 100644 index 0000000000..7691d02064 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-verb-methods.generated/ai-verb-config/index.mdx @@ -0,0 +1,51 @@ +--- +slug: "/reference/typescript/swml-verb-methods.generated/ai-verb-config" +title: "AiVerbConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "SwmlVerbMethods.generated.AiVerbConfig" + parent: "SwmlVerbMethods.generated" + module: "SwmlVerbMethods.generated" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `AiVerbConfig` + +AUTO-GENERATED FILE — do not edit manually. +Generated by: npx tsx src/generateVerbTypes.ts + +Provides TypeScript interface augmentation for all SWML verb methods +auto-installed on SwmlBuilder from schema.json. + +## Signature + +```typescript +interface AiVerbConfig +``` + +## Properties + + + Optional post-prompt text sent to the LLM after the conversation ends. + + + + URL to receive post-prompt status callbacks. + + + + Text prompt for the AI agent (mutually exclusive with prompt when using POM). + + + + SignalWire AI Gateway (SWAIG) configuration for custom function/tool definitions. + + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 11. diff --git a/fern/products/sdk-reference/typescript/swml-verb-methods.generated/index.mdx b/fern/products/sdk-reference/typescript/swml-verb-methods.generated/index.mdx new file mode 100644 index 0000000000..eb79c25544 --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-verb-methods.generated/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/swml-verb-methods.generated" +title: "SwmlVerbMethods.generated" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "SwmlVerbMethods.generated" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `SwmlVerbMethods.generated` + +## Signature + +```typescript +module SwmlVerbMethods.generated +``` + +## Interfaces + + + + AUTO-GENERATED FILE — do not edit manually. Generated by: npx tsx src/generateVerbTypes.ts + + + + + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/swml-verb-methods.generated/play-verb-config/index.mdx b/fern/products/sdk-reference/typescript/swml-verb-methods.generated/play-verb-config/index.mdx new file mode 100644 index 0000000000..fb9eba0b5a --- /dev/null +++ b/fern/products/sdk-reference/typescript/swml-verb-methods.generated/play-verb-config/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/swml-verb-methods.generated/play-verb-config" +title: "PlayVerbConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "SwmlVerbMethods.generated.PlayVerbConfig" + parent: "SwmlVerbMethods.generated" + module: "SwmlVerbMethods.generated" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts" +--- +# `PlayVerbConfig` + +## Signature + +```typescript +interface PlayVerbConfig +``` + +## Properties + + + If true, auto-answer the call before playing audio. Default true. + + + + Gender for text-to-speech ("male" or "female"). + + + + Language code for text-to-speech (e.g. "en-US"). + + + + Voice name to use for text-to-speech (e.g. "Polly.Joanna"). + + + + Single URL to play (mutually exclusive with urls). + + + + Array of URLs to play (mutually exclusive with url). + + + + Volume level for audio playback. Valid range -40 to 40. Default 0. + + +## Source + +[`src/SwmlVerbMethods.generated.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/SwmlVerbMethods.generated.ts) + +Line 24. diff --git a/fern/products/sdk-reference/typescript/type-inference/create-typed-handler-wrapper.mdx b/fern/products/sdk-reference/typescript/type-inference/create-typed-handler-wrapper.mdx new file mode 100644 index 0000000000..b35afea562 --- /dev/null +++ b/fern/products/sdk-reference/typescript/type-inference/create-typed-handler-wrapper.mdx @@ -0,0 +1,55 @@ +--- +slug: "/reference/typescript/type-inference/create-typed-handler-wrapper" +title: "createTypedHandlerWrapper" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "TypeInference.createTypedHandlerWrapper" + parent: "TypeInference" + module: "TypeInference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts" +--- +# `createTypedHandlerWrapper` + +Create a wrapper function that adapts a typed handler to the standard +`(args, rawData) => result` SWAIG handler signature. + +The wrapper extracts named parameters from the args dict and passes them +as positional arguments to the original function. + +## Signature + +```typescript +createTypedHandlerWrapper( + fn: Function, + paramNames: string[], + hasRawData: boolean +): SwaigHandler +``` + +## Parameters + + + The typed handler whose parameters match `paramNames` in order. + + + + Ordered list of parameter names extracted from `fn`, produced by [inferSchema](/reference/typescript/type-inference/infer-schema). + + + + When `true`, the raw-data record is appended as the final positional argument to mirror the old-style handler shape. + + +## Returns + +`SwaigHandler` — A [SwaigHandler](/reference/typescript/swaig-function/swaig-handler) suitable for registration with [AgentBase.defineTool](/reference/typescript/agent-base/agent-base/define-tool). + +## Source + +[`src/TypeInference.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts) + +Line 187. diff --git a/fern/products/sdk-reference/typescript/type-inference/index.mdx b/fern/products/sdk-reference/typescript/type-inference/index.mdx new file mode 100644 index 0000000000..6c8cbb4a47 --- /dev/null +++ b/fern/products/sdk-reference/typescript/type-inference/index.mdx @@ -0,0 +1,53 @@ +--- +slug: "/reference/typescript/type-inference" +title: "TypeInference" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "TypeInference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts" +--- +# `TypeInference` + +## Signature + +```typescript +module TypeInference +``` + +## Functions + + + + Create a wrapper function that adapts a typed handler to the standard `(args, rawData) => result` SWAIG handler signature. + + + + Infer a JSON Schema from a function's parameters. + + + + Parse function parameter names and default values from source code. + + + +## Interfaces + + + + Result of schema inference from a function. + + + + A parsed function parameter with optional default value. + + + +## Source + +[`src/TypeInference.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/type-inference/infer-schema.mdx b/fern/products/sdk-reference/typescript/type-inference/infer-schema.mdx new file mode 100644 index 0000000000..cd1a915ea4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/type-inference/infer-schema.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/type-inference/infer-schema" +title: "inferSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "TypeInference.inferSchema" + parent: "TypeInference" + module: "TypeInference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts" +--- +# `inferSchema` + +Infer a JSON Schema from a function's parameters. + +Extracts parameter names and infers JSON Schema types from default-value +literals: + +- Number literals → `"integer"` (whole numbers) or `"number"` (decimals) +- String literals → `"string"` +- Boolean literals → `"boolean"` +- No default → `"string"` (and the parameter is marked required) + +## Signature + +```typescript +inferSchema(fn: Function): InferredSchema | null +``` + +## Parameters + + + The function to inspect. Arrow functions, regular functions, and method shorthand all work. + + +## Returns + +`InferredSchema | null` — An [InferredSchema](/reference/typescript/type-inference/inferred-schema) describing the parameters, or `null` when the function looks like an old-style `(args, rawData)` SWAIG handler (in which case no inference is attempted). + +## Source + +[`src/TypeInference.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts) + +Line 111. diff --git a/fern/products/sdk-reference/typescript/type-inference/inferred-schema/index.mdx b/fern/products/sdk-reference/typescript/type-inference/inferred-schema/index.mdx new file mode 100644 index 0000000000..bd3545c044 --- /dev/null +++ b/fern/products/sdk-reference/typescript/type-inference/inferred-schema/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/type-inference/inferred-schema" +title: "InferredSchema" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "TypeInference.InferredSchema" + parent: "TypeInference" + module: "TypeInference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts" +--- +# `InferredSchema` + +Result of schema inference from a function. + +## Signature + +```typescript +interface InferredSchema +``` + +## Properties + + + Whether the function accepts a rawData parameter. + + + + JSON Schema properties keyed by parameter name. + + + + Ordered parameter names (excluding rawData). + + + + List of required parameter names (those without defaults). + + +## Source + +[`src/TypeInference.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts) + +Line 18. diff --git a/fern/products/sdk-reference/typescript/type-inference/parse-function-params.mdx b/fern/products/sdk-reference/typescript/type-inference/parse-function-params.mdx new file mode 100644 index 0000000000..f39540a3d1 --- /dev/null +++ b/fern/products/sdk-reference/typescript/type-inference/parse-function-params.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/type-inference/parse-function-params" +title: "parseFunctionParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "TypeInference.parseFunctionParams" + parent: "TypeInference" + module: "TypeInference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts" +--- +# `parseFunctionParams` + +Parse function parameter names and default values from source code. + +Handles arrow functions, regular functions, and method shorthand. + +## Signature + +```typescript +parseFunctionParams(source: string): ParsedParam[] +``` + +## Parameters + + + The function source text, typically from `fn.toString()`. + + +## Returns + +`ParsedParam[]` — An array of `{ name, defaultValue? }` records in declaration order. Returns an empty array if no parameter list is present. + +## Source + +[`src/TypeInference.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts) + +Line 38. diff --git a/fern/products/sdk-reference/typescript/type-inference/parsed-param/index.mdx b/fern/products/sdk-reference/typescript/type-inference/parsed-param/index.mdx new file mode 100644 index 0000000000..92d208176c --- /dev/null +++ b/fern/products/sdk-reference/typescript/type-inference/parsed-param/index.mdx @@ -0,0 +1,35 @@ +--- +slug: "/reference/typescript/type-inference/parsed-param" +title: "ParsedParam" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "TypeInference.ParsedParam" + parent: "TypeInference" + module: "TypeInference" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts" +--- +# `ParsedParam` + +A parsed function parameter with optional default value. + +## Signature + +```typescript +interface ParsedParam +``` + +## Properties + + + + + +## Source + +[`src/TypeInference.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/TypeInference.ts) + +Line 12. diff --git a/fern/products/sdk-reference/typescript/types/agent-options/index.mdx b/fern/products/sdk-reference/typescript/types/agent-options/index.mdx new file mode 100644 index 0000000000..872e601d65 --- /dev/null +++ b/fern/products/sdk-reference/typescript/types/agent-options/index.mdx @@ -0,0 +1,119 @@ +--- +slug: "/reference/typescript/types/agent-options" +title: "AgentOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "types.AgentOptions" + parent: "types" + module: "types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts" +--- +# `AgentOptions` + +Configuration options for constructing an AgentBase instance. + +## Signature + +```typescript +interface AgentOptions +``` + +## Properties + + + Unique identifier for this agent instance; auto-generated if omitted. + + + + Whether to automatically insert an "answer" verb in the SWML call flow (defaults to true). + + + + Explicit basic-auth credentials as \[username, password]; auto-generated if omitted. + + + + Whether to enable the check-for-input override endpoint. When true, a `/check_for_input` route is registered that allows external callers to inject input checks at runtime. Defaults to false. + + + + Path to a JSON configuration file. When provided, the file is loaded at construction time and its `service` section can override name, route, host, and port (constructor arguments still take precedence over file values). + + + + Default webhook URL for SWAIG function callbacks. + + + + Whether to enable the post-prompt override endpoint. When true, a `/post_prompt_override` route is registered that allows external callers to replace the post-prompt text at runtime. Defaults to false. + + + + Hostname to bind the HTTP server to (defaults to "0.0.0.0"). + + + + Display name of the agent, also used as default basic-auth username when credentials are auto-generated. + + + + List of native function names to include in the SWAIG configuration. + + + + Port number for the HTTP server (defaults to env PORT or 3000). + + + + Whether to record the call (defaults to false). + + + + Recording format, e.g. "mp4" (defaults to "mp4"). + + + + Whether to record in stereo (defaults to true). + + + + HTTP route path the agent listens on (defaults to "/"). + + + + Path to a JSON Schema file for SWML validation. When provided, rendered SWML documents are validated against this schema. Falls back to the built-in schema if omitted. + + + + Whether to validate rendered SWML against the schema. Can also be disabled via the `SWML_SKIP_SCHEMA_VALIDATION` env var. Defaults to true. + + + + SignalWire Signing Key for verifying inbound webhook signatures. When set, AgentBase auto-mounts the webhook signature validation middleware on POST /, /swaig, and /post\_prompt; unsigned or mis-signed requests are rejected with 403. Falls back to the `SIGNALWIRE_SIGNING_KEY` environment variable when omitted. When both are unset, signature validation is disabled and the agent emits a one-time warning on startup so operators notice. Per `porting-sdk/webhooks.md`: this MUST be treated as secret — never logged, never echoed to clients, never included in error messages. + + + + When true, suppresses all log output. + + + + Session token expiry in seconds (defaults to 3600). + + + + Whether to use POM-based prompt rendering (defaults to true). + + + + When true, the webhook validation middleware honors `X-Forwarded-Proto` / `X-Forwarded-Host` headers when reconstructing the public URL the platform POSTed to. Default false because proxy headers are spoofable; opt in only when you control the proxy. The `SWML_PROXY_URL_BASE` env var always takes precedence over both forwarded headers and the raw request URL. + + +## Source + +[`src/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts) + +Line 6. diff --git a/fern/products/sdk-reference/typescript/types/dynamic-config-callback.mdx b/fern/products/sdk-reference/typescript/types/dynamic-config-callback.mdx new file mode 100644 index 0000000000..654c5c381e --- /dev/null +++ b/fern/products/sdk-reference/typescript/types/dynamic-config-callback.mdx @@ -0,0 +1,34 @@ +--- +slug: "/reference/typescript/types/dynamic-config-callback" +title: "DynamicConfigCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "types.DynamicConfigCallback" + parent: "types" + module: "types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts" +--- +# `DynamicConfigCallback` + +Callback invoked on each SWML request to dynamically modify an ephemeral copy of the agent. + +The ephemeral agent is typed as `import('./AgentBase.js').AgentBase` at +call sites but kept as a generic type parameter here to avoid a circular +import between `types.ts` and `AgentBase.ts`. Cast or import the type +explicitly at the call site if you need specific methods. + +## Signature + +```typescript +type DynamicConfigCallback = (queryParams: Record, bodyParams: Record, headers: Record, agent: TAgent) => void | Promise +``` + +## Source + +[`src/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts) + +Line 155. diff --git a/fern/products/sdk-reference/typescript/types/function-include/index.mdx b/fern/products/sdk-reference/typescript/types/function-include/index.mdx new file mode 100644 index 0000000000..2243fe71a9 --- /dev/null +++ b/fern/products/sdk-reference/typescript/types/function-include/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/types/function-include" +title: "FunctionInclude" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "types.FunctionInclude" + parent: "types" + module: "types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts" +--- +# `FunctionInclude` + +Reference to an external SWAIG function endpoint to include in the AI configuration. + +## Signature + +```typescript +interface FunctionInclude +``` + +## Properties + + + List of function names available at the remote endpoint. + + + + Optional metadata to pass along with the include. + + + + URL of the remote SWAIG endpoint. + + +## Source + +[`src/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts) + +Line 133. diff --git a/fern/products/sdk-reference/typescript/types/index.mdx b/fern/products/sdk-reference/typescript/types/index.mdx new file mode 100644 index 0000000000..dd1a8c98d5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/types/index.mdx @@ -0,0 +1,57 @@ +--- +slug: "/reference/typescript/types" +title: "types" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts" +--- +# `types` + +## Signature + +```typescript +module types +``` + +## Type Aliases + + + + Callback invoked on each SWML request to dynamically modify an ephemeral copy of the agent. + + + + Callback invoked when a post-prompt summary is received at the end of a call. + + + +## Interfaces + + + + Configuration options for constructing an AgentBase instance. + + + + Reference to an external SWAIG function endpoint to include in the AI configuration. + + + + Configuration for a supported language in the AI agent. + + + + Rule for overriding how the TTS engine pronounces a specific word or phrase. + + + +## Source + +[`src/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/types/language-config/index.mdx b/fern/products/sdk-reference/typescript/types/language-config/index.mdx new file mode 100644 index 0000000000..bdedcd66da --- /dev/null +++ b/fern/products/sdk-reference/typescript/types/language-config/index.mdx @@ -0,0 +1,63 @@ +--- +slug: "/reference/typescript/types/language-config" +title: "LanguageConfig" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "types.LanguageConfig" + parent: "types" + module: "types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts" +--- +# `LanguageConfig` + +Configuration for a supported language in the AI agent. + +## Signature + +```typescript +interface LanguageConfig +``` + +## Properties + + + BCP-47 language code (e.g. "en-US"). + + + + TTS engine identifier. + + + + Filler phrases keyed by category for this language. + + + + Per-function filler phrases, keyed by function name then language code. + + + + Human-readable language name (e.g. "English"). + + + + Optional per-language params dict (engine-specific tuning, voice settings, etc.). Emitted as the language object's `params` key in SWML — only present in the wire payload when non-empty so existing entries remain byte-identical when no params are passed. + + + + Speech recognition model identifier. + + + + Voice identifier to use for this language. + + +## Source + +[`src/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts) + +Line 98. diff --git a/fern/products/sdk-reference/typescript/types/pronunciation-rule/index.mdx b/fern/products/sdk-reference/typescript/types/pronunciation-rule/index.mdx new file mode 100644 index 0000000000..50beb8b12c --- /dev/null +++ b/fern/products/sdk-reference/typescript/types/pronunciation-rule/index.mdx @@ -0,0 +1,43 @@ +--- +slug: "/reference/typescript/types/pronunciation-rule" +title: "PronunciationRule" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "types.PronunciationRule" + parent: "types" + module: "types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts" +--- +# `PronunciationRule` + +Rule for overriding how the TTS engine pronounces a specific word or phrase. + +## Signature + +```typescript +interface PronunciationRule +``` + +## Properties + + + Whether the match should be case-insensitive. + + + + The text pattern to match. + + + + The replacement pronunciation. + + +## Source + +[`src/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts) + +Line 123. diff --git a/fern/products/sdk-reference/typescript/types/summary-callback.mdx b/fern/products/sdk-reference/typescript/types/summary-callback.mdx new file mode 100644 index 0000000000..5282cde416 --- /dev/null +++ b/fern/products/sdk-reference/typescript/types/summary-callback.mdx @@ -0,0 +1,29 @@ +--- +slug: "/reference/typescript/types/summary-callback" +title: "SummaryCallback" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "types.SummaryCallback" + parent: "types" + module: "types" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts" +--- +# `SummaryCallback` + +Callback invoked when a post-prompt summary is received at the end of a call. + +## Signature + +```typescript +type SummaryCallback = (summary: Record | null, rawData: Record) => void | Promise +``` + +## Source + +[`src/types.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/types.ts) + +Line 167. diff --git a/fern/products/sdk-reference/typescript/web-service/index.mdx b/fern/products/sdk-reference/typescript/web-service/index.mdx new file mode 100644 index 0000000000..b2b4ddb6cb --- /dev/null +++ b/fern/products/sdk-reference/typescript/web-service/index.mdx @@ -0,0 +1,41 @@ +--- +slug: "/reference/typescript/web-service" +title: "WebService" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "WebService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts" +--- +# `WebService` + +## Signature + +```typescript +module WebService +``` + +## Classes + + + + Static file serving service with HTTP API. + + + +## Interfaces + + + + Configuration options for WebService. + + + +## Source + +[`src/WebService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/web-service/web-service-options/index.mdx b/fern/products/sdk-reference/typescript/web-service/web-service-options/index.mdx new file mode 100644 index 0000000000..eb98fec875 --- /dev/null +++ b/fern/products/sdk-reference/typescript/web-service/web-service-options/index.mdx @@ -0,0 +1,71 @@ +--- +slug: "/reference/typescript/web-service/web-service-options" +title: "WebServiceOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "WebService.WebServiceOptions" + parent: "WebService" + module: "WebService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts" +--- +# `WebServiceOptions` + +Configuration options for WebService. + +## Signature + +```typescript +interface WebServiceOptions +``` + +## Properties + + + Allowlist of file extensions (e.g. \['.html', '.css']). Default: all allowed. + + + + Basic auth credentials as \[username, password]. Default: none. + + + + Blocklist of file extensions or names. Default: \['.env', '.git', '.gitignore', '.key', '.pem', '.crt', '.pyc', '**pycache**', '.DS\_Store', '.swp'] + + + + Path to a JSON config file. Default: none. + + + + Map of URL route prefixes to local directory paths. Default: \{\}. + + + + Enable CORS. Default: true. + + + + Serve directory listings and fall back to index.html. Default: false. + + + + Maximum file size in bytes. Default: 104857600 (100 MB). + + + + Port to bind to. Default: 8002. + + + + SSL/TLS configuration options. + + +## Source + +[`src/WebService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts) + +Line 53. diff --git a/fern/products/sdk-reference/typescript/web-service/web-service/add-directory.mdx b/fern/products/sdk-reference/typescript/web-service/web-service/add-directory.mdx new file mode 100644 index 0000000000..bf7c941b1e --- /dev/null +++ b/fern/products/sdk-reference/typescript/web-service/web-service/add-directory.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/web-service/web-service/add-directory" +title: "addDirectory" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "WebService.WebService.addDirectory" + parent: "WebService.WebService" + module: "WebService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts" +--- +# `addDirectory` + +Add a new directory to serve at a URL route prefix. + +## Signature + +```typescript +addDirectory(route: string, directory: string): void +``` + +## Parameters + + + URL prefix (e.g. '/docs'). + + + + Local directory path to serve. + + +## Returns + +`void` + +## Throws + +- If the directory does not exist or is not a directory. + +## Source + +[`src/WebService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts) + +Line 184. diff --git a/fern/products/sdk-reference/typescript/web-service/web-service/constructor.mdx b/fern/products/sdk-reference/typescript/web-service/web-service/constructor.mdx new file mode 100644 index 0000000000..9ef8ac3517 --- /dev/null +++ b/fern/products/sdk-reference/typescript/web-service/web-service/constructor.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/web-service/web-service/constructor" +title: "constructor" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "WebService.WebService.constructor" + parent: "WebService.WebService" + module: "WebService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts" +--- +# `constructor` + +Create a WebService. + +## Signature + +```typescript +constructor(options?: WebServiceOptions): WebService +``` + +## Parameters + + + Configuration options for the service. + + +## Returns + +`WebService` + +## Source + +[`src/WebService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts) + +Line 152. diff --git a/fern/products/sdk-reference/typescript/web-service/web-service/get-app.mdx b/fern/products/sdk-reference/typescript/web-service/web-service/get-app.mdx new file mode 100644 index 0000000000..7926f174b5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/web-service/web-service/get-app.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/web-service/web-service/get-app" +title: "getApp" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "WebService.WebService.getApp" + parent: "WebService.WebService" + module: "WebService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts" +--- +# `getApp` + +Get the Hono application for mounting or testing. + +## Signature + +```typescript +getApp(): Hono +``` + +## Returns + +`Hono` — The configured Hono app. + +## Source + +[`src/WebService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts) + +Line 218. diff --git a/fern/products/sdk-reference/typescript/web-service/web-service/index.mdx b/fern/products/sdk-reference/typescript/web-service/web-service/index.mdx new file mode 100644 index 0000000000..c963be3c52 --- /dev/null +++ b/fern/products/sdk-reference/typescript/web-service/web-service/index.mdx @@ -0,0 +1,113 @@ +--- +slug: "/reference/typescript/web-service/web-service" +title: "WebService" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "class" + language: "typescript" + qualified_name: "WebService.WebService" + parent: "WebService" + module: "WebService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts" +--- +# `WebService` + +Static file serving service with HTTP API. + +Provides configurable static file hosting with per-route directory mounting, +extension filtering, file size limits, HTTP Basic Auth, CORS, directory +browsing, and optional SSL/TLS. Mirrors the Python SDK's `WebService` class. + +Useful when an agent or prefab needs to serve supporting assets — prompts, audio +files, images — from the same process without running a separate nginx / CDN. + +## Signature + +```typescript +class WebService +``` + +## Examples + +```typescript +import { WebService } from '@signalwire/sdk'; + +const web = new WebService({ + port: 8080, + directories: { '/audio': './public/audio' }, + allowedExtensions: ['.mp3', '.wav'], +}); + +await web.serve(); +// GET http://host:8080/audio/greeting.mp3 +``` + +## Properties + + + Allowlist of file extensions, or null to allow all (subject to blocklist). + + + + Blocklist of file extensions and file names. + + + + Map of URL route prefixes to local directory paths. + + + + Whether CORS is enabled. + + + + Whether directory listings are enabled. + + + + Maximum file size in bytes that will be served. + + + + Port the service binds to. + + + + The SSL/TLS configuration for this service. Mirrors the Python SDK's `security` attribute (`SecurityConfig`), which exposes SSL settings for post-construction inspection. In the Python SDK `SecurityConfig` also covers CORS origins, HSTS, allowed hosts, and rate limiting; in this SDK those concerns are configured via their own constructor options (`enableCors`, `ssl`, etc.) and Hono middleware rather than a single combined object. + + +## Methods + + + + Add a new directory to serve at a URL route prefix. + + + + Create a WebService. + + + + Get the Hono application for mounting or testing. + + + + Remove a previously added directory route from the bookkeeping map. + + + + Start the HTTP(S) service. + + + + Stop the service and release resources. + + + +## Source + +[`src/WebService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts) + +Line 120. diff --git a/fern/products/sdk-reference/typescript/web-service/web-service/remove-directory.mdx b/fern/products/sdk-reference/typescript/web-service/web-service/remove-directory.mdx new file mode 100644 index 0000000000..0514e18db4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/web-service/web-service/remove-directory.mdx @@ -0,0 +1,42 @@ +--- +slug: "/reference/typescript/web-service/web-service/remove-directory" +title: "removeDirectory" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "WebService.WebService.removeDirectory" + parent: "WebService.WebService" + module: "WebService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts" +--- +# `removeDirectory` + +Remove a previously added directory route from the bookkeeping map. + +Note: Hono does not support dynamic route removal; a server restart +is required for the route to fully stop responding. + +## Signature + +```typescript +removeDirectory(route: string): void +``` + +## Parameters + + + The URL route prefix to remove. + + +## Returns + +`void` + +## Source + +[`src/WebService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts) + +Line 207. diff --git a/fern/products/sdk-reference/typescript/web-service/web-service/start.mdx b/fern/products/sdk-reference/typescript/web-service/web-service/start.mdx new file mode 100644 index 0000000000..399ff1bbdb --- /dev/null +++ b/fern/products/sdk-reference/typescript/web-service/web-service/start.mdx @@ -0,0 +1,59 @@ +--- +slug: "/reference/typescript/web-service/web-service/start" +title: "start" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "WebService.WebService.start" + parent: "WebService.WebService" + module: "WebService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts" +--- +# `start` + +Start the HTTP(S) service. + +When `SWAIG_CLI_MODE=true` is set in the environment, the call is a +no-op so config can be inspected without binding a port. + +## Signature + +```typescript +start( + host?: string, + port?: number, + sslCert?: string, + sslKey?: string +): Promise +``` + +## Parameters + + + Bind address. Defaults to `'0.0.0.0'`. + + + + Port override. Defaults to `this.port`. + + + + Path to SSL certificate file (overrides `SslConfig`). + + + + Path to SSL key file (overrides `SslConfig`). + + +## Returns + +`Promise` — Resolves once the server has begun listening. + +## Source + +[`src/WebService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts) + +Line 250. diff --git a/fern/products/sdk-reference/typescript/web-service/web-service/stop.mdx b/fern/products/sdk-reference/typescript/web-service/web-service/stop.mdx new file mode 100644 index 0000000000..b23a92ffb2 --- /dev/null +++ b/fern/products/sdk-reference/typescript/web-service/web-service/stop.mdx @@ -0,0 +1,33 @@ +--- +slug: "/reference/typescript/web-service/web-service/stop" +title: "stop" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "method" + language: "typescript" + qualified_name: "WebService.WebService.stop" + parent: "WebService.WebService" + module: "WebService" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts" +--- +# `stop` + +Stop the service and release resources. + +## Signature + +```typescript +stop(): void +``` + +## Returns + +`void` + +## Source + +[`src/WebService.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebService.ts) + +Line 302. diff --git a/fern/products/sdk-reference/typescript/webhook-middleware/index.mdx b/fern/products/sdk-reference/typescript/webhook-middleware/index.mdx new file mode 100644 index 0000000000..18e5f4d502 --- /dev/null +++ b/fern/products/sdk-reference/typescript/webhook-middleware/index.mdx @@ -0,0 +1,49 @@ +--- +slug: "/reference/typescript/webhook-middleware" +title: "WebhookMiddleware" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "WebhookMiddleware" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookMiddleware.ts" +--- +# `WebhookMiddleware` + +## Signature + +```typescript +module WebhookMiddleware +``` + +## Constants + + + Canonical lowercase header names (Hono's c.req.header() is case-insensitive). + + + + +## Functions + + + + Build a Hono middleware that enforces SignalWire webhook signature validation. + + + +## Interfaces + + + + Options for [webhookValidationMiddleware](/reference/typescript/webhook-middleware/webhook-validation-middleware). + + + +## Source + +[`src/WebhookMiddleware.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookMiddleware.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/webhook-middleware/webhook-validation-middleware.mdx b/fern/products/sdk-reference/typescript/webhook-middleware/webhook-validation-middleware.mdx new file mode 100644 index 0000000000..6e06831c57 --- /dev/null +++ b/fern/products/sdk-reference/typescript/webhook-middleware/webhook-validation-middleware.mdx @@ -0,0 +1,56 @@ +--- +slug: "/reference/typescript/webhook-middleware/webhook-validation-middleware" +title: "webhookValidationMiddleware" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "WebhookMiddleware.webhookValidationMiddleware" + parent: "WebhookMiddleware" + module: "WebhookMiddleware" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookMiddleware.ts" +--- +# `webhookValidationMiddleware` + +Build a Hono middleware that enforces SignalWire webhook signature +validation. + +The middleware: + +1. Captures the raw body (`await c.req.text()`) BEFORE any other + consumer reads the stream. The string is stashed at `c.set('rawBody')` + so the downstream handler can re-parse without re-reading the stream. +2. Pulls the `X-SignalWire-Signature` header (or the `X-Twilio-Signature` + alias). +3. Reconstructs the public URL (`SWML_PROXY_URL_BASE` env > forwarded + headers when `trustProxy` > raw request URL). +4. Calls [validateWebhookSignature](/reference/typescript/webhook-validator/validate-webhook-signature). +5. On any failure: responds 403 with no body detail (would leak which + branch failed). Does NOT call `next()`. +6. On success: `next()`. + +## Signature + +```typescript +webhookValidationMiddleware(opts: WebhookValidationOptions): MiddlewareHandler +``` + +## Parameters + + + +## Returns + +`MiddlewareHandler` + +## Throws + +- Error at construction time if `signingKey` is empty. + +## Source + +[`src/WebhookMiddleware.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookMiddleware.ts) + +Line 126. diff --git a/fern/products/sdk-reference/typescript/webhook-middleware/webhook-validation-options/index.mdx b/fern/products/sdk-reference/typescript/webhook-middleware/webhook-validation-options/index.mdx new file mode 100644 index 0000000000..64cfff9f3f --- /dev/null +++ b/fern/products/sdk-reference/typescript/webhook-middleware/webhook-validation-options/index.mdx @@ -0,0 +1,39 @@ +--- +slug: "/reference/typescript/webhook-middleware/webhook-validation-options" +title: "WebhookValidationOptions" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "interface" + language: "typescript" + qualified_name: "WebhookMiddleware.WebhookValidationOptions" + parent: "WebhookMiddleware" + module: "WebhookMiddleware" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookMiddleware.ts" +--- +# `WebhookValidationOptions` + +Options for [webhookValidationMiddleware](/reference/typescript/webhook-middleware/webhook-validation-middleware). + +## Signature + +```typescript +interface WebhookValidationOptions +``` + +## Properties + + + The customer's Signing Key. Required; passing an empty string throws at construction time (it's a programming error, not a runtime failure). + + + + When true, honor `X-Forwarded-Proto` / `X-Forwarded-Host` headers when reconstructing the URL. Default false — proxy headers are spoofable, so opt in only when you control the proxy. + + +## Source + +[`src/WebhookMiddleware.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookMiddleware.ts) + +Line 42. diff --git a/fern/products/sdk-reference/typescript/webhook-validator/form-param-value.mdx b/fern/products/sdk-reference/typescript/webhook-validator/form-param-value.mdx new file mode 100644 index 0000000000..95276c44b4 --- /dev/null +++ b/fern/products/sdk-reference/typescript/webhook-validator/form-param-value.mdx @@ -0,0 +1,31 @@ +--- +slug: "/reference/typescript/webhook-validator/form-param-value" +title: "FormParamValue" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "WebhookValidator.FormParamValue" + parent: "WebhookValidator" + module: "WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookValidator.ts" +--- +# `FormParamValue` + +Form params can be a record, a list of \[key, value] tuples, or a Map. Values +may be a string, number, boolean, null/undefined, or an array of those for +repeated keys. + +## Signature + +```typescript +type FormParamValue = string | number | boolean | null | undefined +``` + +## Source + +[`src/WebhookValidator.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookValidator.ts) + +Line 29. diff --git a/fern/products/sdk-reference/typescript/webhook-validator/form-params.mdx b/fern/products/sdk-reference/typescript/webhook-validator/form-params.mdx new file mode 100644 index 0000000000..4830efbc9b --- /dev/null +++ b/fern/products/sdk-reference/typescript/webhook-validator/form-params.mdx @@ -0,0 +1,27 @@ +--- +slug: "/reference/typescript/webhook-validator/form-params" +title: "FormParams" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "type_alias" + language: "typescript" + qualified_name: "WebhookValidator.FormParams" + parent: "WebhookValidator" + module: "WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookValidator.ts" +--- +# `FormParams` + +## Signature + +```typescript +type FormParams = Record | [string, FormParamValue][] | Map +``` + +## Source + +[`src/WebhookValidator.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookValidator.ts) + +Line 30. diff --git a/fern/products/sdk-reference/typescript/webhook-validator/index.mdx b/fern/products/sdk-reference/typescript/webhook-validator/index.mdx new file mode 100644 index 0000000000..d9e36199d5 --- /dev/null +++ b/fern/products/sdk-reference/typescript/webhook-validator/index.mdx @@ -0,0 +1,47 @@ +--- +slug: "/reference/typescript/webhook-validator" +title: "WebhookValidator" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "module" + language: "typescript" + qualified_name: "WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookValidator.ts" +--- +# `WebhookValidator` + +## Signature + +```typescript +module WebhookValidator +``` + +## Functions + + + + Legacy `@signalwire/compatibility-api` drop-in entry point. + + + + Validate a SignalWire webhook signature against both schemes (A then B). + + + +## Type Aliases + + + + + + Form params can be a record, a list of \[key, value] tuples, or a Map. Values may be a string, number, boolean, null/undefined, or an array of those for repeated keys. + + + +## Source + +[`src/WebhookValidator.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookValidator.ts) + +Line 1. diff --git a/fern/products/sdk-reference/typescript/webhook-validator/validate-request.mdx b/fern/products/sdk-reference/typescript/webhook-validator/validate-request.mdx new file mode 100644 index 0000000000..1eec4c72ce --- /dev/null +++ b/fern/products/sdk-reference/typescript/webhook-validator/validate-request.mdx @@ -0,0 +1,73 @@ +--- +slug: "/reference/typescript/webhook-validator/validate-request" +title: "validateRequest" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "WebhookValidator.validateRequest" + parent: "WebhookValidator" + module: "WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookValidator.ts" +--- +# `validateRequest` + +Legacy `@signalwire/compatibility-api` drop-in entry point. + +If `paramsOrRawBody` is a string, delegates to +[validateWebhookSignature](/reference/typescript/webhook-validator/validate-webhook-signature) (Scheme A then Scheme B with parsed form). + +If it's a record, Map, or list of \[key, value] tuples, treats it as +pre-parsed form params and runs Scheme B directly (with URL port +normalization and optional bodySHA256 fallback). + +The parameter type matches Python's +`Union[str, Mapping[str, Any], List[Tuple[str, Any]], None]` for +cross-language signature parity. `Map` is also +accepted at runtime for ergonomic TS usage. + +## Signature + +```typescript +validateRequest( + signingKey: string, + signature: string, + url: string, + paramsOrRawBody: string | Record | [string, unknown][] | null | undefined +): boolean +``` + +## Parameters + + + Customer's Signing Key. Empty / null throws Error. + + + + Header value. Missing / empty returns false. + + + + Full URL SignalWire POSTed to. + + + + String raw body OR pre-parsed form params. + + +## Returns + +`boolean` — true on match, false otherwise. + +## Throws + +- Error when `signingKey` is missing. +- TypeError when `paramsOrRawBody` is neither a string nor a record/Map/array of tuples (e.g. a plain number). + +## Source + +[`src/WebhookValidator.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookValidator.ts) + +Line 373. diff --git a/fern/products/sdk-reference/typescript/webhook-validator/validate-webhook-signature.mdx b/fern/products/sdk-reference/typescript/webhook-validator/validate-webhook-signature.mdx new file mode 100644 index 0000000000..dc9ca25799 --- /dev/null +++ b/fern/products/sdk-reference/typescript/webhook-validator/validate-webhook-signature.mdx @@ -0,0 +1,61 @@ +--- +slug: "/reference/typescript/webhook-validator/validate-webhook-signature" +title: "validateWebhookSignature" +sdk_label: "TypeScript SDK" +icon: "typescript" +lustri: + auto_generated: true + kind: "function" + language: "typescript" + qualified_name: "WebhookValidator.validateWebhookSignature" + parent: "WebhookValidator" + module: "WebhookValidator" + source_url: "https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookValidator.ts" +--- +# `validateWebhookSignature` + +Validate a SignalWire webhook signature against both schemes (A then B). + +## Signature + +```typescript +validateWebhookSignature( + signingKey: string, + signature: string, + url: string, + rawBody: string +): boolean +``` + +## Parameters + + + The customer's Signing Key from the Dashboard. Empty / null throws `Error` — that's a programming error, not a validation failure. + + + + The `X-SignalWire-Signature` header value (or `X-Twilio-Signature` for cXML compat). Missing / empty returns `false` without throwing. + + + + The full URL SignalWire POSTed to (scheme, host, optional port, path, query). Must match what the platform saw — see the URL reconstruction section of porting-sdk/webhooks.md. + + + + The raw request body bytes as a UTF-8 string, BEFORE any JSON / form parsing. Must be a string — passing a parsed object throws `TypeError`. + + +## Returns + +`boolean` — `true` if the signature matches either Scheme A (hex JSON) or Scheme B (base64 form, with port-normalization variants and optional bodySHA256 fallback). `false` otherwise. + +## Throws + +- Error when `signingKey` is missing / empty. +- TypeError when `rawBody` is not a string. + +## Source + +[`src/WebhookValidator.ts`](https://github.com/signalwire/signalwire-typescript/blob/main/src/WebhookValidator.ts) + +Line 300.